grafast 0.1.1-beta.26 → 0.1.1-beta.27

package/dist/engine/OperationPlan.js

@@ -4,7 +4,6 @@ exports.OperationPlan = exports.POLYMORPHIC_ROOT_PATHS = exports.POLYMORPHIC_ROO
 const tslib_1 = require("tslib");
 const lru_1 = tslib_1.__importDefault(require("@graphile/lru"));
 const graphql = tslib_1.__importStar(require("graphql"));
-const tamedevil_1 = tslib_1.__importDefault(require("tamedevil"));
 const assert = tslib_1.__importStar(require("../assert.js"));
 const constants_js_1 = require("../constants.js");
 const graphqlCollectFields_js_1 = require("../graphqlCollectFields.js");
@@ -217,9 +216,7 @@ class OperationPlan {
         this.checkTimeout();
         this.lap("treeShakeSteps", "optimize");
         // Replace/inline/optimise steps
-        tamedevil_1.default.batch(() => {
-            this.optimizeSteps();
-        });
+        this.optimizeSteps();
         this.checkTimeout();
         this.lap("optimizeSteps");
         this.inlineSteps();
@@ -239,14 +236,10 @@ class OperationPlan {
         this.lap("pushDownSteps");
         // Plans are expected to execute later; they may take steps here to prepare
         // themselves (e.g. compiling SQL queries ahead of time).
-        tamedevil_1.default.batch(() => {
-            this.finalizeSteps();
-        });
+        this.finalizeSteps();
         this.lap("finalizeSteps");
         // Replace access plans with direct access, etc (must come after finalizeSteps)
-        tamedevil_1.default.batch(() => {
-            this.optimizeOutputPlans();
-        });
+        this.optimizeOutputPlans();
         this.checkTimeout();
         this.lap("optimizeOutputPlans");
         // AccessSteps may have been removed
@@ -254,13 +247,9 @@ class OperationPlan {
         this.checkTimeout();
         this.lap("treeShakeSteps", "optimizeOutputPlans");
         this.stepTracker.finalizeOutputPlans();
-        tamedevil_1.default.batch(() => {
-            this.finalizeLayerPlans();
-        });
+        this.finalizeLayerPlans();
         this.lap("finalizeLayerPlans");
-        tamedevil_1.default.batch(() => {
-            this.finalizeOutputPlans();
-        });
+        this.finalizeOutputPlans();
         this.lap("finalizeOutputPlans");
         this.finalize();
         this.lap("finalizeOperationPlan");
@@ -466,7 +455,7 @@ class OperationPlan {
         }
         const planningPath = rootType.name + ".";
         const selectionSet = this.operation.selectionSet;
-        const stepStreamOptions = {};
+        const stepStreamOptions = true;
         const groupedFieldSet = (0, withGlobalLayerPlan_js_1.withGlobalLayerPlan)(this.rootLayerPlan, exports.POLYMORPHIC_ROOT_PATHS, planningPath, stepStreamOptions, graphqlCollectFields_js_1.graphqlCollectFields, null, this, this.trackedRootValueStep.id, rootType, selectionSet.selections, (0, graphqlCollectFields_js_1.newSelectionSetDigest)(false));
         if (groupedFieldSet.deferred !== undefined) {
             throw new index_js_1.SafeError("@defer forbidden on subscription root selection set");
@@ -1932,7 +1921,7 @@ class OperationPlan {
             let stepStreamOptions = undefined;
             if (streamDetails === true) {
                 // subscription
-                stepStreamOptions = {};
+                stepStreamOptions = true;
             }
             else if (streamDetails === false) {
                 // Simple list, no action necessary
@@ -3653,6 +3642,7 @@ But ${p} is not in ${winner.layerPlan}'s expected polymorphic paths:
         function printStep(step) {
             const metaString = step.toStringMeta();
             const sstep = (0, utils_js_1.sudo)(step);
+            const { stream } = step._stepOptions;
             return {
                 id: step.id,
                 stepClass: step.constructor.name,
@@ -3670,9 +3660,11 @@ But ${p} is not in ${winner.layerPlan}'s expected polymorphic paths:
                 isSyncAndSafe: step.isSyncAndSafe || undefined,
                 supportsUnbatched: typeof step.unbatchedExecute === "function" || undefined,
                 hasSideEffects: step.hasSideEffects || undefined,
-                stream: step._stepOptions.stream
-                    ? { initialCountStepId: step._stepOptions.stream.initialCountStepId }
-                    : undefined,
+                stream: stream === true
+                    ? {}
+                    : stream
+                        ? { initialCountStepId: stream.initialCountStepId }
+                        : undefined,
                 extra: step.planJSONExtra(),
             };
         }

package/dist/engine/OutputPlan.d.ts

@@ -1,4 +1,4 @@
-import LRU from "@graphile/lru";
+import type LRU from "@graphile/lru";
 import type { FieldNode, GraphQLEnumType, GraphQLObjectType, GraphQLScalarType } from "graphql";
 import * as graphql from "graphql";
 import type { Bucket } from "../bucket.js";

package/dist/engine/OutputPlan.js

@@ -6,16 +6,14 @@ exports.nonNullError = nonNullError;
 exports.getChildBucketAndIndex = getChildBucketAndIndex;
 exports.getDirectLayerPlanChild = getDirectLayerPlanChild;
 const tslib_1 = require("tslib");
-const lru_1 = tslib_1.__importDefault(require("@graphile/lru"));
 const debug_1 = tslib_1.__importDefault(require("debug"));
 const graphql = tslib_1.__importStar(require("graphql"));
-const tamedevil_1 = tslib_1.__importStar(require("tamedevil"));
 const assert = tslib_1.__importStar(require("../assert.js"));
 const constants_js_1 = require("../constants.js");
 const dev_js_1 = require("../dev.js");
 const index_js_1 = require("../index.js");
 const inspect_js_1 = require("../inspect.js");
-const access_js_1 = require("../steps/access.js");
+const tamedevilUtils_1 = require("../tamedevilUtils");
 const utils_js_1 = require("../utils.js");
 const LayerPlan_js_1 = require("./LayerPlan.js");
 const debug = (0, debug_1.default)("grafast:OutputPlan");
@@ -240,33 +238,7 @@ class OutputPlan {
     _mutablePath, _bucket, _bucketIndex, _rawBucketRootValue, _bucketRootFlags) {
         throw new Error(`OutputPlan.executeString has yet to be built!`);
     }
-    optimize() {
-        // This optimization works by ridding us of access steps at the very end of
-        // paths and just accessing properties directly. In rare circumstances
-        // involving untethered side effects in earlier versions this could lead to
-        // errors being skipped and data generated previous to the error being
-        // returned; but OutputPlans now check the latestSideEffectStep so this
-        // should be safe aga.
-        const $root = this.layerPlan.operationPlan.dangerouslyGetStep(this.rootStep.id);
-        if ($root instanceof index_js_1.AccessStep &&
-            $root.isSyncAndSafe && // Make sure we're not using it for streaming!
-            $root.fallback === undefined &&
-            $root.implicitSideEffectStep === null &&
-            (!this.sideEffectStep || !(0, index_js_1.stepADependsOnStepB)($root, this.sideEffectStep))) {
-            const expressionDetails = $root.unbatchedExecute[access_js_1.expressionSymbol];
-            // @ts-ignore
-            const { step: $parent, onReject, acceptFlags } = $root._getDepOptions(0);
-            if (expressionDetails !== undefined &&
-                onReject == null &&
-                acceptFlags === constants_js_1.DEFAULT_ACCEPT_FLAGS) {
-                this.layerPlan.operationPlan.stepTracker.setOutputPlanRootStep(this, $parent);
-                const [path, fallback] = expressionDetails;
-                withFastExpression(path, fallback, (fn) => {
-                    this.processRoot = fn;
-                });
-            }
-        }
-    }
+    optimize() { }
     finalize() {
         // Clear the sideEffectStep if the rootStep explicitly depends on it.
         // NOTE: this occurs here since more dependencies could have been added to
@@ -597,7 +569,7 @@ const leafExecutor = makeExecutor({
 });
 const leafExecutorString = makeExecutor({
     inner(bucketRootValue) {
-        return (0, tamedevil_1.stringifyJSON)(this.type.graphqlType.serialize(bucketRootValue));
+        return (0, tamedevilUtils_1.stringifyJSON)(this.type.graphqlType.serialize(bucketRootValue));
     },
     nameExtra: `leaf`,
     asString: true,
@@ -646,14 +618,14 @@ const floatLeafExecutorString = makeExecutor({
 });
 const stringLeafExecutorString = makeExecutor({
     inner(bucketRootValue) {
-        return (0, tamedevil_1.stringifyString)(this.type.graphqlType.serialize(bucketRootValue));
+        return (0, tamedevilUtils_1.stringifyString)(this.type.graphqlType.serialize(bucketRootValue));
     },
     nameExtra: `stringLeaf`,
     asString: true,
     skipNullHandling: false,
     preamble(bucketRootValue) {
         if (typeof bucketRootValue === "string") {
-            return (0, tamedevil_1.stringifyString)(bucketRootValue);
+            return (0, tamedevilUtils_1.stringifyString)(bucketRootValue);
         }
     },
 });
@@ -1010,38 +982,6 @@ isRoot, asString) {
         skipNullHandling: isRoot,
     });
 }
-const makeCache = new lru_1.default({
-    maxLength: 1000,
-});
-const makingCache = new Map();
-function withFastExpression(path, fallback, callback) {
-    const signature = (fallback === undefined ? "d" : "f") + "_" + path.join("|");
-    const existing = makeCache.get(signature);
-    if (existing !== undefined) {
-        callback(existing);
-        return;
-    }
-    const existingCallbacks = makingCache.get(signature);
-    if (existingCallbacks !== undefined) {
-        existingCallbacks.push(callback);
-        return;
-    }
-    const callbacks = [callback];
-    makingCache.set(signature, callbacks);
-    const jitParts = [];
-    for (let i = 0, l = path.length; i < l; i++) {
-        const part = path[i];
-        jitParts.push(tamedevil_1.default.optionalGet(part));
-    }
-    const expression = tamedevil_1.default.join(jitParts, "");
-    tamedevil_1.default.runInBatch((0, tamedevil_1.default) `(value => (value${expression})${fallback !== undefined ? (0, tamedevil_1.default) ` ?? ${tamedevil_1.default.lit(fallback)}` : tamedevil_1.default.blank})`, (fn) => {
-        makeCache.set(signature, fn);
-        makingCache.delete(signature);
-        for (const callback of callbacks) {
-            callback(fn);
-        }
-    });
-}
 /**
  * Finds the child of `targetParent` that has a path towards `descendent` (by
  * walking backwards from descendent to targetParent).

package/dist/engine/executeBucket.js

@@ -741,7 +741,7 @@ function executeBucket(bucket, requestContext) {
                 indexFlags |= constants_js_1.FLAG_POLY_SKIPPED;
                 forceIndexValue = null;
             }
-            else if (extra._bucket.flagUnion !== 0) {
+            else if (extra._bucket.flagUnion !== constants_js_1.NO_FLAGS) {
                 for (let i = 0; i < dependenciesIncludingSideEffectsCount; i++) {
                     const depExecutionVal = dependenciesIncludingSideEffects[i];
                     const forbiddenFlags = dependencyForbiddenFlags[i];
@@ -1174,7 +1174,7 @@ function newBucket(parent, spec) {
             if (index >= size) {
                 throw new Error(`GrafastInternalError<9465db89-cc9d-415c-97e7-57bb19ddebe0>: attempt to write to out of bounds index ${index} for bucket of size ${size} for step ${step}`);
             }
-            if (flags !== 0) {
+            if (flags !== constants_js_1.NO_FLAGS) {
                 this.flagUnion |= flags;
             }
             if (step._isUnary) {
@@ -1337,14 +1337,14 @@ function executeStepFromEvent(event) {
 }
 function evaluateStream(bucket, step, distributorOptions) {
     const stream = step._stepOptions.stream;
-    if (!stream)
+    if (stream === null)
         return null;
-    const shouldStream = stream.ifStepId == null
+    const shouldStream = stream === true || stream.ifStepId == null
         ? true
         : (bucket.store.get(stream.ifStepId)?.unaryValue() ?? true);
     if (!shouldStream)
         return null;
-    const initialCount = stream.initialCountStepId == null
+    const initialCount = stream === true || stream.initialCountStepId == null
         ? 0
         : (bucket.store.get(stream.initialCountStepId)?.unaryValue() ?? 0);
     if (initialCount >= distributorOptions.distributorTargetBufferSize) {

package/dist/engine/lib/withGlobalLayerPlan.d.ts

@@ -1,14 +1,18 @@
 import type { ExecutionDetailsStream, StepStreamOptions } from "../../interfaces";
 import type { Step } from "../../step";
 import type { LayerPlan } from "../LayerPlan";
-export declare function withGlobalLayerPlan<T, TThis = any, TArgs extends [...args: any[]] = [...args: any[]]>(layerPlan: LayerPlan, polymorphicPaths: ReadonlySet<string> | null, planningPath: string | null, stepStreamOptions: StepStreamOptions | null, callback: (this: TThis, ...args: TArgs) => T, callbackThis?: TThis, ...callbackArgs: TArgs): T;
+export declare function withGlobalLayerPlan<T, TThis = any, TArgs extends [...args: any[]] = [...args: any[]]>(layerPlan: LayerPlan, polymorphicPaths: ReadonlySet<string> | null, planningPath: string | null, stepStreamOptions: StepStreamOptions | true | null, callback: (this: TThis, ...args: TArgs) => T, callbackThis?: TThis, ...callbackArgs: TArgs): T;
 export declare function currentLayerPlan(): LayerPlan;
 export declare function currentPolymorphicPaths(): ReadonlySet<string> | null;
 /** UNUSED */
 export declare function currentPlanningPath(): string | undefined;
 /**
+ * Step - stream details.
+ * true - Not a stream, but it is a subscription.
+ * null - neither stream nor subscription
+ *
  * @experimental
  */
-export declare function currentFieldStreamDetails(): Step<ExecutionDetailsStream | null> | null;
+export declare function currentFieldStreamDetails(): Step<ExecutionDetailsStream | null> | true | null;
 export declare function isUnaryStep($step: Step): boolean;
 //# sourceMappingURL=withGlobalLayerPlan.d.ts.map

package/dist/engine/lib/withGlobalLayerPlan.js

@@ -60,12 +60,19 @@ function currentPlanningPath() {
     return globalData_planningPath;
 }
 /**
+ * Step - stream details.
+ * true - Not a stream, but it is a subscription.
+ * null - neither stream nor subscription
+ *
  * @experimental
  */
 function currentFieldStreamDetails() {
     if (globalData_stepStreamOptions == null) {
         return null;
     }
+    if (globalData_stepStreamOptions === true) {
+        return true;
+    }
     const { ifStepId, initialCountStepId } = globalData_stepStreamOptions;
     return (0, global_js_1.operationPlan)().withRootLayerPlan(() => {
         const $obj = (0, object_js_1.object)({

package/dist/incremental.d.ts

@@ -0,0 +1,13 @@
+import type { DefinitionNode, GraphQLDirective } from "graphql";
+export declare const graphqlHasStreamDefer: any;
+/**
+ * Used to conditionally defer fragments.
+ */
+export declare const GraphQLDeferDirective: GraphQLDirective;
+export declare const deferDefinition: DefinitionNode;
+/**
+ * Used to conditionally stream list fields.
+ */
+export declare const GraphQLStreamDirective: GraphQLDirective;
+export declare const streamDefinition: DefinitionNode;
+//# sourceMappingURL=incremental.d.ts.map

package/dist/incremental.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.streamDefinition = exports.GraphQLStreamDirective = exports.deferDefinition = exports.GraphQLDeferDirective = exports.graphqlHasStreamDefer = void 0;
+const tslib_1 = require("tslib");
+const graphql = tslib_1.__importStar(require("graphql"));
+const { DirectiveLocation, GraphQLBoolean, GraphQLInt, GraphQLList, GraphQLNonNull, GraphQLString, Kind, } = graphql;
+exports.graphqlHasStreamDefer = graphql.GraphQLStreamDirective &&
+    graphql.GraphQLDeferDirective;
+// This file contains the Stream/Defer directives, to be used when GraphQL itself doesn't provide them.
+// Taken from https://github.com/graphql/graphql-js/blob/bc6b2e47512ee11c01eb5185d184990e743df736/src/type/directives.ts
+/*
+MIT License
+
+Copyright (c) GraphQL Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+/**
+ * Used to conditionally defer fragments.
+ */
+exports.GraphQLDeferDirective = graphql.GraphQLDeferDirective ||
+    new graphql.GraphQLDirective({
+        name: "defer",
+        description: "Directs the executor to defer this fragment when the `if` argument is true or undefined.",
+        locations: [
+            DirectiveLocation.FRAGMENT_SPREAD,
+            DirectiveLocation.INLINE_FRAGMENT,
+        ],
+        args: {
+            if: {
+                type: GraphQLBoolean,
+                description: "Deferred when true or undefined.",
+            },
+            label: {
+                type: GraphQLString,
+                description: "Unique name",
+            },
+        },
+    });
+exports.deferDefinition = toDirectiveDef(exports.GraphQLDeferDirective);
+/**
+ * Used to conditionally stream list fields.
+ */
+exports.GraphQLStreamDirective = graphql.GraphQLStreamDirective ||
+    new graphql.GraphQLDirective({
+        name: "stream",
+        description: "Directs the executor to stream plural fields when the `if` argument is true or undefined.",
+        locations: [DirectiveLocation.FIELD],
+        args: {
+            if: {
+                type: GraphQLBoolean,
+                description: "Stream when true or undefined.",
+            },
+            label: {
+                type: GraphQLString,
+                description: "Unique name",
+            },
+            initialCount: {
+                defaultValue: 0,
+                type: GraphQLInt,
+                description: "Number of items to return immediately",
+            },
+        },
+    });
+exports.streamDefinition = toDirectiveDef(exports.GraphQLStreamDirective);
+function toDirectiveDef(directive) {
+    return {
+        kind: Kind.DIRECTIVE_DEFINITION,
+        description: toDescription(directive.description),
+        name: { kind: Kind.NAME, value: directive.name },
+        arguments: directive.args.map(toDirectiveArgDef),
+        repeatable: directive.isRepeatable,
+        locations: directive.locations.map((n) => ({ kind: Kind.NAME, value: n })),
+    };
+}
+function toDirectiveArgDef(arg) {
+    return {
+        kind: Kind.INPUT_VALUE_DEFINITION,
+        description: toDescription(arg.description),
+        name: { kind: Kind.NAME, value: arg.name },
+        type: toTypeDef(arg.type),
+        defaultValue: toValue(arg.defaultValue),
+    };
+}
+function toTypeDef(type) {
+    if (type instanceof GraphQLNonNull) {
+        return {
+            kind: Kind.NON_NULL_TYPE,
+            type: toTypeDef(type.ofType),
+        };
+    }
+    else if (type instanceof GraphQLList) {
+        return {
+            kind: Kind.LIST_TYPE,
+            type: toTypeDef(type.ofType),
+        };
+    }
+    else {
+        return {
+            kind: Kind.NAMED_TYPE,
+            name: { kind: Kind.NAME, value: type.name },
+        };
+    }
+}
+function toDescription(value) {
+    return value != null ? { kind: Kind.STRING, value } : undefined;
+}
+function toValue(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    else if (typeof value === "boolean") {
+        return { kind: Kind.BOOLEAN, value };
+    }
+    else if (typeof value === "number") {
+        if (parseInt(String(value), 10) === value) {
+            return { kind: Kind.INT, value: String(value) };
+        }
+        else {
+            return { kind: Kind.FLOAT, value: String(value) };
+        }
+    }
+    else {
+        console.dir(value);
+        throw new Error(`Not yet supported`);
+    }
+}
+//# sourceMappingURL=incremental.js.map

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import "./thereCanBeOnlyOne.js";
 import type LRU from "@graphile/lru";
 import type { MiddlewareHandlers } from "graphile-config";
-import type { DocumentNode, GraphQLError, OperationDefinitionNode } from "graphql";
+import type { DocumentNode, ExecutionResult, GraphQLError, OperationDefinitionNode } from "graphql";
+import type { ObjMap } from "graphql/jsutils/ObjMap";
 import type { DataFromObjectSteps } from "./steps/object.js";
 type PromiseOrValue<T> = T | Promise<T>;
 import { exportAs, exportAsMany } from "./exportAs.js";
@@ -30,6 +31,7 @@ import { stringifyPayload } from "./stringifyPayload.js";
 import { stripAnsi } from "./stripAnsi.js";
 import { subscribe } from "./subscribe.js";
 import { arrayOfLength, arraysMatch, asyncIteratorWithCleanup, getEnumValueConfig, getEnumValueConfigs, GrafastInputFieldConfigMap, GrafastInputObjectType, GrafastObjectType, GraphQLSpecifiedErrorBehaviors, inputObjectFieldSpec, InputObjectTypeSpec, isPromiseLike, mapsMatch, maybeArraysMatch, newGrafastFieldConfigBuilder, newInputObjectTypeBuilder, newObjectTypeBuilder, objectFieldSpec, objectSpec, ObjectTypeFields, ObjectTypeSpec, recordsMatch, setsMatch, stepADependsOnStepB, stepAMayDependOnStepB, stepAShouldTryAndInlineIntoStepB, stepsAreInSamePhase } from "./utils.js";
+export { GraphQLDeferDirective, graphqlHasStreamDefer, GraphQLStreamDirective, } from "./incremental.js";
 export { isAsyncIterable } from "iterall";
 export { __FlagStep, __InputListStep, __InputObjectStep, __InputObjectStepWithDollars, __InputStaticLeafStep, __ItemStep, __ListTransformStep, __TrackedValueStep, __TrackedValueStepWithDollars, __ValueStep, $$bypassGraphQL, $$eventEmitter, $$extensions, $$idempotent, $$inhibit, $$verbatim, AbstractTypePlan, AbstractTypePlanner, access, AccessStep, ActualKeyByDesiredKey, applyInput, ApplyInputStep, applyTransforms, ApplyTransformsStep, arrayOfLength, arraysMatch, assertExecutableStep, assertListCapableStep, assertModifier, assertNotNull, assertStep, asyncIteratorWithCleanup, bakedInput, bakedInputRuntime, BakedInputStep, BaseEventMap, BaseGraphQLArguments, BaseGraphQLRootValue, BaseGraphQLVariables, BatchExecutionValue, coalesce, CoalesceStep, condition, ConditionStep, connection, ConnectionHandlingResult, ConnectionHandlingStep, ConnectionOptimizedStep, ConnectionStep, constant, ConstantStep, context, createObjectAndApplyChildren, currentFieldStreamDetails, DataFromObjectSteps, DataFromStep, debugPlans, DEFAULT_ACCEPT_FLAGS, defaultPlanResolver, defer, Deferred, DeprecatedInputObjectPlan, DeprecatedObjectPlan, each, EdgeStep, EnumPlan, EnumValueConfig, EnumValueInput, error, ErrorBehavior, ErrorStep, EventCallback, EventMapKey, Step as ExecutableStep, execute, ExecutionDetails, ExecutionDetailsStream, ExecutionEventEmitter, ExecutionEventMap, ExecutionExtra, ExecutionResults, ExecutionResultValue, ExecutionValue, exportAs, exportAsMany, FieldArg, FieldArgs, FieldInfo, FieldPlan, FieldPlanResolver, filter, FilterPlanMemo, first, FirstStep, flagError, get, getEnumValueConfig, getEnumValueConfigs, getGrafastMiddleware, getNullableInputTypeAtPath, grafast, GrafastArgumentConfig, GrafastExecutionArgs, GrafastFieldConfig, GrafastFieldConfigArgumentMap, grafast as grafastGraphql, grafastSync as grafastGraphqlSync, GrafastInputFieldConfig, GrafastInputFieldConfigMap, GrafastInputObjectType, GrafastObjectType, GrafastPlanJSON, grafastPrint, GrafastResultsList, GrafastResultStreamList, GrafastSchemaConfig, GrafastSubscriber, grafastSync, GrafastValuesList, graphqlResolver, GraphQLResolverStep, GraphQLSpecifiedErrorBehaviors, groupBy, GroupByPlanMemo, inhibitOnNull, InputFieldPlan, InputObjectFieldApplyResolver, InputObjectFieldConfig, inputObjectFieldSpec, InputObjectPlan, InputObjectTypeBakedInfo, InputObjectTypeBakedResolver, InputObjectTypeSpec, inspect, AbstractTypePlan as InterfaceOrUnionPlans, InterfacePlan, isDev, isExecutableStep, isListCapableStep, isListLikeStep, isModifier, isObjectLikeStep, isPromiseLike, isSafeError, isStep, isUnaryStep, JSONArray, JSONObject, JSONValue, lambda, LambdaStep, last, LastStep, list, ListCapableStep, listen, ListenStep, ListLikeStep, ListStep, listTransform, ListTransformItemPlanCallback, ListTransformOptions, ListTransformReduce, LoadedRecordStep, loadMany, LoadManyCallback, loadManyCallback, LoadManyInfo, LoadManyLoader, loadManyLoader, LoadManyStep, loadOne, LoadOneCallback, loadOneCallback, LoadOneInfo, LoadOneLoader, loadOneLoader, LoadOneStep, makeDecodeNodeId, makeDecodeNodeIdRuntime, makeGrafastSchema, mapsMatch, Maybe, maybeArraysMatch, Modifier, Multistep, multistep, newGrafastFieldConfigBuilder, newInputObjectTypeBuilder, newObjectTypeBuilder, node, NodeIdCodec, nodeIdFromNode, NodeIdHandler, NodeStep, noop, object, ObjectFieldConfig, objectFieldSpec, ObjectLikeStep, ObjectPlan, ObjectPlanMeta, objectSpec, ObjectStep, ObjectTypeFields, ObjectTypeSpec, OperationPlan, operationPlan, PaginationFeatures, PaginationParams, partitionByIndex, PlanTypeInfo, PromiseOrDirect, proxy, ProxyStep, recordsMatch, remapKeys, RemapKeysStep, reverse, reverseArray, ReverseStep, rootValue, SafeError, ScalarPlan, ScalarPlanResolver, setsMatch, Setter, setter, SetterCapable, sideEffect, SideEffectStep, specFromNodeId, Step, stepADependsOnStepB, stepAMayDependOnStepB, stepAShouldTryAndInlineIntoStepB, StepOptimizeOptions, StepRepresentingList, stepsAreInSamePhase, StepStreamOptions, stringifyPayload, stripAnsi, subscribe, Thunk, trap, TRAP_ERROR, TRAP_ERROR_OR_INHIBITED, TRAP_INHIBITED, TypedEventEmitter, UnaryExecutionValue, UnbatchedStep as UnbatchedExecutableStep, UnbatchedExecutionExtra, UnbatchedStep, UnionPlan, UnwrapMultistep, };
 export { hookArgs } from "./args.js";
@@ -342,4 +344,29 @@ declare module "graphql" {
         grafast?: Grafast.SchemaExtensions;
     }
 }
+declare module "graphql/execution/execute" {
+    interface ExecutionResult<TData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> {
+        hasNext?: never;
+    }
+    interface ExecutionPatchResult<TData = ObjMap<unknown> | unknown, TExtensions = ObjMap<unknown>> {
+        errors?: ReadonlyArray<GraphQLError>;
+        data?: TData | null;
+        path?: ReadonlyArray<string | number>;
+        label?: string;
+        hasNext: boolean;
+        extensions?: TExtensions;
+    }
+    type AsyncExecutionResult = ExecutionResult | ExecutionPatchResult;
+}
+declare module "graphql" {
+    interface ExecutionPatchResult<TData = ObjMap<unknown> | unknown, TExtensions = ObjMap<unknown>> {
+        errors?: ReadonlyArray<GraphQLError>;
+        data?: TData | null;
+        path?: ReadonlyArray<string | number>;
+        label?: string;
+        hasNext: boolean;
+        extensions?: TExtensions;
+    }
+    type AsyncExecutionResult = ExecutionResult | ExecutionPatchResult;
+}
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.error = exports.EdgeStep = exports.each = exports.defer = exports.defaultPlanResolver = exports.DEFAULT_ACCEPT_FLAGS = exports.debugPlans = exports.currentFieldStreamDetails = exports.createObjectAndApplyChildren = exports.context = exports.ConstantStep = exports.constant = exports.ConnectionStep = exports.connection = exports.ConditionStep = exports.condition = exports.CoalesceStep = exports.coalesce = exports.BakedInputStep = exports.bakedInputRuntime = exports.bakedInput = exports.asyncIteratorWithCleanup = exports.assertStep = exports.assertNotNull = exports.assertModifier = exports.assertListCapableStep = exports.assertExecutableStep = exports.arraysMatch = exports.arrayOfLength = exports.ApplyTransformsStep = exports.applyTransforms = exports.ApplyInputStep = exports.applyInput = exports.AccessStep = exports.access = exports.$$verbatim = exports.$$inhibit = exports.$$idempotent = exports.$$extensions = exports.$$eventEmitter = exports.$$bypassGraphQL = exports.__ValueStep = exports.__TrackedValueStep = exports.__ListTransformStep = exports.__ItemStep = exports.__InputStaticLeafStep = exports.__InputObjectStep = exports.__InputListStep = exports.__FlagStep = exports.isAsyncIterable = void 0;
-exports.LoadManyStep = exports.loadManyLoader = exports.loadManyCallback = exports.loadMany = exports.LoadedRecordStep = exports.listTransform = exports.ListStep = exports.ListenStep = exports.listen = exports.list = exports.LastStep = exports.last = exports.LambdaStep = exports.lambda = exports.isUnaryStep = exports.isStep = exports.isSafeError = exports.isPromiseLike = exports.isObjectLikeStep = exports.isModifier = exports.isListLikeStep = exports.isListCapableStep = exports.isExecutableStep = exports.isDev = exports.inspect = exports.inputObjectFieldSpec = exports.inhibitOnNull = exports.groupBy = exports.GraphQLSpecifiedErrorBehaviors = exports.GraphQLResolverStep = exports.graphqlResolver = exports.grafastSync = exports.grafastPrint = exports.grafastGraphqlSync = exports.grafastGraphql = exports.grafast = exports.getNullableInputTypeAtPath = exports.getGrafastMiddleware = exports.getEnumValueConfigs = exports.getEnumValueConfig = exports.get = exports.flagError = exports.FirstStep = exports.first = exports.filter = exports.exportAsMany = exports.exportAs = exports.execute = exports.ExecutableStep = exports.ErrorStep = void 0;
-exports.trap = exports.subscribe = exports.stripAnsi = exports.stringifyPayload = exports.stepsAreInSamePhase = exports.stepAShouldTryAndInlineIntoStepB = exports.stepAMayDependOnStepB = exports.stepADependsOnStepB = exports.Step = exports.specFromNodeId = exports.SideEffectStep = exports.sideEffect = exports.setter = exports.Setter = exports.setsMatch = exports.SafeError = exports.rootValue = exports.ReverseStep = exports.reverseArray = exports.reverse = exports.RemapKeysStep = exports.remapKeys = exports.recordsMatch = exports.ProxyStep = exports.proxy = exports.partitionByIndex = exports.operationPlan = exports.OperationPlan = exports.ObjectStep = exports.objectSpec = exports.objectFieldSpec = exports.object = exports.noop = exports.NodeStep = exports.nodeIdFromNode = exports.node = exports.newObjectTypeBuilder = exports.newInputObjectTypeBuilder = exports.newGrafastFieldConfigBuilder = exports.multistep = exports.Modifier = exports.maybeArraysMatch = exports.mapsMatch = exports.makeGrafastSchema = exports.makeDecodeNodeIdRuntime = exports.makeDecodeNodeId = exports.LoadOneStep = exports.loadOneLoader = exports.loadOneCallback = exports.loadOne = void 0;
-exports.DeepEvalStep = exports.deepEval = exports.version = exports.hookArgs = exports.UnbatchedStep = exports.UnbatchedExecutableStep = exports.TRAP_INHIBITED = exports.TRAP_ERROR_OR_INHIBITED = exports.TRAP_ERROR = void 0;
+exports.defer = exports.defaultPlanResolver = exports.DEFAULT_ACCEPT_FLAGS = exports.debugPlans = exports.currentFieldStreamDetails = exports.createObjectAndApplyChildren = exports.context = exports.ConstantStep = exports.constant = exports.ConnectionStep = exports.connection = exports.ConditionStep = exports.condition = exports.CoalesceStep = exports.coalesce = exports.BakedInputStep = exports.bakedInputRuntime = exports.bakedInput = exports.asyncIteratorWithCleanup = exports.assertStep = exports.assertNotNull = exports.assertModifier = exports.assertListCapableStep = exports.assertExecutableStep = exports.arraysMatch = exports.arrayOfLength = exports.ApplyTransformsStep = exports.applyTransforms = exports.ApplyInputStep = exports.applyInput = exports.AccessStep = exports.access = exports.$$verbatim = exports.$$inhibit = exports.$$idempotent = exports.$$extensions = exports.$$eventEmitter = exports.$$bypassGraphQL = exports.__ValueStep = exports.__TrackedValueStep = exports.__ListTransformStep = exports.__ItemStep = exports.__InputStaticLeafStep = exports.__InputObjectStep = exports.__InputListStep = exports.__FlagStep = exports.isAsyncIterable = exports.GraphQLStreamDirective = exports.graphqlHasStreamDefer = exports.GraphQLDeferDirective = void 0;
+exports.loadMany = exports.LoadedRecordStep = exports.listTransform = exports.ListStep = exports.ListenStep = exports.listen = exports.list = exports.LastStep = exports.last = exports.LambdaStep = exports.lambda = exports.isUnaryStep = exports.isStep = exports.isSafeError = exports.isPromiseLike = exports.isObjectLikeStep = exports.isModifier = exports.isListLikeStep = exports.isListCapableStep = exports.isExecutableStep = exports.isDev = exports.inspect = exports.inputObjectFieldSpec = exports.inhibitOnNull = exports.groupBy = exports.GraphQLSpecifiedErrorBehaviors = exports.GraphQLResolverStep = exports.graphqlResolver = exports.grafastSync = exports.grafastPrint = exports.grafastGraphqlSync = exports.grafastGraphql = exports.grafast = exports.getNullableInputTypeAtPath = exports.getGrafastMiddleware = exports.getEnumValueConfigs = exports.getEnumValueConfig = exports.get = exports.flagError = exports.FirstStep = exports.first = exports.filter = exports.exportAsMany = exports.exportAs = exports.execute = exports.ExecutableStep = exports.ErrorStep = exports.error = exports.EdgeStep = exports.each = void 0;
+exports.stringifyPayload = exports.stepsAreInSamePhase = exports.stepAShouldTryAndInlineIntoStepB = exports.stepAMayDependOnStepB = exports.stepADependsOnStepB = exports.Step = exports.specFromNodeId = exports.SideEffectStep = exports.sideEffect = exports.setter = exports.Setter = exports.setsMatch = exports.SafeError = exports.rootValue = exports.ReverseStep = exports.reverseArray = exports.reverse = exports.RemapKeysStep = exports.remapKeys = exports.recordsMatch = exports.ProxyStep = exports.proxy = exports.partitionByIndex = exports.operationPlan = exports.OperationPlan = exports.ObjectStep = exports.objectSpec = exports.objectFieldSpec = exports.object = exports.noop = exports.NodeStep = exports.nodeIdFromNode = exports.node = exports.newObjectTypeBuilder = exports.newInputObjectTypeBuilder = exports.newGrafastFieldConfigBuilder = exports.multistep = exports.Modifier = exports.maybeArraysMatch = exports.mapsMatch = exports.makeGrafastSchema = exports.makeDecodeNodeIdRuntime = exports.makeDecodeNodeId = exports.LoadOneStep = exports.loadOneLoader = exports.loadOneCallback = exports.loadOne = exports.LoadManyStep = exports.loadManyLoader = exports.loadManyCallback = void 0;
+exports.DeepEvalStep = exports.deepEval = exports.version = exports.hookArgs = exports.UnbatchedStep = exports.UnbatchedExecutableStep = exports.TRAP_INHIBITED = exports.TRAP_ERROR_OR_INHIBITED = exports.TRAP_ERROR = exports.trap = exports.subscribe = exports.stripAnsi = void 0;
 const tslib_1 = require("tslib");
 require("./thereCanBeOnlyOne.js");
 const debug_1 = tslib_1.__importDefault(require("debug"));
@@ -187,6 +187,10 @@ Object.defineProperty(exports, "stepADependsOnStepB", { enumerable: true, get: f
 Object.defineProperty(exports, "stepAMayDependOnStepB", { enumerable: true, get: function () { return utils_js_1.stepAMayDependOnStepB; } });
 Object.defineProperty(exports, "stepAShouldTryAndInlineIntoStepB", { enumerable: true, get: function () { return utils_js_1.stepAShouldTryAndInlineIntoStepB; } });
 Object.defineProperty(exports, "stepsAreInSamePhase", { enumerable: true, get: function () { return utils_js_1.stepsAreInSamePhase; } });
+var incremental_js_1 = require("./incremental.js");
+Object.defineProperty(exports, "GraphQLDeferDirective", { enumerable: true, get: function () { return incremental_js_1.GraphQLDeferDirective; } });
+Object.defineProperty(exports, "graphqlHasStreamDefer", { enumerable: true, get: function () { return incremental_js_1.graphqlHasStreamDefer; } });
+Object.defineProperty(exports, "GraphQLStreamDirective", { enumerable: true, get: function () { return incremental_js_1.GraphQLStreamDirective; } });
 var iterall_1 = require("iterall");
 Object.defineProperty(exports, "isAsyncIterable", { enumerable: true, get: function () { return iterall_1.isAsyncIterable; } });
 (0, exportAs_js_1.exportAsMany)("grafast", {

package/dist/interfaces.d.ts

@@ -260,8 +260,14 @@ export interface StepStreamOptions extends LayerPlanReasonListItemStream {
 export interface StepOptions {
     /**
      * Details for the `@stream` directive.
+     *
+     * object - `@stream` details
+     *
+     * true - no stream directive, but is inside a subscription field
+     *
+     * null - no stream directive
      */
-    stream: StepStreamOptions | null;
+    stream: StepStreamOptions | true | null;
     /**
      * Should we walk an iterable if presented. This is important because we
      * don't want to walk things like Map/Set except if we're doing it as part of

package/dist/makeGrafastSchema.js

@@ -4,6 +4,7 @@ exports.makeGrafastSchema = makeGrafastSchema;
 const tslib_1 = require("tslib");
 const graphql_1 = require("graphql");
 const graphql = tslib_1.__importStar(require("graphql"));
+const incremental_js_1 = require("./incremental.js");
 const utils_js_1 = require("./utils.js");
 const { buildASTSchema, isEnumType, isInputObjectType, isInterfaceType, isObjectType, isScalarType, isUnionType, parse, } = graphql;
 /**
@@ -12,7 +13,7 @@ const { buildASTSchema, isEnumType, isInputObjectType, isInterfaceType, isObject
  */
 function makeGrafastSchema(details) {
     const { typeDefs, plans: rawPlans, objects, unions, interfaces, inputObjects, scalars, enums, enableDeferStream = false, } = details;
-    const document = typeof typeDefs === "string"
+    const baseDocument = typeof typeDefs === "string"
         ? parse(typeDefs)
         : Array.isArray(typeDefs)
             ? {
@@ -20,11 +21,22 @@ function makeGrafastSchema(details) {
                 definitions: typeDefs.flatMap((t) => t.definitions),
             }
             : typeDefs;
+    const document = incremental_js_1.graphqlHasStreamDefer || !enableDeferStream
+        ? baseDocument
+        : {
+            ...baseDocument,
+            definitions: [
+                ...baseDocument.definitions,
+                incremental_js_1.deferDefinition,
+                incremental_js_1.streamDefinition,
+            ],
+        };
     if (!document || document.kind !== "Document") {
         throw new Error("The first argument to makeGrafastSchema must be an object containing a `typeDefs` field; the value for this field should be a parsed GraphQL document, array of these, or a string.");
     }
     const astSchema = buildASTSchema(document, {
-        enableDeferStream,
+        // @ts-ignore
+        enableDeferStream: enableDeferStream && incremental_js_1.graphqlHasStreamDefer,
     });
     let plans;
     if (rawPlans) {

package/dist/mermaid.d.ts

@@ -11,7 +11,12 @@ export interface PrintPlanGraphOptions {
     includePaths?: boolean;
     concise?: boolean;
     skipBuckets?: boolean;
+    /**
+     * Should the leaves render as a vertical chain to save horizontal space?
+     * Set false to disable
+     */
+    collapseLeaves?: boolean;
 }
-export declare function planToMermaid(planJSON: GrafastPlanJSON, { concise, skipBuckets, }?: PrintPlanGraphOptions): string;
+export declare function planToMermaid(planJSON: GrafastPlanJSON, { concise, collapseLeaves, skipBuckets, }?: PrintPlanGraphOptions): string;
 export * from "./planJSONInterfaces.js";
 //# sourceMappingURL=mermaid.d.ts.map

package/dist/mermaid.js

@@ -67,7 +67,7 @@ function isGrafastPlanJSONv1(json) {
 }
 function planToMermaid(planJSON, { 
 // printPathRelations = false,
-concise = false, skipBuckets = global.grafastExplainMermaidSkipBuckets ?? false, } = {}) {
+concise = false, collapseLeaves = true, skipBuckets = global.grafastExplainMermaidSkipBuckets ?? false, } = {}) {
     if (!isGrafastPlanJSONv1(planJSON)) {
         throw new Error("planToMermaid only supports v1 plan JSON");
     }
@@ -107,7 +107,7 @@ concise = false, skipBuckets = global.grafastExplainMermaidSkipBuckets ?? false,
         }
         if (step.bucketId === 0 &&
             step.isSyncAndSafe &&
-            (dependentsByStepId[step.id]?.length ?? 0) === 0) {
+            !dependentsByStepId[step.id]) {
             return true;
         }
         return false;
@@ -294,6 +294,7 @@ concise = false, skipBuckets = global.grafastExplainMermaidSkipBuckets ?? false,
         if (shouldHideStep(plan))
             return;
         const planNode = planId(plan);
+        /** `plan`'s dependencies as rendered step ids */
         const depNodes = plan.dependencyIds.map((depId) => {
             const step = stepById[depId];
             if (shouldHideStep(step) || isExcessivelyReferenced(depId)) {
@@ -334,7 +335,7 @@ concise = false, skipBuckets = global.grafastExplainMermaidSkipBuckets ?? false,
                 }
             }
             else {
-                if (concise &&
+                if (collapseLeaves !== false &&
                     !dependentsByStepId[plan.id] &&
                     depNodes.length === 1) {
                     // Try alternating the nodes so they render closer together