@graphql-tools/utils 8.13.0 → 8.14.0-alpha-20221029153041-68044ec1

package/cjs/collectFields.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.collectSubFields = exports.collectFields = void 0;
+exports.collectSubFields = exports.getFieldEntryKey = exports.doesFragmentConditionMatch = exports.shouldIncludeNode = exports.collectFields = void 0;
 const memoize_js_1 = require("./memoize.js");
 const graphql_1 = require("graphql");
 // Taken from GraphQL-JS v16 for backwards compat
@@ -62,6 +62,7 @@ function shouldIncludeNode(variableValues, node) {
     }
     return true;
 }
+exports.shouldIncludeNode = shouldIncludeNode;
 /**
  * Determines if a fragment is applicable to the given type.
  */
@@ -80,12 +81,14 @@ function doesFragmentConditionMatch(schema, fragment, type) {
     }
     return false;
 }
+exports.doesFragmentConditionMatch = doesFragmentConditionMatch;
 /**
  * Implements the logic to compute the key of a given field's entry
  */
 function getFieldEntryKey(node) {
     return node.alias ? node.alias.value : node.name.value;
 }
+exports.getFieldEntryKey = getFieldEntryKey;
 exports.collectSubFields = (0, memoize_js_1.memoize5)(function collectSubFields(schema, fragments, variableValues, type, fieldNodes) {
     const subFieldNodes = new Map();
     const visitedFragmentNames = new Set();

package/esm/collectFields.js

@@ -47,7 +47,7 @@ export function collectFields(schema, fragments, variableValues, runtimeType, se
  * Determines if a field should be included based on the `@include` and `@skip`
  * directives, where `@skip` has higher precedence than `@include`.
  */
-function shouldIncludeNode(variableValues, node) {
+export function shouldIncludeNode(variableValues, node) {
     const skip = getDirectiveValues(GraphQLSkipDirective, node, variableValues);
     if ((skip === null || skip === void 0 ? void 0 : skip['if']) === true) {
         return false;
@@ -61,7 +61,7 @@ function shouldIncludeNode(variableValues, node) {
 /**
  * Determines if a fragment is applicable to the given type.
  */
-function doesFragmentConditionMatch(schema, fragment, type) {
+export function doesFragmentConditionMatch(schema, fragment, type) {
     const typeConditionNode = fragment.typeCondition;
     if (!typeConditionNode) {
         return true;
@@ -79,7 +79,7 @@ function doesFragmentConditionMatch(schema, fragment, type) {
 /**
  * Implements the logic to compute the key of a given field's entry
  */
-function getFieldEntryKey(node) {
+export function getFieldEntryKey(node) {
     return node.alias ? node.alias.value : node.name.value;
 }
 export const collectSubFields = memoize5(function collectSubFields(schema, fragments, variableValues, type, fieldNodes) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/utils",
-  "version": "8.13.0",
+  "version": "8.14.0-alpha-20221029153041-68044ec1",
   "description": "Common package containing utils and types for GraphQL tools",
   "sideEffects": false,
   "peerDependencies": {

package/typings/Interfaces.d.cts

@@ -4,7 +4,9 @@ import { GraphQLSchema, GraphQLField, GraphQLInputType, GraphQLNamedType, GraphQ
  *
  *   - `errors` is included when any errors occurred as a non-empty array.
  *   - `data` is the result of a successful execution of the query.
+ *   - `hasNext` is true if a future payload is expected.
  *   - `extensions` is reserved for adding non-standard properties.
+ *   - `incremental` is a list of the results from defer/stream directives.
  */
 export interface ExecutionResult<TData = any, TExtensions = any> {
     errors?: ReadonlyArray<GraphQLError>;

package/typings/Interfaces.d.ts

@@ -4,7 +4,9 @@ import { GraphQLSchema, GraphQLField, GraphQLInputType, GraphQLNamedType, GraphQ
  *
  *   - `errors` is included when any errors occurred as a non-empty array.
  *   - `data` is the result of a successful execution of the query.
+ *   - `hasNext` is true if a future payload is expected.
  *   - `extensions` is reserved for adding non-standard properties.
+ *   - `incremental` is a list of the results from defer/stream directives.
  */
 export interface ExecutionResult<TData = any, TExtensions = any> {
     errors?: ReadonlyArray<GraphQLError>;

package/typings/collectFields.d.cts

@@ -1,5 +1,18 @@
-import { GraphQLSchema, FragmentDefinitionNode, GraphQLObjectType, SelectionSetNode, FieldNode } from 'graphql';
+import { GraphQLSchema, FragmentDefinitionNode, GraphQLObjectType, SelectionSetNode, FieldNode, FragmentSpreadNode, InlineFragmentNode } from 'graphql';
 export declare function collectFields(schema: GraphQLSchema, fragments: Record<string, FragmentDefinitionNode>, variableValues: {
     [variable: string]: unknown;
 }, runtimeType: GraphQLObjectType, selectionSet: SelectionSetNode, fields?: Map<string, Array<FieldNode>>, visitedFragmentNames?: Set<string>): Map<string, Array<FieldNode>>;
+/**
+ * Determines if a field should be included based on the `@include` and `@skip`
+ * directives, where `@skip` has higher precedence than `@include`.
+ */
+export declare function shouldIncludeNode(variableValues: any, node: FragmentSpreadNode | FieldNode | InlineFragmentNode): boolean;
+/**
+ * Determines if a fragment is applicable to the given type.
+ */
+export declare function doesFragmentConditionMatch(schema: GraphQLSchema, fragment: FragmentDefinitionNode | InlineFragmentNode, type: GraphQLObjectType): boolean;
+/**
+ * Implements the logic to compute the key of a given field's entry
+ */
+export declare function getFieldEntryKey(node: FieldNode): string;
 export declare const collectSubFields: (schema: GraphQLSchema, fragments: Record<string, FragmentDefinitionNode>, variableValues: Record<string, any>, type: GraphQLObjectType, fieldNodes: Array<FieldNode>) => Map<string, Array<FieldNode>>;

package/typings/collectFields.d.ts

@@ -1,5 +1,18 @@
-import { GraphQLSchema, FragmentDefinitionNode, GraphQLObjectType, SelectionSetNode, FieldNode } from 'graphql';
+import { GraphQLSchema, FragmentDefinitionNode, GraphQLObjectType, SelectionSetNode, FieldNode, FragmentSpreadNode, InlineFragmentNode } from 'graphql';
 export declare function collectFields(schema: GraphQLSchema, fragments: Record<string, FragmentDefinitionNode>, variableValues: {
     [variable: string]: unknown;
 }, runtimeType: GraphQLObjectType, selectionSet: SelectionSetNode, fields?: Map<string, Array<FieldNode>>, visitedFragmentNames?: Set<string>): Map<string, Array<FieldNode>>;
+/**
+ * Determines if a field should be included based on the `@include` and `@skip`
+ * directives, where `@skip` has higher precedence than `@include`.
+ */
+export declare function shouldIncludeNode(variableValues: any, node: FragmentSpreadNode | FieldNode | InlineFragmentNode): boolean;
+/**
+ * Determines if a fragment is applicable to the given type.
+ */
+export declare function doesFragmentConditionMatch(schema: GraphQLSchema, fragment: FragmentDefinitionNode | InlineFragmentNode, type: GraphQLObjectType): boolean;
+/**
+ * Implements the logic to compute the key of a given field's entry
+ */
+export declare function getFieldEntryKey(node: FieldNode): string;
 export declare const collectSubFields: (schema: GraphQLSchema, fragments: Record<string, FragmentDefinitionNode>, variableValues: Record<string, any>, type: GraphQLObjectType, fieldNodes: Array<FieldNode>) => Map<string, Array<FieldNode>>;