graphql 16.8.2 → 16.9.0

package/index.d.ts

@@ -54,6 +54,7 @@ export {
   GraphQLSkipDirective,
   GraphQLDeprecatedDirective,
   GraphQLSpecifiedByDirective,
+  GraphQLOneOfDirective,
   TypeKind,
   DEFAULT_DEPRECATION_REASON,
   introspectionTypes,
@@ -300,6 +301,7 @@ export {
   validate,
   ValidationContext,
   specifiedRules,
+  recommendedRules,
   ExecutableDefinitionsRule,
   FieldsOnCorrectTypeRule,
   FragmentsOnCompositeTypesRule,
@@ -326,6 +328,7 @@ export {
   ValuesOfCorrectTypeRule,
   VariablesAreInputTypesRule,
   VariablesInAllowedPositionRule,
+  MaxIntrospectionDepthRule,
   LoneSchemaDefinitionRule,
   UniqueOperationTypesRule,
   UniqueTypeNamesRule,

package/index.js

@@ -147,6 +147,12 @@ Object.defineProperty(exports, 'GraphQLObjectType', {
     return _index.GraphQLObjectType;
   },
 });
+Object.defineProperty(exports, 'GraphQLOneOfDirective', {
+  enumerable: true,
+  get: function () {
+    return _index.GraphQLOneOfDirective;
+  },
+});
 Object.defineProperty(exports, 'GraphQLScalarType', {
   enumerable: true,
   get: function () {
@@ -237,6 +243,12 @@ Object.defineProperty(exports, 'LoneSchemaDefinitionRule', {
     return _index4.LoneSchemaDefinitionRule;
   },
 });
+Object.defineProperty(exports, 'MaxIntrospectionDepthRule', {
+  enumerable: true,
+  get: function () {
+    return _index4.MaxIntrospectionDepthRule;
+  },
+});
 Object.defineProperty(exports, 'NoDeprecatedCustomRule', {
   enumerable: true,
   get: function () {
@@ -1131,6 +1143,12 @@ Object.defineProperty(exports, 'printType', {
     return _index6.printType;
   },
 });
+Object.defineProperty(exports, 'recommendedRules', {
+  enumerable: true,
+  get: function () {
+    return _index4.recommendedRules;
+  },
+});
 Object.defineProperty(exports, 'resolveObjMapThunk', {
   enumerable: true,
   get: function () {

package/index.mjs

@@ -55,7 +55,8 @@ export {
   GraphQLIncludeDirective,
   GraphQLSkipDirective,
   GraphQLDeprecatedDirective,
-  GraphQLSpecifiedByDirective, // "Enum" of Type Kinds
+  GraphQLSpecifiedByDirective,
+  GraphQLOneOfDirective, // "Enum" of Type Kinds
   TypeKind, // Constant Deprecation Reason
   DEFAULT_DEPRECATION_REASON, // GraphQL Types for introspection.
   introspectionTypes,
@@ -171,7 +172,8 @@ export {
 export {
   validate,
   ValidationContext, // All validation rules in the GraphQL Specification.
-  specifiedRules, // Individual validation rules.
+  specifiedRules,
+  recommendedRules, // Individual validation rules.
   ExecutableDefinitionsRule,
   FieldsOnCorrectTypeRule,
   FragmentsOnCompositeTypesRule,
@@ -197,7 +199,8 @@ export {
   UniqueVariableNamesRule,
   ValuesOfCorrectTypeRule,
   VariablesAreInputTypesRule,
-  VariablesInAllowedPositionRule, // SDL-specific validation rules
+  VariablesInAllowedPositionRule,
+  MaxIntrospectionDepthRule, // SDL-specific validation rules
   LoneSchemaDefinitionRule,
   UniqueOperationTypesRule,
   UniqueTypeNamesRule,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql",
-  "version": "16.8.2",
+  "version": "16.9.0",
   "description": "A Query Language and Runtime which can target any service.",
   "license": "MIT",
   "main": "index",

package/type/definition.d.ts

@@ -789,12 +789,13 @@ export declare class GraphQLEnumType {
 export interface GraphQLEnumTypeConfig {
   name: string;
   description?: Maybe<string>;
-  values: GraphQLEnumValueConfigMap;
+  values: ThunkObjMap<GraphQLEnumValueConfig>;
   extensions?: Maybe<Readonly<GraphQLEnumTypeExtensions>>;
   astNode?: Maybe<EnumTypeDefinitionNode>;
   extensionASTNodes?: Maybe<ReadonlyArray<EnumTypeExtensionNode>>;
 }
 interface GraphQLEnumTypeNormalizedConfig extends GraphQLEnumTypeConfig {
+  values: ObjMap<GraphQLEnumValueConfig>;
   extensions: Readonly<GraphQLEnumTypeExtensions>;
   extensionASTNodes: ReadonlyArray<EnumTypeExtensionNode>;
 }
@@ -865,6 +866,7 @@ export declare class GraphQLInputObjectType {
   extensions: Readonly<GraphQLInputObjectTypeExtensions>;
   astNode: Maybe<InputObjectTypeDefinitionNode>;
   extensionASTNodes: ReadonlyArray<InputObjectTypeExtensionNode>;
+  isOneOf: boolean;
   private _fields;
   constructor(config: Readonly<GraphQLInputObjectTypeConfig>);
   get [Symbol.toStringTag](): string;
@@ -880,6 +882,7 @@ export interface GraphQLInputObjectTypeConfig {
   extensions?: Maybe<Readonly<GraphQLInputObjectTypeExtensions>>;
   astNode?: Maybe<InputObjectTypeDefinitionNode>;
   extensionASTNodes?: Maybe<ReadonlyArray<InputObjectTypeExtensionNode>>;
+  isOneOf?: boolean;
 }
 interface GraphQLInputObjectTypeNormalizedConfig
   extends GraphQLInputObjectTypeConfig {

package/type/definition.js

@@ -1077,11 +1077,12 @@ class GraphQLEnumType {
       _config$extensionASTN5 !== void 0
         ? _config$extensionASTN5
         : [];
-    this._values = defineEnumValues(this.name, config.values);
-    this._valueLookup = new Map(
-      this._values.map((enumValue) => [enumValue.value, enumValue]),
-    );
-    this._nameLookup = (0, _keyMap.keyMap)(this._values, (value) => value.name);
+    this._values =
+      typeof config.values === 'function'
+        ? config.values
+        : defineEnumValues(this.name, config.values);
+    this._valueLookup = null;
+    this._nameLookup = null;
   }
 
   get [Symbol.toStringTag]() {
@@ -1089,14 +1090,31 @@ class GraphQLEnumType {
   }
 
   getValues() {
+    if (typeof this._values === 'function') {
+      this._values = defineEnumValues(this.name, this._values());
+    }
+
     return this._values;
   }
 
   getValue(name) {
+    if (this._nameLookup === null) {
+      this._nameLookup = (0, _keyMap.keyMap)(
+        this.getValues(),
+        (value) => value.name,
+      );
+    }
+
     return this._nameLookup[name];
   }
 
   serialize(outputValue) {
+    if (this._valueLookup === null) {
+      this._valueLookup = new Map(
+        this.getValues().map((enumValue) => [enumValue.value, enumValue]),
+      );
+    }
+
     const enumValue = this._valueLookup.get(outputValue);
 
     if (enumValue === undefined) {
@@ -1253,7 +1271,7 @@ function defineEnumValues(typeName, valueMap) {
  */
 class GraphQLInputObjectType {
   constructor(config) {
-    var _config$extensionASTN6;
+    var _config$extensionASTN6, _config$isOneOf;
 
     this.name = (0, _assertName.assertName)(config.name);
     this.description = config.description;
@@ -1264,6 +1282,10 @@ class GraphQLInputObjectType {
       _config$extensionASTN6 !== void 0
         ? _config$extensionASTN6
         : [];
+    this.isOneOf =
+      (_config$isOneOf = config.isOneOf) !== null && _config$isOneOf !== void 0
+        ? _config$isOneOf
+        : false;
     this._fields = defineInputFieldMap.bind(undefined, config);
   }
 
@@ -1295,6 +1317,7 @@ class GraphQLInputObjectType {
       extensions: this.extensions,
       astNode: this.astNode,
       extensionASTNodes: this.extensionASTNodes,
+      isOneOf: this.isOneOf,
     };
   }
 

package/type/definition.mjs

@@ -926,11 +926,12 @@ export class GraphQLEnumType {
       _config$extensionASTN5 !== void 0
         ? _config$extensionASTN5
         : [];
-    this._values = defineEnumValues(this.name, config.values);
-    this._valueLookup = new Map(
-      this._values.map((enumValue) => [enumValue.value, enumValue]),
-    );
-    this._nameLookup = keyMap(this._values, (value) => value.name);
+    this._values =
+      typeof config.values === 'function'
+        ? config.values
+        : defineEnumValues(this.name, config.values);
+    this._valueLookup = null;
+    this._nameLookup = null;
   }
 
   get [Symbol.toStringTag]() {
@@ -938,14 +939,28 @@ export class GraphQLEnumType {
   }
 
   getValues() {
+    if (typeof this._values === 'function') {
+      this._values = defineEnumValues(this.name, this._values());
+    }
+
     return this._values;
   }
 
   getValue(name) {
+    if (this._nameLookup === null) {
+      this._nameLookup = keyMap(this.getValues(), (value) => value.name);
+    }
+
     return this._nameLookup[name];
   }
 
   serialize(outputValue) {
+    if (this._valueLookup === null) {
+      this._valueLookup = new Map(
+        this.getValues().map((enumValue) => [enumValue.value, enumValue]),
+      );
+    }
+
     const enumValue = this._valueLookup.get(outputValue);
 
     if (enumValue === undefined) {
@@ -1093,7 +1108,7 @@ function defineEnumValues(typeName, valueMap) {
  */
 export class GraphQLInputObjectType {
   constructor(config) {
-    var _config$extensionASTN6;
+    var _config$extensionASTN6, _config$isOneOf;
 
     this.name = assertName(config.name);
     this.description = config.description;
@@ -1104,6 +1119,10 @@ export class GraphQLInputObjectType {
       _config$extensionASTN6 !== void 0
         ? _config$extensionASTN6
         : [];
+    this.isOneOf =
+      (_config$isOneOf = config.isOneOf) !== null && _config$isOneOf !== void 0
+        ? _config$isOneOf
+        : false;
     this._fields = defineInputFieldMap.bind(undefined, config);
   }
 
@@ -1135,6 +1154,7 @@ export class GraphQLInputObjectType {
       extensions: this.extensions,
       astNode: this.astNode,
       extensionASTNodes: this.extensionASTNodes,
+      isOneOf: this.isOneOf,
     };
   }
 

package/type/directives.d.ts

@@ -76,6 +76,10 @@ export declare const GraphQLDeprecatedDirective: GraphQLDirective;
  * Used to provide a URL for specifying the behavior of custom scalar definitions.
  */
 export declare const GraphQLSpecifiedByDirective: GraphQLDirective;
+/**
+ * Used to indicate an Input Object is a OneOf Input Object.
+ */
+export declare const GraphQLOneOfDirective: GraphQLDirective;
 /**
  * The full list of specified directives.
  */

package/type/directives.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, '__esModule', {
 });
 exports.GraphQLSpecifiedByDirective =
   exports.GraphQLSkipDirective =
+  exports.GraphQLOneOfDirective =
   exports.GraphQLIncludeDirective =
   exports.GraphQLDirective =
   exports.GraphQLDeprecatedDirective =
@@ -207,15 +208,28 @@ const GraphQLSpecifiedByDirective = new GraphQLDirective({
   },
 });
 /**
- * The full list of specified directives.
+ * Used to indicate an Input Object is a OneOf Input Object.
  */
 
 exports.GraphQLSpecifiedByDirective = GraphQLSpecifiedByDirective;
+const GraphQLOneOfDirective = new GraphQLDirective({
+  name: 'oneOf',
+  description:
+    'Indicates exactly one field must be supplied and this field must not be `null`.',
+  locations: [_directiveLocation.DirectiveLocation.INPUT_OBJECT],
+  args: {},
+});
+/**
+ * The full list of specified directives.
+ */
+
+exports.GraphQLOneOfDirective = GraphQLOneOfDirective;
 const specifiedDirectives = Object.freeze([
   GraphQLIncludeDirective,
   GraphQLSkipDirective,
   GraphQLDeprecatedDirective,
   GraphQLSpecifiedByDirective,
+  GraphQLOneOfDirective,
 ]);
 exports.specifiedDirectives = specifiedDirectives;
 

package/type/directives.mjs

@@ -175,6 +175,17 @@ export const GraphQLSpecifiedByDirective = new GraphQLDirective({
     },
   },
 });
+/**
+ * Used to indicate an Input Object is a OneOf Input Object.
+ */
+
+export const GraphQLOneOfDirective = new GraphQLDirective({
+  name: 'oneOf',
+  description:
+    'Indicates exactly one field must be supplied and this field must not be `null`.',
+  locations: [DirectiveLocation.INPUT_OBJECT],
+  args: {},
+});
 /**
  * The full list of specified directives.
  */
@@ -184,6 +195,7 @@ export const specifiedDirectives = Object.freeze([
   GraphQLSkipDirective,
   GraphQLDeprecatedDirective,
   GraphQLSpecifiedByDirective,
+  GraphQLOneOfDirective,
 ]);
 export function isSpecifiedDirective(directive) {
   return specifiedDirectives.some(({ name }) => name === directive.name);

package/type/index.d.ts

@@ -113,6 +113,7 @@ export {
   GraphQLSkipDirective,
   GraphQLDeprecatedDirective,
   GraphQLSpecifiedByDirective,
+  GraphQLOneOfDirective,
   DEFAULT_DEPRECATION_REASON,
 } from './directives';
 export type {

package/type/index.js

@@ -99,6 +99,12 @@ Object.defineProperty(exports, 'GraphQLObjectType', {
     return _definition.GraphQLObjectType;
   },
 });
+Object.defineProperty(exports, 'GraphQLOneOfDirective', {
+  enumerable: true,
+  get: function () {
+    return _directives.GraphQLOneOfDirective;
+  },
+});
 Object.defineProperty(exports, 'GraphQLScalarType', {
   enumerable: true,
   get: function () {

package/type/index.mjs

@@ -64,7 +64,8 @@ export {
   GraphQLIncludeDirective,
   GraphQLSkipDirective,
   GraphQLDeprecatedDirective,
-  GraphQLSpecifiedByDirective, // Constant Deprecation Reason
+  GraphQLSpecifiedByDirective,
+  GraphQLOneOfDirective, // Constant Deprecation Reason
   DEFAULT_DEPRECATION_REASON,
 } from './directives.mjs';
 // Common built-in scalar instances.

package/type/introspection.js

@@ -373,6 +373,14 @@ const __Type = new _definition.GraphQLObjectType({
       type: __Type,
       resolve: (type) => ('ofType' in type ? type.ofType : undefined),
     },
+    isOneOf: {
+      type: _scalars.GraphQLBoolean,
+      resolve: (type) => {
+        if ((0, _definition.isInputObjectType)(type)) {
+          return type.isOneOf;
+        }
+      },
+    },
   }),
 });
 

package/type/introspection.mjs

@@ -326,6 +326,14 @@ export const __Type = new GraphQLObjectType({
       type: __Type,
       resolve: (type) => ('ofType' in type ? type.ofType : undefined),
     },
+    isOneOf: {
+      type: GraphQLBoolean,
+      resolve: (type) => {
+        if (isInputObjectType(type)) {
+          return type.isOneOf;
+        }
+      },
+    },
   }),
 });
 export const __Field = new GraphQLObjectType({

package/type/validate.js

@@ -568,6 +568,30 @@ function validateInputFields(context, inputObj) {
         ],
       );
     }
+
+    if (inputObj.isOneOf) {
+      validateOneOfInputObjectField(inputObj, field, context);
+    }
+  }
+}
+
+function validateOneOfInputObjectField(type, field, context) {
+  if ((0, _definition.isNonNullType)(field.type)) {
+    var _field$astNode4;
+
+    context.reportError(
+      `OneOf input field ${type.name}.${field.name} must be nullable.`,
+      (_field$astNode4 = field.astNode) === null || _field$astNode4 === void 0
+        ? void 0
+        : _field$astNode4.type,
+    );
+  }
+
+  if (field.defaultValue !== undefined) {
+    context.reportError(
+      `OneOf input field ${type.name}.${field.name} cannot have a default value.`,
+      field.astNode,
+    );
   }
 }
 

package/type/validate.mjs

@@ -547,6 +547,30 @@ function validateInputFields(context, inputObj) {
         ],
       );
     }
+
+    if (inputObj.isOneOf) {
+      validateOneOfInputObjectField(inputObj, field, context);
+    }
+  }
+}
+
+function validateOneOfInputObjectField(type, field, context) {
+  if (isNonNullType(field.type)) {
+    var _field$astNode4;
+
+    context.reportError(
+      `OneOf input field ${type.name}.${field.name} must be nullable.`,
+      (_field$astNode4 = field.astNode) === null || _field$astNode4 === void 0
+        ? void 0
+        : _field$astNode4.type,
+    );
+  }
+
+  if (field.defaultValue !== undefined) {
+    context.reportError(
+      `OneOf input field ${type.name}.${field.name} cannot have a default value.`,
+      field.astNode,
+    );
   }
 }
 

package/utilities/buildClientSchema.js

@@ -279,6 +279,7 @@ function buildClientSchema(introspection, options) {
       name: inputObjectIntrospection.name,
       description: inputObjectIntrospection.description,
       fields: () => buildInputValueDefMap(inputObjectIntrospection.inputFields),
+      isOneOf: inputObjectIntrospection.isOneOf,
     });
   }
 

package/utilities/buildClientSchema.mjs

@@ -265,6 +265,7 @@ export function buildClientSchema(introspection, options) {
       name: inputObjectIntrospection.name,
       description: inputObjectIntrospection.description,
       fields: () => buildInputValueDefMap(inputObjectIntrospection.inputFields),
+      isOneOf: inputObjectIntrospection.isOneOf,
     });
   }
 

package/utilities/coerceInputValue.js

@@ -139,6 +139,31 @@ function coerceInputValueImpl(inputValue, type, onError, path) {
       }
     }
 
+    if (type.isOneOf) {
+      const keys = Object.keys(coercedValue);
+
+      if (keys.length !== 1) {
+        onError(
+          (0, _Path.pathToArray)(path),
+          inputValue,
+          new _GraphQLError.GraphQLError(
+            `Exactly one key must be specified for OneOf type "${type.name}".`,
+          ),
+        );
+      }
+
+      const key = keys[0];
+      const value = coercedValue[key];
+
+      if (value === null) {
+        onError(
+          (0, _Path.pathToArray)(path).concat(key),
+          value,
+          new _GraphQLError.GraphQLError(`Field "${key}" must be non-null.`),
+        );
+      }
+    }
+
     return coercedValue;
   }
 

package/utilities/coerceInputValue.mjs

@@ -124,6 +124,31 @@ function coerceInputValueImpl(inputValue, type, onError, path) {
       }
     }
 
+    if (type.isOneOf) {
+      const keys = Object.keys(coercedValue);
+
+      if (keys.length !== 1) {
+        onError(
+          pathToArray(path),
+          inputValue,
+          new GraphQLError(
+            `Exactly one key must be specified for OneOf type "${type.name}".`,
+          ),
+        );
+      }
+
+      const key = keys[0];
+      const value = coercedValue[key];
+
+      if (value === null) {
+        onError(
+          pathToArray(path).concat(key),
+          value,
+          new GraphQLError(`Field "${key}" must be non-null.`),
+        );
+      }
+    }
+
     return coercedValue;
   }
 

package/utilities/extendSchema.js

@@ -757,6 +757,7 @@ function extendSchemaImpl(schemaConfig, documentAST, options) {
           fields: () => buildInputFieldMap(allNodes),
           astNode,
           extensionASTNodes,
+          isOneOf: isOneOf(astNode),
         });
       }
     }
@@ -796,3 +797,12 @@ function getSpecifiedByURL(node) {
     ? void 0
     : specifiedBy.url;
 }
+/**
+ * Given an input object node, returns if the node should be OneOf.
+ */
+
+function isOneOf(node) {
+  return Boolean(
+    (0, _values.getDirectiveValues)(_directives.GraphQLOneOfDirective, node),
+  );
+}

package/utilities/extendSchema.mjs

@@ -29,6 +29,7 @@ import {
 import {
   GraphQLDeprecatedDirective,
   GraphQLDirective,
+  GraphQLOneOfDirective,
   GraphQLSpecifiedByDirective,
 } from '../type/directives.mjs';
 import {
@@ -755,6 +756,7 @@ export function extendSchemaImpl(schemaConfig, documentAST, options) {
           fields: () => buildInputFieldMap(allNodes),
           astNode,
           extensionASTNodes,
+          isOneOf: isOneOf(astNode),
         });
       }
     }
@@ -787,3 +789,10 @@ function getSpecifiedByURL(node) {
     ? void 0
     : specifiedBy.url;
 }
+/**
+ * Given an input object node, returns if the node should be OneOf.
+ */
+
+function isOneOf(node) {
+  return Boolean(getDirectiveValues(GraphQLOneOfDirective, node));
+}

package/utilities/getIntrospectionQuery.d.ts

@@ -26,6 +26,11 @@ export interface IntrospectionOptions {
    * Default: false
    */
   inputValueDeprecation?: boolean;
+  /**
+   * Whether target GraphQL server supports `@oneOf` input objects.
+   * Default: false
+   */
+  oneOf?: boolean;
 }
 /**
  * Produce the GraphQL query recommended for a full schema introspection.
@@ -112,6 +117,7 @@ export interface IntrospectionInputObjectType {
   readonly name: string;
   readonly description?: Maybe<string>;
   readonly inputFields: ReadonlyArray<IntrospectionInputValue>;
+  readonly isOneOf: boolean;
 }
 export interface IntrospectionListTypeRef<
   T extends IntrospectionTypeRef = IntrospectionTypeRef,

package/utilities/getIntrospectionQuery.js

@@ -16,6 +16,7 @@ function getIntrospectionQuery(options) {
     directiveIsRepeatable: false,
     schemaDescription: false,
     inputValueDeprecation: false,
+    oneOf: false,
     ...options,
   };
   const descriptions = optionsWithDefault.descriptions ? 'description' : '';
@@ -33,6 +34,7 @@ function getIntrospectionQuery(options) {
     return optionsWithDefault.inputValueDeprecation ? str : '';
   }
 
+  const oneOf = optionsWithDefault.oneOf ? 'isOneOf' : '';
   return `
     query IntrospectionQuery {
       __schema {
@@ -60,6 +62,7 @@ function getIntrospectionQuery(options) {
       name
       ${descriptions}
       ${specifiedByUrl}
+      ${oneOf}
       fields(includeDeprecated: true) {
         name
         ${descriptions}