add deprecation notice for extendHttpServer arguments

keystonejs · Feb 15, 2024 · 544fb20 · 544fb20
1 parent e3f9b63
commit 544fb20
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/packages/core/src/lib/createExpressServer.ts b/packages/core/src/lib/createExpressServer.ts
@@ -3,7 +3,10 @@ import cors from 'cors'
 import { json } from 'body-parser'
 import { expressMiddleware } from '@apollo/server/express4'
 import express from 'express'
-import { type GraphQLFormattedError, type GraphQLSchema } from 'graphql'
+import {
+  type GraphQLFormattedError,
+  type GraphQLSchema
+} from 'graphql'
 import { ApolloServer, type ApolloServerOptions } from '@apollo/server'
 import { ApolloServerPluginLandingPageDisabled } from '@apollo/server/plugin/disabled'
 import { ApolloServerPluginLandingPageLocalDefault } from '@apollo/server/plugin/landingPage/default'
@@ -46,7 +49,7 @@ function formatError (graphqlConfig: GraphQLConfig | undefined) {
 
 export async function createExpressServer (
   config: Pick<KeystoneConfig, 'graphql' | 'server' | 'storage'>,
-  graphQLSchema: GraphQLSchema, // TODO: redundant, remove in breaking change
+  graphQLSchema: GraphQLSchema, // TODO: redundant, prefer context.graphql.schema, remove in breaking change
   context: KeystoneContext
 ): Promise<{
   expressServer: express.Express

diff --git a/packages/core/src/types/config/index.ts b/packages/core/src/types/config/index.ts
@@ -216,6 +216,7 @@ export type ServerConfig<TypeInfo extends BaseKeystoneTypeInfo> = {
   extendHttpServer?: (
     server: Server,
     context: KeystoneContext<TypeInfo>,
+    /** @deprecated, TODO: redundant, prefer context.graphql.schema, remove in breaking change */
     graphqlSchema: GraphQLSchema
   ) => MaybePromise<void>
 } & (