@graphql-tools/utils 8.6.11 → 8.6.12-alpha-2e27df80.0

package/errors.d.ts

@@ -1,2 +1,15 @@
-import { GraphQLError } from 'graphql';
+import { ASTNode, GraphQLError, Source } from 'graphql';
+import { Maybe } from './types';
+interface GraphQLErrorOptions {
+    nodes?: ReadonlyArray<ASTNode> | ASTNode | null;
+    source?: Maybe<Source>;
+    positions?: Maybe<ReadonlyArray<number>>;
+    path?: Maybe<ReadonlyArray<string | number>>;
+    originalError?: Maybe<Error & {
+        readonly extensions?: unknown;
+    }>;
+    extensions?: any;
+}
+export declare function createGraphQLError(message: string, options: GraphQLErrorOptions): GraphQLError;
 export declare function relocatedError(originalError: GraphQLError, path?: ReadonlyArray<string | number>): GraphQLError;
+export {};

package/index.js

@@ -69,6 +69,27 @@ function assertSome(input, message = 'Value should be something') {
     }
 }
 
+function createGraphQLError(message, options) {
+    if (graphql.versionInfo.major > 15) {
+        const error = new graphql.GraphQLError(message, options);
+        Object.defineProperty(error, 'extensions', {
+            value: options.extensions || {},
+        });
+        return error;
+    }
+    return new graphql.GraphQLError(message, options.nodes, options.source, options.positions, options.path, options.originalError, options.extensions);
+}
+function relocatedError(originalError, path) {
+    return createGraphQLError(originalError.message, {
+        nodes: originalError.nodes,
+        source: originalError.source,
+        positions: originalError.positions,
+        path: path == null ? originalError.path : path,
+        originalError,
+        extensions: originalError.extensions,
+    });
+}
+
 if (typeof AggregateError === 'undefined') {
     class AggregateErrorClass extends Error {
         constructor(errors, message = '') {
@@ -217,7 +238,9 @@ function getArgumentValues(def, node, variableValues = {}) {
                 coercedValues[name] = defaultValue;
             }
             else if (graphql.isNonNullType(argType)) {
-                throw new graphql.GraphQLError(`Argument "${name}" of required type "${inspect(argType)}" ` + 'was not provided.', node);
+                throw createGraphQLError(`Argument "${name}" of required type "${inspect(argType)}" ` + 'was not provided.', {
+                    nodes: [node],
+                });
             }
             continue;
         }
@@ -230,22 +253,28 @@ function getArgumentValues(def, node, variableValues = {}) {
                     coercedValues[name] = defaultValue;
                 }
                 else if (graphql.isNonNullType(argType)) {
-                    throw new graphql.GraphQLError(`Argument "${name}" of required type "${inspect(argType)}" ` +
-                        `was provided the variable "$${variableName}" which was not provided a runtime value.`, valueNode);
+                    throw createGraphQLError(`Argument "${name}" of required type "${inspect(argType)}" ` +
+                        `was provided the variable "$${variableName}" which was not provided a runtime value.`, {
+                        nodes: [valueNode],
+                    });
                 }
                 continue;
             }
             isNull = variableValues[variableName] == null;
         }
         if (isNull && graphql.isNonNullType(argType)) {
-            throw new graphql.GraphQLError(`Argument "${name}" of non-null type "${inspect(argType)}" ` + 'must not be null.', valueNode);
+            throw createGraphQLError(`Argument "${name}" of non-null type "${inspect(argType)}" ` + 'must not be null.', {
+                nodes: [valueNode],
+            });
         }
         const coercedValue = graphql.valueFromAST(valueNode, argType, variableValues);
         if (coercedValue === undefined) {
             // Note: ValuesOfCorrectTypeRule validation should catch this before
             // execution. This is a runtime check to ensure execution does not
             // continue with an invalid argument value.
-            throw new graphql.GraphQLError(`Argument "${name}" has invalid value ${graphql.print(valueNode)}.`, valueNode);
+            throw createGraphQLError(`Argument "${name}" has invalid value ${graphql.print(valueNode)}.`, {
+                nodes: [valueNode],
+            });
         }
         coercedValues[name] = coercedValue;
     }
@@ -2091,6 +2120,30 @@ function hasCircularRef(types, config = {
     return size > config.depth;
 }
 
+(function (DirectiveLocation) {
+    /** Request Definitions */
+    DirectiveLocation["QUERY"] = "QUERY";
+    DirectiveLocation["MUTATION"] = "MUTATION";
+    DirectiveLocation["SUBSCRIPTION"] = "SUBSCRIPTION";
+    DirectiveLocation["FIELD"] = "FIELD";
+    DirectiveLocation["FRAGMENT_DEFINITION"] = "FRAGMENT_DEFINITION";
+    DirectiveLocation["FRAGMENT_SPREAD"] = "FRAGMENT_SPREAD";
+    DirectiveLocation["INLINE_FRAGMENT"] = "INLINE_FRAGMENT";
+    DirectiveLocation["VARIABLE_DEFINITION"] = "VARIABLE_DEFINITION";
+    /** Type System Definitions */
+    DirectiveLocation["SCHEMA"] = "SCHEMA";
+    DirectiveLocation["SCALAR"] = "SCALAR";
+    DirectiveLocation["OBJECT"] = "OBJECT";
+    DirectiveLocation["FIELD_DEFINITION"] = "FIELD_DEFINITION";
+    DirectiveLocation["ARGUMENT_DEFINITION"] = "ARGUMENT_DEFINITION";
+    DirectiveLocation["INTERFACE"] = "INTERFACE";
+    DirectiveLocation["UNION"] = "UNION";
+    DirectiveLocation["ENUM"] = "ENUM";
+    DirectiveLocation["ENUM_VALUE"] = "ENUM_VALUE";
+    DirectiveLocation["INPUT_OBJECT"] = "INPUT_OBJECT";
+    DirectiveLocation["INPUT_FIELD_DEFINITION"] = "INPUT_FIELD_DEFINITION";
+})(exports.DirectiveLocation || (exports.DirectiveLocation = {}));
+
 (function (MapperKind) {
     MapperKind["TYPE"] = "MapperKind.TYPE";
     MapperKind["SCALAR_TYPE"] = "MapperKind.SCALAR_TYPE";
@@ -3758,10 +3811,6 @@ function implementsAbstractType(schema, typeA, typeB) {
     return false;
 }
 
-function relocatedError(originalError, path) {
-    return new graphql.GraphQLError(originalError.message, originalError.nodes, originalError.source, originalError.positions, path === null ? undefined : path === undefined ? originalError.path : path, originalError.originalError, originalError.extensions);
-}
-
 function observableToAsyncIterable(observable) {
     const pullQueue = [];
     const pushQueue = [];
@@ -4285,6 +4334,7 @@ exports.compareNodes = compareNodes;
 exports.compareStrings = compareStrings;
 exports.correctASTNodes = correctASTNodes;
 exports.createDefaultRules = createDefaultRules;
+exports.createGraphQLError = createGraphQLError;
 exports.createNamedStub = createNamedStub;
 exports.createStub = createStub;
 exports.createVariableNameGenerator = createVariableNameGenerator;

package/index.mjs

@@ -1,4 +1,4 @@
-import { parse, GraphQLError, isNonNullType, Kind, valueFromAST, print, isObjectType, isListType, isSpecifiedDirective, astFromValue, isSpecifiedScalarType, isIntrospectionType, isInterfaceType, isUnionType, isInputObjectType, isEnumType, isScalarType, GraphQLDeprecatedDirective, specifiedRules, concatAST, validate, versionInfo, buildClientSchema, visit, TokenKind, Source, isTypeSystemDefinitionNode, getNamedType, GraphQLString, GraphQLNonNull, GraphQLList, GraphQLID, GraphQLBoolean, GraphQLFloat, GraphQLInt, GraphQLObjectType, GraphQLInterfaceType, GraphQLInputObjectType, GraphQLDirective, GraphQLUnionType, GraphQLEnumType, GraphQLScalarType, isNamedType, getNullableType, isLeafType, GraphQLSchema, isDirective, isCompositeType, doTypesOverlap, getOperationAST, getDirectiveValues, GraphQLSkipDirective, GraphQLIncludeDirective, typeFromAST, isAbstractType, TypeNameMetaFieldDef, buildASTSchema } from 'graphql';
+import { parse, versionInfo, GraphQLError, isNonNullType, Kind, valueFromAST, print, isObjectType, isListType, isSpecifiedDirective, astFromValue, isSpecifiedScalarType, isIntrospectionType, isInterfaceType, isUnionType, isInputObjectType, isEnumType, isScalarType, GraphQLDeprecatedDirective, specifiedRules, concatAST, validate, buildClientSchema, visit, TokenKind, Source, isTypeSystemDefinitionNode, getNamedType, GraphQLString, GraphQLNonNull, GraphQLList, GraphQLID, GraphQLBoolean, GraphQLFloat, GraphQLInt, GraphQLObjectType, GraphQLInterfaceType, GraphQLInputObjectType, GraphQLDirective, GraphQLUnionType, GraphQLEnumType, GraphQLScalarType, isNamedType, getNullableType, isLeafType, GraphQLSchema, isDirective, isCompositeType, doTypesOverlap, getOperationAST, getDirectiveValues, GraphQLSkipDirective, GraphQLIncludeDirective, typeFromAST, isAbstractType, TypeNameMetaFieldDef, buildASTSchema } from 'graphql';
 
 const asArray = (fns) => (Array.isArray(fns) ? fns : fns ? [fns] : []);
 const invalidDocRegex = /\.[a-z0-9]+$/i;
@@ -65,6 +65,27 @@ function assertSome(input, message = 'Value should be something') {
     }
 }
 
+function createGraphQLError(message, options) {
+    if (versionInfo.major > 15) {
+        const error = new GraphQLError(message, options);
+        Object.defineProperty(error, 'extensions', {
+            value: options.extensions || {},
+        });
+        return error;
+    }
+    return new GraphQLError(message, options.nodes, options.source, options.positions, options.path, options.originalError, options.extensions);
+}
+function relocatedError(originalError, path) {
+    return createGraphQLError(originalError.message, {
+        nodes: originalError.nodes,
+        source: originalError.source,
+        positions: originalError.positions,
+        path: path == null ? originalError.path : path,
+        originalError,
+        extensions: originalError.extensions,
+    });
+}
+
 let AggregateErrorImpl;
 if (typeof AggregateError === 'undefined') {
     class AggregateErrorClass extends Error {
@@ -214,7 +235,9 @@ function getArgumentValues(def, node, variableValues = {}) {
                 coercedValues[name] = defaultValue;
             }
             else if (isNonNullType(argType)) {
-                throw new GraphQLError(`Argument "${name}" of required type "${inspect(argType)}" ` + 'was not provided.', node);
+                throw createGraphQLError(`Argument "${name}" of required type "${inspect(argType)}" ` + 'was not provided.', {
+                    nodes: [node],
+                });
             }
             continue;
         }
@@ -227,22 +250,28 @@ function getArgumentValues(def, node, variableValues = {}) {
                     coercedValues[name] = defaultValue;
                 }
                 else if (isNonNullType(argType)) {
-                    throw new GraphQLError(`Argument "${name}" of required type "${inspect(argType)}" ` +
-                        `was provided the variable "$${variableName}" which was not provided a runtime value.`, valueNode);
+                    throw createGraphQLError(`Argument "${name}" of required type "${inspect(argType)}" ` +
+                        `was provided the variable "$${variableName}" which was not provided a runtime value.`, {
+                        nodes: [valueNode],
+                    });
                 }
                 continue;
             }
             isNull = variableValues[variableName] == null;
         }
         if (isNull && isNonNullType(argType)) {
-            throw new GraphQLError(`Argument "${name}" of non-null type "${inspect(argType)}" ` + 'must not be null.', valueNode);
+            throw createGraphQLError(`Argument "${name}" of non-null type "${inspect(argType)}" ` + 'must not be null.', {
+                nodes: [valueNode],
+            });
         }
         const coercedValue = valueFromAST(valueNode, argType, variableValues);
         if (coercedValue === undefined) {
             // Note: ValuesOfCorrectTypeRule validation should catch this before
             // execution. This is a runtime check to ensure execution does not
             // continue with an invalid argument value.
-            throw new GraphQLError(`Argument "${name}" has invalid value ${print(valueNode)}.`, valueNode);
+            throw createGraphQLError(`Argument "${name}" has invalid value ${print(valueNode)}.`, {
+                nodes: [valueNode],
+            });
         }
         coercedValues[name] = coercedValue;
     }
@@ -2088,6 +2117,31 @@ function hasCircularRef(types, config = {
     return size > config.depth;
 }
 
+var DirectiveLocation;
+(function (DirectiveLocation) {
+    /** Request Definitions */
+    DirectiveLocation["QUERY"] = "QUERY";
+    DirectiveLocation["MUTATION"] = "MUTATION";
+    DirectiveLocation["SUBSCRIPTION"] = "SUBSCRIPTION";
+    DirectiveLocation["FIELD"] = "FIELD";
+    DirectiveLocation["FRAGMENT_DEFINITION"] = "FRAGMENT_DEFINITION";
+    DirectiveLocation["FRAGMENT_SPREAD"] = "FRAGMENT_SPREAD";
+    DirectiveLocation["INLINE_FRAGMENT"] = "INLINE_FRAGMENT";
+    DirectiveLocation["VARIABLE_DEFINITION"] = "VARIABLE_DEFINITION";
+    /** Type System Definitions */
+    DirectiveLocation["SCHEMA"] = "SCHEMA";
+    DirectiveLocation["SCALAR"] = "SCALAR";
+    DirectiveLocation["OBJECT"] = "OBJECT";
+    DirectiveLocation["FIELD_DEFINITION"] = "FIELD_DEFINITION";
+    DirectiveLocation["ARGUMENT_DEFINITION"] = "ARGUMENT_DEFINITION";
+    DirectiveLocation["INTERFACE"] = "INTERFACE";
+    DirectiveLocation["UNION"] = "UNION";
+    DirectiveLocation["ENUM"] = "ENUM";
+    DirectiveLocation["ENUM_VALUE"] = "ENUM_VALUE";
+    DirectiveLocation["INPUT_OBJECT"] = "INPUT_OBJECT";
+    DirectiveLocation["INPUT_FIELD_DEFINITION"] = "INPUT_FIELD_DEFINITION";
+})(DirectiveLocation || (DirectiveLocation = {}));
+
 var MapperKind;
 (function (MapperKind) {
     MapperKind["TYPE"] = "MapperKind.TYPE";
@@ -3756,10 +3810,6 @@ function implementsAbstractType(schema, typeA, typeB) {
     return false;
 }
 
-function relocatedError(originalError, path) {
-    return new GraphQLError(originalError.message, originalError.nodes, originalError.source, originalError.positions, path === null ? undefined : path === undefined ? originalError.path : path, originalError.originalError, originalError.extensions);
-}
-
 function observableToAsyncIterable(observable) {
     const pullQueue = [];
     const pushQueue = [];
@@ -4257,4 +4307,4 @@ function fixSchemaAst(schema, options) {
     return schema;
 }
 
-export { AggregateErrorImpl as AggregateError, MapperKind, addTypes, appendObjectFields, asArray, assertSome, astFromArg, astFromDirective, astFromEnumType, astFromEnumValue, astFromField, astFromInputField, astFromInputObjectType, astFromInterfaceType, astFromObjectType, astFromScalarType, astFromSchema, astFromUnionType, astFromValueUntyped, buildOperationNodeForField, checkValidationErrors, collectComment, collectFields, collectSubFields, compareNodes, compareStrings, correctASTNodes, createDefaultRules, createNamedStub, createStub, createVariableNameGenerator, dedentBlockStringValue, filterSchema, fixSchemaAst, forEachDefaultValue, forEachField, getArgumentValues, getAsyncIterableWithCancel, getAsyncIteratorWithCancel, getBlockStringIndentation, getBuiltInForStub, getComment, getDefinedRootType, getDeprecatableDirectiveNodes, getDescription, getDirective, getDirectiveInExtensions, getDirectiveNodes, getDirectives, getDirectivesInExtensions, getDocumentNodeFromSchema, getFieldsWithDirectives, getImplementingTypes, getLeadingCommentBlock, getOperationASTFromDocument, getOperationASTFromRequest, getResolversFromSchema, getResponseKeyFromInfo, getRootTypeMap, getRootTypeNames, getRootTypes, healSchema, healTypes, implementsAbstractType, inspect, isAggregateError, isAsyncIterable, isDescribable, isDocumentNode, isDocumentString, isNamedStub, isSome, isValidPath, makeDeprecatedDirective, makeDirectiveNode, makeDirectiveNodes, mapAsyncIterator, mapSchema, memoize1, memoize2, memoize2of4, memoize3, memoize4, memoize5, mergeDeep, modifyObjectFields, nodeToString, observableToAsyncIterable, parseGraphQLJSON, parseGraphQLSDL, parseInputValue, parseInputValueLiteral, parseSelectionSet, printComment, printSchemaWithDirectives, printWithComments, pruneSchema, pushComment, relocatedError, removeObjectFields, renameType, resetComments, rewireTypes, selectObjectFields, serializeInputValue, transformCommentsToDescriptions, transformInputValue, updateArgument, validateGraphQlDocuments, valueMatchesCriteria, visitData, visitErrors, visitResult, getAsyncIterableWithCancel as withCancel };
+export { AggregateErrorImpl as AggregateError, DirectiveLocation, MapperKind, addTypes, appendObjectFields, asArray, assertSome, astFromArg, astFromDirective, astFromEnumType, astFromEnumValue, astFromField, astFromInputField, astFromInputObjectType, astFromInterfaceType, astFromObjectType, astFromScalarType, astFromSchema, astFromUnionType, astFromValueUntyped, buildOperationNodeForField, checkValidationErrors, collectComment, collectFields, collectSubFields, compareNodes, compareStrings, correctASTNodes, createDefaultRules, createGraphQLError, createNamedStub, createStub, createVariableNameGenerator, dedentBlockStringValue, filterSchema, fixSchemaAst, forEachDefaultValue, forEachField, getArgumentValues, getAsyncIterableWithCancel, getAsyncIteratorWithCancel, getBlockStringIndentation, getBuiltInForStub, getComment, getDefinedRootType, getDeprecatableDirectiveNodes, getDescription, getDirective, getDirectiveInExtensions, getDirectiveNodes, getDirectives, getDirectivesInExtensions, getDocumentNodeFromSchema, getFieldsWithDirectives, getImplementingTypes, getLeadingCommentBlock, getOperationASTFromDocument, getOperationASTFromRequest, getResolversFromSchema, getResponseKeyFromInfo, getRootTypeMap, getRootTypeNames, getRootTypes, healSchema, healTypes, implementsAbstractType, inspect, isAggregateError, isAsyncIterable, isDescribable, isDocumentNode, isDocumentString, isNamedStub, isSome, isValidPath, makeDeprecatedDirective, makeDirectiveNode, makeDirectiveNodes, mapAsyncIterator, mapSchema, memoize1, memoize2, memoize2of4, memoize3, memoize4, memoize5, mergeDeep, modifyObjectFields, nodeToString, observableToAsyncIterable, parseGraphQLJSON, parseGraphQLSDL, parseInputValue, parseInputValueLiteral, parseSelectionSet, printComment, printSchemaWithDirectives, printWithComments, pruneSchema, pushComment, relocatedError, removeObjectFields, renameType, resetComments, rewireTypes, selectObjectFields, serializeInputValue, transformCommentsToDescriptions, transformInputValue, updateArgument, validateGraphQlDocuments, valueMatchesCriteria, visitData, visitErrors, visitResult, getAsyncIterableWithCancel as withCancel };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/utils",
-  "version": "8.6.11",
+  "version": "8.6.12-alpha-2e27df80.0",
   "description": "Common package containing utils and types for GraphQL tools",
   "sideEffects": false,
   "peerDependencies": {

package/types.d.ts

@@ -48,3 +48,27 @@ export interface PruneSchemaOptions {
 export declare type InputLeafValueTransformer = (type: GraphQLEnumType | GraphQLScalarType, originalValue: any) => any;
 export declare type InputObjectValueTransformer = (type: GraphQLInputObjectType, originalValue: Record<string, any>) => Record<string, any>;
 export declare type ASTVisitorKeyMap = Partial<Parameters<typeof visit>[2]>;
+export declare type DirectiveLocationEnum = typeof DirectiveLocation;
+export declare enum DirectiveLocation {
+    /** Request Definitions */
+    QUERY = "QUERY",
+    MUTATION = "MUTATION",
+    SUBSCRIPTION = "SUBSCRIPTION",
+    FIELD = "FIELD",
+    FRAGMENT_DEFINITION = "FRAGMENT_DEFINITION",
+    FRAGMENT_SPREAD = "FRAGMENT_SPREAD",
+    INLINE_FRAGMENT = "INLINE_FRAGMENT",
+    VARIABLE_DEFINITION = "VARIABLE_DEFINITION",
+    /** Type System Definitions */
+    SCHEMA = "SCHEMA",
+    SCALAR = "SCALAR",
+    OBJECT = "OBJECT",
+    FIELD_DEFINITION = "FIELD_DEFINITION",
+    ARGUMENT_DEFINITION = "ARGUMENT_DEFINITION",
+    INTERFACE = "INTERFACE",
+    UNION = "UNION",
+    ENUM = "ENUM",
+    ENUM_VALUE = "ENUM_VALUE",
+    INPUT_OBJECT = "INPUT_OBJECT",
+    INPUT_FIELD_DEFINITION = "INPUT_FIELD_DEFINITION"
+}