@trigger.dev/core 4.5.16 → 4.6.0

package/dist/esm/v3/schemas/api.js

@@ -1,4 +1,5 @@
-import { z } from "zod";
+import { z } from "zod/v4";
+import { discriminatedUnion } from "../utils/zod.js";
 import { DeserializedJsonSchema } from "../../schemas/json.js";
 import { EXTERNAL_DEPLOYMENT_ID_MAX_LENGTH } from "../externalDeploymentId.js";
 import { FlushedRunMetadata, GitMeta, MachinePresetName, SerializedError, TaskRunError, } from "./common.js";
@@ -168,6 +169,8 @@ export const GetJWTRequestBody = z.object({
 });
 export const GetJWTResponse = z.object({
     token: z.string(),
+    // The environment the exchange resolved, so a caller that named a slug learns the id.
+    environmentId: z.string().optional(),
 });
 export const CreateBackgroundWorkerRequestBody = z.object({
     localOnly: z.boolean(),
@@ -196,6 +199,10 @@ export const IdempotencyKeyOptionsSchema = z.object({
 // with PrismaClientValidationError. Accept the intent and stringify here.
 const ConcurrencyKeySchema = z.union([z.string(), z.number()]).transform((value) => String(value));
 const ExternalDeploymentId = z.preprocess((value) => {
+    // `null` is the opt-out sentinel callers write; treat it as absent, not a validation error.
+    if (value === null) {
+        return undefined;
+    }
     if (typeof value !== "string") {
         return value;
     }
@@ -204,8 +211,8 @@ const ExternalDeploymentId = z.preprocess((value) => {
 }, z.string().max(EXTERNAL_DEPLOYMENT_ID_MAX_LENGTH, `externalId must be at most ${EXTERNAL_DEPLOYMENT_ID_MAX_LENGTH} characters`).optional());
 export const TriggerTaskRequestBody = z
     .object({
-    payload: z.any(),
-    context: z.any(),
+    payload: z.any().optional(),
+    context: z.any().optional(),
     options: z
         .object({
         /** @deprecated engine v1 only */
@@ -263,7 +270,7 @@ export const TriggerTaskRequestBody = z
         machine: MachinePresetName.optional(),
         maxAttempts: z.number().int().optional(),
         maxDuration: z.number().optional(),
-        metadata: z.any(),
+        metadata: z.any().optional(),
         metadataType: z.string().optional(),
         payloadType: z.string().optional(),
         /**
@@ -311,8 +318,8 @@ export const BatchTriggerTaskRequestBody = z.object({
 });
 export const BatchTriggerTaskItem = z.object({
     task: z.string(),
-    payload: z.any(),
-    context: z.any(),
+    payload: z.any().optional(),
+    context: z.any().optional(),
     options: z
         .object({
         concurrencyKey: ConcurrencyKeySchema.optional(),
@@ -333,7 +340,7 @@ export const BatchTriggerTaskItem = z.object({
         machine: MachinePresetName.optional(),
         maxAttempts: z.number().int().optional(),
         maxDuration: z.number().optional(),
-        metadata: z.any(),
+        metadata: z.any().optional(),
         metadataType: z.string().optional(),
         parentAttempt: z.string().optional(),
         payloadType: z.string().optional(),
@@ -449,7 +456,7 @@ export const CreateBatchResponse = z.object({
  *
  * `options` reuses the strict shape from BatchTriggerTaskItem so that the
  * Phase-2 streaming path validates option fields identically to the V2/V3
- * batch trigger endpoints — historically this used z.record(z.unknown()) and
+ * batch trigger endpoints — historically this used z.record(z.string(), z.unknown()) and
  * let invalid values (e.g. numeric concurrencyKey) reach Prisma.
  */
 export const BatchItemNDJSON = z.object({
@@ -501,7 +508,7 @@ export const RescheduleRunRequestBody = z.object({
     delay: z.string().or(z.coerce.date()),
 });
 export const GetEnvironmentVariablesResponseBody = z.object({
-    variables: z.record(z.string()),
+    variables: z.record(z.string(), z.string()),
 });
 export const StartDeploymentIndexingRequestBody = z.object({
     imageReference: z.string(),
@@ -525,6 +532,10 @@ export const BuildServerMetadata = z.object({
     skipEnqueue: z.boolean().optional(),
     fromBundle: z.boolean().optional(),
 });
+export const GetDeploymentArtifactUrlResponseBody = z.object({
+    url: z.string().url(),
+    expiresAt: z.string().datetime(),
+});
 export const ProgressDeploymentRequestBody = z.object({
     contentHash: z.string().optional(),
     gitMeta: GitMeta.optional(),
@@ -565,6 +576,12 @@ export const UpsertBranchRequestBody = z.object({
 });
 export const UpsertBranchResponseBody = z.object({
     id: z.string(),
+    autoArchivedBranches: z
+        .array(z.object({
+        id: z.string(),
+        branchName: z.string(),
+    }))
+        .optional(),
 });
 export const CreateArtifactRequestBody = z.object({
     type: z.enum(["deployment_context", "deployment_bundle"]).default("deployment_context"),
@@ -574,7 +591,7 @@ export const CreateArtifactRequestBody = z.object({
 export const CreateArtifactResponseBody = z.object({
     artifactKey: z.string(),
     uploadUrl: z.string(),
-    uploadFields: z.record(z.string()),
+    uploadFields: z.record(z.string(), z.string()),
     expiresAt: z.string().datetime(),
 });
 export const InitializeDeploymentResponseBody = z.object({
@@ -623,7 +640,7 @@ const InitializeDeploymentRequestBodyFull = InitializeDeploymentRequestBodyBase.
     // The artifact is a pre-built bundle; the build server only runs the container build
     fromBundle: z.boolean().optional(),
     // Build-time env var values for fromBundle deploys, stored encrypted on the deployment
-    buildEnvVars: z.record(z.string()).optional(),
+    buildEnvVars: z.record(z.string(), z.string()).optional(),
 }).superRefine((data, ctx) => {
     if (data.force && !data.externalId) {
         ctx.addIssue({
@@ -689,6 +706,15 @@ export const GetDeploymentResponseBody = z.object({
     imageReference: z.string().nullish(),
     imagePlatform: z.string(),
     commitSHA: z.string().nullish(),
+    /**
+     * The `--external-id` this deployment was deployed under, used by version skew
+     * protection to pin runs. Distinct from `commitSHA`, which is git metadata.
+     *
+     * `optional`, not `nullish`, to stay assignable to the CLI's narrower
+     * `InitializeDeploymentResponseBody` shape, which this is spread into on the
+     * attach-to-existing-deployment path (`cli-v3/src/commands/deploy.ts:1156`).
+     */
+    externalId: z.string().optional(),
     externalBuildData: ExternalBuildData.optional().nullable(),
     errorData: DeploymentErrorData.nullish(),
     canceledReason: z.string().nullish(),
@@ -716,7 +742,7 @@ export const GetDeploymentResponseBody = z.object({
 });
 // Secret material, deliberately kept off GetDeploymentResponseBody
 export const GetDeploymentBuildEnvVarsResponseBody = z.object({
-    variables: z.record(z.string()),
+    variables: z.record(z.string(), z.string()),
 });
 export const GetLatestDeploymentResponseBody = GetDeploymentResponseBody.omit({
     worker: true,
@@ -735,7 +761,7 @@ export const DeploymentFinalizedEvent = z.object({
         message: z.string().optional(),
     }),
 });
-export const DeploymentEvent = z.discriminatedUnion("type", [
+export const DeploymentEvent = discriminatedUnion("type", [
     DeploymentLogEvent,
     DeploymentFinalizedEvent,
 ]);
@@ -756,6 +782,17 @@ export const CreateUploadPayloadUrlResponseBody = z.object({
     /** Present on `/api/v2/packets` PUT (upload handshake); omitted on v1 GET download presign. */
     storagePath: z.string().optional(),
 });
+/** One page of a `chat.agent` session transcript, from `GET /api/v1/sessions/{id}/transcript`. */
+export const SessionTranscriptResponseBody = z.object({
+    messages: z.array(z.unknown()),
+    cursors: z
+        .object({
+        lastOutEventId: z.string().optional(),
+        lastInEventId: z.string().optional(),
+    })
+        .optional(),
+    nextCursor: z.string().optional(),
+});
 export const WorkersListResponseBody = z
     .object({
     type: z.string(),
@@ -915,6 +952,17 @@ export const ScheduleObject = z.object({
     nextRun: z.coerce.date().nullish(),
     /** The stable assigned time for the next nominal CRON time. */
     nextRunEffectiveAt: z.coerce.date().nullish(),
+    /**
+     * Present when a non-overridable plan policy applies a minimum window to this schedule (e.g.
+     * a free-plan schedule's 60-minute minimum). The configured `window` is returned separately
+     * and unchanged; this describes the floor applied on top of it.
+     */
+    appliedSchedulePolicy: z
+        .object({
+        minimumWindowSeconds: z.number(),
+        reason: z.literal("free_schedule"),
+    })
+        .optional(),
     environments: z.array(z.object({
         id: z.string(),
         type: z.string(),
@@ -1017,7 +1065,7 @@ const CommonRunFields = {
     costInCents: z.number(),
     baseCostInCents: z.number(),
     durationMs: z.number(),
-    metadata: z.record(z.any()).optional(),
+    metadata: z.record(z.string(), z.any()).optional(),
     taskKind: z.string().optional(),
     region: z.string().optional(),
 };
@@ -1096,8 +1144,7 @@ const BulkActionSelectionRequestBody = {
     runIds: z.array(z.string()).min(1).optional(),
     name: z.string().max(255, "Name must be less than 255 characters").optional(),
 };
-export const CreateBulkActionRequestBody = z
-    .discriminatedUnion("action", [
+export const CreateBulkActionRequestBody = discriminatedUnion("action", [
     z.object({
         action: z.literal("cancel"),
         targetRegion: z.never().optional(),
@@ -1108,8 +1155,7 @@ export const CreateBulkActionRequestBody = z
         targetRegion: z.string().optional(),
         ...BulkActionSelectionRequestBody,
     }),
-])
-    .refine((body) => (body.filter ? 1 : 0) + (body.runIds ? 1 : 0) === 1, {
+]).refine((body) => (body.filter ? 1 : 0) + (body.runIds ? 1 : 0) === 1, {
     message: "Exactly one of filter or runIds must be provided",
 });
 export const BulkActionStatus = z.enum(["PENDING", "COMPLETED", "ABORTED"]);
@@ -1150,17 +1196,15 @@ export const UpdateEnvironmentVariableRequestBody = z.object({
     value: z.string(),
 });
 export const ImportEnvironmentVariablesRequestBody = z.object({
-    variables: z.record(z.string()),
-    parentVariables: z.record(z.string()).optional(),
+    variables: z.record(z.string(), z.string()),
+    parentVariables: z.record(z.string(), z.string()).optional(),
     override: z.boolean().optional(),
     // When omitted, variables default to non-secret (the DB default is false).
     isSecret: z.boolean().optional(),
-    source: z
-        .discriminatedUnion("type", [
+    source: discriminatedUnion("type", [
         z.object({ type: z.literal("user"), userId: z.string() }),
         z.object({ type: z.literal("integration"), integration: z.string() }),
-    ])
-        .optional(),
+    ]).optional(),
 });
 export const EnvironmentVariableResponseBody = z.object({
     success: z.boolean(),
@@ -1189,7 +1233,7 @@ export const EnvironmentVariableWithSecret = z.object({
 });
 export const UpdateMetadataRequestBody = FlushedRunMetadata;
 export const UpdateMetadataResponseBody = z.object({
-    metadata: z.record(DeserializedJsonSchema),
+    metadata: z.record(z.string(), DeserializedJsonSchema),
 });
 const RawShapeDate = z
     .string()
@@ -1403,7 +1447,7 @@ export const CompleteWaitpointTokenRequestBody = z.object({
  * server's trigger machinery.
  */
 export const SessionTriggerConfig = z.object({
-    basePayload: z.record(z.unknown()),
+    basePayload: z.record(z.string(), z.unknown()),
     machine: MachinePresetName.optional(),
     queue: z.string().max(128).optional(),
     tags: z.array(z.string().max(128)).max(10).optional(),
@@ -1412,10 +1456,17 @@ export const SessionTriggerConfig = z.object({
     maxDuration: z.number().int().positive().optional(),
     /** Pin every run to a specific worker version. Forwarded to `TaskRunOptions.lockToVersion`. */
     lockToVersion: z.string().optional(),
+    /**
+     * Pin every run the session schedules to the deployment carrying this id, refreshed by each
+     * `sessions.start`. Independent of `lockToVersion`, which wins.
+     */
+    externalDeploymentId: ExternalDeploymentId,
     /** Region to schedule runs in. Forwarded to `TaskRunOptions.region`. */
     region: z.string().optional(),
     /** Convenience field surfaced to chat.agent via the wire payload. */
     idleTimeoutInSeconds: z.number().int().positive().max(3600).optional(),
+    /** How long a run may sit undequeued before it expires. Forwarded to `TaskRunOptions.ttl`. */
+    ttl: z.string().or(z.number().nonnegative().int()).optional(),
 });
 /**
  * Request body for `POST /api/v1/sessions`. Creates a Session and
@@ -1444,7 +1495,7 @@ export const CreateSessionRequestBody = z.object({
     /** Up to 10 tags for dashboard filtering. */
     tags: z.array(z.string().max(128)).max(10).optional(),
     /** Arbitrary JSON metadata. */
-    metadata: z.record(z.unknown()).optional(),
+    metadata: z.record(z.string(), z.unknown()).optional(),
     /** Absolute expiry timestamp for retention. */
     expiresAt: z.coerce.date().optional(),
 });
@@ -1467,7 +1518,7 @@ export const SessionItem = z.object({
      */
     currentRunId: z.string().nullable().optional(),
     tags: z.array(z.string()),
-    metadata: z.record(z.unknown()).nullable(),
+    metadata: z.record(z.string(), z.unknown()).nullable(),
     closedAt: z.coerce.date().nullable(),
     closedReason: z.string().nullable(),
     expiresAt: z.coerce.date().nullable(),
@@ -1481,6 +1532,11 @@ export const CreatedSessionResponseBody = SessionItem.extend({
     publicAccessToken: z.string(),
     /** True if the session existed already (idempotent upsert), false if newly created. */
     isCached: z.boolean(),
+    /**
+     * The session's live run is parked waiting for a deployment carrying its external deployment
+     * id. Messages sent meanwhile are durable. Optional, so older servers read as `false`.
+     */
+    pendingVersion: z.boolean().optional(),
 });
 export const RetrieveSessionResponseBody = SessionItem;
 /**
@@ -1495,6 +1551,11 @@ export const EndAndContinueSessionRequestBody = z.object({
     callingRunId: z.string(),
     /** Free-form label for the SessionRun audit row. e.g. `"upgrade"`. */
     reason: z.string().max(64),
+    /**
+     * Re-pin the session to this id instead of clearing the pin. Only read when `reason` is
+     * `"upgrade"`. `lockToVersion` is never cleared.
+     */
+    externalDeploymentId: ExternalDeploymentId,
 });
 export const EndAndContinueSessionResponseBody = z.object({
     /** friendlyId of the run that has taken over the session. */
@@ -1506,10 +1567,16 @@ export const EndAndContinueSessionResponseBody = z.object({
      * to drive the next run.
      */
     swapped: z.boolean(),
+    /**
+     * The run that took over is parked waiting for its deployment. Surface this so a
+     * handoff onto a version that has not landed reads as a deploy in progress rather
+     * than a chat that went quiet.
+     */
+    pendingVersion: z.boolean().optional(),
 });
 export const UpdateSessionRequestBody = z.object({
     tags: z.array(z.string().max(128)).max(10).optional(),
-    metadata: z.record(z.unknown()).nullable().optional(),
+    metadata: z.record(z.string(), z.unknown()).nullable().optional(),
     // Null explicitly clears the externalId; non-null values must be non-empty.
     externalId: z
         .union([
@@ -1527,6 +1594,13 @@ export const UpdateSessionRequestBody = z.object({
 });
 export const CloseSessionRequestBody = z.object({
     reason: z.string().max(256).optional(),
+    /**
+     * The friendlyId of the run requesting the close, when the close comes
+     * from inside the session's own run (`chat.close()`). That run is already
+     * exiting, so the server skips appending the wake-up close record to `.in`
+     * for it. Omitted for an external close (dashboard, `sessions.close()`, MCP).
+     */
+    callingRunId: z.string().optional(),
 });
 export const SessionStatus = z.enum(["ACTIVE", "CLOSED", "EXPIRED"]);
 /**
@@ -1683,8 +1757,14 @@ export const ApiDeploymentListResponseItem = z.object({
         "TIMED_OUT",
     ]),
     deployedAt: z.coerce.date().optional(),
-    git: z.record(z.any()).optional(),
+    git: z.record(z.string(), z.any()).optional(),
     error: DeploymentErrorData.optional(),
+    /**
+     * The `--external-id` this deployment was deployed under, used by version skew
+     * protection to pin runs. Nullish on deployments created without one, and on
+     * servers older than this field.
+     */
+    externalId: z.string().nullish(),
 });
 export const RetrieveCurrentDeploymentResponseBody = ApiDeploymentListResponseItem;
 export const ApiBranchListResponseBody = z.object({
@@ -1693,7 +1773,7 @@ export const ApiBranchListResponseBody = z.object({
         name: z.string(),
         createdAt: z.coerce.date(),
         updatedAt: z.coerce.date(),
-        git: z.record(z.any()).optional(),
+        git: z.record(z.string(), z.any()).optional(),
         isPaused: z.boolean(),
     })),
 });
@@ -1715,7 +1795,7 @@ export const RetrieveRunTraceSpanSchema = z.object({
         workerVersion: z.string().optional(),
         queueName: z.string().optional(),
         machinePreset: z.string().optional(),
-        properties: z.record(z.any()).optional(),
+        properties: z.record(z.string(), z.any()).optional(),
         output: z.unknown().optional(),
     }),
 });
@@ -1739,7 +1819,7 @@ export const RetrieveSpanDetailResponseBody = z.object({
     level: z.string(),
     startTime: z.coerce.date(),
     durationMs: z.number(),
-    properties: z.record(z.any()).optional(),
+    properties: z.record(z.string(), z.any()).optional(),
     events: z.array(z.any()).optional(),
     entityType: z.string().optional(),
     ai: z
@@ -1811,7 +1891,7 @@ export const ReadSessionStreamRecordsResponseBody = z.object({
     })),
 });
 export const ResolvePromptRequestBody = z.object({
-    variables: z.record(z.unknown()).default({}),
+    variables: z.record(z.string(), z.unknown()).default({}),
     label: z.string().optional(),
     version: z.number().optional(),
 });
@@ -1824,7 +1904,7 @@ export const ResolvePromptResponseBody = z.object({
         template: z.string().optional(),
         text: z.string().optional(),
         model: z.string().optional().nullable(),
-        config: z.record(z.unknown()).optional().nullable(),
+        config: z.record(z.string(), z.unknown()).optional().nullable(),
     }),
 });
 export const ListPromptsResponseBody = z.object({