@graphql-tools/utils 8.6.9 → 8.6.12-alpha-a2f32d26.0

package/createGraphQLError.d.ts

@@ -0,0 +1,14 @@
+import { ASTNode, GraphQLError, GraphQLErrorExtensions, 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?: Maybe<GraphQLErrorExtensions>;
+}
+export declare function createGraphQLError(message: string, options: GraphQLErrorOptions): GraphQLError;
+export {};

package/errors.d.ts

@@ -1,2 +1,15 @@
-import { GraphQLError } from 'graphql';
+import { ASTNode, GraphQLError, GraphQLErrorExtensions, 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?: Maybe<GraphQLErrorExtensions>;
+}
+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,19 @@ 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;
+    }
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    return new graphql.GraphQLError(message, options.nodes, options.source, options.positions, options.path, options.originalError, options.extensions);
+}
+
 if (typeof AggregateError === 'undefined') {
     class AggregateErrorClass extends Error {
         constructor(errors, message = '') {
@@ -217,7 +230,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 +245,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;
     }
@@ -3287,11 +3308,13 @@ function visitSchema(schema) {
     return visitQueue(queue, schema);
 }
 function visitQueue(queue, schema, visited = new Set()) {
+    // Interfaces encountered that are field return types need to be revisited to add their implementations
+    const revisit = new Map();
     // Navigate all types starting with pre-queued types (root types)
     while (queue.length) {
         const typeName = queue.pop();
-        // Skip types we already visited
-        if (visited.has(typeName)) {
+        // Skip types we already visited unless it is an interface type that needs revisiting
+        if (visited.has(typeName) && revisit[typeName] !== true) {
             continue;
         }
         const type = schema.getType(typeName);
@@ -3300,6 +3323,17 @@ function visitQueue(queue, schema, visited = new Set()) {
             if (graphql.isUnionType(type)) {
                 queue.push(...type.getTypes().map(type => type.name));
             }
+            // If it is an interface and it is a returned type, grab all implementations so we can use proper __typename in fragments
+            if (graphql.isInterfaceType(type) && revisit[typeName] === true) {
+                queue.push(...getImplementingTypes(type.name, schema));
+                // No need to revisit this interface again
+                revisit[typeName] = false;
+            }
+            // Visit interfaces this type is implementing if they haven't been visited yet
+            if ('getInterfaces' in type) {
+                // Only pushes to queue to visit but not return types
+                queue.push(...type.getInterfaces().map(iface => iface.name));
+            }
             // If the type has files visit those field types
             if ('getFields' in type) {
                 const fields = type.getFields();
@@ -3309,17 +3343,17 @@ function visitQueue(queue, schema, visited = new Set()) {
                 }
                 for (const [, field] of entries) {
                     if (graphql.isObjectType(type)) {
-                        for (const arg of field.args) {
-                            queue.push(graphql.getNamedType(arg.type).name); // Visit arg types
-                        }
+                        // Visit arg types
+                        queue.push(...field.args.map(arg => graphql.getNamedType(arg.type).name));
+                    }
+                    const namedType = graphql.getNamedType(field.type);
+                    queue.push(namedType.name);
+                    // Interfaces returned on fields need to be revisited to add their implementations
+                    if (graphql.isInterfaceType(namedType) && !(namedType.name in revisit)) {
+                        revisit[namedType.name] = true;
                     }
-                    queue.push(graphql.getNamedType(field.type).name);
                 }
             }
-            // Visit interfaces this type is implementing if they haven't been visited yet
-            if ('getInterfaces' in type) {
-                queue.push(...type.getInterfaces().map(iface => iface.name));
-            }
             visited.add(typeName); // Mark as visited (and therefore it is used and should be kept)
         }
     }
@@ -3745,8 +3779,27 @@ function implementsAbstractType(schema, typeA, typeB) {
     return false;
 }
 
+function createGraphQLError$1(message, options) {
+    if (graphql.versionInfo.major > 15) {
+        const error = new graphql.GraphQLError(message, options);
+        Object.defineProperty(error, 'extensions', {
+            value: options.extensions || {},
+        });
+        return error;
+    }
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    return new graphql.GraphQLError(message, options.nodes, options.source, options.positions, options.path, options.originalError, options.extensions);
+}
 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);
+    return createGraphQLError$1(originalError.message, {
+        nodes: originalError.nodes,
+        source: originalError.source,
+        positions: originalError.positions,
+        path: path == null ? originalError.path : path,
+        originalError,
+        extensions: originalError.extensions,
+    });
 }
 
 function observableToAsyncIterable(observable) {
@@ -4003,8 +4056,18 @@ function visitErrorsByType(errors, errorVisitorMap, errorInfo) {
         return newError;
     });
 }
+function getOperationRootType(schema, operationDef) {
+    switch (operationDef.operation) {
+        case 'query':
+            return schema.getQueryType();
+        case 'mutation':
+            return schema.getMutationType();
+        case 'subscription':
+            return schema.getSubscriptionType();
+    }
+}
 function visitRoot(root, operation, schema, fragments, variableValues, resultVisitorMap, errors, errorInfo) {
-    const operationRootType = graphql.getOperationRootType(schema, operation);
+    const operationRootType = getOperationRootType(schema, operation);
     const collectedFields = collectFields(schema, fragments, variableValues, operationRootType, operation.selectionSet, new Map(), new Set());
     return visitObjectValue(root, operationRootType, collectedFields, schema, fragments, variableValues, resultVisitorMap, 0, errors, errorInfo);
 }
@@ -4262,6 +4325,7 @@ exports.compareNodes = compareNodes;
 exports.compareStrings = compareStrings;
 exports.correctASTNodes = correctASTNodes;
 exports.createDefaultRules = createDefaultRules;
+exports.createGraphQLError = createGraphQLError$1;
 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, getOperationRootType, 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,19 @@ 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;
+    }
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    return new GraphQLError(message, options.nodes, options.source, options.positions, options.path, options.originalError, options.extensions);
+}
+
 let AggregateErrorImpl;
 if (typeof AggregateError === 'undefined') {
     class AggregateErrorClass extends Error {
@@ -214,7 +227,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 +242,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;
     }
@@ -3285,11 +3306,13 @@ function visitSchema(schema) {
     return visitQueue(queue, schema);
 }
 function visitQueue(queue, schema, visited = new Set()) {
+    // Interfaces encountered that are field return types need to be revisited to add their implementations
+    const revisit = new Map();
     // Navigate all types starting with pre-queued types (root types)
     while (queue.length) {
         const typeName = queue.pop();
-        // Skip types we already visited
-        if (visited.has(typeName)) {
+        // Skip types we already visited unless it is an interface type that needs revisiting
+        if (visited.has(typeName) && revisit[typeName] !== true) {
             continue;
         }
         const type = schema.getType(typeName);
@@ -3298,6 +3321,17 @@ function visitQueue(queue, schema, visited = new Set()) {
             if (isUnionType(type)) {
                 queue.push(...type.getTypes().map(type => type.name));
             }
+            // If it is an interface and it is a returned type, grab all implementations so we can use proper __typename in fragments
+            if (isInterfaceType(type) && revisit[typeName] === true) {
+                queue.push(...getImplementingTypes(type.name, schema));
+                // No need to revisit this interface again
+                revisit[typeName] = false;
+            }
+            // Visit interfaces this type is implementing if they haven't been visited yet
+            if ('getInterfaces' in type) {
+                // Only pushes to queue to visit but not return types
+                queue.push(...type.getInterfaces().map(iface => iface.name));
+            }
             // If the type has files visit those field types
             if ('getFields' in type) {
                 const fields = type.getFields();
@@ -3307,17 +3341,17 @@ function visitQueue(queue, schema, visited = new Set()) {
                 }
                 for (const [, field] of entries) {
                     if (isObjectType(type)) {
-                        for (const arg of field.args) {
-                            queue.push(getNamedType(arg.type).name); // Visit arg types
-                        }
+                        // Visit arg types
+                        queue.push(...field.args.map(arg => getNamedType(arg.type).name));
+                    }
+                    const namedType = getNamedType(field.type);
+                    queue.push(namedType.name);
+                    // Interfaces returned on fields need to be revisited to add their implementations
+                    if (isInterfaceType(namedType) && !(namedType.name in revisit)) {
+                        revisit[namedType.name] = true;
                     }
-                    queue.push(getNamedType(field.type).name);
                 }
             }
-            // Visit interfaces this type is implementing if they haven't been visited yet
-            if ('getInterfaces' in type) {
-                queue.push(...type.getInterfaces().map(iface => iface.name));
-            }
             visited.add(typeName); // Mark as visited (and therefore it is used and should be kept)
         }
     }
@@ -3743,8 +3777,27 @@ function implementsAbstractType(schema, typeA, typeB) {
     return false;
 }
 
+function createGraphQLError$1(message, options) {
+    if (versionInfo.major > 15) {
+        const error = new GraphQLError(message, options);
+        Object.defineProperty(error, 'extensions', {
+            value: options.extensions || {},
+        });
+        return error;
+    }
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    return new GraphQLError(message, options.nodes, options.source, options.positions, options.path, options.originalError, options.extensions);
+}
 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);
+    return createGraphQLError$1(originalError.message, {
+        nodes: originalError.nodes,
+        source: originalError.source,
+        positions: originalError.positions,
+        path: path == null ? originalError.path : path,
+        originalError,
+        extensions: originalError.extensions,
+    });
 }
 
 function observableToAsyncIterable(observable) {
@@ -4001,6 +4054,16 @@ function visitErrorsByType(errors, errorVisitorMap, errorInfo) {
         return newError;
     });
 }
+function getOperationRootType(schema, operationDef) {
+    switch (operationDef.operation) {
+        case 'query':
+            return schema.getQueryType();
+        case 'mutation':
+            return schema.getMutationType();
+        case 'subscription':
+            return schema.getSubscriptionType();
+    }
+}
 function visitRoot(root, operation, schema, fragments, variableValues, resultVisitorMap, errors, errorInfo) {
     const operationRootType = getOperationRootType(schema, operation);
     const collectedFields = collectFields(schema, fragments, variableValues, operationRootType, operation.selectionSet, new Map(), new Set());
@@ -4234,4 +4297,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, 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$1 as 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,13 +1,13 @@
 {
   "name": "@graphql-tools/utils",
-  "version": "8.6.9",
+  "version": "8.6.12-alpha-a2f32d26.0",
   "description": "Common package containing utils and types for GraphQL tools",
   "sideEffects": false,
   "peerDependencies": {
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "tslib": "~2.3.0"
+    "tslib": "~2.4.0"
   },
   "repository": {
     "type": "git",