Move config.extendGraphqlSchema to config.graphql.extendSchema

.changeset/move-extend-graphql.md

@@ -0,0 +1,5 @@
+---
+'@keystone-6/core': major
+---
+
+Moves `config.extendGraphqlSchema` to `config.graphql.extendGraphqlSchema`, similar to `db.extendPrismaSchema`

examples/extend-graphql-schema-graphql-tools/keystone.ts

@@ -10,6 +10,8 @@ export default config({
     // WARNING: this is only needed for our monorepo examples, dont do this
     ...fixPrismaPath,
   },
+  graphql: {
+    extendGraphqlSchema
+  },
   lists,
-  extendGraphqlSchema,
-})
+})

examples/extend-graphql-schema-graphql-ts/keystone.ts

@@ -10,6 +10,8 @@ export default config({
     // WARNING: this is only needed for our monorepo examples, dont do this
     ...fixPrismaPath,
   },
+  graphql: {
+    extendGraphqlSchema
+  },
   lists,
-  extendGraphqlSchema,
 })

examples/extend-graphql-schema-nexus/keystone.ts

@@ -10,9 +10,10 @@ export default config({
     // WARNING: this is only needed for our monorepo examples, dont do this
     ...fixPrismaPath,
   },
+  graphql: {
+    extendGraphqlSchema
+  },
   lists,
-  extendGraphqlSchema,
-
   // we use a custom types path for easy integration with nexus
   types: {
     path: 'keystone-types.ts',

examples/extend-graphql-subscriptions/keystone.ts

@@ -11,9 +11,11 @@ export default config({
     // WARNING: this is only needed for our monorepo examples, dont do this
     ...fixPrismaPath,
   },
+  graphql: {
+    extendGraphqlSchema
+  },
   lists,
   server: {
     extendHttpServer,
   },
-  extendGraphqlSchema,
 })

packages/auth/src/index.ts

@@ -279,11 +279,18 @@ export function createAuth<ListTypeInfo extends BaseListTypeInfo> ({
 
     if (!config.session) throw new TypeError('Missing .session configuration')
 
-    const { extendGraphqlSchema = defaultExtendGraphqlSchema } = config
+    const { graphql } = config
+    const { extendGraphqlSchema = defaultExtendGraphqlSchema } = graphql ?? {}
     const authListConfig = config.lists[listKey]
 
     return {
       ...config,
+      graphql: {
+        ...config.graphql,
+        extendGraphqlSchema: (schema) => {
+          return extendGraphqlSchema(authExtendGraphqlSchema(schema))
+        },
+      },
       ui,
       session: authSessionStrategy(config.session),
       lists: {
@@ -296,9 +303,6 @@ export function createAuth<ListTypeInfo extends BaseListTypeInfo> ({
           },
         },
       },
-      extendGraphqlSchema: schema => {
-        return extendGraphqlSchema(authExtendGraphqlSchema(schema))
-      },
     }
   }
 

packages/core/src/lib/createGraphQLSchema.ts

@@ -127,9 +127,5 @@ export function createGraphQLSchema (
   )
 
   // merge in the user defined graphQL API
-  if (config.extendGraphqlSchema) {
-    return config.extendGraphqlSchema(graphQLSchema)
-  }
-
-  return graphQLSchema
+  return config.graphql?.extendGraphqlSchema?.(graphQLSchema) ?? graphQLSchema
 }

packages/core/src/lib/defaults.ts

@@ -102,6 +102,7 @@ export function resolveDefaults (config: KeystoneConfig) {
       path: '/api/graphql',
       playground: process.env.NODE_ENV !== 'production',
       schemaPath: 'schema.graphql',
+      extendGraphqlSchema: config.graphql?.extendGraphqlSchema ?? ((s) => s),
       ...config.graphql,
     },
     lists: injectDefaults(config, defaultIdField),
@@ -112,8 +113,6 @@ export function resolveDefaults (config: KeystoneConfig) {
       ...config.server,
       cors,
     },
-    // TODO: remove in breaking change, move to .graphql.extendSchema
-    extendGraphqlSchema: config.extendGraphqlSchema ?? ((s) => s),
     storage: {
       ...config?.storage
     },
@@ -128,4 +127,4 @@ export function resolveDefaults (config: KeystoneConfig) {
   } satisfies KeystoneConfig
 }
 
-export type ResolvedKeystoneConfig = ReturnType<typeof resolveDefaults>
+export type ResolvedKeystoneConfig = ReturnType<typeof resolveDefaults>

packages/core/src/types/config/index.ts

@@ -103,8 +103,6 @@ export type KeystoneConfig<TypeInfo extends BaseKeystoneTypeInfo = BaseKeystoneT
     path?: string
   }
 
-  // TODO: why isn't this within .graphql?
-  extendGraphqlSchema?: (schema: GraphQLSchema) => GraphQLSchema
   /** An object containing configuration about keystone's various external storages.
    *
    * Each entry should be of either `kind: 'local'` or `kind: 's3'`, and follow the configuration of each.
@@ -270,6 +268,12 @@ export type GraphQLConfig<TypeInfo extends BaseKeystoneTypeInfo = BaseKeystoneTy
    * @default 'schema.graphql'
    */
   schemaPath?: string
+
+  /**
+   * A function that receives the Keystone GraphQL schema for the developer to extend
+   * @default 'schema.graphql'
+   */
+  extendGraphqlSchema?: (schema: GraphQLSchema) => GraphQLSchema
 }
 
 export type FilesConfig = {

tests/api-tests/extend-graphql-schema.test.ts

@@ -32,29 +32,31 @@ const runner = setupTestRunner({
         fields: { name: text() },
       }),
     },
-    extendGraphqlSchema: graphql.extend(() => {
-      return {
-        mutation: {
-          triple: graphql.field({
-            type: graphql.Int,
-            args: { x: graphql.arg({ type: graphql.nonNull(graphql.Int) }) },
-            resolve: withAccessCheck(true, (_, { x }: { x: number }) => 3 * x),
-          }),
-        },
-        query: {
-          double: graphql.field({
-            type: graphql.Int,
-            args: { x: graphql.arg({ type: graphql.nonNull(graphql.Int) }) },
-            resolve: withAccessCheck(true, (_, { x }: { x: number }) => 2 * x),
-          }),
-          quads: graphql.field({
-            type: graphql.Int,
-            args: { x: graphql.arg({ type: graphql.nonNull(graphql.Int) }) },
-            resolve: withAccessCheck(falseFn, (_, { x }: { x: number }) => 4 * x),
-          }),
-        },
-      }
-    })
+    graphql: {
+      extendGraphqlSchema: graphql.extend(() => {
+        return {
+          mutation: {
+            triple: graphql.field({
+              type: graphql.Int,
+              args: { x: graphql.arg({ type: graphql.nonNull(graphql.Int) }) },
+              resolve: withAccessCheck(true, (_, { x }: { x: number }) => 3 * x),
+            }),
+          },
+          query: {
+            double: graphql.field({
+              type: graphql.Int,
+              args: { x: graphql.arg({ type: graphql.nonNull(graphql.Int) }) },
+              resolve: withAccessCheck(true, (_, { x }: { x: number }) => 2 * x),
+            }),
+            quads: graphql.field({
+              type: graphql.Int,
+              args: { x: graphql.arg({ type: graphql.nonNull(graphql.Int) }) },
+              resolve: withAccessCheck(falseFn, (_, { x }: { x: number }) => 4 * x),
+            }),
+          },
+        }
+      })
+    }
   }),
 })
 

tests/api-tests/queries/cache-hints.test.ts

@@ -44,35 +44,37 @@ const runner = setupTestRunner({
         },
       }),
     },
-    extendGraphqlSchema: graphql.extend(() => {
-      const MyType = graphql.object<{ original: number }>()({
-        name: 'MyType',
-        fields: {
-          original: graphql.field({ type: graphql.Int }),
-          double: graphql.field({ type: graphql.Int, resolve: ({ original }) => original * 2 }),
-        },
-      })
-      return {
-        query: {
-          double: graphql.field({
-            type: MyType,
-            args: { x: graphql.arg({ type: graphql.nonNull(graphql.Int) }) },
-            resolve: (_, { x }, context, info) => {
-              maybeCacheControlFromInfo(info)?.setCacheHint({ maxAge: 100, scope: 'PUBLIC' })
-              return { original: x, double: x * 2 }
-            },
-          }),
-        },
-        mutation: {
-          triple: graphql.field({
-            type: graphql.Int,
-            args: { x: graphql.arg({ type: graphql.nonNull(graphql.Int) }) },
-            resolve: (_, { x }) => x * 3,
-          }),
-        },
-      }
-    }),
-  },
+    graphql: {
+      extendGraphqlSchema: graphql.extend(() => {
+        const MyType = graphql.object<{ original: number }>()({
+          name: 'MyType',
+          fields: {
+            original: graphql.field({ type: graphql.Int }),
+            double: graphql.field({ type: graphql.Int, resolve: ({ original }) => original * 2 }),
+          },
+        })
+        return {
+          query: {
+            double: graphql.field({
+              type: MyType,
+              args: { x: graphql.arg({ type: graphql.nonNull(graphql.Int) }) },
+              resolve: (_, { x }, context, info) => {
+                maybeCacheControlFromInfo(info)?.setCacheHint({ maxAge: 100, scope: 'PUBLIC' })
+                return { original: x, double: x * 2 }
+              },
+            }),
+          },
+          mutation: {
+            triple: graphql.field({
+              type: graphql.Int,
+              args: { x: graphql.arg({ type: graphql.nonNull(graphql.Int) }) },
+              resolve: (_, { x }) => x * 3,
+            }),
+          },
+        }
+      }),
+    }
+  }
 })
 
 const addFixtures = async (context: ContextFromRunner<typeof runner>) => {

tests/test-projects/live-reloading/keystone.ts

@@ -11,7 +11,9 @@ export default config({
     ...fixPrismaPath,
   },
   lists,
-  extendGraphqlSchema,
+  graphql: {
+    extendGraphqlSchema
+  },
   ui: {
     getAdditionalFiles: [
       () => [