grafast 0.1.1-beta.22 → 0.1.1-beta.24

package/dist/index.d.ts

@@ -71,6 +71,22 @@ declare global {
         }
         interface InputObjectTypeExtensions {
             baked?: InputObjectTypeBakedResolver;
+            /**
+             * EXPERIMENTAL!
+             *
+             * Scope to pass to `.apply()` methods called by `applyInput()` step.
+             *
+             * IMPORTANT: the scope is only evaluated for the top-level named type
+             * that `applyInput()` is applied against, so any type that nests this
+             * (e.g. other input objects) needs to ensure they have an `applyScope()`
+             * that's compatible; similarly this `applyPlan()` needs to supply values
+             * that are compatible with all the descendant input objects, enums and
+             * scalars. For this reason we recommend that you return an object with a
+             * scoped key that you care about so it's easily merged.
+             *
+             * @experimental
+             */
+            applyScope?: () => Step;
         }
         interface InputFieldExtensions {
             apply?: InputObjectFieldApplyResolver<any>;
@@ -130,6 +146,20 @@ declare global {
             planType?($stepOrSpecifier: Step, info: PlanTypeInfo): AbstractTypePlanner;
         }
         interface EnumTypeExtensions {
+            /**
+             * EXPERIMENTAL!
+             *
+             * Scope to pass to `.apply()` methods called by `applyInput()` step.
+             *
+             * IMPORTANT: the scope is only evaluated for the top-level named type
+             * that `applyInput()` is applied against, so any type that nests this
+             * (e.g. input objects) needs to ensure they have an `applyScope()`
+             * that's compatible. For this reason we recommend that you return an
+             * object with a scoped key that you care about so it's easily merged.
+             *
+             * @experimental
+             */
+            applyScope?: () => Step;
         }
         interface EnumValueExtensions {
             /**
@@ -143,6 +173,20 @@ declare global {
         interface ScalarTypeExtensions {
             plan?: ScalarPlanResolver;
             inputPlan?: ScalarInputPlanResolver;
+            /**
+             * EXPERIMENTAL!
+             *
+             * Scope to pass to `.apply()` methods called by `applyInput()` step.
+             *
+             * IMPORTANT: the scope is only evaluated for the top-level named type
+             * that `applyInput()` is applied against, so any type that nests this
+             * (e.g. input objects) needs to ensure they have an `applyScope()`
+             * that's compatible. For this reason we recommend that you return an
+             * object with a scoped key that you care about so it's easily merged.
+             *
+             * @experimental
+             */
+            applyScope?: () => Step;
             /**
              * Set true if `serialize(serialize(foo)) === serialize(foo)` for all foo
              */

package/dist/interfaces.d.ts

@@ -1,6 +1,6 @@
 import type EventEmitter from "eventemitter3";
 import type { Middleware } from "graphile-config";
-import type { ASTNode, ExecutionArgs, FragmentDefinitionNode, GraphQLArgs, GraphQLArgument, GraphQLArgumentConfig, GraphQLField, GraphQLFieldConfig, GraphQLInputField, GraphQLInputFieldConfig, GraphQLInputObjectType, GraphQLInputType, GraphQLInterfaceType, GraphQLObjectType, GraphQLOutputType, GraphQLScalarType, GraphQLSchema, GraphQLUnionType, OperationDefinitionNode, Source, ValueNode, VariableNode } from "graphql";
+import type { ASTNode, ExecutionArgs, FragmentDefinitionNode, GraphQLArgs, GraphQLArgument, GraphQLArgumentConfig, GraphQLEnumValue, GraphQLField, GraphQLFieldConfig, GraphQLInputField, GraphQLInputFieldConfig, GraphQLInputObjectType, GraphQLInputType, GraphQLInterfaceType, GraphQLObjectType, GraphQLOutputType, GraphQLScalarType, GraphQLSchema, GraphQLUnionType, OperationDefinitionNode, Source, ValueNode, VariableNode } from "graphql";
 import type { ObjMap } from "graphql/jsutils/ObjMap.js";
 import type { $$streamMore, $$timeout, $$ts, ExecutionEntryFlags } from "./constants.js";
 import type { Constraint } from "./constraints.js";
@@ -158,11 +158,12 @@ export interface FieldInfo {
  * executions.
  */
 export type FieldPlanResolver<TParentStep extends Step = Step, TArgs extends BaseGraphQLArguments = any, TResultStep extends Step = Step> = ($parentPlan: TParentStep, args: FieldArgs<TArgs>, info: FieldInfo) => TResultStep | null;
-export type InputObjectFieldApplyResolver<TParent = any, TData = any> = (target: TParent, input: TData, // Don't use unknown here, otherwise users can't easily cast it
+export type InputObjectFieldApplyResolver<TParent = any, TData = any, TScope = any> = (target: TParent, input: TData, // Don't use unknown here, otherwise users can't easily cast it
 info: {
     schema: GraphQLSchema;
     fieldName: string;
     field: GraphQLInputField;
+    scope: TScope;
 }) => any;
 export type InputObjectTypeBakedInfo = {
     schema: GraphQLSchema;
@@ -199,7 +200,10 @@ export type ScalarInputPlanResolver<TResultStep extends Step = Step> = ($inputVa
  *
  * @experimental
  */
-export type EnumValueApplyResolver<TParent = any> = (parent: TParent) => void;
+export type EnumValueApplyResolver<TParent = any, TScope = any> = (parent: TParent, info: {
+    value: GraphQLEnumValue;
+    scope: TScope;
+}) => void;
 /**
  * Basically GraphQLFieldConfig but with an easy to access `plan` method.
  */

package/dist/steps/applyInput.d.ts

@@ -13,13 +13,20 @@ export declare class ApplyInputStep<TParent extends object = any, TTarget extend
     isSyncAndSafe: boolean;
     allowMultipleOptimizations: boolean;
     valueDepId: 0;
-    constructor(inputType: GraphQLInputType, $value: AnyInputStep, getTargetFromParent: ((parent: TParent, inputValue: any) => TTarget | undefined | (() => TTarget)) | undefined);
+    scopeDepId: 1 | null;
+    constructor(inputType: GraphQLInputType, $value: AnyInputStep, getTargetFromParent: ((parent: TParent, inputValue: any, info: {
+        scope: unknown;
+    }) => TTarget | undefined | (() => TTarget)) | undefined, $scope?: Step | null);
     deduplicate(peers: readonly ApplyInputStep[]): ApplyInputStep<any, any>[];
     optimize(): this | ConstantStep<(parent: TParent) => void>;
-    unbatchedExecute(extra: UnbatchedExecutionExtra, value: any): (parentThing: TParent) => void;
+    unbatchedExecute(extra: UnbatchedExecutionExtra, value: any, scope: unknown): (parentThing: TParent) => void;
 }
-export declare function inputArgsApply<TArg extends object, TTarget extends object = TArg>(schema: GraphQLSchema, inputType: GraphQLInputType, parent: TArg, inputValue: unknown, getTargetFromParent: ((parent: TArg, inputValue: any) => TTarget | undefined | (() => TTarget)) | undefined): void;
-export declare function applyInput<TParent extends object = any, TTarget extends object = TParent>(inputType: GraphQLInputType, $value: AnyInputStep, getTargetFromParent?: (parent: TParent, inputValue: any) => TTarget | undefined): ConstantStep<(parent: TParent) => void> | ApplyInputStep<TParent, TTarget>;
+export declare function inputArgsApply<TArg extends object, TTarget extends object = TArg>(schema: GraphQLSchema, inputType: GraphQLInputType, parent: TArg, inputValue: unknown, getTargetFromParent: ((parent: TArg, inputValue: any, info: {
+    scope: unknown;
+}) => TTarget | undefined | (() => TTarget)) | undefined, scope: unknown): void;
+export declare function applyInput<TParent extends object = any, TTarget extends object = TParent>(inputType: GraphQLInputType, $value: AnyInputStep, getTargetFromParent?: (parent: TParent, inputValue: any, info: {
+    scope: unknown;
+}) => TTarget | undefined): ConstantStep<(parent: TParent) => void> | ApplyInputStep<TParent, TTarget>;
 /**
  * Modifiers modify their parent (which may be another modifier or anything
  * else). First they gather all the requirements from their children (if any)

package/dist/steps/applyInput.js

@@ -18,13 +18,14 @@ class ApplyInputStep extends step_js_1.UnbatchedStep {
         moduleName: "grafast",
         exportName: "ApplyInputStep",
     }; }
-    constructor(inputType, $value, getTargetFromParent) {
+    constructor(inputType, $value, getTargetFromParent, $scope) {
         super();
         this.inputType = inputType;
         this.getTargetFromParent = getTargetFromParent;
         this.isSyncAndSafe = true;
         this.allowMultipleOptimizations = true;
         this.valueDepId = this.addUnaryDependency($value);
+        this.scopeDepId = $scope ? this.addUnaryDependency($scope) : null;
         if (!this._isUnary) {
             throw new Error(`applyInput() must be unary`);
         }
@@ -36,30 +37,33 @@ class ApplyInputStep extends step_js_1.UnbatchedStep {
     }
     optimize() {
         const $value = this.getDep(this.valueDepId);
-        if ($value instanceof constant_js_1.ConstantStep) {
+        const $scope = this.scopeDepId === null ? null : this.getDep(this.scopeDepId);
+        if ((!$scope || $scope instanceof constant_js_1.ConstantStep) &&
+            $value instanceof constant_js_1.ConstantStep) {
             // Replace myself with a constant!
             const { operationPlan: { schema }, inputType, getTargetFromParent, } = this;
             const { data } = $value;
+            const scope = $scope?.data;
             return (0, constant_js_1.constant)(function applyInputConstant(parent) {
-                inputArgsApply(schema, inputType, parent, data, getTargetFromParent);
+                inputArgsApply(schema, inputType, parent, data, getTargetFromParent, scope);
             }, false);
         }
         return this;
     }
-    unbatchedExecute(extra, value) {
+    unbatchedExecute(extra, value, scope) {
         const { getTargetFromParent } = this;
-        return (parentThing) => inputArgsApply(this.operationPlan.schema, this.inputType, parentThing, value, getTargetFromParent);
+        return (parentThing) => inputArgsApply(this.operationPlan.schema, this.inputType, parentThing, value, getTargetFromParent, scope);
     }
 }
 exports.ApplyInputStep = ApplyInputStep;
-function inputArgsApply(schema, inputType, parent, inputValue, getTargetFromParent) {
+function inputArgsApply(schema, inputType, parent, inputValue, getTargetFromParent, scope) {
     try {
         inputArgsApplyDepth++;
         const target = getTargetFromParent
-            ? getTargetFromParent(parent, inputValue)
+            ? getTargetFromParent(parent, inputValue, { scope })
             : parent;
         if (target != null) {
-            _inputArgsApply(schema, inputType, target, inputValue);
+            _inputArgsApply(schema, inputType, target, inputValue, scope);
         }
     }
     finally {
@@ -82,16 +86,20 @@ function inputArgsApply(schema, inputType, parent, inputValue, getTargetFromPare
 function applyInput(inputType, $value, getTargetFromParent) {
     const opPlan = (0, global_js_1.operationPlan)();
     const { schema } = opPlan;
+    const namedType = (0, graphql_1.getNamedType)(inputType);
     return opPlan.withRootLayerPlan(() => {
-        if ($value instanceof constant_js_1.ConstantStep) {
+        const $scope = namedType.extensions?.grafast?.applyScope?.() ?? null;
+        if ((!$scope || $scope instanceof constant_js_1.ConstantStep) &&
+            $value instanceof constant_js_1.ConstantStep) {
             // Replace us with a constant
             const { data } = $value;
+            const scope = $scope?.data;
             return (0, constant_js_1.constant)(function applyInputConstant(parent) {
-                inputArgsApply(schema, inputType, parent, data, getTargetFromParent);
+                inputArgsApply(schema, inputType, parent, data, getTargetFromParent, scope);
             }, false);
         }
         else {
-            return new ApplyInputStep(inputType, $value, getTargetFromParent);
+            return new ApplyInputStep(inputType, $value, getTargetFromParent, $scope);
         }
     });
 }
@@ -106,7 +114,7 @@ const defaultInputObjectTypeInputPlanResolver: InputObjectTypeInputPlanResolver
     return object(obj);
   };
 */
-function _inputArgsApply(schema, inputType, target, inputValue) {
+function _inputArgsApply(schema, inputType, target, inputValue, scope) {
     // PERF: we should have the plan generate a digest of `inputType` so that we
     // can jump right to the relevant parts without too much traversal cost.
     if (inputValue === undefined) {
@@ -116,7 +124,7 @@ function _inputArgsApply(schema, inputType, target, inputValue) {
         if (inputValue === null) {
             throw new Error(`null value found in non-null position`);
         }
-        _inputArgsApply(schema, inputType.ofType, target, inputValue);
+        _inputArgsApply(schema, inputType.ofType, target, inputValue, scope);
     }
     else if ((0, graphql_1.isListType)(inputType)) {
         if (inputValue == null)
@@ -126,7 +134,7 @@ function _inputArgsApply(schema, inputType, target, inputValue) {
         }
         for (const item of inputValue) {
             const itemTarget = typeof target === "function" ? target() : target;
-            _inputArgsApply(schema, inputType.ofType, itemTarget, item);
+            _inputArgsApply(schema, inputType.ofType, itemTarget, item, scope);
         }
     }
     else if (typeof target === "function") {
@@ -146,9 +154,10 @@ function _inputArgsApply(schema, inputType, target, inputValue) {
                     schema,
                     field,
                     fieldName,
+                    scope,
                 });
                 if (newTarget != null) {
-                    _inputArgsApply(schema, field.type, newTarget, val);
+                    _inputArgsApply(schema, field.type, newTarget, val, scope);
                 }
             }
         }
@@ -165,7 +174,7 @@ function _inputArgsApply(schema, inputType, target, inputValue) {
         const value = values.find((v) => v.value === inputValue);
         if (value) {
             if (value.extensions.grafast?.apply) {
-                value.extensions.grafast.apply(target);
+                value.extensions.grafast.apply(target, { scope, value });
             }
         }
         else {

package/dist/steps/bakedInput.js

@@ -78,11 +78,11 @@ function bakedInputRuntime(schema, inputType, value) {
             schema,
             applyChildren(parent) {
                 applied = true;
-                (0, applyInput_js_1.inputArgsApply)(schema, nullableInputType, parent, value, undefined);
+                (0, applyInput_js_1.inputArgsApply)(schema, nullableInputType, parent, value, undefined, undefined);
             },
         });
         if (!applied) {
-            (0, applyInput_js_1.inputArgsApply)(schema, nullableInputType, bakedObj, value, undefined);
+            (0, applyInput_js_1.inputArgsApply)(schema, nullableInputType, bakedObj, value, undefined, undefined);
         }
         return bakedObj;
     }

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "0.1.1-beta.22";
+export declare const version = "0.1.1-beta.24";
 //# sourceMappingURL=version.d.ts.map

package/dist/version.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // This file is autogenerated by /scripts/postversion.mjs
-exports.version = "0.1.1-beta.22";
+exports.version = "0.1.1-beta.24";
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "grafast",
-  "version": "0.1.1-beta.22",
+  "version": "0.1.1-beta.24",
   "description": "Cutting edge GraphQL planning and execution engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -57,9 +57,9 @@
   "dependencies": {
     "@graphile/lru": "^5.0.0-beta.4",
     "chalk": "^4.1.2",
-    "debug": "^4.3.4",
+    "debug": "^4.4.1",
     "eventemitter3": "^5.0.1",
-    "graphile-config": "^0.0.1-beta.16",
+    "graphile-config": "^0.0.1-beta.17",
     "graphql": "^16.1.0-experimental-stream-defer.6",
     "iterall": "^1.3.0",
     "tamedevil": "^0.0.0-beta.8",
@@ -73,6 +73,12 @@
   "peerDependenciesMeta": {
     "@envelop/core": {
       "optional": true
+    },
+    "graphql": {
+      "optional": true
+    },
+    "tamedevil": {
+      "optional": true
     }
   },
   "files": [