@graphql-tools/utils 8.5.4 → 8.6.1

package/index.js

@@ -226,7 +226,7 @@ function getArgumentValues(def, node, variableValues = {}) {
         let isNull = valueNode.kind === graphql.Kind.NULL;
         if (valueNode.kind === graphql.Kind.VARIABLE) {
             const variableName = valueNode.name.value;
-            if (variableValues == null || !variableMap[variableName]) {
+            if (variableValues == null || variableMap[variableName] == null) {
                 if (defaultValue !== undefined) {
                     coercedValues[name] = defaultValue;
                 }
@@ -3207,57 +3207,54 @@ function addTypes(schema, newTypesOrDirectives) {
  * @param options Additional options for removing unused types from the schema
  */
 function pruneSchema(schema, options = {}) {
-    const pruningContext = {
-        schema,
-        unusedTypes: Object.create(null),
-        implementations: Object.create(null),
-    };
-    for (const typeName in schema.getTypeMap()) {
-        const type = schema.getType(typeName);
-        if (type && 'getInterfaces' in type) {
-            for (const iface of type.getInterfaces()) {
-                const implementations = getImplementations(pruningContext, iface);
-                if (implementations == null) {
-                    pruningContext.implementations[iface.name] = Object.create(null);
-                }
-                pruningContext.implementations[iface.name][type.name] = true;
-            }
+    const pruningContext = createPruningContext(schema);
+    visitTypes(pruningContext);
+    const types = Object.values(schema.getTypeMap());
+    const typesToPrune = new Set();
+    for (const type of types) {
+        if (type.name.startsWith('__')) {
+            continue;
         }
-    }
-    visitTypes(pruningContext, schema);
-    return mapSchema(schema, {
-        [exports.MapperKind.TYPE]: (type) => {
-            // If we should NOT prune the type, return it immediately as unmodified
-            if (options.skipPruning && options.skipPruning(type)) {
-                return type;
+        // If we should NOT prune the type, return it immediately as unmodified
+        if (options.skipPruning && options.skipPruning(type)) {
+            continue;
+        }
+        if (graphql.isObjectType(type) || graphql.isInputObjectType(type)) {
+            if ((!Object.keys(type.getFields()).length && !options.skipEmptyCompositeTypePruning) ||
+                (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning)) {
+                typesToPrune.add(type.name);
             }
-            if (graphql.isObjectType(type) || graphql.isInputObjectType(type)) {
-                if ((!Object.keys(type.getFields()).length && !options.skipEmptyCompositeTypePruning) ||
-                    (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning)) {
-                    return null;
-                }
+        }
+        else if (graphql.isUnionType(type)) {
+            if ((!type.getTypes().length && !options.skipEmptyUnionPruning) ||
+                (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning)) {
+                typesToPrune.add(type.name);
             }
-            else if (graphql.isUnionType(type)) {
-                if ((!type.getTypes().length && !options.skipEmptyUnionPruning) ||
-                    (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning)) {
-                    return null;
-                }
+        }
+        else if (graphql.isInterfaceType(type)) {
+            const implementations = getImplementations(pruningContext, type);
+            if ((!Object.keys(type.getFields()).length && !options.skipEmptyCompositeTypePruning) ||
+                (implementations && !Object.keys(implementations).length && !options.skipUnimplementedInterfacesPruning) ||
+                (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning)) {
+                typesToPrune.add(type.name);
             }
-            else if (graphql.isInterfaceType(type)) {
-                const implementations = getImplementations(pruningContext, type);
-                if ((!Object.keys(type.getFields()).length && !options.skipEmptyCompositeTypePruning) ||
-                    (implementations && !Object.keys(implementations).length && !options.skipUnimplementedInterfacesPruning) ||
-                    (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning)) {
-                    return null;
-                }
+        }
+        else {
+            if (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning) {
+                typesToPrune.add(type.name);
             }
-            else {
-                if (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning) {
-                    return null;
-                }
+        }
+    }
+    // TODO: consider not returning a new schema if there was nothing to prune. This would be a breaking change.
+    const prunedSchema = mapSchema(schema, {
+        [exports.MapperKind.TYPE]: (type) => {
+            if (typesToPrune.has(type.name)) {
+                return null;
             }
         },
     });
+    // if we pruned something, we need to prune again in case there are now objects without fields
+    return typesToPrune.size ? pruneSchema(prunedSchema, options) : prunedSchema;
 }
 function visitOutputType(visitedTypes, pruningContext, type) {
     if (visitedTypes[type.name]) {
@@ -3297,6 +3294,29 @@ function visitOutputType(visitedTypes, pruningContext, type) {
         }
     }
 }
+/**
+ * Initialize a pruneContext given a schema.
+ */
+function createPruningContext(schema) {
+    const pruningContext = {
+        schema,
+        unusedTypes: Object.create(null),
+        implementations: Object.create(null),
+    };
+    for (const typeName in schema.getTypeMap()) {
+        const type = schema.getType(typeName);
+        if (type && 'getInterfaces' in type) {
+            for (const iface of type.getInterfaces()) {
+                const implementations = getImplementations(pruningContext, iface);
+                if (implementations == null) {
+                    pruningContext.implementations[iface.name] = Object.create(null);
+                }
+                pruningContext.implementations[iface.name][type.name] = true;
+            }
+        }
+    }
+    return pruningContext;
+}
 /**
  * Get the implementations of an interface. May return undefined.
  */
@@ -3318,7 +3338,8 @@ function visitInputType(visitedTypes, pruningContext, type) {
         }
     }
 }
-function visitTypes(pruningContext, schema) {
+function visitTypes(pruningContext) {
+    const schema = pruningContext.schema;
     for (const typeName in schema.getTypeMap()) {
         if (!typeName.startsWith('__')) {
             pruningContext.unusedTypes[typeName] = true;
@@ -4175,27 +4196,52 @@ function isDocumentNode(object) {
     return object && typeof object === 'object' && 'kind' in object && object.kind === graphql.Kind.DOCUMENT;
 }
 
-async function defaultReturn(value) {
+async function defaultAsyncIteratorReturn(value) {
     return { value, done: true };
 }
-function withCancel(asyncIterable, onCancel) {
+const proxyMethodFactory = memoize2(function proxyMethodFactory(target, targetMethod) {
+    return function proxyMethod(...args) {
+        return Reflect.apply(targetMethod, target, args);
+    };
+});
+function getAsyncIteratorWithCancel(asyncIterator, onCancel) {
+    return new Proxy(asyncIterator, {
+        has(asyncIterator, prop) {
+            if (prop === 'return') {
+                return true;
+            }
+            return Reflect.has(asyncIterator, prop);
+        },
+        get(asyncIterator, prop, receiver) {
+            const existingPropValue = Reflect.get(asyncIterator, prop, receiver);
+            if (prop === 'return') {
+                const existingReturn = existingPropValue || defaultAsyncIteratorReturn;
+                return async function returnWithCancel(value) {
+                    const returnValue = await onCancel(value);
+                    return Reflect.apply(existingReturn, asyncIterator, [returnValue]);
+                };
+            }
+            else if (typeof existingPropValue === 'function') {
+                return proxyMethodFactory(asyncIterator, existingPropValue);
+            }
+            return existingPropValue;
+        },
+    });
+}
+function getAsyncIterableWithCancel(asyncIterable, onCancel) {
     return new Proxy(asyncIterable, {
-        get(asyncIterable, prop) {
+        get(asyncIterable, prop, receiver) {
+            const existingPropValue = Reflect.get(asyncIterable, prop, receiver);
             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 function asyncIteratorFactory() {
+                    const asyncIterator = Reflect.apply(existingPropValue, asyncIterable, []);
+                    return getAsyncIteratorWithCancel(asyncIterator, onCancel);
                 };
             }
-            return asyncIterable[prop];
+            else if (typeof existingPropValue === 'function') {
+                return proxyMethodFactory(asyncIterable, existingPropValue);
+            }
+            return existingPropValue;
         },
     });
 }
@@ -4256,6 +4302,8 @@ exports.fixSchemaAst = fixSchemaAst;
 exports.forEachDefaultValue = forEachDefaultValue;
 exports.forEachField = forEachField;
 exports.getArgumentValues = getArgumentValues;
+exports.getAsyncIterableWithCancel = getAsyncIterableWithCancel;
+exports.getAsyncIteratorWithCancel = getAsyncIteratorWithCancel;
 exports.getBlockStringIndentation = getBlockStringIndentation;
 exports.getBuiltInForStub = getBuiltInForStub;
 exports.getComment = getComment;
@@ -4330,4 +4378,4 @@ exports.valueMatchesCriteria = valueMatchesCriteria;
 exports.visitData = visitData;
 exports.visitErrors = visitErrors;
 exports.visitResult = visitResult;
-exports.withCancel = withCancel;
+exports.withCancel = getAsyncIterableWithCancel;

package/index.mjs

@@ -223,7 +223,7 @@ function getArgumentValues(def, node, variableValues = {}) {
         let isNull = valueNode.kind === Kind.NULL;
         if (valueNode.kind === Kind.VARIABLE) {
             const variableName = valueNode.name.value;
-            if (variableValues == null || !variableMap[variableName]) {
+            if (variableValues == null || variableMap[variableName] == null) {
                 if (defaultValue !== undefined) {
                     coercedValues[name] = defaultValue;
                 }
@@ -3205,57 +3205,54 @@ function addTypes(schema, newTypesOrDirectives) {
  * @param options Additional options for removing unused types from the schema
  */
 function pruneSchema(schema, options = {}) {
-    const pruningContext = {
-        schema,
-        unusedTypes: Object.create(null),
-        implementations: Object.create(null),
-    };
-    for (const typeName in schema.getTypeMap()) {
-        const type = schema.getType(typeName);
-        if (type && 'getInterfaces' in type) {
-            for (const iface of type.getInterfaces()) {
-                const implementations = getImplementations(pruningContext, iface);
-                if (implementations == null) {
-                    pruningContext.implementations[iface.name] = Object.create(null);
-                }
-                pruningContext.implementations[iface.name][type.name] = true;
-            }
+    const pruningContext = createPruningContext(schema);
+    visitTypes(pruningContext);
+    const types = Object.values(schema.getTypeMap());
+    const typesToPrune = new Set();
+    for (const type of types) {
+        if (type.name.startsWith('__')) {
+            continue;
         }
-    }
-    visitTypes(pruningContext, schema);
-    return mapSchema(schema, {
-        [MapperKind.TYPE]: (type) => {
-            // If we should NOT prune the type, return it immediately as unmodified
-            if (options.skipPruning && options.skipPruning(type)) {
-                return type;
+        // If we should NOT prune the type, return it immediately as unmodified
+        if (options.skipPruning && options.skipPruning(type)) {
+            continue;
+        }
+        if (isObjectType(type) || isInputObjectType(type)) {
+            if ((!Object.keys(type.getFields()).length && !options.skipEmptyCompositeTypePruning) ||
+                (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning)) {
+                typesToPrune.add(type.name);
             }
-            if (isObjectType(type) || isInputObjectType(type)) {
-                if ((!Object.keys(type.getFields()).length && !options.skipEmptyCompositeTypePruning) ||
-                    (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning)) {
-                    return null;
-                }
+        }
+        else if (isUnionType(type)) {
+            if ((!type.getTypes().length && !options.skipEmptyUnionPruning) ||
+                (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning)) {
+                typesToPrune.add(type.name);
             }
-            else if (isUnionType(type)) {
-                if ((!type.getTypes().length && !options.skipEmptyUnionPruning) ||
-                    (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning)) {
-                    return null;
-                }
+        }
+        else if (isInterfaceType(type)) {
+            const implementations = getImplementations(pruningContext, type);
+            if ((!Object.keys(type.getFields()).length && !options.skipEmptyCompositeTypePruning) ||
+                (implementations && !Object.keys(implementations).length && !options.skipUnimplementedInterfacesPruning) ||
+                (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning)) {
+                typesToPrune.add(type.name);
             }
-            else if (isInterfaceType(type)) {
-                const implementations = getImplementations(pruningContext, type);
-                if ((!Object.keys(type.getFields()).length && !options.skipEmptyCompositeTypePruning) ||
-                    (implementations && !Object.keys(implementations).length && !options.skipUnimplementedInterfacesPruning) ||
-                    (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning)) {
-                    return null;
-                }
+        }
+        else {
+            if (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning) {
+                typesToPrune.add(type.name);
             }
-            else {
-                if (pruningContext.unusedTypes[type.name] && !options.skipUnusedTypesPruning) {
-                    return null;
-                }
+        }
+    }
+    // TODO: consider not returning a new schema if there was nothing to prune. This would be a breaking change.
+    const prunedSchema = mapSchema(schema, {
+        [MapperKind.TYPE]: (type) => {
+            if (typesToPrune.has(type.name)) {
+                return null;
             }
         },
     });
+    // if we pruned something, we need to prune again in case there are now objects without fields
+    return typesToPrune.size ? pruneSchema(prunedSchema, options) : prunedSchema;
 }
 function visitOutputType(visitedTypes, pruningContext, type) {
     if (visitedTypes[type.name]) {
@@ -3295,6 +3292,29 @@ function visitOutputType(visitedTypes, pruningContext, type) {
         }
     }
 }
+/**
+ * Initialize a pruneContext given a schema.
+ */
+function createPruningContext(schema) {
+    const pruningContext = {
+        schema,
+        unusedTypes: Object.create(null),
+        implementations: Object.create(null),
+    };
+    for (const typeName in schema.getTypeMap()) {
+        const type = schema.getType(typeName);
+        if (type && 'getInterfaces' in type) {
+            for (const iface of type.getInterfaces()) {
+                const implementations = getImplementations(pruningContext, iface);
+                if (implementations == null) {
+                    pruningContext.implementations[iface.name] = Object.create(null);
+                }
+                pruningContext.implementations[iface.name][type.name] = true;
+            }
+        }
+    }
+    return pruningContext;
+}
 /**
  * Get the implementations of an interface. May return undefined.
  */
@@ -3316,7 +3336,8 @@ function visitInputType(visitedTypes, pruningContext, type) {
         }
     }
 }
-function visitTypes(pruningContext, schema) {
+function visitTypes(pruningContext) {
+    const schema = pruningContext.schema;
     for (const typeName in schema.getTypeMap()) {
         if (!typeName.startsWith('__')) {
             pruningContext.unusedTypes[typeName] = true;
@@ -4173,27 +4194,52 @@ function isDocumentNode(object) {
     return object && typeof object === 'object' && 'kind' in object && object.kind === Kind.DOCUMENT;
 }
 
-async function defaultReturn(value) {
+async function defaultAsyncIteratorReturn(value) {
     return { value, done: true };
 }
-function withCancel(asyncIterable, onCancel) {
+const proxyMethodFactory = memoize2(function proxyMethodFactory(target, targetMethod) {
+    return function proxyMethod(...args) {
+        return Reflect.apply(targetMethod, target, args);
+    };
+});
+function getAsyncIteratorWithCancel(asyncIterator, onCancel) {
+    return new Proxy(asyncIterator, {
+        has(asyncIterator, prop) {
+            if (prop === 'return') {
+                return true;
+            }
+            return Reflect.has(asyncIterator, prop);
+        },
+        get(asyncIterator, prop, receiver) {
+            const existingPropValue = Reflect.get(asyncIterator, prop, receiver);
+            if (prop === 'return') {
+                const existingReturn = existingPropValue || defaultAsyncIteratorReturn;
+                return async function returnWithCancel(value) {
+                    const returnValue = await onCancel(value);
+                    return Reflect.apply(existingReturn, asyncIterator, [returnValue]);
+                };
+            }
+            else if (typeof existingPropValue === 'function') {
+                return proxyMethodFactory(asyncIterator, existingPropValue);
+            }
+            return existingPropValue;
+        },
+    });
+}
+function getAsyncIterableWithCancel(asyncIterable, onCancel) {
     return new Proxy(asyncIterable, {
-        get(asyncIterable, prop) {
+        get(asyncIterable, prop, receiver) {
+            const existingPropValue = Reflect.get(asyncIterable, prop, receiver);
             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 function asyncIteratorFactory() {
+                    const asyncIterator = Reflect.apply(existingPropValue, asyncIterable, []);
+                    return getAsyncIteratorWithCancel(asyncIterator, onCancel);
                 };
             }
-            return asyncIterable[prop];
+            else if (typeof existingPropValue === 'function') {
+                return proxyMethodFactory(asyncIterable, existingPropValue);
+            }
+            return existingPropValue;
         },
     });
 }
@@ -4219,4 +4265,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, 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 };
+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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/utils",
-  "version": "8.5.4",
+  "version": "8.6.1",
   "description": "Common package containing utils and types for GraphQL tools",
   "sideEffects": false,
   "peerDependencies": {
@@ -30,6 +30,7 @@
     "./*": {
       "require": "./*.js",
       "import": "./*.mjs"
-    }
+    },
+    "./package.json": "./package.json"
   }
 }

package/withCancel.d.ts

@@ -1 +1,3 @@
-export declare function withCancel<T>(asyncIterable: AsyncIterable<T>, onCancel: (value?: any) => void | Promise<void>): AsyncIterable<T | undefined>;
+export declare function getAsyncIteratorWithCancel<T, TReturn = any>(asyncIterator: AsyncIterator<T>, onCancel: (value?: TReturn) => void | Promise<void>): AsyncIterator<T>;
+export declare function getAsyncIterableWithCancel<T, TAsyncIterable extends AsyncIterable<T>, TReturn = any>(asyncIterable: TAsyncIterable, onCancel: (value?: TReturn) => void | Promise<void>): TAsyncIterable;
+export { getAsyncIterableWithCancel as withCancel };