inngest 0.4.0-beta.1 → 0.4.0-beta.10

package/README.md

@@ -1,42 +1,52 @@
-# inngest-node
+# inngest
+
+[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
+[![npm version](https://img.shields.io/npm/v/inngest)](https://www.npmjs.com/package/inngest)
+[![Discord](https://img.shields.io/discord/842170679536517141?label=discord)](https://discord.gg/EuesV2ZSnX)
+[![Twitter Follow](https://img.shields.io/twitter/follow/inngest?style=social)](https://twitter.com/inngest)
+
+Build, test, and deploy code that runs in response to events or on a schedule right in your own codebase.
+
+👋 _**Have a question or feature request? [Join our Discord](https://www.inngest.com/discord)!**_
 
 ```
 npm install inngest
 ```
 
-👋 _**Have a question or feature request? [Join our Discord](https://www.inngest.com/discord)!**_
+```ts
+// Send events
+import { Inngest } from "inngest";
+const inngest = new Inngest({ name: "My App" });
+
+inngest.send("app/user.created", { data: { id: 123 } });
+```
 
-## Usage
+```ts
+// Listen to events
+import { createFunction } from "inngest";
 
-```js
-// ES Modules / TypeScript
-import { Inngest } from "inngest";
-// or CommonJS
-const { Inngest } = require("inngest");
-
-const inngest = new Inngest(process.env.INNGEST_SOURCE_API_KEY);
-
-// Send a single event
-await inngest.send({
-  name: "user.signup",
-  data: {
-    plan: account.planType,
-  },
-  user: {
-    external_id: user.id,
-    email: user.email,
-  },
-});
-
-// Send events in bulk
-const events = ["+12125551234", "+13135555678"].map(phoneNumber => ({
-  name: "sms.response.requested",
-  data: {
-    message: "Are you available for work today? (y/n)"
-  },
-  user: {
-    phone: phoneNumber
+export default createFunction(
+  "Send welcome email",
+  "app/user.created",
+  ({ event }) => {
+    sendEmailTo(event.data.id, "Welcome!");
   }
-}});
-await inngest.send(events);
+);
 ```
+
+## Getting started
+
+Links to how to start, platforms, frameworks, logos?
+
+## 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/components/Inngest.d.ts

@@ -0,0 +1,215 @@
+import { SingleOrArray, ValueOf } from "../helpers/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
+ * events.
+ *
+ * To provide event typing, make sure to pass in your generated event types as
+ * the first generic.
+ *
+ * ```ts
+ * const inngest = new Inngest<Events>("My App", process.env.INNGEST_EVENT_KEY);
+ *
+ * // or to provide custom events too
+ * const inngest = new Inngest<
+ *   Events & {
+ *     "demo/event.blah": {
+ *       name: "demo/event.blah";
+ *       data: {
+ *         bar: boolean;
+ *       };
+ *     };
+ *   }
+ * >("My App", process.env.INNGEST_EVENT_KEY);
+ * ```
+ *
+ * @public
+ */
+export declare class Inngest<Events extends Record<string, EventPayload>> {
+    #private;
+    /**
+     * The name of this instance, most commonly the name of the application it
+     * resides in.
+     */
+    readonly name: string;
+    /**
+     * Inngest event key, used to send events to Inngest Cloud.
+     */
+    private readonly eventKey;
+    /**
+     * Base URL for Inngest Cloud.
+     */
+    readonly inngestBaseUrl: URL;
+    /**
+     * 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}
+     */
+    private readonly client;
+    /**
+     * A client used to interact with the Inngest API by sending or reacting to
+     * events.
+     *
+     * To provide event typing, make sure to pass in your generated event types as
+     * the first generic.
+     *
+     * ```ts
+     * const inngest = new Inngest<Events>("My App", process.env.INNGEST_EVENT_KEY);
+     *
+     * // or to provide custom events too
+     * const inngest = new Inngest<
+     *   Events & {
+     *     "demo/event.blah": {
+     *       name: "demo/event.blah";
+     *       data: {
+     *         bar: boolean;
+     *       };
+     *     };
+     *   }
+     * >("My App", process.env.INNGEST_EVENT_KEY);
+     * ```
+     */
+    constructor({ name, eventKey, inngestBaseUrl, }: ClientOptions);
+    /**
+     * Send one or many events to Inngest. Takes a known event from this Inngest
+     * instance based on the given `name`.
+     *
+     * ```ts
+     * await inngest.send("app/user.created", { data: { id: 123 } });
+     * ```
+     *
+     * Returns a promise that will resolve if the event(s) were sent successfully,
+     * else throws with an error explaining what went wrong.
+     *
+     * If you wish to send an event with custom types (i.e. one that hasn't been
+     * generated), make sure to add it when creating your Inngest instance, like
+     * so:
+     *
+     * ```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: SingleOrArray<Omit<Events[Event], "name">>): Promise<void>;
+    /**
+     * Send one or many events to Inngest. Takes an entire payload (including
+     * name) as each input.
+     *
+     * ```ts
+     * await inngest.send({ name: "app/user.created", data: { id: 123 } });
+     * ```
+     *
+     * Returns a promise that will resolve if the event(s) were sent successfully,
+     * else throws with an error explaining what went wrong.
+     *
+     * If you wish to send an event with custom types (i.e. one that hasn't been
+     * generated), make sure to add it when creating your Inngest instance, like
+     * so:
+     *
+     * ```ts
+     * const inngest = new Inngest<Events & {
+     *   "my/event": {
+     *     name: "my/event";
+     *     data: { bar: string; };
+     *   }
+     * }>("My App", "API_KEY");
+     * ```
+     */
+    send<Payload extends SingleOrArray<ValueOf<Events>>>(payload: Payload): Promise<void>;
+    /**
+     * Given an event to listen to, run the given function when that event is
+     * seen.
+     */
+    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: Name, 
+    /**
+     * The event to listen for.
+     */
+    event: Event, 
+    /**
+     * The function to run when the event is received.
+     */
+    fn: Fn): InngestFunction<Events>;
+    /**
+     * 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: Opts, 
+    /**
+     * The event to listen for.
+     */
+    event: Event, 
+    /**
+     * 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/components/Inngest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Inngest.d.ts","sourceRoot":"","sources":["../../src/components/Inngest.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC1D,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;gBACS,EACV,IAAI,EACJ,QAAwC,EACxC,cAAkC,GACnC,EAAE,aAAa;IA8DhB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,IAAI,CAAC,KAAK,SAAS,MAAM,MAAM,EAC1C,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC,GAClD,OAAO,CAAC,IAAI,CAAC;IAChB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,IAAI,CAAC,OAAO,SAAS,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAC9D,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,IAAI,CAAC;IAqDhB;;;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 → components}/Inngest.js

@@ -11,6 +11,7 @@ var _Inngest_instances, _Inngest_getResponseError;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Inngest = void 0;
 const axios_1 = __importDefault(require("axios"));
+const version_1 = require("../version");
 const InngestFunction_1 = require("./InngestFunction");
 const InngestStep_1 = require("./InngestStep");
 /**
@@ -19,18 +20,50 @@ const InngestStep_1 = require("./InngestStep");
  *
  * To provide event typing, make sure to pass in your generated event types as
  * the first generic.
+ *
+ * ```ts
+ * const inngest = new Inngest<Events>("My App", process.env.INNGEST_EVENT_KEY);
+ *
+ * // or to provide custom events too
+ * const inngest = new Inngest<
+ *   Events & {
+ *     "demo/event.blah": {
+ *       name: "demo/event.blah";
+ *       data: {
+ *         bar: boolean;
+ *       };
+ *     };
+ *   }
+ * >("My App", process.env.INNGEST_EVENT_KEY);
+ * ```
+ *
+ * @public
  */
 class Inngest {
-    constructor(
-    /**
-     * The name of this instance, most commonly the name of the application it
-     * resides in.
-     */
-    name, 
     /**
-     * Inngest event key, used to send events to Inngest Cloud.
+     * A client used to interact with the Inngest API by sending or reacting to
+     * events.
+     *
+     * To provide event typing, make sure to pass in your generated event types as
+     * the first generic.
+     *
+     * ```ts
+     * const inngest = new Inngest<Events>("My App", process.env.INNGEST_EVENT_KEY);
+     *
+     * // or to provide custom events too
+     * const inngest = new Inngest<
+     *   Events & {
+     *     "demo/event.blah": {
+     *       name: "demo/event.blah";
+     *       data: {
+     *         bar: boolean;
+     *       };
+     *     };
+     *   }
+     * >("My App", process.env.INNGEST_EVENT_KEY);
+     * ```
      */
-    eventKey, { inngestBaseUrl = "https://inn.gs/" } = {}) {
+    constructor({ name, eventKey = process.env.INNGEST_EVENT_KEY, inngestBaseUrl = "https://inn.gs/", }) {
         _Inngest_instances.add(this);
         if (!name) {
             throw new Error("A name must be passed to create an Inngest instance.");
@@ -46,26 +79,59 @@ class Inngest {
             timeout: 0,
             headers: {
                 "Content-Type": "application/json",
-                "User-Agent": "InngestJS 0.1.0",
+                "User-Agent": `InngestJS v${version_1.version}`,
             },
             validateStatus: () => true,
             maxRedirects: 0,
         });
     }
-    /**
-     * Send event(s) to Inngest
-     */
-    async send(name, payload) {
-        const response = await this.client.post(this.inngestApiUrl.href, Object.assign(Object.assign({}, payload), { name }));
+    async send(nameOrPayload, maybePayload) {
+        let payloads;
+        if (typeof nameOrPayload === "string") {
+            /**
+             * Add our payloads and ensure they all have a name.
+             */
+            payloads = (Array.isArray(maybePayload)
+                ? maybePayload
+                : maybePayload
+                    ? [maybePayload]
+                    : []).map((payload) => (Object.assign(Object.assign({}, payload), { name: nameOrPayload })));
+        }
+        else {
+            /**
+             * Grab our payloads straight from the args.
+             */
+            payloads = (Array.isArray(nameOrPayload)
+                ? nameOrPayload
+                : nameOrPayload
+                    ? [nameOrPayload]
+                    : []);
+        }
+        /**
+         * The two overload types should never allow this to happen, but in the case
+         * the user is in JS Land and it does, let's throw.
+         */
+        if (!payloads.length) {
+            throw new Error("Provided a name but no events to send; make sure to send an event payload too");
+        }
+        const response = await this.client.post(this.inngestApiUrl.href, payloads);
         if (response.status >= 200 && response.status < 300) {
-            return true;
+            return;
         }
         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/components/Inngest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Inngest.js","sourceRoot":"","sources":["../../src/components/Inngest.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA4D;AAG5D,wCAAqC;AACrC,uDAAoD;AACpD,+CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAa,OAAO;IA6BlB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,YAAY,EACV,IAAI,EACJ,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,EACxC,cAAc,GAAG,iBAAiB,GACpB;;QACd,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;IA4FM,KAAK,CAAC,IAAI,CACf,aAAqD,EACrD,YAAyD;QAEzD,IAAI,QAA2B,CAAC;QAEhC,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;YACrC;;eAEG;YACH,QAAQ,GAAG,CACT,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;gBACzB,CAAC,CAAC,YAAY;gBACd,CAAC,CAAC,YAAY;oBACd,CAAC,CAAC,CAAC,YAAY,CAAC;oBAChB,CAAC,CAAC,EAAE,CACP,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,iCACd,OAAO,KACV,IAAI,EAAE,aAAa,IACnB,CAAoB,CAAC;SACxB;aAAM;YACL;;eAEG;YACH,QAAQ,GAAG,CACT,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;gBAC1B,CAAC,CAAC,aAAa;gBACf,CAAC,CAAC,aAAa;oBACf,CAAC,CAAC,CAAC,aAAa,CAAC;oBACjB,CAAC,CAAC,EAAE,CACY,CAAC;SACtB;QAED;;;WAGG;QACH,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YACpB,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAC;SACH;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAE3E,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;AAjYD,0BAiYC;mGA3SmB,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/components/InngestFunction.d.ts

@@ -0,0 +1,42 @@
+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;
+    /**
+     * 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.
+     */
+    private getConfig;
+    /**
+     * Run a step in this function defined by `stepId` with `data`.
+     */
+    private runStep;
+}
+//# sourceMappingURL=InngestFunction.d.ts.map

package/components/InngestFunction.d.ts.map

@@ -0,0 +1 @@
+{"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 → 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/components/InngestFunction.js.map

@@ -0,0 +1 @@
+{"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 → 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 → 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 → 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/components/InngestStep.js.map

@@ -0,0 +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;;;;;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"}