@graphql-tools/utils 8.5.1 → 8.5.4

package/AggregateError.d.ts

@@ -8,3 +8,4 @@ interface AggregateErrorConstructor {
 }
 declare let AggregateErrorImpl: AggregateErrorConstructor;
 export { AggregateErrorImpl as AggregateError };
+export declare function isAggregateError(error: Error): error is AggregateError;

package/executor.d.ts

@@ -1,7 +1,7 @@
 import { ExecutionResult, ExecutionRequest } from './Interfaces';
 declare type MaybePromise<T> = Promise<T> | T;
-declare type MaybeAsyncIterableIterator<T> = AsyncIterableIterator<T> | T;
-export declare type AsyncExecutor<TBaseContext = Record<string, any>, TBaseExtensions = Record<string, any>> = <TReturn = any, TArgs = Record<string, any>, TContext extends TBaseContext = TBaseContext, TRoot = any, TExtensions extends TBaseExtensions = TBaseExtensions>(request: ExecutionRequest<TArgs, TContext, TRoot, TExtensions>) => Promise<MaybeAsyncIterableIterator<ExecutionResult<TReturn>>>;
+declare type MaybeAsyncIterable<T> = AsyncIterable<T> | T;
+export declare type AsyncExecutor<TBaseContext = Record<string, any>, TBaseExtensions = Record<string, any>> = <TReturn = any, TArgs = Record<string, any>, TContext extends TBaseContext = TBaseContext, TRoot = any, TExtensions extends TBaseExtensions = TBaseExtensions>(request: ExecutionRequest<TArgs, TContext, TRoot, TExtensions>) => Promise<MaybeAsyncIterable<ExecutionResult<TReturn>>>;
 export declare type SyncExecutor<TBaseContext = Record<string, any>, TBaseExtensions = Record<string, any>> = <TReturn = any, TArgs = Record<string, any>, TContext extends TBaseContext = TBaseContext, TRoot = any, TExtensions extends TBaseExtensions = TBaseExtensions>(request: ExecutionRequest<TArgs, TContext, TRoot, TExtensions>) => ExecutionResult<TReturn>;
-export declare type Executor<TBaseContext = Record<string, any>, TBaseExtensions = Record<string, any>> = <TReturn = any, TArgs = Record<string, any>, TContext extends TBaseContext = TBaseContext, TRoot = any, TExtensions extends TBaseExtensions = TBaseExtensions>(request: ExecutionRequest<TArgs, TContext, TRoot, TExtensions>) => MaybePromise<MaybeAsyncIterableIterator<ExecutionResult<TReturn>>>;
+export declare type Executor<TBaseContext = Record<string, any>, TBaseExtensions = Record<string, any>> = <TReturn = any, TArgs = Record<string, any>, TContext extends TBaseContext = TBaseContext, TRoot = any, TExtensions extends TBaseExtensions = TBaseExtensions>(request: ExecutionRequest<TArgs, TContext, TRoot, TExtensions>) => MaybePromise<MaybeAsyncIterable<ExecutionResult<TReturn>>>;
 export {};

package/index.js

@@ -69,9 +69,27 @@ function assertSome(input, message = 'Value should be something') {
     }
 }
 
+if (typeof AggregateError === 'undefined') {
+    class AggregateErrorClass extends Error {
+        constructor(errors, message = '') {
+            super(message);
+            this.errors = errors;
+            this.name = 'AggregateError';
+            Error.captureStackTrace(this, AggregateErrorClass);
+        }
+    }
+    exports.AggregateError = function (errors, message) {
+        return new AggregateErrorClass(errors, message);
+    };
+}
+else {
+    exports.AggregateError = AggregateError;
+}
+function isAggregateError(error) {
+    return 'errors' in error && Array.isArray(error['errors']);
+}
+
 // Taken from graphql-js
-// https://github.com/graphql/graphql-js/blob/main/src/jsutils/inspect.ts
-/* eslint-disable @typescript-eslint/ban-types */
 const MAX_ARRAY_LENGTH = 10;
 const MAX_RECURSIVE_DEPTH = 2;
 /**
@@ -92,10 +110,22 @@ function formatValue(value, seenValues) {
             return String(value);
     }
 }
+function formatError(value) {
+    if (value instanceof graphql.GraphQLError) {
+        return value.toString();
+    }
+    return `${value.name}: ${value.message};\n ${value.stack}`;
+}
 function formatObjectValue(value, previouslySeenValues) {
     if (value === null) {
         return 'null';
     }
+    if (value instanceof Error) {
+        if (isAggregateError(value)) {
+            return formatError(value) + '\n' + formatArray(value.errors, previouslySeenValues);
+        }
+        return formatError(value);
+    }
     if (previouslySeenValues.includes(value)) {
         return '[Circular]';
     }
@@ -176,7 +206,6 @@ function getArgumentValues(def, node, variableValues = {}) {
         [key]: value,
     }), {});
     const coercedValues = {};
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     const argumentNodes = (_a = node.arguments) !== null && _a !== void 0 ? _a : [];
     const argNodeMap = argumentNodes.reduce((prev, arg) => ({
         ...prev,
@@ -1013,10 +1042,10 @@ function astFromScalarType(type, schema, pathToDirectivesInExtensions) {
     const directives = directivesInExtensions
         ? makeDirectiveNodes(schema, directivesInExtensions)
         : ((_a = type.astNode) === null || _a === void 0 ? void 0 : _a.directives) || [];
-    if (type['specifiedByUrl'] &&
-        !directives.some(directiveNode => directiveNode.name.value === 'specifiedBy')) {
+    const specifiedByValue = (type['specifiedByUrl'] || type['specifiedByURL']);
+    if (specifiedByValue && !directives.some(directiveNode => directiveNode.name.value === 'specifiedBy')) {
         const specifiedByArgs = {
-            url: type['specifiedByUrl'],
+            url: specifiedByValue,
         };
         directives.push(makeDirectiveNode('specifiedBy', specifiedByArgs));
     }
@@ -1164,21 +1193,6 @@ function makeDirectiveNodes(schema, directiveValues) {
     return directiveNodes;
 }
 
-exports.AggregateError = globalThis.AggregateError;
-if (typeof exports.AggregateError === 'undefined') {
-    class AggregateErrorClass extends Error {
-        constructor(errors, message = '') {
-            super(message);
-            this.errors = errors;
-            this.name = 'AggregateError';
-            Error.captureStackTrace(this, AggregateErrorClass);
-        }
-    }
-    exports.AggregateError = function (errors, message) {
-        return new AggregateErrorClass(errors, message);
-    };
-}
-
 async function validateGraphQlDocuments(schema, documentFiles, effectiveRules = createDefaultRules()) {
     const allFragmentMap = new Map();
     const documentFileObjectsToValidate = [];
@@ -3323,7 +3337,6 @@ function visitTypes(pruningContext, schema) {
     }
 }
 
-// eslint-disable-next-line @typescript-eslint/ban-types
 function mergeDeep(sources, respectPrototype = false) {
     const target = sources[0] || {};
     const output = {};
@@ -4152,24 +4165,39 @@ function valueMatchesCriteria(value, criteria) {
 }
 
 function isAsyncIterable(value) {
-    return typeof value === 'object' && value != null && Symbol.asyncIterator in value;
+    return (typeof value === 'object' &&
+        value != null &&
+        Symbol.asyncIterator in value &&
+        typeof value[Symbol.asyncIterator] === 'function');
 }
 
 function isDocumentNode(object) {
     return object && typeof object === 'object' && 'kind' in object && object.kind === graphql.Kind.DOCUMENT;
 }
 
-function withCancel(asyncIteratorLike, onCancel) {
-    const asyncIterator = asyncIteratorLike[Symbol.asyncIterator]();
-    if (!asyncIterator.return) {
-        asyncIterator.return = () => Promise.resolve({ value: undefined, done: true });
-    }
-    const savedReturn = asyncIterator.return.bind(asyncIterator);
-    asyncIterator.return = () => {
-        onCancel();
-        return savedReturn();
-    };
-    return asyncIterator;
+async function defaultReturn(value) {
+    return { value, done: true };
+}
+function withCancel(asyncIterable, onCancel) {
+    return new Proxy(asyncIterable, {
+        get(asyncIterable, prop) {
+            if (Symbol.asyncIterator === prop) {
+                return function getAsyncIteratorWithCancel() {
+                    const asyncIterator = asyncIterable[Symbol.asyncIterator]();
+                    if (!asyncIterator.return) {
+                        asyncIterator.return = defaultReturn;
+                    }
+                    const savedReturn = asyncIterator.return.bind(asyncIterator);
+                    asyncIterator.return = async function extendedReturn(value) {
+                        const returnValue = await onCancel(value);
+                        return savedReturn(returnValue);
+                    };
+                    return asyncIterator;
+                };
+            }
+            return asyncIterable[prop];
+        },
+    });
 }
 
 function buildFixedSchema(schema, options) {
@@ -4254,6 +4282,7 @@ exports.healSchema = healSchema;
 exports.healTypes = healTypes;
 exports.implementsAbstractType = implementsAbstractType;
 exports.inspect = inspect;
+exports.isAggregateError = isAggregateError;
 exports.isAsyncIterable = isAsyncIterable;
 exports.isDescribable = isDescribable;
 exports.isDocumentNode = isDocumentNode;

package/index.mjs

@@ -1,4 +1,4 @@
-import { parse, isNonNullType, GraphQLError, 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, 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';
 
 const asArray = (fns) => (Array.isArray(fns) ? fns : fns ? [fns] : []);
 const invalidDocRegex = /\.[a-z0-9]+$/i;
@@ -65,9 +65,28 @@ function assertSome(input, message = 'Value should be something') {
     }
 }
 
+let AggregateErrorImpl;
+if (typeof AggregateError === 'undefined') {
+    class AggregateErrorClass extends Error {
+        constructor(errors, message = '') {
+            super(message);
+            this.errors = errors;
+            this.name = 'AggregateError';
+            Error.captureStackTrace(this, AggregateErrorClass);
+        }
+    }
+    AggregateErrorImpl = function (errors, message) {
+        return new AggregateErrorClass(errors, message);
+    };
+}
+else {
+    AggregateErrorImpl = AggregateError;
+}
+function isAggregateError(error) {
+    return 'errors' in error && Array.isArray(error['errors']);
+}
+
 // Taken from graphql-js
-// https://github.com/graphql/graphql-js/blob/main/src/jsutils/inspect.ts
-/* eslint-disable @typescript-eslint/ban-types */
 const MAX_ARRAY_LENGTH = 10;
 const MAX_RECURSIVE_DEPTH = 2;
 /**
@@ -88,10 +107,22 @@ function formatValue(value, seenValues) {
             return String(value);
     }
 }
+function formatError(value) {
+    if (value instanceof GraphQLError) {
+        return value.toString();
+    }
+    return `${value.name}: ${value.message};\n ${value.stack}`;
+}
 function formatObjectValue(value, previouslySeenValues) {
     if (value === null) {
         return 'null';
     }
+    if (value instanceof Error) {
+        if (isAggregateError(value)) {
+            return formatError(value) + '\n' + formatArray(value.errors, previouslySeenValues);
+        }
+        return formatError(value);
+    }
     if (previouslySeenValues.includes(value)) {
         return '[Circular]';
     }
@@ -172,7 +203,6 @@ function getArgumentValues(def, node, variableValues = {}) {
         [key]: value,
     }), {});
     const coercedValues = {};
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     const argumentNodes = (_a = node.arguments) !== null && _a !== void 0 ? _a : [];
     const argNodeMap = argumentNodes.reduce((prev, arg) => ({
         ...prev,
@@ -1009,10 +1039,10 @@ function astFromScalarType(type, schema, pathToDirectivesInExtensions) {
     const directives = directivesInExtensions
         ? makeDirectiveNodes(schema, directivesInExtensions)
         : ((_a = type.astNode) === null || _a === void 0 ? void 0 : _a.directives) || [];
-    if (type['specifiedByUrl'] &&
-        !directives.some(directiveNode => directiveNode.name.value === 'specifiedBy')) {
+    const specifiedByValue = (type['specifiedByUrl'] || type['specifiedByURL']);
+    if (specifiedByValue && !directives.some(directiveNode => directiveNode.name.value === 'specifiedBy')) {
         const specifiedByArgs = {
-            url: type['specifiedByUrl'],
+            url: specifiedByValue,
         };
         directives.push(makeDirectiveNode('specifiedBy', specifiedByArgs));
     }
@@ -1160,21 +1190,6 @@ function makeDirectiveNodes(schema, directiveValues) {
     return directiveNodes;
 }
 
-let AggregateErrorImpl = globalThis.AggregateError;
-if (typeof AggregateErrorImpl === 'undefined') {
-    class AggregateErrorClass extends Error {
-        constructor(errors, message = '') {
-            super(message);
-            this.errors = errors;
-            this.name = 'AggregateError';
-            Error.captureStackTrace(this, AggregateErrorClass);
-        }
-    }
-    AggregateErrorImpl = function (errors, message) {
-        return new AggregateErrorClass(errors, message);
-    };
-}
-
 async function validateGraphQlDocuments(schema, documentFiles, effectiveRules = createDefaultRules()) {
     const allFragmentMap = new Map();
     const documentFileObjectsToValidate = [];
@@ -3320,7 +3335,6 @@ function visitTypes(pruningContext, schema) {
     }
 }
 
-// eslint-disable-next-line @typescript-eslint/ban-types
 function mergeDeep(sources, respectPrototype = false) {
     const target = sources[0] || {};
     const output = {};
@@ -4149,24 +4163,39 @@ function valueMatchesCriteria(value, criteria) {
 }
 
 function isAsyncIterable(value) {
-    return typeof value === 'object' && value != null && Symbol.asyncIterator in value;
+    return (typeof value === 'object' &&
+        value != null &&
+        Symbol.asyncIterator in value &&
+        typeof value[Symbol.asyncIterator] === 'function');
 }
 
 function isDocumentNode(object) {
     return object && typeof object === 'object' && 'kind' in object && object.kind === Kind.DOCUMENT;
 }
 
-function withCancel(asyncIteratorLike, onCancel) {
-    const asyncIterator = asyncIteratorLike[Symbol.asyncIterator]();
-    if (!asyncIterator.return) {
-        asyncIterator.return = () => Promise.resolve({ value: undefined, done: true });
-    }
-    const savedReturn = asyncIterator.return.bind(asyncIterator);
-    asyncIterator.return = () => {
-        onCancel();
-        return savedReturn();
-    };
-    return asyncIterator;
+async function defaultReturn(value) {
+    return { value, done: true };
+}
+function withCancel(asyncIterable, onCancel) {
+    return new Proxy(asyncIterable, {
+        get(asyncIterable, prop) {
+            if (Symbol.asyncIterator === prop) {
+                return function getAsyncIteratorWithCancel() {
+                    const asyncIterator = asyncIterable[Symbol.asyncIterator]();
+                    if (!asyncIterator.return) {
+                        asyncIterator.return = defaultReturn;
+                    }
+                    const savedReturn = asyncIterator.return.bind(asyncIterator);
+                    asyncIterator.return = async function extendedReturn(value) {
+                        const returnValue = await onCancel(value);
+                        return savedReturn(returnValue);
+                    };
+                    return asyncIterator;
+                };
+            }
+            return asyncIterable[prop];
+        },
+    });
 }
 
 function buildFixedSchema(schema, options) {
@@ -4190,4 +4219,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, 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, 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, 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, createNamedStub, createStub, createVariableNameGenerator, dedentBlockStringValue, filterSchema, fixSchemaAst, forEachDefaultValue, forEachField, getArgumentValues, 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, withCancel };

package/isAsyncIterable.d.ts

@@ -1 +1 @@
-export declare function isAsyncIterable<T>(value: any): value is AsyncIterableIterator<T>;
+export declare function isAsyncIterable<T>(value: any): value is AsyncIterable<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/utils",
-  "version": "8.5.1",
+  "version": "8.5.4",
   "description": "Common package containing utils and types for GraphQL tools",
   "sideEffects": false,
   "peerDependencies": {

package/withCancel.d.ts

@@ -1,3 +1 @@
-export declare function withCancel<T>(asyncIteratorLike: {
-    [Symbol.asyncIterator](): AsyncIterator<T>;
-}, onCancel: () => void): AsyncIterator<T | undefined>;
+export declare function withCancel<T>(asyncIterable: AsyncIterable<T>, onCancel: (value?: any) => void | Promise<void>): AsyncIterable<T | undefined>;