planning

node_modules/graphql/utilities/buildASTSchema.js.flow

@@ -0,0 +1,129 @@
+// @flow strict
+import devAssert from '../jsutils/devAssert';
+
+import type { Source } from '../language/source';
+import type { DocumentNode } from '../language/ast';
+import type { ParseOptions } from '../language/parser';
+import { Kind } from '../language/kinds';
+import { parse } from '../language/parser';
+
+import { assertValidSDL } from '../validation/validate';
+
+import type { GraphQLSchemaValidationOptions } from '../type/schema';
+import { GraphQLSchema } from '../type/schema';
+import { specifiedDirectives } from '../type/directives';
+
+import { extendSchemaImpl } from './extendSchema';
+
+export type BuildSchemaOptions = {|
+  ...GraphQLSchemaValidationOptions,
+
+  /**
+   * Descriptions are defined as preceding string literals, however an older
+   * experimental version of the SDL supported preceding comments as
+   * descriptions. Set to true to enable this deprecated behavior.
+   * This option is provided to ease adoption and will be removed in v16.
+   *
+   * Default: false
+   */
+  commentDescriptions?: boolean,
+
+  /**
+   * Set to true to assume the SDL is valid.
+   *
+   * Default: false
+   */
+  assumeValidSDL?: boolean,
+|};
+
+/**
+ * This takes the ast of a schema document produced by the parse function in
+ * src/language/parser.js.
+ *
+ * If no schema definition is provided, then it will look for types named Query
+ * and Mutation.
+ *
+ * Given that AST it constructs a GraphQLSchema. The resulting schema
+ * has no resolve methods, so execution will use default resolvers.
+ *
+ * Accepts options as a second argument:
+ *
+ *    - commentDescriptions:
+ *        Provide true to use preceding comments as the description.
+ *
+ */
+export function buildASTSchema(
+  documentAST: DocumentNode,
+  options?: BuildSchemaOptions,
+): GraphQLSchema {
+  devAssert(
+    documentAST != null && documentAST.kind === Kind.DOCUMENT,
+    'Must provide valid Document AST.',
+  );
+
+  if (options?.assumeValid !== true && options?.assumeValidSDL !== true) {
+    assertValidSDL(documentAST);
+  }
+
+  const emptySchemaConfig = {
+    description: undefined,
+    types: [],
+    directives: [],
+    extensions: undefined,
+    extensionASTNodes: [],
+    assumeValid: false,
+  };
+  const config = extendSchemaImpl(emptySchemaConfig, documentAST, options);
+
+  if (config.astNode == null) {
+    for (const type of config.types) {
+      switch (type.name) {
+        // Note: While this could make early assertions to get the correctly
+        // typed values below, that would throw immediately while type system
+        // validation with validateSchema() will produce more actionable results.
+        case 'Query':
+          config.query = (type: any);
+          break;
+        case 'Mutation':
+          config.mutation = (type: any);
+          break;
+        case 'Subscription':
+          config.subscription = (type: any);
+          break;
+      }
+    }
+  }
+
+  const { directives } = config;
+  // If specified directives were not explicitly declared, add them.
+  for (const stdDirective of specifiedDirectives) {
+    if (directives.every((directive) => directive.name !== stdDirective.name)) {
+      directives.push(stdDirective);
+    }
+  }
+
+  return new GraphQLSchema(config);
+}
+
+/**
+ * A helper function to build a GraphQLSchema directly from a source
+ * document.
+ */
+export function buildSchema(
+  source: string | Source,
+  options?: {| ...BuildSchemaOptions, ...ParseOptions |},
+): GraphQLSchema {
+  const document = parse(source, {
+    noLocation: options?.noLocation,
+    allowLegacySDLEmptyFields: options?.allowLegacySDLEmptyFields,
+    allowLegacySDLImplementsInterfaces:
+      options?.allowLegacySDLImplementsInterfaces,
+    experimentalFragmentVariables: options?.experimentalFragmentVariables,
+  });
+
+  return buildASTSchema(document, {
+    commentDescriptions: options?.commentDescriptions,
+    assumeValidSDL: options?.assumeValidSDL,
+    assumeValid: options?.assumeValid,
+  });
+}