inngest 0.4.0-beta.4 → 0.4.0-beta.6

package/README.md

@@ -40,3 +40,16 @@ const events = ["+12125551234", "+13135555678"].map(phoneNumber => ({
 }});
 await inngest.send(events);
 ```
+
+## Contributing
+
+Clone the repository, then:
+
+```sh
+yarn # install dependencies
+yarn dev # build/lint/test
+```
+
+We use [Volta](https://volta.sh/) to manage Node/Yarn versions.
+
+When making a pull request, make sure to commit the changed `etc/inngest.api.md` file; this is a generated types/docs file that will highlight changes to the exposed API.

package/dist/components/Inngest.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="node" />
-import * as InngestT from "../types";
+import { ClientOptions, EventPayload, FunctionOptions, StepFn } from "../types";
 import { InngestFunction } from "./InngestFunction";
 /**
  * A client used to interact with the Inngest API by sending or reacting to
@@ -8,8 +7,7 @@ import { InngestFunction } from "./InngestFunction";
  * To provide event typing, make sure to pass in your generated event types as
  * the first generic.
  *
- * @example
- *
+ * ```ts
  * const inngest = new Inngest<Events>("My App", process.env.INNGEST_API_KEY);
  *
  * // or to provide custom events too
@@ -23,8 +21,11 @@ import { InngestFunction } from "./InngestFunction";
  *     };
  *   }
  * >("My App", process.env.INNGEST_API_KEY);
+ * ```
+ *
+ * @public
  */
-export declare class Inngest<Events extends Record<string, InngestT.EventPayload>> {
+export declare class Inngest<Events extends Record<string, EventPayload>> {
     #private;
     /**
      * The name of this instance, most commonly the name of the application it
@@ -40,13 +41,13 @@ export declare class Inngest<Events extends Record<string, InngestT.EventPayload
      */
     readonly inngestBaseUrl: URL;
     /**
-     * The URL of the Inngest Cloud API.
+     * The absolute URL of the Inngest Cloud API.
      */
     private readonly inngestApiUrl;
     /**
      * An Axios instance used for communicating with Inngest Cloud.
      *
-     * @link https://npm.im/axios
+     * {@link https://npm.im/axios}
      */
     private readonly client;
     /**
@@ -56,8 +57,7 @@ export declare class Inngest<Events extends Record<string, InngestT.EventPayload
      * To provide event typing, make sure to pass in your generated event types as
      * the first generic.
      *
-     * @example
-     *
+     * ```ts
      * const inngest = new Inngest<Events>("My App", process.env.INNGEST_API_KEY);
      *
      * // or to provide custom events too
@@ -71,6 +71,7 @@ export declare class Inngest<Events extends Record<string, InngestT.EventPayload
      *     };
      *   }
      * >("My App", process.env.INNGEST_API_KEY);
+     * ```
      */
     constructor(
     /**
@@ -81,7 +82,7 @@ export declare class Inngest<Events extends Record<string, InngestT.EventPayload
     /**
      * Inngest event key, used to send events to Inngest Cloud.
      */
-    eventKey: string, { inngestBaseUrl }?: InngestT.ClientOptions);
+    eventKey: string, { inngestBaseUrl }?: ClientOptions);
     /**
      * Send one or many events to Inngest. Takes a known event from this Inngest
      * instance based on the given `name`.
@@ -93,25 +94,25 @@ export declare class Inngest<Events extends Record<string, InngestT.EventPayload
      * generated), make sure to add it when creating your Inngest instance, like
      * so:
      *
-     * @example
-     *
+     * ```ts
      * const inngest = new Inngest<Events & {
      *   "my/event": {
      *     name: "my/event";
      *     data: { bar: string; };
      *   }
      * }>("My App", "API_KEY");
+     * ```
      */
     send<Event extends keyof Events>(name: Event, payload: Omit<Events[Event], "name"> | Omit<Events[Event], "name">[]): Promise<void>;
     /**
      * Given an event to listen to, run the given function when that event is
      * seen.
      */
-    createFunction<Event extends keyof Events, Fn extends InngestT.StepFn<Events[Event], string, "step">>(
+    createFunction<Event extends keyof Events, Name extends string, Fn extends StepFn<Events[Event], Name, "step">>(
     /**
      * The name of this function as it will appear in the Inngst Cloud UI.
      */
-    name: string, 
+    name: Name, 
     /**
      * The event to listen for.
      */
@@ -120,11 +121,15 @@ export declare class Inngest<Events extends Record<string, InngestT.EventPayload
      * The function to run when the event is received.
      */
     fn: Fn): InngestFunction<Events>;
-    createFunction<Event extends keyof Events, Fn extends InngestT.StepFn<Events[Event], string, "step">>(
+    /**
+     * Given an event to listen to, run the given function when that event is
+     * seen.
+     */
+    createFunction<Event extends keyof Events, Opts extends FunctionOptions, Fn extends StepFn<Events[Event], Opts extends FunctionOptions ? Opts["name"] : string, "step">>(
     /**
      * Options for this Inngest function - useful for defining a custom ID.
      */
-    opts: InngestT.FunctionOptions, 
+    opts: Opts, 
     /**
      * The event to listen for.
      */
@@ -133,5 +138,57 @@ export declare class Inngest<Events extends Record<string, InngestT.EventPayload
      * The function to run when the event is received.
      */
     fn: Fn): InngestFunction<Events>;
+    /**
+     * Run the given `fn` at a specified time or on a schedule given by `cron`.
+     */
+    createScheduledFunction<Name extends string>(
+    /**
+     * The name of this function as it will appear in the Inngest Cloud UI.
+     */
+    name: Name, 
+    /**
+     * The cron definition to schedule your function.
+     *
+     * @example
+     *
+     * "0 0 0 1 1 * 1" // At 12:00 AM, on day 1 of the month, only in January, only in 0001
+     * "0 0 0 1 1 * 1,2" // At 12:00 AM, on day 1 of the month, only in January, only in 0001 and 0002
+     * "0 0 0 1 1 * 1,2,3" // At 12:00 AM, on day 1 of the month, only in January, only in 0001, 0002, and 0003
+     * "0 0 0 1 * * 1/4" // At 12:00 AM, on day 1 of the month, every 4 years
+     * "0 0 0 * * 0 1-4" // At 12:00 AM, only on Sunday, 0001 through 0004
+     * "0 0 0 * * * 2/4" // At 12:00 AM, every 4 years, 0002 through 9999
+     * "0 0 * * * * *" // Every hour
+     */
+    cron: string, 
+    /**
+     * The function to run.
+     */
+    fn: StepFn<null, Name, "step">): InngestFunction<Events>;
+    /**
+     * Run the given `fn` at a specified time or on a schedule given by `cron`.
+     */
+    createScheduledFunction<Opts extends FunctionOptions>(
+    /**
+     * Options for this Inngest function - useful for defining a custom ID.
+     */
+    opts: Opts, 
+    /**
+     * The cron definition to schedule your function.
+     *
+     * @example
+     *
+     * "0 0 0 1 1 * 1" // At 12:00 AM, on day 1 of the month, only in January, only in 0001
+     * "0 0 0 1 1 * 1,2" // At 12:00 AM, on day 1 of the month, only in January, only in 0001 and 0002
+     * "0 0 0 1 1 * 1,2,3" // At 12:00 AM, on day 1 of the month, only in January, only in 0001, 0002, and 0003
+     * "0 0 0 1 * * 1/4" // At 12:00 AM, on day 1 of the month, every 4 years
+     * "0 0 0 * * 0 1-4" // At 12:00 AM, only on Sunday, 0001 through 0004
+     * "0 0 0 * * * 2/4" // At 12:00 AM, every 4 years, 0002 through 9999
+     * "0 0 * * * * *" // Every hour
+     */
+    cron: string, 
+    /**
+     * The function to run.
+     */
+    fn: StepFn<null, Opts extends FunctionOptions ? Opts["name"] : string, "step">): InngestFunction<Events>;
 }
 //# sourceMappingURL=Inngest.d.ts.map

package/dist/components/Inngest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Inngest.d.ts","sourceRoot":"","sources":["../../src/components/Inngest.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AAErC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGpD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,OAAO,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC;;IACvE;;;OAGG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAElC;;OAEG;IACH,SAAgB,cAAc,EAAE,GAAG,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAM;IAEpC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IAEvC;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAED;;;OAGG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,EAChB,EAAE,cAAkC,EAAE,GAAE,QAAQ,CAAC,aAAkB;IA+DrE;;;;;;;;;;;;;;;;;;;OAmBG;IACU,IAAI,CAAC,KAAK,SAAS,MAAM,MAAM,EAC1C,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,EAAE,GACnE,OAAO,CAAC,IAAI,CAAC;IAahB;;;OAGG;IACI,cAAc,CACnB,KAAK,SAAS,MAAM,MAAM,EAC1B,EAAE,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC;IAEzD;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,KAAK,EAAE,KAAK;IAEZ;;OAEG;IACH,EAAE,EAAE,EAAE,GACL,eAAe,CAAC,MAAM,CAAC;IACnB,cAAc,CACnB,KAAK,SAAS,MAAM,MAAM,EAC1B,EAAE,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC;IAEzD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC,eAAe;IAE9B;;OAEG;IACH,KAAK,EAAE,KAAK;IAEZ;;OAEG;IACH,EAAE,EAAE,EAAE,GACL,eAAe,CAAC,MAAM,CAAC;CAiB3B"}
+{"version":3,"file":"Inngest.d.ts","sourceRoot":"","sources":["../../src/components/Inngest.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEhF,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGpD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,OAAO,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;;IAC9D;;;OAGG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAElC;;OAEG;IACH,SAAgB,cAAc,EAAE,GAAG,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAM;IAEpC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IAEvC;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAED;;;OAGG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,EAChB,EAAE,cAAkC,EAAE,GAAE,aAAkB;IA+D5D;;;;;;;;;;;;;;;;;;;OAmBG;IACU,IAAI,CAAC,KAAK,SAAS,MAAM,MAAM,EAC1C,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,EAAE,GACnE,OAAO,CAAC,IAAI,CAAC;IAahB;;;OAGG;IACI,cAAc,CACnB,KAAK,SAAS,MAAM,MAAM,EAC1B,IAAI,SAAS,MAAM,EACnB,EAAE,SAAS,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC;IAE9C;;OAEG;IACH,IAAI,EAAE,IAAI;IAEV;;OAEG;IACH,KAAK,EAAE,KAAK;IAEZ;;OAEG;IACH,EAAE,EAAE,EAAE,GACL,eAAe,CAAC,MAAM,CAAC;IAC1B;;;OAGG;IACI,cAAc,CACnB,KAAK,SAAS,MAAM,MAAM,EAC1B,IAAI,SAAS,eAAe,EAC5B,EAAE,SAAS,MAAM,CACf,MAAM,CAAC,KAAK,CAAC,EACb,IAAI,SAAS,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,MAAM,EACpD,MAAM,CACP;IAED;;OAEG;IACH,IAAI,EAAE,IAAI;IAEV;;OAEG;IACH,KAAK,EAAE,KAAK;IAEZ;;OAEG;IACH,EAAE,EAAE,EAAE,GACL,eAAe,CAAC,MAAM,CAAC;IAyB1B;;OAEG;IACI,uBAAuB,CAAC,IAAI,SAAS,MAAM;IAChD;;OAEG;IACH,IAAI,EAAE,IAAI;IAEV;;;;;;;;;;;;OAYG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,GAC7B,eAAe,CAAC,MAAM,CAAC;IAC1B;;OAEG;IACI,uBAAuB,CAAC,IAAI,SAAS,eAAe;IACzD;;OAEG;IACH,IAAI,EAAE,IAAI;IAEV;;;;;;;;;;;;OAYG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,EAAE,EAAE,MAAM,CACR,IAAI,EACJ,IAAI,SAAS,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,MAAM,EACpD,MAAM,CACP,GACA,eAAe,CAAC,MAAM,CAAC;CAuB3B"}

package/dist/components/Inngest.js

@@ -21,8 +21,7 @@ const InngestStep_1 = require("./InngestStep");
  * To provide event typing, make sure to pass in your generated event types as
  * the first generic.
  *
- * @example
- *
+ * ```ts
  * const inngest = new Inngest<Events>("My App", process.env.INNGEST_API_KEY);
  *
  * // or to provide custom events too
@@ -36,6 +35,9 @@ const InngestStep_1 = require("./InngestStep");
  *     };
  *   }
  * >("My App", process.env.INNGEST_API_KEY);
+ * ```
+ *
+ * @public
  */
 class Inngest {
     /**
@@ -45,8 +47,7 @@ class Inngest {
      * To provide event typing, make sure to pass in your generated event types as
      * the first generic.
      *
-     * @example
-     *
+     * ```ts
      * const inngest = new Inngest<Events>("My App", process.env.INNGEST_API_KEY);
      *
      * // or to provide custom events too
@@ -60,6 +61,7 @@ class Inngest {
      *     };
      *   }
      * >("My App", process.env.INNGEST_API_KEY);
+     * ```
      */
     constructor(
     /**
@@ -103,14 +105,14 @@ class Inngest {
      * generated), make sure to add it when creating your Inngest instance, like
      * so:
      *
-     * @example
-     *
+     * ```ts
      * const inngest = new Inngest<Events & {
      *   "my/event": {
      *     name: "my/event";
      *     data: { bar: string; };
      *   }
      * }>("My App", "API_KEY");
+     * ```
      */
     async send(name, payload) {
         const response = await this.client.post(this.inngestApiUrl.href, Object.assign(Object.assign({}, payload), { name }));
@@ -119,10 +121,18 @@ class Inngest {
         }
         throw __classPrivateFieldGet(this, _Inngest_instances, "m", _Inngest_getResponseError).call(this, response);
     }
+    /**
+     * Given an event to listen to, run the given function when that event is
+     * seen.
+     */
     createFunction(nameOrOpts, event, fn) {
-        return new InngestFunction_1.InngestFunction(typeof nameOrOpts === "string" ? { name: nameOrOpts } : nameOrOpts, event, {
-            step: new InngestStep_1.InngestStep(fn),
-        });
+        return new InngestFunction_1.InngestFunction(typeof nameOrOpts === "string" ? { name: nameOrOpts } : nameOrOpts, { event: event }, { step: new InngestStep_1.InngestStep(fn) });
+    }
+    /**
+     * Run the given `fn` at a specified time or on a schedule given by `cron`.
+     */
+    createScheduledFunction(nameOrOpts, cron, fn) {
+        return new InngestFunction_1.InngestFunction(typeof nameOrOpts === "string" ? { name: nameOrOpts } : nameOrOpts, { cron }, { step: new InngestStep_1.InngestStep(fn) });
     }
 }
 exports.Inngest = Inngest;

package/dist/components/Inngest.js.map

@@ -1 +1 @@
-{"version":3,"file":"Inngest.js","sourceRoot":"","sources":["../../src/components/Inngest.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA4D;AAE5D,wCAAqC;AACrC,uDAAoD;AACpD,+CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,OAAO;IA6BlB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH;IACE;;;OAGG;IACH,IAAY;IAEZ;;OAEG;IACH,QAAgB,EAChB,EAAE,cAAc,GAAG,iBAAiB,KAA6B,EAAE;;QAEnE,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;SACzE;QAED,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAC;SACH;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,CAAC,KAAK,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAExE,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,MAAM,CAAC;YACzB,OAAO,EAAE,CAAC;YACV,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,YAAY,EAAE,cAAc,iBAAO,EAAE;aACtC;YACD,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI;YAC1B,YAAY,EAAE,CAAC;SAChB,CAAC,CAAC;IACL,CAAC;IAqCD;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,IAAI,CACf,IAAW,EACX,OAAoE;QAEpE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,kCAC1D,OAAO,KACV,IAAI,IACJ,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE;YACnD,OAAO;SACR;QAED,MAAM,uBAAA,IAAI,qDAAkB,MAAtB,IAAI,EAAmB,QAAQ,CAAC,CAAC;IACzC,CAAC;IA4CM,cAAc,CAInB,UAA6C,EAC7C,KAAY,EACZ,EAAM;QAEN,OAAO,IAAI,iCAAe,CACxB,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,EAClE,KAAK,EACL;YACE,IAAI,EAAE,IAAI,yBAAW,CAAC,EAAE,CAAC;SAC1B,CACF,CAAC;IACJ,CAAC;CACF;AA5ND,0BA4NC;mGA9HmB,QAAuB;IACvC,IAAI,YAAY,GAAG,eAAe,CAAC;IACnC,QAAQ,QAAQ,CAAC,MAAM,EAAE;QACvB,KAAK,GAAG;YACN,YAAY,GAAG,qBAAqB,CAAC;YACrC,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,8BAA8B,CAAC;YAC9C,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,WAAW,CAAC;YAC3B,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,qBAAqB,CAAC;YACrC,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAClD,MAAM;QACR,KAAK,GAAG,CAAC;QACT,KAAK,GAAG;YACN,YAAY,GAAG,6BAA6B,CAAC;YAC7C,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,yBAAyB,CAAC;YACzC,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,uBAAuB,CAAC;YACvC,MAAM;KACT;IACD,OAAO,IAAI,KAAK,CAAC,sBAAsB,QAAQ,CAAC,MAAM,IAAI,YAAY,EAAE,CAAC,CAAC;AAC5E,CAAC"}
+{"version":3,"file":"Inngest.js","sourceRoot":"","sources":["../../src/components/Inngest.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA4D;AAE5D,wCAAqC;AACrC,uDAAoD;AACpD,+CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAa,OAAO;IA6BlB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH;IACE;;;OAGG;IACH,IAAY;IAEZ;;OAEG;IACH,QAAgB,EAChB,EAAE,cAAc,GAAG,iBAAiB,KAAoB,EAAE;;QAE1D,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;SACzE;QAED,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAC;SACH;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,CAAC,KAAK,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAExE,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,MAAM,CAAC;YACzB,OAAO,EAAE,CAAC;YACV,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,YAAY,EAAE,cAAc,iBAAO,EAAE;aACtC;YACD,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI;YAC1B,YAAY,EAAE,CAAC;SAChB,CAAC,CAAC;IACL,CAAC;IAqCD;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,IAAI,CACf,IAAW,EACX,OAAoE;QAEpE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,kCAC1D,OAAO,KACV,IAAI,IACJ,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE;YACnD,OAAO;SACR;QAED,MAAM,uBAAA,IAAI,qDAAkB,MAAtB,IAAI,EAAmB,QAAQ,CAAC,CAAC;IACzC,CAAC;IAsDD;;;OAGG;IACI,cAAc,CAYnB,UAAgB,EAAE,KAAY,EAAE,EAAM;QACtC,OAAO,IAAI,iCAAe,CACxB,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,EAClE,EAAE,KAAK,EAAE,KAAe,EAAE,EAC1B,EAAE,IAAI,EAAE,IAAI,yBAAW,CAAC,EAAE,CAAC,EAAE,CAC9B,CAAC;IACJ,CAAC;IAgED;;OAEG;IACI,uBAAuB,CAC5B,UAAgB,EAChB,IAAY,EACZ,EAQC;QAED,OAAO,IAAI,iCAAe,CACxB,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,EAClE,EAAE,IAAI,EAAE,EACR,EAAE,IAAI,EAAE,IAAI,yBAAW,CAAC,EAAE,CAAC,EAAE,CAC9B,CAAC;IACJ,CAAC;CACF;AAlUD,0BAkUC;mGApOmB,QAAuB;IACvC,IAAI,YAAY,GAAG,eAAe,CAAC;IACnC,QAAQ,QAAQ,CAAC,MAAM,EAAE;QACvB,KAAK,GAAG;YACN,YAAY,GAAG,qBAAqB,CAAC;YACrC,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,8BAA8B,CAAC;YAC9C,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,WAAW,CAAC;YAC3B,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,qBAAqB,CAAC;YACrC,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAClD,MAAM;QACR,KAAK,GAAG,CAAC;QACT,KAAK,GAAG;YACN,YAAY,GAAG,6BAA6B,CAAC;YAC7C,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,yBAAyB,CAAC;YACzC,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,uBAAuB,CAAC;YACvC,MAAM;KACT;IACD,OAAO,IAAI,KAAK,CAAC,sBAAsB,QAAQ,CAAC,MAAM,IAAI,YAAY,EAAE,CAAC,CAAC;AAC5E,CAAC"}

package/dist/components/InngestFunction.d.ts

@@ -1,8 +1,34 @@
-import { EventPayload, FunctionOptions, Steps } from "../types";
+import { EventPayload, FunctionOptions, FunctionTrigger, Steps } from "../types";
+/**
+ * A stateless Inngest function, wrapping up function configuration and any
+ * in-memory steps to run when triggered.
+ *
+ * This function can be "registered" to create a handler that Inngest can
+ * trigger remotely.
+ *
+ * @public
+ */
 export declare class InngestFunction<Events extends Record<string, EventPayload>> {
     #private;
-    constructor(opts: FunctionOptions, trigger: keyof Events, steps: Steps);
+    /**
+     * A stateless Inngest function, wrapping up function configuration and any
+     * in-memory steps to run when triggered.
+     *
+     * This function can be "registered" to create a handler that Inngest can
+     * trigger remotely.
+     */
+    constructor(
+    /**
+     * Options
+     */
+    opts: FunctionOptions, trigger: FunctionTrigger<keyof Events>, steps: Steps);
+    /**
+     * The generated or given ID for this function.
+     */
     get id(): string;
+    /**
+     * The name of this function as it will appear in the Inngest Cloud UI.
+     */
     get name(): string;
     /**
      * Retrieve the Inngest config for this function.

package/dist/components/InngestFunction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InngestFunction.d.ts","sourceRoot":"","sources":["../../src/components/InngestFunction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAkB,eAAe,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEhF,qBAAa,eAAe,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;;gBAK1D,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,MAAM,EAAE,KAAK,EAAE,KAAK;IAMtE,IAAW,EAAE,WAEZ;IAED,IAAW,IAAI,WAEd;IAED;;OAEG;IACH,OAAO,CAAC,SAAS;IAmCjB;;OAEG;IACH,OAAO,CAAC,OAAO;CAsBhB"}
+{"version":3,"file":"InngestFunction.d.ts","sourceRoot":"","sources":["../../src/components/InngestFunction.ts"],"names":[],"mappings":"AACA,OAAO,EACL,YAAY,EAEZ,eAAe,EACf,eAAe,EACf,KAAK,EACN,MAAM,UAAU,CAAC;AAElB;;;;;;;;GAQG;AACH,qBAAa,eAAe,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;;IAKtE;;;;;;OAMG;;IAED;;OAEG;IACH,IAAI,EAAE,eAAe,EACrB,OAAO,EAAE,eAAe,CAAC,MAAM,MAAM,CAAC,EACtC,KAAK,EAAE,KAAK;IAOd;;OAEG;IACH,IAAW,EAAE,WAMZ;IAED;;OAEG;IACH,IAAW,IAAI,WAEd;IAED;;OAEG;IACH,OAAO,CAAC,SAAS;IAmCjB;;OAEG;IACH,OAAO,CAAC,OAAO;CAyBhB"}

package/dist/components/InngestFunction.js

@@ -14,8 +14,28 @@ var _InngestFunction_instances, _InngestFunction_opts, _InngestFunction_trigger,
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InngestFunction = void 0;
 const consts_1 = require("../helpers/consts");
+/**
+ * A stateless Inngest function, wrapping up function configuration and any
+ * in-memory steps to run when triggered.
+ *
+ * This function can be "registered" to create a handler that Inngest can
+ * trigger remotely.
+ *
+ * @public
+ */
 class InngestFunction {
-    constructor(opts, trigger, steps) {
+    /**
+     * A stateless Inngest function, wrapping up function configuration and any
+     * in-memory steps to run when triggered.
+     *
+     * This function can be "registered" to create a handler that Inngest can
+     * trigger remotely.
+     */
+    constructor(
+    /**
+     * Options
+     */
+    opts, trigger, steps) {
         _InngestFunction_instances.add(this);
         _InngestFunction_opts.set(this, void 0);
         _InngestFunction_trigger.set(this, void 0);
@@ -24,9 +44,18 @@ class InngestFunction {
         __classPrivateFieldSet(this, _InngestFunction_trigger, trigger, "f");
         __classPrivateFieldSet(this, _InngestFunction_steps, steps || {}, "f");
     }
+    /**
+     * The generated or given ID for this function.
+     */
     get id() {
-        return __classPrivateFieldGet(this, _InngestFunction_opts, "f").id || __classPrivateFieldGet(this, _InngestFunction_instances, "m", _InngestFunction_generateId).call(this);
+        if (!__classPrivateFieldGet(this, _InngestFunction_opts, "f").id) {
+            __classPrivateFieldGet(this, _InngestFunction_opts, "f").id = __classPrivateFieldGet(this, _InngestFunction_instances, "m", _InngestFunction_generateId).call(this);
+        }
+        return __classPrivateFieldGet(this, _InngestFunction_opts, "f").id;
     }
+    /**
+     * The name of this function as it will appear in the Inngest Cloud UI.
+     */
     get name() {
         return __classPrivateFieldGet(this, _InngestFunction_opts, "f").name;
     }
@@ -43,7 +72,7 @@ class InngestFunction {
         return {
             id: this.id,
             name: this.name,
-            triggers: [{ event: __classPrivateFieldGet(this, _InngestFunction_trigger, "f") }],
+            triggers: [__classPrivateFieldGet(this, _InngestFunction_trigger, "f")],
             steps: Object.keys(__classPrivateFieldGet(this, _InngestFunction_steps, "f")).reduce((acc, stepId) => {
                 const url = new URL(baseUrl.href);
                 url.searchParams.set(consts_1.fnIdParam, __classPrivateFieldGet(this, _InngestFunction_opts, "f").name);

package/dist/components/InngestFunction.js.map

@@ -1 +1 @@
-{"version":3,"file":"InngestFunction.js","sourceRoot":"","sources":["../../src/components/InngestFunction.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,8CAA2D;AAG3D,MAAa,eAAe;IAK1B,YAAY,IAAqB,EAAE,OAAqB,EAAE,KAAY;;QAJtE,wCAAgC;QAChC,2CAAgC;QAChC,yCAAuB;QAGrB,uBAAA,IAAI,yBAAS,IAAI,MAAA,CAAC;QAClB,uBAAA,IAAI,4BAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,0BAAU,KAAK,IAAI,EAAE,MAAA,CAAC;IAC5B,CAAC;IAED,IAAW,EAAE;QACX,OAAO,uBAAA,IAAI,6BAAM,CAAC,EAAE,IAAI,uBAAA,IAAI,+DAAY,MAAhB,IAAI,CAAc,CAAC;IAC7C,CAAC;IAED,IAAW,IAAI;QACb,OAAO,uBAAA,IAAI,6BAAM,CAAC,IAAI,CAAC;IACzB,CAAC;IAED;;OAEG;IACK,SAAS;IACf;;;;OAIG;IACH,OAAY;QAEZ,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,uBAAA,IAAI,gCAAmB,EAAE,CAAC;YAC9C,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,uBAAA,IAAI,8BAAO,CAAC,CAAC,MAAM,CACpC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;gBACd,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAClC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAS,EAAE,uBAAA,IAAI,6BAAM,CAAC,IAAI,CAAC,CAAC;gBACjD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,oBAAW,EAAE,MAAM,CAAC,CAAC;gBAE1C,uCACK,GAAG,KACN,CAAC,MAAM,CAAC,EAAE;wBACR,EAAE,EAAE,MAAM;wBACV,IAAI,EAAE,MAAM;wBACZ,OAAO,EAAE;4BACP,IAAI,EAAE,MAAM;4BACZ,GAAG,EAAE,GAAG,CAAC,IAAI;yBACd;qBACF,IACD;YACJ,CAAC,EACD,EAAE,CACH;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,OAAO,CAAC,MAAc,EAAE,IAAS;QACvC,MAAM,IAAI,GAAG,uBAAA,IAAI,8BAAO,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,IAAI,KAAK,CACb,gCAAgC,MAAM,kBAAkB,IAAI,CAAC,IAAI,GAAG,CACrE,CAAC;SACH;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;CAaF;AAlFD,0CAkFC;;IAVG,MAAM,IAAI,GAAG,GAAG,CAAC;IAEjB,OAAO,uBAAA,IAAI,6BAAM,CAAC,IAAI;SACnB,WAAW,EAAE;SACb,UAAU,CAAC,cAAc,EAAE,IAAI,CAAC;SAChC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;SACvB,KAAK,CAAC,IAAI,CAAC;SACX,MAAM,CAAC,OAAO,CAAC;SACf,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC"}
+{"version":3,"file":"InngestFunction.js","sourceRoot":"","sources":["../../src/components/InngestFunction.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,8CAA2D;AAS3D;;;;;;;;GAQG;AACH,MAAa,eAAe;IAK1B;;;;;;OAMG;IACH;IACE;;OAEG;IACH,IAAqB,EACrB,OAAsC,EACtC,KAAY;;QAjBd,wCAAgC;QAChC,2CAAiD;QACjD,yCAAuB;QAiBrB,uBAAA,IAAI,yBAAS,IAAI,MAAA,CAAC;QAClB,uBAAA,IAAI,4BAAY,OAAO,MAAA,CAAC;QACxB,uBAAA,IAAI,0BAAU,KAAK,IAAI,EAAE,MAAA,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAW,EAAE;QACX,IAAI,CAAC,uBAAA,IAAI,6BAAM,CAAC,EAAE,EAAE;YAClB,uBAAA,IAAI,6BAAM,CAAC,EAAE,GAAG,uBAAA,IAAI,+DAAY,MAAhB,IAAI,CAAc,CAAC;SACpC;QAED,OAAO,uBAAA,IAAI,6BAAM,CAAC,EAAE,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,uBAAA,IAAI,6BAAM,CAAC,IAAI,CAAC;IACzB,CAAC;IAED;;OAEG;IACK,SAAS;IACf;;;;OAIG;IACH,OAAY;QAEZ,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,CAAC,uBAAA,IAAI,gCAA4B,CAAC;YAC5C,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,uBAAA,IAAI,8BAAO,CAAC,CAAC,MAAM,CACpC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;gBACd,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAClC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAS,EAAE,uBAAA,IAAI,6BAAM,CAAC,IAAI,CAAC,CAAC;gBACjD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,oBAAW,EAAE,MAAM,CAAC,CAAC;gBAE1C,uCACK,GAAG,KACN,CAAC,MAAM,CAAC,EAAE;wBACR,EAAE,EAAE,MAAM;wBACV,IAAI,EAAE,MAAM;wBACZ,OAAO,EAAE;4BACP,IAAI,EAAE,MAAM;4BACZ,GAAG,EAAE,GAAG,CAAC,IAAI;yBACd;qBACF,IACD;YACJ,CAAC,EACD,EAAE,CACH;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,OAAO,CAAC,MAAc,EAAE,IAAS;QACvC,MAAM,IAAI,GAAG,uBAAA,IAAI,8BAAO,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,IAAI,KAAK,CACb,gCAAgC,MAAM,kBAAkB,IAAI,CAAC,IAAI,GAAG,CACrE,CAAC;SACH;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;CAgBF;AA7GD,0CA6GC;;IAVG,MAAM,IAAI,GAAG,GAAG,CAAC;IAEjB,OAAO,uBAAA,IAAI,6BAAM,CAAC,IAAI;SACnB,WAAW,EAAE;SACb,UAAU,CAAC,cAAc,EAAE,IAAI,CAAC;SAChC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC;SACvB,KAAK,CAAC,IAAI,CAAC;SACX,MAAM,CAAC,OAAO,CAAC;SACf,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC"}

package/dist/components/InngestStep.d.ts

@@ -6,6 +6,9 @@ export declare class InngestStep<Input extends any[], Output> {
     constructor(fn: (...args: Input) => Output);
     /**
      * Run this step with the given `data`.
+     *
+     * Purposefully return a promise so that it's easier to catch further up the
+     * stack.
      */
     private run;
 }

package/dist/components/InngestStep.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InngestStep.d.ts","sourceRoot":"","sources":["../../src/components/InngestStep.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,WAAW,CAAC,KAAK,SAAS,GAAG,EAAE,EAAE,MAAM;;gBAGtC,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,MAAM;IAI1C;;OAEG;YACW,GAAG;CAGlB"}
+{"version":3,"file":"InngestStep.d.ts","sourceRoot":"","sources":["../../src/components/InngestStep.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,WAAW,CAAC,KAAK,SAAS,GAAG,EAAE,EAAE,MAAM;;gBAGtC,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,MAAM;IAI1C;;;;;OAKG;YAEW,GAAG;CAGlB"}

package/dist/components/InngestStep.js

@@ -23,7 +23,11 @@ class InngestStep {
     }
     /**
      * Run this step with the given `data`.
+     *
+     * Purposefully return a promise so that it's easier to catch further up the
+     * stack.
      */
+    // eslint-disable-next-line @typescript-eslint/require-await
     async run(data) {
         return __classPrivateFieldGet(this, _InngestStep_fn, "f").call(this, data);
     }

package/dist/components/InngestStep.js.map

@@ -1 +1 @@
-{"version":3,"file":"InngestStep.js","sourceRoot":"","sources":["../../src/components/InngestStep.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA;;GAEG;AACH,MAAa,WAAW;IAGtB,YAAY,EAA8B;QAF1C,kCAAuC;QAGrC,uBAAA,IAAI,mBAAO,EAAE,MAAA,CAAC;IAChB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,GAAG,CAAC,IAAS;QACzB,OAAO,uBAAA,IAAI,uBAAI,MAAR,IAAI,EAAK,IAAI,CAAC,CAAC;IACxB,CAAC;CACF;AAbD,kCAaC"}
+{"version":3,"file":"InngestStep.js","sourceRoot":"","sources":["../../src/components/InngestStep.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA;;GAEG;AACH,MAAa,WAAW;IAGtB,YAAY,EAA8B;QAF1C,kCAAuC;QAGrC,uBAAA,IAAI,mBAAO,EAAE,MAAA,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,4DAA4D;IACpD,KAAK,CAAC,GAAG,CAAC,IAAS;QACzB,OAAO,uBAAA,IAAI,uBAAI,MAAR,IAAI,EAAK,IAAI,CAAC,CAAC;IACxB,CAAC;CACF;AAjBD,kCAiBC"}

package/dist/handlers/default.d.ts

@@ -1,11 +1,12 @@
-/// <reference types="node" />
 import { Inngest } from "../components/Inngest";
 import { InngestFunction } from "../components/InngestFunction";
-import { EventPayload, FunctionConfig, RegisterOptions, RegisterPingResponse, StepRunResponse } from "../types";
+import { EventPayload, FunctionConfig, RegisterOptions, StepRunResponse } from "../types";
 /**
  * A handler for registering 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.
+ *
+ * @public
  */
 export declare type RegisterHandler = (
 /**
@@ -27,7 +28,7 @@ signingKey: string, functions: InngestFunction<any>[], opts?: RegisterOptions) =
  * Can either take an `Inngest` instance and a signing key, or can be used to
  * create custom handlers by passing in an `InngestCommHandler`.
  *
- * @link TODO
+ * @public
  */
 export declare const register: <Events extends Record<string, EventPayload>>(...args: [nameOrInngest: string | Inngest<Events>, signingKey: string, functions: InngestFunction<Events>[], opts?: RegisterOptions | undefined] | [commHandler: InngestCommHandler]) => any;
 /**
@@ -46,6 +47,8 @@ export declare const register: <Events extends Record<string, EventPayload>>(...
  * platform
  *
  * This needs to also account for the ability to validate signatures etc.
+ *
+ * @public
  */
 export declare class InngestCommHandler {
     name: string;
@@ -58,7 +61,7 @@ export declare class InngestCommHandler {
     /**
      * An Axios instance used for communicating with Inngest Cloud.
      *
-     * @link https://npm.im/axios
+     * {@link https://npm.im/axios}
      */
     private readonly client;
     /**
@@ -67,11 +70,11 @@ export declare class InngestCommHandler {
      */
     private readonly fns;
     constructor(nameOrInngest: string | Inngest<any>, signingKey: string, functions: InngestFunction<any>[], { inngestRegisterUrl }?: RegisterOptions);
+    private get hashedSigningKey();
     createHandler(): any;
     protected runStep(functionId: string, stepId: string, data: any): Promise<StepRunResponse>;
     protected configs(url: URL): FunctionConfig[];
     protected register(url: URL): Promise<void>;
-    protected pong(url: URL): RegisterPingResponse;
     protected validateSignature(): boolean;
     protected signResponse(): string;
 }

package/dist/handlers/default.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"default.d.ts","sourceRoot":"","sources":["../../src/handlers/default.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEhE,OAAO,EACL,YAAY,EACZ,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,eAAe,EAChB,MAAM,UAAU,CAAC;AAGlB;;;;GAIG;AACH,oBAAY,eAAe,GAAG;AAC5B;;;GAGG;AACH,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;AAEpC;;;;;GAKG;AACH,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,eAAe,CAAC,GAAG,CAAC,EAAE,EACjC,IAAI,CAAC,EAAE,eAAe,KACnB,GAAG,CAAC;AAET;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,4OAkBpB,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,kBAAkB;IACtB,IAAI,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAM;IAEzC,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAa;IACrD,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAEtC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IAEvC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,GAAG,CAA4C;gBAG9D,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,EACpC,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,eAAe,CAAC,GAAG,CAAC,EAAE,EACjC,EAAE,kBAAkB,EAAE,GAAE,eAAoB;IAsCvC,aAAa,IAAI,GAAG;cAgDX,OAAO,CACrB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,GACR,OAAO,CAAC,eAAe,CAAC;IA8B3B,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,cAAc,EAAE;cAI7B,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IA+BjD,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,oBAAoB;IAW9C,SAAS,CAAC,iBAAiB,IAAI,OAAO;IAItC,SAAS,CAAC,YAAY,IAAI,MAAM;CAGjC"}
+{"version":3,"file":"default.d.ts","sourceRoot":"","sources":["../../src/handlers/default.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEhE,OAAO,EACL,YAAY,EACZ,cAAc,EACd,eAAe,EAEf,eAAe,EAChB,MAAM,UAAU,CAAC;AAGlB;;;;;;GAMG;AACH,oBAAY,eAAe,GAAG;AAC5B;;;GAGG;AACH,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;AAEpC;;;;;GAKG;AACH,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,eAAe,CAAC,GAAG,CAAC,EAAE,EACjC,IAAI,CAAC,EAAE,eAAe,KACnB,GAAG,CAAC;AAET;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,4OAoBpB,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,kBAAkB;IACtB,IAAI,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAM;IAEzC,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAa;IACrD,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAEtC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IAEvC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,GAAG,CAA4C;gBAG9D,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,EACpC,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,eAAe,CAAC,GAAG,CAAC,EAAE,EACjC,EAAE,kBAAkB,EAAE,GAAE,eAAoB;IAwC9C,OAAO,KAAK,gBAAgB,GAiB3B;IAEM,aAAa,IAAI,GAAG;cAqDX,OAAO,CACrB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,GACR,OAAO,CAAC,eAAe,CAAC;IAqC3B,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,cAAc,EAAE;cAI7B,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAoCjD,SAAS,CAAC,iBAAiB,IAAI,OAAO;IAItC,SAAS,CAAC,YAAY,IAAI,MAAM;CAGjC"}

package/dist/handlers/default.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InngestCommHandler = exports.register = void 0;
 const axios_1 = __importDefault(require("axios"));
+const crypto_1 = __importDefault(require("crypto"));
 const zod_1 = require("zod");
 const consts_1 = require("../helpers/consts");
 const version_1 = require("../version");
@@ -15,14 +16,16 @@ const version_1 = require("../version");
  * Can either take an `Inngest` instance and a signing key, or can be used to
  * create custom handlers by passing in an `InngestCommHandler`.
  *
- * @link TODO
+ * @public
  */
 const register = (...args) => {
     if (args.length === 1) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
         return args[0].createHandler();
     }
     const [nameOrInngest, signingKey, fns, opts] = args;
     const handler = new InngestCommHandler(nameOrInngest, signingKey, fns, opts);
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return handler.createHandler();
 };
 exports.register = register;
@@ -42,6 +45,8 @@ exports.register = register;
  * platform
  *
  * This needs to also account for the ability to validate signatures etc.
+ *
+ * @public
  */
 class InngestCommHandler {
     constructor(nameOrInngest, signingKey, functions, { inngestRegisterUrl } = {}) {
@@ -65,14 +70,34 @@ class InngestCommHandler {
             timeout: 0,
             headers: {
                 "Content-Type": "application/json",
-                "User-Agent": `InngestJS v${version_1.version}`,
+                "User-Agent": `InngestJS v${version_1.version} (${this.frameworkName})`,
             },
             validateStatus: () => true,
             maxRedirects: 0,
         });
     }
+    // hashedSigningKey creates a sha256 checksum of the signing key with the
+    // same signing key prefix.
+    get hashedSigningKey() {
+        var _a;
+        const prefix = ((_a = this.signingKey.match(/^signkey-(test|prod)-/)) === null || _a === void 0 ? void 0 : _a.shift()) || "";
+        const key = Buffer.from(this.signingKey.replace(/^signkey-(test|prod)-/, ""), "hex");
+        // Decode the key from its hex representation into a bytestream
+        console.log(prefix, key, `${prefix}${crypto_1.default.createHash("sha256").update(key).digest("hex")}`);
+        return `${prefix}${crypto_1.default.createHash("sha256").update(key).digest("hex")}`;
+    }
     createHandler() {
-        return async (req, res) => {
+        return async (req, res, next) => {
+            /**
+             * Specifically for CORS (browser->site requests), only allow PUT requests
+             * from the dashboard.
+             */
+            if (req.method === "OPTIONS") {
+                res.header("Access-Control-Allow-Origin", consts_1.corsOrigin);
+                res.header("Access-Control-Allow-Methods", "PUT");
+                res.header("Access-Control-Allow-Headers", "Content-Type");
+                return void next();
+            }
             console.log("Something hit the default handler!");
             const reqUrl = new URL(req.originalUrl, req.hostname);
             switch (req.method) {
@@ -81,14 +106,7 @@ class InngestCommHandler {
                     // Push config to Inngest.
                     await this.register(reqUrl);
                     return void res.sendStatus(200);
-                case "GET":
-                    console.log("It was a GET request");
-                    // Inngest is asking for config; confirm signed and send.
-                    this.validateSignature(); //TODO
-                    const pingRes = this.pong(reqUrl);
-                    this.signResponse(); // TODO
-                    return void res.json(pingRes);
-                case "POST":
+                case "POST": {
                     console.log("It was a POST request");
                     // Inngest is trying to run a step; confirm signed and run.
                     const { fnId, stepId } = zod_1.z
@@ -105,6 +123,7 @@ class InngestCommHandler {
                         return void res.status(stepRes.status).json(stepRes.error);
                     }
                     return void res.status(stepRes.status).json(stepRes.body);
+                }
                 default:
                     return void res.sendStatus(405);
             }
@@ -124,9 +143,15 @@ class InngestCommHandler {
             };
         }
         catch (err) {
+            if (err instanceof Error) {
+                return {
+                    status: 500,
+                    error: err.stack || err.message,
+                };
+            }
             return {
                 status: 500,
-                error: err.stack || err.message,
+                error: `Unknown error: ${JSON.stringify(err)}`,
             };
         }
     }
@@ -136,18 +161,6 @@ class InngestCommHandler {
     async register(url) {
         const body = {
             url: url.href,
-            hash: "TODO",
-        };
-        const config = {
-            headers: {
-                Authorization: `Bearer ${this.signingKey}`,
-            },
-        };
-        const res = await this.client.post(this.inngestRegisterUrl.href, body, config);
-        console.log("hit the register URL", this.inngestRegisterUrl.href, "with:", body, "and", config, "and got back:", res.status, res.data);
-    }
-    pong(url) {
-        return {
             deployType: "ping",
             framework: this.frameworkName,
             appName: this.name,
@@ -155,6 +168,13 @@ class InngestCommHandler {
             sdk: `js:v${version_1.version}`,
             v: "0.1",
         };
+        const config = {
+            headers: {
+                Authorization: `Bearer ${this.hashedSigningKey}`,
+            },
+        };
+        const res = await this.client.post(this.inngestRegisterUrl.href, body, config);
+        console.log("hit the register URL", this.inngestRegisterUrl.href, "with:", body, "and", config, "and got back:", res.status, res.data);
     }
     validateSignature() {
         return true;