Add graphql.isNonNull.update (#8283)

Co-authored-by: Daniel Cousens <[email protected]> Co-authored-by: Josh Calder <[email protected]> Co-authored-by: rburgst <[email protected]>
keystonejs · Feb 2, 2023 · 11bb288 · 11bb288 · vercel · Feb 2, 2023
1 parent 8451751
commit 11bb288
Show file tree

Hide file tree

Showing 95 changed files with 1,045 additions and 385 deletions.
diff --git a/.changeset/rotten-apples-run.md b/.changeset/rotten-apples-run.md
@@ -0,0 +1,5 @@
+---
+'@keystone-6/core': major
+---
+
+Changes `graphql.omit` type from array to explicit `{ read: boolean, create: boolean, update: boolean }`
diff --git a/.changeset/rotten-bananas-attend.md b/.changeset/rotten-bananas-attend.md
@@ -0,0 +1,5 @@
+---
+'@keystone-6/core': major
+---
+
+Changes `graphql.*.isNonNull` to `graphql.isNonNull.*`, and adds `graphql.isNonNull.update` for optimistic locking usecases
diff --git a/.changeset/rotten-bananas-fly.md b/.changeset/rotten-bananas-fly.md
@@ -0,0 +1,5 @@
+---
+'@keystone-6/core': minor
+---
+
+Removes `keystone build` errors for `graphql.isNonNull.create` and `graphql.isNonNull.update` when field access control is configured
diff --git a/docs/pages/docs/fields/bigint.md b/docs/pages/docs/fields/bigint.md
@@ -24,6 +24,8 @@ Options:
 - `isIndexed` (default: `false`)
   - If `true` then this field will be indexed by the database.
   - If `'unique'` then all values of this field must be unique.
+{% if $nextRelease %}
+{% else /%}
 - `graphql.read.isNonNull` (default: `false`): If you have no read access control and you don't intend to add any in the future,
   you can set this to true and the output field will be non-nullable. This is only allowed when you have no read access control because otherwise,
   when access is denied, `null` will be returned which will cause an error since the field is non-nullable and the error
@@ -32,6 +34,7 @@ Options:
   you can set this to true and the create field will be non-nullable and have a default value at the GraphQL level.
   This is only allowed when you have no create access control because otherwise, the item will always fail access control
   if a user doesn't have access to create the particular field regardless of whether or not they specify the field in the create.
+{% /if %}
 
 ```typescript
 import { config, list } from '@keystone-6/core';

diff --git a/docs/pages/docs/fields/calendarday.md b/docs/pages/docs/fields/calendarday.md
@@ -20,6 +20,8 @@ Options:
 - `isIndexed` (default: `false`)
   - If `true` then this field will be indexed by the database.
   - If `'unique'` then all values of this field must be unique.
+{% if $nextRelease %}
+{% else /%}
 - `graphql.read.isNonNull` (default: `false`): If you have no read access control and you don't intend to add any in the future,
   you can set this to true and the output field will be non-nullable. This is only allowed when you have no read access control because otherwise,
   when access is denied, `null` will be returned which will cause an error since the field is non-nullable and the error
@@ -28,6 +30,7 @@ Options:
   you can set this to true and the create field will be non-nullable and have a default value at the GraphQL level.
   This is only allowed when you have no create access control because otherwise, the item will always fail access control
   if a user doesn't have access to create the particular field regardless of whether or not they specify the field in the create.
+{% /if %}
 
 ```typescript
 import { config, list } from '@keystone-6/core';

diff --git a/docs/pages/docs/fields/checkbox.md b/docs/pages/docs/fields/checkbox.md
@@ -9,6 +9,8 @@ Options:
 
 - `defaultValue` (default: `false`): This value will be used for the field when creating items if no explicit value is set.
 - `db.map`: Adds a [Prisma `@map`](https://www.prisma.io/docs/reference/api-reference/prisma-schema-reference#map) attribute to this field which changes the column name in the database
+{% if $nextRelease %}
+{% else /%}
 - `graphql.read.isNonNull` (default: `false`): If you have no read access control and you don't intend to add any in the future,
   you can set this to true and the output field will be non-nullable. This is only allowed when you have no read access control because otherwise,
   when access is denied, `null` will be returned which will cause an error since the field is non-nullable and the error
@@ -17,6 +19,7 @@ Options:
   you can set this to true and the create field will be non-nullable and have a default value at the GraphQL level.
   This is only allowed when you have no create access control because otherwise, the item will always fail access control
   if a user doesn't have access to create the particular field regardless of whether or not they specify the field in the create.
+{% /if %}
 
 ```typescript
 import { config, list } from '@keystone-6/core';

diff --git a/docs/pages/docs/fields/decimal.md b/docs/pages/docs/fields/decimal.md
@@ -22,6 +22,8 @@ Options:
 - `isIndexed` (default: `false`)
   - If `true` then this field will be indexed by the database.
   - If `'unique'` then all values of this field must be unique.
+{% if $nextRelease %}
+{% else /%}
 - `graphql.read.isNonNull` (default: `false`): If you have no read access control and you don't intend to add any in the future,
   you can set this to true and the output field will be non-nullable. This is only allowed when you have no read access control because otherwise,
   when access is denied, `null` will be returned which will cause an error since the field is non-nullable and the error
@@ -30,6 +32,7 @@ Options:
   you can set this to true and the create field will be non-nullable and have a default value at the GraphQL level.
   This is only allowed when you have no create access control because otherwise, the item will always fail access control
   if a user doesn't have access to create the particular field regardless of whether or not they specify the field in the create.
+{% /if %}
 
 ```typescript
 import { config, list } from '@keystone-6/core';

diff --git a/docs/pages/docs/fields/float.md b/docs/pages/docs/fields/float.md
@@ -19,6 +19,8 @@ Options:
 - `isIndexed` (default: `false`)
   - If `true` then this field will be indexed by the database.
   - If `'unique'` then all values of this field must be unique.
+{% if $nextRelease %}
+{% else /%}
 - `graphql.read.isNonNull` (default: `false`): If you have no read access control and you don't intend to add any in the future,
   you can set this to true and the output field will be non-nullable. This is only allowed when you have no read access control because otherwise,
   when access is denied, `null` will be returned which will cause an error since the field is non-nullable and the error
@@ -27,6 +29,7 @@ Options:
   you can set this to true and the create field will be non-nullable and have a default value at the GraphQL level.
   This is only allowed when you have no create access control because otherwise, the item will always fail access control
   if a user doesn't have access to create the particular field regardless of whether or not they specify the field in the create.
+{% /if %}
 
 ```typescript
 import { config, list } from '@keystone-6/core';

diff --git a/docs/pages/docs/fields/integer.md b/docs/pages/docs/fields/integer.md
@@ -21,6 +21,8 @@ Options:
 - `isIndexed` (default: `false`)
   - If `true` then this field will be indexed by the database.
   - If `'unique'` then all values of this field must be unique.
+{% if $nextRelease %}
+{% else /%}
 - `graphql.read.isNonNull` (default: `false`): If you have no read access control and you don't intend to add any in the future,
   you can set this to true and the output field will be non-nullable. This is only allowed when you have no read access control because otherwise,
   when access is denied, `null` will be returned which will cause an error since the field is non-nullable and the error
@@ -29,6 +31,7 @@ Options:
   you can set this to true and the create field will be non-nullable and have a default value at the GraphQL level.
   This is only allowed when you have no create access control because otherwise, the item will always fail access control
   if a user doesn't have access to create the particular field regardless of whether or not they specify the field in the create.
+{% /if %}
 
 ```typescript
 import { config, list } from '@keystone-6/core';

diff --git a/docs/pages/docs/fields/multiselect.md b/docs/pages/docs/fields/multiselect.md
@@ -18,6 +18,8 @@ Options:
   The `value` will be used in the GraphQL API and stored in the database.
 - `defaultValue` (default: `[]`): This value will be used for the field when creating items if no explicit value is set.
 - `db.map`: Adds a [Prisma `@map`](https://www.prisma.io/docs/reference/api-reference/prisma-schema-reference#map) attribute to this field which changes the column name in the database
+{% if $nextRelease %}
+{% else /%}
 - `graphql.read.isNonNull` (default: `false`): If you have no read access control and you don't intend to add any in the future,
   you can set this to true and the output field will be non-nullable. This is only allowed when you have no read access control because otherwise,
   when access is denied, `null` will be returned which will cause an error since the field is non-nullable and the error
@@ -26,6 +28,7 @@ Options:
   you can set this to true and the create field will be non-nullable and have a default value at the GraphQL level.
   This is only allowed when you have no create access control because otherwise, the item will always fail access control
   if a user doesn't have access to create the particular field regardless of whether or not they specify the field in the create.
+{% /if %}
 
 ```typescript
 import { config, list } from '@keystone-6/core';

diff --git a/docs/pages/docs/fields/overview.md b/docs/pages/docs/fields/overview.md
@@ -98,6 +98,14 @@ Options:
     See the [Lists API](../config/lists#ui) for details.
 - `graphql`: Configures certain aspects of the GraphQL API.
   - `cacheHint` (default: `undefined`): Allows you to specify the [dynamic cache control hints](https://www.apollographql.com/docs/apollo-server/performance/caching/#in-your-resolvers-dynamic) used for queries to this list.
+{% if $nextRelease %}
+    - `isNonNull.read` (default: `false`): Changing this to `true` will change the GraphQL output type to be non-nullable.
+    If you have 'read' field access control, this will be rejected with a runtime `Error` as `null` may be returned if the access control returns false.
+    - `isNonNull.create` (default: `false`): Enforce that this field is non-nullable in the \*CreateInput for the respective list item.
+    Fields that have a `defaultValue` only have that default value included in the GraphQL if this field is `true`.
+    - `isNonNull.update` (default: `false`): Enforce that this field is non-nullable in the \*UpdateInput for the respective list item.
+    This field additionally results in the AdminUI always sending this particular field in updates, including when it has not changed.
+{% /if %}
   - `omit` (default: 'undefined'): Controls whether this field appears in the autogenerated types of the GraphQL API
     This option accepts either `true`, or an array of the values `read`, `create`, or `update`.
     If you specify `true` then the field will be excluded from all input and output types in the GraphQL API.

diff --git a/docs/pages/docs/fields/select.md b/docs/pages/docs/fields/select.md
@@ -27,6 +27,8 @@ Options:
   - If `'unique'` then all values of this field must be unique.
 - `ui.displayMode` (default: `'select'`): Configures the display mode of the field in the Admin UI.
   Can be one of `['select', 'segmented-control', 'radio']`.
+{% if $nextRelease %}
+{% else /%}
 - `graphql.read.isNonNull` (default: `false`): If you have no read access control and you don't intend to add any in the future,
   you can set this to true and the output field will be non-nullable. This is only allowed when you have no read access control because otherwise,
   when access is denied, `null` will be returned which will cause an error since the field is non-nullable and the error
@@ -35,6 +37,7 @@ Options:
   you can set this to true and the create field will be non-nullable and have a default value at the GraphQL level.
   This is only allowed when you have no create access control because otherwise, the item will always fail access control
   if a user doesn't have access to create the particular field regardless of whether or not they specify the field in the create.
+{% /if %}
 
 ```typescript
 import { config, list } from '@keystone-6/core';

diff --git a/docs/pages/docs/fields/text.md b/docs/pages/docs/fields/text.md
@@ -25,6 +25,8 @@ Options:
   - If `'unique'` then all values of this field must be unique.
 - `ui` (default: `{ displayMode: 'input' }`): Configures the display mode of the field in the Admin UI.
   Can be one of `['input', 'textarea']`.
+{% if $nextRelease %}
+{% else /%}
 - `graphql.read.isNonNull` (default: `false`): If you have no read access control and you don't intend to add any in the future,
   you can set this to true and the output field will be non-nullable. This is only allowed when you have no read access control because otherwise,
   when access is denied, `null` will be returned which will cause an error since the field is non-nullable and the error
@@ -33,6 +35,7 @@ Options:
   you can set this to true and the create field will be non-nullable and have a default value at the GraphQL level.
   This is only allowed when you have no create access control because otherwise, the item will always fail access control
   if a user doesn't have access to create the particular field regardless of whether or not they specify the field in the create.
+{% /if %}
 
 {% hint kind="tip" %}
 **\*Warning** Unlike with other `keystone` fields, `db.isNullable` is defaulted to `false` for the text field.

diff --git a/docs/pages/docs/fields/timestamp.md b/docs/pages/docs/fields/timestamp.md
@@ -20,6 +20,8 @@ Options:
 - `isIndexed` (default: `false`)
   - If `true` then this field will be indexed by the database.
   - If `'unique'` then all values of this field must be unique.
+{% if $nextRelease %}
+{% else /%}
 - `graphql.read.isNonNull` (default: `false`): If you have no read access control and you don't intend to add any in the future,
   you can set this to true and the output field will be non-nullable. This is only allowed when you have no read access control because otherwise,
   when access is denied, `null` will be returned which will cause an error since the field is non-nullable and the error
@@ -28,6 +30,7 @@ Options:
   you can set this to true and the create field will be non-nullable and have a default value at the GraphQL level.
   This is only allowed when you have no create access control because otherwise, the item will always fail access control
   if a user doesn't have access to create the particular field regardless of whether or not they specify the field in the create.
+{% /if %}
 
 ```typescript
 import { config, list } from '@keystone-6/core';

diff --git a/examples/assets-local/schema.graphql b/examples/assets-local/schema.graphql
@@ -304,6 +304,7 @@ type KeystoneAdminUIFieldMeta {
   description: String
   isOrderable: Boolean!
   isFilterable: Boolean!
+  isNonNull: [KeystoneAdminUIFieldMetaIsNonNull!]
   fieldMeta: JSON
   viewsIndex: Int!
   customViewsIndex: Int
@@ -313,6 +314,12 @@ type KeystoneAdminUIFieldMeta {
   search: QueryMode
 }
 
+enum KeystoneAdminUIFieldMetaIsNonNull {
+  read
+  create
+  update
+}
+
 type KeystoneAdminUIFieldMetaCreateView {
   fieldMode: KeystoneAdminUIFieldMetaCreateViewFieldMode!
 }

diff --git a/examples/assets-s3/schema.graphql b/examples/assets-s3/schema.graphql
@@ -304,6 +304,7 @@ type KeystoneAdminUIFieldMeta {
   description: String
   isOrderable: Boolean!
   isFilterable: Boolean!
+  isNonNull: [KeystoneAdminUIFieldMetaIsNonNull!]
   fieldMeta: JSON
   viewsIndex: Int!
   customViewsIndex: Int
@@ -313,6 +314,12 @@ type KeystoneAdminUIFieldMeta {
   search: QueryMode
 }
 
+enum KeystoneAdminUIFieldMetaIsNonNull {
+  read
+  create
+  update
+}
+
 type KeystoneAdminUIFieldMetaCreateView {
   fieldMode: KeystoneAdminUIFieldMetaCreateViewFieldMode!
 }

diff --git a/examples/auth/schema.graphql b/examples/auth/schema.graphql
@@ -188,6 +188,7 @@ type KeystoneAdminUIFieldMeta {
   description: String
   isOrderable: Boolean!
   isFilterable: Boolean!
+  isNonNull: [KeystoneAdminUIFieldMetaIsNonNull!]
   fieldMeta: JSON
   viewsIndex: Int!
   customViewsIndex: Int
@@ -197,6 +198,12 @@ type KeystoneAdminUIFieldMeta {
   search: QueryMode
 }
 
+enum KeystoneAdminUIFieldMetaIsNonNull {
+  read
+  create
+  update
+}
+
 type KeystoneAdminUIFieldMetaCreateView {
   fieldMode: KeystoneAdminUIFieldMetaCreateViewFieldMode!
 }

diff --git a/examples/basic/schema.graphql b/examples/basic/schema.graphql
@@ -452,6 +452,7 @@ type KeystoneAdminUIFieldMeta {
   description: String
   isOrderable: Boolean!
   isFilterable: Boolean!
+  isNonNull: [KeystoneAdminUIFieldMetaIsNonNull!]
   fieldMeta: JSON
   viewsIndex: Int!
   customViewsIndex: Int
@@ -461,6 +462,12 @@ type KeystoneAdminUIFieldMeta {
   search: QueryMode
 }
 
+enum KeystoneAdminUIFieldMetaIsNonNull {
+  read
+  create
+  update
+}
+
 type KeystoneAdminUIFieldMetaCreateView {
   fieldMode: KeystoneAdminUIFieldMetaCreateViewFieldMode!
 }

diff --git a/examples/blog/schema.graphql b/examples/blog/schema.graphql
@@ -265,6 +265,7 @@ type KeystoneAdminUIFieldMeta {
   description: String
   isOrderable: Boolean!
   isFilterable: Boolean!
+  isNonNull: [KeystoneAdminUIFieldMetaIsNonNull!]
   fieldMeta: JSON
   viewsIndex: Int!
   customViewsIndex: Int
@@ -274,6 +275,12 @@ type KeystoneAdminUIFieldMeta {
   search: QueryMode
 }
 
+enum KeystoneAdminUIFieldMetaIsNonNull {
+  read
+  create
+  update
+}
+
 type KeystoneAdminUIFieldMetaCreateView {
   fieldMode: KeystoneAdminUIFieldMetaCreateViewFieldMode!
 }

diff --git a/examples/custom-admin-ui-logo/schema.graphql b/examples/custom-admin-ui-logo/schema.graphql
@@ -265,6 +265,7 @@ type KeystoneAdminUIFieldMeta {
   description: String
   isOrderable: Boolean!
   isFilterable: Boolean!
+  isNonNull: [KeystoneAdminUIFieldMetaIsNonNull!]
   fieldMeta: JSON
   viewsIndex: Int!
   customViewsIndex: Int
@@ -274,6 +275,12 @@ type KeystoneAdminUIFieldMeta {
   search: QueryMode
 }
 
+enum KeystoneAdminUIFieldMetaIsNonNull {
+  read
+  create
+  update
+}
+
 type KeystoneAdminUIFieldMetaCreateView {
   fieldMode: KeystoneAdminUIFieldMetaCreateViewFieldMode!
 }

diff --git a/examples/custom-admin-ui-navigation/schema.graphql b/examples/custom-admin-ui-navigation/schema.graphql
@@ -265,6 +265,7 @@ type KeystoneAdminUIFieldMeta {
   description: String
   isOrderable: Boolean!
   isFilterable: Boolean!
+  isNonNull: [KeystoneAdminUIFieldMetaIsNonNull!]
   fieldMeta: JSON
   viewsIndex: Int!
   customViewsIndex: Int
@@ -274,6 +275,12 @@ type KeystoneAdminUIFieldMeta {
   search: QueryMode
 }
 
+enum KeystoneAdminUIFieldMetaIsNonNull {
+  read
+  create
+  update
+}
+
 type KeystoneAdminUIFieldMetaCreateView {
   fieldMode: KeystoneAdminUIFieldMetaCreateViewFieldMode!
 }

diff --git a/examples/custom-admin-ui-pages/schema.graphql b/examples/custom-admin-ui-pages/schema.graphql
@@ -265,6 +265,7 @@ type KeystoneAdminUIFieldMeta {
   description: String
   isOrderable: Boolean!
   isFilterable: Boolean!
+  isNonNull: [KeystoneAdminUIFieldMetaIsNonNull!]
   fieldMeta: JSON
   viewsIndex: Int!
   customViewsIndex: Int
@@ -274,6 +275,12 @@ type KeystoneAdminUIFieldMeta {
   search: QueryMode
 }
 
+enum KeystoneAdminUIFieldMetaIsNonNull {
+  read
+  create
+  update
+}
+
 type KeystoneAdminUIFieldMetaCreateView {
   fieldMode: KeystoneAdminUIFieldMetaCreateViewFieldMode!
 }

diff --git a/examples/custom-field-view/schema.graphql b/examples/custom-field-view/schema.graphql
@@ -268,6 +268,7 @@ type KeystoneAdminUIFieldMeta {
   description: String
   isOrderable: Boolean!
   isFilterable: Boolean!
+  isNonNull: [KeystoneAdminUIFieldMetaIsNonNull!]
   fieldMeta: JSON
   viewsIndex: Int!
   customViewsIndex: Int
@@ -277,6 +278,12 @@ type KeystoneAdminUIFieldMeta {
   search: QueryMode
 }
 
+enum KeystoneAdminUIFieldMetaIsNonNull {
+  read
+  create
+  update
+}
+
 type KeystoneAdminUIFieldMetaCreateView {
   fieldMode: KeystoneAdminUIFieldMetaCreateViewFieldMode!
 }