Add __assertStep support to makeExtendSchemaPlugin

graphile · Jan 19, 2024 · 1dd9c30 · 1dd9c30
1 parent d8d2803
commit 1dd9c30
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 4 deletions.
diff --git a/grafast/grafast/src/makeGrafastSchema.ts b/grafast/grafast/src/makeGrafastSchema.ts
@@ -48,7 +48,9 @@ export type FieldPlans =
  * The plans/config for each field of a GraphQL object type.
  */
 export type ObjectPlans = {
-  __Step?: { new (...args: any[]): ExecutableStep };
+  __assertStep?:
+    | ((step: ExecutableStep) => asserts step is ExecutableStep)
+    | { new (...args: any[]): ExecutableStep };
 } & {
   [fieldName: string]: FieldPlans;
 };
@@ -142,6 +144,10 @@ export function makeGrafastSchema(details: {
             type.extensions as graphql.GraphQLObjectTypeExtensions<any, any>
           ).grafast = { assertStep: fieldSpec as any };
           continue;
+        } else if (fieldName.startsWith("__")) {
+          throw new Error(
+            `Unsupported field name '${fieldName}'; perhaps you meant '__assertStep'?`,
+          );
         }
 
         const field = fields[fieldName];

diff --git a/graphile-build/graphile-utils/src/makeExtendSchemaPlugin.ts b/graphile-build/graphile-utils/src/makeExtendSchemaPlugin.ts
@@ -1,4 +1,4 @@
-import type { FieldPlanResolver } from "grafast";
+import type { ExecutableStep, FieldPlanResolver } from "grafast";
 import type {
   DefinitionNode,
   DirectiveDefinitionNode,
@@ -14,6 +14,7 @@ import type {
   // Config:
   GraphQLEnumValueConfigMap,
   GraphQLFieldConfigMap,
+  GraphQLObjectTypeExtensions,
   // Resolvers:
   GraphQLFieldResolver,
   GraphQLInputFieldConfigMap,
@@ -69,11 +70,15 @@ export interface ObjectResolver<TSource = any, TContext = any> {
     | ObjectFieldConfig<TSource, TContext>;
 }
 
-export interface ObjectPlan<TSource = any, TContext = any> {
+export type ObjectPlan<TSource = any, TContext = any> = {
+  __assertStep?:
+    | ((step: ExecutableStep) => asserts step is ExecutableStep)
+    | { new (...args: any[]): ExecutableStep };
+} & {
   [key: string]:
     | FieldPlanResolver<any, any, any>
     | ObjectFieldConfig<TSource, TContext>;
-}
+};
 
 export interface EnumResolver {
   [key: string]: string | number | Array<any> | Record<string, any> | symbol;
@@ -412,6 +417,15 @@ export function makeExtendSchemaPlugin(
                         description,
                       }
                     : null),
+                  ...(plans?.[name]?.__assertStep
+                    ? {
+                        extensions: {
+                          grafast: {
+                            assertStep: plans[name].__assertStep as any,
+                          },
+                        } as GraphQLObjectTypeExtensions<any, any>,
+                      }
+                    : null),
                 }),
                 uniquePluginName,
               );