@trigger.dev/sdk 0.0.0-prerelease-20241119135607 → 0.0.0-prerelease-20241128131418
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/v3/batch.d.ts +28 -0
- package/dist/commonjs/v3/batch.js +52 -0
- package/dist/commonjs/v3/batch.js.map +1 -0
- package/dist/commonjs/v3/index.d.ts +2 -1
- package/dist/commonjs/v3/index.js +1 -0
- package/dist/commonjs/v3/index.js.map +1 -1
- package/dist/commonjs/v3/runs.d.ts +148 -58
- package/dist/commonjs/v3/runs.js +93 -0
- package/dist/commonjs/v3/runs.js.map +1 -1
- package/dist/commonjs/v3/shared.d.ts +300 -8
- package/dist/commonjs/v3/shared.js +618 -100
- package/dist/commonjs/v3/shared.js.map +1 -1
- package/dist/commonjs/v3/tasks.d.ts +2 -2
- package/dist/commonjs/v3/tasks.js.map +1 -1
- 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/batch.d.ts +28 -0
- package/dist/esm/v3/batch.js +49 -0
- package/dist/esm/v3/batch.js.map +1 -0
- package/dist/esm/v3/index.d.ts +2 -1
- package/dist/esm/v3/index.js +1 -0
- package/dist/esm/v3/index.js.map +1 -1
- package/dist/esm/v3/runs.d.ts +155 -65
- package/dist/esm/v3/runs.js +93 -0
- package/dist/esm/v3/runs.js.map +1 -1
- package/dist/esm/v3/shared.d.ts +300 -8
- package/dist/esm/v3/shared.js +615 -101
- package/dist/esm/v3/shared.js.map +1 -1
- package/dist/esm/v3/tasks.d.ts +2 -2
- package/dist/esm/v3/tasks.js.map +1 -1
- package/dist/esm/version.js +1 -1
- package/package.json +4 -4
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v3/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,8CAA4B;AAC5B,uCAAsD;AAA7C,iGAAA,KAAK,OAAA;AACd,yCAAoC;AAA3B,kGAAA,KAAK,OAAA;AACd,6CAA2B;AAC3B,4CAA0B;AAC1B,iDAA+B;AAC/B,6CAA2B;AAC3B,uDAAqC;AACrC,4CAA0B;AAC1B,gDAA8B;AAC9B,+CAA6B;AAC7B,iDAA+B;AAS/B,2CAa8B;AAZ5B,8FAAA,QAAQ,OAAA;AACR,yGAAA,mBAAmB,OAAA;AACnB,qGAAA,eAAe,OAAA;AACf,mGAAA,aAAa,OAAA;AACb,yGAAA,mBAAmB,OAAA;AACnB,mGAAA,aAAa,OAAA;AACb,2GAAA,qBAAqB,OAAA;AACrB,oGAAA,cAAc,OAAA;AACd,8GAAA,wBAAwB,OAAA;AACxB,uGAAA,iBAAiB,OAAA;AACjB,4FAAA,MAAM,OAAA;AAIR,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v3/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,8CAA4B;AAC5B,uCAAsD;AAA7C,iGAAA,KAAK,OAAA;AACd,yCAAoC;AAA3B,kGAAA,KAAK,OAAA;AACd,6CAA2B;AAC3B,6CAA2B;AAC3B,4CAA0B;AAC1B,iDAA+B;AAC/B,6CAA2B;AAC3B,uDAAqC;AACrC,4CAA0B;AAC1B,gDAA8B;AAC9B,+CAA6B;AAC7B,iDAA+B;AAS/B,2CAa8B;AAZ5B,8FAAA,QAAQ,OAAA;AACR,yGAAA,mBAAmB,OAAA;AACnB,qGAAA,eAAe,OAAA;AACf,mGAAA,aAAa,OAAA;AACb,yGAAA,mBAAmB,OAAA;AACnB,mGAAA,aAAa,OAAA;AACb,2GAAA,qBAAqB,OAAA;AACrB,oGAAA,cAAc,OAAA;AACd,8GAAA,wBAAwB,OAAA;AACxB,uGAAA,iBAAiB,OAAA;AACjB,4FAAA,MAAM,OAAA;AAIR,qCASmB;AARjB,+FAAA,IAAI,OAAA;AASN,kEAAkD;AAClD,wDAAwC;AAGxC,qCAA4C;AAAnC,oGAAA,SAAS,OAAA;AAAE,+FAAA,IAAI,OAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import type { AnyRetrieveRunResult, AnyRunShape, ApiRequestOptions, InferRunTypes, ListProjectRunsQueryParams, ListRunsQueryParams, RescheduleRunRequestBody, RetrieveRunResult, RunShape, RealtimeRun, RunSubscription, TaskRunShape } from "@trigger.dev/core/v3";
|
|
1
|
+
import type { AnyRetrieveRunResult, AnyRunShape, ApiRequestOptions, InferRunTypes, ListProjectRunsQueryParams, ListRunsQueryParams, RescheduleRunRequestBody, RetrieveRunResult, RunShape, RealtimeRun, AnyRealtimeRun, RunSubscription, TaskRunShape, AnyBatchedRunHandle } from "@trigger.dev/core/v3";
|
|
2
2
|
import { ApiPromise, CanceledRunResponse, CursorPagePromise, ListRunResponseItem, ReplayRunResponse, RetrieveRunResponse } from "@trigger.dev/core/v3";
|
|
3
3
|
import { AnyRunHandle, AnyTask } from "./shared.js";
|
|
4
|
-
export type { AnyRetrieveRunResult, AnyRunShape, RetrieveRunResult, RunShape, TaskRunShape, RealtimeRun, };
|
|
4
|
+
export type { AnyRetrieveRunResult, AnyRunShape, RetrieveRunResult, RunShape, TaskRunShape, RealtimeRun, AnyRealtimeRun, };
|
|
5
5
|
export declare const runs: {
|
|
6
6
|
replay: typeof replayRun;
|
|
7
7
|
cancel: typeof cancelRun;
|
|
@@ -11,12 +11,13 @@ export declare const runs: {
|
|
|
11
11
|
poll: typeof poll;
|
|
12
12
|
subscribeToRun: typeof subscribeToRun;
|
|
13
13
|
subscribeToRunsWithTag: typeof subscribeToRunsWithTag;
|
|
14
|
+
subscribeToBatch: typeof subscribeToRunsInBatch;
|
|
14
15
|
};
|
|
15
16
|
export type ListRunsItem = ListRunResponseItem;
|
|
16
17
|
declare function listRuns(projectRef: string, params?: ListProjectRunsQueryParams, requestOptions?: ApiRequestOptions): CursorPagePromise<typeof ListRunResponseItem>;
|
|
17
18
|
declare function listRuns(params?: ListRunsQueryParams, requestOptions?: ApiRequestOptions): CursorPagePromise<typeof ListRunResponseItem>;
|
|
18
|
-
type RunId<TRunId> = TRunId extends AnyRunHandle ? TRunId : TRunId extends AnyTask ? string : TRunId extends string ? TRunId : never;
|
|
19
|
-
declare function retrieveRun<TRunId extends AnyRunHandle | AnyTask | string>(runId: RunId<TRunId>, requestOptions?: ApiRequestOptions): ApiPromise<RetrieveRunResult<TRunId>>;
|
|
19
|
+
type RunId<TRunId> = TRunId extends AnyRunHandle | AnyBatchedRunHandle ? TRunId : TRunId extends AnyTask ? string : TRunId extends string ? TRunId : never;
|
|
20
|
+
declare function retrieveRun<TRunId extends AnyRunHandle | AnyBatchedRunHandle | AnyTask | string>(runId: RunId<TRunId>, requestOptions?: ApiRequestOptions): ApiPromise<RetrieveRunResult<TRunId>>;
|
|
20
21
|
declare function replayRun(runId: string, requestOptions?: ApiRequestOptions): ApiPromise<ReplayRunResponse>;
|
|
21
22
|
declare function cancelRun(runId: string, requestOptions?: ApiRequestOptions): ApiPromise<CanceledRunResponse>;
|
|
22
23
|
declare function rescheduleRun(runId: string, body: RescheduleRunRequestBody, requestOptions?: ApiRequestOptions): ApiPromise<RetrieveRunResponse>;
|
|
@@ -26,34 +27,27 @@ export type PollOptions = {
|
|
|
26
27
|
declare function poll<TRunId extends AnyRunHandle | AnyTask | string>(runId: RunId<TRunId>, options?: {
|
|
27
28
|
pollIntervalMs?: number;
|
|
28
29
|
}, requestOptions?: ApiRequestOptions): Promise<{
|
|
30
|
+
status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
31
|
+
id: string;
|
|
29
32
|
tags: string[];
|
|
30
|
-
version?: string | undefined;
|
|
31
|
-
error?: {
|
|
32
|
-
message: string;
|
|
33
|
-
name?: string | undefined;
|
|
34
|
-
stackTrace?: string | undefined;
|
|
35
|
-
} | undefined;
|
|
36
|
-
status: "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "COMPLETED" | "CANCELED" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED" | "TIMED_OUT";
|
|
37
|
-
taskIdentifier: string;
|
|
38
|
-
schedule?: {
|
|
39
|
-
id: string;
|
|
40
|
-
generator: {
|
|
41
|
-
description: string;
|
|
42
|
-
type: "CRON";
|
|
43
|
-
expression: string;
|
|
44
|
-
};
|
|
45
|
-
externalId?: string | undefined;
|
|
46
|
-
deduplicationKey?: string | undefined;
|
|
47
|
-
} | undefined;
|
|
48
33
|
isTest: boolean;
|
|
49
|
-
id: string;
|
|
50
34
|
createdAt: Date;
|
|
51
35
|
durationMs: number;
|
|
52
36
|
costInCents: number;
|
|
53
37
|
baseCostInCents: number;
|
|
38
|
+
taskIdentifier: string;
|
|
39
|
+
depth: number;
|
|
40
|
+
triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
|
|
41
|
+
isQueued: boolean;
|
|
42
|
+
isExecuting: boolean;
|
|
43
|
+
isCompleted: boolean;
|
|
44
|
+
isSuccess: boolean;
|
|
45
|
+
isFailed: boolean;
|
|
46
|
+
isCancelled: boolean;
|
|
47
|
+
updatedAt: Date;
|
|
54
48
|
relatedRuns: {
|
|
55
49
|
root?: {
|
|
56
|
-
status: "
|
|
50
|
+
status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
57
51
|
id: string;
|
|
58
52
|
tags: string[];
|
|
59
53
|
isTest: boolean;
|
|
@@ -63,7 +57,7 @@ declare function poll<TRunId extends AnyRunHandle | AnyTask | string>(runId: Run
|
|
|
63
57
|
baseCostInCents: number;
|
|
64
58
|
taskIdentifier: string;
|
|
65
59
|
depth: number;
|
|
66
|
-
triggerFunction: "
|
|
60
|
+
triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
|
|
67
61
|
isQueued: boolean;
|
|
68
62
|
isExecuting: boolean;
|
|
69
63
|
isCompleted: boolean;
|
|
@@ -71,18 +65,18 @@ declare function poll<TRunId extends AnyRunHandle | AnyTask | string>(runId: Run
|
|
|
71
65
|
isFailed: boolean;
|
|
72
66
|
isCancelled: boolean;
|
|
73
67
|
updatedAt: Date;
|
|
74
|
-
|
|
68
|
+
startedAt?: Date | undefined;
|
|
75
69
|
idempotencyKey?: string | undefined;
|
|
76
70
|
version?: string | undefined;
|
|
77
|
-
|
|
71
|
+
metadata?: Record<string, any> | undefined;
|
|
72
|
+
ttl?: string | undefined;
|
|
73
|
+
batchId?: string | undefined;
|
|
78
74
|
finishedAt?: Date | undefined;
|
|
79
75
|
delayedUntil?: Date | undefined;
|
|
80
|
-
ttl?: string | undefined;
|
|
81
76
|
expiredAt?: Date | undefined;
|
|
82
|
-
metadata?: Record<string, any> | undefined;
|
|
83
77
|
} | undefined;
|
|
84
78
|
parent?: {
|
|
85
|
-
status: "
|
|
79
|
+
status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
86
80
|
id: string;
|
|
87
81
|
tags: string[];
|
|
88
82
|
isTest: boolean;
|
|
@@ -92,7 +86,7 @@ declare function poll<TRunId extends AnyRunHandle | AnyTask | string>(runId: Run
|
|
|
92
86
|
baseCostInCents: number;
|
|
93
87
|
taskIdentifier: string;
|
|
94
88
|
depth: number;
|
|
95
|
-
triggerFunction: "
|
|
89
|
+
triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
|
|
96
90
|
isQueued: boolean;
|
|
97
91
|
isExecuting: boolean;
|
|
98
92
|
isCompleted: boolean;
|
|
@@ -100,18 +94,18 @@ declare function poll<TRunId extends AnyRunHandle | AnyTask | string>(runId: Run
|
|
|
100
94
|
isFailed: boolean;
|
|
101
95
|
isCancelled: boolean;
|
|
102
96
|
updatedAt: Date;
|
|
103
|
-
|
|
97
|
+
startedAt?: Date | undefined;
|
|
104
98
|
idempotencyKey?: string | undefined;
|
|
105
99
|
version?: string | undefined;
|
|
106
|
-
|
|
100
|
+
metadata?: Record<string, any> | undefined;
|
|
101
|
+
ttl?: string | undefined;
|
|
102
|
+
batchId?: string | undefined;
|
|
107
103
|
finishedAt?: Date | undefined;
|
|
108
104
|
delayedUntil?: Date | undefined;
|
|
109
|
-
ttl?: string | undefined;
|
|
110
105
|
expiredAt?: Date | undefined;
|
|
111
|
-
metadata?: Record<string, any> | undefined;
|
|
112
106
|
} | undefined;
|
|
113
107
|
children?: {
|
|
114
|
-
status: "
|
|
108
|
+
status: "CANCELED" | "COMPLETED" | "FAILED" | "TIMED_OUT" | "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED";
|
|
115
109
|
id: string;
|
|
116
110
|
tags: string[];
|
|
117
111
|
isTest: boolean;
|
|
@@ -121,7 +115,7 @@ declare function poll<TRunId extends AnyRunHandle | AnyTask | string>(runId: Run
|
|
|
121
115
|
baseCostInCents: number;
|
|
122
116
|
taskIdentifier: string;
|
|
123
117
|
depth: number;
|
|
124
|
-
triggerFunction: "
|
|
118
|
+
triggerFunction: "trigger" | "batchTrigger" | "triggerAndWait" | "batchTriggerAndWait";
|
|
125
119
|
isQueued: boolean;
|
|
126
120
|
isExecuting: boolean;
|
|
127
121
|
isCompleted: boolean;
|
|
@@ -129,52 +123,148 @@ declare function poll<TRunId extends AnyRunHandle | AnyTask | string>(runId: Run
|
|
|
129
123
|
isFailed: boolean;
|
|
130
124
|
isCancelled: boolean;
|
|
131
125
|
updatedAt: Date;
|
|
132
|
-
|
|
126
|
+
startedAt?: Date | undefined;
|
|
133
127
|
idempotencyKey?: string | undefined;
|
|
134
128
|
version?: string | undefined;
|
|
135
|
-
|
|
129
|
+
metadata?: Record<string, any> | undefined;
|
|
130
|
+
ttl?: string | undefined;
|
|
131
|
+
batchId?: string | undefined;
|
|
136
132
|
finishedAt?: Date | undefined;
|
|
137
133
|
delayedUntil?: Date | undefined;
|
|
138
|
-
ttl?: string | undefined;
|
|
139
134
|
expiredAt?: Date | undefined;
|
|
140
|
-
metadata?: Record<string, any> | undefined;
|
|
141
135
|
}[] | undefined;
|
|
142
136
|
};
|
|
143
|
-
depth: number;
|
|
144
|
-
triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
|
|
145
|
-
isQueued: boolean;
|
|
146
|
-
isExecuting: boolean;
|
|
147
|
-
isCompleted: boolean;
|
|
148
|
-
isSuccess: boolean;
|
|
149
|
-
isFailed: boolean;
|
|
150
|
-
isCancelled: boolean;
|
|
151
|
-
updatedAt: Date;
|
|
152
137
|
attempts: ({
|
|
153
|
-
status: "
|
|
138
|
+
status: "PENDING" | "CANCELED" | "COMPLETED" | "FAILED" | "EXECUTING" | "PAUSED";
|
|
154
139
|
id: string;
|
|
155
140
|
createdAt: Date;
|
|
156
141
|
updatedAt: Date;
|
|
157
142
|
startedAt?: Date | undefined;
|
|
158
|
-
completedAt?: Date | undefined;
|
|
159
143
|
error?: {
|
|
160
144
|
message: string;
|
|
161
145
|
name?: string | undefined;
|
|
162
146
|
stackTrace?: string | undefined;
|
|
163
147
|
} | undefined;
|
|
148
|
+
completedAt?: Date | undefined;
|
|
164
149
|
} | undefined)[];
|
|
165
150
|
attemptCount: number;
|
|
166
|
-
payloadPresignedUrl?: string | undefined;
|
|
167
|
-
outputPresignedUrl?: string | undefined;
|
|
168
|
-
batchId?: string | undefined;
|
|
169
|
-
idempotencyKey?: string | undefined;
|
|
170
151
|
startedAt?: Date | undefined;
|
|
152
|
+
idempotencyKey?: string | undefined;
|
|
153
|
+
version?: string | undefined;
|
|
154
|
+
metadata?: Record<string, any> | undefined;
|
|
155
|
+
ttl?: string | undefined;
|
|
156
|
+
schedule?: {
|
|
157
|
+
id: string;
|
|
158
|
+
generator: {
|
|
159
|
+
type: "CRON";
|
|
160
|
+
description: string;
|
|
161
|
+
expression: string;
|
|
162
|
+
};
|
|
163
|
+
externalId?: string | undefined;
|
|
164
|
+
deduplicationKey?: string | undefined;
|
|
165
|
+
} | undefined;
|
|
166
|
+
batchId?: string | undefined;
|
|
167
|
+
error?: {
|
|
168
|
+
message: string;
|
|
169
|
+
name?: string | undefined;
|
|
170
|
+
stackTrace?: string | undefined;
|
|
171
|
+
} | undefined;
|
|
171
172
|
finishedAt?: Date | undefined;
|
|
172
173
|
delayedUntil?: Date | undefined;
|
|
173
|
-
ttl?: string | undefined;
|
|
174
174
|
expiredAt?: Date | undefined;
|
|
175
|
-
|
|
175
|
+
payloadPresignedUrl?: string | undefined;
|
|
176
|
+
outputPresignedUrl?: string | undefined;
|
|
176
177
|
output?: InferRunTypes<TRunId>["output"] | undefined;
|
|
177
178
|
payload?: InferRunTypes<TRunId>["payload"] | undefined;
|
|
178
179
|
}>;
|
|
180
|
+
/**
|
|
181
|
+
* Subscribes to real-time updates for a specific run.
|
|
182
|
+
*
|
|
183
|
+
* This function allows you to receive real-time updates whenever a run changes, including:
|
|
184
|
+
* - Status changes in the run lifecycle
|
|
185
|
+
* - Tag additions or removals
|
|
186
|
+
* - Metadata updates
|
|
187
|
+
*
|
|
188
|
+
* @template TRunId - The type parameter extending AnyRunHandle, AnyTask, or string
|
|
189
|
+
* @param {RunId<TRunId>} runId - The ID of the run to subscribe to. Can be a string ID, RunHandle, or Task
|
|
190
|
+
* @returns {RunSubscription<InferRunTypes<TRunId>>} An async iterator that yields updated run objects
|
|
191
|
+
*
|
|
192
|
+
* @example
|
|
193
|
+
* ```ts
|
|
194
|
+
* // Subscribe using a run handle
|
|
195
|
+
* const handle = await tasks.trigger("my-task", { some: "data" });
|
|
196
|
+
* for await (const run of runs.subscribeToRun(handle.id)) {
|
|
197
|
+
* console.log("Run updated:", run);
|
|
198
|
+
* }
|
|
199
|
+
*
|
|
200
|
+
* // Subscribe with type safety
|
|
201
|
+
* for await (const run of runs.subscribeToRun<typeof myTask>(runId)) {
|
|
202
|
+
* console.log("Payload:", run.payload.some);
|
|
203
|
+
* if (run.output) {
|
|
204
|
+
* console.log("Output:", run.output);
|
|
205
|
+
* }
|
|
206
|
+
* }
|
|
207
|
+
* ```
|
|
208
|
+
*/
|
|
179
209
|
declare function subscribeToRun<TRunId extends AnyRunHandle | AnyTask | string>(runId: RunId<TRunId>): RunSubscription<InferRunTypes<TRunId>>;
|
|
210
|
+
/**
|
|
211
|
+
* Subscribes to real-time updates for all runs that have specific tags.
|
|
212
|
+
*
|
|
213
|
+
* This function allows you to monitor multiple runs simultaneously by filtering on tags.
|
|
214
|
+
* You'll receive updates whenever any run with the specified tag(s) changes.
|
|
215
|
+
*
|
|
216
|
+
* @template TTasks - The type parameter extending AnyTask for type-safe payload and output
|
|
217
|
+
* @param {string | string[]} tag - A single tag or array of tags to filter runs
|
|
218
|
+
* @returns {RunSubscription<InferRunTypes<TTasks>>} An async iterator that yields updated run objects
|
|
219
|
+
*
|
|
220
|
+
* @example
|
|
221
|
+
* ```ts
|
|
222
|
+
* // Subscribe to runs with a single tag
|
|
223
|
+
* for await (const run of runs.subscribeToRunsWithTag("user:1234")) {
|
|
224
|
+
* console.log("Run updated:", run);
|
|
225
|
+
* }
|
|
226
|
+
*
|
|
227
|
+
* // Subscribe with multiple tags and type safety
|
|
228
|
+
* for await (const run of runs.subscribeToRunsWithTag<typeof myTask | typeof otherTask>(["tag1", "tag2"])) {
|
|
229
|
+
* switch (run.taskIdentifier) {
|
|
230
|
+
* case "my-task":
|
|
231
|
+
* console.log("MyTask output:", run.output.foo);
|
|
232
|
+
* break;
|
|
233
|
+
* case "other-task":
|
|
234
|
+
* console.log("OtherTask output:", run.output.bar);
|
|
235
|
+
* break;
|
|
236
|
+
* }
|
|
237
|
+
* }
|
|
238
|
+
* ```
|
|
239
|
+
*/
|
|
180
240
|
declare function subscribeToRunsWithTag<TTasks extends AnyTask>(tag: string | string[]): RunSubscription<InferRunTypes<TTasks>>;
|
|
241
|
+
/**
|
|
242
|
+
* Subscribes to real-time updates for all runs within a specific batch.
|
|
243
|
+
*
|
|
244
|
+
* Use this function when you've triggered multiple runs using `batchTrigger` and want
|
|
245
|
+
* to monitor all runs in that batch. You'll receive updates whenever any run in the batch changes.
|
|
246
|
+
*
|
|
247
|
+
* @template TTasks - The type parameter extending AnyTask for type-safe payload and output
|
|
248
|
+
* @param {string} batchId - The ID of the batch to subscribe to
|
|
249
|
+
* @returns {RunSubscription<InferRunTypes<TTasks>>} An async iterator that yields updated run objects
|
|
250
|
+
*
|
|
251
|
+
* @example
|
|
252
|
+
* ```ts
|
|
253
|
+
* // Subscribe to all runs in a batch
|
|
254
|
+
* for await (const run of runs.subscribeToRunsInBatch("batch-123")) {
|
|
255
|
+
* console.log("Batch run updated:", run);
|
|
256
|
+
* }
|
|
257
|
+
*
|
|
258
|
+
* // Subscribe with type safety
|
|
259
|
+
* for await (const run of runs.subscribeToRunsInBatch<typeof myTask>("batch-123")) {
|
|
260
|
+
* console.log("Run payload:", run.payload);
|
|
261
|
+
* if (run.output) {
|
|
262
|
+
* console.log("Run output:", run.output);
|
|
263
|
+
* }
|
|
264
|
+
* }
|
|
265
|
+
* ```
|
|
266
|
+
*
|
|
267
|
+
* @note The run objects received will include standard fields like id, status, payload, output,
|
|
268
|
+
* createdAt, updatedAt, tags, and more. See the Run object documentation for full details.
|
|
269
|
+
*/
|
|
270
|
+
declare function subscribeToRunsInBatch<TTasks extends AnyTask>(batchId: string): RunSubscription<InferRunTypes<TTasks>>;
|
package/dist/commonjs/v3/runs.js
CHANGED
|
@@ -13,6 +13,7 @@ exports.runs = {
|
|
|
13
13
|
poll,
|
|
14
14
|
subscribeToRun,
|
|
15
15
|
subscribeToRunsWithTag,
|
|
16
|
+
subscribeToBatch: subscribeToRunsInBatch,
|
|
16
17
|
};
|
|
17
18
|
function listRuns(paramsOrProjectRef, paramsOrOptions, requestOptions) {
|
|
18
19
|
const apiClient = v3_1.apiClientManager.clientOrThrow();
|
|
@@ -195,13 +196,105 @@ async function poll(runId, options, requestOptions) {
|
|
|
195
196
|
}
|
|
196
197
|
throw new Error(`Run ${typeof runId === "string" ? runId : runId.id} did not complete after ${MAX_POLL_ATTEMPTS} attempts`);
|
|
197
198
|
}
|
|
199
|
+
/**
|
|
200
|
+
* Subscribes to real-time updates for a specific run.
|
|
201
|
+
*
|
|
202
|
+
* This function allows you to receive real-time updates whenever a run changes, including:
|
|
203
|
+
* - Status changes in the run lifecycle
|
|
204
|
+
* - Tag additions or removals
|
|
205
|
+
* - Metadata updates
|
|
206
|
+
*
|
|
207
|
+
* @template TRunId - The type parameter extending AnyRunHandle, AnyTask, or string
|
|
208
|
+
* @param {RunId<TRunId>} runId - The ID of the run to subscribe to. Can be a string ID, RunHandle, or Task
|
|
209
|
+
* @returns {RunSubscription<InferRunTypes<TRunId>>} An async iterator that yields updated run objects
|
|
210
|
+
*
|
|
211
|
+
* @example
|
|
212
|
+
* ```ts
|
|
213
|
+
* // Subscribe using a run handle
|
|
214
|
+
* const handle = await tasks.trigger("my-task", { some: "data" });
|
|
215
|
+
* for await (const run of runs.subscribeToRun(handle.id)) {
|
|
216
|
+
* console.log("Run updated:", run);
|
|
217
|
+
* }
|
|
218
|
+
*
|
|
219
|
+
* // Subscribe with type safety
|
|
220
|
+
* for await (const run of runs.subscribeToRun<typeof myTask>(runId)) {
|
|
221
|
+
* console.log("Payload:", run.payload.some);
|
|
222
|
+
* if (run.output) {
|
|
223
|
+
* console.log("Output:", run.output);
|
|
224
|
+
* }
|
|
225
|
+
* }
|
|
226
|
+
* ```
|
|
227
|
+
*/
|
|
198
228
|
function subscribeToRun(runId) {
|
|
199
229
|
const $runId = typeof runId === "string" ? runId : runId.id;
|
|
200
230
|
const apiClient = v3_1.apiClientManager.clientOrThrow();
|
|
201
231
|
return apiClient.subscribeToRun($runId);
|
|
202
232
|
}
|
|
233
|
+
/**
|
|
234
|
+
* Subscribes to real-time updates for all runs that have specific tags.
|
|
235
|
+
*
|
|
236
|
+
* This function allows you to monitor multiple runs simultaneously by filtering on tags.
|
|
237
|
+
* You'll receive updates whenever any run with the specified tag(s) changes.
|
|
238
|
+
*
|
|
239
|
+
* @template TTasks - The type parameter extending AnyTask for type-safe payload and output
|
|
240
|
+
* @param {string | string[]} tag - A single tag or array of tags to filter runs
|
|
241
|
+
* @returns {RunSubscription<InferRunTypes<TTasks>>} An async iterator that yields updated run objects
|
|
242
|
+
*
|
|
243
|
+
* @example
|
|
244
|
+
* ```ts
|
|
245
|
+
* // Subscribe to runs with a single tag
|
|
246
|
+
* for await (const run of runs.subscribeToRunsWithTag("user:1234")) {
|
|
247
|
+
* console.log("Run updated:", run);
|
|
248
|
+
* }
|
|
249
|
+
*
|
|
250
|
+
* // Subscribe with multiple tags and type safety
|
|
251
|
+
* for await (const run of runs.subscribeToRunsWithTag<typeof myTask | typeof otherTask>(["tag1", "tag2"])) {
|
|
252
|
+
* switch (run.taskIdentifier) {
|
|
253
|
+
* case "my-task":
|
|
254
|
+
* console.log("MyTask output:", run.output.foo);
|
|
255
|
+
* break;
|
|
256
|
+
* case "other-task":
|
|
257
|
+
* console.log("OtherTask output:", run.output.bar);
|
|
258
|
+
* break;
|
|
259
|
+
* }
|
|
260
|
+
* }
|
|
261
|
+
* ```
|
|
262
|
+
*/
|
|
203
263
|
function subscribeToRunsWithTag(tag) {
|
|
204
264
|
const apiClient = v3_1.apiClientManager.clientOrThrow();
|
|
205
265
|
return apiClient.subscribeToRunsWithTag(tag);
|
|
206
266
|
}
|
|
267
|
+
/**
|
|
268
|
+
* Subscribes to real-time updates for all runs within a specific batch.
|
|
269
|
+
*
|
|
270
|
+
* Use this function when you've triggered multiple runs using `batchTrigger` and want
|
|
271
|
+
* to monitor all runs in that batch. You'll receive updates whenever any run in the batch changes.
|
|
272
|
+
*
|
|
273
|
+
* @template TTasks - The type parameter extending AnyTask for type-safe payload and output
|
|
274
|
+
* @param {string} batchId - The ID of the batch to subscribe to
|
|
275
|
+
* @returns {RunSubscription<InferRunTypes<TTasks>>} An async iterator that yields updated run objects
|
|
276
|
+
*
|
|
277
|
+
* @example
|
|
278
|
+
* ```ts
|
|
279
|
+
* // Subscribe to all runs in a batch
|
|
280
|
+
* for await (const run of runs.subscribeToRunsInBatch("batch-123")) {
|
|
281
|
+
* console.log("Batch run updated:", run);
|
|
282
|
+
* }
|
|
283
|
+
*
|
|
284
|
+
* // Subscribe with type safety
|
|
285
|
+
* for await (const run of runs.subscribeToRunsInBatch<typeof myTask>("batch-123")) {
|
|
286
|
+
* console.log("Run payload:", run.payload);
|
|
287
|
+
* if (run.output) {
|
|
288
|
+
* console.log("Run output:", run.output);
|
|
289
|
+
* }
|
|
290
|
+
* }
|
|
291
|
+
* ```
|
|
292
|
+
*
|
|
293
|
+
* @note The run objects received will include standard fields like id, status, payload, output,
|
|
294
|
+
* createdAt, updatedAt, tags, and more. See the Run object documentation for full details.
|
|
295
|
+
*/
|
|
296
|
+
function subscribeToRunsInBatch(batchId) {
|
|
297
|
+
const apiClient = v3_1.apiClientManager.clientOrThrow();
|
|
298
|
+
return apiClient.subscribeToBatch(batchId);
|
|
299
|
+
}
|
|
207
300
|
//# sourceMappingURL=runs.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runs.js","sourceRoot":"","sources":["../../../src/v3/runs.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"runs.js","sourceRoot":"","sources":["../../../src/v3/runs.ts"],"names":[],"mappings":";;;AAgBA,6CAY8B;AAC9B,gFAAuF;AAEvF,2CAAqC;AAYxB,QAAA,IAAI,GAAG;IAClB,MAAM,EAAE,SAAS;IACjB,MAAM,EAAE,SAAS;IACjB,QAAQ,EAAE,WAAW;IACrB,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,aAAa;IACzB,IAAI;IACJ,cAAc;IACd,sBAAsB;IACtB,gBAAgB,EAAE,sBAAsB;CACzC,CAAC;AAaF,SAAS,QAAQ,CACf,kBAAiD,EACjD,eAAsF,EACtF,cAAkC;IAElC,MAAM,SAAS,GAAG,qBAAgB,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,IAAA,qBAAgB,EAAC,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,IAAA,qBAAgB,EAAC,eAAe,CAAC,EAAE,CAAC;YACtC,OAAO,IAAA,wBAAmB,EACxB;gBACE,MAAM,EAAN,kBAAM;gBACN,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,MAAM;gBACZ,UAAU,EAAE;oBACV,UAAU,EAAE,kBAAkB;oBAC9B,GAAG,IAAA,wBAAmB,EAAC;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,IAAA,wBAAmB,EACxB;gBACE,MAAM,EAAN,kBAAM;gBACN,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,MAAM;gBACZ,UAAU,EAAE;oBACV,UAAU,EAAE,kBAAkB;oBAC9B,GAAG,IAAA,sBAAiB,EAAC,eAA0C,EAAE,aAAa,CAAC;oBAC/E,GAAG,IAAA,wBAAmB,EAAC;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,IAAA,wBAAmB,EACxB;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,GAAG,IAAA,sBAAiB,EAAC,kBAA6C,EAAE,aAAa,CAAC;SACnF;KACF,EACD,IAAA,qBAAgB,EAAC,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,qBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;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,IAAA,wBAAmB,EAAC;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,GAAyB;IAClE,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,IAAA,2CAAyB,EAAC,GAAG,CAAC,mBAAmB,EAAE,kBAAM,CAAC;YAC1D,IAAA,2CAAyB,EAAC,GAAG,CAAC,kBAAkB,EAAE,kBAAM,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,IAAA,2CAAyB,EAAC,GAAG,CAAC,mBAAmB,EAAE,kBAAM,CAAC,CAAC;IACzF,CAAC;SAAM,IAAI,GAAG,CAAC,kBAAkB,EAAE,CAAC;QAClC,WAAW,CAAC,MAAM,GAAG,MAAM,IAAA,2CAAyB,EAAC,GAAG,CAAC,kBAAkB,EAAE,kBAAM,CAAC,CAAC;IACvF,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,SAAS,CAChB,KAAa,EACb,cAAkC;IAElC,MAAM,SAAS,GAAG,qBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,KAAK;YACL,GAAG,IAAA,wBAAmB,EAAC;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,qBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,KAAK;YACL,GAAG,IAAA,wBAAmB,EAAC;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,qBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE;YACV,KAAK;YACL,GAAG,IAAA,wBAAmB,EAAC;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,YAAI,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;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,SAAS,cAAc,CACrB,KAAoB;IAEpB,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;IAE5D,MAAM,SAAS,GAAG,qBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,OAAO,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,SAAS,sBAAsB,CAC7B,GAAsB;IAEtB,MAAM,SAAS,GAAG,qBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,OAAO,SAAS,CAAC,sBAAsB,CAAwB,GAAG,CAAC,CAAC;AACtE,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,SAAS,sBAAsB,CAC7B,OAAe;IAEf,MAAM,SAAS,GAAG,qBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,OAAO,SAAS,CAAC,gBAAgB,CAAwB,OAAO,CAAC,CAAC;AACpE,CAAC"}
|