inngest 2.7.2 → 3.0.0

package/components/InngestMiddleware.d.ts

@@ -1,14 +1,12 @@
 import { type Simplify } from "type-fest";
 import { type Await, type MaybePromise, type ObjectAssign, type PartialK } from "../helpers/types";
-import { type BaseContext, type ClientOptions, type EventPayload, type IncomingOp, type MiddlewareStack, type OutgoingOp } from "../types";
-import { type Inngest } from "./Inngest";
-import { type InngestFunction } from "./InngestFunction";
+import { type BaseContext, type ClientOptions, type EventPayload, type IncomingOp, type MiddlewareStack, type OutgoingOp, type SendEventBaseOutput } from "../types";
+import { type AnyInngest } from "./Inngest";
+import { type AnyInngestFunction } from "./InngestFunction";
 /**
  * A middleware that can be registered with Inngest to hook into various
  * lifecycles of the SDK and affect input and output of Inngest functionality.
  *
- * TODO Add docs and shortlink.
- *
  * See {@link https://innge.st/middleware}
  *
  * @example
@@ -18,7 +16,7 @@ import { type InngestFunction } from "./InngestFunction";
  *   middleware: [
  *     new InngestMiddleware({
  *       name: "My Middleware",
- *       register: () => {
+ *       init: () => {
  *         // ...
  *       }
  *     })
@@ -61,6 +59,7 @@ type PromisifiedFunctionRecord<TRecord extends Record<string, (arg: any) => any>
     [K in keyof TRecord]: (...args: Parameters<TRecord[K]>) => Promise<Parameters<TRecord[K]>[0]>;
 }>, keyof FnsWithSameInputAsOutput<TRecord>>;
 export type RunHookStack = PromisifiedFunctionRecord<Await<MiddlewareRegisterReturn["onFunctionRun"]>>;
+export type SendEventHookStack = PromisifiedFunctionRecord<Await<MiddlewareRegisterReturn["onSendEvent"]>>;
 /**
  * Given some middleware and an entrypoint, runs the initializer for the given
  * `key` and returns functions that will pass arguments through a stack of each
@@ -180,9 +179,6 @@ export type MiddlewareRegisterReturn = {
          * The `output` hook is called after the event has been sent to Inngest.
          * This is where you can perform any final actions after the event has
          * been sent to Inngest and can modify the output the SDK sees.
-         *
-         * TODO This needs to be a result object that we spread into, not just some
-         * unknown value.
          */
         transformOutput?: MiddlewareSendEventOutput;
     }>;
@@ -193,17 +189,13 @@ export type MiddlewareRegisterReturn = {
 export type MiddlewareRegisterFn = (ctx: {
     /**
      * The client this middleware is being registered on.
-     *
-     * TODO This should not use `any`, but the generic type expected.
      */
-    client: Inngest<any>;
+    client: AnyInngest;
     /**
      * If defined, this middleware has been applied directly to an Inngest
      * function rather than on the client.
-     *
-     * TODO This should not use `any`, but the generic type expected.
      */
-    fn?: InngestFunction<any, any, any, any>;
+    fn?: AnyInngestFunction;
 }) => MaybePromise<MiddlewareRegisterReturn>;
 /**
  * A blank, no-op hook that passes nothing and expects nothing in return.
@@ -221,17 +213,15 @@ type MiddlewareRunArgs = Readonly<{
      * The context object that will be passed to the function. This contains
      * event data, some contextual data such as the run's ID, and step tooling.
      */
-    ctx: Record<string, unknown> & Readonly<BaseContext<ClientOptions, string, Record<string, (...args: unknown[]) => unknown>>>;
+    ctx: Record<string, unknown> & Readonly<BaseContext<ClientOptions, string>>;
     /**
      * The step data that will be passed to the function.
      */
-    steps: Readonly<Omit<IncomingOp, "id">>[];
+    steps: Readonly<IncomingOp>[];
     /**
      * The function that is being executed.
-     *
-     * TODO This should not use `any`, but the generic type expected.
      */
-    fn: InngestFunction<any, any, any, any>;
+    fn: AnyInngestFunction;
 }>;
 /**
  * The specific arguments sent to the `run` hook when an execution has begun.
@@ -258,11 +248,11 @@ type MiddlewareRunInput = (ctx: MiddlewareRunArgs) => MaybePromise<{
     steps?: Pick<IncomingOp, "data">[];
 } | void>;
 /**
- * Arguments sent to some `sendEvent` lifecycle hooks of a middleware.
+ * Arguments for the SendEventInput hook
  *
  * @internal
  */
-type MiddlewareSendEventArgs = Readonly<{
+type MiddlewareSendEventInputArgs = Readonly<{
     payloads: ReadonlyArray<EventPayload>;
 }>;
 /**
@@ -271,23 +261,33 @@ type MiddlewareSendEventArgs = Readonly<{
  *
  * @internal
  */
-type MiddlewareSendEventInput = (ctx: MiddlewareSendEventArgs) => MaybePromise<{
+type MiddlewareSendEventInput = (ctx: MiddlewareSendEventInputArgs) => MaybePromise<{
     payloads?: EventPayload[];
 } | void>;
+/**
+ * Arguments for the SendEventOutput hook
+ *
+ * @internal
+ */
+type MiddlewareSendEventOutputArgs = {
+    result: Readonly<SendEventBaseOutput>;
+};
 /**
  * The shape of an `output` hook within a `sendEvent`, optionally returning a
  * change to the result value.
  */
-type MiddlewareSendEventOutput = (ctx: MiddlewareSendEventArgs) => MaybePromise<void>;
+type MiddlewareSendEventOutput = (ctx: MiddlewareSendEventOutputArgs) => MaybePromise<{
+    result?: Record<string, unknown>;
+} | void>;
 /**
  * @internal
  */
 type MiddlewareRunOutput = (ctx: {
     result: Readonly<Pick<OutgoingOp, "error" | "data">>;
     step?: Readonly<Omit<OutgoingOp, "id">>;
-}) => {
+}) => MaybePromise<{
     result?: Partial<Pick<OutgoingOp, "data">>;
-} | void;
+} | void>;
 /**
  * @internal
  */
@@ -299,6 +299,17 @@ type GetMiddlewareRunInputMutation<TMiddleware extends InngestMiddleware<Middlew
 /**
  * @internal
  */
+type GetMiddlewareSendEventOutputMutation<TMiddleware extends InngestMiddleware<MiddlewareOptions>> = TMiddleware extends InngestMiddleware<infer TOpts> ? TOpts["init"] extends MiddlewareRegisterFn ? Await<Await<Await<TOpts["init"]>["onSendEvent"]>["transformOutput"]> extends {
+    result: infer TResult;
+} ? {
+    [K in keyof TResult]: TResult[K];
+} : {} : {} : {};
+/**
+ * @internal
+ */
+export type MiddlewareStackSendEventOutputMutation<TContext, TMiddleware extends MiddlewareStack> = ObjectAssign<{
+    [K in keyof TMiddleware]: GetMiddlewareSendEventOutputMutation<TMiddleware[K]>;
+}, TContext>;
 export type ExtendWithMiddleware<TMiddlewareStacks extends MiddlewareStack[], TContext = {}> = ObjectAssign<{
     [K in keyof TMiddlewareStacks]: MiddlewareStackRunInputMutation<{}, TMiddlewareStacks[K]>;
 }, TContext>;

package/components/InngestMiddleware.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InngestMiddleware.d.ts","sourceRoot":"","sources":["../../src/components/InngestMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,EACL,KAAK,KAAK,EACV,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,QAAQ,EACd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,UAAU,EAChB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,iBAAiB,CAAC,KAAK,SAAS,iBAAiB;IAC5D;;;OAGG;IACH,SAAgB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpC;;;;;;;;;;;;;;OAcG;IACH,SAAgB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBAExB,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,KAAK;CAIlC;AAED,KAAK,wBAAwB,CAE3B,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAC,IAC/C;KACD,CAAC,IAAI,MAAM,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACtE,CAAC,GACD,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,SAAS,GAC1C,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,SAAS,GAChD,CAAC,GACD,KAAK,GACP,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC;CACvB,CAAC;AAEF,KAAK,yBAAyB,CAE5B,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAC,IAC/C,IAAI,CACN,OAAO,CAAC;KACL,CAAC,IAAI,MAAM,OAAO,GAAG,CACpB,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAC5B,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;CAChC,CAAC,EACF,MAAM,wBAAwB,CAAC,OAAO,CAAC,CACxC,GACC,IAAI,CACF,OAAO,CAAC;KACL,CAAC,IAAI,MAAM,OAAO,GAAG,CACpB,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAC5B,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACxC,CAAC,EACF,MAAM,wBAAwB,CAAC,OAAO,CAAC,CACxC,CAAC;AAEJ,MAAM,MAAM,YAAY,GAAG,yBAAyB,CAClD,KAAK,CAAC,wBAAwB,CAAC,eAAe,CAAC,CAAC,CACjD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,4CAEkB,GAAG,KAAK,GAAG,6nBA8FrD,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;;;;;;OAcG;IACH,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,YAAY,CAAC;QACpD;;;;;;;;;;;WAWG;QACH,cAAc,CAAC,EAAE,kBAAkB,CAAC;QAEpC;;;WAGG;QACH,iBAAiB,CAAC,EAAE,SAAS,CAAC;QAE9B;;;WAGG;QACH,gBAAgB,CAAC,EAAE,SAAS,CAAC;QAE7B;;;;WAIG;QACH,eAAe,CAAC,EAAE,SAAS,CAAC;QAE5B;;;WAGG;QACH,cAAc,CAAC,EAAE,SAAS,CAAC;QAE3B;;;;;;;;;;;WAWG;QACH,eAAe,CAAC,EAAE,mBAAmB,CAAC;QAEtC;;;;WAIG;QACH,cAAc,CAAC,EAAE,SAAS,CAAC;KAC5B,CAAC,CAAC;IAEH;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,YAAY,CAAC;QAC/B;;;;WAIG;QACH,cAAc,CAAC,EAAE,wBAAwB,CAAC;QAE1C;;;;;;;WAOG;QACH,eAAe,CAAC,EAAE,yBAAyB,CAAC;KAC7C,CAAC,CAAC;CACJ,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,GAAG,EAAE;IACvC;;;;OAIG;IAEH,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IAErB;;;;;OAKG;IAEH,EAAE,CAAC,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;CAC1C,KAAK,YAAY,CAAC,wBAAwB,CAAC,CAAC;AAE7C;;;;GAIG;AACH,KAAK,SAAS,GAAG,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;AAE1C;;;;GAIG;AACH,KAAK,iBAAiB,GAAG,QAAQ,CAAC;IAChC;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC1B,QAAQ,CACN,WAAW,CACT,aAAa,EACb,MAAM,EACN,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,CAChD,CACF,CAAC;IAEJ;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;IAE1C;;;;OAIG;IAEH,EAAE,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;CACzC,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,KAAK,cAAc,GAAG,QAAQ,CAC5B,QAAQ,CACN,IAAI,CAAC,iBAAiB,EAAE,KAAK,CAAC,GAAG;IAC/B;;;OAGG;IACH,GAAG,EAAE,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC;CACxD,CACF,CACF,CAAC;AAEF;;;;;GAKG;AACH,KAAK,kBAAkB,GAAG,CAAC,GAAG,EAAE,iBAAiB,KAAK,YAAY,CAAC;IACjE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,KAAK,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE,CAAC;CAOpC,GAAG,IAAI,CAAC,CAAC;AAEV;;;;GAIG;AACH,KAAK,uBAAuB,GAAG,QAAQ,CAAC;IACtC,QAAQ,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;CACvC,CAAC,CAAC;AAEH;;;;;GAKG;AACH,KAAK,wBAAwB,GAAG,CAAC,GAAG,EAAE,uBAAuB,KAAK,YAAY,CAAC;IAC7E,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;CAC3B,GAAG,IAAI,CAAC,CAAC;AAEV;;;GAGG;AACH,KAAK,yBAAyB,GAAG,CAC/B,GAAG,EAAE,uBAAuB,KACzB,YAAY,CAAC,IAAI,CAAC,CAAC;AAExB;;GAEG;AACH,KAAK,mBAAmB,GAAG,CAAC,GAAG,EAAE;IAC/B,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IACrD,IAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;CACzC,KAAK;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAA;CAAE,GAAG,IAAI,CAAC;AAE5D;;GAEG;AACH,KAAK,6BAA6B,CAChC,WAAW,SAAS,iBAAiB,CAAC,iBAAiB,CAAC,IACtD,WAAW,SAAS,iBAAiB,CAAC,MAAM,KAAK,CAAC,GAClD,KAAK,CAAC,MAAM,CAAC,SAAS,oBAAoB,GACxC,KAAK,CACH,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAC/D,SAAS;IACR,GAAG,EAAE,MAAM,IAAI,CAAC;CACjB,GACC;KACG,CAAC,IAAI,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC;CAC3B,GAED,EAAE,GAEJ,EAAE,GAEJ,EAAE,CAAC;AAEP;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAC9B,iBAAiB,SAAS,eAAe,EAAE,EAE3C,QAAQ,GAAG,EAAE,IACX,YAAY,CACd;KACG,CAAC,IAAI,MAAM,iBAAiB,GAAG,+BAA+B,CAE7D,EAAE,EACF,iBAAiB,CAAC,CAAC,CAAC,CACrB;CACF,EACD,QAAQ,CACT,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,CACzC,QAAQ,EACR,WAAW,SAAS,eAAe,IACjC,YAAY,CACd;KACG,CAAC,IAAI,MAAM,WAAW,GAAG,6BAA6B,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CACxE,EACD,QAAQ,CACT,CAAC"}
+{"version":3,"file":"InngestMiddleware.d.ts","sourceRoot":"","sources":["../../src/components/InngestMiddleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,EACL,KAAK,KAAK,EACV,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,QAAQ,EACd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,UAAU,EACf,KAAK,mBAAmB,EACzB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,iBAAiB,CAAC,KAAK,SAAS,iBAAiB;IAC5D;;;OAGG;IACH,SAAgB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpC;;;;;;;;;;;;;;OAcG;IACH,SAAgB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBAExB,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,KAAK;CAIlC;AAED,KAAK,wBAAwB,CAE3B,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAC,IAC/C;KACD,CAAC,IAAI,MAAM,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACtE,CAAC,GACD,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,SAAS,GAC1C,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,SAAS,GAChD,CAAC,GACD,KAAK,GACP,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC;CACvB,CAAC;AAEF,KAAK,yBAAyB,CAE5B,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAC,IAC/C,IAAI,CACN,OAAO,CAAC;KACL,CAAC,IAAI,MAAM,OAAO,GAAG,CACpB,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAC5B,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;CAChC,CAAC,EACF,MAAM,wBAAwB,CAAC,OAAO,CAAC,CACxC,GACC,IAAI,CACF,OAAO,CAAC;KACL,CAAC,IAAI,MAAM,OAAO,GAAG,CACpB,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAC5B,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACxC,CAAC,EACF,MAAM,wBAAwB,CAAC,OAAO,CAAC,CACxC,CAAC;AAEJ,MAAM,MAAM,YAAY,GAAG,yBAAyB,CAClD,KAAK,CAAC,wBAAwB,CAAC,eAAe,CAAC,CAAC,CACjD,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,CACxD,KAAK,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAC,CAC/C,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,4CAEkB,GAAG,KAAK,GAAG,6nBA8FrD,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;;;;;;;OAcG;IACH,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,YAAY,CAAC;QACpD;;;;;;;;;;;WAWG;QACH,cAAc,CAAC,EAAE,kBAAkB,CAAC;QAEpC;;;WAGG;QACH,iBAAiB,CAAC,EAAE,SAAS,CAAC;QAE9B;;;WAGG;QACH,gBAAgB,CAAC,EAAE,SAAS,CAAC;QAE7B;;;;WAIG;QACH,eAAe,CAAC,EAAE,SAAS,CAAC;QAE5B;;;WAGG;QACH,cAAc,CAAC,EAAE,SAAS,CAAC;QAE3B;;;;;;;;;;;WAWG;QACH,eAAe,CAAC,EAAE,mBAAmB,CAAC;QAEtC;;;;WAIG;QACH,cAAc,CAAC,EAAE,SAAS,CAAC;KAC5B,CAAC,CAAC;IAEH;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,YAAY,CAAC;QAC/B;;;;WAIG;QACH,cAAc,CAAC,EAAE,wBAAwB,CAAC;QAE1C;;;;WAIG;QACH,eAAe,CAAC,EAAE,yBAAyB,CAAC;KAC7C,CAAC,CAAC;CACJ,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,GAAG,EAAE;IACvC;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IAEnB;;;OAGG;IACH,EAAE,CAAC,EAAE,kBAAkB,CAAC;CACzB,KAAK,YAAY,CAAC,wBAAwB,CAAC,CAAC;AAE7C;;;;GAIG;AACH,KAAK,SAAS,GAAG,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;AAE1C;;;;GAIG;AACH,KAAK,iBAAiB,GAAG,QAAQ,CAAC;IAChC;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC;IAE5E;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;IAE9B;;OAEG;IACH,EAAE,EAAE,kBAAkB,CAAC;CACxB,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,KAAK,cAAc,GAAG,QAAQ,CAC5B,QAAQ,CACN,IAAI,CAAC,iBAAiB,EAAE,KAAK,CAAC,GAAG;IAC/B;;;OAGG;IACH,GAAG,EAAE,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC;CACxD,CACF,CACF,CAAC;AAEF;;;;;GAKG;AACH,KAAK,kBAAkB,GAAG,CAAC,GAAG,EAAE,iBAAiB,KAAK,YAAY,CAAC;IACjE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,KAAK,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE,CAAC;CAOpC,GAAG,IAAI,CAAC,CAAC;AAEV;;;;GAIG;AACH,KAAK,4BAA4B,GAAG,QAAQ,CAAC;IAC3C,QAAQ,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;CACvC,CAAC,CAAC;AAEH;;;;;GAKG;AACH,KAAK,wBAAwB,GAAG,CAC9B,GAAG,EAAE,4BAA4B,KAC9B,YAAY,CAAC;IAChB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;CAC3B,GAAG,IAAI,CAAC,CAAC;AAEV;;;;GAIG;AACH,KAAK,6BAA6B,GAAG;IAAE,MAAM,EAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAA;CAAE,CAAC;AAE/E;;;GAGG;AACH,KAAK,yBAAyB,GAAG,CAC/B,GAAG,EAAE,6BAA6B,KAC/B,YAAY,CAAC;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,GAAG,IAAI,CAAC,CAAC;AAE/D;;GAEG;AACH,KAAK,mBAAmB,GAAG,CAAC,GAAG,EAAE;IAC/B,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC;IACrD,IAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;CACzC,KAAK,YAAY,CAAC;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAA;CAAE,GAAG,IAAI,CAAC,CAAC;AAE1E;;GAEG;AACH,KAAK,6BAA6B,CAChC,WAAW,SAAS,iBAAiB,CAAC,iBAAiB,CAAC,IACtD,WAAW,SAAS,iBAAiB,CAAC,MAAM,KAAK,CAAC,GAClD,KAAK,CAAC,MAAM,CAAC,SAAS,oBAAoB,GACxC,KAAK,CACH,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAC/D,SAAS;IACR,GAAG,EAAE,MAAM,IAAI,CAAC;CACjB,GACC;KACG,CAAC,IAAI,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC;CAC3B,GAED,EAAE,GAEJ,EAAE,GAEJ,EAAE,CAAC;AAEP;;GAEG;AACH,KAAK,oCAAoC,CACvC,WAAW,SAAS,iBAAiB,CAAC,iBAAiB,CAAC,IACtD,WAAW,SAAS,iBAAiB,CAAC,MAAM,KAAK,CAAC,GAClD,KAAK,CAAC,MAAM,CAAC,SAAS,oBAAoB,GACxC,KAAK,CACH,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAC9D,SAAS;IACR,MAAM,EAAE,MAAM,OAAO,CAAC;CACvB,GACC;KACG,CAAC,IAAI,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;CACjC,GAED,EAAE,GAEJ,EAAE,GAEJ,EAAE,CAAC;AAEP;;GAEG;AACH,MAAM,MAAM,sCAAsC,CAChD,QAAQ,EACR,WAAW,SAAS,eAAe,IACjC,YAAY,CACd;KACG,CAAC,IAAI,MAAM,WAAW,GAAG,oCAAoC,CAC5D,WAAW,CAAC,CAAC,CAAC,CACf;CACF,EACD,QAAQ,CACT,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAC9B,iBAAiB,SAAS,eAAe,EAAE,EAE3C,QAAQ,GAAG,EAAE,IACX,YAAY,CACd;KACG,CAAC,IAAI,MAAM,iBAAiB,GAAG,+BAA+B,CAE7D,EAAE,EACF,iBAAiB,CAAC,CAAC,CAAC,CACrB;CACF,EACD,QAAQ,CACT,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,CACzC,QAAQ,EACR,WAAW,SAAS,eAAe,IACjC,YAAY,CACd;KACG,CAAC,IAAI,MAAM,WAAW,GAAG,6BAA6B,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CACxE,EACD,QAAQ,CACT,CAAC"}

package/components/InngestMiddleware.js

@@ -6,8 +6,6 @@ const functions_1 = require("../helpers/functions");
  * A middleware that can be registered with Inngest to hook into various
  * lifecycles of the SDK and affect input and output of Inngest functionality.
  *
- * TODO Add docs and shortlink.
- *
  * See {@link https://innge.st/middleware}
  *
  * @example
@@ -17,7 +15,7 @@ const functions_1 = require("../helpers/functions");
  *   middleware: [
  *     new InngestMiddleware({
  *       name: "My Middleware",
- *       register: () => {
+ *       init: () => {
  *         // ...
  *       }
  *     })

package/components/InngestMiddleware.js.map

@@ -1 +1 @@
-{"version":3,"file":"InngestMiddleware.js","sourceRoot":"","sources":["../../src/components/InngestMiddleware.ts"],"names":[],"mappings":";;;AACA,oDAA0D;AAkB1D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAa,iBAAiB;IAwB5B,YAAY,EAAE,IAAI,EAAE,IAAI,EAAS;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AA5BD,8CA4BC;AAuCD;;;;;;GAMG;AACI,MAAM,YAAY,GAAG,KAAK;AAO/B;;GAEG;AACH,UAAkC;AAElC;;GAEG;AACH,GAAS;AAET;;GAEG;AACH,GAAqC,EAErC,UAgBC,EACc,EAAE;IACjB,oCAAoC;IACpC,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC;IAEjC,kEAAkE;IAClE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE;QACxC,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;QAEnB,IAAI,EAAE,EAAE;YACN,OAAO,CAAC,GAAG,GAAG,EAAE,EAAE,CAAC,CAAC;SACrB;QAED,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAsC,CAAC,CAAC;IAE3C,0DAA0D;IAC1D,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,MAAM,CAEzC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE;QAClB,+DAA+D;QAC/D,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACzC,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAExB,0EAA0E;IAC1E,2BAA2B;IAC3B,MAAM,GAAG,GAAG,EAAU,CAAC;IAEvB,wEAAwE;IACxE,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE;QAClC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAmB,CAAC;QAErD,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;YAC1B,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAEtB,MAAM,iBAAiB,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,iBAAiB,EAAE;gBACrB,GAAG,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;aACtC;YAED,MAAM,SAAS,GAAG,UAAU,CAAC,GAA8B,CAEtB,CAAC;YAEtC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAA,qBAAS,EAAC,GAAG,EAAE,SAAS,CAAqB,CAAC;SAC1D;KACF;IAED,0EAA0E;IAC1E,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAChC,MAAM,GAAG,GAAG,CAAqB,CAAC;QAElC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAA,mBAAO,EAChB,GAAG,CAAC,GAAG,CAAoC,CACb,CAAC;KAClC;IAED,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAhGW,QAAA,YAAY,gBAgGvB"}
+{"version":3,"file":"InngestMiddleware.js","sourceRoot":"","sources":["../../src/components/InngestMiddleware.ts"],"names":[],"mappings":";;;AACA,oDAA0D;AAmB1D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,iBAAiB;IAwB5B,YAAY,EAAE,IAAI,EAAE,IAAI,EAAS;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AA5BD,8CA4BC;AA2CD;;;;;;GAMG;AACI,MAAM,YAAY,GAAG,KAAK;AAO/B;;GAEG;AACH,UAAkC;AAElC;;GAEG;AACH,GAAS;AAET;;GAEG;AACH,GAAqC,EAErC,UAgBC,EACc,EAAE;IACjB,oCAAoC;IACpC,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC;IAEjC,kEAAkE;IAClE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE;QACxC,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;QAEnB,IAAI,EAAE,EAAE;YACN,OAAO,CAAC,GAAG,GAAG,EAAE,EAAE,CAAC,CAAC;SACrB;QAED,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAsC,CAAC,CAAC;IAE3C,0DAA0D;IAC1D,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,MAAM,CAEzC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE;QAClB,+DAA+D;QAC/D,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACzC,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IAExB,0EAA0E;IAC1E,2BAA2B;IAC3B,MAAM,GAAG,GAAG,EAAU,CAAC;IAEvB,wEAAwE;IACxE,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE;QAClC,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAmB,CAAC;QAErD,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;YAC1B,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAEtB,MAAM,iBAAiB,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,iBAAiB,EAAE;gBACrB,GAAG,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;aACtC;YAED,MAAM,SAAS,GAAG,UAAU,CAAC,GAA8B,CAEtB,CAAC;YAEtC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAA,qBAAS,EAAC,GAAG,EAAE,SAAS,CAAqB,CAAC;SAC1D;KACF;IAED,0EAA0E;IAC1E,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAChC,MAAM,GAAG,GAAG,CAAqB,CAAC;QAElC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAA,mBAAO,EAChB,GAAG,CAAC,GAAG,CAAoC,CACb,CAAC;KAClC;IAED,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAhGW,QAAA,YAAY,gBAgGvB"}

package/components/InngestStepTools.d.ts

@@ -1,14 +1,62 @@
 import { type Jsonify } from "type-fest";
-import { type ObjectPaths, type SendEventPayload } from "../helpers/types";
-import { StepOpCode, type ClientOptions, type EventPayload, type HashedOp, type StepOpts } from "../types";
+import { type ExclusiveKeys, type ObjectPaths, type ParametersExceptFirst, type SendEventPayload } from "../helpers/types";
+import { type ClientOptions, type EventPayload, type HashedOp, type SendEventOutput, type StepOptions, type StepOptionsOrId } from "../types";
 import { type EventsFromOpts, type Inngest } from "./Inngest";
-import { type ExecutionState } from "./InngestFunction";
-export interface TickOp extends HashedOp {
+export interface FoundStep extends HashedOp {
+    hashedId: string;
     fn?: (...args: unknown[]) => unknown;
     fulfilled: boolean;
-    resolve: (value: unknown | PromiseLike<unknown>) => void;
-    reject: (reason?: unknown) => void;
+    handled: boolean;
+    /**
+     * Returns a boolean representing whether or not the step was handled on this
+     * invocation.
+     */
+    handle: () => boolean;
 }
+export type MatchOpFn<T extends (...args: unknown[]) => Promise<unknown> = (...args: unknown[]) => Promise<unknown>> = (stepOptions: StepOptions, 
+/**
+ * Arguments passed by the user.
+ */
+...args: ParametersExceptFirst<T>) => Omit<HashedOp, "data" | "error">;
+export type StepHandler = (info: {
+    matchOp: MatchOpFn;
+    opts?: StepToolOptions;
+    args: [StepOptionsOrId, ...unknown[]];
+}) => Promise<unknown>;
+export interface StepToolOptions<T extends (...args: unknown[]) => Promise<unknown> = (...args: unknown[]) => Promise<unknown>> {
+    /**
+     * Optionally, we can also provide a function that will be called when
+     * Inngest tells us to run this operation.
+     *
+     * If this function is defined, the first time the tool is used it will
+     * report the desired operation (including options) to the Inngest. Inngest
+     * will then call back to the function to tell it to run the step and then
+     * retrieve data.
+     *
+     * We do this in order to allow functionality such as per-step retries; this
+     * gives the SDK the opportunity to tell Inngest what it wants to do before
+     * it does it.
+     *
+     * This function is passed the arguments passed by the user. It will be run
+     * when we receive an operation matching this one that does not contain a
+     * `data` property.
+     */
+    fn?: (...args: Parameters<T>) => unknown;
+    /**
+     * If `true` and we have detected that this is a  non-step function, the
+     * provided `fn` will be called and the result returned immediately
+     * instead of being executed later.
+     *
+     * If no `fn` is provided to the tool, this will throw the same error as
+     * if this setting was `false`.
+     */
+    nonStepExecuteInline?: boolean;
+}
+export declare const getStepOptions: (options: StepOptionsOrId) => StepOptions;
+/**
+ * Suffix used to namespace steps that are automatically indexed.
+ */
+export declare const STEP_INDEXING_SUFFIX = ":";
 /**
  * Create a new set of step function tools ready to be used in a step function.
  * This function should be run and a fresh set of tools provided every time a
@@ -17,7 +65,7 @@ export interface TickOp extends HashedOp {
  * An op stack (function state) is passed in as well as some mutable properties
  * that the tools can use to submit a new op.
  */
-export declare const createStepTools: <TOpts extends ClientOptions, Events extends EventsFromOpts<TOpts>, TriggeringEvent extends keyof Events & string>(client: Inngest<TOpts>, state: ExecutionState) => {
+export declare const createStepTools: <TOpts extends ClientOptions, Events extends EventsFromOpts<TOpts>, TriggeringEvent extends keyof Events & string>(client: Inngest<TOpts>, stepHandler: StepHandler) => {
     /**
      * Send one or many events to Inngest. Should always be used in place of
      * `inngest.send()` to ensure that the event send is successfully retried
@@ -43,7 +91,11 @@ export declare const createStepTools: <TOpts extends ClientOptions, Events exten
      *
      * Returns a promise that will resolve once the event has been sent.
      */
-    sendEvent: <Payload extends SendEventPayload<EventsFromOpts<TOpts>>>(payload: Payload, opts?: StepOpts) => Promise<void>;
+    sendEvent: <Payload extends SendEventPayload<EventsFromOpts<TOpts>>>(idOrOptions: StepOptionsOrId, payload: Payload) => Promise<import("type-fest").Simplify<import("type-fest").Simplify<Omit<Omit<import("../types").SendEventBaseOutput, never> & import("type-fest").Simplify<Omit<{}, never> | (Omit<{}, never> & {})>, keyof import("../helpers/types").ObjectAssign<NonNullable<TOpts["middleware"]> extends infer T extends import("../types").MiddlewareStack ? { [K in keyof T]: NonNullable<TOpts["middleware"]>[K] extends infer T_1 ? T_1 extends NonNullable<TOpts["middleware"]>[K] ? T_1 extends import("./InngestMiddleware").InngestMiddleware<infer TOpts_1 extends import("./InngestMiddleware").MiddlewareOptions> ? TOpts_1["init"] extends import("./InngestMiddleware").MiddlewareRegisterFn ? import("../helpers/types").Await<import("../helpers/types").Await<import("../helpers/types").Await<TOpts_1["init"]>["onSendEvent"]>["transformOutput"]> extends {
+        result: infer TResult;
+    } ? { [K_1 in keyof TResult]: TResult[K_1]; } : {} : {} : {} : never : never; } : never, {}>> & import("../helpers/types").ObjectAssign<NonNullable<TOpts["middleware"]> extends infer T_2 extends import("../types").MiddlewareStack ? { [K in keyof T_2]: NonNullable<TOpts["middleware"]>[K] extends infer T_3 ? T_3 extends NonNullable<TOpts["middleware"]>[K] ? T_3 extends import("./InngestMiddleware").InngestMiddleware<infer TOpts_1 extends import("./InngestMiddleware").MiddlewareOptions> ? TOpts_1["init"] extends import("./InngestMiddleware").MiddlewareRegisterFn ? import("../helpers/types").Await<import("../helpers/types").Await<import("../helpers/types").Await<TOpts_1["init"]>["onSendEvent"]>["transformOutput"]> extends {
+        result: infer TResult;
+    } ? { [K_1 in keyof TResult]: TResult[K_1]; } : {} : {} : {} : never : never; } : never, {}>>>>;
     /**
      * Wait for a particular event to be received before continuing. When the
      * event is received, it will be returned.
@@ -53,11 +105,7 @@ export declare const createStepTools: <TOpts extends ClientOptions, Events exten
      * events, or to only wait a maximum amount of time before giving up and
      * returning `null` instead of any event data.
      */
-    waitForEvent: <IncomingEvent extends EventPayload | keyof Events>(event: IncomingEvent extends keyof Events ? IncomingEvent : IncomingEvent extends EventPayload ? IncomingEvent["name"] : never, opts: string | ((IncomingEvent extends keyof Events ? WaitForEventOpts<Events[TriggeringEvent], Events[IncomingEvent]> : IncomingEvent extends EventPayload ? WaitForEventOpts<Events[TriggeringEvent], IncomingEvent> : never) & {
-        if?: undefined;
-    }) | ((IncomingEvent extends keyof Events ? WaitForEventOpts<Events[TriggeringEvent], Events[IncomingEvent]> : IncomingEvent extends EventPayload ? WaitForEventOpts<Events[TriggeringEvent], IncomingEvent> : never) & {
-        match?: undefined;
-    })) => Promise<IncomingEvent extends keyof Events ? Events[IncomingEvent] | null : IncomingEvent | null>;
+    waitForEvent: <IncomingEvent extends keyof Events & string>(idOrOptions: StepOptionsOrId, opts: WaitForEventOpts<Events, TriggeringEvent, IncomingEvent>) => Promise<IncomingEvent extends keyof Events ? Events[IncomingEvent] | null : IncomingEvent | null>;
     /**
      * Use this tool to run business logic. Each call to `run` will be retried
      * individually, meaning you can compose complex workflows that safely
@@ -70,7 +118,7 @@ export declare const createStepTools: <TOpts extends ClientOptions, Events exten
      * of the `run` tool, meaning you can return and reason about return data
      * for next steps.
      */
-    run: <T extends () => unknown>(name: string, fn: T, opts?: StepOpts) => Promise<Jsonify<T extends () => Promise<infer U> ? Awaited<U extends void ? null : U> : ReturnType<T> extends void ? null : ReturnType<T>>>;
+    run: <T_4 extends () => unknown>(idOrOptions: StepOptionsOrId, fn: T_4) => Promise<Jsonify<T_4 extends () => Promise<infer U> ? Awaited<U extends void ? null : U> : ReturnType<T_4> extends void ? null : ReturnType<T_4>>>;
     /**
      * Wait a specified amount of time before continuing.
      *
@@ -81,20 +129,21 @@ export declare const createStepTools: <TOpts extends ClientOptions, Events exten
      *
      * To wait until a particular date, use `sleepUntil` instead.
      */
-    sleep: (time: number | string, opts?: StepOpts) => Promise<void>;
+    sleep: (idOrOptions: StepOptionsOrId, time: number | string) => Promise<void>;
     /**
      * Wait until a particular date before continuing by passing a `Date`.
      *
      * To wait for a particular amount of time from now, always use `sleep`
      * instead.
      */
-    sleepUntil: (time: Date | string, opts?: StepOpts) => Promise<void>;
+    sleepUntil: (idOrOptions: StepOptionsOrId, time: Date | string) => Promise<void>;
 };
 /**
  * A set of optional parameters given to a `waitForEvent` call to control how
  * the event is handled.
  */
-interface WaitForEventOpts<TriggeringEvent extends EventPayload, IncomingEvent extends EventPayload> extends StepOpts {
+type WaitForEventOpts<Events extends Record<string, EventPayload>, TriggeringEvent extends keyof Events, IncomingEvent extends keyof Events> = {
+    event: IncomingEvent;
     /**
      * The step function will wait for the event for a maximum of this time, at
      * which point the event will be returned as `null` instead of any event data.
@@ -106,6 +155,7 @@ interface WaitForEventOpts<TriggeringEvent extends EventPayload, IncomingEvent e
      * {@link https://npm.im/ms}
      */
     timeout: number | string | Date;
+} & ExclusiveKeys<{
     /**
      * If provided, the step function will wait for the incoming event to match
      * particular criteria. If the event does not match, it will be ignored and
@@ -127,7 +177,7 @@ interface WaitForEventOpts<TriggeringEvent extends EventPayload, IncomingEvent e
      *
      * {@link https://www.inngest.com/docs/functions/expressions}
      */
-    match?: ObjectPaths<TriggeringEvent> & ObjectPaths<IncomingEvent>;
+    match?: ObjectPaths<Events[TriggeringEvent]> & ObjectPaths<Events[IncomingEvent]>;
     /**
      * If provided, the step function will wait for the incoming event to match
      * the given condition. If the event does not match, it will be ignored and
@@ -141,24 +191,6 @@ interface WaitForEventOpts<TriggeringEvent extends EventPayload, IncomingEvent e
      * {@link https://www.inngest.com/docs/functions/expressions}
      */
     if?: string;
-}
-/**
- * An operation ready to hash to be used to memoise step function progress.
- *
- * @internal
- */
-export type UnhashedOp = {
-    name: string;
-    op: StepOpCode;
-    opts: Record<string, unknown> | null;
-    parent: string | null;
-    pos?: number;
-};
-/**
- * Exported for testing.
- */
-export declare const _internals: {
-    hashData: (op: UnhashedOp) => string;
-};
+}, "match", "if">;
 export {};
 //# sourceMappingURL=InngestStepTools.d.ts.map

package/components/InngestStepTools.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InngestStepTools.d.ts","sourceRoot":"","sources":["../../src/components/InngestStepTools.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAOzC,OAAO,EACL,KAAK,WAAW,EAEhB,KAAK,gBAAgB,EACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,UAAU,EACV,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,QAAQ,EACb,KAAK,QAAQ,EACd,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAC9D,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAGxD,MAAM,WAAW,MAAO,SAAQ,QAAQ;IACtC,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC;IACrC,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IACzD,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;CACpC;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,oJAMnB,cAAc;IAuJnB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;kGAIQ,QAAQ,KACd,QAAQ,IAAI,CAAC;IAiBlB;;;;;;;;OAQG;;;;;;IAmEH;;;;;;;;;;;OAWG;0BAEgB,OAAO,QAMhB,MAAM,gBAWL,QAAQ;IAyBnB;;;;;;;;;OASG;kBAMO,MAAM,GAAG,MAAM,SACd,QAAQ,KACZ,QAAQ,IAAI,CAAC;IAapB;;;;;OAKG;uBAMO,IAAI,GAAG,MAAM,SACZ,QAAQ,KACZ,QAAQ,IAAI,CAAC;CA+BvB,CAAC;AAEF;;;GAGG;AACH,UAAU,gBAAgB,CACxB,eAAe,SAAS,YAAY,EACpC,aAAa,SAAS,YAAY,CAClC,SAAQ,QAAQ;IAChB;;;;;;;;;OASG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAElE;;;;;;;;;;;OAWG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,UAAU,CAAC;IACf,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACrC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAMF;;GAEG;AACH,eAAO,MAAM,UAAU;mBAPD,UAAU,KAAG,MAAM;CAOH,CAAC"}
+{"version":3,"file":"InngestStepTools.d.ts","sourceRoot":"","sources":["../../src/components/InngestStepTools.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,EACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAEL,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,QAAQ,EACb,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,eAAe,EACrB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAE9D,MAAM,WAAW,SAAU,SAAQ,QAAQ;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC;IACrC,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,MAAM,EAAE,MAAM,OAAO,CAAC;CACvB;AAED,MAAM,MAAM,SAAS,CACnB,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,CACnD,GAAG,IAAI,EAAE,OAAO,EAAE,KACf,OAAO,CAAC,OAAO,CAAC,IACnB,CACF,WAAW,EAAE,WAAW;AACxB;;GAEG;AACH,GAAG,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,KAC9B,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC;AAEtC,MAAM,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE;IAC/B,OAAO,EAAE,SAAS,CAAC;IACnB,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,IAAI,EAAE,CAAC,eAAe,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;CACvC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAEvB,MAAM,WAAW,eAAe,CAC9B,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,CACnD,GAAG,IAAI,EAAE,OAAO,EAAE,KACf,OAAO,CAAC,OAAO,CAAC;IAErB;;;;;;;;;;;;;;;;OAgBG;IACH,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;IAEzC;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,eAAO,MAAM,cAAc,YAAa,eAAe,KAAG,WAMzD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,0JAMb,WAAW;IAmCtB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;sFAGc,eAAe;;;;;IAoBhC;;;;;;;;OAQG;6EAGc,eAAe;IAsChC;;;;;;;;;;;OAWG;4BAEgB,OAAO,eACT,eAAe;IAoChC;;;;;;;;;OASG;yBAGc,eAAe,QAKtB,MAAM,GAAG,MAAM,KAClB,QAAQ,IAAI,CAAC;IAcpB;;;;;OAKG;8BAGc,eAAe,QAKtB,IAAI,GAAG,MAAM,KAChB,QAAQ,IAAI,CAAC;CAgCvB,CAAC;AAEF;;;GAGG;AACH,KAAK,gBAAgB,CACnB,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,EAC3C,eAAe,SAAS,MAAM,MAAM,EACpC,aAAa,SAAS,MAAM,MAAM,IAChC;IACF,KAAK,EAAE,aAAa,CAAC;IAErB;;;;;;;;;OASG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CACjC,GAAG,aAAa,CACf;IACE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,GAC1C,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;IAErC;;;;;;;;;;;OAWG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,EACD,OAAO,EACP,IAAI,CACL,CAAC"}

package/components/InngestStepTools.js

@@ -1,15 +1,19 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._internals = exports.createStepTools = void 0;
-const canonicalize_1 = __importDefault(require("canonicalize"));
-const hash_js_1 = require("hash.js");
-const errors_1 = require("../helpers/errors");
+exports.createStepTools = exports.STEP_INDEXING_SUFFIX = exports.getStepOptions = void 0;
 const strings_1 = require("../helpers/strings");
 const types_1 = require("../types");
-const NonRetriableError_1 = require("./NonRetriableError");
+const getStepOptions = (options) => {
+    if (typeof options === "string") {
+        return { id: options };
+    }
+    return options;
+};
+exports.getStepOptions = getStepOptions;
+/**
+ * Suffix used to namespace steps that are automatically indexed.
+ */
+exports.STEP_INDEXING_SUFFIX = ":";
 /**
  * Create a new set of step function tools ready to be used in a step function.
  * This function should be run and a fresh set of tools provided every time a
@@ -18,42 +22,7 @@ const NonRetriableError_1 = require("./NonRetriableError");
  * An op stack (function state) is passed in as well as some mutable properties
  * that the tools can use to submit a new op.
  */
-const createStepTools = (client, state) => {
-    // Start referencing everything
-    state.tickOps = state.allFoundOps;
-    /**
-     * Create a unique hash of an operation using only a subset of the operation's
-     * properties; will never use `data` and will guarantee the order of the
-     * object so we don't rely on individual tools for that.
-     *
-     * If the operation already contains an ID, the current ID will be used
-     * instead, so that users can provide their own IDs.
-     */
-    const hashOp = (
-    /**
-     * The op to generate a hash from. We only use a subset of the op's
-     * properties when creating the hash.
-     */
-    op) => {
-        var _a, _b, _c, _d;
-        /**
-         * If the op already has an ID, we don't need to generate one. This allows
-         * users to specify their own IDs.
-         */
-        if (op.id) {
-            return op;
-        }
-        const obj = {
-            parent: (_b = (_a = state.currentOp) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : null,
-            op: op.op,
-            name: op.name,
-            opts: (_c = op.opts) !== null && _c !== void 0 ? _c : null,
-        };
-        const collisionHash = exports._internals.hashData(obj);
-        const pos = (state.tickOpHashes[collisionHash] =
-            ((_d = state.tickOpHashes[collisionHash]) !== null && _d !== void 0 ? _d : -1) + 1);
-        return Object.assign(Object.assign({}, op), { id: exports._internals.hashData(Object.assign({ pos }, obj)) });
-    };
+const createStepTools = (client, stepHandler) => {
     /**
      * A local helper used to create tools that can be used to submit an op.
      *
@@ -72,30 +41,9 @@ const createStepTools = (client, state) => {
      * Most simple tools will likely only need to define this.
      */
     matchOp, opts) => {
-        return ((...args) => {
-            if (state.nonStepFnDetected) {
-                if ((opts === null || opts === void 0 ? void 0 : opts.nonStepExecuteInline) && opts.fn) {
-                    return Promise.resolve(opts.fn(...args));
-                }
-                throw new NonRetriableError_1.NonRetriableError((0, errors_1.functionStoppedRunningErr)(errors_1.ErrCode.STEP_USED_AFTER_ASYNC));
-            }
-            if (state.executingStep) {
-                throw new NonRetriableError_1.NonRetriableError((0, errors_1.prettyError)({
-                    whatHappened: "Your function was stopped from running",
-                    why: "We detected that you have nested `step.*` tooling.",
-                    consequences: "Nesting `step.*` tooling is not supported.",
-                    stack: true,
-                    toFixNow: "Make sure you're not using `step.*` tooling inside of other `step.*` tooling. If you need to compose steps together, you can create a new async function and call it from within your step function, or use promise chaining.",
-                    otherwise: "For more information on step functions with Inngest, see https://www.inngest.com/docs/functions/multi-step",
-                    code: errors_1.ErrCode.NESTING_STEPS,
-                }));
-            }
-            state.hasUsedTools = true;
-            const opId = hashOp(matchOp(...args));
-            return new Promise((resolve, reject) => {
-                state.tickOps[opId.id] = Object.assign(Object.assign(Object.assign({}, opId), ((opts === null || opts === void 0 ? void 0 : opts.fn) ? { fn: () => { var _a; return (_a = opts.fn) === null || _a === void 0 ? void 0 : _a.call(opts, ...args); } } : {})), { resolve,
-                    reject, fulfilled: false });
-            });
+        return (async (...args) => {
+            const parsedArgs = args;
+            return stepHandler({ args: parsedArgs, matchOp, opts });
         });
     };
     /**
@@ -130,15 +78,16 @@ const createStepTools = (client, state) => {
          *
          * Returns a promise that will resolve once the event has been sent.
          */
-        sendEvent: createTool((_payload, opts) => {
+        sendEvent: createTool(({ id, name }) => {
             return {
-                id: opts === null || opts === void 0 ? void 0 : opts.id,
+                id,
                 op: types_1.StepOpCode.StepPlanned,
                 name: "sendEvent",
+                displayName: name !== null && name !== void 0 ? name : id,
             };
         }, {
             nonStepExecuteInline: true,
-            fn: (payload) => {
+            fn: (idOrOptions, payload) => {
                 return client.send(payload);
             },
         }),
@@ -151,22 +100,15 @@ const createStepTools = (client, state) => {
          * events, or to only wait a maximum amount of time before giving up and
          * returning `null` instead of any event data.
          */
-        waitForEvent: createTool((
-        /**
-         * The event name to wait for.
-         */
-        event, 
+        waitForEvent: createTool(({ id, name }, 
         /**
          * Options to control the event we're waiting for.
          */
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         opts) => {
             const matchOpts = {
                 timeout: (0, strings_1.timeStr)(typeof opts === "string" ? opts : opts.timeout),
             };
-            let id;
             if (typeof opts !== "string") {
-                id = opts === null || opts === void 0 ? void 0 : opts.id;
                 if (opts === null || opts === void 0 ? void 0 : opts.match) {
                     matchOpts.if = `event.${opts.match} == async.${opts.match}`;
                 }
@@ -177,8 +119,9 @@ const createStepTools = (client, state) => {
             return {
                 id,
                 op: types_1.StepOpCode.WaitForEvent,
-                name: event,
+                name: opts.event,
                 opts: matchOpts,
+                displayName: name !== null && name !== void 0 ? name : id,
             };
         }),
         /**
@@ -193,13 +136,14 @@ const createStepTools = (client, state) => {
          * of the `run` tool, meaning you can return and reason about return data
          * for next steps.
          */
-        run: createTool((name, _fn, opts) => {
+        run: createTool(({ id, name }) => {
             return {
-                id: opts === null || opts === void 0 ? void 0 : opts.id,
+                id,
                 op: types_1.StepOpCode.StepPlanned,
-                name,
+                name: id,
+                displayName: name !== null && name !== void 0 ? name : id,
             };
-        }, { fn: (_, fn) => fn() }),
+        }, { fn: (stepOptions, fn) => fn() }),
         /**
          * Wait a specified amount of time before continuing.
          *
@@ -210,15 +154,16 @@ const createStepTools = (client, state) => {
          *
          * To wait until a particular date, use `sleepUntil` instead.
          */
-        sleep: createTool((time, opts) => {
+        sleep: createTool(({ id, name }, time) => {
             /**
              * The presence of this operation in the returned stack indicates that the
              * sleep is over and we should continue execution.
              */
             return {
-                id: opts === null || opts === void 0 ? void 0 : opts.id,
+                id,
                 op: types_1.StepOpCode.Sleep,
                 name: (0, strings_1.timeStr)(time),
+                displayName: name !== null && name !== void 0 ? name : id,
             };
         }),
         /**
@@ -227,7 +172,7 @@ const createStepTools = (client, state) => {
          * To wait for a particular amount of time from now, always use `sleep`
          * instead.
          */
-        sleepUntil: createTool((time, opts) => {
+        sleepUntil: createTool(({ id, name }, time) => {
             const date = typeof time === "string" ? new Date(time) : time;
             /**
              * The presence of this operation in the returned stack indicates that the
@@ -235,9 +180,10 @@ const createStepTools = (client, state) => {
              */
             try {
                 return {
-                    id: opts === null || opts === void 0 ? void 0 : opts.id,
+                    id,
                     op: types_1.StepOpCode.Sleep,
                     name: date.toISOString(),
+                    displayName: name !== null && name !== void 0 ? name : id,
                 };
             }
             catch (err) {
@@ -255,11 +201,4 @@ const createStepTools = (client, state) => {
     return tools;
 };
 exports.createStepTools = createStepTools;
-const hashData = (op) => {
-    return (0, hash_js_1.sha1)().update((0, canonicalize_1.default)(op)).digest("hex");
-};
-/**
- * Exported for testing.
- */
-exports._internals = { hashData };
 //# sourceMappingURL=InngestStepTools.js.map