payload 0.18.5 → 0.19.0

package/docs/graphql/graphql-schema.mdx

@@ -0,0 +1,53 @@
+---
+title: GraphQL Schema
+label: GraphQL Schema
+order: 30
+desc: Output your own GraphQL schema based on your collections and globals to a file.
+keywords: headless cms, typescript, documentation, Content Management System, cms, headless, javascript, node, react, express
+---
+
+When working with GraphQL it is useful to have the schema for development of other projects that need to call on your GraphQL endpoint. In Payload the schema is controlled by your collections and globals and is made available to the developer or third parties, it is not necessary for developers using Payload to write schema types manually.
+
+### GraphQL Schema generate script
+
+Run the following command in a Payload project to generate your project's GraphQL schema from Payload:
+
+```
+payload generate:graphQLSchema
+```
+
+You can run this command whenever you need to regenerate your graphQL schema and output it to a file, and then you can use the schema for writing your own graphQL elsewhere in other projects.
+
+### GraphQL schema output file
+
+```js
+{
+  // the remainder of your config
+	graphQL: {
+		schemaOutputFile: path.resolve(__dirname, './graphql/schema.graphql'),
+	},
+}
+```
+
+The above example outputs all your definitions to a file relative from your payload config as `./graphql/schema.graphql`. By default, the file will be output to your current working directory as `schema.graphql`.
+
+#### Adding an NPM script
+
+<Banner type="warning">
+  <strong>Important:</strong><br/>
+  Payload needs to be able to find your config to generate your GraphQL schema.
+</Banner>
+
+Payload will automatically try and locate your config, but might not always be able to find it. For example, if you are working in a `/src` directory or similar, you need to tell Payload where to find your config manually by using an environment variable. If this applies to you, you can create an NPM script to make generating your types easier.
+
+To add an NPM script to generate your types and show Payload where to find your config, open your `package.json` and update the `scripts` property to the following:
+
+```json
+{
+  "scripts": {
+    "generate:types": "PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:types",
+  },
+}
+```
+
+Now you can run `yarn generate:graphQLSchema` to easily generate your schema.

package/docs/graphql/overview.mdx

@@ -12,6 +12,19 @@ By default, the GraphQL API is exposed via `/api/graphql`, but you can customize
 
 The labels you provide for your Collections and Globals are used to name the GraphQL types that are created to correspond to your config. Special characters and spaces are removed.
 
+## GraphQL Options
+
+At the top of your Payload config you can define all the options to manage GraphQL. The
+
+| Option               | Description  |
+| -------------------- | -------------|
+| `mutations`                     | Any custom Mutations to be added in addition to what Payload provides. [More](/docs/graphql/extending) |
+| `queries`                       | Any custom Queries to be added in addition to what Payload provides. [More](/docs/graphql/extending) |
+| `maxComplexity`                 | A number used to set the maximum allowed complexity allowed by requests [More](/docs/graphql/overview#query-complexity-limits) |
+| `disablePlaygroundInProduction` | A boolean that if false will enable the graphQL playground, defaults to true. [More](/docs/graphql/overview#graphql-playground) |
+| `disable`                       | A boolean that if false will disable the graphQL entirely, defaults to false. |
+| `schemaOutputFile`              | A string for the file path used by the generate schema command. Defaults to `graphql.schema` next to `payload.config.ts` [More](/docs/graphql/graphql-schema) |
+
 ## Collections
 
 Everything that can be done to a Collection via the REST or Local API can be done with GraphQL (outside of uploading files, which is REST-only). If you have a collection as follows:

package/docs/local-api/overview.mdx

@@ -102,6 +102,10 @@ const post = await payload.create({
   // a file directly through the Local API by providing
   // its full, absolute file path.
   filePath: path.resolve(__dirname, './path-to-image.jpg'),
+
+  // Alternatively, you can directly pass a File,
+  // if file is provided, filePath will be omitted
+  file: uploadedFile,
 })
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payload",
-  "version": "0.18.5",
+  "version": "0.19.0",
   "description": "Node, React and MongoDB Headless CMS and Application Framework",
   "license": "MIT",
   "author": {
@@ -27,7 +27,7 @@
     "payload": "bin.js"
   },
   "scripts": {
-    "copyfiles": "copyfiles -u 1 src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png} dist/",
+    "copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png}\" dist/",
     "build:tsc": "tsc --p tsconfig.admin.json && tsc --p tsconfig.server.json",
     "build:components": "webpack --config dist/webpack/components.config.js",
     "build": "yarn copyfiles && yarn build:tsc && yarn build:components",
@@ -35,6 +35,7 @@
     "demo:build:analyze": "cross-env PAYLOAD_CONFIG_PATH=demo/payload.config.ts PAYLOAD_ANALYZE_BUNDLE=true node dist/bin/build",
     "demo:build": "cross-env PAYLOAD_CONFIG_PATH=demo/payload.config.ts node dist/bin/build",
     "demo:generate:types": "cross-env PAYLOAD_CONFIG_PATH=demo/payload.config.ts node dist/bin/generateTypes",
+    "demo:generate:graphqlschema": "cross-env PAYLOAD_CONFIG_PATH=demo/payload.config.ts node dist/bin/generateGraphQLSchema",
     "demo:serve": "cross-env PAYLOAD_CONFIG_PATH=demo/payload.config.ts NODE_ENV=production nodemon",
     "dev": "cross-env PAYLOAD_CONFIG_PATH=demo/payload.config.ts nodemon",
     "test": "yarn test:int && yarn test:client",

package/dist/graphql/index.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="node" />
-declare const initializeGraphQL: (req: any, res: any) => (request: import("http").IncomingMessage & {
-    url: string;
-}, response: import("http").ServerResponse & {
-    json?: (data: unknown) => void;
-}) => Promise<void>;
-export default initializeGraphQL;