fix: implements graphql schema generation (#6254)

Co-authored-by: Elliot DeNolf <denolfe@gmail.com>

Author: JarrodMFlesch

.github/workflows/main.yml

@@ -423,7 +423,6 @@ jobs:
           pnpm run build
 
   tests-type-generation:
-    if: false # This should be replaced with gen on a real Payload project
     runs-on: ubuntu-latest
     needs: build
 

packages/graphql/bin.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { bin } from './dist/bin/index.js'
+
+bin()

packages/graphql/package.json

@@ -13,10 +13,18 @@
       "import": "./src/index.ts",
       "require": "./src/index.ts",
       "types": "./src/index.ts"
+    },
+    "./*": {
+      "import": "./src/exports/*.ts",
+      "require": "./src/exports/*.ts",
+      "types": "./src/exports/*.ts"
     }
   },
   "main": "./src/index.ts",
   "types": "./src/index.d.ts",
+  "bin": {
+    "payload-graphql": "bin.js"
+  },
   "files": [
     "dist"
   ],
@@ -48,6 +56,11 @@
         "import": "./dist/index.js",
         "require": "./dist/index.js",
         "types": "./dist/index.d.ts"
+      },
+      "./*": {
+        "import": "./dist/exports/*.js",
+        "require": "./dist/exports/*.js",
+        "types": "./dist/exports/*.d.ts"
       }
     },
     "main": "./dist/index.js",

packages/graphql/src/bin/generateSchema.ts

@@ -0,0 +1,14 @@
+/* eslint-disable @typescript-eslint/no-floating-promises */
+import type { SanitizedConfig } from 'payload/types'
+
+import fs from 'fs'
+import { printSchema } from 'graphql'
+
+import { configToSchema } from '../index.js'
+export function generateSchema(config: SanitizedConfig): void {
+  const outputFile = process.env.PAYLOAD_GRAPHQL_SCHEMA_PATH || config.graphQL.schemaOutputFile
+
+  const { schema } = configToSchema(config)
+
+  fs.writeFileSync(outputFile, printSchema(schema))
+}

packages/graphql/src/bin/index.ts

@@ -0,0 +1,21 @@
+/* eslint-disable no-console */
+import minimist from 'minimist'
+import { findConfig, importConfig, loadEnv } from 'payload/node'
+
+import { generateSchema } from './generateSchema.js'
+
+export const bin = async () => {
+  loadEnv()
+  const configPath = findConfig()
+  const config = await importConfig(configPath)
+
+  const args = minimist(process.argv.slice(2))
+  const script = (typeof args._[0] === 'string' ? args._[0] : '').toLowerCase()
+
+  if (script === 'generate:schema') {
+    return generateSchema(config)
+  }
+
+  console.log(`Unknown script: "${script}".`)
+  process.exit(1)
+}

packages/graphql/src/exports/utilities.ts

@@ -0,0 +1 @@
+export { generateSchema } from '../bin/generateSchema.js'

packages/payload/src/bin/loader/read-default-tsconfig.ts

@@ -1,3 +1,29 @@
+/**
+ *
+ * MIT License
+ *
+ * Copyright (c) 2020-present LongYinan
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
 import type { Options } from '@swc-node/core'
 
 import { resolve } from 'path'

packages/payload/src/config/defaults.ts

@@ -26,6 +26,7 @@ export const defaults: Omit<Config, 'db' | 'editor' | 'secret'> = {
   graphQL: {
     disablePlaygroundInProduction: true,
     maxComplexity: 1000,
+    schemaOutputFile: `${typeof process?.cwd === 'function' ? process.cwd() : ''}/schema.graphql`,
   },
   hooks: {},
   i18n: {},

packages/payload/src/config/schema.ts

@@ -110,6 +110,7 @@ export default joi.object({
     maxComplexity: joi.number(),
     mutations: joi.function(),
     queries: joi.function(),
+    schemaOutputFile: joi.string(),
   }),
   hooks: joi.object().keys({
     afterError: joi.func(),

packages/payload/src/config/types.ts

@@ -564,6 +564,10 @@ export type Config = {
      * @see https://payloadcms.com/docs/graphql/extending
      */
     queries?: GraphQLExtension
+    /**
+     * Filepath to write the generated schema to
+     */
+    schemaOutputFile?: string
   }
   /**
    * Tap into Payload-wide hooks.