graphql 14.1.1 → 14.3.1

package/type/definition.js.flow

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2015-present, Facebook, Inc.
+ * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -14,33 +14,34 @@ import instanceOf from '../jsutils/instanceOf';
 import inspect from '../jsutils/inspect';
 import invariant from '../jsutils/invariant';
 import keyMap from '../jsutils/keyMap';
+import keyValMap from '../jsutils/keyValMap';
 import mapValue from '../jsutils/mapValue';
-import type { ObjMap } from '../jsutils/ObjMap';
+import { type ObjMap } from '../jsutils/ObjMap';
 import { Kind } from '../language/kinds';
 import { valueFromASTUntyped } from '../utilities/valueFromASTUntyped';
-import type {
-  ScalarTypeDefinitionNode,
-  ObjectTypeDefinitionNode,
-  FieldDefinitionNode,
-  InputValueDefinitionNode,
-  InterfaceTypeDefinitionNode,
-  UnionTypeDefinitionNode,
-  EnumTypeDefinitionNode,
-  EnumValueDefinitionNode,
-  InputObjectTypeDefinitionNode,
-  ScalarTypeExtensionNode,
-  ObjectTypeExtensionNode,
-  InterfaceTypeExtensionNode,
-  UnionTypeExtensionNode,
-  EnumTypeExtensionNode,
-  InputObjectTypeExtensionNode,
-  OperationDefinitionNode,
-  FieldNode,
-  FragmentDefinitionNode,
-  ValueNode,
+import {
+  type ScalarTypeDefinitionNode,
+  type ObjectTypeDefinitionNode,
+  type FieldDefinitionNode,
+  type InputValueDefinitionNode,
+  type InterfaceTypeDefinitionNode,
+  type UnionTypeDefinitionNode,
+  type EnumTypeDefinitionNode,
+  type EnumValueDefinitionNode,
+  type InputObjectTypeDefinitionNode,
+  type ScalarTypeExtensionNode,
+  type ObjectTypeExtensionNode,
+  type InterfaceTypeExtensionNode,
+  type UnionTypeExtensionNode,
+  type EnumTypeExtensionNode,
+  type InputObjectTypeExtensionNode,
+  type OperationDefinitionNode,
+  type FieldNode,
+  type FragmentDefinitionNode,
+  type ValueNode,
 } from '../language/ast';
-import type { GraphQLSchema } from './schema';
-import type { MaybePromise } from '../jsutils/MaybePromise';
+import { type GraphQLSchema } from './schema';
+import { type PromiseOrValue } from '../jsutils/PromiseOrValue';
 
 // Predicates & Assertions
 
@@ -360,6 +361,9 @@ export function GraphQLList(ofType) {
 (GraphQLList.prototype: any).toString = function toString() {
   return '[' + String(this.ofType) + ']';
 };
+
+// Conditionally apply `[Symbol.toStringTag]` if `Symbol`s are supported
+defineToStringTag(GraphQLList);
 defineToJSON(GraphQLList);
 
 /**
@@ -401,6 +405,9 @@ export function GraphQLNonNull(ofType) {
 (GraphQLNonNull.prototype: any).toString = function toString() {
   return String(this.ofType) + '!';
 };
+
+// Conditionally apply `[Symbol.toStringTag]` if `Symbol`s are supported
+defineToStringTag(GraphQLNonNull);
 defineToJSON(GraphQLNonNull);
 
 /**
@@ -511,6 +518,10 @@ function resolveThunk<+T>(thunk: Thunk<T>): T {
   return typeof thunk === 'function' ? thunk() : thunk;
 }
 
+function undefineIfEmpty<T>(arr: ?$ReadOnlyArray<T>): ?$ReadOnlyArray<T> {
+  return arr && arr.length > 0 ? arr : undefined;
+}
+
 /**
  * Scalar Type Definition
  *
@@ -551,7 +562,7 @@ export class GraphQLScalarType {
     this.parseValue = config.parseValue || (value => value);
     this.parseLiteral = config.parseLiteral || valueFromASTUntyped;
     this.astNode = config.astNode;
-    this.extensionASTNodes = config.extensionASTNodes;
+    this.extensionASTNodes = undefineIfEmpty(config.extensionASTNodes);
     invariant(typeof config.name === 'string', 'Must provide name.');
     invariant(
       typeof config.serialize === 'function',
@@ -569,6 +580,23 @@ export class GraphQLScalarType {
     }
   }
 
+  toConfig(): {|
+    ...GraphQLScalarTypeConfig<*, *>,
+    parseValue: GraphQLScalarValueParser<*>,
+    parseLiteral: GraphQLScalarLiteralParser<*>,
+    extensionASTNodes: $ReadOnlyArray<ScalarTypeExtensionNode>,
+  |} {
+    return {
+      name: this.name,
+      description: this.description,
+      serialize: this.serialize,
+      parseValue: this.parseValue,
+      parseLiteral: this.parseLiteral,
+      astNode: this.astNode,
+      extensionASTNodes: this.extensionASTNodes || [],
+    };
+  }
+
   toString(): string {
     return this.name;
   }
@@ -649,7 +677,7 @@ export class GraphQLObjectType {
     this.name = config.name;
     this.description = config.description;
     this.astNode = config.astNode;
-    this.extensionASTNodes = config.extensionASTNodes;
+    this.extensionASTNodes = undefineIfEmpty(config.extensionASTNodes);
     this.isTypeOf = config.isTypeOf;
     this._fields = defineFieldMap.bind(undefined, config);
     this._interfaces = defineInterfaces.bind(undefined, config);
@@ -675,6 +703,23 @@ export class GraphQLObjectType {
     return this._interfaces;
   }
 
+  toConfig(): {|
+    ...GraphQLObjectTypeConfig<*, *>,
+    interfaces: Array<GraphQLInterfaceType>,
+    fields: GraphQLFieldConfigMap<*, *>,
+    extensionASTNodes: $ReadOnlyArray<ObjectTypeExtensionNode>,
+  |} {
+    return {
+      name: this.name,
+      description: this.description,
+      isTypeOf: this.isTypeOf,
+      interfaces: this.getInterfaces(),
+      fields: fieldsToFieldsConfig(this.getFields()),
+      astNode: this.astNode,
+      extensionASTNodes: this.extensionASTNodes || [],
+    };
+  }
+
   toString(): string {
     return this.name;
   }
@@ -714,7 +759,7 @@ function defineFieldMap<TSource, TContext>(
       `${config.name}.${fieldName} field config must be an object`,
     );
     invariant(
-      !fieldConfig.hasOwnProperty('isDeprecated'),
+      !('isDeprecated' in fieldConfig),
       `${config.name}.${fieldName} should provide "deprecationReason" ` +
         'instead of "isDeprecated".',
     );
@@ -752,6 +797,33 @@ function isPlainObj(obj) {
   return obj && typeof obj === 'object' && !Array.isArray(obj);
 }
 
+function fieldsToFieldsConfig(fields) {
+  return mapValue(fields, field => ({
+    type: field.type,
+    args: argsToArgsConfig(field.args),
+    resolve: field.resolve,
+    subscribe: field.subscribe,
+    deprecationReason: field.deprecationReason,
+    description: field.description,
+    astNode: field.astNode,
+  }));
+}
+
+export function argsToArgsConfig(
+  args: Array<GraphQLArgument>,
+): GraphQLFieldConfigArgumentMap {
+  return keyValMap(
+    args,
+    arg => arg.name,
+    arg => ({
+      type: arg.type,
+      defaultValue: arg.defaultValue,
+      description: arg.description,
+      astNode: arg.astNode,
+    }),
+  );
+}
+
 export type GraphQLObjectTypeConfig<TSource, TContext> = {|
   name: string,
   interfaces?: Thunk<?Array<GraphQLInterfaceType>>,
@@ -766,13 +838,14 @@ export type GraphQLTypeResolver<TSource, TContext> = (
   value: TSource,
   context: TContext,
   info: GraphQLResolveInfo,
-) => MaybePromise<?GraphQLObjectType | string>;
+  abstractType: GraphQLAbstractType,
+) => PromiseOrValue<?GraphQLObjectType | string>;
 
 export type GraphQLIsTypeOfFn<TSource, TContext> = (
   source: TSource,
   context: TContext,
   info: GraphQLResolveInfo,
-) => MaybePromise<boolean>;
+) => PromiseOrValue<boolean>;
 
 export type GraphQLFieldResolver<
   TSource,
@@ -893,7 +966,7 @@ export class GraphQLInterfaceType {
     this.name = config.name;
     this.description = config.description;
     this.astNode = config.astNode;
-    this.extensionASTNodes = config.extensionASTNodes;
+    this.extensionASTNodes = undefineIfEmpty(config.extensionASTNodes);
     this.resolveType = config.resolveType;
     this._fields = defineFieldMap.bind(undefined, config);
     invariant(typeof config.name === 'string', 'Must provide name.');
@@ -911,6 +984,21 @@ export class GraphQLInterfaceType {
     return this._fields;
   }
 
+  toConfig(): {|
+    ...GraphQLInterfaceTypeConfig<*, *>,
+    fields: GraphQLFieldConfigMap<*, *>,
+    extensionASTNodes: $ReadOnlyArray<InterfaceTypeExtensionNode>,
+  |} {
+    return {
+      name: this.name,
+      description: this.description,
+      resolveType: this.resolveType,
+      fields: fieldsToFieldsConfig(this.getFields()),
+      astNode: this.astNode,
+      extensionASTNodes: this.extensionASTNodes || [],
+    };
+  }
+
   toString(): string {
     return this.name;
   }
@@ -970,7 +1058,7 @@ export class GraphQLUnionType {
     this.name = config.name;
     this.description = config.description;
     this.astNode = config.astNode;
-    this.extensionASTNodes = config.extensionASTNodes;
+    this.extensionASTNodes = undefineIfEmpty(config.extensionASTNodes);
     this.resolveType = config.resolveType;
     this._types = defineTypes.bind(undefined, config);
     invariant(typeof config.name === 'string', 'Must provide name.');
@@ -988,6 +1076,21 @@ export class GraphQLUnionType {
     return this._types;
   }
 
+  toConfig(): {|
+    ...GraphQLUnionTypeConfig<*, *>,
+    types: Array<GraphQLObjectType>,
+    extensionASTNodes: $ReadOnlyArray<UnionTypeExtensionNode>,
+  |} {
+    return {
+      name: this.name,
+      description: this.description,
+      resolveType: this.resolveType,
+      types: this.getTypes(),
+      astNode: this.astNode,
+      extensionASTNodes: this.extensionASTNodes || [],
+    };
+  }
+
   toString(): string {
     return this.name;
   }
@@ -1058,7 +1161,7 @@ export class GraphQLEnumType /* <T> */ {
     this.name = config.name;
     this.description = config.description;
     this.astNode = config.astNode;
-    this.extensionASTNodes = config.extensionASTNodes;
+    this.extensionASTNodes = undefineIfEmpty(config.extensionASTNodes);
     this._values = defineEnumValues(this, config.values);
     this._valueLookup = new Map(
       this._values.map(enumValue => [enumValue.value, enumValue]),
@@ -1102,6 +1205,30 @@ export class GraphQLEnumType /* <T> */ {
     }
   }
 
+  toConfig(): {|
+    ...GraphQLEnumTypeConfig,
+    extensionASTNodes: $ReadOnlyArray<EnumTypeExtensionNode>,
+  |} {
+    const values = keyValMap(
+      this.getValues(),
+      value => value.name,
+      value => ({
+        description: value.description,
+        value: value.value,
+        deprecationReason: value.deprecationReason,
+        astNode: value.astNode,
+      }),
+    );
+
+    return {
+      name: this.name,
+      description: this.description,
+      values,
+      astNode: this.astNode,
+      extensionASTNodes: this.extensionASTNodes || [],
+    };
+  }
+
   toString(): string {
     return this.name;
   }
@@ -1126,7 +1253,7 @@ function defineEnumValues(
         `representing an internal value but got: ${inspect(value)}.`,
     );
     invariant(
-      !value.hasOwnProperty('isDeprecated'),
+      !('isDeprecated' in value),
       `${type.name}.${valueName} should provide "deprecationReason" instead ` +
         'of "isDeprecated".',
     );
@@ -1136,7 +1263,7 @@ function defineEnumValues(
       isDeprecated: Boolean(value.deprecationReason),
       deprecationReason: value.deprecationReason,
       astNode: value.astNode,
-      value: value.hasOwnProperty('value') ? value.value : valueName,
+      value: 'value' in value ? value.value : valueName,
     };
   });
 }
@@ -1199,7 +1326,7 @@ export class GraphQLInputObjectType {
     this.name = config.name;
     this.description = config.description;
     this.astNode = config.astNode;
-    this.extensionASTNodes = config.extensionASTNodes;
+    this.extensionASTNodes = undefineIfEmpty(config.extensionASTNodes);
     this._fields = defineInputFieldMap.bind(undefined, config);
     invariant(typeof config.name === 'string', 'Must provide name.');
   }
@@ -1211,6 +1338,27 @@ export class GraphQLInputObjectType {
     return this._fields;
   }
 
+  toConfig(): {|
+    ...GraphQLInputObjectTypeConfig,
+    fields: GraphQLInputFieldConfigMap,
+    extensionASTNodes: $ReadOnlyArray<InputObjectTypeExtensionNode>,
+  |} {
+    const fields = mapValue(this.getFields(), field => ({
+      description: field.description,
+      type: field.type,
+      defaultValue: field.defaultValue,
+      astNode: field.astNode,
+    }));
+
+    return {
+      name: this.name,
+      description: this.description,
+      fields,
+      astNode: this.astNode,
+      extensionASTNodes: this.extensionASTNodes || [],
+    };
+  }
+
   toString(): string {
     return this.name;
   }
@@ -1231,7 +1379,7 @@ function defineInputFieldMap(
   );
   return mapValue(fieldMap, (fieldConfig, fieldName) => {
     invariant(
-      !fieldConfig.hasOwnProperty('resolve'),
+      !('resolve' in fieldConfig),
       `${config.name}.${fieldName} field has a resolve property, but ` +
         'Input Types cannot define resolvers.',
     );