@trigger.dev/sdk 2.2.0 → 2.2.2

package/dist/index.d.ts

@@ -79,6 +79,7 @@ declare class ApiClient {
                 callbackUrl: z.ZodNullable<z.ZodOptional<z.ZodString>>;
                 idempotencyKey: z.ZodString;
                 attempts: z.ZodNumber;
+                forceYield: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
             }, "strip", z.ZodTypeAny, {
                 id: string;
                 name: string;
@@ -111,6 +112,7 @@ declare class ApiClient {
                 } | null | undefined;
                 operation?: string | null | undefined;
                 callbackUrl?: string | null | undefined;
+                forceYield?: boolean | null | undefined;
             }, {
                 id: string;
                 name: string;
@@ -143,6 +145,7 @@ declare class ApiClient {
                 } | null | undefined;
                 operation?: string | null | undefined;
                 callbackUrl?: string | null | undefined;
+                forceYield?: boolean | null | undefined;
             }>;
             cachedTasks: z.ZodOptional<z.ZodObject<{
                 tasks: z.ZodArray<z.ZodObject<{
@@ -222,6 +225,7 @@ declare class ApiClient {
                 } | null | undefined;
                 operation?: string | null | undefined;
                 callbackUrl?: string | null | undefined;
+                forceYield?: boolean | null | undefined;
             };
             cachedTasks?: {
                 tasks: {
@@ -267,6 +271,7 @@ declare class ApiClient {
                 } | null | undefined;
                 operation?: string | null | undefined;
                 callbackUrl?: string | null | undefined;
+                forceYield?: boolean | null | undefined;
             };
             cachedTasks?: {
                 tasks: {
@@ -334,6 +339,7 @@ declare class ApiClient {
         callbackUrl: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         idempotencyKey: z.ZodString;
         attempts: z.ZodNumber;
+        forceYield: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
     }, "strip", z.ZodTypeAny, {
         id: string;
         name: string;
@@ -366,6 +372,7 @@ declare class ApiClient {
         } | null | undefined;
         operation?: string | null | undefined;
         callbackUrl?: string | null | undefined;
+        forceYield?: boolean | null | undefined;
     }, {
         id: string;
         name: string;
@@ -398,6 +405,7 @@ declare class ApiClient {
         } | null | undefined;
         operation?: string | null | undefined;
         callbackUrl?: string | null | undefined;
+        forceYield?: boolean | null | undefined;
     }>>>;
     completeTask(runId: string, id: string, task: CompleteTaskBodyInput): Promise<{
         id: string;
@@ -431,6 +439,7 @@ declare class ApiClient {
         } | null | undefined;
         operation?: string | null | undefined;
         callbackUrl?: string | null | undefined;
+        forceYield?: boolean | null | undefined;
     }>;
     failTask(runId: string, id: string, body: FailTaskBodyInput): Promise<{
         id: string;
@@ -464,6 +473,7 @@ declare class ApiClient {
         } | null | undefined;
         operation?: string | null | undefined;
         callbackUrl?: string | null | undefined;
+        forceYield?: boolean | null | undefined;
     }>;
     sendEvent(event: SendEvent, options?: SendEventOptions): Promise<{
         id: string;
@@ -1116,7 +1126,7 @@ declare class TriggerClient {
     #private;
     id: string;
     constructor(options: Prettify<TriggerClientOptions>);
-    handleRequest(request: Request): Promise<NormalizedResponse>;
+    handleRequest(request: Request, timeOrigin?: number): Promise<NormalizedResponse>;
     defineJob<TTrigger extends Trigger<EventSpecification<any>>, TIntegrations extends Record<string, TriggerIntegration> = {}>(options: JobOptions<TTrigger, TIntegrations>): Job<TTrigger, TIntegrations>;
     defineAuthResolver(integration: TriggerIntegration, resolver: TriggerAuthResolver): TriggerClient;
     defineDynamicSchedule(options: DynamicIntervalOptions): DynamicSchedule;
@@ -1346,6 +1356,7 @@ type IOOptions = {
     apiClient: ApiClient;
     client: TriggerClient;
     context: TriggerContext;
+    timeOrigin: number;
     logger?: Logger;
     logLevel?: LogLevel;
     jobLogger?: Logger;
@@ -1355,6 +1366,7 @@ type IOOptions = {
     yieldedExecutions?: Array<string>;
     noopTasksSet?: string;
     serverVersion?: string | null;
+    executionTimeout?: number;
 };
 type JsonPrimitive = string | number | boolean | null | undefined | Date | symbol;
 type JsonArray = Json[];
@@ -1393,17 +1405,19 @@ declare class IO {
     private _noopTasksBloomFilter;
     private _stats;
     private _serverVersion;
+    private _timeOrigin;
+    private _executionTimeout?;
     get stats(): IOStats;
     constructor(options: IOOptions);
     /** Used to send log messages to the [Run log](https://trigger.dev/docs/documentation/guides/viewing-runs). */
     get logger(): IOLogger;
     /** `io.wait()` waits for the specified amount of time before continuing the Job. Delays work even if you're on a serverless platform with timeouts, or if your server goes down. They utilize [resumability](https://trigger.dev/docs/documentation/concepts/resumability) to ensure that the Run can be resumed after the delay.
-     * @param key Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
+     * @param cacheKey Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
      * @param seconds The number of seconds to wait. This can be very long, serverless timeouts are not an issue.
      */
-    wait(key: string | any[], seconds: number): Promise<void>;
+    wait(cacheKey: string | any[], seconds: number): Promise<void>;
     /** `io.createStatus()` allows you to set a status with associated data during the Run. Statuses can be used by your UI using the react package
-     * @param key Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
+     * @param cacheKey Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
      * @param initialStatus The initial status you want this status to have. You can update it during the rub using the returned object.
      * @returns a TriggerStatus object that you can call `update()` on, to update the status.
      * @example
@@ -1434,9 +1448,9 @@ declare class IO {
     });
      * ```
     */
-    createStatus(key: IntegrationTaskKey, initialStatus: InitialStatusUpdate): Promise<TriggerStatus>;
+    createStatus(cacheKey: IntegrationTaskKey, initialStatus: InitialStatusUpdate): Promise<TriggerStatus>;
     /** `io.backgroundFetch()` fetches data from a URL that can take longer that the serverless timeout. The actual `fetch` request is performed on the Trigger.dev platform, and the response is sent back to you.
-     * @param key Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
+     * @param cacheKey Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
      * @param url The URL to fetch from.
      * @param requestInit The options for the request
      * @param retry The options for retrying the request if it fails
@@ -1446,13 +1460,13 @@ declare class IO {
      * - Ranges: 500-599
      * - Wildcards: 2xx, 3xx, 4xx, 5xx
      */
-    backgroundFetch<TResponseData>(key: string | any[], url: string, requestInit?: FetchRequestInit, retry?: FetchRetryOptions): Promise<TResponseData>;
+    backgroundFetch<TResponseData>(cacheKey: string | any[], url: string, requestInit?: FetchRequestInit, retry?: FetchRetryOptions): Promise<TResponseData>;
     /** `io.sendEvent()` allows you to send an event from inside a Job run. The sent even will trigger any Jobs that are listening for that event (based on the name).
-     * @param key Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
+     * @param cacheKey Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
      * @param event The event to send. The event name must match the name of the event that your Jobs are listening for.
      * @param options Options for sending the event.
      */
-    sendEvent(key: string | any[], event: SendEvent, options?: SendEventOptions): Promise<{
+    sendEvent(cacheKey: string | any[], event: SendEvent, options?: SendEventOptions): Promise<{
         id: string;
         name: string;
         payload: ((string | number | boolean | {
@@ -1466,7 +1480,7 @@ declare class IO {
         deliveredAt?: Date | null | undefined;
         cancelledAt?: Date | null | undefined;
     }>;
-    getEvent(key: string | any[], id: string): Promise<{
+    getEvent(cacheKey: string | any[], id: string): Promise<{
         id: string;
         name: string;
         updatedAt: Date;
@@ -1479,11 +1493,11 @@ declare class IO {
         createdAt: Date;
     }>;
     /** `io.cancelEvent()` allows you to cancel an event that was previously sent with `io.sendEvent()`. This will prevent any Jobs from running that are listening for that event if the event was sent with a delay
-     * @param key
+     * @param cacheKey
      * @param eventId
      * @returns
      */
-    cancelEvent(key: string | any[], eventId: string): Promise<{
+    cancelEvent(cacheKey: string | any[], eventId: string): Promise<{
         id: string;
         name: string;
         payload: ((string | number | boolean | {
@@ -1497,21 +1511,21 @@ declare class IO {
         deliveredAt?: Date | null | undefined;
         cancelledAt?: Date | null | undefined;
     }>;
-    updateSource(key: string | any[], options: {
+    updateSource(cacheKey: string | any[], options: {
         key: string;
     } & UpdateTriggerSourceBodyV2): Promise<{
         id: string;
         key: string;
     }>;
     /** `io.registerInterval()` allows you to register a [DynamicSchedule](https://trigger.dev/docs/sdk/dynamicschedule) that will trigger any jobs it's attached to on a regular interval.
-     * @param key Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
+     * @param cacheKey Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
      * @param dynamicSchedule The [DynamicSchedule](https://trigger.dev/docs/sdk/dynamicschedule) to register a new schedule on.
      * @param id A unique id for the interval. This is used to identify and unregister the interval later.
      * @param options The options for the interval.
      * @returns A promise that has information about the interval.
      * @deprecated Use `DynamicSchedule.register` instead.
      */
-    registerInterval(key: string | any[], dynamicSchedule: DynamicSchedule, id: string, options: IntervalOptions): Promise<{
+    registerInterval(cacheKey: string | any[], dynamicSchedule: DynamicSchedule, id: string, options: IntervalOptions): Promise<{
         id: string;
         schedule: {
             options: {
@@ -1532,22 +1546,22 @@ declare class IO {
         metadata?: any;
     }>;
     /** `io.unregisterInterval()` allows you to unregister a [DynamicSchedule](https://trigger.dev/docs/sdk/dynamicschedule) that was previously registered with `io.registerInterval()`.
-     * @param key Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
+     * @param cacheKey Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
      * @param dynamicSchedule The [DynamicSchedule](https://trigger.dev/docs/sdk/dynamicschedule) to unregister a schedule on.
      * @param id A unique id for the interval. This is used to identify and unregister the interval later.
      * @deprecated Use `DynamicSchedule.unregister` instead.
      */
-    unregisterInterval(key: string | any[], dynamicSchedule: DynamicSchedule, id: string): Promise<{
+    unregisterInterval(cacheKey: string | any[], dynamicSchedule: DynamicSchedule, id: string): Promise<{
         ok: boolean;
     }>;
     /** `io.registerCron()` allows you to register a [DynamicSchedule](https://trigger.dev/docs/sdk/dynamicschedule) that will trigger any jobs it's attached to on a regular CRON schedule.
-     * @param key Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
+     * @param cacheKey Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
      * @param dynamicSchedule The [DynamicSchedule](https://trigger.dev/docs/sdk/dynamicschedule) to register a new schedule on.
      * @param id A unique id for the schedule. This is used to identify and unregister the schedule later.
      * @param options The options for the CRON schedule.
      * @deprecated Use `DynamicSchedule.register` instead.
      */
-    registerCron(key: string | any[], dynamicSchedule: DynamicSchedule, id: string, options: CronOptions): Promise<{
+    registerCron(cacheKey: string | any[], dynamicSchedule: DynamicSchedule, id: string, options: CronOptions): Promise<{
         id: string;
         schedule: {
             options: {
@@ -1568,43 +1582,43 @@ declare class IO {
         metadata?: any;
     }>;
     /** `io.unregisterCron()` allows you to unregister a [DynamicSchedule](https://trigger.dev/docs/sdk/dynamicschedule) that was previously registered with `io.registerCron()`.
-     * @param key Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
+     * @param cacheKey Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
      * @param dynamicSchedule The [DynamicSchedule](https://trigger.dev/docs/sdk/dynamicschedule) to unregister a schedule on.
      * @param id A unique id for the interval. This is used to identify and unregister the interval later.
      * @deprecated Use `DynamicSchedule.unregister` instead.
      */
-    unregisterCron(key: string | any[], dynamicSchedule: DynamicSchedule, id: string): Promise<{
+    unregisterCron(cacheKey: string | any[], dynamicSchedule: DynamicSchedule, id: string): Promise<{
         ok: boolean;
     }>;
     /** `io.registerTrigger()` allows you to register a [DynamicTrigger](https://trigger.dev/docs/sdk/dynamictrigger) with the specified trigger params.
-     * @param key Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
+     * @param cacheKey Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
      * @param trigger The [DynamicTrigger](https://trigger.dev/docs/sdk/dynamictrigger) to register.
      * @param id A unique id for the trigger. This is used to identify and unregister the trigger later.
      * @param params The params for the trigger.
      * @deprecated Use `DynamicTrigger.register` instead.
      */
-    registerTrigger<TTrigger extends DynamicTrigger<EventSpecification<any>, ExternalSource<any, any, any>>>(key: string | any[], trigger: TTrigger, id: string, params: ExternalSourceParams<TTrigger["source"]>): Promise<{
+    registerTrigger<TTrigger extends DynamicTrigger<EventSpecification<any>, ExternalSource<any, any, any>>>(cacheKey: string | any[], trigger: TTrigger, id: string, params: ExternalSourceParams<TTrigger["source"]>): Promise<{
         id: string;
         key: string;
     } | undefined>;
-    getAuth(key: string | any[], clientId?: string): Promise<ConnectionAuth | undefined>;
+    getAuth(cacheKey: string | any[], clientId?: string): Promise<ConnectionAuth | undefined>;
     /** `io.runTask()` allows you to run a [Task](https://trigger.dev/docs/documentation/concepts/tasks) from inside a Job run. A Task is a resumable unit of a Run that can be retried, resumed and is logged. [Integrations](https://trigger.dev/docs/integrations) use Tasks internally to perform their actions.
      *
-     * @param key Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
+     * @param cacheKey Should be a stable and unique key inside the `run()`. See [resumability](https://trigger.dev/docs/documentation/concepts/resumability) for more information.
      * @param callback The callback that will be called when the Task is run. The callback receives the Task and the IO as parameters.
      * @param options The options of how you'd like to run and log the Task.
      * @param onError The callback that will be called when the Task fails. The callback receives the error, the Task and the IO as parameters. If you wish to retry then return an object with a `retryAt` property.
      * @returns A Promise that resolves with the returned value of the callback.
      */
-    runTask<T extends Json<T> | void>(key: string | any[], callback: (task: ServerTask, io: IO) => Promise<T>, options?: RunTaskOptions, onError?: RunTaskErrorCallback): Promise<T>;
+    runTask<T extends Json<T> | void>(cacheKey: string | any[], callback: (task: ServerTask, io: IO) => Promise<T>, options?: RunTaskOptions, onError?: RunTaskErrorCallback): Promise<T>;
     /**
      * `io.yield()` allows you to yield execution of the current run and resume it in a new function execution. Similar to `io.wait()` but does not create a task and resumes execution immediately.
      */
-    yield(key: string): void;
+    yield(cacheKey: string): void;
     /**
      * `io.brb()` is an alias of `io.yield()`
      */
-    brb: (key: string) => void;
+    brb: (cacheKey: string) => void;
     /** `io.try()` allows you to run Tasks and catch any errors that are thrown, it's similar to a normal `try/catch` block but works with [io.runTask()](/sdk/io/runtask).
      * A regular `try/catch` block on its own won't work as expected with Tasks. Internally `runTask()` throws some special errors to control flow execution. This is necessary to deal with resumability, serverless timeouts, and retrying Tasks.
      * @param tryCallback The code you wish to run
@@ -1872,13 +1886,38 @@ declare class CanceledWithTaskError {
     task: ServerTask;
     constructor(task: ServerTask);
 }
+declare class YieldExecutionError {
+    key: string;
+    constructor(key: string);
+}
+declare class AutoYieldExecutionError {
+    location: string;
+    timeRemaining: number;
+    timeElapsed: number;
+    constructor(location: string, timeRemaining: number, timeElapsed: number);
+}
+declare class AutoYieldWithCompletedTaskExecutionError {
+    id: string;
+    properties: DisplayProperty[] | undefined;
+    output: any;
+    data: {
+        location: string;
+        timeRemaining: number;
+        timeElapsed: number;
+    };
+    constructor(id: string, properties: DisplayProperty[] | undefined, output: any, data: {
+        location: string;
+        timeRemaining: number;
+        timeElapsed: number;
+    });
+}
 /** Use this function if you're using a `try/catch` block to catch errors.
  * It checks if a thrown error is a special internal error that you should ignore.
  * If this returns `true` then you must rethrow the error: `throw err;`
  * @param err The error to check
  * @returns `true` if the error is a Trigger Error, `false` otherwise.
  */
-declare function isTriggerError(err: unknown): err is ResumeWithTaskError | RetryWithTaskError | CanceledWithTaskError;
+declare function isTriggerError(err: unknown): err is ResumeWithTaskError | RetryWithTaskError | CanceledWithTaskError | YieldExecutionError | AutoYieldExecutionError | AutoYieldWithCompletedTaskExecutionError;
 
 declare const retry: {
     readonly standardBackoff: {