feat!: make graphql an optional dependency

packages/next/package.json

@@ -88,8 +88,6 @@
     "@payloadcms/ui": "workspace:*",
     "busboy": "^1.6.0",
     "file-type": "19.3.0",
-    "graphql-http": "^1.22.0",
-    "graphql-playground-html": "1.6.30",
     "http-status": "1.6.2",
     "path-to-regexp": "^6.2.1",
     "qs-esm": "7.0.2",
@@ -114,11 +112,12 @@
     "esbuild": "0.23.1",
     "esbuild-sass-plugin": "3.3.1",
     "eslint-plugin-react-compiler": "19.0.0-beta-a7bf2bd-20241110",
+    "graphql": "^16.8.1",
+    "graphql-http": "^1.22.0",
     "payload": "workspace:*",
     "swc-plugin-transform-remove-imports": "1.15.0"
   },
   "peerDependencies": {
-    "graphql": "^16.8.1",
     "next": "^15.0.0",
     "payload": "workspace:*"
   },

packages/next/src/routes/graphql/handler.ts

@@ -1,16 +1,29 @@
 import type { GraphQLError, GraphQLFormattedError } from 'graphql'
 import type { APIError, Payload, PayloadRequest, SanitizedConfig } from 'payload'
 
-import { configToSchema } from '@payloadcms/graphql'
-import { createHandler } from 'graphql-http/lib/use/fetch'
 import httpStatus from 'http-status'
+import { createRequire } from 'module'
 
 import { addDataAndFileToRequest } from '../../utilities/addDataAndFileToRequest.js'
 import { addLocalesToRequestFromData } from '../../utilities/addLocalesToRequest.js'
 import { createPayloadRequest } from '../../utilities/createPayloadRequest.js'
 import { headersWithCors } from '../../utilities/headersWithCors.js'
 import { mergeHeaders } from '../../utilities/mergeHeaders.js'
 
+const require = createRequire(import.meta.url)
+
+let createHandler
+let configToSchema
+const getDynamicImports = () => {
+  if (createHandler) {
+    return createHandler
+  } else {
+    createHandler = require('graphql-http/lib/use/fetch').createHandler
+    configToSchema = require('@payloadcms/graphql').configToSchema
+    return { configToSchema, createHandler }
+  }
+}
+
 const handleError = async ({
   err,
   payload,
@@ -78,7 +91,12 @@
   if (!cached.promise) {
     const resolvedConfig = await config
     cached.promise = new Promise((resolve) => {
+      if (resolvedConfig.graphQL.disable) {
+        resolve(null)
+        return
+      }
+      const { configToSchema } = getDynamicImports()
       const schema = configToSchema(resolvedConfig)
       resolve(cached.graphql || schema)
     })
   }
@@ -95,6 +113,13 @@
 
 export const POST =
   (config: Promise<SanitizedConfig> | SanitizedConfig) => async (request: Request) => {
+    if ((await config).graphQL.disable) {
+      return new Response('GraphQL is disabled', {
+        status: httpStatus.NOT_FOUND,
+      })
+    }
+
+    const { createHandler } = getDynamicImports()
     const originalRequest = request.clone()
     const req = await createPayloadRequest({
       config,

packages/next/src/routes/graphql/playground.ts

@@ -1,15 +1,28 @@
 import type { SanitizedConfig } from 'payload'
 
-import { renderPlaygroundPage } from 'graphql-playground-html'
+import { createRequire } from 'module'
 
 import { createPayloadRequest } from '../../utilities/createPayloadRequest.js'
 
+const require = createRequire(import.meta.url)
+
+let renderPlaygroundPage
+const getRenderPlaygroundPage = () => {
+  if (renderPlaygroundPage) {
+    return renderPlaygroundPage
+  } else {
+    renderPlaygroundPage = require('graphql-playground-html').renderPlaygroundPage
+    return renderPlaygroundPage
+  }
+}
 export const GET = (config: Promise<SanitizedConfig>) => async (request: Request) => {
   const req = await createPayloadRequest({
     config,
     request,
   })
 
+  const renderPlaygroundPage = getRenderPlaygroundPage()
+
   if (
     (!req.payload.config.graphQL.disable &&
       !req.payload.config.graphQL.disablePlaygroundInProduction &&

packages/payload/package.json

@@ -125,13 +125,11 @@
     "copyfiles": "2.4.1",
     "cross-env": "7.0.3",
     "esbuild": "0.23.1",
+    "graphql": "^16.8.1",
     "graphql-http": "^1.22.0",
     "rimraf": "3.0.2",
     "sharp": "0.32.6"
   },
-  "peerDependencies": {
-    "graphql": "^16.8.1"
-  },
   "engines": {
     "node": "^18.20.2 || >=20.9.0"
   },

packages/payload/src/collections/config/types.ts

@@ -525,11 +525,11 @@ export interface SanitizedCollectionConfig
   auth: Auth
   endpoints: Endpoint[] | false
   fields: Field[]
-  slug: CollectionSlug
   /**
    * Object of collections to join 'Join Fields object keyed by collection
    */
   joins: SanitizedJoins
+  slug: CollectionSlug
   upload: SanitizedUploadConfig
   versions: SanitizedCollectionVersions
 }

packages/payload/src/config/sanitize.ts

@@ -97,6 +97,12 @@ export const sanitizeConfig = async (incomingConfig: Config): Promise<SanitizedC
     },
   }
 
+  if (configWithDefaults.graphQL.disable) {
+    configWithDefaults.graphQL = { disable: true }
+    delete configWithDefaults.routes.graphQL
+    delete configWithDefaults.routes.graphQLPlayground
+  }
+
   if (!configWithDefaults?.serverURL) {
     configWithDefaults.serverURL = ''
   }

packages/payload/src/index.ts

@@ -1,6 +1,7 @@
 import type { ExecutionResult, GraphQLSchema, ValidationRule } from 'graphql'
 import type { Request as graphQLRequest, OperationArgs } from 'graphql-http'
 import type { Logger } from 'pino'
+import type { NonNever } from 'ts-essentials'
 
 import { spawn } from 'child_process'
 import crypto from 'crypto'
@@ -25,12 +26,6 @@ import type {
   SelectFromCollectionSlug,
   TypeWithID,
 } from './collections/config/types.js'
-
-import { generateImportMap, type ImportMap } from './bin/generateImportMap/index.js'
-export type { FieldState } from './admin/forms/Form.js'
-export type * from './admin/types.js'
-import type { NonNever } from 'ts-essentials'
-
 import type { Options as CountOptions } from './collections/operations/local/count.js'
 import type { Options as CreateOptions } from './collections/operations/local/create.js'
 import type {
@@ -72,6 +67,7 @@ import type { TypeWithVersion } from './versions/types.js'
 import { decrypt, encrypt } from './auth/crypto.js'
 import { APIKeyAuthentication } from './auth/strategies/apiKey.js'
 import { JWTAuthentication } from './auth/strategies/jwt.js'
+import { generateImportMap, type ImportMap } from './bin/generateImportMap/index.js'
 import { checkPayloadDependencies } from './checkPayloadDependencies.js'
 import localOperations from './collections/operations/local/index.js'
 import { consoleEmailAdapter } from './email/consoleEmailAdapter.js'
@@ -82,6 +78,9 @@ import { getLogger } from './utilities/logger.js'
 import { serverInit as serverInitTelemetry } from './utilities/telemetry/events/serverInit.js'
 import { traverseFields } from './utilities/traverseFields.js'
 
+export type { FieldState } from './admin/forms/Form.js'
+export type * from './admin/types.js'
+
 export interface GeneratedTypes {
   authUntyped: {
     [slug: string]: {
@@ -459,7 +458,7 @@ export class BasePayload {
     return restoreVersion<TSlug>(this, options)
   }
 
-  schema: GraphQLSchema
+  schema?: GraphQLSchema
 
   secret: string