inngest 0.8.5 → 0.8.6-beta.1

package/cloudflare.d.ts

@@ -1,4 +1,4 @@
-import { ServeHandler } from "./express";
+import { ServeHandler } from "./components/InngestCommHandler";
 /**
  * In Cloudflare, serve and register any declared functions with Inngest, making
  * them available to be triggered by events.

package/cloudflare.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cloudflare.d.ts","sourceRoot":"","sources":["../src/cloudflare.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,YAAY,EACb,MAAM,WAAW,CAAC;AAqHnB;;;;;GAKG;AACH,eAAO,MAAM,KAAK,EAAE,YAOnB,CAAC"}
+{"version":3,"file":"cloudflare.d.ts","sourceRoot":"","sources":["../src/cloudflare.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EACb,MAAM,iCAAiC,CAAC;AAGzC;;;;;GAKG;AACH,eAAO,MAAM,KAAK,EAAE,YAmEnB,CAAC"}

package/cloudflare.js

@@ -1,87 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serve = void 0;
-const zod_1 = require("zod");
-const express_1 = require("./express");
+const InngestCommHandler_1 = require("./components/InngestCommHandler");
 const consts_1 = require("./helpers/consts");
-const devserver_1 = require("./helpers/devserver");
-const landing_1 = require("./landing");
-class CloudflareCommHandler extends express_1.InngestCommHandler {
-    constructor() {
-        super(...arguments);
-        this.frameworkName = "cloudflare-pages";
-    }
-    createHandler() {
-        return async ({ request: req, env, }) => {
-            const headers = { "x-inngest-sdk": this.sdkHeader.join("") };
-            let reqUrl;
-            let isIntrospection;
-            try {
-                reqUrl = this.reqUrl(req.url, `https://${req.headers.get("host") || ""}`);
-                isIntrospection = reqUrl.searchParams.has(consts_1.queryKeys.Introspect);
-                reqUrl.searchParams.delete(consts_1.queryKeys.Introspect);
-            }
-            catch (err) {
-                return new Response(JSON.stringify(err), {
-                    status: 500,
-                    headers,
-                });
-            }
-            if (!this.signingKey && env[consts_1.envKeys.SigningKey]) {
-                this.signingKey = env[consts_1.envKeys.SigningKey];
-            }
-            this._isProd = env.CF_PAGES === "1" || env.ENVIRONMENT === "production";
-            switch (req.method) {
-                case "GET": {
-                    const showLandingPage = this.shouldShowLandingPage(env[consts_1.envKeys.LandingPage]);
-                    if (this._isProd || !showLandingPage)
-                        break;
-                    if (isIntrospection) {
-                        const introspection = Object.assign(Object.assign({}, this.registerBody(reqUrl)), { devServerURL: (0, devserver_1.devServerUrl)(env[consts_1.envKeys.DevServerUrl]).href, hasSigningKey: Boolean(this.signingKey) });
-                        return new Response(JSON.stringify(introspection), {
-                            status: 200,
-                            headers,
-                        });
-                    }
-                    // Grab landing page and serve
-                    return new Response(landing_1.landing, {
-                        status: 200,
-                        headers: Object.assign(Object.assign({}, headers), { "content-type": "text/html; charset=utf-8" }),
-                    });
-                }
-                case "PUT": {
-                    // Push config to Inngest.
-                    const { status, message } = await this.register(reqUrl, env[consts_1.envKeys.DevServerUrl]);
-                    return new Response(JSON.stringify({ message }), { status, headers });
-                }
-                case "POST": {
-                    // Inngest is trying to run a step; confirm signed and run.
-                    const { fnId, stepId } = zod_1.z
-                        .object({
-                        fnId: zod_1.z.string().min(1),
-                        stepId: zod_1.z.string().min(1),
-                    })
-                        .parse({
-                        fnId: reqUrl.searchParams.get(consts_1.queryKeys.FnId),
-                        stepId: reqUrl.searchParams.get(consts_1.queryKeys.StepId),
-                    });
-                    const stepRes = await this.runStep(fnId, stepId, await req.json());
-                    if (stepRes.status === 500) {
-                        return new Response(JSON.stringify(stepRes.error), {
-                            status: stepRes.status,
-                            headers,
-                        });
-                    }
-                    return new Response(JSON.stringify(stepRes.body), {
-                        status: stepRes.status,
-                        headers,
-                    });
-                }
-            }
-            return new Response(null, { status: 405, headers });
-        };
-    }
-}
 /**
  * In Cloudflare, serve and register any declared functions with Inngest, making
  * them available to be triggered by events.
@@ -89,7 +10,54 @@ class CloudflareCommHandler extends express_1.InngestCommHandler {
  * @public
  */
 const serve = (nameOrInngest, fns, opts) => {
-    return (0, express_1.serve)(new CloudflareCommHandler(nameOrInngest, fns, Object.assign({ fetch: fetch.bind(globalThis) }, opts)));
+    const handler = new InngestCommHandler_1.InngestCommHandler("cloudflare-pages", nameOrInngest, fns, Object.assign({ 
+        /**
+         * Assume that we want to override the `fetch` implementation with the one
+         * globally available in the Cloudflare env. Specifying it here will
+         * ensure we avoid trying to load a Node-compatible version later.
+         */
+        fetch: fetch.bind(globalThis) }, opts), ({ request: req, env, }) => {
+        const url = new URL(req.url, `https://${req.headers.get("host") || ""}`);
+        const isProduction = env.CF_PAGES === "1" || env.ENVIRONMENT === "production";
+        return {
+            view: () => {
+                if (req.method === "GET") {
+                    return {
+                        url,
+                        env,
+                        isIntrospection: url.searchParams.has(consts_1.queryKeys.Introspect),
+                        isProduction,
+                    };
+                }
+            },
+            register: () => {
+                if (req.method === "PUT") {
+                    return {
+                        env,
+                        url,
+                        isProduction,
+                    };
+                }
+            },
+            run: async () => {
+                if (req.method === "POST") {
+                    return {
+                        fnId: url.searchParams.get(consts_1.queryKeys.FnId),
+                        data: (await req.json()),
+                        env,
+                        isProduction,
+                        url,
+                    };
+                }
+            },
+        };
+    }, ({ body, status, headers }) => {
+        return new Response(body, {
+            status,
+            headers,
+        });
+    });
+    return handler.createHandler();
 };
 exports.serve = serve;
 //# sourceMappingURL=cloudflare.js.map

package/cloudflare.js.map

@@ -1 +1 @@
-{"version":3,"file":"cloudflare.js","sourceRoot":"","sources":["../src/cloudflare.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,uCAImB;AACnB,6CAAsD;AACtD,mDAAmD;AACnD,uCAAoC;AAGpC,MAAM,qBAAsB,SAAQ,4BAAkB;IAAtD;;QACqB,kBAAa,GAAG,kBAAkB,CAAC;IA4GxD,CAAC;IA1GiB,aAAa;QAC3B,OAAO,KAAK,EAAE,EACZ,OAAO,EAAE,GAAG,EACZ,GAAG,GAIJ,EAAqB,EAAE;YACtB,MAAM,OAAO,GAAG,EAAE,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YAE7D,IAAI,MAAW,CAAC;YAChB,IAAI,eAAwB,CAAC;YAE7B,IAAI;gBACF,MAAM,GAAG,IAAI,CAAC,MAAM,CAClB,GAAG,CAAC,GAAG,EACP,WAAW,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAC3C,CAAC;gBAEF,eAAe,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAS,CAAC,UAAU,CAAC,CAAC;gBAChE,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,kBAAS,CAAC,UAAU,CAAC,CAAC;aAClD;YAAC,OAAO,GAAG,EAAE;gBACZ,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE;oBACvC,MAAM,EAAE,GAAG;oBACX,OAAO;iBACR,CAAC,CAAC;aACJ;YAED,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,GAAG,CAAC,gBAAO,CAAC,UAAU,CAAC,EAAE;gBAC/C,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,gBAAO,CAAC,UAAU,CAAC,CAAC;aAC3C;YAED,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,QAAQ,KAAK,GAAG,IAAI,GAAG,CAAC,WAAW,KAAK,YAAY,CAAC;YAExE,QAAQ,GAAG,CAAC,MAAM,EAAE;gBAClB,KAAK,KAAK,CAAC,CAAC;oBACV,MAAM,eAAe,GAAG,IAAI,CAAC,qBAAqB,CAChD,GAAG,CAAC,gBAAO,CAAC,WAAW,CAAC,CACzB,CAAC;oBAEF,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,eAAe;wBAAE,MAAM;oBAE5C,IAAI,eAAe,EAAE;wBACnB,MAAM,aAAa,mCACd,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAC5B,YAAY,EAAE,IAAA,wBAAY,EAAC,GAAG,CAAC,gBAAO,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,EAC1D,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,GACxC,CAAC;wBAEF,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE;4BACjD,MAAM,EAAE,GAAG;4BACX,OAAO;yBACR,CAAC,CAAC;qBACJ;oBAED,8BAA8B;oBAC9B,OAAO,IAAI,QAAQ,CAAC,iBAAO,EAAE;wBAC3B,MAAM,EAAE,GAAG;wBACX,OAAO,kCACF,OAAO,KACV,cAAc,EAAE,0BAA0B,GAC3C;qBACF,CAAC,CAAC;iBACJ;gBAED,KAAK,KAAK,CAAC,CAAC;oBACV,0BAA0B;oBAC1B,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAC7C,MAAM,EACN,GAAG,CAAC,gBAAO,CAAC,YAAY,CAAC,CAC1B,CAAC;oBAEF,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;iBACvE;gBAED,KAAK,MAAM,CAAC,CAAC;oBACX,2DAA2D;oBAC3D,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAC;yBACvB,MAAM,CAAC;wBACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;wBACvB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;qBAC1B,CAAC;yBACD,KAAK,CAAC;wBACL,IAAI,EAAE,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAS,CAAC,IAAI,CAAC;wBAC7C,MAAM,EAAE,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAS,CAAC,MAAM,CAAC;qBAClD,CAAC,CAAC;oBAEL,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;oBAEnE,IAAI,OAAO,CAAC,MAAM,KAAK,GAAG,EAAE;wBAC1B,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;4BACjD,MAAM,EAAE,OAAO,CAAC,MAAM;4BACtB,OAAO;yBACR,CAAC,CAAC;qBACJ;oBAED,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;wBAChD,MAAM,EAAE,OAAO,CAAC,MAAM;wBACtB,OAAO;qBACR,CAAC,CAAC;iBACJ;aACF;YAED,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QACtD,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;GAKG;AACI,MAAM,KAAK,GAAiB,CAAC,aAAa,EAAE,GAAG,EAAE,IAAI,EAAO,EAAE;IACnE,OAAO,IAAA,eAAY,EACjB,IAAI,qBAAqB,CAAC,aAAa,EAAE,GAAG,kBAC1C,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,IAC1B,IAAI,EACP,CACH,CAAC;AACJ,CAAC,CAAC;AAPW,QAAA,KAAK,SAOhB"}
+{"version":3,"file":"cloudflare.js","sourceRoot":"","sources":["../src/cloudflare.ts"],"names":[],"mappings":";;;AAAA,wEAGyC;AACzC,6CAA6C;AAE7C;;;;;GAKG;AACI,MAAM,KAAK,GAAiB,CAAC,aAAa,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;IAC9D,MAAM,OAAO,GAAG,IAAI,uCAAkB,CACpC,kBAAkB,EAClB,aAAa,EACb,GAAG;QAED;;;;WAIG;QACH,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,IAC1B,IAAI,GAET,CAAC,EACC,OAAO,EAAE,GAAG,EACZ,GAAG,GAIJ,EAAE,EAAE;QACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACzE,MAAM,YAAY,GAChB,GAAG,CAAC,QAAQ,KAAK,GAAG,IAAI,GAAG,CAAC,WAAW,KAAK,YAAY,CAAC;QAE3D,OAAO;YACL,IAAI,EAAE,GAAG,EAAE;gBACT,IAAI,GAAG,CAAC,MAAM,KAAK,KAAK,EAAE;oBACxB,OAAO;wBACL,GAAG;wBACH,GAAG;wBACH,eAAe,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAS,CAAC,UAAU,CAAC;wBAC3D,YAAY;qBACb,CAAC;iBACH;YACH,CAAC;YACD,QAAQ,EAAE,GAAG,EAAE;gBACb,IAAI,GAAG,CAAC,MAAM,KAAK,KAAK,EAAE;oBACxB,OAAO;wBACL,GAAG;wBACH,GAAG;wBACH,YAAY;qBACb,CAAC;iBACH;YACH,CAAC;YACD,GAAG,EAAE,KAAK,IAAI,EAAE;gBACd,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,EAAE;oBACzB,OAAO;wBACL,IAAI,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAS,CAAC,IAAI,CAAW;wBACpD,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAwB;wBAC/C,GAAG;wBACH,YAAY;wBACZ,GAAG;qBACJ,CAAC;iBACH;YACH,CAAC;SACF,CAAC;IACJ,CAAC,EACD,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,EAAY,EAAE;QACtC,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE;YACxB,MAAM;YACN,OAAO;SACR,CAAC,CAAC;IACL,CAAC,CACF,CAAC;IAEF,OAAO,OAAO,CAAC,aAAa,EAAE,CAAC;AACjC,CAAC,CAAC;AAnEW,QAAA,KAAK,SAmEhB"}

package/components/InngestCommHandler.d.ts

@@ -0,0 +1,379 @@
+import type { MaybePromise } from "../helpers/types";
+import type { FunctionConfig, RegisterOptions, RegisterRequest, StepRunResponse } from "../types";
+import type { Inngest } from "./Inngest";
+import type { InngestFunction } from "./InngestFunction";
+/**
+ * A handler for serving Inngest functions. This type should be used
+ * whenever a handler for a new framework is being added to enforce that the
+ * registration process is always the same for the user.
+ *
+ * @example
+ * ```
+ * // my-custom-handler.ts
+ * import { InngestCommHandler, ServeHandler } from "inngest";
+ *
+ * export const serve: ServeHandler = (nameOrInngest, fns, opts) => {
+ *   const handler = new InngestCommHandler(
+ *     "my-custom-handler",
+ *     nameOrInngest,
+ *     fns,
+ *     opts,
+ *     () => { ... },
+ *     () => { ... }
+ *   );
+ *
+ *   return handler.createHandler();
+ * };
+ * ```
+ *
+ * @public
+ */
+export declare type ServeHandler = (
+/**
+ * The name of this app, used to scope and group Inngest functions, or
+ * the `Inngest` instance used to declare all functions.
+ */
+nameOrInngest: string | Inngest<any>, 
+/**
+ * An array of the functions to serve and register with Inngest.
+ */
+functions: InngestFunction<any>[], 
+/**
+ * A set of options to further configure the registration of Inngest
+ * functions.
+ */
+opts?: RegisterOptions) => any;
+/**
+ * `InngestCommHandler` is a class for handling incoming requests from Inngest (or
+ * Inngest's tooling such as the dev server or CLI) and taking appropriate
+ * action for any served functions.
+ *
+ * All handlers (Next.js, RedwoodJS, Remix, Deno Fresh, etc) are created using
+ * this class; the exposed `serve` function will - most commonly - create an
+ * instance of `InngestCommHandler` and then return `instance.createHandler()`.
+ *
+ * Two critical parameters required are the `handler` and the `transformRes`
+ * function. See individual parameter details for more information, or see the
+ * source code for an existing handler, e.g.
+ * {@link https://github.com/inngest/inngest-js/blob/main/src/next.ts}
+ *
+ * @example
+ * ```
+ * // my-custom-handler.ts
+ * import { InngestCommHandler, ServeHandler } from "inngest";
+ *
+ * export const serve: ServeHandler = (nameOrInngest, fns, opts) => {
+ *   const handler = new InngestCommHandler(
+ *     "my-custom-handler",
+ *     nameOrInngest,
+ *     fns,
+ *     opts,
+ *     () => { ... },
+ *     () => { ... }
+ *   );
+ *
+ *   return handler.createHandler();
+ * };
+ * ```
+ *
+ * @public
+ */
+export declare class InngestCommHandler<H extends Handler, TransformedRes> {
+    /**
+     * The name of this serve handler, e.g. `"My App"`. It's recommended that this
+     * value represents the overarching app/service that this set of functions is
+     * being served from.
+     */
+    readonly name: string;
+    /**
+     * The handler specified during instantiation of the class.
+     */
+    readonly handler: H;
+    /**
+     * The response transformer specified during instantiation of the class.
+     */
+    readonly transformRes: (res: ActionResponse, ...args: Parameters<H>) => TransformedRes;
+    /**
+     * The URL of the Inngest function registration endpoint.
+     */
+    private readonly inngestRegisterUrl;
+    /**
+     * The name of the framework this handler is designed for. Should be
+     * lowercase, alphanumeric characters inclusive of `-` and `/`. This should
+     * never be defined by the user; a {@link ServeHandler} should abstract this.
+     */
+    protected readonly frameworkName: string;
+    /**
+     * The signing key used to validate requests from Inngest. This is
+     * intentionally mutatble so that we can pick up the signing key from the
+     * environment during execution if needed.
+     */
+    protected signingKey: string | undefined;
+    /**
+     * A property that can be set to indicate whether or not we believe we are in
+     * production mode.
+     *
+     * Should be set every time a request is received.
+     */
+    protected _isProd: boolean;
+    /**
+     * A set of headers sent back with every request. Usually includes generic
+     * functionality such as `"Content-Type"`, alongside informational headers
+     * such as Inngest SDK version.
+     */
+    private readonly headers;
+    /**
+     * The localized `fetch` implementation used by this handler.
+     */
+    private readonly fetch;
+    /**
+     * Whether we should show the SDK Landing Page.
+     *
+     * This purposefully does not take in to account any environment variables, as
+     * accessing them safely is platform-specific.
+     */
+    protected readonly showLandingPage: boolean | undefined;
+    /**
+     * The host used to access the Inngest serve endpoint, e.g.:
+     *
+     *     "https://myapp.com"
+     *
+     * By default, the library will try to infer this using request details such
+     * as the "Host" header and request path, but sometimes this isn't possible
+     * (e.g. when running in a more controlled environments such as AWS Lambda or
+     * when dealing with proxies/rediects).
+     *
+     * Provide the custom hostname here to ensure that the path is reported
+     * correctly when registering functions with Inngest.
+     *
+     * To also provide a custom path, use `servePath`.
+     */
+    protected readonly serveHost: string | undefined;
+    /**
+     * The path to the Inngest serve endpoint. e.g.:
+     *
+     *     "/some/long/path/to/inngest/endpoint"
+     *
+     * By default, the library will try to infer this using request details such
+     * as the "Host" header and request path, but sometimes this isn't possible
+     * (e.g. when running in a more controlled environments such as AWS Lambda or
+     * when dealing with proxies/rediects).
+     *
+     * Provide the custom path (excluding the hostname) here to ensure that the
+     * path is reported correctly when registering functions with Inngest.
+     *
+     * To also provide a custom hostname, use `serveHost`.
+     */
+    protected readonly servePath: string | undefined;
+    /**
+     * A private collection of functions that are being served. This map is used
+     * to find and register functions when interacting with Inngest Cloud.
+     */
+    private readonly fns;
+    constructor(
+    /**
+     * The name of the framework this handler is designed for. Should be
+     * lowercase, alphanumeric characters inclusive of `-` and `/`.
+     *
+     * This should never be defined by the user; a {@link ServeHandler} should
+     * abstract this.
+     */
+    frameworkName: string, 
+    /**
+     * The name of this serve handler, e.g. `"My App"`. It's recommended that this
+     * value represents the overarching app/service that this set of functions is
+     * being served from.
+     *
+     * This can also be an `Inngest` client, in which case the name given when
+     * instantiating the client is used. This is useful if you're sending and
+     * receiving events from the same service, as you can reuse a single
+     * definition of Inngest.
+     */
+    appNameOrInngest: string | Inngest<any>, 
+    /**
+     * An array of the functions to serve and register with Inngest.
+     */
+    functions: InngestFunction<any>[], { inngestRegisterUrl, fetch, landingPage, signingKey, serveHost, servePath, }: RegisterOptions | undefined, 
+    /**
+     * The `handler` is the function your framework requires to handle a
+     * request. For example, this is most commonly a function that is given a
+     * `Request` and must return a `Response`.
+     *
+     * The handler must map out any incoming parameters, then return a
+     * strictly-typed object to assess what kind of request is being made,
+     * collecting any relevant data as we go.
+     *
+     * @example
+     * ```
+     * return {
+     *   register: () => { ... },
+     *   run: () => { ... },
+     *   view: () => { ... }
+     * };
+     * ```
+     *
+     * Every key must be specified and must be a function that either returns
+     * a strictly-typed payload or `undefined` if the request is not for that
+     * purpose.
+     *
+     * This gives handlers freedom to choose how their platform of choice will
+     * trigger differing actions, whilst also ensuring all required information
+     * is given for each request type.
+     *
+     * See any existing handler for a full example.
+     *
+     * This should never be defined by the user; a {@link ServeHandler} should
+     * abstract this.
+     */
+    handler: H, 
+    /**
+     * The `transformRes` function receives the output of the Inngest SDK and
+     * can decide how to package up that information to appropriately return the
+     * information to Inngest.
+     *
+     * Mostly, this is taking the given parameters and returning a new
+     * `Response`.
+     *
+     * The function is passed an {@link ActionResponse} (an object containing a
+     * `status` code, a `headers` object, and a stringified `body`), as well as
+     * every parameter passed to the given `handler` function. This ensures you
+     * can appropriately handle the response, including use of any required
+     * parameters such as `res` in Express-/Connect-like frameworks.
+     *
+     * This should never be defined by the user; a {@link ServeHandler} should
+     * abstract this.
+     */
+    transformRes: (actionRes: ActionResponse, ...args: Parameters<H>) => TransformedRes);
+    private get hashedSigningKey();
+    /**
+     * `createHandler` should be used to return a type-equivalent version of the
+     * `handler` specified during instantiation.
+     *
+     * @example
+     * ```
+     * // my-custom-handler.ts
+     * import { InngestCommHandler, ServeHandler } from "inngest";
+     *
+     * export const serve: ServeHandler = (nameOrInngest, fns, opts) => {
+     *   const handler = new InngestCommHandler(
+     *     "my-custom-handler",
+     *     nameOrInngest,
+     *     fns,
+     *     opts,
+     *     () => { ... },
+     *     () => { ... }
+     *   );
+     *
+     *   return handler.createHandler();
+     * };
+     * ```
+     */
+    createHandler(): (...args: Parameters<H>) => Promise<TransformedRes>;
+    /**
+     * Given a set of functions to check if an action is available from the
+     * instance's handler, enact any action that is found.
+     *
+     * This method can fetch varying payloads of data, but ultimately is the place
+     * where _decisions_ are made regarding functionality.
+     *
+     * For example, if we find that we should be viewing the UI, this function
+     * will decide whether the UI should be visible based on the payload it has
+     * found (e.g. env vars, options, etc).
+     */
+    private handleAction;
+    protected runStep(functionId: string, stepId: string, data: any): Promise<StepRunResponse>;
+    protected configs(url: URL): FunctionConfig[];
+    /**
+     * Returns an SDK header split in to three parts so that they can be used for
+     * different purposes.
+     *
+     * To use the entire string, run `this.sdkHeader.join("")`.
+     */
+    protected get sdkHeader(): [
+        prefix: string,
+        version: RegisterRequest["sdk"],
+        suffix: string
+    ];
+    /**
+     * Return an Inngest serve endpoint URL given a potential `path` and `host`.
+     *
+     * Will automatically use the `serveHost` and `servePath` if they have been
+     * set when registering.
+     */
+    protected reqUrl(url: URL): URL;
+    protected registerBody(url: URL): RegisterRequest;
+    protected register(url: URL, devServerHost: string | undefined): Promise<{
+        status: number;
+        message: string;
+    }>;
+    private get isProd();
+    private upsertSigningKeyFromEnv;
+    protected shouldShowLandingPage(strEnvVar: string | undefined): boolean;
+    protected validateSignature(): boolean;
+    protected signResponse(): string;
+}
+/**
+ * The broad definition of a handler passed when instantiating an
+ * {@link InngestCommHandler} instance.
+ */
+declare type Handler = (...args: any[]) => {
+    [K in Extract<HandlerAction, {
+        action: "run" | "register" | "view";
+    }>["action"]]: () => MaybePromise<Omit<Extract<HandlerAction, {
+        action: K;
+    }>, "action"> | undefined>;
+};
+/**
+ * The response from the Inngest SDK before it is transformed in to a
+ * framework-compatible response by an {@link InngestCommHandler} instance.
+ */
+interface ActionResponse {
+    /**
+     * The HTTP status code to return.
+     */
+    status: number;
+    /**
+     * The headers to return in the response.
+     */
+    headers: Record<string, string>;
+    /**
+     * A stringified body to return.
+     */
+    body: string;
+}
+/**
+ * A set of actions the SDK is aware of, including any payloads they require
+ * when requesting them.
+ */
+declare type HandlerAction = {
+    action: "error";
+    data: Record<string, string>;
+    env: Record<string, string | undefined>;
+    isProduction: boolean;
+    url: URL;
+} | {
+    action: "view";
+    env: Record<string, string | undefined>;
+    url: URL;
+    isIntrospection: boolean;
+    isProduction: boolean;
+} | {
+    action: "register";
+    env: Record<string, string | undefined>;
+    url: URL;
+    isProduction: boolean;
+} | {
+    action: "run";
+    fnId: string;
+    data: Record<string, any>;
+    env: Record<string, string | undefined>;
+    isProduction: boolean;
+    url: URL;
+} | {
+    action: "bad-method";
+    env: Record<string, string | undefined>;
+    isProduction: boolean;
+    url: URL;
+};
+export {};
+//# sourceMappingURL=InngestCommHandler.d.ts.map

package/components/InngestCommHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InngestCommHandler.d.ts","sourceRoot":"","sources":["../../src/components/InngestCommHandler.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD,OAAO,KAAK,EACV,cAAc,EAEd,eAAe,EACf,eAAe,EACf,eAAe,EAChB,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,oBAAY,YAAY,GAAG;AACzB;;;GAGG;AACH,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;AAEpC;;GAEG;AACH,SAAS,EAAE,eAAe,CAAC,GAAG,CAAC,EAAE;AAEjC;;;GAGG;AACH,IAAI,CAAC,EAAE,eAAe,KACnB,GAAG,CAAC;AAgBT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,kBAAkB,CAAC,CAAC,SAAS,OAAO,EAAE,cAAc;IAC/D;;;;OAIG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SAAgB,OAAO,EAAE,CAAC,CAAC;IAE3B;;OAEG;IACH,SAAgB,YAAY,EAAE,CAC5B,GAAG,EAAE,cAAc,EACnB,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KACnB,cAAc,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAM;IAEzC;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAEzC;;;;OAIG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,SAAS,CAAC,OAAO,UAAS;IAE1B;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IAEjD;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAE/B;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,OAAO,GAAG,SAAS,CAAC;IAExD;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAEjD;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAEjD;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,GAAG,CAA4C;;IAG9D;;;;;;OAMG;IACH,aAAa,EAAE,MAAM;IAErB;;;;;;;;;OASG;IACH,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAEvC;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC,GAAG,CAAC,EAAE,EACjC,EACE,kBAAkB,EAClB,KAAK,EACL,WAAW,EACX,UAAU,EACV,SAAS,EACT,SAAS,GACV,6BAAsB;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,OAAO,EAAE,CAAC;IAEV;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,EAAE,CACZ,SAAS,EAAE,cAAc,EACzB,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KACnB,cAAc;IAiDrB,OAAO,KAAK,gBAAgB,GAW3B;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,aAAa,IAAI,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,cAAc,CAAC;IAiB3E;;;;;;;;;;OAUG;YACW,YAAY;cA8GV,OAAO,CACrB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,GACR,OAAO,CAAC,eAAe,CAAC;IA2C3B,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,cAAc,EAAE;IAI7C;;;;;OAKG;IACH,SAAS,KAAK,SAAS,IAAI;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC;QAC/B,MAAM,EAAE,MAAM;KACf,CAEA;IAED;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;IAe/B,SAAS,CAAC,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,eAAe;cAgBjC,QAAQ,CACtB,GAAG,EAAE,GAAG,EACR,aAAa,EAAE,MAAM,GAAG,SAAS,GAChC,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAiE/C,OAAO,KAAK,MAAM,GAEjB;IAED,OAAO,CAAC,uBAAuB;IAM/B,SAAS,CAAC,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO;IAIvE,SAAS,CAAC,iBAAiB,IAAI,OAAO;IAItC,SAAS,CAAC,YAAY,IAAI,MAAM;CAGjC;AAED;;;GAGG;AACH,aAAK,OAAO,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK;KAChC,CAAC,IAAI,OAAO,CACX,aAAa,EACb;QAAE,MAAM,EAAE,KAAK,GAAG,UAAU,GAAG,MAAM,CAAA;KAAE,CACxC,CAAC,QAAQ,CAAC,GAAG,MAAM,YAAY,CAC9B,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE;QAAE,MAAM,EAAE,CAAC,CAAA;KAAE,CAAC,EAAE,QAAQ,CAAC,GAAG,SAAS,CAClE;CACF,CAAC;AAEF;;;GAGG;AACH,UAAU,cAAc;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,aAAK,aAAa,GACd;IACE,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IACxC,YAAY,EAAE,OAAO,CAAC;IACtB,GAAG,EAAE,GAAG,CAAC;CACV,GACD;IACE,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IACxC,GAAG,EAAE,GAAG,CAAC;IACT,eAAe,EAAE,OAAO,CAAC;IACzB,YAAY,EAAE,OAAO,CAAC;CACvB,GACD;IACE,MAAM,EAAE,UAAU,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IACxC,GAAG,EAAE,GAAG,CAAC;IACT,YAAY,EAAE,OAAO,CAAC;CACvB,GACD;IACE,MAAM,EAAE,KAAK,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1B,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IACxC,YAAY,EAAE,OAAO,CAAC;IACtB,GAAG,EAAE,GAAG,CAAC;CACV,GACD;IACE,MAAM,EAAE,YAAY,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IACxC,YAAY,EAAE,OAAO,CAAC;IACtB,GAAG,EAAE,GAAG,CAAC;CACV,CAAC"}