graphql 16.3.0 → 16.5.0

package/type/definition.d.ts

@@ -302,10 +302,9 @@ export interface GraphQLScalarTypeExtensions {
  * Scalars (or Enums) and are defined with a name and a series of functions
  * used to parse input from ast or variables and to ensure validity.
  *
- * If a type's serialize function does not return a value (i.e. it returns
- * `undefined`) then an error will be raised and a `null` value will be returned
- * in the response. If the serialize function returns `null`, then no error will
- * be included in the response.
+ * If a type's serialize function returns `null` or does not return a value
+ * (i.e. it returns `undefined`) then an error will be raised and a `null`
+ * value will be returned in the response. It is always better to validate
  *
  * Example:
  *
@@ -313,9 +312,16 @@ export interface GraphQLScalarTypeExtensions {
  * const OddType = new GraphQLScalarType({
  *   name: 'Odd',
  *   serialize(value) {
- *     if (value % 2 === 1) {
- *       return value;
+ *     if (!Number.isFinite(value)) {
+ *       throw new Error(
+ *         `Scalar "Odd" cannot represent "${value}" since it is not a finite number.`,
+ *       );
  *     }
+ *
+ *     if (value % 2 === 0) {
+ *       throw new Error(`Scalar "Odd" cannot represent "${value}" since it is even.`);
+ *     }
+ *     return value;
  *   }
  * });
  * ```

package/type/definition.js

@@ -520,10 +520,9 @@ function resolveObjMapThunk(thunk) {
  * Scalars (or Enums) and are defined with a name and a series of functions
  * used to parse input from ast or variables and to ensure validity.
  *
- * If a type's serialize function does not return a value (i.e. it returns
- * `undefined`) then an error will be raised and a `null` value will be returned
- * in the response. If the serialize function returns `null`, then no error will
- * be included in the response.
+ * If a type's serialize function returns `null` or does not return a value
+ * (i.e. it returns `undefined`) then an error will be raised and a `null`
+ * value will be returned in the response. It is always better to validate
  *
  * Example:
  *
@@ -531,9 +530,16 @@ function resolveObjMapThunk(thunk) {
  * const OddType = new GraphQLScalarType({
  *   name: 'Odd',
  *   serialize(value) {
- *     if (value % 2 === 1) {
- *       return value;
+ *     if (!Number.isFinite(value)) {
+ *       throw new Error(
+ *         `Scalar "Odd" cannot represent "${value}" since it is not a finite number.`,
+ *       );
  *     }
+ *
+ *     if (value % 2 === 0) {
+ *       throw new Error(`Scalar "Odd" cannot represent "${value}" since it is even.`);
+ *     }
+ *     return value;
  *   }
  * });
  * ```
@@ -1134,7 +1140,9 @@ class GraphQLEnumType {
       throw new _GraphQLError.GraphQLError(
         `Enum "${this.name}" cannot represent non-enum value: ${valueStr}.` +
           didYouMeanEnumValue(this, valueStr),
-        valueNode,
+        {
+          nodes: valueNode,
+        },
       );
     }
 
@@ -1145,7 +1153,9 @@ class GraphQLEnumType {
       throw new _GraphQLError.GraphQLError(
         `Value "${valueStr}" does not exist in "${this.name}" enum.` +
           didYouMeanEnumValue(this, valueStr),
-        valueNode,
+        {
+          nodes: valueNode,
+        },
       );
     }
 

package/type/definition.mjs

@@ -381,10 +381,9 @@ export function resolveObjMapThunk(thunk) {
  * Scalars (or Enums) and are defined with a name and a series of functions
  * used to parse input from ast or variables and to ensure validity.
  *
- * If a type's serialize function does not return a value (i.e. it returns
- * `undefined`) then an error will be raised and a `null` value will be returned
- * in the response. If the serialize function returns `null`, then no error will
- * be included in the response.
+ * If a type's serialize function returns `null` or does not return a value
+ * (i.e. it returns `undefined`) then an error will be raised and a `null`
+ * value will be returned in the response. It is always better to validate
  *
  * Example:
  *
@@ -392,9 +391,16 @@ export function resolveObjMapThunk(thunk) {
  * const OddType = new GraphQLScalarType({
  *   name: 'Odd',
  *   serialize(value) {
- *     if (value % 2 === 1) {
- *       return value;
+ *     if (!Number.isFinite(value)) {
+ *       throw new Error(
+ *         `Scalar "Odd" cannot represent "${value}" since it is not a finite number.`,
+ *       );
  *     }
+ *
+ *     if (value % 2 === 0) {
+ *       throw new Error(`Scalar "Odd" cannot represent "${value}" since it is even.`);
+ *     }
+ *     return value;
  *   }
  * });
  * ```
@@ -981,7 +987,9 @@ export class GraphQLEnumType {
       throw new GraphQLError(
         `Enum "${this.name}" cannot represent non-enum value: ${valueStr}.` +
           didYouMeanEnumValue(this, valueStr),
-        valueNode,
+        {
+          nodes: valueNode,
+        },
       );
     }
 
@@ -992,7 +1000,9 @@ export class GraphQLEnumType {
       throw new GraphQLError(
         `Value "${valueStr}" does not exist in "${this.name}" enum.` +
           didYouMeanEnumValue(this, valueStr),
-        valueNode,
+        {
+          nodes: valueNode,
+        },
       );
     }
 

package/type/scalars.js

@@ -99,7 +99,9 @@ const GraphQLInt = new _definition.GraphQLScalarType({
         `Int cannot represent non-integer value: ${(0, _printer.print)(
           valueNode,
         )}`,
-        valueNode,
+        {
+          nodes: valueNode,
+        },
       );
     }
 
@@ -108,7 +110,9 @@ const GraphQLInt = new _definition.GraphQLScalarType({
     if (num > GRAPHQL_MAX_INT || num < GRAPHQL_MIN_INT) {
       throw new _GraphQLError.GraphQLError(
         `Int cannot represent non 32-bit signed integer value: ${valueNode.value}`,
-        valueNode,
+        {
+          nodes: valueNode,
+        },
       );
     }
 
@@ -218,7 +222,9 @@ const GraphQLString = new _definition.GraphQLScalarType({
         `String cannot represent a non string value: ${(0, _printer.print)(
           valueNode,
         )}`,
-        valueNode,
+        {
+          nodes: valueNode,
+        },
       );
     }
 
@@ -266,7 +272,9 @@ const GraphQLBoolean = new _definition.GraphQLScalarType({
         `Boolean cannot represent a non boolean value: ${(0, _printer.print)(
           valueNode,
         )}`,
-        valueNode,
+        {
+          nodes: valueNode,
+        },
       );
     }
 
@@ -317,7 +325,9 @@ const GraphQLID = new _definition.GraphQLScalarType({
       throw new _GraphQLError.GraphQLError(
         'ID cannot represent a non-string and non-integer value: ' +
           (0, _printer.print)(valueNode),
-        valueNode,
+        {
+          nodes: valueNode,
+        },
       );
     }
 

package/type/scalars.mjs

@@ -70,7 +70,9 @@ export const GraphQLInt = new GraphQLScalarType({
     if (valueNode.kind !== Kind.INT) {
       throw new GraphQLError(
         `Int cannot represent non-integer value: ${print(valueNode)}`,
-        valueNode,
+        {
+          nodes: valueNode,
+        },
       );
     }
 
@@ -79,7 +81,9 @@ export const GraphQLInt = new GraphQLScalarType({
     if (num > GRAPHQL_MAX_INT || num < GRAPHQL_MIN_INT) {
       throw new GraphQLError(
         `Int cannot represent non 32-bit signed integer value: ${valueNode.value}`,
-        valueNode,
+        {
+          nodes: valueNode,
+        },
       );
     }
 
@@ -174,7 +178,9 @@ export const GraphQLString = new GraphQLScalarType({
     if (valueNode.kind !== Kind.STRING) {
       throw new GraphQLError(
         `String cannot represent a non string value: ${print(valueNode)}`,
-        valueNode,
+        {
+          nodes: valueNode,
+        },
       );
     }
 
@@ -215,7 +221,9 @@ export const GraphQLBoolean = new GraphQLScalarType({
     if (valueNode.kind !== Kind.BOOLEAN) {
       throw new GraphQLError(
         `Boolean cannot represent a non boolean value: ${print(valueNode)}`,
-        valueNode,
+        {
+          nodes: valueNode,
+        },
       );
     }
 
@@ -260,7 +268,9 @@ export const GraphQLID = new GraphQLScalarType({
       throw new GraphQLError(
         'ID cannot represent a non-string and non-integer value: ' +
           print(valueNode),
-        valueNode,
+        {
+          nodes: valueNode,
+        },
       );
     }
 

package/type/validate.js

@@ -69,7 +69,11 @@ class SchemaValidationContext {
   reportError(message, nodes) {
     const _nodes = Array.isArray(nodes) ? nodes.filter(Boolean) : nodes;
 
-    this._errors.push(new _GraphQLError.GraphQLError(message, _nodes));
+    this._errors.push(
+      new _GraphQLError.GraphQLError(message, {
+        nodes: _nodes,
+      }),
+    );
   }
 
   getErrors() {

package/type/validate.mjs

@@ -66,7 +66,11 @@ class SchemaValidationContext {
   reportError(message, nodes) {
     const _nodes = Array.isArray(nodes) ? nodes.filter(Boolean) : nodes;
 
-    this._errors.push(new GraphQLError(message, _nodes));
+    this._errors.push(
+      new GraphQLError(message, {
+        nodes: _nodes,
+      }),
+    );
   }
 
   getErrors() {

package/utilities/coerceInputValue.js

@@ -158,11 +158,9 @@ function coerceInputValueImpl(inputValue, type, onError, path) {
           inputValue,
           new _GraphQLError.GraphQLError(
             `Expected type "${type.name}". ` + error.message,
-            undefined,
-            undefined,
-            undefined,
-            undefined,
-            error,
+            {
+              originalError: error,
+            },
           ),
         );
       }

package/utilities/coerceInputValue.mjs

@@ -141,14 +141,9 @@ function coerceInputValueImpl(inputValue, type, onError, path) {
         onError(
           pathToArray(path),
           inputValue,
-          new GraphQLError(
-            `Expected type "${type.name}". ` + error.message,
-            undefined,
-            undefined,
-            undefined,
-            undefined,
-            error,
-          ),
+          new GraphQLError(`Expected type "${type.name}". ` + error.message, {
+            originalError: error,
+          }),
         );
       }
 

package/utilities/getOperationRootType.js

@@ -19,7 +19,9 @@ function getOperationRootType(schema, operation) {
     if (!queryType) {
       throw new _GraphQLError.GraphQLError(
         'Schema does not define the required query root type.',
-        operation,
+        {
+          nodes: operation,
+        },
       );
     }
 
@@ -32,7 +34,9 @@ function getOperationRootType(schema, operation) {
     if (!mutationType) {
       throw new _GraphQLError.GraphQLError(
         'Schema is not configured for mutations.',
-        operation,
+        {
+          nodes: operation,
+        },
       );
     }
 
@@ -45,7 +49,9 @@ function getOperationRootType(schema, operation) {
     if (!subscriptionType) {
       throw new _GraphQLError.GraphQLError(
         'Schema is not configured for subscriptions.',
-        operation,
+        {
+          nodes: operation,
+        },
       );
     }
 
@@ -54,6 +60,8 @@ function getOperationRootType(schema, operation) {
 
   throw new _GraphQLError.GraphQLError(
     'Can only have query, mutation and subscription operations.',
-    operation,
+    {
+      nodes: operation,
+    },
   );
 }

package/utilities/getOperationRootType.mjs

@@ -12,7 +12,9 @@ export function getOperationRootType(schema, operation) {
     if (!queryType) {
       throw new GraphQLError(
         'Schema does not define the required query root type.',
-        operation,
+        {
+          nodes: operation,
+        },
       );
     }
 
@@ -23,10 +25,9 @@ export function getOperationRootType(schema, operation) {
     const mutationType = schema.getMutationType();
 
     if (!mutationType) {
-      throw new GraphQLError(
-        'Schema is not configured for mutations.',
-        operation,
-      );
+      throw new GraphQLError('Schema is not configured for mutations.', {
+        nodes: operation,
+      });
     }
 
     return mutationType;
@@ -36,10 +37,9 @@ export function getOperationRootType(schema, operation) {
     const subscriptionType = schema.getSubscriptionType();
 
     if (!subscriptionType) {
-      throw new GraphQLError(
-        'Schema is not configured for subscriptions.',
-        operation,
-      );
+      throw new GraphQLError('Schema is not configured for subscriptions.', {
+        nodes: operation,
+      });
     }
 
     return subscriptionType;
@@ -47,6 +47,8 @@ export function getOperationRootType(schema, operation) {
 
   throw new GraphQLError(
     'Can only have query, mutation and subscription operations.',
-    operation,
+    {
+      nodes: operation,
+    },
   );
 }

package/validation/rules/ExecutableDefinitionsRule.js

@@ -32,7 +32,9 @@ function ExecutableDefinitionsRule(context) {
           context.reportError(
             new _GraphQLError.GraphQLError(
               `The ${defName} definition is not executable.`,
-              definition,
+              {
+                nodes: definition,
+              },
             ),
           );
         }

package/validation/rules/ExecutableDefinitionsRule.mjs

@@ -21,10 +21,9 @@ export function ExecutableDefinitionsRule(context) {
               ? 'schema'
               : '"' + definition.name.value + '"';
           context.reportError(
-            new GraphQLError(
-              `The ${defName} definition is not executable.`,
-              definition,
-            ),
+            new GraphQLError(`The ${defName} definition is not executable.`, {
+              nodes: definition,
+            }),
           );
         }
       }

package/validation/rules/FieldsOnCorrectTypeRule.js

@@ -51,7 +51,9 @@ function FieldsOnCorrectTypeRule(context) {
             new _GraphQLError.GraphQLError(
               `Cannot query field "${fieldName}" on type "${type.name}".` +
                 suggestion,
-              node,
+              {
+                nodes: node,
+              },
             ),
           );
         }

package/validation/rules/FieldsOnCorrectTypeRule.mjs

@@ -42,7 +42,9 @@ export function FieldsOnCorrectTypeRule(context) {
             new GraphQLError(
               `Cannot query field "${fieldName}" on type "${type.name}".` +
                 suggestion,
-              node,
+              {
+                nodes: node,
+              },
             ),
           );
         }

package/validation/rules/FragmentsOnCompositeTypesRule.js

@@ -38,7 +38,9 @@ function FragmentsOnCompositeTypesRule(context) {
           context.reportError(
             new _GraphQLError.GraphQLError(
               `Fragment cannot condition on non composite type "${typeStr}".`,
-              typeCondition,
+              {
+                nodes: typeCondition,
+              },
             ),
           );
         }
@@ -56,7 +58,9 @@ function FragmentsOnCompositeTypesRule(context) {
         context.reportError(
           new _GraphQLError.GraphQLError(
             `Fragment "${node.name.value}" cannot condition on non composite type "${typeStr}".`,
-            node.typeCondition,
+            {
+              nodes: node.typeCondition,
+            },
           ),
         );
       }

package/validation/rules/FragmentsOnCompositeTypesRule.mjs

@@ -25,7 +25,9 @@ export function FragmentsOnCompositeTypesRule(context) {
           context.reportError(
             new GraphQLError(
               `Fragment cannot condition on non composite type "${typeStr}".`,
-              typeCondition,
+              {
+                nodes: typeCondition,
+              },
             ),
           );
         }
@@ -40,7 +42,9 @@ export function FragmentsOnCompositeTypesRule(context) {
         context.reportError(
           new GraphQLError(
             `Fragment "${node.name.value}" cannot condition on non composite type "${typeStr}".`,
-            node.typeCondition,
+            {
+              nodes: node.typeCondition,
+            },
           ),
         );
       }

package/validation/rules/KnownArgumentNamesRule.js

@@ -46,7 +46,9 @@ function KnownArgumentNamesRule(context) {
           new _GraphQLError.GraphQLError(
             `Unknown argument "${argName}" on field "${parentType.name}.${fieldDef.name}".` +
               (0, _didYouMean.didYouMean)(suggestions),
-            argNode,
+            {
+              nodes: argNode,
+            },
           ),
         );
       }
@@ -103,7 +105,9 @@ function KnownArgumentNamesOnDirectivesRule(context) {
               new _GraphQLError.GraphQLError(
                 `Unknown argument "${argName}" on directive "@${directiveName}".` +
                   (0, _didYouMean.didYouMean)(suggestions),
-                argNode,
+                {
+                  nodes: argNode,
+                },
               ),
             );
           }

package/validation/rules/KnownArgumentNamesRule.mjs

@@ -31,7 +31,9 @@ export function KnownArgumentNamesRule(context) {
           new GraphQLError(
             `Unknown argument "${argName}" on field "${parentType.name}.${fieldDef.name}".` +
               didYouMean(suggestions),
-            argNode,
+            {
+              nodes: argNode,
+            },
           ),
         );
       }
@@ -85,7 +87,9 @@ export function KnownArgumentNamesOnDirectivesRule(context) {
               new GraphQLError(
                 `Unknown argument "${argName}" on directive "@${directiveName}".` +
                   didYouMean(suggestions),
-                argNode,
+                {
+                  nodes: argNode,
+                },
               ),
             );
           }

package/validation/rules/KnownDirectivesRule.js

@@ -53,7 +53,9 @@ function KnownDirectivesRule(context) {
 
       if (!locations) {
         context.reportError(
-          new _GraphQLError.GraphQLError(`Unknown directive "@${name}".`, node),
+          new _GraphQLError.GraphQLError(`Unknown directive "@${name}".`, {
+            nodes: node,
+          }),
         );
         return;
       }
@@ -64,7 +66,9 @@ function KnownDirectivesRule(context) {
         context.reportError(
           new _GraphQLError.GraphQLError(
             `Directive "@${name}" may not be used on ${candidateLocation}.`,
-            node,
+            {
+              nodes: node,
+            },
           ),
         );
       }

package/validation/rules/KnownDirectivesRule.mjs

@@ -40,7 +40,9 @@ export function KnownDirectivesRule(context) {
 
       if (!locations) {
         context.reportError(
-          new GraphQLError(`Unknown directive "@${name}".`, node),
+          new GraphQLError(`Unknown directive "@${name}".`, {
+            nodes: node,
+          }),
         );
         return;
       }
@@ -51,7 +53,9 @@ export function KnownDirectivesRule(context) {
         context.reportError(
           new GraphQLError(
             `Directive "@${name}" may not be used on ${candidateLocation}.`,
-            node,
+            {
+              nodes: node,
+            },
           ),
         );
       }

package/validation/rules/KnownFragmentNamesRule.js

@@ -25,7 +25,9 @@ function KnownFragmentNamesRule(context) {
         context.reportError(
           new _GraphQLError.GraphQLError(
             `Unknown fragment "${fragmentName}".`,
-            node.name,
+            {
+              nodes: node.name,
+            },
           ),
         );
       }

package/validation/rules/KnownFragmentNamesRule.mjs

@@ -16,7 +16,9 @@ export function KnownFragmentNamesRule(context) {
 
       if (!fragment) {
         context.reportError(
-          new GraphQLError(`Unknown fragment "${fragmentName}".`, node.name),
+          new GraphQLError(`Unknown fragment "${fragmentName}".`, {
+            nodes: node.name,
+          }),
         );
       }
     },

package/validation/rules/KnownTypeNamesRule.js

@@ -65,7 +65,9 @@ function KnownTypeNamesRule(context) {
           new _GraphQLError.GraphQLError(
             `Unknown type "${typeName}".` +
               (0, _didYouMean.didYouMean)(suggestedTypes),
-            node,
+            {
+              nodes: node,
+            },
           ),
         );
       }

package/validation/rules/KnownTypeNamesRule.mjs

@@ -56,7 +56,9 @@ export function KnownTypeNamesRule(context) {
         context.reportError(
           new GraphQLError(
             `Unknown type "${typeName}".` + didYouMean(suggestedTypes),
-            node,
+            {
+              nodes: node,
+            },
           ),
         );
       }

package/validation/rules/LoneAnonymousOperationRule.js

@@ -31,7 +31,9 @@ function LoneAnonymousOperationRule(context) {
         context.reportError(
           new _GraphQLError.GraphQLError(
             'This anonymous operation must be the only defined operation.',
-            node,
+            {
+              nodes: node,
+            },
           ),
         );
       }

package/validation/rules/LoneAnonymousOperationRule.mjs

@@ -23,7 +23,9 @@ export function LoneAnonymousOperationRule(context) {
         context.reportError(
           new GraphQLError(
             'This anonymous operation must be the only defined operation.',
-            node,
+            {
+              nodes: node,
+            },
           ),
         );
       }