@trigger.dev/sdk 3.2.0 → 3.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/commonjs/apiClient.d.ts +53 -63
- package/dist/commonjs/io.d.ts +7 -19
- package/dist/commonjs/status.d.ts +1 -1
- package/dist/commonjs/triggerClient.d.ts +11 -21
- package/dist/commonjs/triggers/scheduled.d.ts +2 -2
- package/dist/commonjs/types.d.ts +2 -2
- package/dist/commonjs/v3/auth.d.ts +1 -1
- package/dist/commonjs/v3/auth.js +3 -0
- package/dist/commonjs/v3/auth.js.map +1 -1
- package/dist/commonjs/v3/idempotencyKeys.d.ts +1 -40
- package/dist/commonjs/v3/idempotencyKeys.js +1 -69
- package/dist/commonjs/v3/idempotencyKeys.js.map +1 -1
- package/dist/commonjs/v3/index.d.ts +3 -1
- package/dist/commonjs/v3/index.js +2 -0
- package/dist/commonjs/v3/index.js.map +1 -1
- package/dist/commonjs/v3/metadata.d.ts +55 -0
- package/dist/commonjs/v3/metadata.js +65 -0
- package/dist/commonjs/v3/metadata.js.map +1 -1
- package/dist/commonjs/v3/runs.d.ts +11 -11
- package/dist/commonjs/v3/runs.js.map +1 -1
- package/dist/commonjs/v3/shared.d.ts +3 -2
- package/dist/commonjs/v3/shared.js +26 -14
- package/dist/commonjs/v3/shared.js.map +1 -1
- package/dist/commonjs/v3/tasks.d.ts +2 -1
- package/dist/commonjs/v3/tasks.js +2 -1
- package/dist/commonjs/v3/tasks.js.map +1 -1
- package/dist/commonjs/v3/waitUntil.d.ts +9 -0
- package/dist/commonjs/v3/waitUntil.js +16 -0
- package/dist/commonjs/v3/waitUntil.js.map +1 -0
- package/dist/commonjs/version.js +1 -1
- package/dist/esm/apiClient.d.ts +53 -63
- package/dist/esm/io.d.ts +7 -19
- package/dist/esm/status.d.ts +1 -1
- package/dist/esm/triggerClient.d.ts +9 -21
- package/dist/esm/triggers/invokeTrigger.d.ts +1 -1
- package/dist/esm/triggers/scheduled.d.ts +2 -2
- package/dist/esm/types.d.ts +2 -2
- package/dist/esm/v3/auth.d.ts +1 -1
- package/dist/esm/v3/auth.js +3 -0
- package/dist/esm/v3/auth.js.map +1 -1
- package/dist/esm/v3/idempotencyKeys.d.ts +1 -40
- package/dist/esm/v3/idempotencyKeys.js +1 -68
- package/dist/esm/v3/idempotencyKeys.js.map +1 -1
- package/dist/esm/v3/index.d.ts +3 -1
- package/dist/esm/v3/index.js +2 -0
- package/dist/esm/v3/index.js.map +1 -1
- package/dist/esm/v3/metadata.d.ts +55 -0
- package/dist/esm/v3/metadata.js +65 -0
- package/dist/esm/v3/metadata.js.map +1 -1
- package/dist/esm/v3/runs.d.ts +14 -14
- package/dist/esm/v3/runs.js.map +1 -1
- package/dist/esm/v3/shared.d.ts +3 -2
- package/dist/esm/v3/shared.js +26 -15
- package/dist/esm/v3/shared.js.map +1 -1
- package/dist/esm/v3/tasks.d.ts +2 -1
- package/dist/esm/v3/tasks.js +2 -1
- package/dist/esm/v3/tasks.js.map +1 -1
- package/dist/esm/v3/waitUntil.d.ts +9 -0
- package/dist/esm/v3/waitUntil.js +13 -0
- package/dist/esm/v3/waitUntil.js.map +1 -0
- package/dist/esm/version.js +1 -1
- package/package.json +9 -5
|
@@ -41,28 +41,15 @@ export declare class ApiClient {
|
|
|
41
41
|
cachedTasksCursor?: string;
|
|
42
42
|
}): Promise<VersionedResponseBody<{
|
|
43
43
|
"2023-09-29": z.ZodObject<{
|
|
44
|
-
task: z.ZodObject<{
|
|
45
|
-
params: z.ZodNullable<z.ZodOptional<z.ZodType<import("@trigger.dev/core").DeserializedJson, z.ZodTypeDef, import("@trigger.dev/core").DeserializedJson>>>;
|
|
46
|
-
status: z.ZodEnum<["PENDING", "WAITING", "RUNNING", "COMPLETED", "ERRORED", "CANCELED"]>;
|
|
47
|
-
error: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
48
|
-
context: z.ZodNullable<z.ZodOptional<z.ZodType<import("@trigger.dev/core").DeserializedJson, z.ZodTypeDef, import("@trigger.dev/core").DeserializedJson>>>;
|
|
49
|
-
name: z.ZodString;
|
|
44
|
+
task: z.ZodObject<z.objectUtil.extendShape<{
|
|
50
45
|
id: z.ZodString;
|
|
51
|
-
|
|
52
|
-
style: z.ZodEnum<["normal", "minimal"]>;
|
|
53
|
-
variant: z.ZodOptional<z.ZodString>;
|
|
54
|
-
}, "strip", z.ZodTypeAny, {
|
|
55
|
-
style: "normal" | "minimal";
|
|
56
|
-
variant?: string | undefined;
|
|
57
|
-
}, {
|
|
58
|
-
style: "normal" | "minimal";
|
|
59
|
-
variant?: string | undefined;
|
|
60
|
-
}>>>;
|
|
46
|
+
name: z.ZodString;
|
|
61
47
|
icon: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
62
48
|
noop: z.ZodBoolean;
|
|
63
49
|
startedAt: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
64
50
|
completedAt: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
65
51
|
delayUntil: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
52
|
+
status: z.ZodEnum<["PENDING", "WAITING", "RUNNING", "COMPLETED", "ERRORED", "CANCELED"]>;
|
|
66
53
|
description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
67
54
|
properties: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
68
55
|
label: z.ZodString;
|
|
@@ -96,15 +83,29 @@ export declare class ApiClient {
|
|
|
96
83
|
url?: string | undefined;
|
|
97
84
|
imageUrl?: string[] | undefined;
|
|
98
85
|
}>, "many">>>;
|
|
86
|
+
params: z.ZodNullable<z.ZodOptional<z.ZodType<import("@trigger.dev/core").DeserializedJson, z.ZodTypeDef, import("@trigger.dev/core").DeserializedJson>>>;
|
|
99
87
|
output: z.ZodNullable<z.ZodOptional<z.ZodType<import("@trigger.dev/core").DeserializedJson, z.ZodTypeDef, import("@trigger.dev/core").DeserializedJson>>>;
|
|
88
|
+
context: z.ZodNullable<z.ZodOptional<z.ZodType<import("@trigger.dev/core").DeserializedJson, z.ZodTypeDef, import("@trigger.dev/core").DeserializedJson>>>;
|
|
89
|
+
error: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
100
90
|
parentId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
91
|
+
style: z.ZodNullable<z.ZodOptional<z.ZodObject<{
|
|
92
|
+
style: z.ZodEnum<["normal", "minimal"]>;
|
|
93
|
+
variant: z.ZodOptional<z.ZodString>;
|
|
94
|
+
}, "strip", z.ZodTypeAny, {
|
|
95
|
+
style: "normal" | "minimal";
|
|
96
|
+
variant?: string | undefined;
|
|
97
|
+
}, {
|
|
98
|
+
style: "normal" | "minimal";
|
|
99
|
+
variant?: string | undefined;
|
|
100
|
+
}>>>;
|
|
101
101
|
operation: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
102
102
|
callbackUrl: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
103
103
|
childExecutionMode: z.ZodNullable<z.ZodOptional<z.ZodEnum<["SEQUENTIAL", "PARALLEL"]>>>;
|
|
104
|
+
}, {
|
|
104
105
|
idempotencyKey: z.ZodString;
|
|
105
106
|
attempts: z.ZodNumber;
|
|
106
107
|
forceYield: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
107
|
-
}
|
|
108
|
+
}>, "strip", z.ZodTypeAny, {
|
|
108
109
|
status: "PENDING" | "WAITING" | "RUNNING" | "COMPLETED" | "ERRORED" | "CANCELED";
|
|
109
110
|
name: string;
|
|
110
111
|
id: string;
|
|
@@ -112,7 +113,6 @@ export declare class ApiClient {
|
|
|
112
113
|
idempotencyKey: string;
|
|
113
114
|
attempts: number;
|
|
114
115
|
params?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
115
|
-
error?: string | null | undefined;
|
|
116
116
|
context?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
117
117
|
style?: {
|
|
118
118
|
style: "normal" | "minimal";
|
|
@@ -136,6 +136,7 @@ export declare class ApiClient {
|
|
|
136
136
|
imageUrl?: string[] | undefined;
|
|
137
137
|
}[] | null | undefined;
|
|
138
138
|
output?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
139
|
+
error?: string | null | undefined;
|
|
139
140
|
parentId?: string | null | undefined;
|
|
140
141
|
operation?: string | null | undefined;
|
|
141
142
|
callbackUrl?: string | null | undefined;
|
|
@@ -149,7 +150,6 @@ export declare class ApiClient {
|
|
|
149
150
|
idempotencyKey: string;
|
|
150
151
|
attempts: number;
|
|
151
152
|
params?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
152
|
-
error?: string | null | undefined;
|
|
153
153
|
context?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
154
154
|
style?: {
|
|
155
155
|
style: "normal" | "minimal";
|
|
@@ -173,6 +173,7 @@ export declare class ApiClient {
|
|
|
173
173
|
imageUrl?: string[] | undefined;
|
|
174
174
|
}[] | null | undefined;
|
|
175
175
|
output?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
176
|
+
error?: string | null | undefined;
|
|
176
177
|
parentId?: string | null | undefined;
|
|
177
178
|
operation?: string | null | undefined;
|
|
178
179
|
callbackUrl?: string | null | undefined;
|
|
@@ -233,7 +234,6 @@ export declare class ApiClient {
|
|
|
233
234
|
idempotencyKey: string;
|
|
234
235
|
attempts: number;
|
|
235
236
|
params?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
236
|
-
error?: string | null | undefined;
|
|
237
237
|
context?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
238
238
|
style?: {
|
|
239
239
|
style: "normal" | "minimal";
|
|
@@ -257,6 +257,7 @@ export declare class ApiClient {
|
|
|
257
257
|
imageUrl?: string[] | undefined;
|
|
258
258
|
}[] | null | undefined;
|
|
259
259
|
output?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
260
|
+
error?: string | null | undefined;
|
|
260
261
|
parentId?: string | null | undefined;
|
|
261
262
|
operation?: string | null | undefined;
|
|
262
263
|
callbackUrl?: string | null | undefined;
|
|
@@ -283,7 +284,6 @@ export declare class ApiClient {
|
|
|
283
284
|
idempotencyKey: string;
|
|
284
285
|
attempts: number;
|
|
285
286
|
params?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
286
|
-
error?: string | null | undefined;
|
|
287
287
|
context?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
288
288
|
style?: {
|
|
289
289
|
style: "normal" | "minimal";
|
|
@@ -307,6 +307,7 @@ export declare class ApiClient {
|
|
|
307
307
|
imageUrl?: string[] | undefined;
|
|
308
308
|
}[] | null | undefined;
|
|
309
309
|
output?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
310
|
+
error?: string | null | undefined;
|
|
310
311
|
parentId?: string | null | undefined;
|
|
311
312
|
operation?: string | null | undefined;
|
|
312
313
|
callbackUrl?: string | null | undefined;
|
|
@@ -325,28 +326,15 @@ export declare class ApiClient {
|
|
|
325
326
|
cursor?: string | undefined;
|
|
326
327
|
} | undefined;
|
|
327
328
|
}>;
|
|
328
|
-
}, z.ZodObject<{
|
|
329
|
-
params: z.ZodNullable<z.ZodOptional<z.ZodType<import("@trigger.dev/core").DeserializedJson, z.ZodTypeDef, import("@trigger.dev/core").DeserializedJson>>>;
|
|
330
|
-
status: z.ZodEnum<["PENDING", "WAITING", "RUNNING", "COMPLETED", "ERRORED", "CANCELED"]>;
|
|
331
|
-
error: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
332
|
-
context: z.ZodNullable<z.ZodOptional<z.ZodType<import("@trigger.dev/core").DeserializedJson, z.ZodTypeDef, import("@trigger.dev/core").DeserializedJson>>>;
|
|
333
|
-
name: z.ZodString;
|
|
329
|
+
}, z.ZodObject<z.objectUtil.extendShape<{
|
|
334
330
|
id: z.ZodString;
|
|
335
|
-
|
|
336
|
-
style: z.ZodEnum<["normal", "minimal"]>;
|
|
337
|
-
variant: z.ZodOptional<z.ZodString>;
|
|
338
|
-
}, "strip", z.ZodTypeAny, {
|
|
339
|
-
style: "normal" | "minimal";
|
|
340
|
-
variant?: string | undefined;
|
|
341
|
-
}, {
|
|
342
|
-
style: "normal" | "minimal";
|
|
343
|
-
variant?: string | undefined;
|
|
344
|
-
}>>>;
|
|
331
|
+
name: z.ZodString;
|
|
345
332
|
icon: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
346
333
|
noop: z.ZodBoolean;
|
|
347
334
|
startedAt: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
348
335
|
completedAt: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
349
336
|
delayUntil: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
337
|
+
status: z.ZodEnum<["PENDING", "WAITING", "RUNNING", "COMPLETED", "ERRORED", "CANCELED"]>;
|
|
350
338
|
description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
351
339
|
properties: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
352
340
|
label: z.ZodString;
|
|
@@ -380,15 +368,29 @@ export declare class ApiClient {
|
|
|
380
368
|
url?: string | undefined;
|
|
381
369
|
imageUrl?: string[] | undefined;
|
|
382
370
|
}>, "many">>>;
|
|
371
|
+
params: z.ZodNullable<z.ZodOptional<z.ZodType<import("@trigger.dev/core").DeserializedJson, z.ZodTypeDef, import("@trigger.dev/core").DeserializedJson>>>;
|
|
383
372
|
output: z.ZodNullable<z.ZodOptional<z.ZodType<import("@trigger.dev/core").DeserializedJson, z.ZodTypeDef, import("@trigger.dev/core").DeserializedJson>>>;
|
|
373
|
+
context: z.ZodNullable<z.ZodOptional<z.ZodType<import("@trigger.dev/core").DeserializedJson, z.ZodTypeDef, import("@trigger.dev/core").DeserializedJson>>>;
|
|
374
|
+
error: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
384
375
|
parentId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
376
|
+
style: z.ZodNullable<z.ZodOptional<z.ZodObject<{
|
|
377
|
+
style: z.ZodEnum<["normal", "minimal"]>;
|
|
378
|
+
variant: z.ZodOptional<z.ZodString>;
|
|
379
|
+
}, "strip", z.ZodTypeAny, {
|
|
380
|
+
style: "normal" | "minimal";
|
|
381
|
+
variant?: string | undefined;
|
|
382
|
+
}, {
|
|
383
|
+
style: "normal" | "minimal";
|
|
384
|
+
variant?: string | undefined;
|
|
385
|
+
}>>>;
|
|
385
386
|
operation: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
386
387
|
callbackUrl: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
387
388
|
childExecutionMode: z.ZodNullable<z.ZodOptional<z.ZodEnum<["SEQUENTIAL", "PARALLEL"]>>>;
|
|
389
|
+
}, {
|
|
388
390
|
idempotencyKey: z.ZodString;
|
|
389
391
|
attempts: z.ZodNumber;
|
|
390
392
|
forceYield: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
391
|
-
}
|
|
393
|
+
}>, "strip", z.ZodTypeAny, {
|
|
392
394
|
status: "PENDING" | "WAITING" | "RUNNING" | "COMPLETED" | "ERRORED" | "CANCELED";
|
|
393
395
|
name: string;
|
|
394
396
|
id: string;
|
|
@@ -396,7 +398,6 @@ export declare class ApiClient {
|
|
|
396
398
|
idempotencyKey: string;
|
|
397
399
|
attempts: number;
|
|
398
400
|
params?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
399
|
-
error?: string | null | undefined;
|
|
400
401
|
context?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
401
402
|
style?: {
|
|
402
403
|
style: "normal" | "minimal";
|
|
@@ -420,6 +421,7 @@ export declare class ApiClient {
|
|
|
420
421
|
imageUrl?: string[] | undefined;
|
|
421
422
|
}[] | null | undefined;
|
|
422
423
|
output?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
424
|
+
error?: string | null | undefined;
|
|
423
425
|
parentId?: string | null | undefined;
|
|
424
426
|
operation?: string | null | undefined;
|
|
425
427
|
callbackUrl?: string | null | undefined;
|
|
@@ -433,7 +435,6 @@ export declare class ApiClient {
|
|
|
433
435
|
idempotencyKey: string;
|
|
434
436
|
attempts: number;
|
|
435
437
|
params?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
436
|
-
error?: string | null | undefined;
|
|
437
438
|
context?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
438
439
|
style?: {
|
|
439
440
|
style: "normal" | "minimal";
|
|
@@ -457,6 +458,7 @@ export declare class ApiClient {
|
|
|
457
458
|
imageUrl?: string[] | undefined;
|
|
458
459
|
}[] | null | undefined;
|
|
459
460
|
output?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
461
|
+
error?: string | null | undefined;
|
|
460
462
|
parentId?: string | null | undefined;
|
|
461
463
|
operation?: string | null | undefined;
|
|
462
464
|
callbackUrl?: string | null | undefined;
|
|
@@ -471,7 +473,6 @@ export declare class ApiClient {
|
|
|
471
473
|
idempotencyKey: string;
|
|
472
474
|
attempts: number;
|
|
473
475
|
params?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
474
|
-
error?: string | null | undefined;
|
|
475
476
|
context?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
476
477
|
style?: {
|
|
477
478
|
style: "normal" | "minimal";
|
|
@@ -495,6 +496,7 @@ export declare class ApiClient {
|
|
|
495
496
|
imageUrl?: string[] | undefined;
|
|
496
497
|
}[] | null | undefined;
|
|
497
498
|
output?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
499
|
+
error?: string | null | undefined;
|
|
498
500
|
parentId?: string | null | undefined;
|
|
499
501
|
operation?: string | null | undefined;
|
|
500
502
|
callbackUrl?: string | null | undefined;
|
|
@@ -509,7 +511,6 @@ export declare class ApiClient {
|
|
|
509
511
|
idempotencyKey: string;
|
|
510
512
|
attempts: number;
|
|
511
513
|
params?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
512
|
-
error?: string | null | undefined;
|
|
513
514
|
context?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
514
515
|
style?: {
|
|
515
516
|
style: "normal" | "minimal";
|
|
@@ -533,6 +534,7 @@ export declare class ApiClient {
|
|
|
533
534
|
imageUrl?: string[] | undefined;
|
|
534
535
|
}[] | null | undefined;
|
|
535
536
|
output?: import("@trigger.dev/core").DeserializedJson | undefined;
|
|
537
|
+
error?: string | null | undefined;
|
|
536
538
|
parentId?: string | null | undefined;
|
|
537
539
|
operation?: string | null | undefined;
|
|
538
540
|
callbackUrl?: string | null | undefined;
|
|
@@ -540,11 +542,7 @@ export declare class ApiClient {
|
|
|
540
542
|
forceYield?: boolean | null | undefined;
|
|
541
543
|
}>;
|
|
542
544
|
sendEvent(event: SendEvent, options?: SendEventOptions): Promise<{
|
|
543
|
-
payload: (
|
|
544
|
-
[key: string]: import("@trigger.dev/core").DeserializedJson;
|
|
545
|
-
} | import("@trigger.dev/core").DeserializedJson[]) & (string | number | boolean | {
|
|
546
|
-
[key: string]: import("@trigger.dev/core").DeserializedJson;
|
|
547
|
-
} | import("@trigger.dev/core").DeserializedJson[] | undefined)) | null;
|
|
545
|
+
payload: import("@trigger.dev/core").DeserializedJson;
|
|
548
546
|
name: string;
|
|
549
547
|
id: string;
|
|
550
548
|
timestamp: Date;
|
|
@@ -554,11 +552,7 @@ export declare class ApiClient {
|
|
|
554
552
|
cancelledAt?: Date | null | undefined;
|
|
555
553
|
}>;
|
|
556
554
|
sendEvents(events: SendEvent[], options?: SendEventOptions): Promise<{
|
|
557
|
-
payload: (
|
|
558
|
-
[key: string]: import("@trigger.dev/core").DeserializedJson;
|
|
559
|
-
} | import("@trigger.dev/core").DeserializedJson[]) & (string | number | boolean | {
|
|
560
|
-
[key: string]: import("@trigger.dev/core").DeserializedJson;
|
|
561
|
-
} | import("@trigger.dev/core").DeserializedJson[] | undefined)) | null;
|
|
555
|
+
payload: import("@trigger.dev/core").DeserializedJson;
|
|
562
556
|
name: string;
|
|
563
557
|
id: string;
|
|
564
558
|
timestamp: Date;
|
|
@@ -568,11 +562,7 @@ export declare class ApiClient {
|
|
|
568
562
|
cancelledAt?: Date | null | undefined;
|
|
569
563
|
}[]>;
|
|
570
564
|
cancelEvent(eventId: string): Promise<{
|
|
571
|
-
payload: (
|
|
572
|
-
[key: string]: import("@trigger.dev/core").DeserializedJson;
|
|
573
|
-
} | import("@trigger.dev/core").DeserializedJson[]) & (string | number | boolean | {
|
|
574
|
-
[key: string]: import("@trigger.dev/core").DeserializedJson;
|
|
575
|
-
} | import("@trigger.dev/core").DeserializedJson[] | undefined)) | null;
|
|
565
|
+
payload: import("@trigger.dev/core").DeserializedJson;
|
|
576
566
|
name: string;
|
|
577
567
|
id: string;
|
|
578
568
|
timestamp: Date;
|
|
@@ -593,8 +583,8 @@ export declare class ApiClient {
|
|
|
593
583
|
state?: "loading" | "success" | "failure" | undefined;
|
|
594
584
|
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
595
585
|
}[];
|
|
596
|
-
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
597
586
|
state?: "loading" | "success" | "failure" | undefined;
|
|
587
|
+
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
598
588
|
}>;
|
|
599
589
|
updateSource(client: string, key: string, source: UpdateTriggerSourceBodyV2): Promise<TriggerSource>;
|
|
600
590
|
updateWebhook(key: string, webhookData: UpdateWebhookBody): Promise<TriggerSource>;
|
|
@@ -606,15 +596,15 @@ export declare class ApiClient {
|
|
|
606
596
|
cron: string;
|
|
607
597
|
};
|
|
608
598
|
type: "cron";
|
|
609
|
-
accountId?: string | undefined;
|
|
610
599
|
metadata?: any;
|
|
600
|
+
accountId?: string | undefined;
|
|
611
601
|
} | {
|
|
612
602
|
options: {
|
|
613
603
|
seconds: number;
|
|
614
604
|
};
|
|
615
605
|
type: "interval";
|
|
616
|
-
accountId?: string | undefined;
|
|
617
606
|
metadata?: any;
|
|
607
|
+
accountId?: string | undefined;
|
|
618
608
|
};
|
|
619
609
|
active: boolean;
|
|
620
610
|
metadata?: any;
|
|
@@ -655,8 +645,8 @@ export declare class ApiClient {
|
|
|
655
645
|
state?: "loading" | "success" | "failure" | undefined;
|
|
656
646
|
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
657
647
|
}[];
|
|
658
|
-
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
659
648
|
state?: "loading" | "success" | "failure" | undefined;
|
|
649
|
+
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
660
650
|
}[];
|
|
661
651
|
output?: any;
|
|
662
652
|
nextCursor?: string | undefined;
|
|
@@ -676,8 +666,8 @@ export declare class ApiClient {
|
|
|
676
666
|
state?: "loading" | "success" | "failure" | undefined;
|
|
677
667
|
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
678
668
|
}[];
|
|
679
|
-
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
680
669
|
state?: "loading" | "success" | "failure" | undefined;
|
|
670
|
+
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
681
671
|
}[];
|
|
682
672
|
output?: any;
|
|
683
673
|
nextCursor?: string | undefined;
|
|
@@ -691,8 +681,8 @@ export declare class ApiClient {
|
|
|
691
681
|
state?: "loading" | "success" | "failure" | undefined;
|
|
692
682
|
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
693
683
|
}[];
|
|
694
|
-
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
695
684
|
state?: "loading" | "success" | "failure" | undefined;
|
|
685
|
+
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
696
686
|
}[];
|
|
697
687
|
run: {
|
|
698
688
|
status: "PENDING" | "CANCELED" | "QUEUED" | "WAITING_ON_CONNECTIONS" | "PREPROCESSING" | "STARTED" | "SUCCESS" | "FAILURE" | "TIMED_OUT" | "ABORTED" | "UNRESOLVED_AUTH" | "INVALID_PAYLOAD" | "EXECUTING" | "WAITING_TO_CONTINUE" | "WAITING_TO_EXECUTE";
|
package/dist/commonjs/io.d.ts
CHANGED
|
@@ -242,11 +242,7 @@ export declare class IO {
|
|
|
242
242
|
* @param options Options for sending the event.
|
|
243
243
|
*/
|
|
244
244
|
sendEvent(cacheKey: string | any[], event: SendEvent, options?: SendEventOptions): Promise<{
|
|
245
|
-
payload: (
|
|
246
|
-
[key: string]: import("@trigger.dev/core").DeserializedJson;
|
|
247
|
-
} | import("@trigger.dev/core").DeserializedJson[]) & (string | number | boolean | {
|
|
248
|
-
[key: string]: import("@trigger.dev/core").DeserializedJson;
|
|
249
|
-
} | import("@trigger.dev/core").DeserializedJson[] | undefined)) | null;
|
|
245
|
+
payload: import("@trigger.dev/core").DeserializedJson;
|
|
250
246
|
name: string;
|
|
251
247
|
id: string;
|
|
252
248
|
timestamp: Date;
|
|
@@ -261,11 +257,7 @@ export declare class IO {
|
|
|
261
257
|
* @param options Options for sending the events.
|
|
262
258
|
*/
|
|
263
259
|
sendEvents(cacheKey: string | any[], events: SendEvent[], options?: SendEventOptions): Promise<{
|
|
264
|
-
payload: (
|
|
265
|
-
[key: string]: import("@trigger.dev/core").DeserializedJson;
|
|
266
|
-
} | import("@trigger.dev/core").DeserializedJson[]) & (string | number | boolean | {
|
|
267
|
-
[key: string]: import("@trigger.dev/core").DeserializedJson;
|
|
268
|
-
} | import("@trigger.dev/core").DeserializedJson[] | undefined)) | null;
|
|
260
|
+
payload: import("@trigger.dev/core").DeserializedJson;
|
|
269
261
|
name: string;
|
|
270
262
|
id: string;
|
|
271
263
|
timestamp: Date;
|
|
@@ -292,11 +284,7 @@ export declare class IO {
|
|
|
292
284
|
* @returns
|
|
293
285
|
*/
|
|
294
286
|
cancelEvent(cacheKey: string | any[], eventId: string): Promise<{
|
|
295
|
-
payload: (
|
|
296
|
-
[key: string]: import("@trigger.dev/core").DeserializedJson;
|
|
297
|
-
} | import("@trigger.dev/core").DeserializedJson[]) & (string | number | boolean | {
|
|
298
|
-
[key: string]: import("@trigger.dev/core").DeserializedJson;
|
|
299
|
-
} | import("@trigger.dev/core").DeserializedJson[] | undefined)) | null;
|
|
287
|
+
payload: import("@trigger.dev/core").DeserializedJson;
|
|
300
288
|
name: string;
|
|
301
289
|
id: string;
|
|
302
290
|
timestamp: Date;
|
|
@@ -332,15 +320,15 @@ export declare class IO {
|
|
|
332
320
|
cron: string;
|
|
333
321
|
};
|
|
334
322
|
type: "cron";
|
|
335
|
-
accountId?: string | undefined;
|
|
336
323
|
metadata?: any;
|
|
324
|
+
accountId?: string | undefined;
|
|
337
325
|
} | {
|
|
338
326
|
options: {
|
|
339
327
|
seconds: number;
|
|
340
328
|
};
|
|
341
329
|
type: "interval";
|
|
342
|
-
accountId?: string | undefined;
|
|
343
330
|
metadata?: any;
|
|
331
|
+
accountId?: string | undefined;
|
|
344
332
|
};
|
|
345
333
|
active: boolean;
|
|
346
334
|
metadata?: any;
|
|
@@ -368,15 +356,15 @@ export declare class IO {
|
|
|
368
356
|
cron: string;
|
|
369
357
|
};
|
|
370
358
|
type: "cron";
|
|
371
|
-
accountId?: string | undefined;
|
|
372
359
|
metadata?: any;
|
|
360
|
+
accountId?: string | undefined;
|
|
373
361
|
} | {
|
|
374
362
|
options: {
|
|
375
363
|
seconds: number;
|
|
376
364
|
};
|
|
377
365
|
type: "interval";
|
|
378
|
-
accountId?: string | undefined;
|
|
379
366
|
metadata?: any;
|
|
367
|
+
accountId?: string | undefined;
|
|
380
368
|
};
|
|
381
369
|
active: boolean;
|
|
382
370
|
metadata?: any;
|
|
@@ -13,7 +13,7 @@ export declare class TriggerStatus {
|
|
|
13
13
|
state?: "loading" | "success" | "failure" | undefined;
|
|
14
14
|
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
15
15
|
}[];
|
|
16
|
-
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
17
16
|
state?: "loading" | "success" | "failure" | undefined;
|
|
17
|
+
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
18
18
|
}>;
|
|
19
19
|
}
|
|
@@ -116,11 +116,7 @@ export declare class TriggerClient {
|
|
|
116
116
|
* @returns A promise that resolves to the event details
|
|
117
117
|
*/
|
|
118
118
|
sendEvent(event: SendEvent, options?: SendEventOptions): Promise<{
|
|
119
|
-
payload:
|
|
120
|
-
[key: string]: DeserializedJson;
|
|
121
|
-
} | DeserializedJson[]) & (string | number | boolean | {
|
|
122
|
-
[key: string]: DeserializedJson;
|
|
123
|
-
} | DeserializedJson[] | undefined)) | null;
|
|
119
|
+
payload: DeserializedJson;
|
|
124
120
|
name: string;
|
|
125
121
|
id: string;
|
|
126
122
|
timestamp: Date;
|
|
@@ -135,11 +131,7 @@ export declare class TriggerClient {
|
|
|
135
131
|
* @returns A promise that resolves to an array of event details
|
|
136
132
|
*/
|
|
137
133
|
sendEvents(events: SendEvent[], options?: SendEventOptions): Promise<{
|
|
138
|
-
payload:
|
|
139
|
-
[key: string]: DeserializedJson;
|
|
140
|
-
} | DeserializedJson[]) & (string | number | boolean | {
|
|
141
|
-
[key: string]: DeserializedJson;
|
|
142
|
-
} | DeserializedJson[] | undefined)) | null;
|
|
134
|
+
payload: DeserializedJson;
|
|
143
135
|
name: string;
|
|
144
136
|
id: string;
|
|
145
137
|
timestamp: Date;
|
|
@@ -149,11 +141,7 @@ export declare class TriggerClient {
|
|
|
149
141
|
cancelledAt?: Date | null | undefined;
|
|
150
142
|
}[]>;
|
|
151
143
|
cancelEvent(eventId: string): Promise<{
|
|
152
|
-
payload:
|
|
153
|
-
[key: string]: DeserializedJson;
|
|
154
|
-
} | DeserializedJson[]) & (string | number | boolean | {
|
|
155
|
-
[key: string]: DeserializedJson;
|
|
156
|
-
} | DeserializedJson[] | undefined)) | null;
|
|
144
|
+
payload: DeserializedJson;
|
|
157
145
|
name: string;
|
|
158
146
|
id: string;
|
|
159
147
|
timestamp: Date;
|
|
@@ -174,8 +162,10 @@ export declare class TriggerClient {
|
|
|
174
162
|
state?: "loading" | "success" | "failure" | undefined;
|
|
175
163
|
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
176
164
|
}[];
|
|
177
|
-
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
178
165
|
state?: "loading" | "success" | "failure" | undefined;
|
|
166
|
+
data?: Record<string, import(
|
|
167
|
+
/** Default is unset and off. If set to true it will log to the server's console as well as the Trigger.dev platform */
|
|
168
|
+
"@trigger.dev/core").SerializableJson> | undefined;
|
|
179
169
|
}>;
|
|
180
170
|
registerSchedule(id: string, key: string, schedule: ScheduleMetadata): Promise<{
|
|
181
171
|
id: string;
|
|
@@ -184,15 +174,15 @@ export declare class TriggerClient {
|
|
|
184
174
|
cron: string;
|
|
185
175
|
};
|
|
186
176
|
type: "cron";
|
|
187
|
-
accountId?: string | undefined;
|
|
188
177
|
metadata?: any;
|
|
178
|
+
accountId?: string | undefined;
|
|
189
179
|
} | {
|
|
190
180
|
options: {
|
|
191
181
|
seconds: number;
|
|
192
182
|
};
|
|
193
183
|
type: "interval";
|
|
194
|
-
accountId?: string | undefined;
|
|
195
184
|
metadata?: any;
|
|
185
|
+
accountId?: string | undefined;
|
|
196
186
|
};
|
|
197
187
|
active: boolean;
|
|
198
188
|
metadata?: any;
|
|
@@ -227,8 +217,8 @@ export declare class TriggerClient {
|
|
|
227
217
|
state?: "loading" | "success" | "failure" | undefined;
|
|
228
218
|
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
229
219
|
}[];
|
|
230
|
-
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
231
220
|
state?: "loading" | "success" | "failure" | undefined;
|
|
221
|
+
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
232
222
|
}[];
|
|
233
223
|
output?: any;
|
|
234
224
|
nextCursor?: string | undefined;
|
|
@@ -248,8 +238,8 @@ export declare class TriggerClient {
|
|
|
248
238
|
state?: "loading" | "success" | "failure" | undefined;
|
|
249
239
|
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
250
240
|
}[];
|
|
251
|
-
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
252
241
|
state?: "loading" | "success" | "failure" | undefined;
|
|
242
|
+
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
253
243
|
}[];
|
|
254
244
|
output?: any;
|
|
255
245
|
nextCursor?: string | undefined;
|
|
@@ -273,8 +263,8 @@ export declare class TriggerClient {
|
|
|
273
263
|
state?: "loading" | "success" | "failure" | undefined;
|
|
274
264
|
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
275
265
|
}[];
|
|
276
|
-
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
277
266
|
state?: "loading" | "success" | "failure" | undefined;
|
|
267
|
+
data?: Record<string, import("@trigger.dev/core").SerializableJson> | undefined;
|
|
278
268
|
}[];
|
|
279
269
|
run: {
|
|
280
270
|
status: "PENDING" | "CANCELED" | "QUEUED" | "WAITING_ON_CONNECTIONS" | "PREPROCESSING" | "STARTED" | "SUCCESS" | "FAILURE" | "TIMED_OUT" | "ABORTED" | "UNRESOLVED_AUTH" | "INVALID_PAYLOAD" | "EXECUTING" | "WAITING_TO_CONTINUE" | "WAITING_TO_EXECUTE";
|
|
@@ -119,15 +119,15 @@ export declare class DynamicSchedule implements Trigger<ScheduledEventSpecificat
|
|
|
119
119
|
cron: string;
|
|
120
120
|
};
|
|
121
121
|
type: "cron";
|
|
122
|
-
accountId?: string | undefined;
|
|
123
122
|
metadata?: any;
|
|
123
|
+
accountId?: string | undefined;
|
|
124
124
|
} | {
|
|
125
125
|
options: {
|
|
126
126
|
seconds: number;
|
|
127
127
|
};
|
|
128
128
|
type: "interval";
|
|
129
|
-
accountId?: string | undefined;
|
|
130
129
|
metadata?: any;
|
|
130
|
+
accountId?: string | undefined;
|
|
131
131
|
};
|
|
132
132
|
active: boolean;
|
|
133
133
|
metadata?: any;
|
package/dist/commonjs/types.d.ts
CHANGED
|
@@ -186,16 +186,16 @@ export declare function waitForEventSchema(schema: z.ZodTypeAny): z.ZodObject<{
|
|
|
186
186
|
id: string;
|
|
187
187
|
timestamp: Date;
|
|
188
188
|
payload?: any;
|
|
189
|
-
context?: any;
|
|
190
189
|
accountId?: string | undefined;
|
|
190
|
+
context?: any;
|
|
191
191
|
}, {
|
|
192
192
|
name: string;
|
|
193
193
|
source: string;
|
|
194
194
|
id: string;
|
|
195
195
|
timestamp: Date;
|
|
196
196
|
payload?: any;
|
|
197
|
-
context?: any;
|
|
198
197
|
accountId?: string | undefined;
|
|
198
|
+
context?: any;
|
|
199
199
|
}>;
|
|
200
200
|
export type NotificationEvents = {
|
|
201
201
|
runSucceeeded: (notification: SuccessfulRunNotification<any>) => void;
|
|
@@ -22,7 +22,7 @@ export declare const auth: {
|
|
|
22
22
|
createPublicToken: typeof createPublicToken;
|
|
23
23
|
withAuth: typeof withAuth;
|
|
24
24
|
};
|
|
25
|
-
type PublicTokenPermissionAction = "read";
|
|
25
|
+
type PublicTokenPermissionAction = "read" | "write";
|
|
26
26
|
type PublicTokenPermissionProperties = {
|
|
27
27
|
/**
|
|
28
28
|
* Grant access to specific tasks
|
package/dist/commonjs/v3/auth.js
CHANGED
|
@@ -90,6 +90,9 @@ function flattenScopes(permissions) {
|
|
|
90
90
|
else if (typeof value === "string") {
|
|
91
91
|
flattenedPermissions.push(`${action}:${property}:${value}`);
|
|
92
92
|
}
|
|
93
|
+
else if (typeof value === "boolean" && value) {
|
|
94
|
+
flattenedPermissions.push(`${action}:${property}`);
|
|
95
|
+
}
|
|
93
96
|
}
|
|
94
97
|
}
|
|
95
98
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../../src/v3/auth.ts"],"names":[],"mappings":";;;AAoBA,8BAEC;AAtBD,6CAAqF;AACrF,6CAA2E;AAE3E;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,SAAS,CAAC,OAA+B;IACvD,qBAAgB,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;AAC5D,CAAC;AAEY,QAAA,IAAI,GAAG;IAClB,SAAS;IACT,iBAAiB;IACjB,QAAQ;CACT,CAAC;AA0DF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,KAAK,UAAU,iBAAiB,CAAC,OAAkC;IACjE,MAAM,SAAS,GAAG,qBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,iBAAiB,EAAE,CAAC;IAEnD,OAAO,MAAM,IAAA,gBAAoB,EAAC;QAChC,SAAS,EAAE,SAAS,CAAC,WAAW;QAChC,OAAO,EAAE;YACP,GAAG,MAAM;YACT,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;SACpE;QACD,cAAc,EAAE,OAAO,EAAE,cAAc;KACxC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,QAAQ,CACrB,MAA8B,EAC9B,EAAK;IAEL,OAAO,qBAAgB,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,aAAa,CAAC,WAAmC;IACxD,MAAM,oBAAoB,GAAa,EAAE,CAAC;IAE1C,KAAK,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/D,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,OAAO,UAAU,KAAK,SAAS,IAAI,UAAU,EAAE,CAAC;gBAClD,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACpC,CAAC;iBAAM,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;gBAC1C,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC3D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;wBACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;4BACzB,oBAAoB,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC;wBAC7D,CAAC;oBACH,CAAC;yBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;wBACrC,oBAAoB,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,QAAQ,IAAI,KAAK,EAAE,CAAC,CAAC;oBAC9D,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC"}
|
|
1
|
+
{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../../src/v3/auth.ts"],"names":[],"mappings":";;;AAoBA,8BAEC;AAtBD,6CAAqF;AACrF,6CAA2E;AAE3E;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,SAAS,CAAC,OAA+B;IACvD,qBAAgB,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;AAC5D,CAAC;AAEY,QAAA,IAAI,GAAG;IAClB,SAAS;IACT,iBAAiB;IACjB,QAAQ;CACT,CAAC;AA0DF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,KAAK,UAAU,iBAAiB,CAAC,OAAkC;IACjE,MAAM,SAAS,GAAG,qBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,iBAAiB,EAAE,CAAC;IAEnD,OAAO,MAAM,IAAA,gBAAoB,EAAC;QAChC,SAAS,EAAE,SAAS,CAAC,WAAW;QAChC,OAAO,EAAE;YACP,GAAG,MAAM;YACT,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;SACpE;QACD,cAAc,EAAE,OAAO,EAAE,cAAc;KACxC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,QAAQ,CACrB,MAA8B,EAC9B,EAAK;IAEL,OAAO,qBAAgB,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,aAAa,CAAC,WAAmC;IACxD,MAAM,oBAAoB,GAAa,EAAE,CAAC;IAE1C,KAAK,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/D,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,OAAO,UAAU,KAAK,SAAS,IAAI,UAAU,EAAE,CAAC;gBAClD,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACpC,CAAC;iBAAM,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;gBAC1C,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC3D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;wBACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;4BACzB,oBAAoB,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC;wBAC7D,CAAC;oBACH,CAAC;yBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;wBACrC,oBAAoB,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,QAAQ,IAAI,KAAK,EAAE,CAAC,CAAC;oBAC9D,CAAC;yBAAM,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,EAAE,CAAC;wBAC/C,oBAAoB,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,QAAQ,EAAE,CAAC,CAAC;oBACrD,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC"}
|
|
@@ -1,44 +1,5 @@
|
|
|
1
|
-
import { type IdempotencyKey } from "@trigger.dev/core/v3";
|
|
1
|
+
import { createIdempotencyKey, type IdempotencyKey } from "@trigger.dev/core/v3";
|
|
2
2
|
export declare const idempotencyKeys: {
|
|
3
3
|
create: typeof createIdempotencyKey;
|
|
4
4
|
};
|
|
5
5
|
export type { IdempotencyKey };
|
|
6
|
-
export declare function isIdempotencyKey(value: string | string[] | IdempotencyKey): value is IdempotencyKey;
|
|
7
|
-
/**
|
|
8
|
-
* Creates a deterministic idempotency key based on the provided key material.
|
|
9
|
-
*
|
|
10
|
-
* If running inside a task, the task run ID is automatically included in the key material, giving you a unique key per task run.
|
|
11
|
-
* This ensures that a given child task is only triggered once per task run, even if the parent task is retried.
|
|
12
|
-
*
|
|
13
|
-
* @param {string | string[]} key The key material to create the idempotency key from.
|
|
14
|
-
* @param {object} [options] Additional options.
|
|
15
|
-
* @param {"run" | "attempt" | "global"} [options.scope="run"] The scope of the idempotency key.
|
|
16
|
-
*
|
|
17
|
-
* @returns {Promise<IdempotencyKey>} The idempotency key as a branded string.
|
|
18
|
-
*
|
|
19
|
-
* @example
|
|
20
|
-
*
|
|
21
|
-
* ```typescript
|
|
22
|
-
* import { idempotencyKeys, task } from "@trigger.dev/sdk/v3";
|
|
23
|
-
*
|
|
24
|
-
* export const myTask = task({
|
|
25
|
-
* id: "my-task",
|
|
26
|
-
* run: async (payload: any) => {
|
|
27
|
-
* const idempotencyKey = await idempotencyKeys.create("my-task-key");
|
|
28
|
-
*
|
|
29
|
-
* // Use the idempotency key when triggering child tasks
|
|
30
|
-
* await childTask.triggerAndWait(payload, { idempotencyKey });
|
|
31
|
-
* }
|
|
32
|
-
* });
|
|
33
|
-
* ```
|
|
34
|
-
*
|
|
35
|
-
* You can also use the `scope` parameter to create a key that is unique per task run, task run attempts (retries of the same run), or globally:
|
|
36
|
-
*
|
|
37
|
-
* ```typescript
|
|
38
|
-
* await idempotencyKeys.create("my-task-key", { scope: "attempt" }); // Creates a key that is unique per task run attempt
|
|
39
|
-
* await idempotencyKeys.create("my-task-key", { scope: "global" }); // Skips including the task run ID
|
|
40
|
-
* ```
|
|
41
|
-
*/
|
|
42
|
-
declare function createIdempotencyKey(key: string | string[], options?: {
|
|
43
|
-
scope?: "run" | "attempt" | "global";
|
|
44
|
-
}): Promise<IdempotencyKey>;
|