@trigger.dev/core 4.3.1 → 4.3.3

package/dist/commonjs/v3/schemas/api.d.ts

@@ -740,6 +740,18 @@ export declare const CreateBackgroundWorkerResponse: z.ZodObject<{
 export type CreateBackgroundWorkerResponse = z.infer<typeof CreateBackgroundWorkerResponse>;
 export declare const RunTags: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
 export type RunTags = z.infer<typeof RunTags>;
+/** Stores the original user-provided idempotency key and scope */
+export declare const IdempotencyKeyOptionsSchema: z.ZodObject<{
+    key: z.ZodString;
+    scope: z.ZodEnum<["run", "attempt", "global"]>;
+}, "strip", z.ZodTypeAny, {
+    key: string;
+    scope: "run" | "attempt" | "global";
+}, {
+    key: string;
+    scope: "run" | "attempt" | "global";
+}>;
+export type IdempotencyKeyOptionsSchema = z.infer<typeof IdempotencyKeyOptionsSchema>;
 export declare const TriggerTaskRequestBody: z.ZodObject<{
     payload: z.ZodAny;
     context: z.ZodAny;
@@ -783,6 +795,17 @@ export declare const TriggerTaskRequestBody: z.ZodObject<{
         delay: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
         idempotencyKey: z.ZodOptional<z.ZodString>;
         idempotencyKeyTTL: z.ZodOptional<z.ZodString>;
+        /** The original user-provided idempotency key and scope */
+        idempotencyKeyOptions: z.ZodOptional<z.ZodObject<{
+            key: z.ZodString;
+            scope: z.ZodEnum<["run", "attempt", "global"]>;
+        }, "strip", z.ZodTypeAny, {
+            key: string;
+            scope: "run" | "attempt" | "global";
+        }, {
+            key: string;
+            scope: "run" | "attempt" | "global";
+        }>>;
         machine: z.ZodOptional<z.ZodEnum<["micro", "small-1x", "small-2x", "medium-1x", "medium-2x", "large-1x", "large-2x"]>>;
         maxAttempts: z.ZodOptional<z.ZodNumber>;
         maxDuration: z.ZodOptional<z.ZodNumber>;
@@ -838,6 +861,10 @@ export declare const TriggerTaskRequestBody: z.ZodObject<{
         parentRunId?: string | undefined;
         resumeParentOnCompletion?: boolean | undefined;
         lockToVersion?: string | undefined;
+        idempotencyKeyOptions?: {
+            key: string;
+            scope: "run" | "attempt" | "global";
+        } | undefined;
         metadataType?: string | undefined;
         test?: boolean | undefined;
         bulkActionId?: string | undefined;
@@ -871,6 +898,10 @@ export declare const TriggerTaskRequestBody: z.ZodObject<{
         parentRunId?: string | undefined;
         resumeParentOnCompletion?: boolean | undefined;
         lockToVersion?: string | undefined;
+        idempotencyKeyOptions?: {
+            key: string;
+            scope: "run" | "attempt" | "global";
+        } | undefined;
         metadataType?: string | undefined;
         test?: boolean | undefined;
         bulkActionId?: string | undefined;
@@ -906,6 +937,10 @@ export declare const TriggerTaskRequestBody: z.ZodObject<{
         parentRunId?: string | undefined;
         resumeParentOnCompletion?: boolean | undefined;
         lockToVersion?: string | undefined;
+        idempotencyKeyOptions?: {
+            key: string;
+            scope: "run" | "attempt" | "global";
+        } | undefined;
         metadataType?: string | undefined;
         test?: boolean | undefined;
         bulkActionId?: string | undefined;
@@ -943,6 +978,10 @@ export declare const TriggerTaskRequestBody: z.ZodObject<{
         parentRunId?: string | undefined;
         resumeParentOnCompletion?: boolean | undefined;
         lockToVersion?: string | undefined;
+        idempotencyKeyOptions?: {
+            key: string;
+            scope: "run" | "attempt" | "global";
+        } | undefined;
         metadataType?: string | undefined;
         test?: boolean | undefined;
         bulkActionId?: string | undefined;
@@ -1006,6 +1045,17 @@ export declare const BatchTriggerTaskRequestBody: z.ZodObject<{
             delay: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
             idempotencyKey: z.ZodOptional<z.ZodString>;
             idempotencyKeyTTL: z.ZodOptional<z.ZodString>;
+            /** The original user-provided idempotency key and scope */
+            idempotencyKeyOptions: z.ZodOptional<z.ZodObject<{
+                key: z.ZodString;
+                scope: z.ZodEnum<["run", "attempt", "global"]>;
+            }, "strip", z.ZodTypeAny, {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            }, {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            }>>;
             machine: z.ZodOptional<z.ZodEnum<["micro", "small-1x", "small-2x", "medium-1x", "medium-2x", "large-1x", "large-2x"]>>;
             maxAttempts: z.ZodOptional<z.ZodNumber>;
             maxDuration: z.ZodOptional<z.ZodNumber>;
@@ -1061,6 +1111,10 @@ export declare const BatchTriggerTaskRequestBody: z.ZodObject<{
             parentRunId?: string | undefined;
             resumeParentOnCompletion?: boolean | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
             bulkActionId?: string | undefined;
@@ -1094,6 +1148,10 @@ export declare const BatchTriggerTaskRequestBody: z.ZodObject<{
             parentRunId?: string | undefined;
             resumeParentOnCompletion?: boolean | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
             bulkActionId?: string | undefined;
@@ -1129,6 +1187,10 @@ export declare const BatchTriggerTaskRequestBody: z.ZodObject<{
             parentRunId?: string | undefined;
             resumeParentOnCompletion?: boolean | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
             bulkActionId?: string | undefined;
@@ -1166,6 +1228,10 @@ export declare const BatchTriggerTaskRequestBody: z.ZodObject<{
             parentRunId?: string | undefined;
             resumeParentOnCompletion?: boolean | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
             bulkActionId?: string | undefined;
@@ -1206,6 +1272,10 @@ export declare const BatchTriggerTaskRequestBody: z.ZodObject<{
             parentRunId?: string | undefined;
             resumeParentOnCompletion?: boolean | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
             bulkActionId?: string | undefined;
@@ -1246,6 +1316,10 @@ export declare const BatchTriggerTaskRequestBody: z.ZodObject<{
             parentRunId?: string | undefined;
             resumeParentOnCompletion?: boolean | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
             bulkActionId?: string | undefined;
@@ -1265,6 +1339,17 @@ export declare const BatchTriggerTaskItem: z.ZodObject<{
         delay: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
         idempotencyKey: z.ZodOptional<z.ZodString>;
         idempotencyKeyTTL: z.ZodOptional<z.ZodString>;
+        /** The original user-provided idempotency key and scope */
+        idempotencyKeyOptions: z.ZodOptional<z.ZodObject<{
+            key: z.ZodString;
+            scope: z.ZodEnum<["run", "attempt", "global"]>;
+        }, "strip", z.ZodTypeAny, {
+            key: string;
+            scope: "run" | "attempt" | "global";
+        }, {
+            key: string;
+            scope: "run" | "attempt" | "global";
+        }>>;
         lockToVersion: z.ZodOptional<z.ZodString>;
         machine: z.ZodOptional<z.ZodEnum<["micro", "small-1x", "small-2x", "medium-1x", "medium-2x", "large-1x", "large-2x"]>>;
         maxAttempts: z.ZodOptional<z.ZodNumber>;
@@ -1322,6 +1407,10 @@ export declare const BatchTriggerTaskItem: z.ZodObject<{
         } | undefined;
         parentAttempt?: string | undefined;
         lockToVersion?: string | undefined;
+        idempotencyKeyOptions?: {
+            key: string;
+            scope: "run" | "attempt" | "global";
+        } | undefined;
         metadataType?: string | undefined;
         test?: boolean | undefined;
     }, {
@@ -1348,6 +1437,10 @@ export declare const BatchTriggerTaskItem: z.ZodObject<{
         } | undefined;
         parentAttempt?: string | undefined;
         lockToVersion?: string | undefined;
+        idempotencyKeyOptions?: {
+            key: string;
+            scope: "run" | "attempt" | "global";
+        } | undefined;
         metadataType?: string | undefined;
         test?: boolean | undefined;
     }>>;
@@ -1377,6 +1470,10 @@ export declare const BatchTriggerTaskItem: z.ZodObject<{
         } | undefined;
         parentAttempt?: string | undefined;
         lockToVersion?: string | undefined;
+        idempotencyKeyOptions?: {
+            key: string;
+            scope: "run" | "attempt" | "global";
+        } | undefined;
         metadataType?: string | undefined;
         test?: boolean | undefined;
     } | undefined;
@@ -1408,6 +1505,10 @@ export declare const BatchTriggerTaskItem: z.ZodObject<{
         } | undefined;
         parentAttempt?: string | undefined;
         lockToVersion?: string | undefined;
+        idempotencyKeyOptions?: {
+            key: string;
+            scope: "run" | "attempt" | "global";
+        } | undefined;
         metadataType?: string | undefined;
         test?: boolean | undefined;
     } | undefined;
@@ -1425,6 +1526,17 @@ export declare const BatchTriggerTaskV2RequestBody: z.ZodObject<{
             delay: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
             idempotencyKey: z.ZodOptional<z.ZodString>;
             idempotencyKeyTTL: z.ZodOptional<z.ZodString>;
+            /** The original user-provided idempotency key and scope */
+            idempotencyKeyOptions: z.ZodOptional<z.ZodObject<{
+                key: z.ZodString;
+                scope: z.ZodEnum<["run", "attempt", "global"]>;
+            }, "strip", z.ZodTypeAny, {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            }, {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            }>>;
             lockToVersion: z.ZodOptional<z.ZodString>;
             machine: z.ZodOptional<z.ZodEnum<["micro", "small-1x", "small-2x", "medium-1x", "medium-2x", "large-1x", "large-2x"]>>;
             maxAttempts: z.ZodOptional<z.ZodNumber>;
@@ -1482,6 +1594,10 @@ export declare const BatchTriggerTaskV2RequestBody: z.ZodObject<{
             } | undefined;
             parentAttempt?: string | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
         }, {
@@ -1508,6 +1624,10 @@ export declare const BatchTriggerTaskV2RequestBody: z.ZodObject<{
             } | undefined;
             parentAttempt?: string | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
         }>>;
@@ -1537,6 +1657,10 @@ export declare const BatchTriggerTaskV2RequestBody: z.ZodObject<{
             } | undefined;
             parentAttempt?: string | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
         } | undefined;
@@ -1568,6 +1692,10 @@ export declare const BatchTriggerTaskV2RequestBody: z.ZodObject<{
             } | undefined;
             parentAttempt?: string | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
         } | undefined;
@@ -1613,6 +1741,10 @@ export declare const BatchTriggerTaskV2RequestBody: z.ZodObject<{
             } | undefined;
             parentAttempt?: string | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
         } | undefined;
@@ -1649,6 +1781,10 @@ export declare const BatchTriggerTaskV2RequestBody: z.ZodObject<{
             } | undefined;
             parentAttempt?: string | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
         } | undefined;
@@ -1712,6 +1848,17 @@ export declare const BatchTriggerTaskV3RequestBody: z.ZodObject<{
             delay: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
             idempotencyKey: z.ZodOptional<z.ZodString>;
             idempotencyKeyTTL: z.ZodOptional<z.ZodString>;
+            /** The original user-provided idempotency key and scope */
+            idempotencyKeyOptions: z.ZodOptional<z.ZodObject<{
+                key: z.ZodString;
+                scope: z.ZodEnum<["run", "attempt", "global"]>;
+            }, "strip", z.ZodTypeAny, {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            }, {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            }>>;
             lockToVersion: z.ZodOptional<z.ZodString>;
             machine: z.ZodOptional<z.ZodEnum<["micro", "small-1x", "small-2x", "medium-1x", "medium-2x", "large-1x", "large-2x"]>>;
             maxAttempts: z.ZodOptional<z.ZodNumber>;
@@ -1769,6 +1916,10 @@ export declare const BatchTriggerTaskV3RequestBody: z.ZodObject<{
             } | undefined;
             parentAttempt?: string | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
         }, {
@@ -1795,6 +1946,10 @@ export declare const BatchTriggerTaskV3RequestBody: z.ZodObject<{
             } | undefined;
             parentAttempt?: string | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
         }>>;
@@ -1824,6 +1979,10 @@ export declare const BatchTriggerTaskV3RequestBody: z.ZodObject<{
             } | undefined;
             parentAttempt?: string | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
         } | undefined;
@@ -1855,6 +2014,10 @@ export declare const BatchTriggerTaskV3RequestBody: z.ZodObject<{
             } | undefined;
             parentAttempt?: string | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
         } | undefined;
@@ -1898,6 +2061,10 @@ export declare const BatchTriggerTaskV3RequestBody: z.ZodObject<{
             } | undefined;
             parentAttempt?: string | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
         } | undefined;
@@ -1933,6 +2100,10 @@ export declare const BatchTriggerTaskV3RequestBody: z.ZodObject<{
             } | undefined;
             parentAttempt?: string | undefined;
             lockToVersion?: string | undefined;
+            idempotencyKeyOptions?: {
+                key: string;
+                scope: "run" | "attempt" | "global";
+            } | undefined;
             metadataType?: string | undefined;
             test?: boolean | undefined;
         } | undefined;
@@ -1967,16 +2138,35 @@ export declare const CreateBatchRequestBody: z.ZodObject<{
     resumeParentOnCompletion: z.ZodOptional<z.ZodBoolean>;
     /** Idempotency key for the batch */
     idempotencyKey: z.ZodOptional<z.ZodString>;
+    /** The original user-provided idempotency key and scope */
+    idempotencyKeyOptions: z.ZodOptional<z.ZodObject<{
+        key: z.ZodString;
+        scope: z.ZodEnum<["run", "attempt", "global"]>;
+    }, "strip", z.ZodTypeAny, {
+        key: string;
+        scope: "run" | "attempt" | "global";
+    }, {
+        key: string;
+        scope: "run" | "attempt" | "global";
+    }>>;
 }, "strip", z.ZodTypeAny, {
     runCount: number;
     idempotencyKey?: string | undefined;
     parentRunId?: string | undefined;
     resumeParentOnCompletion?: boolean | undefined;
+    idempotencyKeyOptions?: {
+        key: string;
+        scope: "run" | "attempt" | "global";
+    } | undefined;
 }, {
     runCount: number;
     idempotencyKey?: string | undefined;
     parentRunId?: string | undefined;
     resumeParentOnCompletion?: boolean | undefined;
+    idempotencyKeyOptions?: {
+        key: string;
+        scope: "run" | "attempt" | "global";
+    } | undefined;
 }>;
 export type CreateBatchRequestBody = z.infer<typeof CreateBatchRequestBody>;
 /**
@@ -3515,6 +3705,20 @@ export declare const DevDequeueResponseBody: z.ZodObject<{
             values?: string[] | undefined;
         }>, "many">>;
     }, "strip", z.ZodTypeAny, {
+        run: {
+            id: string;
+            isTest: boolean;
+            machine: {
+                cpu: number;
+                memory: number;
+                name: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
+                centsPerMs: number;
+            };
+            traceContext: Record<string, unknown>;
+            friendlyId: string;
+            attemptNumber: number;
+            masterQueue: string;
+        };
         version: "1";
         environment: {
             type: "PRODUCTION" | "STAGING" | "DEVELOPMENT" | "PREVIEW";
@@ -3531,20 +3735,6 @@ export declare const DevDequeueResponseBody: z.ZodObject<{
             friendlyId?: string | undefined;
             imagePlatform?: string | undefined;
         };
-        run: {
-            id: string;
-            isTest: boolean;
-            machine: {
-                cpu: number;
-                memory: number;
-                name: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
-                centsPerMs: number;
-            };
-            traceContext: Record<string, unknown>;
-            friendlyId: string;
-            attemptNumber: number;
-            masterQueue: string;
-        };
         snapshot: {
             id: string;
             createdAt: Date;
@@ -3596,6 +3786,20 @@ export declare const DevDequeueResponseBody: z.ZodObject<{
             values?: string[] | undefined;
         }[] | undefined;
     }, {
+        run: {
+            id: string;
+            isTest: boolean;
+            machine: {
+                cpu: number;
+                memory: number;
+                name: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
+                centsPerMs: number;
+            };
+            traceContext: Record<string, unknown>;
+            friendlyId: string;
+            attemptNumber: number;
+            masterQueue: string;
+        };
         version: "1";
         environment: {
             type: "PRODUCTION" | "STAGING" | "DEVELOPMENT" | "PREVIEW";
@@ -3612,20 +3816,6 @@ export declare const DevDequeueResponseBody: z.ZodObject<{
             friendlyId?: string | undefined;
             imagePlatform?: string | undefined;
         };
-        run: {
-            id: string;
-            isTest: boolean;
-            machine: {
-                cpu: number;
-                memory: number;
-                name: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
-                centsPerMs: number;
-            };
-            traceContext: Record<string, unknown>;
-            friendlyId: string;
-            attemptNumber: number;
-            masterQueue: string;
-        };
         snapshot: {
             id: string;
             createdAt: Date;
@@ -3679,6 +3869,20 @@ export declare const DevDequeueResponseBody: z.ZodObject<{
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     dequeuedMessages: {
+        run: {
+            id: string;
+            isTest: boolean;
+            machine: {
+                cpu: number;
+                memory: number;
+                name: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
+                centsPerMs: number;
+            };
+            traceContext: Record<string, unknown>;
+            friendlyId: string;
+            attemptNumber: number;
+            masterQueue: string;
+        };
         version: "1";
         environment: {
             type: "PRODUCTION" | "STAGING" | "DEVELOPMENT" | "PREVIEW";
@@ -3695,20 +3899,6 @@ export declare const DevDequeueResponseBody: z.ZodObject<{
             friendlyId?: string | undefined;
             imagePlatform?: string | undefined;
         };
-        run: {
-            id: string;
-            isTest: boolean;
-            machine: {
-                cpu: number;
-                memory: number;
-                name: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
-                centsPerMs: number;
-            };
-            traceContext: Record<string, unknown>;
-            friendlyId: string;
-            attemptNumber: number;
-            masterQueue: string;
-        };
         snapshot: {
             id: string;
             createdAt: Date;
@@ -3762,6 +3952,20 @@ export declare const DevDequeueResponseBody: z.ZodObject<{
     }[];
 }, {
     dequeuedMessages: {
+        run: {
+            id: string;
+            isTest: boolean;
+            machine: {
+                cpu: number;
+                memory: number;
+                name: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
+                centsPerMs: number;
+            };
+            traceContext: Record<string, unknown>;
+            friendlyId: string;
+            attemptNumber: number;
+            masterQueue: string;
+        };
         version: "1";
         environment: {
             type: "PRODUCTION" | "STAGING" | "DEVELOPMENT" | "PREVIEW";
@@ -3778,20 +3982,6 @@ export declare const DevDequeueResponseBody: z.ZodObject<{
             friendlyId?: string | undefined;
             imagePlatform?: string | undefined;
         };
-        run: {
-            id: string;
-            isTest: boolean;
-            machine: {
-                cpu: number;
-                memory: number;
-                name: "micro" | "small-1x" | "small-2x" | "medium-1x" | "medium-2x" | "large-1x" | "large-2x";
-                centsPerMs: number;
-            };
-            traceContext: Record<string, unknown>;
-            friendlyId: string;
-            attemptNumber: number;
-            masterQueue: string;
-        };
         snapshot: {
             id: string;
             createdAt: Date;

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

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FailDeploymentResponseBody = exports.FailDeploymentRequestBody = exports.DeploymentErrorData = exports.GenerateRegistryCredentialsResponseBody = exports.RemoteBuildProviderStatusResponseBody = exports.InitializeDeploymentRequestBody = exports.InitializeDeploymentResponseBody = exports.CreateArtifactResponseBody = exports.CreateArtifactRequestBody = exports.UpsertBranchResponseBody = exports.UpsertBranchRequestBody = exports.BuildServerMetadata = exports.DeploymentTriggeredVia = exports.ExternalBuildData = exports.CancelDeploymentRequestBody = exports.ProgressDeploymentRequestBody = exports.FinalizeDeploymentRequestBody = exports.StartDeploymentIndexingResponseBody = exports.StartDeploymentIndexingRequestBody = exports.GetEnvironmentVariablesResponseBody = exports.RescheduleRunRequestBody = exports.AddTagsRequestBody = exports.GetBatchResponseBody = exports.BatchTriggerTaskResponse = exports.StreamBatchItemsResponse = exports.BatchItemNDJSON = exports.CreateBatchResponse = exports.CreateBatchRequestBody = exports.BatchTriggerTaskV3Response = exports.BatchTriggerTaskV3RequestBody = exports.BatchTriggerTaskV2Response = exports.BatchTriggerTaskV2RequestBody = exports.BatchTriggerTaskItem = exports.BatchTriggerTaskRequestBody = exports.TriggerTaskResponse = exports.TriggerTaskRequestBody = exports.RunTags = exports.CreateBackgroundWorkerResponse = exports.CreateBackgroundWorkerRequestBody = exports.GetJWTResponse = exports.GetJWTRequestBody = exports.GetWorkerByTagResponse = exports.GetWorkerTaskResponse = exports.GetProjectEnvResponse = exports.CreateProjectRequestBody = exports.GetOrgsResponseBody = exports.GetProjectsResponseBody = exports.GetProjectResponseBody = exports.WhoAmIResponseSchema = exports.RunEngineVersion = void 0;
-exports.RetrieveBatchV2Response = exports.RetrieveBatchResponse = exports.BatchStatus = exports.SubscribeRunRawShape = exports.UpdateMetadataResponseBody = exports.UpdateMetadataRequestBody = exports.EnvironmentVariableWithSecret = exports.EnvironmentVariables = exports.EnvironmentVariable = exports.EnvironmentVariableValue = exports.EnvironmentVariableResponseBody = exports.ImportEnvironmentVariablesRequestBody = exports.UpdateEnvironmentVariableRequestBody = exports.CreateEnvironmentVariableRequestBody = exports.ListRunResponse = exports.ListRunResponseItem = exports.RetrieveRunResponse = exports.RelatedRunDetails = exports.TriggerFunction = exports.RunScheduleDetails = exports.RunEnvironmentDetails = exports.AttemptStatus = exports.RunStatus = exports.TimezonesResult = exports.ListScheduleOptions = exports.ListSchedulesResult = exports.DeletedScheduleObject = exports.ScheduleObject = exports.ScheduleGenerator = exports.UpdateScheduleOptions = exports.CreateScheduleOptions = exports.ScheduledTaskPayload = exports.ScheduleType = exports.ResetIdempotencyKeyResponse = exports.CanceledRunResponse = exports.ReplayRunResponse = exports.DevDequeueResponseBody = exports.DevDequeueRequestBody = exports.DevConfigResponseBody = exports.WorkersCreateResponseBody = exports.WorkersCreateRequestBody = exports.WorkersListResponseBody = exports.CreateUploadPayloadUrlResponseBody = exports.DeploymentEventFromString = exports.DeploymentEvent = exports.DeploymentFinalizedEvent = exports.DeploymentLogEvent = exports.GetLatestDeploymentResponseBody = exports.GetDeploymentResponseBody = exports.PromoteDeploymentResponseBody = void 0;
-exports.AppendToStreamResponseBody = exports.CreateStreamResponseBody = exports.RetrieveRunTraceResponseBody = exports.RetrieveRunTraceSpan = exports.RetrieveRunTraceSpanSchema = exports.ApiBranchListResponseBody = exports.ApiDeploymentListResponseItem = exports.ApiDeploymentListSearchParams = exports.ApiDeploymentListOptions = exports.ApiDeploymentListParams = exports.WaitForDurationResponseBody = exports.WaitForDurationRequestBody = exports.WaitForWaitpointTokenResponseBody = exports.CompleteWaitpointTokenResponseBody = exports.CompleteWaitpointTokenRequestBody = exports.WaitpointRetrieveTokenResponse = exports.WaitpointListTokenItem = exports.WaitpointTokenItem = exports.WaitpointTokenStatus = exports.waitpointTokenStatuses = exports.CreateWaitpointTokenResponseBody = exports.CreateWaitpointTokenRequestBody = exports.TimePeriod = exports.SubscribeRealtimeStreamChunkRawShape = void 0;
+exports.FailDeploymentRequestBody = exports.DeploymentErrorData = exports.GenerateRegistryCredentialsResponseBody = exports.RemoteBuildProviderStatusResponseBody = exports.InitializeDeploymentRequestBody = exports.InitializeDeploymentResponseBody = exports.CreateArtifactResponseBody = exports.CreateArtifactRequestBody = exports.UpsertBranchResponseBody = exports.UpsertBranchRequestBody = exports.BuildServerMetadata = exports.DeploymentTriggeredVia = exports.ExternalBuildData = exports.CancelDeploymentRequestBody = exports.ProgressDeploymentRequestBody = exports.FinalizeDeploymentRequestBody = exports.StartDeploymentIndexingResponseBody = exports.StartDeploymentIndexingRequestBody = exports.GetEnvironmentVariablesResponseBody = exports.RescheduleRunRequestBody = exports.AddTagsRequestBody = exports.GetBatchResponseBody = exports.BatchTriggerTaskResponse = exports.StreamBatchItemsResponse = exports.BatchItemNDJSON = exports.CreateBatchResponse = exports.CreateBatchRequestBody = exports.BatchTriggerTaskV3Response = exports.BatchTriggerTaskV3RequestBody = exports.BatchTriggerTaskV2Response = exports.BatchTriggerTaskV2RequestBody = exports.BatchTriggerTaskItem = exports.BatchTriggerTaskRequestBody = exports.TriggerTaskResponse = exports.TriggerTaskRequestBody = exports.IdempotencyKeyOptionsSchema = exports.RunTags = exports.CreateBackgroundWorkerResponse = exports.CreateBackgroundWorkerRequestBody = exports.GetJWTResponse = exports.GetJWTRequestBody = exports.GetWorkerByTagResponse = exports.GetWorkerTaskResponse = exports.GetProjectEnvResponse = exports.CreateProjectRequestBody = exports.GetOrgsResponseBody = exports.GetProjectsResponseBody = exports.GetProjectResponseBody = exports.WhoAmIResponseSchema = exports.RunEngineVersion = void 0;
+exports.RetrieveBatchResponse = exports.BatchStatus = exports.SubscribeRunRawShape = exports.UpdateMetadataResponseBody = exports.UpdateMetadataRequestBody = exports.EnvironmentVariableWithSecret = exports.EnvironmentVariables = exports.EnvironmentVariable = exports.EnvironmentVariableValue = exports.EnvironmentVariableResponseBody = exports.ImportEnvironmentVariablesRequestBody = exports.UpdateEnvironmentVariableRequestBody = exports.CreateEnvironmentVariableRequestBody = exports.ListRunResponse = exports.ListRunResponseItem = exports.RetrieveRunResponse = exports.RelatedRunDetails = exports.TriggerFunction = exports.RunScheduleDetails = exports.RunEnvironmentDetails = exports.AttemptStatus = exports.RunStatus = exports.TimezonesResult = exports.ListScheduleOptions = exports.ListSchedulesResult = exports.DeletedScheduleObject = exports.ScheduleObject = exports.ScheduleGenerator = exports.UpdateScheduleOptions = exports.CreateScheduleOptions = exports.ScheduledTaskPayload = exports.ScheduleType = exports.ResetIdempotencyKeyResponse = exports.CanceledRunResponse = exports.ReplayRunResponse = exports.DevDequeueResponseBody = exports.DevDequeueRequestBody = exports.DevConfigResponseBody = exports.WorkersCreateResponseBody = exports.WorkersCreateRequestBody = exports.WorkersListResponseBody = exports.CreateUploadPayloadUrlResponseBody = exports.DeploymentEventFromString = exports.DeploymentEvent = exports.DeploymentFinalizedEvent = exports.DeploymentLogEvent = exports.GetLatestDeploymentResponseBody = exports.GetDeploymentResponseBody = exports.PromoteDeploymentResponseBody = exports.FailDeploymentResponseBody = void 0;
+exports.AppendToStreamResponseBody = exports.CreateStreamResponseBody = exports.RetrieveRunTraceResponseBody = exports.RetrieveRunTraceSpan = exports.RetrieveRunTraceSpanSchema = exports.ApiBranchListResponseBody = exports.ApiDeploymentListResponseItem = exports.ApiDeploymentListSearchParams = exports.ApiDeploymentListOptions = exports.ApiDeploymentListParams = exports.WaitForDurationResponseBody = exports.WaitForDurationRequestBody = exports.WaitForWaitpointTokenResponseBody = exports.CompleteWaitpointTokenResponseBody = exports.CompleteWaitpointTokenRequestBody = exports.WaitpointRetrieveTokenResponse = exports.WaitpointListTokenItem = exports.WaitpointTokenItem = exports.WaitpointTokenStatus = exports.waitpointTokenStatuses = exports.CreateWaitpointTokenResponseBody = exports.CreateWaitpointTokenRequestBody = exports.TimePeriod = exports.SubscribeRealtimeStreamChunkRawShape = exports.RetrieveBatchV2Response = void 0;
 exports.isWaitpointOutputTimeout = isWaitpointOutputTimeout;
 exports.timeoutError = timeoutError;
 const zod_1 = require("zod");
@@ -107,6 +107,11 @@ exports.CreateBackgroundWorkerResponse = zod_1.z.object({
 //an array of 1, 2, or 3 strings
 const RunTag = zod_1.z.string().max(128, "Tags must be less than 128 characters");
 exports.RunTags = zod_1.z.union([RunTag, RunTag.array()]);
+/** Stores the original user-provided idempotency key and scope */
+exports.IdempotencyKeyOptionsSchema = zod_1.z.object({
+    key: zod_1.z.string(),
+    scope: zod_1.z.enum(["run", "attempt", "global"]),
+});
 exports.TriggerTaskRequestBody = zod_1.z.object({
     payload: zod_1.z.any(),
     context: zod_1.z.any(),
@@ -148,6 +153,8 @@ exports.TriggerTaskRequestBody = zod_1.z.object({
         delay: zod_1.z.string().or(zod_1.z.coerce.date()).optional(),
         idempotencyKey: zod_1.z.string().optional(),
         idempotencyKeyTTL: zod_1.z.string().optional(),
+        /** The original user-provided idempotency key and scope */
+        idempotencyKeyOptions: exports.IdempotencyKeyOptionsSchema.optional(),
         machine: common_js_1.MachinePresetName.optional(),
         maxAttempts: zod_1.z.number().int().optional(),
         maxDuration: zod_1.z.number().optional(),
@@ -188,6 +195,8 @@ exports.BatchTriggerTaskItem = zod_1.z.object({
         delay: zod_1.z.string().or(zod_1.z.coerce.date()).optional(),
         idempotencyKey: zod_1.z.string().optional(),
         idempotencyKeyTTL: zod_1.z.string().optional(),
+        /** The original user-provided idempotency key and scope */
+        idempotencyKeyOptions: exports.IdempotencyKeyOptionsSchema.optional(),
         lockToVersion: zod_1.z.string().optional(),
         machine: common_js_1.MachinePresetName.optional(),
         maxAttempts: zod_1.z.number().int().optional(),
@@ -275,6 +284,8 @@ exports.CreateBatchRequestBody = zod_1.z.object({
     resumeParentOnCompletion: zod_1.z.boolean().optional(),
     /** Idempotency key for the batch */
     idempotencyKey: zod_1.z.string().optional(),
+    /** The original user-provided idempotency key and scope */
+    idempotencyKeyOptions: exports.IdempotencyKeyOptionsSchema.optional(),
 });
 /**
  * Phase 1: Create batch response