inngest 2.0.0-schemas.1 → 2.0.1

package/CHANGELOG.md

@@ -1,5 +1,78 @@
 # inngest
 
+## 2.0.1
+
+### Patch Changes
+
+- 3ef0b36: Add better visibility into serve handlers issues
+- 4226b85: Fix middleware `transformOutput` hook not running if an asynchronous, non-step function's body threw
+- cc3929d: Fix a very rare bug in which `step.sleep()` hashing could produce different IDs across different executions
+
+## 2.0.0
+
+### Major Changes
+
+- 4f29f5c: Removed `tools` parameter (breaking). This was marked as `@deprecated` in v1, but is being fully removed in v2. Use `step` instead.
+  See the [v2 migration guide](https://www.inngest.com/docs/sdk/migration#clearer-event-sending).
+- 4f29f5c: Renamed `throttle` to `rateLimit`.
+  See the [v2 migration guide](https://www.inngest.com/docs/sdk/migration#clearer-event-sending).
+- 4f29f5c: Added the ability to provide middleware when defining Inngest clients and functions, hooking into a client's lifecycle to add custom functionality like error monitoring, data transformations, and more.
+  See [Advanced: Middleware - Inngest Documentation](https://www.inngest.com/docs/reference/middleware/overview).
+- 4f29f5c: Removed ability to `serve()` without a client (breaking).
+  See the [v2 migration guide](https://www.inngest.com/docs/sdk/migration#clearer-event-sending).
+- 4f29f5c: Better event schema definitions (breaking), providing an extensible metho of creating and maintaining event payloads with a variety of native tools and third-party libraries.
+  See [Defining Event Payload Types - Inngest Documentation](https://www.inngest.com/docs/reference/client/create#defining-event-payload-types).
+- 4f29f5c: Removed some overloads of `inngest.send()` to provide a better TS experience when sending events (breaking).
+  See the [v2 migration guide](https://www.inngest.com/docs/sdk/migration#clearer-event-sending).
+
+### Minor Changes
+
+- 4f29f5c: Added a `logger` to Inngest functions in addition to allowing users to provide a custom logger to reliably push logs to external services and handle flushing on serverless environments.
+  See [Logging in Inngest - Inngest Documentation](https://www.inngest.com/docs/guides/logging).
+- 4f29f5c: Add `GetEvents<>` export which can be used to pull final event types from an Inngest client.
+  See [Defining Event Payload Types](https://www.inngest.com/docs/reference/client/create#defining-event-payload-types).
+- 4f29f5c: Add ability to provide `concurrency: { limit: number }` in function config, ready for more config options.
+
+### Patch Changes
+
+- b62cd6d: Update landing page vite dependency to v3.2.7
+
+## 1.9.4
+
+### Patch Changes
+
+- 7d025d6: Fix `NonRetriableError` not working when thrown from within a step
+
+## 1.9.3
+
+### Patch Changes
+
+- 64c397e: Handle circular JSON errors while stringifying across the SDK
+
+## 1.9.2
+
+### Patch Changes
+
+- 71b1a17: Fix Vercel platform check to support local dev while using `vercel env pull`
+
+## 1.9.1
+
+### Patch Changes
+
+- 49ddbb5: Add platform deploy checks
+
+## 1.9.0
+
+### Minor Changes
+
+- 48d94a2: Allow user provided logger to be used within functions (experimental)
+
+## 1.8.5
+
+### Patch Changes
+
+- 34f9ee8: INN-1253 Show actionable error when steps are nested
+
 ## 1.8.4
 
 ### Patch Changes

package/README.md

@@ -179,6 +179,13 @@ yarn add ./inngest.tgz && framework dev
 
 To release to production, we use [Changesets](https://github.com/changesets/changesets). This means that releasing and changelog generation is all managed through PRs, where a bot will guide you through the process of announcing changes in PRs and releasing them once merged to `main`.
 
+#### Legacy versions
+
+Merging and releasing to previous major versions of the SDK is also supported.
+
+- Add a `backport v*.x` label (e.g. `backport v1.x`) to a PR to have a backport PR generated when the initial PR is merged.
+- Merging into a `v*.x` branch creates a release PR (named **Release v1.x**, for example) the same as the `main` branch. Simply merge to release.
+
 #### Snapshot versions
 
 If a local `inngest.tgz` isn't ideal, we can release a tagged version to npm. For now, this is relatively manual. For this, please ensure you are in an open PR branch for observability.

package/components/EventSchemas.d.ts

@@ -2,6 +2,13 @@ import { type Simplify } from "type-fest";
 import { type z } from "zod";
 import { type IsStringLiteral } from "../helpers/types";
 import { type EventPayload } from "../types";
+/**
+ * Declares the shape of an event schema we expect from the user. This may be
+ * different to what a user is sending us depending on the supported library,
+ * but this standard format is what we require as the end result.
+ *
+ * @internal
+ */
 export type StandardEventSchema = {
     data: Record<string, any>;
     user?: Record<string, any>;
@@ -28,7 +35,7 @@ export type ZodEventSchemas = Record<string, {
  * of information required.
  *
  * It purposefully uses slightly more complex (read: verbose) mapped types to
- * flatten the output.
+ * flatten the output and preserve comments.
  *
  * @public
  */

package/components/EventSchemas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EventSchemas.d.ts","sourceRoot":"","sources":["../../src/components/EventSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,UAAU,CAAC;AAE7C,MAAM,MAAM,mBAAmB,GAAG;IAEhC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE1B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAClC,MAAM,EACN;IACE,IAAI,EAAE,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,IAAI,CAAC,EAAE,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;CAClC,CACF,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,4BAA4B,CAAC,CAAC,IAAI,QAAQ,CAAC;KACpD,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,GAAG;SACtB,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG;YAAE,IAAI,EAAE,CAAC,CAAA;SAAE,CAAC,GAAG,CAAC,IAAI,CACxE,YAAY,EACZ,MAAM,CAAC,CAAC,CAAC,CAAC,CACX,GACC,CAAC,CAAC,CAAC,CAAC,GAAG;YAAE,IAAI,EAAE,CAAC,CAAA;SAAE,CAAC,CAAC,EAAE,CAAC;KAC1B;CACF,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,OAAO,CACjB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,EAC1C,IAAI,SAAS,oBAAoB,IAC/B,eAAe,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,IAAI,GAClD,QAAQ,CACN,IAAI,CAAC,KAAK,EAAE,MAAM,4BAA4B,CAAC,IAAI,CAAC,CAAC,GACnD,4BAA4B,CAAC,IAAI,CAAC,CACrC,GACD,4BAA4B,CAAC,IAAI,CAAC,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9D;;OAEG;IACI,aAAa,CAAC,CAAC,SAAS,oBAAoB;IAInD;;;;;;;;;;;;;;;;;;OAkBG;IACI,UAAU,CAAC,CAAC,SAAS,oBAAoB;IAIhD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,SAAS,CAAC,CAAC,SAAS;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,mBAAmB;;;IAWjE;;;;;;;;;;;;;;;;;;OAkBG;IAEI,OAAO,CAAC,CAAC,SAAS,eAAe,EAAE,OAAO,EAAE,CAAC;CAerD"}
+{"version":3,"file":"EventSchemas.d.ts","sourceRoot":"","sources":["../../src/components/EventSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,UAAU,CAAC;AAE7C;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAEhC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE1B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAClC,MAAM,EACN;IACE,IAAI,EAAE,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,IAAI,CAAC,EAAE,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;CAClC,CACF,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,4BAA4B,CAAC,CAAC,IAAI,QAAQ,CAAC;KACpD,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,GAAG;SACtB,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG;YAAE,IAAI,EAAE,CAAC,CAAA;SAAE,CAAC,GAAG,CAAC,IAAI,CACxE,YAAY,EACZ,MAAM,CAAC,CAAC,CAAC,CAAC,CACX,GACC,CAAC,CAAC,CAAC,CAAC,GAAG;YAAE,IAAI,EAAE,CAAC,CAAA;SAAE,CAAC,CAAC,EAAE,CAAC;KAC1B;CACF,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,OAAO,CACjB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,EAC1C,IAAI,SAAS,oBAAoB,IAC/B,eAAe,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,IAAI,GAClD,QAAQ,CACN,IAAI,CAAC,KAAK,EAAE,MAAM,4BAA4B,CAAC,IAAI,CAAC,CAAC,GACnD,4BAA4B,CAAC,IAAI,CAAC,CACrC,GACD,4BAA4B,CAAC,IAAI,CAAC,CAAC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9D;;OAEG;IACI,aAAa,CAAC,CAAC,SAAS,oBAAoB;IAInD;;;;;;;;;;;;;;;;;;OAkBG;IACI,UAAU,CAAC,CAAC,SAAS,oBAAoB;IAIhD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,SAAS,CAAC,CAAC,SAAS;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,mBAAmB;;;IAWjE;;;;;;;;;;;;;;;;;;OAkBG;IAEI,OAAO,CAAC,CAAC,SAAS,eAAe,EAAE,OAAO,EAAE,CAAC;CAerD"}

package/components/EventSchemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"EventSchemas.js","sourceRoot":"","sources":["../../src/components/EventSchemas.ts"],"names":[],"mappings":";;;AAsEA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAa,YAAY;IACvB;;OAEG;IACI,aAAa;QAClB,OAAO,IAAI,YAAY,EAAiB,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,UAAU;QACf,OAAO,IAAI,YAAY,EAAiB,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,SAAS;QACd,OAAO,IAAI,YAAY,EAOpB,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,6DAA6D;IACtD,OAAO,CAA4B,OAAU;QAClD,OAAO,IAAI,YAAY,EAYpB,CAAC;IACN,CAAC;CACF;AAvGD,oCAuGC"}
+{"version":3,"file":"EventSchemas.js","sourceRoot":"","sources":["../../src/components/EventSchemas.ts"],"names":[],"mappings":";;;AA6EA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAa,YAAY;IACvB;;OAEG;IACI,aAAa;QAClB,OAAO,IAAI,YAAY,EAAiB,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,UAAU;QACf,OAAO,IAAI,YAAY,EAAiB,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,SAAS;QACd,OAAO,IAAI,YAAY,EAOpB,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,6DAA6D;IACtD,OAAO,CAA4B,OAAU;QAClD,OAAO,IAAI,YAAY,EAYpB,CAAC;IACN,CAAC;CACF;AAvGD,oCAuGC"}

package/components/Inngest.d.ts

@@ -1,7 +1,9 @@
-import { type PartialK, type SendEventPayload, type SingleOrArray } from "../helpers/types";
-import { type ClientOptions, type EventNameFromTrigger, type EventPayload, type FailureEventArgs, type FunctionOptions, type FunctionTrigger, type Handler, type ShimmedFns, type TriggerOptions } from "../types";
+import { type SendEventPayload } from "../helpers/types";
+import { type Logger } from "../middleware/logger";
+import { type ClientOptions, type EventNameFromTrigger, type EventPayload, type FailureEventArgs, type FunctionOptions, type FunctionTrigger, type Handler, type MiddlewareStack, type ShimmedFns, type TriggerOptions } from "../types";
 import { type EventSchemas } from "./EventSchemas";
 import { InngestFunction } from "./InngestFunction";
+import { InngestMiddleware, type MiddlewareStackRunInputMutation } from "./InngestMiddleware";
 /**
  * Given a set of client options for Inngest, return the event types that can
  * be sent or received.
@@ -13,23 +15,20 @@ export type EventsFromOpts<TOpts extends ClientOptions> = TOpts["schemas"] exten
  * 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.
+ * To provide event typing, see {@link EventSchemas}.
  *
  * ```ts
- * const inngest = new Inngest<Events>({ name: "My App" });
+ * const inngest = new Inngest({ name: "My App" });
  *
- * // or to provide custom events too
- * const inngest = new Inngest<
- *   Events & {
+ * // or to provide event typing too
+ * const inngest = new Inngest({
+ *   name: "My App",
+ *   schemas: new EventSchemas().fromRecord<{
  *     "app/user.created": {
- *       name: "app/user.created";
- *       data: {
- *         foo: boolean;
- *       };
+ *       data: { userId: string };
  *     };
- *   }
- * >({ name: "My App" });
+ *   }>(),
+ * });
  * ```
  *
  * @public
@@ -55,30 +54,38 @@ export declare class Inngest<TOpts extends ClientOptions = ClientOptions> {
     private inngestApiUrl;
     private readonly headers;
     private readonly fetch;
+    private readonly logger;
+    /**
+     * A promise that resolves when the middleware stack has been initialized and
+     * the client is ready to be used.
+     */
+    private readonly middleware;
     /**
      * 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.
+     * To provide event typing, see {@link EventSchemas}.
      *
      * ```ts
-     * const inngest = new Inngest<Events>({ name: "My App" });
+     * const inngest = new Inngest({ name: "My App" });
      *
-     * // or to provide custom events too
-     * const inngest = new Inngest<
-     *   Events & {
+     * // or to provide event typing too
+     * const inngest = new Inngest({
+     *   name: "My App",
+     *   schemas: new EventSchemas().fromRecord<{
      *     "app/user.created": {
-     *       name: "app/user.created";
-     *       data: {
-     *         foo: boolean;
-     *       };
+     *       data: { userId: string };
      *     };
-     *   }
-     * >({ name: "My App" });
+     *   }>(),
+     * });
      * ```
      */
-    constructor({ name, eventKey, inngestBaseUrl, fetch, env, }: TOpts);
+    constructor({ name, eventKey, inngestBaseUrl, fetch, env, logger, middleware, }: TOpts);
+    /**
+     * Initialize all passed middleware, running the `register` function on each
+     * in sequence and returning the requested hook registrations.
+     */
+    private initializeMiddleware;
     /**
      * Set the event key for this instance of Inngest. This is useful if for some
      * reason the key is not available at time of instantiation or present in the
@@ -91,31 +98,6 @@ export declare class Inngest<TOpts extends ClientOptions = ClientOptions> {
      * in the `INNGEST_EVENT_KEY` environment variable.
      */
     eventKey: string): void;
-    /**
-     * 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 EventsFromOpts<TOpts>>(name: Event, payload: SingleOrArray<PartialK<Omit<EventsFromOpts<TOpts>[Event], "name" | "v">, "ts">>): Promise<void>;
     /**
      * Send one or many events to Inngest. Takes an entire payload (including
      * name) as each input.
@@ -132,16 +114,19 @@ export declare class Inngest<TOpts extends ClientOptions = ClientOptions> {
      * so:
      *
      * ```ts
-     * const inngest = new Inngest<Events & {
-     *   "my/event": {
-     *     name: "my/event";
-     *     data: { bar: string; };
-     *   }
-     * }>("My App", "API_KEY");
+     * const inngest = new Inngest({
+     *   name: "My App",
+     *   schemas: new EventSchemas().fromRecord<{
+     *     "my/event": {
+     *       name: "my/event";
+     *       data: { bar: string };
+     *     };
+     *   }>(),
+     * });
      * ```
      */
     send<Payload extends SendEventPayload<EventsFromOpts<TOpts>>>(payload: Payload): Promise<void>;
-    createFunction<TFns extends Record<string, unknown>, TTrigger extends TriggerOptions<keyof EventsFromOpts<TOpts> & string>, TShimmedFns extends Record<string, (...args: any[]) => any> = ShimmedFns<TFns>, TTriggerName extends keyof EventsFromOpts<TOpts> & string = EventNameFromTrigger<EventsFromOpts<TOpts>, TTrigger>>(nameOrOpts: string | (Omit<FunctionOptions<EventsFromOpts<TOpts>, TTriggerName>, "fns" | "onFailure"> & {
+    createFunction<TFns extends Record<string, unknown>, TMiddleware extends MiddlewareStack, TTrigger extends TriggerOptions<keyof EventsFromOpts<TOpts> & string>, TShimmedFns extends Record<string, (...args: any[]) => any> = ShimmedFns<TFns>, TTriggerName extends keyof EventsFromOpts<TOpts> & string = EventNameFromTrigger<EventsFromOpts<TOpts>, TTrigger>>(nameOrOpts: string | (Omit<FunctionOptions<EventsFromOpts<TOpts>, TTriggerName>, "fns" | "onFailure" | "middleware"> & {
         /**
          * Pass in an object of functions that will be wrapped in Inngest
          * tooling and passes to your handler. This wrapping ensures that each
@@ -184,6 +169,57 @@ export declare class Inngest<TOpts extends ClientOptions = ClientOptions> {
          * regular handler.
          */
         onFailure?: Handler<TOpts, EventsFromOpts<TOpts>, TTriggerName, TShimmedFns, FailureEventArgs<EventsFromOpts<TOpts>[TTriggerName]>>;
-    }), trigger: TTrigger, handler: Handler<TOpts, EventsFromOpts<TOpts>, TTriggerName, TShimmedFns>): InngestFunction<TOpts, EventsFromOpts<TOpts>, FunctionTrigger<keyof EventsFromOpts<TOpts> & string>, FunctionOptions<EventsFromOpts<TOpts>, keyof EventsFromOpts<TOpts> & string>>;
+        /**
+         * TODO
+         */
+        middleware?: TMiddleware;
+    }), trigger: TTrigger, handler: Handler<TOpts, EventsFromOpts<TOpts>, TTriggerName, TShimmedFns, MiddlewareStackRunInputMutation<{}, typeof builtInMiddleware> & MiddlewareStackRunInputMutation<{}, NonNullable<TOpts["middleware"]>> & MiddlewareStackRunInputMutation<{}, TMiddleware>>): InngestFunction<TOpts, EventsFromOpts<TOpts>, FunctionTrigger<keyof EventsFromOpts<TOpts> & string>, FunctionOptions<EventsFromOpts<TOpts>, keyof EventsFromOpts<TOpts> & string>>;
 }
+/**
+ * Default middleware that is included in every client, placed after the user's
+ * middleware on the client but before function-level middleware.
+ *
+ * It is defined here to ensure that comments are included in the generated TS
+ * definitions. Without this, we infer the stack of built-in middleware without
+ * comments, losing a lot of value.
+ *
+ * If this is moved, please ensure that using this package in another project
+ * can correctly access comments on mutated input and output.
+ */
+declare const builtInMiddleware: [InngestMiddleware<{
+    name: string;
+    init({ client }: {
+        client: Inngest<any>;
+        fn?: InngestFunction<any, any, any, any> | undefined;
+    }): {
+        onFunctionRun(arg: Readonly<import("type-fest").Simplify<Omit<Readonly<{
+            ctx: Record<string, unknown> & Readonly<import("../types").BaseContext<ClientOptions, string, Record<string, (...args: unknown[]) => unknown>>>;
+            steps: Readonly<Omit<{
+                data?: any;
+                error?: any;
+                id: string;
+            }, "id">>[];
+            fn: InngestFunction<any, any, any, any>;
+        }>, "ctx"> & {
+            ctx: Pick<Record<string, unknown> & Readonly<import("../types").BaseContext<ClientOptions, string, Record<string, (...args: unknown[]) => unknown>>>, "event" | "runId">;
+        }>>): {
+            transformInput(): {
+                ctx: {
+                    /**
+                     * The passed in logger from the user.
+                     * Defaults to a console logger if not provided.
+                     */
+                    logger: Logger;
+                };
+            };
+            beforeExecution(): void;
+            transformOutput({ result: { error } }: {
+                result: Readonly<Pick<import("../types").OutgoingOp, "data" | "error">>;
+                step?: Readonly<Omit<import("../types").OutgoingOp, "id">> | undefined;
+            }): void;
+            beforeResponse(): Promise<void>;
+        };
+    };
+}>];
+export {};
 //# sourceMappingURL=Inngest.d.ts.map

package/components/Inngest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Inngest.d.ts","sourceRoot":"","sources":["../../src/components/Inngest.ts"],"names":[],"mappings":"AAUA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,OAAO,EACZ,KAAK,UAAU,EACf,KAAK,cAAc,EACpB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAOpD;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,SAAS,aAAa,IACpD,KAAK,CAAC,SAAS,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAC1C,CAAC,GACD,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,OAAO,CAAC,KAAK,SAAS,aAAa,GAAG,aAAa;;IAC9D;;;OAGG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAM;IAEtB;;OAEG;IACH,SAAgB,cAAc,EAAE,GAAG,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,aAAa,CAAyD;IAE9E,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IAEjD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAE/B;;;;;;;;;;;;;;;;;;;;;;OAsBG;gBACS,EACV,IAAI,EACJ,QAAQ,EACR,cAAkC,EAClC,KAAK,EACL,GAAG,GACJ,EAAE,KAAK;IAmER;;;;OAIG;IACI,WAAW;IAChB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,GACf,IAAI;IAKP;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,IAAI,CAAC,KAAK,SAAS,MAAM,cAAc,CAAC,KAAK,CAAC,EACzD,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,aAAa,CACpB,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC,EAAE,IAAI,CAAC,CACjE,GACA,OAAO,CAAC,IAAI,CAAC;IAChB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,IAAI,CAAC,OAAO,SAAS,gBAAgB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,EACvE,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,IAAI,CAAC;IAkGT,cAAc,CACnB,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,QAAQ,SAAS,cAAc,CAAC,MAAM,cAAc,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,EACrE,WAAW,SAAS,MAAM,CACxB,MAAM,EAEN,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CACxB,GAAG,UAAU,CAAC,IAAI,CAAC,EACpB,YAAY,SAAS,MAAM,cAAc,CAAC,KAAK,CAAC,GAC9C,MAAM,GAAG,oBAAoB,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,EAEhE,UAAU,EACN,MAAM,GACN,CAAC,IAAI,CACH,eAAe,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC,EACpD,KAAK,GAAG,WAAW,CACpB,GAAG;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+BG;QACH,GAAG,CAAC,EAAE,IAAI,CAAC;QAEX;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,OAAO,CACjB,KAAK,EACL,cAAc,CAAC,KAAK,CAAC,EACrB,YAAY,EACZ,WAAW,EACX,gBAAgB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CACtD,CAAC;KACH,CAAC,EACN,OAAO,EAAE,QAAQ,EACjB,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,WAAW,CAAC,GACxE,eAAe,CAChB,KAAK,EACL,cAAc,CAAC,KAAK,CAAC,EACrB,eAAe,CAAC,MAAM,cAAc,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,EACrD,eAAe,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,cAAc,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAC7E;CAgBF"}
+{"version":3,"file":"Inngest.d.ts","sourceRoot":"","sources":["../../src/components/Inngest.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAA8B,KAAK,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,OAAO,EACZ,KAAK,eAAe,EACpB,KAAK,UAAU,EACf,KAAK,cAAc,EACpB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EACL,iBAAiB,EAKjB,KAAK,+BAA+B,EACrC,MAAM,qBAAqB,CAAC;AAO7B;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,SAAS,aAAa,IACpD,KAAK,CAAC,SAAS,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAC1C,CAAC,GACD,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,OAAO,CAAC,KAAK,SAAS,aAAa,GAAG,aAAa;;IAC9D;;;OAGG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAM;IAEtB;;OAEG;IACH,SAAgB,cAAc,EAAE,GAAG,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,aAAa,CAAyD;IAE9E,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IAEjD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAE/B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAsC;IAEjE;;;;;;;;;;;;;;;;;;;OAmBG;gBACS,EACV,IAAI,EACJ,QAAQ,EACR,cAAkC,EAClC,KAAK,EACL,GAAG,EACH,MAA4B,EAC5B,UAAU,GACX,EAAE,KAAK;IAsCR;;;OAGG;YACW,oBAAoB;IA8DlC;;;;OAIG;IACI,WAAW;IAChB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,GACf,IAAI;IAKP;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,IAAI,CAAC,OAAO,SAAS,gBAAgB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,EACvE,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,IAAI,CAAC;IAoFT,cAAc,CACnB,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,WAAW,SAAS,eAAe,EACnC,QAAQ,SAAS,cAAc,CAAC,MAAM,cAAc,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,EACrE,WAAW,SAAS,MAAM,CACxB,MAAM,EAEN,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CACxB,GAAG,UAAU,CAAC,IAAI,CAAC,EACpB,YAAY,SAAS,MAAM,cAAc,CAAC,KAAK,CAAC,GAC9C,MAAM,GAAG,oBAAoB,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,EAEhE,UAAU,EACN,MAAM,GACN,CAAC,IAAI,CACH,eAAe,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC,EACpD,KAAK,GAAG,WAAW,GAAG,YAAY,CACnC,GAAG;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+BG;QACH,GAAG,CAAC,EAAE,IAAI,CAAC;QAEX;;;;;;;WAOG;QACH,SAAS,CAAC,EAAE,OAAO,CACjB,KAAK,EACL,cAAc,CAAC,KAAK,CAAC,EACrB,YAAY,EACZ,WAAW,EACX,gBAAgB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CACtD,CAAC;QAEF;;WAEG;QACH,UAAU,CAAC,EAAE,WAAW,CAAC;KAC1B,CAAC,EACN,OAAO,EAAE,QAAQ,EACjB,OAAO,EAAE,OAAO,CACd,KAAK,EACL,cAAc,CAAC,KAAK,CAAC,EACrB,YAAY,EACZ,WAAW,EAEX,+BAA+B,CAAC,EAAE,EAAE,OAAO,iBAAiB,CAAC,GAE3D,+BAA+B,CAAC,EAAE,EAAE,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,GAErE,+BAA+B,CAAC,EAAE,EAAE,WAAW,CAAC,CACnD,GACA,eAAe,CAChB,KAAK,EACL,cAAc,CAAC,KAAK,CAAC,EACrB,eAAe,CAAC,MAAM,cAAc,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,EACrD,eAAe,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,cAAc,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAC7E;CAgBF;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;oBAkCL;;;uBAGG;;;;;;;;;;;;GAqBnB,CAAC"}

package/components/Inngest.js

@@ -11,28 +11,28 @@ const consts_1 = require("../helpers/consts");
 const devserver_1 = require("../helpers/devserver");
 const env_1 = require("../helpers/env");
 const errors_1 = require("../helpers/errors");
+const strings_1 = require("../helpers/strings");
+const logger_1 = require("../middleware/logger");
 const InngestFunction_1 = require("./InngestFunction");
+const InngestMiddleware_1 = require("./InngestMiddleware");
 /**
  * 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.
+ * To provide event typing, see {@link EventSchemas}.
  *
  * ```ts
- * const inngest = new Inngest<Events>({ name: "My App" });
+ * const inngest = new Inngest({ name: "My App" });
  *
- * // or to provide custom events too
- * const inngest = new Inngest<
- *   Events & {
+ * // or to provide event typing too
+ * const inngest = new Inngest({
+ *   name: "My App",
+ *   schemas: new EventSchemas().fromRecord<{
  *     "app/user.created": {
- *       name: "app/user.created";
- *       data: {
- *         foo: boolean;
- *       };
+ *       data: { userId: string };
  *     };
- *   }
- * >({ name: "My App" });
+ *   }>(),
+ * });
  * ```
  *
  * @public
@@ -42,26 +42,23 @@ class Inngest {
      * 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.
+     * To provide event typing, see {@link EventSchemas}.
      *
      * ```ts
-     * const inngest = new Inngest<Events>({ name: "My App" });
+     * const inngest = new Inngest({ name: "My App" });
      *
-     * // or to provide custom events too
-     * const inngest = new Inngest<
-     *   Events & {
+     * // or to provide event typing too
+     * const inngest = new Inngest({
+     *   name: "My App",
+     *   schemas: new EventSchemas().fromRecord<{
      *     "app/user.created": {
-     *       name: "app/user.created";
-     *       data: {
-     *         foo: boolean;
-     *       };
+     *       data: { userId: string };
      *     };
-     *   }
-     * >({ name: "My App" });
+     *   }>(),
+     * });
      * ```
      */
-    constructor({ name, eventKey, inngestBaseUrl = "https://inn.gs/", fetch, env, }) {
+    constructor({ name, eventKey, inngestBaseUrl = "https://inn.gs/", fetch, env, logger = new logger_1.DefaultLogger(), middleware, }) {
         _Inngest_instances.add(this);
         /**
          * Inngest event key, used to send events to Inngest Cloud.
@@ -92,6 +89,30 @@ class Inngest {
             inngestEnv: env,
         });
         this.fetch = (0, env_1.getFetch)(fetch);
+        this.logger = logger;
+        this.middleware = this.initializeMiddleware([
+            ...builtInMiddleware,
+            ...(middleware || []),
+        ]);
+    }
+    /**
+     * Initialize all passed middleware, running the `register` function on each
+     * in sequence and returning the requested hook registrations.
+     */
+    async initializeMiddleware(middleware = [], opts) {
+        var _a;
+        /**
+         * Wait for the prefix stack to run first; do not trigger ours before this
+         * is complete.
+         */
+        const prefix = await ((_a = opts === null || opts === void 0 ? void 0 : opts.prefixStack) !== null && _a !== void 0 ? _a : []);
+        const stack = middleware.reduce(async (acc, m) => {
+            // Be explicit about waiting for the previous middleware to finish
+            const prev = await acc;
+            const next = await m.init(Object.assign({ client: this }, opts === null || opts === void 0 ? void 0 : opts.registerInput));
+            return [...prev, next];
+        }, Promise.resolve([]));
+        return [...prefix, ...(await stack)];
     }
     /**
      * Set the event key for this instance of Inngest. This is useful if for some
@@ -108,7 +129,43 @@ class Inngest {
         this.eventKey = eventKey;
         this.inngestApiUrl = new URL(`e/${this.eventKey}`, this.inngestBaseUrl);
     }
-    async send(nameOrPayload, maybePayload) {
+    /**
+     * 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({
+     *   name: "My App",
+     *   schemas: new EventSchemas().fromRecord<{
+     *     "my/event": {
+     *       name: "my/event";
+     *       data: { bar: string };
+     *     };
+     *   }>(),
+     * });
+     * ```
+     */
+    async send(payload) {
+        var _a, _b;
+        const hooks = await (0, InngestMiddleware_1.getHookStack)(this.middleware, "onSendEvent", undefined, {
+            transformInput: (prev, output) => {
+                return Object.assign(Object.assign({}, prev), output);
+            },
+            transformOutput: (prev, _output) => {
+                return prev;
+            },
+        });
         if (!this.eventKey) {
             throw new Error((0, errors_1.prettyError)({
                 whatHappened: "Failed to send event",
@@ -117,26 +174,16 @@ class Inngest {
                 toFixNow: errors_1.fixEventKeyMissingSteps,
             }));
         }
-        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]
-                    : []);
+        let payloads = Array.isArray(payload)
+            ? payload
+            : payload
+                ? [payload]
+                : [];
+        const inputChanges = await ((_a = hooks.transformInput) === null || _a === void 0 ? void 0 : _a.call(hooks, {
+            payloads: [...payloads],
+        }));
+        if (inputChanges === null || inputChanges === void 0 ? void 0 : inputChanges.payloads) {
+            payloads = [...inputChanges.payloads];
         }
         /**
          * It can be valid for a user to send an empty list of events; if this
@@ -154,7 +201,7 @@ class Inngest {
         // When sending events, check if the dev server is available.  If so, use the
         // dev server.
         let url = this.inngestApiUrl.href;
-        if (!(0, env_1.isProd)()) {
+        if (!(0, env_1.skipDevServer)()) {
             const host = (0, env_1.devServerHost)();
             // If the dev server host env var has been set we always want to use
             // the dev server - even if it's down.  Otherwise, optimistically use
@@ -165,11 +212,11 @@ class Inngest {
         }
         const response = await this.fetch(url, {
             method: "POST",
-            body: JSON.stringify(payloads),
+            body: (0, strings_1.stringify)(payloads),
             headers: Object.assign({}, this.headers),
         });
         if (response.status >= 200 && response.status < 300) {
-            return;
+            return void (await ((_b = hooks.transformOutput) === null || _b === void 0 ? void 0 : _b.call(hooks, { payloads: [...payloads] })));
         }
         throw await __classPrivateFieldGet(this, _Inngest_instances, "m", _Inngest_getResponseError).call(this, response);
     }
@@ -216,4 +263,68 @@ async function _Inngest_getResponseError(response) {
     }
     return new Error(`Inngest API Error: ${response.status} ${errorMessage}`);
 };
+/**
+ * Default middleware that is included in every client, placed after the user's
+ * middleware on the client but before function-level middleware.
+ *
+ * It is defined here to ensure that comments are included in the generated TS
+ * definitions. Without this, we infer the stack of built-in middleware without
+ * comments, losing a lot of value.
+ *
+ * If this is moved, please ensure that using this package in another project
+ * can correctly access comments on mutated input and output.
+ */
+const builtInMiddleware = ((m) => m)([
+    new InngestMiddleware_1.InngestMiddleware({
+        name: "Inngest: Logger",
+        init({ client }) {
+            return {
+                onFunctionRun(arg) {
+                    const { ctx } = arg;
+                    const metadata = {
+                        runID: ctx.runId,
+                        eventName: ctx.event.name,
+                        functionName: arg.fn.name,
+                    };
+                    let providedLogger = client["logger"];
+                    // create a child logger if the provided logger has child logger implementation
+                    try {
+                        if ("child" in providedLogger) {
+                            providedLogger = providedLogger.child(metadata);
+                        }
+                    }
+                    catch (err) {
+                        console.error('failed to create "childLogger" with error: ', err);
+                        // no-op
+                    }
+                    const logger = new logger_1.ProxyLogger(providedLogger);
+                    return {
+                        transformInput() {
+                            return {
+                                ctx: {
+                                    /**
+                                     * The passed in logger from the user.
+                                     * Defaults to a console logger if not provided.
+                                     */
+                                    logger: logger,
+                                },
+                            };
+                        },
+                        beforeExecution() {
+                            logger.enable();
+                        },
+                        transformOutput({ result: { error } }) {
+                            if (error) {
+                                logger.error(error);
+                            }
+                        },
+                        async beforeResponse() {
+                            await logger.flush();
+                        },
+                    };
+                },
+            };
+        },
+    }),
+]);
 //# sourceMappingURL=Inngest.js.map