Add MiddlewareHandlers helper

.changeset/eighty-meals-confess.md

@@ -0,0 +1,5 @@
+---
+"grafast": patch
+---
+
+Internal: adopt new MiddlewareHandlers type for simplicity.

.changeset/mean-mugs-hide.md

@@ -0,0 +1,7 @@
+---
+"grafserv": patch
+---
+
+Adopt new MiddlewareHandlers type for simplicity, and in doing so fix type of
+middleware (for plugins) that incorrectly unwrapped promise resulting in
+TypeScript incorrectly suggesting that `await` was not necessary.

.changeset/nine-islands-do.md

@@ -0,0 +1,6 @@
+---
+"graphile-config": patch
+---
+
+Adds `MiddlewareHandlers<TActivities>` type to help with adding middleware to
+configs

grafast/grafast/src/index.ts

@@ -2,7 +2,7 @@ import "./thereCanBeOnlyOne.js";
 
 import type LRU from "@graphile/lru";
 import debugFactory from "debug";
-import type { CallbackOrDescriptor, MiddlewareNext } from "graphile-config";
+import type { MiddlewareHandlers } from "graphile-config";
 import type {
   DocumentNode,
   GraphQLError,
@@ -780,15 +780,7 @@ declare global {
     }
     interface Plugin {
       grafast?: {
-        middleware?: {
-          [key in keyof GrafastMiddleware]?: CallbackOrDescriptor<
-            GrafastMiddleware[key] extends (
-              ...args: infer UArgs
-            ) => infer UResult
-              ? (next: MiddlewareNext<UResult>, ...args: UArgs) => UResult
-              : never
-          >;
-        };
+        middleware?: MiddlewareHandlers<GrafastMiddleware>;
       };
     }
   }

grafast/grafserv/src/index.ts

@@ -1,6 +1,6 @@
 import type { PromiseOrDirect } from "grafast";
 import type { ExecutionArgs, GraphQLError } from "grafast/graphql";
-import type { CallbackOrDescriptor, MiddlewareNext } from "graphile-config";
+import type { CallbackOrDescriptor, MiddlewareHandlers } from "graphile-config";
 import type { RuruHTMLParts } from "ruru/server";
 
 import type {
@@ -86,18 +86,7 @@ declare global {
               : never
           >;
         };
-        middleware?: {
-          [key in keyof GrafservMiddleware]?: CallbackOrDescriptor<
-            GrafservMiddleware[key] extends (
-              ...args: infer UArgs
-            ) => infer UResult
-              ? (
-                  next: MiddlewareNext<Awaited<UResult>>,
-                  ...args: UArgs
-                ) => UResult
-              : never
-          >;
-        };
+        middleware?: MiddlewareHandlers<GrafservMiddleware>;
       };
     }
     interface GrafservOptions {

utils/graphile-config/src/index.ts

@@ -17,7 +17,7 @@ export type {
   CallbackOrDescriptor,
   FunctionalityObject,
 } from "./interfaces.js";
-export type { MiddlewareNext } from "./middleware.js";
+export type { MiddlewareHandlers, MiddlewareNext } from "./middleware.js";
 export { Middleware } from "./middleware.js";
 export { isResolvedPreset, resolvePresets } from "./resolvePresets.js";
 

utils/graphile-config/src/middleware.ts

@@ -175,3 +175,13 @@ function makeNext<TRawResult, TAwaitedResult = Awaited<TRawResult>>(
   };
   return next;
 }
+
+export type MiddlewareHandlers<
+  TActivities extends FunctionalityObject<TActivities>,
+> = {
+  [key in keyof TActivities]?: CallbackOrDescriptor<
+    TActivities[key] extends (...args: infer UArgs) => infer UResult
+      ? (next: MiddlewareNext<UResult>, ...args: UArgs) => UResult
+      : never
+  >;
+};

utils/website/graphile-config/middleware.md

@@ -206,6 +206,32 @@ type SomeActionResult = number;
 
 export type PromiseOrDirect<T> = Promise<T> | T;
 
+/***** index.ts *****/
+
+import type { MiddlewareHandlers } from "graphile-config";
+
+// Extend Plugin with support for registering handlers for the middleware activities:
+declare global {
+  namespace GraphileConfig {
+    interface Plugin {
+      libraryName?: {
+        middleware?: MiddlewareHandlers<MyMiddleware>;
+
+        // Prior to [email protected], a more verbose alternative was required:
+        /*
+        middleware?: {
+          [key in keyof MyMiddleware]?: CallbackOrDescriptor<
+            MyMiddleware[key] extends (...args: infer UArgs) => infer UResult
+              ? (next: MiddlewareNext<UResult>, ...args: UArgs) => UResult
+              : never
+          >;
+        };
+        */
+      };
+    }
+  }
+}
+
 /***** getMiddleware.ts *****/
 
 import { Middleware, orderedApply, resolvePresets } from "graphile-config";