@trigger.dev/sdk 3.0.6 → 3.0.8
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/v3/envvars.js +6 -25
- package/dist/commonjs/v3/envvars.js.map +1 -1
- package/dist/commonjs/v3/index.d.ts +1 -0
- package/dist/commonjs/v3/index.js +1 -0
- package/dist/commonjs/v3/index.js.map +1 -1
- package/dist/commonjs/v3/metadata.d.ts +79 -0
- package/dist/commonjs/v3/metadata.js +133 -0
- package/dist/commonjs/v3/metadata.js.map +1 -0
- package/dist/commonjs/v3/runs.d.ts +24 -0
- package/dist/commonjs/v3/runs.js +5 -21
- package/dist/commonjs/v3/runs.js.map +1 -1
- package/dist/commonjs/v3/schedules/index.js +7 -31
- package/dist/commonjs/v3/schedules/index.js.map +1 -1
- package/dist/commonjs/v3/shared.d.ts +5 -1
- package/dist/commonjs/v3/shared.js +8 -31
- package/dist/commonjs/v3/shared.js.map +1 -1
- package/dist/commonjs/v3/tags.js +1 -5
- package/dist/commonjs/v3/tags.js.map +1 -1
- package/dist/commonjs/version.js +1 -1
- package/dist/esm/v3/envvars.js +6 -25
- package/dist/esm/v3/envvars.js.map +1 -1
- package/dist/esm/v3/index.d.ts +1 -0
- package/dist/esm/v3/index.js +1 -0
- package/dist/esm/v3/index.js.map +1 -1
- package/dist/esm/v3/metadata.d.ts +79 -0
- package/dist/esm/v3/metadata.js +130 -0
- package/dist/esm/v3/metadata.js.map +1 -0
- package/dist/esm/v3/runs.d.ts +24 -0
- package/dist/esm/v3/runs.js +5 -21
- package/dist/esm/v3/runs.js.map +1 -1
- package/dist/esm/v3/schedules/index.js +8 -32
- package/dist/esm/v3/schedules/index.js.map +1 -1
- package/dist/esm/v3/shared.d.ts +5 -1
- package/dist/esm/v3/shared.js +8 -30
- package/dist/esm/v3/shared.js.map +1 -1
- package/dist/esm/v3/tags.js +1 -5
- package/dist/esm/v3/tags.js.map +1 -1
- package/dist/esm/version.js +1 -1
- package/package.json +2 -2
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
import { accessoryAttributes, flattenAttributes, mergeRequestOptions, runMetadata, } from "@trigger.dev/core/v3";
|
|
2
|
+
import { tracer } from "./tracer.js";
|
|
3
|
+
/**
|
|
4
|
+
* Provides access to run metadata operations.
|
|
5
|
+
* @namespace
|
|
6
|
+
* @property {Function} current - Get the current run's metadata.
|
|
7
|
+
* @property {Function} get - Get a specific key from the current run's metadata.
|
|
8
|
+
* @property {Function} set - Set a key in the current run's metadata.
|
|
9
|
+
* @property {Function} del - Delete a key from the current run's metadata.
|
|
10
|
+
* @property {Function} save - Update the entire metadata object for the current run.
|
|
11
|
+
*/
|
|
12
|
+
export const metadata = {
|
|
13
|
+
current: currentMetadata,
|
|
14
|
+
get: getMetadataKey,
|
|
15
|
+
set: setMetadataKey,
|
|
16
|
+
del: deleteMetadataKey,
|
|
17
|
+
save: saveMetadata,
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* Returns the metadata of the current run if inside a task run.
|
|
21
|
+
* This function allows you to access the entire metadata object for the current run.
|
|
22
|
+
*
|
|
23
|
+
* @returns {RunMetadata | undefined} The current run's metadata or undefined if not in a run context.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* const currentMetadata = metadata.current();
|
|
27
|
+
* console.log(currentMetadata);
|
|
28
|
+
*/
|
|
29
|
+
function currentMetadata() {
|
|
30
|
+
return runMetadata.current();
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Get a specific key from the metadata of the current run if inside a task run.
|
|
34
|
+
*
|
|
35
|
+
* @param {string} key - The key to retrieve from the metadata.
|
|
36
|
+
* @returns {DeserializedJson | undefined} The value associated with the key, or undefined if not found or not in a run context.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* const user = metadata.get("user");
|
|
40
|
+
* console.log(user.name); // "Eric"
|
|
41
|
+
* console.log(user.id); // "user_1234"
|
|
42
|
+
*/
|
|
43
|
+
function getMetadataKey(key) {
|
|
44
|
+
return runMetadata.getKey(key);
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Set a key in the metadata of the current run if inside a task run.
|
|
48
|
+
* This function allows you to update or add a new key-value pair to the run's metadata.
|
|
49
|
+
*
|
|
50
|
+
* @param {string} key - The key to set in the metadata.
|
|
51
|
+
* @param {DeserializedJson} value - The value to associate with the key.
|
|
52
|
+
* @param {ApiRequestOptions} [requestOptions] - Optional API request options.
|
|
53
|
+
* @returns {Promise<void>} A promise that resolves when the metadata is updated.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* await metadata.set("progress", 0.5);
|
|
57
|
+
*/
|
|
58
|
+
async function setMetadataKey(key, value, requestOptions) {
|
|
59
|
+
const $requestOptions = mergeRequestOptions({
|
|
60
|
+
tracer,
|
|
61
|
+
name: "metadata.set()",
|
|
62
|
+
icon: "code-plus",
|
|
63
|
+
attributes: {
|
|
64
|
+
...accessoryAttributes({
|
|
65
|
+
items: [
|
|
66
|
+
{
|
|
67
|
+
text: key,
|
|
68
|
+
variant: "normal",
|
|
69
|
+
},
|
|
70
|
+
],
|
|
71
|
+
style: "codepath",
|
|
72
|
+
}),
|
|
73
|
+
...flattenAttributes(value, key),
|
|
74
|
+
},
|
|
75
|
+
}, requestOptions);
|
|
76
|
+
await runMetadata.setKey(key, value, $requestOptions);
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Delete a key from the metadata of the current run if inside a task run.
|
|
80
|
+
*
|
|
81
|
+
* @param {string} key - The key to delete from the metadata.
|
|
82
|
+
* @param {ApiRequestOptions} [requestOptions] - Optional API request options.
|
|
83
|
+
* @returns {Promise<void>} A promise that resolves when the key is deleted from the metadata.
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* await metadata.del("progress");
|
|
87
|
+
*/
|
|
88
|
+
async function deleteMetadataKey(key, requestOptions) {
|
|
89
|
+
const $requestOptions = mergeRequestOptions({
|
|
90
|
+
tracer,
|
|
91
|
+
name: "metadata.del()",
|
|
92
|
+
icon: "code-minus",
|
|
93
|
+
attributes: {
|
|
94
|
+
...accessoryAttributes({
|
|
95
|
+
items: [
|
|
96
|
+
{
|
|
97
|
+
text: key,
|
|
98
|
+
variant: "normal",
|
|
99
|
+
},
|
|
100
|
+
],
|
|
101
|
+
style: "codepath",
|
|
102
|
+
}),
|
|
103
|
+
key,
|
|
104
|
+
},
|
|
105
|
+
}, requestOptions);
|
|
106
|
+
await runMetadata.deleteKey(key, $requestOptions);
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Update the entire metadata object for the current run if inside a task run.
|
|
110
|
+
* This function allows you to replace the entire metadata object with a new one.
|
|
111
|
+
*
|
|
112
|
+
* @param {RunMetadata} metadata - The new metadata object to set for the run.
|
|
113
|
+
* @param {ApiRequestOptions} [requestOptions] - Optional API request options.
|
|
114
|
+
* @returns {Promise<void>} A promise that resolves when the metadata is updated.
|
|
115
|
+
*
|
|
116
|
+
* @example
|
|
117
|
+
* await metadata.save({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
|
|
118
|
+
*/
|
|
119
|
+
async function saveMetadata(metadata, requestOptions) {
|
|
120
|
+
const $requestOptions = mergeRequestOptions({
|
|
121
|
+
tracer,
|
|
122
|
+
name: "metadata.save()",
|
|
123
|
+
icon: "code-plus",
|
|
124
|
+
attributes: {
|
|
125
|
+
...flattenAttributes(metadata),
|
|
126
|
+
},
|
|
127
|
+
}, requestOptions);
|
|
128
|
+
await runMetadata.update(metadata, $requestOptions);
|
|
129
|
+
}
|
|
130
|
+
//# sourceMappingURL=metadata.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/v3/metadata.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EAEnB,iBAAiB,EACjB,mBAAmB,EACnB,WAAW,GACZ,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;;;;;;GAQG;AAEH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,OAAO,EAAE,eAAe;IACxB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,iBAAiB;IACtB,IAAI,EAAE,YAAY;CACnB,CAAC;AAIF;;;;;;;;;GASG;AACH,SAAS,eAAe;IACtB,OAAO,WAAW,CAAC,OAAO,EAAE,CAAC;AAC/B,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,cAAc,CAAC,GAAW;IACjC,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,cAAc,CAC3B,GAAW,EACX,KAAuB,EACvB,cAAkC;IAElC,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,WAAW;QACjB,UAAU,EAAE;YACV,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,GAAG;wBACT,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;YACF,GAAG,iBAAiB,CAAC,KAAK,EAAE,GAAG,CAAC;SACjC;KACF,EACD,cAAc,CACf,CAAC;IAEF,MAAM,WAAW,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;AACxD,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,iBAAiB,CAAC,GAAW,EAAE,cAAkC;IAC9E,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,YAAY;QAClB,UAAU,EAAE;YACV,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,GAAG;wBACT,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;YACF,GAAG;SACJ;KACF,EACD,cAAc,CACf,CAAC;IAEF,MAAM,WAAW,CAAC,SAAS,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,YAAY,CACzB,QAAqB,EACrB,cAAkC;IAElC,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,WAAW;QACjB,UAAU,EAAE;YACV,GAAG,iBAAiB,CAAC,QAAQ,CAAC;SAC/B;KACF,EACD,cAAc,CACf,CAAC;IAEF,MAAM,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;AACtD,CAAC"}
|
package/dist/esm/v3/runs.d.ts
CHANGED
|
@@ -87,6 +87,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
87
87
|
delayedUntil?: Date | undefined;
|
|
88
88
|
ttl?: string | undefined;
|
|
89
89
|
expiredAt?: Date | undefined;
|
|
90
|
+
metadata?: Record<string, any> | undefined;
|
|
90
91
|
} | undefined;
|
|
91
92
|
parent?: {
|
|
92
93
|
status: "COMPLETED" | "CANCELED" | "QUEUED" | "EXECUTING" | "FAILED" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
@@ -115,6 +116,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
115
116
|
delayedUntil?: Date | undefined;
|
|
116
117
|
ttl?: string | undefined;
|
|
117
118
|
expiredAt?: Date | undefined;
|
|
119
|
+
metadata?: Record<string, any> | undefined;
|
|
118
120
|
} | undefined;
|
|
119
121
|
children?: {
|
|
120
122
|
status: "COMPLETED" | "CANCELED" | "QUEUED" | "EXECUTING" | "FAILED" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
@@ -143,6 +145,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
143
145
|
delayedUntil?: Date | undefined;
|
|
144
146
|
ttl?: string | undefined;
|
|
145
147
|
expiredAt?: Date | undefined;
|
|
148
|
+
metadata?: Record<string, any> | undefined;
|
|
146
149
|
}[] | undefined;
|
|
147
150
|
};
|
|
148
151
|
payload?: any;
|
|
@@ -167,6 +170,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
167
170
|
delayedUntil?: Date | undefined;
|
|
168
171
|
ttl?: string | undefined;
|
|
169
172
|
expiredAt?: Date | undefined;
|
|
173
|
+
metadata?: Record<string, any> | undefined;
|
|
170
174
|
}, "output"> & {
|
|
171
175
|
output?: TOutput;
|
|
172
176
|
} : TRunId extends Task<string, any, infer TTaskOutput> ? Omit<{
|
|
@@ -229,6 +233,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
229
233
|
delayedUntil?: Date | undefined;
|
|
230
234
|
ttl?: string | undefined;
|
|
231
235
|
expiredAt?: Date | undefined;
|
|
236
|
+
metadata?: Record<string, any> | undefined;
|
|
232
237
|
} | undefined;
|
|
233
238
|
parent?: {
|
|
234
239
|
status: "COMPLETED" | "CANCELED" | "QUEUED" | "EXECUTING" | "FAILED" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
@@ -257,6 +262,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
257
262
|
delayedUntil?: Date | undefined;
|
|
258
263
|
ttl?: string | undefined;
|
|
259
264
|
expiredAt?: Date | undefined;
|
|
265
|
+
metadata?: Record<string, any> | undefined;
|
|
260
266
|
} | undefined;
|
|
261
267
|
children?: {
|
|
262
268
|
status: "COMPLETED" | "CANCELED" | "QUEUED" | "EXECUTING" | "FAILED" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
@@ -285,6 +291,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
285
291
|
delayedUntil?: Date | undefined;
|
|
286
292
|
ttl?: string | undefined;
|
|
287
293
|
expiredAt?: Date | undefined;
|
|
294
|
+
metadata?: Record<string, any> | undefined;
|
|
288
295
|
}[] | undefined;
|
|
289
296
|
};
|
|
290
297
|
payload?: any;
|
|
@@ -309,6 +316,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
309
316
|
delayedUntil?: Date | undefined;
|
|
310
317
|
ttl?: string | undefined;
|
|
311
318
|
expiredAt?: Date | undefined;
|
|
319
|
+
metadata?: Record<string, any> | undefined;
|
|
312
320
|
}, "output"> & {
|
|
313
321
|
output?: TTaskOutput;
|
|
314
322
|
} : TRunId extends string ? {
|
|
@@ -371,6 +379,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
371
379
|
delayedUntil?: Date | undefined;
|
|
372
380
|
ttl?: string | undefined;
|
|
373
381
|
expiredAt?: Date | undefined;
|
|
382
|
+
metadata?: Record<string, any> | undefined;
|
|
374
383
|
} | undefined;
|
|
375
384
|
parent?: {
|
|
376
385
|
status: "COMPLETED" | "CANCELED" | "QUEUED" | "EXECUTING" | "FAILED" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
@@ -399,6 +408,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
399
408
|
delayedUntil?: Date | undefined;
|
|
400
409
|
ttl?: string | undefined;
|
|
401
410
|
expiredAt?: Date | undefined;
|
|
411
|
+
metadata?: Record<string, any> | undefined;
|
|
402
412
|
} | undefined;
|
|
403
413
|
children?: {
|
|
404
414
|
status: "COMPLETED" | "CANCELED" | "QUEUED" | "EXECUTING" | "FAILED" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
@@ -427,6 +437,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
427
437
|
delayedUntil?: Date | undefined;
|
|
428
438
|
ttl?: string | undefined;
|
|
429
439
|
expiredAt?: Date | undefined;
|
|
440
|
+
metadata?: Record<string, any> | undefined;
|
|
430
441
|
}[] | undefined;
|
|
431
442
|
};
|
|
432
443
|
payload?: any;
|
|
@@ -451,6 +462,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
451
462
|
delayedUntil?: Date | undefined;
|
|
452
463
|
ttl?: string | undefined;
|
|
453
464
|
expiredAt?: Date | undefined;
|
|
465
|
+
metadata?: Record<string, any> | undefined;
|
|
454
466
|
} : never) extends infer T ? { [K in keyof T]: (TRunId extends RunHandle<infer TOutput> ? Omit<{
|
|
455
467
|
status: "COMPLETED" | "CANCELED" | "QUEUED" | "EXECUTING" | "FAILED" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
456
468
|
id: string;
|
|
@@ -511,6 +523,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
511
523
|
delayedUntil?: Date | undefined;
|
|
512
524
|
ttl?: string | undefined;
|
|
513
525
|
expiredAt?: Date | undefined;
|
|
526
|
+
metadata?: Record<string, any> | undefined;
|
|
514
527
|
} | undefined;
|
|
515
528
|
parent?: {
|
|
516
529
|
status: "COMPLETED" | "CANCELED" | "QUEUED" | "EXECUTING" | "FAILED" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
@@ -539,6 +552,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
539
552
|
delayedUntil?: Date | undefined;
|
|
540
553
|
ttl?: string | undefined;
|
|
541
554
|
expiredAt?: Date | undefined;
|
|
555
|
+
metadata?: Record<string, any> | undefined;
|
|
542
556
|
} | undefined;
|
|
543
557
|
children?: {
|
|
544
558
|
status: "COMPLETED" | "CANCELED" | "QUEUED" | "EXECUTING" | "FAILED" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
@@ -567,6 +581,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
567
581
|
delayedUntil?: Date | undefined;
|
|
568
582
|
ttl?: string | undefined;
|
|
569
583
|
expiredAt?: Date | undefined;
|
|
584
|
+
metadata?: Record<string, any> | undefined;
|
|
570
585
|
}[] | undefined;
|
|
571
586
|
};
|
|
572
587
|
payload?: any;
|
|
@@ -591,6 +606,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
591
606
|
delayedUntil?: Date | undefined;
|
|
592
607
|
ttl?: string | undefined;
|
|
593
608
|
expiredAt?: Date | undefined;
|
|
609
|
+
metadata?: Record<string, any> | undefined;
|
|
594
610
|
}, "output"> & {
|
|
595
611
|
output?: TOutput;
|
|
596
612
|
} : TRunId extends Task<string, any, infer TTaskOutput> ? Omit<{
|
|
@@ -653,6 +669,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
653
669
|
delayedUntil?: Date | undefined;
|
|
654
670
|
ttl?: string | undefined;
|
|
655
671
|
expiredAt?: Date | undefined;
|
|
672
|
+
metadata?: Record<string, any> | undefined;
|
|
656
673
|
} | undefined;
|
|
657
674
|
parent?: {
|
|
658
675
|
status: "COMPLETED" | "CANCELED" | "QUEUED" | "EXECUTING" | "FAILED" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
@@ -681,6 +698,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
681
698
|
delayedUntil?: Date | undefined;
|
|
682
699
|
ttl?: string | undefined;
|
|
683
700
|
expiredAt?: Date | undefined;
|
|
701
|
+
metadata?: Record<string, any> | undefined;
|
|
684
702
|
} | undefined;
|
|
685
703
|
children?: {
|
|
686
704
|
status: "COMPLETED" | "CANCELED" | "QUEUED" | "EXECUTING" | "FAILED" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
@@ -709,6 +727,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
709
727
|
delayedUntil?: Date | undefined;
|
|
710
728
|
ttl?: string | undefined;
|
|
711
729
|
expiredAt?: Date | undefined;
|
|
730
|
+
metadata?: Record<string, any> | undefined;
|
|
712
731
|
}[] | undefined;
|
|
713
732
|
};
|
|
714
733
|
payload?: any;
|
|
@@ -733,6 +752,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
733
752
|
delayedUntil?: Date | undefined;
|
|
734
753
|
ttl?: string | undefined;
|
|
735
754
|
expiredAt?: Date | undefined;
|
|
755
|
+
metadata?: Record<string, any> | undefined;
|
|
736
756
|
}, "output"> & {
|
|
737
757
|
output?: TTaskOutput;
|
|
738
758
|
} : TRunId extends string ? {
|
|
@@ -795,6 +815,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
795
815
|
delayedUntil?: Date | undefined;
|
|
796
816
|
ttl?: string | undefined;
|
|
797
817
|
expiredAt?: Date | undefined;
|
|
818
|
+
metadata?: Record<string, any> | undefined;
|
|
798
819
|
} | undefined;
|
|
799
820
|
parent?: {
|
|
800
821
|
status: "COMPLETED" | "CANCELED" | "QUEUED" | "EXECUTING" | "FAILED" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
@@ -823,6 +844,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
823
844
|
delayedUntil?: Date | undefined;
|
|
824
845
|
ttl?: string | undefined;
|
|
825
846
|
expiredAt?: Date | undefined;
|
|
847
|
+
metadata?: Record<string, any> | undefined;
|
|
826
848
|
} | undefined;
|
|
827
849
|
children?: {
|
|
828
850
|
status: "COMPLETED" | "CANCELED" | "QUEUED" | "EXECUTING" | "FAILED" | "WAITING_FOR_DEPLOY" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
@@ -851,6 +873,7 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
851
873
|
delayedUntil?: Date | undefined;
|
|
852
874
|
ttl?: string | undefined;
|
|
853
875
|
expiredAt?: Date | undefined;
|
|
876
|
+
metadata?: Record<string, any> | undefined;
|
|
854
877
|
}[] | undefined;
|
|
855
878
|
};
|
|
856
879
|
payload?: any;
|
|
@@ -875,5 +898,6 @@ declare function poll<TRunId extends RunHandle<any> | AnyTask | string>(runId: R
|
|
|
875
898
|
delayedUntil?: Date | undefined;
|
|
876
899
|
ttl?: string | undefined;
|
|
877
900
|
expiredAt?: Date | undefined;
|
|
901
|
+
metadata?: Record<string, any> | undefined;
|
|
878
902
|
} : never)[K]; } : never>;
|
|
879
903
|
export {};
|
package/dist/esm/v3/runs.js
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { accessoryAttributes, apiClientManager, flattenAttributes, isRequestOptions, mergeRequestOptions, } from "@trigger.dev/core/v3";
|
|
2
|
-
import { apiClientMissingError } from "./shared.js";
|
|
3
2
|
import { tracer } from "./tracer.js";
|
|
4
3
|
import { resolvePresignedPacketUrl } from "@trigger.dev/core/v3/utils/ioSerialization";
|
|
5
4
|
export const runs = {
|
|
@@ -11,10 +10,7 @@ export const runs = {
|
|
|
11
10
|
poll,
|
|
12
11
|
};
|
|
13
12
|
function listRuns(paramsOrProjectRef, paramsOrOptions, requestOptions) {
|
|
14
|
-
const apiClient = apiClientManager.
|
|
15
|
-
if (!apiClient) {
|
|
16
|
-
throw apiClientMissingError();
|
|
17
|
-
}
|
|
13
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
18
14
|
const $requestOptions = listRunsRequestOptions(paramsOrProjectRef, paramsOrOptions, requestOptions);
|
|
19
15
|
if (typeof paramsOrProjectRef === "string") {
|
|
20
16
|
if (isRequestOptions(paramsOrOptions)) {
|
|
@@ -78,10 +74,7 @@ function listRunsRequestOptions(paramsOrProjectRef, paramsOrOptions, requestOpti
|
|
|
78
74
|
}, isRequestOptions(paramsOrOptions) ? paramsOrOptions : requestOptions);
|
|
79
75
|
}
|
|
80
76
|
function retrieveRun(runId, requestOptions) {
|
|
81
|
-
const apiClient = apiClientManager.
|
|
82
|
-
if (!apiClient) {
|
|
83
|
-
throw apiClientMissingError();
|
|
84
|
-
}
|
|
77
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
85
78
|
const $requestOptions = mergeRequestOptions({
|
|
86
79
|
tracer,
|
|
87
80
|
name: "runs.retrieve()",
|
|
@@ -123,10 +116,7 @@ async function resolvePayloadAndOutputUrls(run) {
|
|
|
123
116
|
return resolvedRun;
|
|
124
117
|
}
|
|
125
118
|
function replayRun(runId, requestOptions) {
|
|
126
|
-
const apiClient = apiClientManager.
|
|
127
|
-
if (!apiClient) {
|
|
128
|
-
throw apiClientMissingError();
|
|
129
|
-
}
|
|
119
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
130
120
|
const $requestOptions = mergeRequestOptions({
|
|
131
121
|
tracer,
|
|
132
122
|
name: "runs.replay()",
|
|
@@ -147,10 +137,7 @@ function replayRun(runId, requestOptions) {
|
|
|
147
137
|
return apiClient.replayRun(runId, $requestOptions);
|
|
148
138
|
}
|
|
149
139
|
function cancelRun(runId, requestOptions) {
|
|
150
|
-
const apiClient = apiClientManager.
|
|
151
|
-
if (!apiClient) {
|
|
152
|
-
throw apiClientMissingError();
|
|
153
|
-
}
|
|
140
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
154
141
|
const $requestOptions = mergeRequestOptions({
|
|
155
142
|
tracer,
|
|
156
143
|
name: "runs.cancel()",
|
|
@@ -171,10 +158,7 @@ function cancelRun(runId, requestOptions) {
|
|
|
171
158
|
return apiClient.cancelRun(runId, $requestOptions);
|
|
172
159
|
}
|
|
173
160
|
function rescheduleRun(runId, body, requestOptions) {
|
|
174
|
-
const apiClient = apiClientManager.
|
|
175
|
-
if (!apiClient) {
|
|
176
|
-
throw apiClientMissingError();
|
|
177
|
-
}
|
|
161
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
178
162
|
const $requestOptions = mergeRequestOptions({
|
|
179
163
|
tracer,
|
|
180
164
|
name: "runs.reschedule()",
|
package/dist/esm/v3/runs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runs.js","sourceRoot":"","sources":["../../../src/v3/runs.ts"],"names":[],"mappings":"AAOA,OAAO,EAOL,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"runs.js","sourceRoot":"","sources":["../../../src/v3/runs.ts"],"names":[],"mappings":"AAOA,OAAO,EAOL,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAC;AAYvF,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,MAAM,EAAE,SAAS;IACjB,MAAM,EAAE,SAAS;IACjB,QAAQ,EAAE,WAAW;IACrB,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,aAAa;IACzB,IAAI;CACL,CAAC;AAaF,SAAS,QAAQ,CACf,kBAAiD,EACjD,eAAsF,EACtF,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,sBAAsB,CAC5C,kBAAkB,EAClB,eAAe,EACf,cAAc,CACf,CAAC;IAEF,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE,CAAC;QAC3C,IAAI,gBAAgB,CAAC,eAAe,CAAC,EAAE,CAAC;YACtC,OAAO,SAAS,CAAC,eAAe,CAAC,kBAAkB,EAAE,EAAE,EAAE,eAAe,CAAC,CAAC;QAC5E,CAAC;aAAM,CAAC;YACN,OAAO,SAAS,CAAC,eAAe,CAAC,kBAAkB,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,eAAe,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,sBAAsB,CAC7B,kBAAiD,EACjD,eAAsF,EACtF,cAAkC;IAElC,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE,CAAC;QAC3C,IAAI,gBAAgB,CAAC,eAAe,CAAC,EAAE,CAAC;YACtC,OAAO,mBAAmB,CACxB;gBACE,MAAM;gBACN,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,MAAM;gBACZ,UAAU,EAAE;oBACV,UAAU,EAAE,kBAAkB;oBAC9B,GAAG,mBAAmB,CAAC;wBACrB,KAAK,EAAE;4BACL;gCACE,IAAI,EAAE,kBAAkB;gCACxB,OAAO,EAAE,QAAQ;6BAClB;yBACF;wBACD,KAAK,EAAE,UAAU;qBAClB,CAAC;iBACH;aACF,EACD,eAAe,CAChB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,mBAAmB,CACxB;gBACE,MAAM;gBACN,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,MAAM;gBACZ,UAAU,EAAE;oBACV,UAAU,EAAE,kBAAkB;oBAC9B,GAAG,iBAAiB,CAAC,eAA0C,EAAE,aAAa,CAAC;oBAC/E,GAAG,mBAAmB,CAAC;wBACrB,KAAK,EAAE;4BACL;gCACE,IAAI,EAAE,kBAAkB;gCACxB,OAAO,EAAE,QAAQ;6BAClB;yBACF;wBACD,KAAK,EAAE,UAAU;qBAClB,CAAC;iBACH;aACF,EACD,cAAc,CACf,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,mBAAmB,CACxB;QACE,MAAM;QACN,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,GAAG,iBAAiB,CAAC,kBAA6C,EAAE,aAAa,CAAC;SACnF;KACF,EACD,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,cAAc,CACrE,CAAC;AACJ,CAAC;AAWD,SAAS,WAAW,CAClB,KAAoB,EACpB,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,KAAK,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;YACnD,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;wBAClD,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;IAE5D,OAAO,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE;QAC1E,OAAO,2BAA2B,CAAC,YAAY,CAAC,CAAC;IACnD,CAAC,CAA0C,CAAC;AAC9C,CAAC;AAED,KAAK,UAAU,2BAA2B,CAAC,GAA2B;IACpE,MAAM,WAAW,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;IAE/B,IAAI,GAAG,CAAC,mBAAmB,IAAI,GAAG,CAAC,kBAAkB,EAAE,CAAC;QACtD,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC1C,yBAAyB,CAAC,GAAG,CAAC,mBAAmB,EAAE,MAAM,CAAC;YAC1D,yBAAyB,CAAC,GAAG,CAAC,kBAAkB,EAAE,MAAM,CAAC;SAC1D,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC;QAC9B,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;IAC9B,CAAC;SAAM,IAAI,GAAG,CAAC,mBAAmB,EAAE,CAAC;QACnC,WAAW,CAAC,OAAO,GAAG,MAAM,yBAAyB,CAAC,GAAG,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACzF,CAAC;SAAM,IAAI,GAAG,CAAC,kBAAkB,EAAE,CAAC;QAClC,WAAW,CAAC,MAAM,GAAG,MAAM,yBAAyB,CAAC,GAAG,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;IACvF,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,SAAS,CAChB,KAAa,EACb,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,KAAK;YACL,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,KAAK;wBACX,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,SAAS,CAChB,KAAa,EACb,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,KAAK;YACL,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,KAAK;wBACX,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,aAAa,CACpB,KAAa,EACb,IAA8B,EAC9B,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,KAAK;YACL,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,KAAK;wBACX,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC;AAC/D,CAAC;AAID,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAE9B,KAAK,UAAU,IAAI,CACjB,KAAoB,EACpB,OAAqC,EACrC,cAAkC;IAElC,IAAI,QAAQ,GAAG,CAAC,CAAC;IAEjB,OAAO,QAAQ,EAAE,GAAG,iBAAiB,EAAE,CAAC;QACtC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAEvD,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;YACpB,OAAO,GAAG,CAAC;QACb,CAAC;QAED,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC;IACvF,CAAC;IAED,MAAM,IAAI,KAAK,CACb,OACE,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAC5C,2BAA2B,iBAAiB,WAAW,CACxD,CAAC;AACJ,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { TimezonesResult, accessoryAttributes, apiClientManager, mergeRequestOptions, taskCatalog, } from "@trigger.dev/core/v3";
|
|
2
2
|
import { zodfetch } from "@trigger.dev/core/v3/zodfetch";
|
|
3
|
-
import {
|
|
3
|
+
import { createTask } from "../shared.js";
|
|
4
4
|
import { tracer } from "../tracer.js";
|
|
5
5
|
export function task(params) {
|
|
6
6
|
const task = createTask(params);
|
|
@@ -32,10 +32,7 @@ export function task(params) {
|
|
|
32
32
|
* @returns The created schedule
|
|
33
33
|
*/
|
|
34
34
|
export function create(options, requestOptions) {
|
|
35
|
-
const apiClient = apiClientManager.
|
|
36
|
-
if (!apiClient) {
|
|
37
|
-
throw apiClientMissingError();
|
|
38
|
-
}
|
|
35
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
39
36
|
const $requestOptions = mergeRequestOptions({
|
|
40
37
|
tracer,
|
|
41
38
|
name: "schedules.create()",
|
|
@@ -60,10 +57,7 @@ export function create(options, requestOptions) {
|
|
|
60
57
|
* @returns The retrieved schedule
|
|
61
58
|
*/
|
|
62
59
|
export function retrieve(scheduleId, requestOptions) {
|
|
63
|
-
const apiClient = apiClientManager.
|
|
64
|
-
if (!apiClient) {
|
|
65
|
-
throw apiClientMissingError();
|
|
66
|
-
}
|
|
60
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
67
61
|
const $requestOptions = mergeRequestOptions({
|
|
68
62
|
tracer,
|
|
69
63
|
name: "schedules.retrieve()",
|
|
@@ -94,10 +88,7 @@ export function retrieve(scheduleId, requestOptions) {
|
|
|
94
88
|
* @returns The updated schedule
|
|
95
89
|
*/
|
|
96
90
|
export function update(scheduleId, options, requestOptions) {
|
|
97
|
-
const apiClient = apiClientManager.
|
|
98
|
-
if (!apiClient) {
|
|
99
|
-
throw apiClientMissingError();
|
|
100
|
-
}
|
|
91
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
101
92
|
const $requestOptions = mergeRequestOptions({
|
|
102
93
|
tracer,
|
|
103
94
|
name: "schedules.update()",
|
|
@@ -122,10 +113,7 @@ export function update(scheduleId, options, requestOptions) {
|
|
|
122
113
|
* @param scheduleId - The ID of the schedule to delete
|
|
123
114
|
*/
|
|
124
115
|
export function del(scheduleId, requestOptions) {
|
|
125
|
-
const apiClient = apiClientManager.
|
|
126
|
-
if (!apiClient) {
|
|
127
|
-
throw apiClientMissingError();
|
|
128
|
-
}
|
|
116
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
129
117
|
const $requestOptions = mergeRequestOptions({
|
|
130
118
|
tracer,
|
|
131
119
|
name: "schedules.delete()",
|
|
@@ -150,10 +138,7 @@ export function del(scheduleId, requestOptions) {
|
|
|
150
138
|
* @param scheduleId - The ID of the schedule to deactivate
|
|
151
139
|
*/
|
|
152
140
|
export function deactivate(scheduleId, requestOptions) {
|
|
153
|
-
const apiClient = apiClientManager.
|
|
154
|
-
if (!apiClient) {
|
|
155
|
-
throw apiClientMissingError();
|
|
156
|
-
}
|
|
141
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
157
142
|
const $requestOptions = mergeRequestOptions({
|
|
158
143
|
tracer,
|
|
159
144
|
name: "schedules.deactivate()",
|
|
@@ -178,10 +163,7 @@ export function deactivate(scheduleId, requestOptions) {
|
|
|
178
163
|
* @param scheduleId - The ID of the schedule to activate
|
|
179
164
|
*/
|
|
180
165
|
export function activate(scheduleId, requestOptions) {
|
|
181
|
-
const apiClient = apiClientManager.
|
|
182
|
-
if (!apiClient) {
|
|
183
|
-
throw apiClientMissingError();
|
|
184
|
-
}
|
|
166
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
185
167
|
const $requestOptions = mergeRequestOptions({
|
|
186
168
|
tracer,
|
|
187
169
|
name: "schedules.activate()",
|
|
@@ -209,10 +191,7 @@ export function activate(scheduleId, requestOptions) {
|
|
|
209
191
|
* @returns The list of schedules
|
|
210
192
|
*/
|
|
211
193
|
export function list(options, requestOptions) {
|
|
212
|
-
const apiClient = apiClientManager.
|
|
213
|
-
if (!apiClient) {
|
|
214
|
-
throw apiClientMissingError();
|
|
215
|
-
}
|
|
194
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
216
195
|
const $requestOptions = mergeRequestOptions({
|
|
217
196
|
tracer,
|
|
218
197
|
name: "schedules.list()",
|
|
@@ -226,9 +205,6 @@ export function list(options, requestOptions) {
|
|
|
226
205
|
*/
|
|
227
206
|
export function timezones(options) {
|
|
228
207
|
const baseUrl = apiClientManager.baseURL;
|
|
229
|
-
if (!baseUrl) {
|
|
230
|
-
throw apiClientMissingError();
|
|
231
|
-
}
|
|
232
208
|
return zodfetch(TimezonesResult, `${baseUrl}/api/v1/timezones${options?.excludeUtc === true ? "?excludeUtc=true" : ""}`, {
|
|
233
209
|
method: "GET",
|
|
234
210
|
headers: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/v3/schedules/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,GACZ,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAqB,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/v3/schedules/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,GACZ,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAqB,UAAU,EAAE,MAAM,cAAc,CAAC;AAE7D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAgCtC,MAAM,UAAU,IAAI,CAClB,MAA0D;IAE1D,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IAEhC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI;QACtB,CAAC,CAAC,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ;YAC/B,CAAC,CAAC,MAAM,CAAC,IAAI;YACb,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO;QACvB,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,QAAQ,GACZ,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;IAE3F,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAAE;QACtC,aAAa,EAAE,UAAU;QACzB,QAAQ,EAAE,IAAI;YACZ,CAAC,CAAC;gBACE,IAAI,EAAE,IAAI;gBACV,QAAQ;aACT;YACH,CAAC,CAAC,SAAS;KACd,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,MAAM,CACpB,OAA2C,EAC3C,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,OAAO,CAAC,IAAI;wBAClB,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;AAC5D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CACtB,UAAkB,EAClB,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,UAAU;wBAChB,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,gBAAgB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AACjE,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,MAAM,CACpB,UAAkB,EAClB,OAA2C,EAC3C,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,UAAU;wBAChB,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,cAAc,CAAC,UAAU,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC;AACxE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,GAAG,CACjB,UAAkB,EAClB,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,UAAU;wBAChB,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,cAAc,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AAC/D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CACxB,UAAkB,EAClB,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,wBAAwB;QAC9B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,UAAU;wBAChB,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,kBAAkB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AACnE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ,CACtB,UAAkB,EAClB,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,UAAU;YACV,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,UAAU;wBAChB,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,gBAAgB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AACjE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,IAAI,CAClB,OAA0C,EAC1C,cAAkC;IAElC,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,OAAO;KACd,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;AAC3D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,OAAkC;IAC1D,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,CAAC;IAEzC,OAAO,QAAQ,CACb,eAAe,EACf,GAAG,OAAO,oBAAoB,OAAO,EAAE,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,EAAE,EACtF;QACE,MAAM,EAAE,KAAK;QACb,OAAO,EAAE;YACP,cAAc,EAAE,kBAAkB;SACnC;KACF,CACF,CAAC;AACJ,CAAC"}
|
package/dist/esm/v3/shared.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { ApiRequestOptions, FailureFnParams, HandleErrorFnParams, HandleErrorResult, InitFnParams, InitOutput, MachineCpu, MachineMemory, MiddlewareFnParams, QueueOptions, RetryOptions, RunFnParams, RunTags, StartFnParams, SuccessFnParams, TaskRunContext } from "@trigger.dev/core/v3";
|
|
2
2
|
import { IdempotencyKey } from "./idempotencyKeys.js";
|
|
3
3
|
import { PollOptions, RetrieveRunResult } from "./runs.js";
|
|
4
|
+
import { SerializableJson } from "@trigger.dev/core";
|
|
4
5
|
export type Context = TaskRunContext;
|
|
5
6
|
type RequireOne<T, K extends keyof T> = {
|
|
6
7
|
[X in Exclude<keyof T, K>]?: T[X];
|
|
@@ -352,6 +353,10 @@ export type TaskRunOptions = {
|
|
|
352
353
|
* ```
|
|
353
354
|
*/
|
|
354
355
|
tags?: RunTags;
|
|
356
|
+
/**
|
|
357
|
+
* Metadata to attach to the run. Metadata can be used to store additional information about the run. Limited to 4KB.
|
|
358
|
+
*/
|
|
359
|
+
metadata?: Record<string, SerializableJson>;
|
|
355
360
|
};
|
|
356
361
|
type TaskRunConcurrencyOptions = Queue;
|
|
357
362
|
export type Prettify<T> = {
|
|
@@ -439,5 +444,4 @@ export declare function batchTriggerAndWait<TTask extends AnyTask>(id: TaskIdent
|
|
|
439
444
|
*/
|
|
440
445
|
export declare function triggerAndPoll<TTask extends AnyTask>(id: TaskIdentifier<TTask>, payload: TaskPayload<TTask>, options?: TaskRunOptions & PollOptions, requestOptions?: ApiRequestOptions): Promise<RetrieveRunResult<RunHandle<TaskOutput<TTask>>>>;
|
|
441
446
|
export declare function batchTrigger<TTask extends AnyTask>(id: TaskIdentifier<TTask>, items: Array<BatchItem<TaskPayload<TTask>>>, requestOptions?: ApiRequestOptions): Promise<BatchRunHandle<TaskOutput<TTask>>>;
|
|
442
|
-
export declare function apiClientMissingError(): "Unknown error" | "You need to set the TRIGGER_API_URL and TRIGGER_SECRET_KEY environment variables." | "You need to set the TRIGGER_API_URL environment variable." | "You need to set the TRIGGER_SECRET_KEY environment variable.";
|
|
443
447
|
export {};
|
package/dist/esm/v3/shared.js
CHANGED
|
@@ -207,10 +207,7 @@ export async function batchTrigger(id, items, requestOptions) {
|
|
|
207
207
|
return await batchTrigger_internal("tasks.batchTrigger()", id, items, requestOptions);
|
|
208
208
|
}
|
|
209
209
|
async function trigger_internal(name, id, payload, options, requestOptions) {
|
|
210
|
-
const apiClient = apiClientManager.
|
|
211
|
-
if (!apiClient) {
|
|
212
|
-
throw apiClientMissingError();
|
|
213
|
-
}
|
|
210
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
214
211
|
const payloadPacket = await stringifyIO(payload);
|
|
215
212
|
const handle = await apiClient.triggerTask(id, {
|
|
216
213
|
payload: payloadPacket.data,
|
|
@@ -225,6 +222,7 @@ async function trigger_internal(name, id, payload, options, requestOptions) {
|
|
|
225
222
|
tags: options?.tags,
|
|
226
223
|
maxAttempts: options?.maxAttempts,
|
|
227
224
|
parentAttempt: taskContext.ctx?.attempt.id,
|
|
225
|
+
metadata: options?.metadata,
|
|
228
226
|
},
|
|
229
227
|
}, {
|
|
230
228
|
spanParentAsLink: true,
|
|
@@ -259,10 +257,7 @@ async function trigger_internal(name, id, payload, options, requestOptions) {
|
|
|
259
257
|
return handle;
|
|
260
258
|
}
|
|
261
259
|
async function batchTrigger_internal(name, id, items, requestOptions, queue) {
|
|
262
|
-
const apiClient = apiClientManager.
|
|
263
|
-
if (!apiClient) {
|
|
264
|
-
throw apiClientMissingError();
|
|
265
|
-
}
|
|
260
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
266
261
|
const response = await apiClient.batchTriggerTask(id, {
|
|
267
262
|
items: await Promise.all(items.map(async (item) => {
|
|
268
263
|
const payloadPacket = await stringifyIO(item.payload);
|
|
@@ -279,6 +274,7 @@ async function batchTrigger_internal(name, id, items, requestOptions, queue) {
|
|
|
279
274
|
tags: item.options?.tags,
|
|
280
275
|
maxAttempts: item.options?.maxAttempts,
|
|
281
276
|
parentAttempt: taskContext.ctx?.attempt.id,
|
|
277
|
+
metadata: item.options?.metadata,
|
|
282
278
|
},
|
|
283
279
|
};
|
|
284
280
|
})),
|
|
@@ -313,10 +309,7 @@ async function triggerAndWait_internal(name, id, payload, options, requestOption
|
|
|
313
309
|
if (!ctx) {
|
|
314
310
|
throw new Error("triggerAndWait can only be used from inside a task.run()");
|
|
315
311
|
}
|
|
316
|
-
const apiClient = apiClientManager.
|
|
317
|
-
if (!apiClient) {
|
|
318
|
-
throw apiClientMissingError();
|
|
319
|
-
}
|
|
312
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
320
313
|
const payloadPacket = await stringifyIO(payload);
|
|
321
314
|
return await tracer.startActiveSpan(name, async (span) => {
|
|
322
315
|
const response = await apiClient.triggerTask(id, {
|
|
@@ -333,6 +326,7 @@ async function triggerAndWait_internal(name, id, payload, options, requestOption
|
|
|
333
326
|
ttl: options?.ttl,
|
|
334
327
|
tags: options?.tags,
|
|
335
328
|
maxAttempts: options?.maxAttempts,
|
|
329
|
+
metadata: options?.metadata,
|
|
336
330
|
},
|
|
337
331
|
}, {}, requestOptions);
|
|
338
332
|
span.setAttribute("messaging.message.id", response.id);
|
|
@@ -377,10 +371,7 @@ async function batchTriggerAndWait_internal(name, id, items, requestOptions, que
|
|
|
377
371
|
if (!ctx) {
|
|
378
372
|
throw new Error("batchTriggerAndWait can only be used from inside a task.run()");
|
|
379
373
|
}
|
|
380
|
-
const apiClient = apiClientManager.
|
|
381
|
-
if (!apiClient) {
|
|
382
|
-
throw apiClientMissingError();
|
|
383
|
-
}
|
|
374
|
+
const apiClient = apiClientManager.clientOrThrow();
|
|
384
375
|
return await tracer.startActiveSpan(name, async (span) => {
|
|
385
376
|
const response = await apiClient.batchTriggerTask(id, {
|
|
386
377
|
items: await Promise.all(items.map(async (item) => {
|
|
@@ -398,6 +389,7 @@ async function batchTriggerAndWait_internal(name, id, items, requestOptions, que
|
|
|
398
389
|
ttl: item.options?.ttl,
|
|
399
390
|
tags: item.options?.tags,
|
|
400
391
|
maxAttempts: item.options?.maxAttempts,
|
|
392
|
+
metadata: item.options?.metadata,
|
|
401
393
|
},
|
|
402
394
|
};
|
|
403
395
|
})),
|
|
@@ -510,20 +502,6 @@ async function handleTaskRunExecutionResult(execution) {
|
|
|
510
502
|
};
|
|
511
503
|
}
|
|
512
504
|
}
|
|
513
|
-
export function apiClientMissingError() {
|
|
514
|
-
const hasBaseUrl = !!apiClientManager.baseURL;
|
|
515
|
-
const hasAccessToken = !!apiClientManager.accessToken;
|
|
516
|
-
if (!hasBaseUrl && !hasAccessToken) {
|
|
517
|
-
return `You need to set the TRIGGER_API_URL and TRIGGER_SECRET_KEY environment variables.`;
|
|
518
|
-
}
|
|
519
|
-
else if (!hasBaseUrl) {
|
|
520
|
-
return `You need to set the TRIGGER_API_URL environment variable.`;
|
|
521
|
-
}
|
|
522
|
-
else if (!hasAccessToken) {
|
|
523
|
-
return `You need to set the TRIGGER_SECRET_KEY environment variable.`;
|
|
524
|
-
}
|
|
525
|
-
return `Unknown error`;
|
|
526
|
-
}
|
|
527
505
|
async function makeKey(idempotencyKey) {
|
|
528
506
|
if (!idempotencyKey) {
|
|
529
507
|
return;
|