@trigger.dev/core 0.0.0-prerelease-20250430152137 → 0.0.0-process-keep-alive-20250618143615

package/dist/commonjs/v3/apiClient/index.d.ts

@@ -1,15 +1,15 @@
 import { z } from "zod";
 import { AddTagsRequestBody, BatchTaskRunExecutionResult, BatchTriggerTaskV3RequestBody, CompleteWaitpointTokenRequestBody, CreateEnvironmentVariableRequestBody, CreateScheduleOptions, CreateWaitpointTokenRequestBody, CreateWaitpointTokenResponseBody, ListQueueOptions, ListRunResponseItem, ListScheduleOptions, RescheduleRunRequestBody, RetrieveQueueParam, TaskRunExecutionResult, TriggerTaskRequestBody, UpdateEnvironmentVariableRequestBody, UpdateMetadataRequestBody, UpdateScheduleOptions, WaitForDurationRequestBody, WaitpointTokenItem } from "../schemas/index.js";
+import { AsyncIterableStream } from "../streams/asyncIterableStream.js";
 import { AnyRunTypes, TriggerJwtOptions } from "../types/tasks.js";
+import { Prettify } from "../types/utils.js";
 import { AnyZodFetchOptions, ApiPromise, ApiRequestOptions, CursorPagePromise, ZodFetchOptions, isRequestOptions } from "./core.js";
-import { AnyRealtimeRun, AnyRunShape, RealtimeRun, RunShape, RunStreamCallback, RunSubscription, TaskRunShape } from "./runStream.js";
+import { AnyRealtimeRun, AnyRunShape, RealtimeRun, RunShape, RunStreamCallback, RunSubscription, TaskRunShape, RealtimeRunSkipColumns } from "./runStream.js";
 import { CreateEnvironmentVariableParams, ImportEnvironmentVariablesParams, ListProjectRunsQueryParams, ListRunsQueryParams, ListWaitpointTokensQueryParams, SubscribeToRunsQueryParams, UpdateEnvironmentVariableParams } from "./types.js";
-import { AsyncIterableStream } from "../streams/asyncIterableStream.js";
-import { Prettify } from "../types/utils.js";
 export type CreateWaitpointTokenResponse = Prettify<CreateWaitpointTokenResponseBody & {
     publicAccessToken: string;
 }>;
-export type { CreateEnvironmentVariableParams, ImportEnvironmentVariablesParams, SubscribeToRunsQueryParams, UpdateEnvironmentVariableParams, };
+export type { CreateEnvironmentVariableParams, ImportEnvironmentVariablesParams, SubscribeToRunsQueryParams, UpdateEnvironmentVariableParams, RealtimeRunSkipColumns, };
 export type ClientTriggerOptions = {
     spanParentAsLink?: boolean;
 };
@@ -24,6 +24,7 @@ export type TriggerApiRequestOptions = ApiRequestOptions & {
 };
 export { isRequestOptions };
 export type { AnyRealtimeRun, AnyRunShape, ApiRequestOptions, RealtimeRun, RunShape, RunStreamCallback, RunSubscription, TaskRunShape, };
+export * from "./getBranch.js";
 /**
  * Trigger.dev v3 API client
  */
@@ -31,8 +32,9 @@ export declare class ApiClient {
     #private;
     readonly baseUrl: string;
     readonly accessToken: string;
+    readonly previewBranch?: string;
     private readonly defaultRequestOptions;
-    constructor(baseUrl: string, accessToken: string, requestOptions?: ApiRequestOptions);
+    constructor(baseUrl: string, accessToken: string, previewBranch?: string, requestOptions?: ApiRequestOptions);
     get fetchClient(): typeof fetch;
     getHeaders(): Record<string, string>;
     getRunResult(runId: string, requestOptions?: ZodFetchOptions): Promise<TaskRunExecutionResult | undefined>;
@@ -62,7 +64,6 @@ export declare class ApiClient {
         durationMs: number;
         costInCents: number;
         baseCostInCents: number;
-        attemptCount: number;
         taskIdentifier: string;
         relatedRuns: {
             root?: {
@@ -84,12 +85,12 @@ export declare class ApiClient {
                 isFailed: boolean;
                 isCancelled: boolean;
                 updatedAt: Date;
+                metadata?: Record<string, any> | undefined;
                 startedAt?: Date | undefined;
                 idempotencyKey?: string | undefined;
                 version?: string | undefined;
-                metadata?: Record<string, any> | undefined;
-                batchId?: string | undefined;
                 ttl?: string | undefined;
+                batchId?: string | undefined;
                 finishedAt?: Date | undefined;
                 delayedUntil?: Date | undefined;
                 expiredAt?: Date | undefined;
@@ -113,12 +114,12 @@ export declare class ApiClient {
                 isFailed: boolean;
                 isCancelled: boolean;
                 updatedAt: Date;
+                metadata?: Record<string, any> | undefined;
                 startedAt?: Date | undefined;
                 idempotencyKey?: string | undefined;
                 version?: string | undefined;
-                metadata?: Record<string, any> | undefined;
-                batchId?: string | undefined;
                 ttl?: string | undefined;
+                batchId?: string | undefined;
                 finishedAt?: Date | undefined;
                 delayedUntil?: Date | undefined;
                 expiredAt?: Date | undefined;
@@ -142,12 +143,12 @@ export declare class ApiClient {
                 isFailed: boolean;
                 isCancelled: boolean;
                 updatedAt: Date;
+                metadata?: Record<string, any> | undefined;
                 startedAt?: Date | undefined;
                 idempotencyKey?: string | undefined;
                 version?: string | undefined;
-                metadata?: Record<string, any> | undefined;
-                batchId?: string | undefined;
                 ttl?: string | undefined;
+                batchId?: string | undefined;
                 finishedAt?: Date | undefined;
                 delayedUntil?: Date | undefined;
                 expiredAt?: Date | undefined;
@@ -167,19 +168,27 @@ export declare class ApiClient {
             id: string;
             createdAt: Date;
             updatedAt: Date;
-            startedAt?: Date | undefined;
             error?: {
                 message: string;
                 name?: string | undefined;
                 stackTrace?: string | undefined;
             } | undefined;
+            startedAt?: Date | undefined;
             completedAt?: Date | undefined;
         } | undefined)[];
-        startedAt?: Date | undefined;
+        attemptCount: number;
         payload?: any;
+        error?: {
+            message: string;
+            name?: string | undefined;
+            stackTrace?: string | undefined;
+        } | undefined;
+        metadata?: Record<string, any> | undefined;
+        startedAt?: Date | undefined;
         idempotencyKey?: string | undefined;
         version?: string | undefined;
-        metadata?: Record<string, any> | undefined;
+        output?: any;
+        ttl?: string | undefined;
         schedule?: {
             id: string;
             generator: {
@@ -190,16 +199,9 @@ export declare class ApiClient {
             externalId?: string | undefined;
             deduplicationKey?: string | undefined;
         } | undefined;
-        error?: {
-            message: string;
-            name?: string | undefined;
-            stackTrace?: string | undefined;
-        } | undefined;
-        output?: any;
-        batchId?: string | undefined;
-        ttl?: string | undefined;
         payloadPresignedUrl?: string | undefined;
         outputPresignedUrl?: string | undefined;
+        batchId?: string | undefined;
         finishedAt?: Date | undefined;
         delayedUntil?: Date | undefined;
         expiredAt?: Date | undefined;
@@ -221,7 +223,6 @@ export declare class ApiClient {
         durationMs: number;
         costInCents: number;
         baseCostInCents: number;
-        attemptCount: number;
         taskIdentifier: string;
         relatedRuns: {
             root?: {
@@ -243,12 +244,12 @@ export declare class ApiClient {
                 isFailed: boolean;
                 isCancelled: boolean;
                 updatedAt: Date;
+                metadata?: Record<string, any> | undefined;
                 startedAt?: Date | undefined;
                 idempotencyKey?: string | undefined;
                 version?: string | undefined;
-                metadata?: Record<string, any> | undefined;
-                batchId?: string | undefined;
                 ttl?: string | undefined;
+                batchId?: string | undefined;
                 finishedAt?: Date | undefined;
                 delayedUntil?: Date | undefined;
                 expiredAt?: Date | undefined;
@@ -272,12 +273,12 @@ export declare class ApiClient {
                 isFailed: boolean;
                 isCancelled: boolean;
                 updatedAt: Date;
+                metadata?: Record<string, any> | undefined;
                 startedAt?: Date | undefined;
                 idempotencyKey?: string | undefined;
                 version?: string | undefined;
-                metadata?: Record<string, any> | undefined;
-                batchId?: string | undefined;
                 ttl?: string | undefined;
+                batchId?: string | undefined;
                 finishedAt?: Date | undefined;
                 delayedUntil?: Date | undefined;
                 expiredAt?: Date | undefined;
@@ -301,12 +302,12 @@ export declare class ApiClient {
                 isFailed: boolean;
                 isCancelled: boolean;
                 updatedAt: Date;
+                metadata?: Record<string, any> | undefined;
                 startedAt?: Date | undefined;
                 idempotencyKey?: string | undefined;
                 version?: string | undefined;
-                metadata?: Record<string, any> | undefined;
-                batchId?: string | undefined;
                 ttl?: string | undefined;
+                batchId?: string | undefined;
                 finishedAt?: Date | undefined;
                 delayedUntil?: Date | undefined;
                 expiredAt?: Date | undefined;
@@ -326,19 +327,27 @@ export declare class ApiClient {
             id: string;
             createdAt: Date;
             updatedAt: Date;
-            startedAt?: Date | undefined;
             error?: {
                 message: string;
                 name?: string | undefined;
                 stackTrace?: string | undefined;
             } | undefined;
+            startedAt?: Date | undefined;
             completedAt?: Date | undefined;
         } | undefined)[];
-        startedAt?: Date | undefined;
+        attemptCount: number;
         payload?: any;
+        error?: {
+            message: string;
+            name?: string | undefined;
+            stackTrace?: string | undefined;
+        } | undefined;
+        metadata?: Record<string, any> | undefined;
+        startedAt?: Date | undefined;
         idempotencyKey?: string | undefined;
         version?: string | undefined;
-        metadata?: Record<string, any> | undefined;
+        output?: any;
+        ttl?: string | undefined;
         schedule?: {
             id: string;
             generator: {
@@ -349,16 +358,9 @@ export declare class ApiClient {
             externalId?: string | undefined;
             deduplicationKey?: string | undefined;
         } | undefined;
-        error?: {
-            message: string;
-            name?: string | undefined;
-            stackTrace?: string | undefined;
-        } | undefined;
-        output?: any;
-        batchId?: string | undefined;
-        ttl?: string | undefined;
         payloadPresignedUrl?: string | undefined;
         outputPresignedUrl?: string | undefined;
+        batchId?: string | undefined;
         finishedAt?: Date | undefined;
         delayedUntil?: Date | undefined;
         expiredAt?: Date | undefined;
@@ -372,17 +374,17 @@ export declare class ApiClient {
         id: string;
         task: string;
         timezone: string;
+        environments: {
+            type: string;
+            id: string;
+            userName?: string | null | undefined;
+        }[];
         generator: {
             type: "CRON";
             description: string;
             expression: string;
         };
         active: boolean;
-        environments: {
-            type: string;
-            id: string;
-            userName?: string | null | undefined;
-        }[];
         externalId?: string | null | undefined;
         deduplicationKey?: string | null | undefined;
         nextRun?: Date | null | undefined;
@@ -427,17 +429,17 @@ export declare class ApiClient {
         id: string;
         task: string;
         timezone: string;
+        environments: {
+            type: string;
+            id: string;
+            userName?: string | null | undefined;
+        }[];
         generator: {
             type: "CRON";
             description: string;
             expression: string;
         };
         active: boolean;
-        environments: {
-            type: string;
-            id: string;
-            userName?: string | null | undefined;
-        }[];
         externalId?: string | null | undefined;
         deduplicationKey?: string | null | undefined;
         nextRun?: Date | null | undefined;
@@ -446,17 +448,17 @@ export declare class ApiClient {
         id: string;
         task: string;
         timezone: string;
+        environments: {
+            type: string;
+            id: string;
+            userName?: string | null | undefined;
+        }[];
         generator: {
             type: "CRON";
             description: string;
             expression: string;
         };
         active: boolean;
-        environments: {
-            type: string;
-            id: string;
-            userName?: string | null | undefined;
-        }[];
         externalId?: string | null | undefined;
         deduplicationKey?: string | null | undefined;
         nextRun?: Date | null | undefined;
@@ -466,17 +468,17 @@ export declare class ApiClient {
         id: string;
         task: string;
         timezone: string;
+        environments: {
+            type: string;
+            id: string;
+            userName?: string | null | undefined;
+        }[];
         generator: {
             type: "CRON";
             description: string;
             expression: string;
         };
         active: boolean;
-        environments: {
-            type: string;
-            id: string;
-            userName?: string | null | undefined;
-        }[];
         externalId?: string | null | undefined;
         deduplicationKey?: string | null | undefined;
         nextRun?: Date | null | undefined;
@@ -486,17 +488,17 @@ export declare class ApiClient {
         id: string;
         task: string;
         timezone: string;
+        environments: {
+            type: string;
+            id: string;
+            userName?: string | null | undefined;
+        }[];
         generator: {
             type: "CRON";
             description: string;
             expression: string;
         };
         active: boolean;
-        environments: {
-            type: string;
-            id: string;
-            userName?: string | null | undefined;
-        }[];
         externalId?: string | null | undefined;
         deduplicationKey?: string | null | undefined;
         nextRun?: Date | null | undefined;
@@ -506,17 +508,17 @@ export declare class ApiClient {
         id: string;
         task: string;
         timezone: string;
+        environments: {
+            type: string;
+            id: string;
+            userName?: string | null | undefined;
+        }[];
         generator: {
             type: "CRON";
             description: string;
             expression: string;
         };
         active: boolean;
-        environments: {
-            type: string;
-            id: string;
-            userName?: string | null | undefined;
-        }[];
         externalId?: string | null | undefined;
         deduplicationKey?: string | null | undefined;
         nextRun?: Date | null | undefined;
@@ -526,17 +528,17 @@ export declare class ApiClient {
         id: string;
         task: string;
         timezone: string;
+        environments: {
+            type: string;
+            id: string;
+            userName?: string | null | undefined;
+        }[];
         generator: {
             type: "CRON";
             description: string;
             expression: string;
         };
         active: boolean;
-        environments: {
-            type: string;
-            id: string;
-            userName?: string | null | undefined;
-        }[];
         externalId?: string | null | undefined;
         deduplicationKey?: string | null | undefined;
         nextRun?: Date | null | undefined;
@@ -545,16 +547,16 @@ export declare class ApiClient {
         id: string;
     }>;
     listEnvVars(projectRef: string, slug: string, requestOptions?: ZodFetchOptions): ApiPromise<{
-        name: string;
         value: string;
+        name: string;
         isSecret: boolean;
     }[]>;
     importEnvVars(projectRef: string, slug: string, body: ImportEnvironmentVariablesParams, requestOptions?: ZodFetchOptions): ApiPromise<{
         success: boolean;
     }>;
     retrieveEnvVar(projectRef: string, slug: string, key: string, requestOptions?: ZodFetchOptions): ApiPromise<{
-        name: string;
         value: string;
+        name: string;
         isSecret: boolean;
     }>;
     createEnvVar(projectRef: string, slug: string, body: CreateEnvironmentVariableRequestBody, requestOptions?: ZodFetchOptions): ApiPromise<{
@@ -576,6 +578,7 @@ export declare class ApiClient {
     listWaitpointTokens(params?: ListWaitpointTokensQueryParams, requestOptions?: ZodFetchOptions): CursorPagePromise<typeof WaitpointTokenItem>;
     retrieveWaitpointToken(friendlyId: string, requestOptions?: ZodFetchOptions): ApiPromise<{
         status: "COMPLETED" | "TIMED_OUT" | "WAITING";
+        url: string;
         id: string;
         tags: string[];
         createdAt: Date;
@@ -614,8 +617,8 @@ export declare class ApiClient {
         paused: z.ZodBoolean;
         releaseConcurrencyOnWaitpoint: z.ZodBoolean;
     }, "strip", z.ZodTypeAny, {
+        type: "custom" | "task";
         name: string;
-        type: "task" | "custom";
         id: string;
         concurrencyLimit: number | null;
         releaseConcurrencyOnWaitpoint: boolean;
@@ -623,8 +626,8 @@ export declare class ApiClient {
         queued: number;
         paused: boolean;
     }, {
+        type: "custom" | "task";
         name: string;
-        type: "task" | "custom";
         id: string;
         concurrencyLimit: number | null;
         releaseConcurrencyOnWaitpoint: boolean;
@@ -633,8 +636,8 @@ export declare class ApiClient {
         paused: boolean;
     }>>;
     retrieveQueue(queue: RetrieveQueueParam, requestOptions?: ZodFetchOptions): ApiPromise<{
+        type: "custom" | "task";
         name: string;
-        type: "task" | "custom";
         id: string;
         concurrencyLimit: number | null;
         releaseConcurrencyOnWaitpoint: boolean;
@@ -643,8 +646,8 @@ export declare class ApiClient {
         paused: boolean;
     }>;
     pauseQueue(queue: RetrieveQueueParam, action: "pause" | "resume", requestOptions?: ZodFetchOptions): ApiPromise<{
+        type: "custom" | "task";
         name: string;
-        type: "task" | "custom";
         id: string;
         concurrencyLimit: number | null;
         releaseConcurrencyOnWaitpoint: boolean;
@@ -656,14 +659,19 @@ export declare class ApiClient {
         signal?: AbortSignal;
         closeOnComplete?: boolean;
         onFetchError?: (error: Error) => void;
+        skipColumns?: string[];
     }): RunSubscription<TRunTypes>;
-    subscribeToRunsWithTag<TRunTypes extends AnyRunTypes>(tag: string | string[], options?: {
+    subscribeToRunsWithTag<TRunTypes extends AnyRunTypes>(tag: string | string[], filters?: {
+        createdAt?: string;
+        skipColumns?: string[];
+    }, options?: {
         signal?: AbortSignal;
         onFetchError?: (error: Error) => void;
     }): RunSubscription<TRunTypes>;
     subscribeToBatch<TRunTypes extends AnyRunTypes>(batchId: string, options?: {
         signal?: AbortSignal;
         onFetchError?: (error: Error) => void;
+        skipColumns?: string[];
     }): RunSubscription<TRunTypes>;
     fetchStream<T>(runId: string, streamKey: string, options?: {
         signal?: AbortSignal;
@@ -674,9 +682,9 @@ export declare class ApiClient {
         status: "COMPLETED" | "PENDING";
         id: string;
         createdAt: Date;
-        runCount: number;
         updatedAt: Date;
         runs: string[];
+        runCount: number;
         idempotencyKey?: string | undefined;
     }>;
 }

package/dist/commonjs/v3/apiClient/index.js

@@ -1,4 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiClient = exports.isRequestOptions = void 0;
 exports.mergeRequestOptions = mergeRequestOptions;
@@ -20,16 +34,19 @@ const DEFAULT_ZOD_FETCH_OPTIONS = {
         randomize: false,
     },
 };
+__exportStar(require("./getBranch.js"), exports);
 /**
  * Trigger.dev v3 API client
  */
 class ApiClient {
     baseUrl;
     accessToken;
+    previewBranch;
     defaultRequestOptions;
-    constructor(baseUrl, accessToken, requestOptions = {}) {
+    constructor(baseUrl, accessToken, previewBranch, requestOptions = {}) {
         this.accessToken = accessToken;
         this.baseUrl = baseUrl.replace(/\/$/, "");
+        this.previewBranch = previewBranch;
         this.defaultRequestOptions = mergeRequestOptions(DEFAULT_ZOD_FETCH_OPTIONS, requestOptions);
     }
     get fetchClient() {
@@ -429,7 +446,11 @@ class ApiClient {
         }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
     }
     subscribeToRun(runId, options) {
-        return (0, runStream_js_1.runShapeStream)(`${this.baseUrl}/realtime/v1/runs/${runId}`, {
+        const queryParams = new URLSearchParams();
+        if (options?.skipColumns) {
+            queryParams.append("skipColumns", options.skipColumns.join(","));
+        }
+        return (0, runStream_js_1.runShapeStream)(`${this.baseUrl}/realtime/v1/runs/${runId}${queryParams ? `?${queryParams}` : ""}`, {
             closeOnComplete: typeof options?.closeOnComplete === "boolean" ? options.closeOnComplete : true,
             headers: this.#getRealtimeHeaders(),
             client: this,
@@ -437,9 +458,11 @@ class ApiClient {
             onFetchError: options?.onFetchError,
         });
     }
-    subscribeToRunsWithTag(tag, options) {
+    subscribeToRunsWithTag(tag, filters, options) {
         const searchParams = createSearchQueryForSubscribeToRuns({
             tags: tag,
+            ...(filters ? { createdAt: filters.createdAt } : {}),
+            ...(filters?.skipColumns ? { skipColumns: filters.skipColumns } : {}),
         });
         return (0, runStream_js_1.runShapeStream)(`${this.baseUrl}/realtime/v1/runs${searchParams ? `?${searchParams}` : ""}`, {
             closeOnComplete: false,
@@ -450,7 +473,11 @@ class ApiClient {
         });
     }
     subscribeToBatch(batchId, options) {
-        return (0, runStream_js_1.runShapeStream)(`${this.baseUrl}/realtime/v1/batches/${batchId}`, {
+        const queryParams = new URLSearchParams();
+        if (options?.skipColumns) {
+            queryParams.append("skipColumns", options.skipColumns.join(","));
+        }
+        return (0, runStream_js_1.runShapeStream)(`${this.baseUrl}/realtime/v1/batches/${batchId}${queryParams ? `?${queryParams}` : ""}`, {
             closeOnComplete: false,
             headers: this.#getRealtimeHeaders(),
             client: this,
@@ -491,6 +518,9 @@ class ApiClient {
                 return acc;
             }, {}),
         };
+        if (this.previewBranch) {
+            headers["x-trigger-branch"] = this.previewBranch;
+        }
         // Only inject the context if we are inside a task
         if (task_context_api_js_1.taskContext.isInsideTask) {
             headers["x-trigger-worker"] = "true";
@@ -506,10 +536,13 @@ class ApiClient {
         return headers;
     }
     #getRealtimeHeaders() {
-        const headers = {
+        let headers = {
             Authorization: `Bearer ${this.accessToken}`,
             "trigger-version": version_js_1.VERSION,
         };
+        if (this.previewBranch) {
+            headers["x-trigger-branch"] = this.previewBranch;
+        }
         return headers;
     }
 }
@@ -523,6 +556,12 @@ function createSearchQueryForSubscribeToRuns(query) {
         if (query.tags) {
             searchParams.append("tags", Array.isArray(query.tags) ? query.tags.join(",") : query.tags);
         }
+        if (query.createdAt) {
+            searchParams.append("createdAt", query.createdAt);
+        }
+        if (query.skipColumns) {
+            searchParams.append("skipColumns", query.skipColumns.join(","));
+        }
     }
     return searchParams;
 }