V3

packages/inngest/etc/inngest.api.md

@@ -13,14 +13,14 @@ export interface ClientOptions {
     env?: string;
     eventKey?: string;
     fetch?: typeof fetch;
+    id: string;
     inngestBaseUrl?: string;
     // Warning: (ae-forgotten-export) The symbol "Logger" needs to be exported by the entry point index.d.ts
     logger?: Logger;
     // Warning: (ae-forgotten-export) The symbol "MiddlewareStack" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
     middleware?: MiddlewareStack;
-    name: string;
     schemas?: EventSchemas<Record<string, EventPayload>>;
 }
 
@@ -98,12 +98,10 @@ export interface FunctionOptions<Events extends Record<string, EventPayload>, Ev
         limit: number;
         key?: string;
     };
-    // (undocumented)
-    fns?: Record<string, unknown>;
-    id?: string;
+    id: string;
     idempotency?: string;
     middleware?: MiddlewareStack;
-    name: string;
+    name?: string;
     // (undocumented)
     onFailure?: (...args: unknown[]) => unknown;
     rateLimit?: {
@@ -114,8 +112,10 @@ export interface FunctionOptions<Events extends Record<string, EventPayload>, Ev
     retries?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20;
 }
 
+// Warning: (ae-forgotten-export) The symbol "AnyInngest" needs to be exported by the entry point index.d.ts
+//
 // @public
-export type GetEvents<T extends Inngest<any>> = T extends Inngest<infer U> ? EventsFromOpts<U> : never;
+export type GetEvents<T extends AnyInngest> = T extends Inngest<infer U> ? EventsFromOpts<U> : never;
 
 // @public
 export enum headerKeys {
@@ -135,8 +135,7 @@ export enum headerKeys {
 
 // @public
 export class Inngest<TOpts extends ClientOptions = ClientOptions> {
-    constructor({ name, eventKey, inngestBaseUrl, fetch, env, logger, middleware, }: TOpts);
-    // Warning: (ae-forgotten-export) The symbol "ShimmedFns" needs to be exported by the entry point index.d.ts
+    constructor({ id, eventKey, inngestBaseUrl, fetch, env, logger, middleware, }: TOpts);
     // Warning: (ae-forgotten-export) The symbol "ExclusiveKeys" needs to be exported by the entry point index.d.ts
     // Warning: (ae-forgotten-export) The symbol "Handler" needs to be exported by the entry point index.d.ts
     // Warning: (ae-forgotten-export) The symbol "ExtendWithMiddleware" needs to be exported by the entry point index.d.ts
@@ -145,21 +144,20 @@ export class Inngest<TOpts extends ClientOptions = ClientOptions> {
     // Warning: (ae-forgotten-export) The symbol "FunctionTrigger" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
-    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 | ExclusiveKeys<Omit<FunctionOptions<EventsFromOpts<TOpts>, TTriggerName>, "fns" | "onFailure" | "middleware"> & {
-        fns?: TFns;
-        onFailure?: Handler<TOpts, EventsFromOpts<TOpts>, TTriggerName, TShimmedFns, ExtendWithMiddleware<[
+    createFunction<TMiddleware extends MiddlewareStack, TTrigger extends TriggerOptions<keyof EventsFromOpts<TOpts> & string>, TTriggerName extends keyof EventsFromOpts<TOpts> & string = EventNameFromTrigger<EventsFromOpts<TOpts>, TTrigger>>(options: ExclusiveKeys<Omit<FunctionOptions<EventsFromOpts<TOpts>, TTriggerName>, "onFailure" | "middleware"> & {
+        onFailure?: Handler<TOpts, EventsFromOpts<TOpts>, TTriggerName, ExtendWithMiddleware<[
         typeof builtInMiddleware,
         NonNullable<TOpts["middleware"]>,
         TMiddleware
         ], FailureEventArgs<EventsFromOpts<TOpts>[TTriggerName]>>>;
         middleware?: TMiddleware;
-    }, "batchEvents", "cancelOn" | "rateLimit">, trigger: TTrigger, handler: Handler<TOpts, EventsFromOpts<TOpts>, TTriggerName, TShimmedFns, ExtendWithMiddleware<[
+    }, "batchEvents", "cancelOn" | "rateLimit">, trigger: TTrigger, handler: Handler<TOpts, EventsFromOpts<TOpts>, TTriggerName, ExtendWithMiddleware<[
     typeof builtInMiddleware,
     NonNullable<TOpts["middleware"]>,
     TMiddleware
     ]>>): InngestFunction<TOpts, EventsFromOpts<TOpts>, FunctionTrigger<keyof EventsFromOpts<TOpts> & string>, FunctionOptions<EventsFromOpts<TOpts>, keyof EventsFromOpts<TOpts> & string>>;
+    readonly id: string;
     readonly inngestBaseUrl: URL;
-    readonly name: string;
     // Warning: (ae-forgotten-export) The symbol "SendEventPayload" needs to be exported by the entry point index.d.ts
     send<Payload extends SendEventPayload<EventsFromOpts<TOpts>>>(payload: Payload): Promise<void>;
     setEventKey(
@@ -171,10 +169,11 @@ export class Inngest<TOpts extends ClientOptions = ClientOptions> {
 //
 // @public
 export class InngestCommHandler<H extends Handler_2, TResTransform extends (res: ActionResponse<string>, ...args: Parameters<H>) => any, TStreamTransform extends (res: ActionResponse<ReadableStream>, ...args: Parameters<H>) => any> {
+    // Warning: (ae-forgotten-export) The symbol "AnyInngestFunction" needs to be exported by the entry point index.d.ts
     constructor(
     frameworkName: string,
-    client: Inngest<any>,
-    functions: InngestFunction<any, any, any, any>[], { inngestRegisterUrl, fetch, logLevel, signingKey, serveHost, servePath, streaming, name, }: RegisterOptions | undefined,
+    client: AnyInngest,
+    functions: AnyInngestFunction[], { inngestRegisterUrl, fetch, logLevel, signingKey, serveHost, servePath, streaming, id, }: RegisterOptions | undefined,
     handler: H,
     transformRes: TResTransform,
     streamTransformRes?: TStreamTransform);
@@ -185,10 +184,10 @@ export class InngestCommHandler<H extends Handler_2, TResTransform extends (res:
     createHandler(): (...args: Parameters<H>) => Promise<Awaited<ReturnType<TResTransform>>>;
     protected readonly frameworkName: string;
     readonly handler: H;
+    readonly id: string;
     protected _isProd: boolean;
     protected log(level: LogLevel, ...args: unknown[]): void;
     protected readonly logLevel: LogLevel;
-    readonly name: string;
     // (undocumented)
     protected register(url: URL, devServerHost: string | undefined, deployId: string | undefined | null, getHeaders: () => Record<string, string>): Promise<{
         status: number;
@@ -201,10 +200,10 @@ export class InngestCommHandler<H extends Handler_2, TResTransform extends (res:
     protected registerBody(url: URL): RegisterRequest;
     protected reqUrl(url: URL): URL;
     // Warning: (ae-forgotten-export) The symbol "ServerTiming" needs to be exported by the entry point index.d.ts
-    // Warning: (ae-forgotten-export) The symbol "StepRunResponse" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "ExecutionResult" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
-    protected runStep(functionId: string, stepId: string | null, data: unknown, timer: ServerTiming): Promise<StepRunResponse>;
+    protected runStep(functionId: string, stepId: string | null, data: unknown, timer: ServerTiming): Promise<ExecutionResult>;
     protected readonly serveHost: string | undefined;
     protected readonly servePath: string | undefined;
     protected signingKey: string | undefined;
@@ -257,8 +256,8 @@ export interface MiddlewareOptions {
 //
 // @public (undocumented)
 export type MiddlewareRegisterFn = (ctx: {
-    client: Inngest<any>;
-    fn?: InngestFunction<any, any, any, any>;
+    client: AnyInngest;
+    fn?: AnyInngestFunction;
 }) => MaybePromise<MiddlewareRegisterReturn>;
 
 // @public (undocumented)
@@ -301,11 +300,11 @@ export enum queryKeys {
 // @public
 export interface RegisterOptions {
     fetch?: typeof fetch;
+    id?: string;
     inngestRegisterUrl?: string;
     // @deprecated
     landingPage?: boolean;
     logLevel?: LogLevel;
-    name?: string;
     serveHost?: string;
     servePath?: string;
     signingKey?: string;
@@ -314,8 +313,8 @@ export interface RegisterOptions {
 
 // @public
 export type ServeHandler = (
-client: Inngest<any>,
-functions: InngestFunction<any, any, any, any>[],
+client: AnyInngest,
+functions: AnyInngestFunction[],
 opts?: RegisterOptions
 /**
 * This `any` return is appropriate.
@@ -355,14 +354,14 @@ export type ZodEventSchemas = Record<string, {
 
 // Warnings were encountered during analysis:
 //
-// src/components/InngestMiddleware.ts:261:3 - (ae-forgotten-export) The symbol "InitialRunInfo" needs to be exported by the entry point index.d.ts
-// src/components/InngestMiddleware.ts:274:5 - (ae-forgotten-export) The symbol "MiddlewareRunInput" needs to be exported by the entry point index.d.ts
-// src/components/InngestMiddleware.ts:280:5 - (ae-forgotten-export) The symbol "BlankHook" needs to be exported by the entry point index.d.ts
-// src/components/InngestMiddleware.ts:313:5 - (ae-forgotten-export) The symbol "MiddlewareRunOutput" needs to be exported by the entry point index.d.ts
-// src/components/InngestMiddleware.ts:332:5 - (ae-forgotten-export) The symbol "MiddlewareSendEventInput" needs to be exported by the entry point index.d.ts
-// src/components/InngestMiddleware.ts:342:5 - (ae-forgotten-export) The symbol "MiddlewareSendEventOutput" needs to be exported by the entry point index.d.ts
-// src/types.ts:51:5 - (ae-forgotten-export) The symbol "failureEventErrorSchema" needs to be exported by the entry point index.d.ts
-// src/types.ts:685:5 - (ae-forgotten-export) The symbol "TimeStrBatch" needs to be exported by the entry point index.d.ts
+// src/components/InngestMiddleware.ts:259:3 - (ae-forgotten-export) The symbol "InitialRunInfo" needs to be exported by the entry point index.d.ts
+// src/components/InngestMiddleware.ts:272:5 - (ae-forgotten-export) The symbol "MiddlewareRunInput" needs to be exported by the entry point index.d.ts
+// src/components/InngestMiddleware.ts:278:5 - (ae-forgotten-export) The symbol "BlankHook" needs to be exported by the entry point index.d.ts
+// src/components/InngestMiddleware.ts:311:5 - (ae-forgotten-export) The symbol "MiddlewareRunOutput" needs to be exported by the entry point index.d.ts
+// src/components/InngestMiddleware.ts:330:5 - (ae-forgotten-export) The symbol "MiddlewareSendEventInput" needs to be exported by the entry point index.d.ts
+// src/components/InngestMiddleware.ts:340:5 - (ae-forgotten-export) The symbol "MiddlewareSendEventOutput" needs to be exported by the entry point index.d.ts
+// src/types.ts:53:5 - (ae-forgotten-export) The symbol "failureEventErrorSchema" needs to be exported by the entry point index.d.ts
+// src/types.ts:639:5 - (ae-forgotten-export) The symbol "TimeStrBatch" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

packages/inngest/package.json

@@ -47,11 +47,11 @@
     "canonicalize": "^1.0.8",
     "chalk": "^4.1.2",
     "cross-fetch": "^3.1.5",
+    "debug": "^4.3.4",
     "h3": "^1.0.2",
     "hash.js": "^1.1.7",
     "json-stringify-safe": "^5.0.1",
     "ms": "^2.1.3",
-    "queue-microtask": "^1.2.3",
     "serialize-error-cjs": "^0.1.3",
     "type-fest": "^3.5.1",
     "zod": "^3.19.1"
@@ -63,6 +63,7 @@
     "@jest/globals": "^29.5.0",
     "@microsoft/api-extractor": "^7.33.7",
     "@types/aws-lambda": "^8.10.108",
+    "@types/debug": "^4.1.8",
     "@types/express": "^4.17.13",
     "@types/inquirer": "^9.0.3",
     "@types/jest": "^27.4.1",

packages/inngest/src/components/EventSchemas.test.ts

@@ -7,7 +7,7 @@ import { z } from "zod";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type Schemas<T extends EventSchemas<any>> = GetEvents<
-  Inngest<{ name: "test"; schemas: T }>
+  Inngest<{ id: "test"; schemas: T }>
 >;
 
 describe("EventSchemas", () => {
@@ -544,13 +544,13 @@ describe("EventSchemas", () => {
       }>();
 
       const inngest = new Inngest({
-        name: "test",
+        id: "test",
         schemas,
         eventKey: "test-key-123",
       });
 
       inngest.createFunction(
-        { name: "test" },
+        { id: "test" },
         { event: "test.event" },
         ({ event }) => {
           assertType<"test.event">(event.name);
@@ -567,13 +567,13 @@ describe("EventSchemas", () => {
       }>();
 
       const inngest = new Inngest({
-        name: "test",
+        id: "test",
         schemas,
         eventKey: "test-key-123",
       });
 
       inngest.createFunction(
-        { name: "test" },
+        { id: "test" },
         { event: "test.event" },
         ({ event }) => {
           assertType<"test.event">(event.name);
@@ -592,19 +592,19 @@ describe("EventSchemas", () => {
       }>();
 
       const inngest = new Inngest({
-        name: "test",
+        id: "test",
         schemas,
         eventKey: "test-key-123",
       });
 
       inngest.createFunction(
         {
-          name: "test",
+          id: "test",
           cancelOn: [{ event: "test.event2", match: "data.foo" }],
         },
         { event: "test.event" },
         ({ step }) => {
-          void step.waitForEvent("test.event2", {
+          void step.waitForEvent("id", "test.event2", {
             match: "data.foo",
             timeout: "1h",
           });
@@ -620,19 +620,19 @@ describe("EventSchemas", () => {
       }>();
 
       const inngest = new Inngest({
-        name: "test",
+        id: "test",
         schemas,
         eventKey: "test-key-123",
       });
 
       inngest.createFunction(
         {
-          name: "test",
+          id: "test",
           cancelOn: [{ event: "test.event2", match: "data.foo" }],
         },
         { event: "test.event" },
         ({ step }) => {
-          void step.waitForEvent("test.event2", {
+          void step.waitForEvent("id", "test.event2", {
             match: "data.foo",
             timeout: "1h",
           });
@@ -648,19 +648,19 @@ describe("EventSchemas", () => {
       }>();
 
       const inngest = new Inngest({
-        name: "test",
+        id: "test",
         schemas,
         eventKey: "test-key-123",
       });
 
       inngest.createFunction(
         {
-          name: "test",
+          id: "test",
           cancelOn: [{ event: "test.event2", match: "data.foo" }],
         },
         { event: "test.event" },
         ({ step }) => {
-          void step.waitForEvent("test.event2", {
+          void step.waitForEvent("id", "test.event2", {
             match: "data.foo",
             timeout: "1h",
           });