@graphql-codegen/schema-ast 2.5.1-alpha-0814e49cc.0 → 2.5.1

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@graphql-codegen/schema-ast",
-  "version": "2.5.1-alpha-0814e49cc.0",
+  "version": "2.5.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 || ^16.0.0"
   },
   "dependencies": {
-    "@graphql-codegen/plugin-helpers": "^2.6.1-alpha-0814e49cc.0",
+    "@graphql-codegen/plugin-helpers": "^2.6.2",
     "@graphql-tools/utils": "^8.8.0",
     "tslib": "~2.4.0"
   },
@@ -26,7 +26,7 @@
   "exports": {
     ".": {
       "require": {
-        "types": "./typings/index.d.ts",
+        "types": "./typings/index.d.cts",
         "default": "./cjs/index.js"
       },
       "import": {

package/typings/index.d.cts

@@ -0,0 +1,71 @@
+import { GraphQLSchema } from 'graphql';
+import { PluginFunction, PluginValidateFn } from '@graphql-codegen/plugin-helpers';
+/**
+ * @description This plugin prints the merged schema as string. If multiple schemas are provided, they will be merged and printed as one schema.
+ */
+export interface SchemaASTConfig {
+    /**
+     * @description Include directives to Schema output.
+     * @default false
+     *
+     * @exampleMarkdown
+     * ```yaml {8}
+     * schema:
+     *   - './src/schema.graphql'
+     * generates:
+     *   path/to/file.graphql:
+     *     plugins:
+     *       - schema-ast
+     *     config:
+     *       includeDirectives: true
+     * ```
+     */
+    includeDirectives?: boolean;
+    /**
+     * @description Include introspection types to Schema output.
+     * @default false
+     *
+     * @exampleMarkdown
+     * ```yaml {8}
+     * 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
+     * ```yaml {7}
+     * schema: http://localhost:3000/graphql
+     * generates:
+     *   schema.graphql:
+     *     plugins:
+     *       - schema-ast
+     *     config:
+     *       commentDescriptions: true
+     * ```
+     */
+    commentDescriptions?: boolean;
+    /**
+     * @description Set to false to disable sorting
+     * @default true
+     */
+    sort?: boolean;
+    federation?: boolean;
+}
+export declare const plugin: PluginFunction<SchemaASTConfig>;
+export declare const validate: PluginValidateFn<any>;
+export declare function transformSchemaAST(schema: GraphQLSchema, config: {
+    [key: string]: any;
+}): {
+    schema: GraphQLSchema;
+    ast: import("graphql").DocumentNode;
+};