@graphql-codegen/schema-ast 2.3.0 → 2.4.1

package/index.d.ts

@@ -22,7 +22,24 @@ export interface SchemaASTConfig {
      */
     includeDirectives?: boolean;
     /**
-     * @description Set to true in order to print description as comments (using # instead of """)
+     * @description Include introspection types to Schema output.
+     * @default false
+     *
+     * @exampleMarkdown
+     * ```yml
+     * schema:
+     *   - './src/schema.graphql'
+     * generates:
+     *   path/to/file.graphql:
+     *     plugins:
+     *       - schema-ast
+     *     config:
+     *       includeIntrospectionTypes: true
+     * ```
+     */
+    includeIntrospectionTypes?: boolean;
+    /**
+     * @description Set to true in order to print description as comments (using `#` instead of `"""`)
      * @default false
      *
      * @exampleMarkdown
@@ -38,8 +55,8 @@ export interface SchemaASTConfig {
      */
     commentDescriptions?: boolean;
     /**
-     * @description Set to true in order get the schema lexicographically sorted before printed.
-     * @default false
+     * @description Set to false to disable sorting
+     * @default true
      */
     sort?: boolean;
     federation?: boolean;

package/index.js

@@ -6,12 +6,16 @@ const graphql = require('graphql');
 const pluginHelpers = require('@graphql-codegen/plugin-helpers');
 const path = require('path');
 
-const plugin = async (schema, _documents, { commentDescriptions = false, includeDirectives = false, sort = false, federation }) => {
-    const transformedSchemaAndAst = transformSchemaAST(schema, { sort, federation });
-    if (includeDirectives) {
-        return graphql.print(transformedSchemaAndAst.ast);
-    }
-    return graphql.printSchema(transformedSchemaAndAst.schema, { commentDescriptions });
+const plugin = async (schema, _documents, { commentDescriptions = false, includeDirectives = false, includeIntrospectionTypes = false, sort = false, federation, }) => {
+    const transformedSchemaAndAst = transformSchemaAST(schema, { sort, federation, includeIntrospectionTypes });
+    return [
+        includeIntrospectionTypes ? graphql.printIntrospectionSchema(transformedSchemaAndAst.schema) : null,
+        includeDirectives
+            ? graphql.print(transformedSchemaAndAst.ast)
+            : graphql.printSchema(transformedSchemaAndAst.schema, { commentDescriptions }),
+    ]
+        .filter(Boolean)
+        .join('\n');
 };
 const validate = async (_schema, _documents, _config, outputFile, allPlugins) => {
     const singlePlugin = allPlugins.length === 1;
@@ -21,6 +25,16 @@ const validate = async (_schema, _documents, _config, outputFile, allPlugins) =>
 };
 function transformSchemaAST(schema, config) {
     schema = config.federation ? pluginHelpers.removeFederation(schema) : schema;
+    if (config.includeIntrospectionTypes) {
+        // See: https://spec.graphql.org/June2018/#sec-Schema-Introspection
+        const introspectionAST = graphql.parse(`
+      extend type Query {
+        __schema: __Schema!
+        __type(name: String!): __Type
+      }
+    `);
+        schema = graphql.extendSchema(schema, introspectionAST);
+    }
     let ast = pluginHelpers.getCachedDocumentNodeFromSchema(schema);
     ast = config.disableDescriptions
         ? graphql.visit(ast, {

package/index.mjs

@@ -1,13 +1,17 @@
-import { print, printSchema, visit, buildASTSchema } from 'graphql';
+import { printIntrospectionSchema, print, printSchema, parse, extendSchema, visit, buildASTSchema } from 'graphql';
 import { removeFederation, getCachedDocumentNodeFromSchema } from '@graphql-codegen/plugin-helpers';
 import { extname } from 'path';
 
-const plugin = async (schema, _documents, { commentDescriptions = false, includeDirectives = false, sort = false, federation }) => {
-    const transformedSchemaAndAst = transformSchemaAST(schema, { sort, federation });
-    if (includeDirectives) {
-        return print(transformedSchemaAndAst.ast);
-    }
-    return printSchema(transformedSchemaAndAst.schema, { commentDescriptions });
+const plugin = async (schema, _documents, { commentDescriptions = false, includeDirectives = false, includeIntrospectionTypes = false, sort = false, federation, }) => {
+    const transformedSchemaAndAst = transformSchemaAST(schema, { sort, federation, includeIntrospectionTypes });
+    return [
+        includeIntrospectionTypes ? printIntrospectionSchema(transformedSchemaAndAst.schema) : null,
+        includeDirectives
+            ? print(transformedSchemaAndAst.ast)
+            : printSchema(transformedSchemaAndAst.schema, { commentDescriptions }),
+    ]
+        .filter(Boolean)
+        .join('\n');
 };
 const validate = async (_schema, _documents, _config, outputFile, allPlugins) => {
     const singlePlugin = allPlugins.length === 1;
@@ -17,6 +21,16 @@ const validate = async (_schema, _documents, _config, outputFile, allPlugins) =>
 };
 function transformSchemaAST(schema, config) {
     schema = config.federation ? removeFederation(schema) : schema;
+    if (config.includeIntrospectionTypes) {
+        // See: https://spec.graphql.org/June2018/#sec-Schema-Introspection
+        const introspectionAST = parse(`
+      extend type Query {
+        __schema: __Schema!
+        __type(name: String!): __Type
+      }
+    `);
+        schema = extendSchema(schema, introspectionAST);
+    }
     let ast = getCachedDocumentNodeFromSchema(schema);
     ast = config.disableDescriptions
         ? visit(ast, {

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@graphql-codegen/schema-ast",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "description": "GraphQL Code Generator plugin for generating a .graphql file from a given schema",
   "peerDependencies": {
-    "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0"
+    "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@graphql-codegen/plugin-helpers": "^2.3.0",
+    "@graphql-codegen/plugin-helpers": "^2.3.2",
     "@graphql-tools/utils": "^8.1.1",
     "tslib": "~2.3.0"
   },
@@ -23,6 +23,7 @@
     "definition": "index.d.ts"
   },
   "exports": {
+    "./package.json": "./package.json",
     ".": {
       "require": "./index.js",
       "import": "./index.mjs"