@trigger.dev/sdk 4.3.0 → 4.3.1
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/batch.d.ts +3 -3
- package/dist/commonjs/v3/batch.js.map +1 -1
- package/dist/commonjs/v3/idempotencyKeys.d.ts +2 -1
- package/dist/commonjs/v3/idempotencyKeys.js +1 -0
- package/dist/commonjs/v3/idempotencyKeys.js.map +1 -1
- package/dist/commonjs/v3/shared.d.ts +71 -0
- package/dist/commonjs/v3/shared.js +880 -542
- package/dist/commonjs/v3/shared.js.map +1 -1
- package/dist/commonjs/v3/shared.test.d.ts +1 -0
- package/dist/commonjs/v3/shared.test.js +190 -0
- package/dist/commonjs/v3/shared.test.js.map +1 -0
- package/dist/commonjs/version.js +1 -1
- package/dist/esm/v3/batch.d.ts +3 -3
- package/dist/esm/v3/batch.js +1 -1
- package/dist/esm/v3/batch.js.map +1 -1
- package/dist/esm/v3/idempotencyKeys.d.ts +2 -1
- package/dist/esm/v3/idempotencyKeys.js +2 -1
- package/dist/esm/v3/idempotencyKeys.js.map +1 -1
- package/dist/esm/v3/shared.d.ts +71 -0
- package/dist/esm/v3/shared.js +879 -541
- package/dist/esm/v3/shared.js.map +1 -1
- package/dist/esm/v3/shared.test.d.ts +1 -0
- package/dist/esm/v3/shared.test.js +188 -0
- package/dist/esm/v3/shared.test.js.map +1 -0
- package/dist/esm/version.js +1 -1
- package/package.json +3 -2
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { ApiPromise, ApiRequestOptions,
|
|
2
|
-
import { batchTriggerById, batchTriggerByIdAndWait, batchTriggerTasks
|
|
1
|
+
import { ApiPromise, ApiRequestOptions, RetrieveBatchV2Response } from "@trigger.dev/core/v3";
|
|
2
|
+
import { batchTriggerAndWaitTasks, batchTriggerById, batchTriggerByIdAndWait, batchTriggerTasks } from "./shared.js";
|
|
3
3
|
export declare const batch: {
|
|
4
4
|
trigger: typeof batchTriggerById;
|
|
5
5
|
triggerAndWait: typeof batchTriggerByIdAndWait;
|
|
@@ -24,5 +24,5 @@ export declare const batch: {
|
|
|
24
24
|
* const batchDetails = await batch.retrieve(response.batchId);
|
|
25
25
|
* console.log("batch", batchDetails);
|
|
26
26
|
*/
|
|
27
|
-
declare function retrieveBatch(batchId: string, requestOptions?: ApiRequestOptions): ApiPromise<
|
|
27
|
+
declare function retrieveBatch(batchId: string, requestOptions?: ApiRequestOptions): ApiPromise<RetrieveBatchV2Response>;
|
|
28
28
|
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"batch.js","sourceRoot":"","sources":["../../../src/v3/batch.ts"],"names":[],"mappings":";;;AAAA,
|
|
1
|
+
{"version":3,"file":"batch.js","sourceRoot":"","sources":["../../../src/v3/batch.ts"],"names":[],"mappings":";;;AAAA,6CAQ8B;AAC9B,2CAKqB;AACrB,2CAAqC;AAExB,QAAA,KAAK,GAAG;IACnB,OAAO,EAAE,4BAAgB;IACzB,cAAc,EAAE,mCAAuB;IACvC,aAAa,EAAE,6BAAiB;IAChC,oBAAoB,EAAE,oCAAwB;IAC9C,QAAQ,EAAE,aAAa;CACxB,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,SAAS,aAAa,CACpB,OAAe,EACf,cAAkC;IAElC,MAAM,SAAS,GAAG,qBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,OAAO,EAAE,OAAO;YAChB,GAAG,IAAA,wBAAmB,EAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,OAAO;wBACb,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;SACH;KACF,EACD,cAAc,CACf,CAAC;IAEF,OAAO,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;AAC3D,CAAC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { createIdempotencyKey, type IdempotencyKey } from "@trigger.dev/core/v3";
|
|
1
|
+
import { createIdempotencyKey, resetIdempotencyKey, type IdempotencyKey } from "@trigger.dev/core/v3";
|
|
2
2
|
export declare const idempotencyKeys: {
|
|
3
3
|
create: typeof createIdempotencyKey;
|
|
4
|
+
reset: typeof resetIdempotencyKey;
|
|
4
5
|
};
|
|
5
6
|
export type { IdempotencyKey };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"idempotencyKeys.js","sourceRoot":"","sources":["../../../src/v3/idempotencyKeys.ts"],"names":[],"mappings":";;;AAAA,
|
|
1
|
+
{"version":3,"file":"idempotencyKeys.js","sourceRoot":"","sources":["../../../src/v3/idempotencyKeys.ts"],"names":[],"mappings":";;;AAAA,6CAAsG;AAEzF,QAAA,eAAe,GAAG;IAC7B,MAAM,EAAE,yBAAoB;IAC5B,KAAK,EAAE,wBAAmB;CAC3B,CAAC"}
|
|
@@ -4,6 +4,7 @@ import type { AnyRunHandle, AnyTask, BatchByIdAndWaitItem, BatchByIdItem, BatchB
|
|
|
4
4
|
export type { AnyRunHandle, AnyTask, BatchItem, BatchResult, BatchRunHandle, BatchTriggerOptions, Queue, RunHandle, RunHandleOutput, RunHandlePayload, SerializableJson, Task, TaskBatchOutputHandle, TaskFromIdentifier, TaskIdentifier, TaskOptions, TaskOutput, TaskOutputHandle, TaskPayload, TaskRunResult, TriggerOptions, TaskWithSchema, TaskWithSchemaOptions, TaskSchema, TaskOptionsWithSchema, };
|
|
5
5
|
export { SubtaskUnwrapError, TaskRunPromise };
|
|
6
6
|
export type Context = TaskRunContext;
|
|
7
|
+
export { BatchTriggerError };
|
|
7
8
|
export declare function queue(options: QueueOptions): Queue;
|
|
8
9
|
export declare function createTask<TIdentifier extends string, TOutput = unknown, TInitOutput extends InitOutput = any>(params: TaskOptionsWithSchema<TIdentifier, TOutput, TInitOutput>): Task<TIdentifier, any, TOutput>;
|
|
9
10
|
export declare function createTask<TIdentifier extends string, TInput = void, TOutput = unknown, TInitOutput extends InitOutput = any>(params: TaskOptions<TIdentifier, TInput, TOutput, TInitOutput>): Task<TIdentifier, TInput, TOutput>;
|
|
@@ -109,6 +110,15 @@ export declare function batchTrigger<TTask extends AnyTask>(id: TaskIdentifier<T
|
|
|
109
110
|
* payload: { other: "data" }
|
|
110
111
|
* }
|
|
111
112
|
* ]);
|
|
113
|
+
*
|
|
114
|
+
* // Or stream items from an async iterable
|
|
115
|
+
* async function* generateItems() {
|
|
116
|
+
* for (let i = 0; i < 1000; i++) {
|
|
117
|
+
* yield { id: "my-task", payload: { index: i } };
|
|
118
|
+
* }
|
|
119
|
+
* }
|
|
120
|
+
*
|
|
121
|
+
* const streamResult = await batch.trigger<typeof myTask>(generateItems());
|
|
112
122
|
* ```
|
|
113
123
|
*
|
|
114
124
|
* @description
|
|
@@ -128,6 +138,7 @@ export declare function batchTrigger<TTask extends AnyTask>(id: TaskIdentifier<T
|
|
|
128
138
|
* - `maxDuration`: Maximum execution duration
|
|
129
139
|
*/
|
|
130
140
|
export declare function batchTriggerById<TTask extends AnyTask>(items: Array<BatchByIdItem<InferRunTypes<TTask>>>, options?: BatchTriggerOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchRunHandleFromTypes<InferRunTypes<TTask>>>;
|
|
141
|
+
export declare function batchTriggerById<TTask extends AnyTask>(items: AsyncIterable<BatchByIdItem<InferRunTypes<TTask>>> | ReadableStream<BatchByIdItem<InferRunTypes<TTask>>>, options?: BatchTriggerOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchRunHandleFromTypes<InferRunTypes<TTask>>>;
|
|
131
142
|
/**
|
|
132
143
|
* Triggers multiple tasks and waits for all of them to complete before returning their results.
|
|
133
144
|
* This function must be called from within a task.run() context.
|
|
@@ -204,8 +215,23 @@ export declare function batchTriggerById<TTask extends AnyTask>(items: Array<Bat
|
|
|
204
215
|
* - Payload types
|
|
205
216
|
* - Return value types
|
|
206
217
|
* - Error handling
|
|
218
|
+
*
|
|
219
|
+
* You can also pass an AsyncIterable or ReadableStream to stream items:
|
|
220
|
+
*
|
|
221
|
+
* @example
|
|
222
|
+
* ```ts
|
|
223
|
+
* // Stream items from an async iterable
|
|
224
|
+
* async function* generateItems() {
|
|
225
|
+
* for (let i = 0; i < 1000; i++) {
|
|
226
|
+
* yield { id: "child-task", payload: { index: i } };
|
|
227
|
+
* }
|
|
228
|
+
* }
|
|
229
|
+
*
|
|
230
|
+
* const results = await batch.triggerAndWait<typeof childTask>(generateItems());
|
|
231
|
+
* ```
|
|
207
232
|
*/
|
|
208
233
|
export declare function batchTriggerByIdAndWait<TTask extends AnyTask>(items: Array<BatchByIdAndWaitItem<InferRunTypes<TTask>>>, options?: BatchTriggerAndWaitOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchByIdResult<TTask>>;
|
|
234
|
+
export declare function batchTriggerByIdAndWait<TTask extends AnyTask>(items: AsyncIterable<BatchByIdAndWaitItem<InferRunTypes<TTask>>> | ReadableStream<BatchByIdAndWaitItem<InferRunTypes<TTask>>>, options?: BatchTriggerAndWaitOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchByIdResult<TTask>>;
|
|
209
235
|
/**
|
|
210
236
|
* Triggers multiple tasks and waits for all of them to complete before returning their results.
|
|
211
237
|
* This function must be called from within a task.run() context.
|
|
@@ -282,10 +308,25 @@ export declare function batchTriggerByIdAndWait<TTask extends AnyTask>(items: Ar
|
|
|
282
308
|
* - Payload types
|
|
283
309
|
* - Return value types
|
|
284
310
|
* - Error handling
|
|
311
|
+
*
|
|
312
|
+
* You can also pass an AsyncIterable or ReadableStream to stream items:
|
|
313
|
+
*
|
|
314
|
+
* @example
|
|
315
|
+
* ```ts
|
|
316
|
+
* // Stream items from an async iterable
|
|
317
|
+
* async function* generateItems() {
|
|
318
|
+
* for (let i = 0; i < 1000; i++) {
|
|
319
|
+
* yield { task: childTask, payload: { index: i } };
|
|
320
|
+
* }
|
|
321
|
+
* }
|
|
322
|
+
*
|
|
323
|
+
* const result = await batch.triggerByTask([childTask], generateItems());
|
|
324
|
+
* ```
|
|
285
325
|
*/
|
|
286
326
|
export declare function batchTriggerTasks<TTasks extends readonly AnyTask[]>(items: {
|
|
287
327
|
[K in keyof TTasks]: BatchByTaskItem<TTasks[K]>;
|
|
288
328
|
}, options?: BatchTriggerOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchTasksRunHandleFromTypes<TTasks>>;
|
|
329
|
+
export declare function batchTriggerTasks<TTasks extends readonly AnyTask[]>(items: AsyncIterable<BatchByTaskItem<TTasks[number]>> | ReadableStream<BatchByTaskItem<TTasks[number]>>, options?: BatchTriggerOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchTasksRunHandleFromTypes<TTasks>>;
|
|
289
330
|
/**
|
|
290
331
|
* Triggers multiple tasks and waits for all of them to complete before returning their results.
|
|
291
332
|
* This function must be called from within a task.run() context.
|
|
@@ -362,7 +403,37 @@ export declare function batchTriggerTasks<TTasks extends readonly AnyTask[]>(ite
|
|
|
362
403
|
* - Payload types
|
|
363
404
|
* - Return value types
|
|
364
405
|
* - Error handling
|
|
406
|
+
*
|
|
407
|
+
* You can also pass an AsyncIterable or ReadableStream to stream items:
|
|
408
|
+
*
|
|
409
|
+
* @example
|
|
410
|
+
* ```ts
|
|
411
|
+
* // Stream items from an async iterable
|
|
412
|
+
* async function* generateItems() {
|
|
413
|
+
* for (let i = 0; i < 1000; i++) {
|
|
414
|
+
* yield { task: childTask, payload: { index: i } };
|
|
415
|
+
* }
|
|
416
|
+
* }
|
|
417
|
+
*
|
|
418
|
+
* const results = await batch.triggerByTaskAndWait([childTask], generateItems());
|
|
419
|
+
* ```
|
|
365
420
|
*/
|
|
366
421
|
export declare function batchTriggerAndWaitTasks<TTasks extends readonly AnyTask[]>(items: {
|
|
367
422
|
[K in keyof TTasks]: BatchByTaskAndWaitItem<TTasks[K]>;
|
|
368
423
|
}, options?: BatchTriggerAndWaitOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchByTaskResult<TTasks>>;
|
|
424
|
+
export declare function batchTriggerAndWaitTasks<TTasks extends readonly AnyTask[]>(items: AsyncIterable<BatchByTaskAndWaitItem<TTasks[number]>> | ReadableStream<BatchByTaskAndWaitItem<TTasks[number]>>, options?: BatchTriggerAndWaitOptions, requestOptions?: TriggerApiRequestOptions): Promise<BatchByTaskResult<TTasks>>;
|
|
425
|
+
/**
|
|
426
|
+
* Error thrown when batch trigger operations fail.
|
|
427
|
+
* Includes context about which phase failed and the batch details.
|
|
428
|
+
*/
|
|
429
|
+
declare class BatchTriggerError extends Error {
|
|
430
|
+
readonly phase: "create" | "stream";
|
|
431
|
+
readonly batchId?: string;
|
|
432
|
+
readonly itemCount: number;
|
|
433
|
+
constructor(message: string, options: {
|
|
434
|
+
cause?: unknown;
|
|
435
|
+
phase: "create" | "stream";
|
|
436
|
+
batchId?: string;
|
|
437
|
+
itemCount: number;
|
|
438
|
+
});
|
|
439
|
+
}
|