@trigger.dev/core 0.0.0-prerelease-20260508090504 → 0.0.0-prerelease-20260810145618

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

@@ -14,21 +14,24 @@ 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.SSEStreamSubscription = exports.isRequestOptions = void 0;
+exports.ApiClient = exports.isRequestOptions = exports.SSEStreamSubscription = void 0;
 exports.mergeRequestOptions = mergeRequestOptions;
+const nanoid_1 = require("nanoid");
 const zod_1 = require("zod");
 const version_js_1 = require("../../version.js");
+const apiKeys_js_1 = require("../apiKeys.js");
 const jwt_js_1 = require("../jwt.js");
 const index_js_1 = require("../schemas/index.js");
+const wireProtocol_js_1 = require("../sessionStreams/wireProtocol.js");
 const task_context_api_js_1 = require("../task-context-api.js");
+const getEnv_js_1 = require("../utils/getEnv.js");
+const retries_js_1 = require("../utils/retries.js");
 const core_js_1 = require("./core.js");
 Object.defineProperty(exports, "isRequestOptions", { enumerable: true, get: function () { return core_js_1.isRequestOptions; } });
 const errors_js_1 = require("./errors.js");
-const retries_js_1 = require("../utils/retries.js");
 const runStream_js_1 = require("./runStream.js");
 Object.defineProperty(exports, "SSEStreamSubscription", { enumerable: true, get: function () { return runStream_js_1.SSEStreamSubscription; } });
 const version_js_2 = require("./version.js");
-const getEnv_js_1 = require("../utils/getEnv.js");
 const DEFAULT_ZOD_FETCH_OPTIONS = {
     retry: {
         maxAttempts: 5,
@@ -39,6 +42,7 @@ const DEFAULT_ZOD_FETCH_OPTIONS = {
     },
 };
 __exportStar(require("./getBranch.js"), exports);
+const CreatePublicTokenResponseBody = zod_1.z.object({ token: zod_1.z.string() });
 /**
  * Trigger.dev v3 API client
  */
@@ -49,7 +53,10 @@ class ApiClient {
     futureFlags;
     additionalHeaders;
     defaultRequestOptions;
-    constructor(baseUrl, accessToken, previewBranch, requestOptions = {}, futureFlags = {}) {
+    constructor(baseUrl, accessToken, 
+    // Carries the branch for any branchable env (preview or dev) — both ride the
+    // x-trigger-branch header, and the server disambiguates by the token's env.
+    previewBranch, requestOptions = {}, futureFlags = {}) {
         this.accessToken = accessToken;
         this.baseUrl = baseUrl.replace(/\/$/, "");
         this.previewBranch = previewBranch;
@@ -58,6 +65,17 @@ class ApiClient {
         this.defaultRequestOptions = mergeRequestOptions(DEFAULT_ZOD_FETCH_OPTIONS, restRequestOptions);
         this.futureFlags = futureFlags;
     }
+    /**
+     * Key for signing a public access token locally. Only root keys can do this —
+     * an additional key isn't the environment's signing material, so a token
+     * signed with one would never verify. Throw rather than return a dead token.
+     */
+    get #selfSigningKey() {
+        if ((0, apiKeys_js_1.isAdditionalApiKey)(this.accessToken)) {
+            throw new Error("This additional API key cannot self-sign public tokens, and the server did not return one. Upgrade the server or use the root API key.");
+        }
+        return this.accessToken;
+    }
     get fetchClient() {
         const headers = this.#getHeaders(false);
         const fetchClient = (input, requestInit) => {
@@ -116,7 +134,7 @@ class ApiClient {
             const claimsHeader = response.headers.get("x-trigger-jwt-claims");
             const claims = claimsHeader ? JSON.parse(claimsHeader) : undefined;
             const jwt = await (0, jwt_js_1.generateJWT)({
-                secretKey: this.accessToken,
+                secretKey: this.#selfSigningKey,
                 payload: {
                     ...claims,
                     scopes: [`read:runs:${data.id}`],
@@ -139,10 +157,17 @@ class ApiClient {
         }, mergeRequestOptions(this.defaultRequestOptions, requestOptions))
             .withResponse()
             .then(async ({ data, response }) => {
+            const jwtHeader = response.headers.get("x-trigger-jwt");
+            if (typeof jwtHeader === "string") {
+                return {
+                    ...data,
+                    publicAccessToken: jwtHeader,
+                };
+            }
             const claimsHeader = response.headers.get("x-trigger-jwt-claims");
             const claims = claimsHeader ? JSON.parse(claimsHeader) : undefined;
             const jwt = await (0, jwt_js_1.generateJWT)({
-                secretKey: this.accessToken,
+                secretKey: this.#selfSigningKey,
                 payload: {
                     ...claims,
                     scopes: [`read:batch:${data.id}`],
@@ -175,10 +200,17 @@ class ApiClient {
         }, mergeRequestOptions(this.defaultRequestOptions, requestOptions))
             .withResponse()
             .then(async ({ data, response }) => {
+            const jwtHeader = response.headers.get("x-trigger-jwt");
+            if (typeof jwtHeader === "string") {
+                return {
+                    ...data,
+                    publicAccessToken: jwtHeader,
+                };
+            }
             const claimsHeader = response.headers.get("x-trigger-jwt-claims");
             const claims = claimsHeader ? JSON.parse(claimsHeader) : undefined;
             const jwt = await (0, jwt_js_1.generateJWT)({
-                secretKey: this.accessToken,
+                secretKey: this.#selfSigningKey,
                 payload: {
                     ...claims,
                     scopes: [`read:batch:${data.id}`],
@@ -328,6 +360,20 @@ class ApiClient {
             headers: this.#getHeaders(false),
         }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
     }
+    /** Presigned PUT URL for a `chat.agent` session snapshot. */
+    createChatSnapshotUploadUrl(sessionId, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.CreateUploadPayloadUrlResponseBody, `${this.baseUrl}/api/v1/sessions/${encodeURIComponent(sessionId)}/snapshot-url`, {
+            method: "PUT",
+            headers: this.#getHeaders(false),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    /** Presigned GET URL for a `chat.agent` session snapshot. */
+    getChatSnapshotUrl(sessionId, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.CreateUploadPayloadUrlResponseBody, `${this.baseUrl}/api/v1/sessions/${encodeURIComponent(sessionId)}/snapshot-url`, {
+            method: "GET",
+            headers: this.#getHeaders(false),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
     retrieveRun(runId, requestOptions) {
         return (0, core_js_1.zodfetch)(index_js_1.RetrieveRunResponse, `${this.baseUrl}/api/v3/runs/${runId}`, {
             method: "GET",
@@ -385,6 +431,36 @@ class ApiClient {
             headers: this.#getHeaders(false),
         }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
     }
+    createBulkAction(options, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.CreateBulkActionResponseBody, `${this.baseUrl}/api/v1/bulk-actions`, {
+            method: "POST",
+            headers: this.#getHeaders(false),
+            body: JSON.stringify(options),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    listBulkActions(query, requestOptions) {
+        return (0, core_js_1.zodfetchCursorPage)(index_js_1.BulkActionObject, `${this.baseUrl}/api/v1/bulk-actions`, {
+            query: new URLSearchParams(),
+            limit: query?.limit,
+            after: query?.after,
+            before: query?.before,
+        }, {
+            method: "GET",
+            headers: this.#getHeaders(false),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    retrieveBulkAction(bulkActionId, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.BulkActionObject, `${this.baseUrl}/api/v1/bulk-actions/${bulkActionId}`, {
+            method: "GET",
+            headers: this.#getHeaders(false),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    abortBulkAction(bulkActionId, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.AbortBulkActionResponseBody, `${this.baseUrl}/api/v1/bulk-actions/${bulkActionId}/abort`, {
+            method: "POST",
+            headers: this.#getHeaders(false),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
     resetIdempotencyKey(taskIdentifier, idempotencyKey, requestOptions) {
         return (0, core_js_1.zodfetch)(index_js_1.ResetIdempotencyKeyResponse, `${this.baseUrl}/api/v1/idempotencyKeys/${encodeURIComponent(idempotencyKey)}/reset`, {
             method: "POST",
@@ -537,7 +613,7 @@ class ApiClient {
                 const claimsHeader = response.headers.get("x-trigger-jwt-claims");
                 const claims = claimsHeader ? JSON.parse(claimsHeader) : undefined;
                 const jwt = await (0, jwt_js_1.generateJWT)({
-                    secretKey: this.accessToken,
+                    secretKey: this.#selfSigningKey,
                     payload: {
                         ...claims,
                         scopes: [`write:waitpoints:${data.id}`],
@@ -584,6 +660,157 @@ class ApiClient {
             headers: this.#getHeaders(false),
         }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
     }
+    // ========================================================================
+    // Sessions
+    // ========================================================================
+    createSession(body, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.CreatedSessionResponseBody, `${this.baseUrl}/api/v1/sessions`, {
+            method: "POST",
+            headers: this.#getHeaders(false),
+            body: JSON.stringify(body),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    retrieveSession(sessionIdOrExternalId, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.RetrieveSessionResponseBody, `${this.baseUrl}/api/v1/sessions/${encodeURIComponent(sessionIdOrExternalId)}`, {
+            method: "GET",
+            headers: this.#getHeaders(false),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    updateSession(sessionIdOrExternalId, body, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.RetrieveSessionResponseBody, `${this.baseUrl}/api/v1/sessions/${encodeURIComponent(sessionIdOrExternalId)}`, {
+            method: "PATCH",
+            headers: this.#getHeaders(false),
+            body: JSON.stringify(body),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    closeSession(sessionIdOrExternalId, body, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.RetrieveSessionResponseBody, `${this.baseUrl}/api/v1/sessions/${encodeURIComponent(sessionIdOrExternalId)}/close`, {
+            method: "POST",
+            headers: this.#getHeaders(false),
+            body: JSON.stringify(body ?? {}),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    endAndContinueSession(sessionIdOrExternalId, body, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.EndAndContinueSessionResponseBody, `${this.baseUrl}/api/v1/sessions/${encodeURIComponent(sessionIdOrExternalId)}/end-and-continue`, {
+            method: "POST",
+            headers: this.#getHeaders(false),
+            body: JSON.stringify(body),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    listSessions(options, requestOptions) {
+        const searchParams = createSearchQueryForListSessions(options);
+        return (0, core_js_1.zodfetchCursorPage)(index_js_1.ListedSessionItem, `${this.baseUrl}/api/v1/sessions`, {
+            query: searchParams,
+            limit: options?.limit,
+            after: options?.after,
+            before: options?.before,
+        }, {
+            method: "GET",
+            headers: this.#getHeaders(false),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    // ========================================================================
+    // Session realtime channels
+    // ========================================================================
+    async initializeSessionStream(sessionIdOrExternalId, io, requestOptions) {
+        // The server returns S2 credentials in response headers alongside a tiny
+        // JSON body with the realtime version. Follow the same shape as
+        // `createStream` so downstream clients can feed them into
+        // `StreamsWriterV2`.
+        return (0, core_js_1.zodfetch)(index_js_1.CreateStreamResponseBody, `${this.baseUrl}/realtime/v1/sessions/${encodeURIComponent(sessionIdOrExternalId)}/${io}`, {
+            method: "PUT",
+            headers: this.#getHeaders(false),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions))
+            .withResponse()
+            .then(({ data, response }) => ({
+            ...data,
+            headers: Object.fromEntries(response.headers.entries()),
+        }));
+    }
+    async appendToSessionStream(sessionIdOrExternalId, io, part, requestOptions) {
+        // Generated once per logical append, outside zodfetch, so its internal
+        // retries reuse the same part id and the server-side dedupe collapses a
+        // retried POST whose first attempt actually committed. Full-length nanoid
+        // (~126 bits) to match the browser transport's randomUUID entropy.
+        const partId = (0, nanoid_1.nanoid)();
+        return (0, core_js_1.zodfetch)(index_js_1.AppendToStreamResponseBody, `${this.baseUrl}/realtime/v1/sessions/${encodeURIComponent(sessionIdOrExternalId)}/${io}/append`, {
+            method: "POST",
+            headers: { ...this.#getHeaders(false), "X-Part-Id": partId },
+            body: part,
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
+    /**
+     * Non-SSE drain of a Session channel's tail. Returns whatever records
+     * exist after `afterEventId` (or from the head of the stream) and closes
+     * — `wait=0` semantics, no long-poll. Used by `replaySessionOutTail` at
+     * run boot, where the SSE long-poll's ~1s tax on empty streams is the
+     * dominant cost on every fresh chat.
+     *
+     * `afterEventId` is the same cursor format as the SSE Last-Event-ID
+     * (the S2 sequence number, stringified) — pass `lastOutEventId` from a
+     * persisted snapshot to resume.
+     */
+    async readSessionStreamRecords(sessionIdOrExternalId, io, options) {
+        const qs = new URLSearchParams();
+        if (options?.afterEventId !== undefined) {
+            qs.set("afterEventId", options.afterEventId);
+        }
+        const url = `${options?.baseUrl ?? this.baseUrl}/realtime/v1/sessions/${encodeURIComponent(sessionIdOrExternalId)}/${io}/records${qs.toString() ? `?${qs.toString()}` : ""}`;
+        return (0, core_js_1.zodfetch)(index_js_1.ReadSessionStreamRecordsResponseBody, url, {
+            method: "GET",
+            headers: this.#getHeaders(false),
+        }, mergeRequestOptions(this.defaultRequestOptions, undefined));
+    }
+    /**
+     * Subscribe to SSE records on a Session channel. Reuses the same
+     * {@link SSEStreamSubscription} plumbing as `readStream` for run-scoped
+     * realtime streams — auto-retry, Last-Event-ID resume, abort-on-cancel.
+     */
+    async subscribeToSessionStream(sessionIdOrExternalId, io, options) {
+        const url = `${options?.baseUrl ?? this.baseUrl}/realtime/v1/sessions/${encodeURIComponent(sessionIdOrExternalId)}/${io}`;
+        const subscription = new runStream_js_1.SSEStreamSubscription(url, {
+            headers: this.getHeaders(),
+            signal: options?.signal,
+            onComplete: options?.onComplete,
+            onError: options?.onError,
+            timeoutInSeconds: options?.timeoutInSeconds,
+            lastEventId: options?.lastEventId,
+        });
+        const stream = await subscription.subscribe();
+        const onPart = options?.onPart;
+        const onControl = options?.onControl;
+        return stream.pipeThrough(new TransformStream({
+            transform(part, controller) {
+                // Always surface the raw part via onPart so cursor tracking
+                // (lastSeqNum, lastEventId) stays correct for both data and
+                // control records.
+                onPart?.(part);
+                // Trigger control record — route to onControl, never enqueue.
+                const subtype = (0, wireProtocol_js_1.controlSubtype)(part.headers);
+                if (subtype) {
+                    // `part.id` is the S2 seq_num in decimal string form.
+                    // `parseInt` returns NaN if S2 ever surfaces a non-numeric
+                    // id (shouldn't happen, but `|| 0` would mask it as a real
+                    // seq 0). Drop the malformed event rather than fire
+                    // `onControl` with a misleading cursor — callers like
+                    // `findLatestSessionInCursor` and the dashboard rely on the
+                    // seqNum being meaningful for resume.
+                    const parsedSeqNum = Number.parseInt(part.id, 10);
+                    if (!Number.isFinite(parsedSeqNum)) {
+                        return;
+                    }
+                    onControl?.({
+                        subtype,
+                        headers: part.headers ?? [],
+                        seqNum: parsedSeqNum,
+                        timestamp: part.timestamp,
+                    });
+                    return;
+                }
+                controller.enqueue(part.chunk);
+            },
+        }));
+    }
     async waitForDuration(runId, body, requestOptions) {
         return (0, core_js_1.zodfetch)(index_js_1.WaitForDurationResponseBody, `${this.baseUrl}/engine/v1/runs/${runId}/wait/duration`, {
             method: "POST",
@@ -721,6 +948,12 @@ class ApiClient {
             headers: this.#getHeaders(false),
         }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
     }
+    retrieveCurrentDeployment(requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.RetrieveCurrentDeploymentResponseBody, `${this.baseUrl}/api/v1/deployments/current`, {
+            method: "GET",
+            headers: this.#getHeaders(false),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
     async fetchStream(runId, streamKey, options) {
         const streamFactory = new runStream_js_1.SSEStreamSubscriptionFactory(options?.baseUrl ?? this.baseUrl, {
             headers: this.getHeaders(),
@@ -776,12 +1009,26 @@ class ApiClient {
             body: JSON.stringify(body),
         }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
     }
+    async createSessionStreamWaitpoint(runFriendlyId, body, requestOptions) {
+        return (0, core_js_1.zodfetch)(index_js_1.CreateSessionStreamWaitpointResponseBody, `${this.baseUrl}/api/v1/runs/${runFriendlyId}/session-streams/wait`, {
+            method: "POST",
+            headers: this.#getHeaders(false),
+            body: JSON.stringify(body),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
     async generateJWTClaims(requestOptions) {
         return (0, core_js_1.zodfetch)(zod_1.z.record(zod_1.z.any()), `${this.baseUrl}/api/v1/auth/jwt/claims`, {
             method: "POST",
             headers: this.#getHeaders(false),
         }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
     }
+    async createPublicToken(body, requestOptions) {
+        return (0, core_js_1.zodfetch)(CreatePublicTokenResponseBody, `${this.baseUrl}/api/v1/auth/public-tokens`, {
+            method: "POST",
+            headers: this.#getHeaders(false),
+            body: JSON.stringify(body),
+        }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
+    }
     retrieveBatch(batchId, requestOptions) {
         return (0, core_js_1.zodfetch)(index_js_1.RetrieveBatchV2Response, `${this.baseUrl}/api/v2/batches/${batchId}`, {
             method: "GET",
@@ -815,6 +1062,25 @@ class ApiClient {
             headers: this.#getHeaders(false),
         }, mergeRequestOptions(this.defaultRequestOptions, requestOptions));
     }
+    /**
+     * Fetch a server-rendered report (text + sparkline). Thin pass-through — the string
+     * is ready to display. `format`: "markdown" (default, agents/chat) or "ansi" (terminal).
+     */
+    async getReport(key, options) {
+        const searchParams = new URLSearchParams({ format: options?.format ?? "markdown" });
+        if (options?.period) {
+            searchParams.set("period", options.period);
+        }
+        const response = await fetch(`${this.baseUrl}/api/v1/reports/${encodeURIComponent(key)}?${searchParams.toString()}`, {
+            method: "GET",
+            headers: this.#getHeaders(false),
+        });
+        if (!response.ok) {
+            const bodySnippet = await readBodySnippet(response);
+            throw new Error(`Failed to fetch report "${key}": ${response.status} ${response.statusText}${bodySnippet ? ` — ${bodySnippet}` : ""}`);
+        }
+        return response.text();
+    }
     #getHeaders(spanParentAsLink, additionalHeaders) {
         const headers = {
             "Content-Type": "application/json",
@@ -968,6 +1234,9 @@ function createSearchQueryForListRuns(query) {
         if (query.machine) {
             searchParams.append("filter[machine]", Array.isArray(query.machine) ? query.machine.join(",") : query.machine);
         }
+        if (query.region) {
+            searchParams.append("filter[region]", Array.isArray(query.region) ? query.region.join(",") : query.region);
+        }
     }
     return searchParams;
 }
@@ -977,6 +1246,33 @@ function queueNameFromQueueTypeName(queue) {
     }
     return queue.name;
 }
+function createSearchQueryForListSessions(options) {
+    const searchParams = new URLSearchParams();
+    if (!options)
+        return searchParams;
+    const appendMany = (name, value) => {
+        if (value === undefined)
+            return;
+        searchParams.append(name, Array.isArray(value) ? value.join(",") : value);
+    };
+    appendMany("filter[type]", options.type);
+    appendMany("filter[tags]", options.tag);
+    appendMany("filter[taskIdentifier]", options.taskIdentifier);
+    if (options.externalId) {
+        searchParams.append("filter[externalId]", options.externalId);
+    }
+    appendMany("filter[status]", options.status);
+    if (options.period) {
+        searchParams.append("filter[createdAt][period]", options.period);
+    }
+    if (options.from !== undefined) {
+        searchParams.append("filter[createdAt][from]", options.from instanceof Date ? options.from.getTime().toString() : options.from.toString());
+    }
+    if (options.to !== undefined) {
+        searchParams.append("filter[createdAt][to]", options.to instanceof Date ? options.to.getTime().toString() : options.to.toString());
+    }
+    return searchParams;
+}
 function createSearchQueryForListWaitpointTokens(query) {
     const searchParams = new URLSearchParams();
     if (query) {
@@ -1076,6 +1372,22 @@ function shouldRetryStreamBatchItems(response, attempt, retryOptions) {
 function sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }
+/**
+ * Best-effort read of a (likely error) response body for inclusion in a thrown Error.
+ * Never throws, and truncates so we don't dump a huge HTML page into an error message.
+ */
+async function readBodySnippet(response, maxLength = 500) {
+    try {
+        const text = (await response.text()).trim();
+        if (!text) {
+            return "";
+        }
+        return text.length > maxLength ? `${text.slice(0, maxLength)}…` : text;
+    }
+    catch {
+        return "";
+    }
+}
 /**
  * Safely cancels a ReadableStream, handling the case where it might be locked.
  *