@trigger.dev/sdk 3.0.0-beta.50 → 3.0.0-beta.52

package/dist/v3/index.d.ts

@@ -1,4 +1,4 @@
-import { RetryOptions, FetchRetryOptions, ListProjectRunsQueryParams, ApiRequestOptions, CursorPagePromise, ListRunResponseItem, ListRunsQueryParams, ApiPromise, ReplayRunResponse, CanceledRunResponse, RescheduleRunRequestBody, RetrieveRunResponse, TaskRunContext, QueueOptions, InitOutput, MachineCpu, MachineMemory, RunFnParams, InitFnParams, HandleErrorFnParams, HandleErrorResult, MiddlewareFnParams, StartFnParams, SuccessFnParams, FailureFnParams, ScheduledTaskPayload, CreateScheduleOptions, ScheduleObject, UpdateScheduleOptions, DeletedScheduleObject, ListScheduleOptions, OffsetLimitPagePromise, ImportEnvironmentVariablesParams, EnvironmentVariableResponseBody, EnvironmentVariables, CreateEnvironmentVariableParams, EnvironmentVariableValue, UpdateEnvironmentVariableParams, ApiClientConfiguration } from '@trigger.dev/core/v3';
+import { RetryOptions, FetchRetryOptions, ListProjectRunsQueryParams, ApiRequestOptions, CursorPagePromise, ListRunResponseItem, ListRunsQueryParams, ApiPromise, ReplayRunResponse, CanceledRunResponse, RescheduleRunRequestBody, RetrieveRunResponse, TaskRunContext, QueueOptions, InitOutput, MachineCpu, MachineMemory, RunFnParams, InitFnParams, HandleErrorFnParams, HandleErrorResult, MiddlewareFnParams, StartFnParams, SuccessFnParams, FailureFnParams, RunTags, ScheduledTaskPayload, CreateScheduleOptions, ScheduleObject, UpdateScheduleOptions, DeletedScheduleObject, ListScheduleOptions, OffsetLimitPagePromise, ImportEnvironmentVariablesParams, EnvironmentVariableResponseBody, EnvironmentVariables, CreateEnvironmentVariableParams, EnvironmentVariableValue, UpdateEnvironmentVariableParams, ApiClientConfiguration } from '@trigger.dev/core/v3';
 export { AbortTaskRunError, ApiClientConfiguration, ApiError, AuthenticationError, BadRequestError, ConflictError, HandleErrorArgs, HandleErrorFunction, ImportEnvironmentVariablesParams, InternalServerError, LogLevel, NotFoundError, PermissionDeniedError, RateLimitError, ResolveEnvironmentVariablesFunction, ResolveEnvironmentVariablesParams, ResolveEnvironmentVariablesResult, RetryOptions, ProjectConfig as TriggerConfig, UnprocessableEntityError, logger } from '@trigger.dev/core/v3';
 import { HttpHandler } from 'msw';
 
@@ -48,11 +48,11 @@ declare const retry: {
     };
 };
 
-type RetrieveRunResult<TOutput> = Prettify<TOutput extends RunHandle<infer THandleOutput> ? Omit<RetrieveRunResponse, "output"> & {
-    output?: THandleOutput;
-} : Omit<RetrieveRunResponse, "output"> & {
+type RetrieveRunResult<TRunId> = Prettify<TRunId extends RunHandle<infer TOutput> ? Omit<RetrieveRunResponse, "output"> & {
     output?: TOutput;
-}>;
+} : TRunId extends Task<string, any, infer TTaskOutput> ? Omit<RetrieveRunResponse, "output"> & {
+    output?: TTaskOutput;
+} : TRunId extends string ? RetrieveRunResponse : never>;
 declare const runs: {
     replay: typeof replayRun;
     cancel: typeof cancelRun;
@@ -63,20 +63,25 @@ declare const runs: {
 };
 declare function listRuns(projectRef: string, params?: ListProjectRunsQueryParams, requestOptions?: ApiRequestOptions): CursorPagePromise<typeof ListRunResponseItem>;
 declare function listRuns(params?: ListRunsQueryParams, requestOptions?: ApiRequestOptions): CursorPagePromise<typeof ListRunResponseItem>;
-declare function retrieveRun<TRunId extends RunHandle<any> | string>(runId: TRunId, requestOptions?: ApiRequestOptions): ApiPromise<RetrieveRunResult<TRunId>>;
+type RunId<TRunId> = TRunId extends RunHandle<any> ? TRunId : TRunId extends AnyTask ? string : TRunId extends string ? TRunId : never;
+declare function retrieveRun<TRunId extends RunHandle<any> | AnyTask | string>(runId: RunId<TRunId>, requestOptions?: ApiRequestOptions): ApiPromise<RetrieveRunResult<TRunId>>;
 declare function replayRun(runId: string, requestOptions?: ApiRequestOptions): ApiPromise<ReplayRunResponse>;
 declare function cancelRun(runId: string, requestOptions?: ApiRequestOptions): ApiPromise<CanceledRunResponse>;
 declare function rescheduleRun(runId: string, body: RescheduleRunRequestBody, requestOptions?: ApiRequestOptions): ApiPromise<RetrieveRunResponse>;
 type PollOptions = {
     pollIntervalMs?: number;
 };
-declare function poll<TRunHandle extends RunHandle<any> | string>(handle: TRunHandle, options?: {
+declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: RunId<TRunId>, options?: {
     pollIntervalMs?: number;
-}, requestOptions?: ApiRequestOptions): Promise<(TRunHandle extends RunHandle<infer THandleOutput> ? Omit<{
+}, requestOptions?: ApiRequestOptions): Promise<(TRunId extends RunHandle<infer TOutput> ? Omit<{
     status: "CANCELED" | "COMPLETED" | "FAILED" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
     id: string;
+    tags: string[];
     isTest: boolean;
     createdAt: Date;
+    durationMs: number;
+    costInCents: number;
+    baseCostInCents: number;
     attempts: ({
         status: "PENDING" | "CANCELED" | "COMPLETED" | "FAILED" | "EXECUTING" | "PAUSED";
         id: string;
@@ -120,12 +125,16 @@ declare function poll<TRunHandle extends RunHandle<any> | string>(handle: TRunHa
     ttl?: string | undefined;
     expiredAt?: Date | undefined;
 }, "output"> & {
-    output?: THandleOutput | undefined;
-} : Omit<{
+    output?: TOutput | undefined;
+} : TRunId extends Task<string, any, infer TTaskOutput> ? Omit<{
     status: "CANCELED" | "COMPLETED" | "FAILED" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
     id: string;
+    tags: string[];
     isTest: boolean;
     createdAt: Date;
+    durationMs: number;
+    costInCents: number;
+    baseCostInCents: number;
     attempts: ({
         status: "PENDING" | "CANCELED" | "COMPLETED" | "FAILED" | "EXECUTING" | "PAUSED";
         id: string;
@@ -169,12 +178,67 @@ declare function poll<TRunHandle extends RunHandle<any> | string>(handle: TRunHa
     ttl?: string | undefined;
     expiredAt?: Date | undefined;
 }, "output"> & {
-    output?: TRunHandle | undefined;
-}) extends infer T ? { [K in keyof T]: (TRunHandle extends RunHandle<infer THandleOutput> ? Omit<{
+    output?: TTaskOutput | undefined;
+} : TRunId extends string ? {
     status: "CANCELED" | "COMPLETED" | "FAILED" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
     id: string;
+    tags: string[];
     isTest: boolean;
     createdAt: Date;
+    durationMs: number;
+    costInCents: number;
+    baseCostInCents: number;
+    attempts: ({
+        status: "PENDING" | "CANCELED" | "COMPLETED" | "FAILED" | "EXECUTING" | "PAUSED";
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        startedAt?: Date | undefined;
+        completedAt?: Date | undefined;
+        error?: {
+            message: string;
+            name?: string | undefined;
+            stackTrace?: string | undefined;
+        } | undefined;
+    } | undefined)[];
+    updatedAt: Date;
+    taskIdentifier: string;
+    isQueued: boolean;
+    isExecuting: boolean;
+    isCompleted: boolean;
+    isSuccess: boolean;
+    isFailed: boolean;
+    isCancelled: boolean;
+    payload?: any;
+    payloadPresignedUrl?: string | undefined;
+    output?: any;
+    outputPresignedUrl?: string | undefined;
+    schedule?: {
+        id: string;
+        generator: {
+            type: "CRON";
+            expression: string;
+            description: string;
+        };
+        externalId?: string | undefined;
+        deduplicationKey?: string | undefined;
+    } | undefined;
+    idempotencyKey?: string | undefined;
+    version?: string | undefined;
+    startedAt?: Date | undefined;
+    finishedAt?: Date | undefined;
+    delayedUntil?: Date | undefined;
+    ttl?: string | undefined;
+    expiredAt?: Date | undefined;
+} : never) extends infer T ? { [K in keyof T]: (TRunId extends RunHandle<infer TOutput> ? Omit<{
+    status: "CANCELED" | "COMPLETED" | "FAILED" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
+    id: string;
+    tags: string[];
+    isTest: boolean;
+    createdAt: Date;
+    durationMs: number;
+    costInCents: number;
+    baseCostInCents: number;
     attempts: ({
         status: "PENDING" | "CANCELED" | "COMPLETED" | "FAILED" | "EXECUTING" | "PAUSED";
         id: string;
@@ -218,12 +282,16 @@ declare function poll<TRunHandle extends RunHandle<any> | string>(handle: TRunHa
     ttl?: string | undefined;
     expiredAt?: Date | undefined;
 }, "output"> & {
-    output?: THandleOutput | undefined;
-} : Omit<{
+    output?: TOutput | undefined;
+} : TRunId extends Task<string, any, infer TTaskOutput> ? Omit<{
     status: "CANCELED" | "COMPLETED" | "FAILED" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
     id: string;
+    tags: string[];
     isTest: boolean;
     createdAt: Date;
+    durationMs: number;
+    costInCents: number;
+    baseCostInCents: number;
     attempts: ({
         status: "PENDING" | "CANCELED" | "COMPLETED" | "FAILED" | "EXECUTING" | "PAUSED";
         id: string;
@@ -267,8 +335,59 @@ declare function poll<TRunHandle extends RunHandle<any> | string>(handle: TRunHa
     ttl?: string | undefined;
     expiredAt?: Date | undefined;
 }, "output"> & {
-    output?: TRunHandle | undefined;
-})[K]; } : never>;
+    output?: TTaskOutput | undefined;
+} : TRunId extends string ? {
+    status: "CANCELED" | "COMPLETED" | "FAILED" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
+    id: string;
+    tags: string[];
+    isTest: boolean;
+    createdAt: Date;
+    durationMs: number;
+    costInCents: number;
+    baseCostInCents: number;
+    attempts: ({
+        status: "PENDING" | "CANCELED" | "COMPLETED" | "FAILED" | "EXECUTING" | "PAUSED";
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        startedAt?: Date | undefined;
+        completedAt?: Date | undefined;
+        error?: {
+            message: string;
+            name?: string | undefined;
+            stackTrace?: string | undefined;
+        } | undefined;
+    } | undefined)[];
+    updatedAt: Date;
+    taskIdentifier: string;
+    isQueued: boolean;
+    isExecuting: boolean;
+    isCompleted: boolean;
+    isSuccess: boolean;
+    isFailed: boolean;
+    isCancelled: boolean;
+    payload?: any;
+    payloadPresignedUrl?: string | undefined;
+    output?: any;
+    outputPresignedUrl?: string | undefined;
+    schedule?: {
+        id: string;
+        generator: {
+            type: "CRON";
+            expression: string;
+            description: string;
+        };
+        externalId?: string | undefined;
+        deduplicationKey?: string | undefined;
+    } | undefined;
+    idempotencyKey?: string | undefined;
+    version?: string | undefined;
+    startedAt?: Date | undefined;
+    finishedAt?: Date | undefined;
+    delayedUntil?: Date | undefined;
+    ttl?: string | undefined;
+    expiredAt?: Date | undefined;
+} : never)[K]; } : never>;
 
 declare const idempotencyKeys: {
     create: typeof createIdempotencyKey;
@@ -564,8 +683,6 @@ interface Task<TIdentifier extends string, TInput = void, TOutput = any> {
 type AnyTask = Task<string, any, any>;
 type TaskPayload<TTask extends AnyTask> = TTask extends Task<string, infer TInput, any> ? TInput : never;
 type TaskOutput<TTask extends AnyTask> = TTask extends Task<string, any, infer TOutput> ? TOutput : never;
-type TaskOutputHandle<TTask extends AnyTask> = TTask extends Task<string, any, infer TOutput> ? RunHandle<TOutput> : never;
-type TaskBatchOutputHandle<TTask extends AnyTask> = TTask extends Task<string, any, infer TOutput> ? BatchRunHandle<TOutput> : never;
 type TaskIdentifier<TTask extends AnyTask> = TTask extends Task<infer TIdentifier, any, any> ? TIdentifier : never;
 type TaskRunOptions = {
     /**
@@ -644,6 +761,20 @@ type TaskRunOptions = {
      * **Note:** Runs in development have a default `ttl` of 10 minutes. You can override this by setting the `ttl` option.
      */
     ttl?: string | number;
+    /**
+     * Tags to attach to the run. Tags can be used to filter runs in the dashboard and using the SDK.
+     *
+     * You can set up to 5 tags per run, they must be less than 64 characters each.
+     *
+     * We recommend prefixing tags with a namespace using an underscore or colon, like `user_1234567` or `org:9876543`.
+     *
+     * @example
+     *
+     * ```ts
+     * await myTask.trigger({ foo: "bar" }, { tags: ["user:1234567", "org:9876543"] });
+     * ```
+     */
+    tags?: RunTags;
 };
 type TaskRunConcurrencyOptions = Queue;
 type Prettify<T> = {
@@ -665,8 +796,51 @@ type Prettify<T> = {
  *
  * @returns {RunHandle} An object with the `id` of the run. Can be used to retrieve the completed run output in a typesafe manner.
  */
-declare function trigger<TTask extends AnyTask>(id: TaskIdentifier<TTask>, payload: TaskPayload<TTask>, options?: TaskRunOptions, requestOptions?: ApiRequestOptions): Promise<TaskOutputHandle<TTask>>;
+declare function trigger<TTask extends AnyTask>(id: TaskIdentifier<TTask>, payload: TaskPayload<TTask>, options?: TaskRunOptions, requestOptions?: ApiRequestOptions): Promise<RunHandle<TaskOutput<TTask>>>;
+/**
+ * Trigger a task with the given payload, and wait for the result. Returns the result of the task run
+ * @param id - The id of the task to trigger
+ * @param payload
+ * @param options - Options for the task run
+ * @returns TaskRunResult
+ * @example
+ * ```ts
+ * import { tasks } from "@trigger.dev/sdk/v3";
+ * const result = await tasks.triggerAndWait("my-task", { foo: "bar" });
+ *
+ * if (result.ok) {
+ *  console.log(result.output);
+ * } else {
+ *  console.error(result.error);
+ * }
+ * ```
+ */
 declare function triggerAndWait<TTask extends AnyTask>(id: TaskIdentifier<TTask>, payload: TaskPayload<TTask>, options?: TaskRunOptions, requestOptions?: ApiRequestOptions): Promise<TaskRunResult<TaskOutput<TTask>>>;
+/**
+ * Batch trigger multiple task runs with the given payloads, and wait for the results. Returns the results of the task runs.
+ * @param id - The id of the task to trigger
+ * @param items
+ * @returns BatchResult
+ * @example
+ *
+ * ```ts
+ * import { tasks } from "@trigger.dev/sdk/v3";
+ *
+ * const result = await tasks.batchTriggerAndWait("my-task", [
+ *  { payload: { foo: "bar" } },
+ *  { payload: { foo: "baz" } },
+ * ]);
+ *
+ * for (const run of result.runs) {
+ *  if (run.ok) {
+ *    console.log(run.output);
+ *  } else {
+ *    console.error(run.error);
+ *  }
+ * }
+ * ```
+ */
+declare function batchTriggerAndWait<TTask extends AnyTask>(id: TaskIdentifier<TTask>, items: Array<BatchItem<TaskPayload<TTask>>>, requestOptions?: ApiRequestOptions): Promise<BatchResult<TaskOutput<TTask>>>;
 /**
  * Trigger a task by its identifier with the given payload and poll until the run is completed.
  *
@@ -682,8 +856,8 @@ declare function triggerAndWait<TTask extends AnyTask>(id: TaskIdentifier<TTask>
  *
  * @returns {Run} The completed run, either successful or failed.
  */
-declare function triggerAndPoll<TTask extends AnyTask>(id: TaskIdentifier<TTask>, payload: TaskPayload<TTask>, options?: TaskRunOptions & PollOptions, requestOptions?: ApiRequestOptions): Promise<RetrieveRunResult<TaskOutputHandle<TTask>>>;
-declare function batchTrigger<TTask extends AnyTask>(id: TaskIdentifier<TTask>, items: Array<BatchItem<TaskPayload<TTask>>>, requestOptions?: ApiRequestOptions): Promise<TaskBatchOutputHandle<TTask>>;
+declare function triggerAndPoll<TTask extends AnyTask>(id: TaskIdentifier<TTask>, payload: TaskPayload<TTask>, options?: TaskRunOptions & PollOptions, requestOptions?: ApiRequestOptions): Promise<RetrieveRunResult<RunHandle<TaskOutput<TTask>>>>;
+declare function batchTrigger<TTask extends AnyTask>(id: TaskIdentifier<TTask>, items: Array<BatchItem<TaskPayload<TTask>>>, requestOptions?: ApiRequestOptions): Promise<BatchRunHandle<TaskOutput<TTask>>>;
 
 /** Creates a task that can be triggered
  * @param options - Task options
@@ -709,6 +883,7 @@ declare const tasks: {
     triggerAndPoll: typeof triggerAndPoll;
     batchTrigger: typeof batchTrigger;
     triggerAndWait: typeof triggerAndWait;
+    batchTriggerAndWait: typeof batchTriggerAndWait;
 };
 
 type WaitOptions = {
@@ -812,6 +987,11 @@ declare const usage: {
     }>;
 };
 
+declare const tags: {
+    add: typeof addTags;
+};
+declare function addTags(tags: RunTags, requestOptions?: ApiRequestOptions): Promise<void>;
+
 type ScheduleOptions<TIdentifier extends string, TOutput, TInitOutput extends InitOutput> = TaskOptions<TIdentifier, ScheduledTaskPayload, TOutput, TInitOutput> & {
     /** You can optionally specify a CRON schedule on your task. You can also dynamically add a schedule in the dashboard or using the SDK functions.
      *
@@ -950,4 +1130,4 @@ declare namespace envvars {
  */
 declare function configure(options: ApiClientConfiguration): void;
 
-export { type BatchItem, type BatchResult, type BatchRunHandle, type CacheEntry, type CacheFunction, type CacheMetadata, type CacheStore, type ComputeUsage, type Context, type CurrentUsage, type Eventually, type IdempotencyKey, InMemoryCache, type Queue, type RunHandle, type Task, type TaskIdentifier, type TaskOptions, type TaskOutput, type TaskPayload, type TaskRunOptions, type TaskRunResult, type WaitOptions, configure, createCache, envvars, idempotencyKeys, isIdempotencyKey, queue, retry, runs, index as schedules, task$1 as task, tasks, usage, wait };
+export { type AnyTask, type BatchItem, type BatchResult, type BatchRunHandle, type CacheEntry, type CacheFunction, type CacheMetadata, type CacheStore, type ComputeUsage, type Context, type CurrentUsage, type Eventually, type IdempotencyKey, InMemoryCache, type Queue, type RunHandle, type Task, type TaskIdentifier, type TaskOptions, type TaskOutput, type TaskPayload, type TaskRunOptions, type TaskRunResult, type WaitOptions, configure, createCache, envvars, idempotencyKeys, isIdempotencyKey, queue, retry, runs, index as schedules, tags, task$1 as task, tasks, usage, wait };