@trigger.dev/sdk 0.0.0-prerelease-20241023140846 → 0.0.0-prerelease-20241119135607
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/triggers/invokeTrigger.d.ts +1 -1
- package/dist/commonjs/types.d.ts +4 -4
- package/dist/commonjs/v3/auth.d.ts +104 -0
- package/dist/commonjs/v3/auth.js +102 -0
- package/dist/commonjs/v3/auth.js.map +1 -0
- package/dist/commonjs/v3/idempotencyKeys.d.ts +2 -46
- package/dist/commonjs/v3/idempotencyKeys.js +1 -69
- package/dist/commonjs/v3/idempotencyKeys.js.map +1 -1
- package/dist/commonjs/v3/index.d.ts +4 -19
- package/dist/commonjs/v3/index.js +18 -35
- package/dist/commonjs/v3/index.js.map +1 -1
- package/dist/commonjs/v3/metadata.d.ts +75 -12
- package/dist/commonjs/v3/metadata.js +93 -53
- package/dist/commonjs/v3/metadata.js.map +1 -1
- package/dist/commonjs/v3/runs.d.ts +33 -756
- package/dist/commonjs/v3/runs.js +12 -1
- package/dist/commonjs/v3/runs.js.map +1 -1
- package/dist/commonjs/v3/shared.d.ts +10 -380
- package/dist/commonjs/v3/shared.js +125 -68
- package/dist/commonjs/v3/shared.js.map +1 -1
- package/dist/commonjs/v3/tasks.d.ts +6 -5
- package/dist/commonjs/v3/tasks.js +4 -5
- package/dist/commonjs/v3/tasks.js.map +1 -1
- package/dist/commonjs/v3/tracer.d.ts +1 -1
- package/dist/commonjs/v3/tracer.js +2 -2
- package/dist/commonjs/v3/tracer.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/v3/auth.d.ts +104 -0
- package/dist/esm/v3/auth.js +98 -0
- package/dist/esm/v3/auth.js.map +1 -0
- package/dist/esm/v3/idempotencyKeys.d.ts +2 -46
- package/dist/esm/v3/idempotencyKeys.js +1 -68
- package/dist/esm/v3/idempotencyKeys.js.map +1 -1
- package/dist/esm/v3/index-browser.d.mts +2 -0
- package/dist/esm/v3/index-browser.mjs +3 -0
- package/dist/esm/v3/index.d.ts +4 -19
- package/dist/esm/v3/index.js +4 -22
- package/dist/esm/v3/index.js.map +1 -1
- package/dist/esm/v3/metadata.d.ts +75 -12
- package/dist/esm/v3/metadata.js +94 -54
- package/dist/esm/v3/metadata.js.map +1 -1
- package/dist/esm/v3/runs.d.ts +61 -784
- package/dist/esm/v3/runs.js +12 -1
- package/dist/esm/v3/runs.js.map +1 -1
- package/dist/esm/v3/shared.d.ts +10 -380
- package/dist/esm/v3/shared.js +121 -65
- package/dist/esm/v3/shared.js.map +1 -1
- package/dist/esm/v3/tasks.d.ts +6 -5
- package/dist/esm/v3/tasks.js +4 -4
- package/dist/esm/v3/tasks.js.map +1 -1
- package/dist/esm/v3/tracer.d.ts +1 -1
- package/dist/esm/v3/tracer.js +1 -1
- package/dist/esm/v3/tracer.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
- package/dist/browser/apiClient.d.ts +0 -737
- package/dist/browser/apiClient.js +0 -687
- package/dist/browser/apiClient.js.map +0 -1
- package/dist/browser/concurrencyLimit.d.ts +0 -10
- package/dist/browser/concurrencyLimit.js +0 -13
- package/dist/browser/concurrencyLimit.js.map +0 -1
- package/dist/browser/errors.d.ts +0 -66
- package/dist/browser/errors.js +0 -95
- package/dist/browser/errors.js.map +0 -1
- package/dist/browser/httpEndpoint.d.ts +0 -87
- package/dist/browser/httpEndpoint.js +0 -125
- package/dist/browser/httpEndpoint.js.map +0 -1
- package/dist/browser/index.d.ts +0 -23
- package/dist/browser/index.js +0 -35
- package/dist/browser/index.js.map +0 -1
- package/dist/browser/integrations.d.ts +0 -11
- package/dist/browser/integrations.js +0 -2
- package/dist/browser/integrations.js.map +0 -1
- package/dist/browser/io.d.ts +0 -453
- package/dist/browser/io.js +0 -1159
- package/dist/browser/io.js.map +0 -1
- package/dist/browser/ioWithIntegrations.d.ts +0 -4
- package/dist/browser/ioWithIntegrations.js +0 -29
- package/dist/browser/ioWithIntegrations.js.map +0 -1
- package/dist/browser/job.d.ts +0 -96
- package/dist/browser/job.js +0 -206
- package/dist/browser/job.js.map +0 -1
- package/dist/browser/retry.d.ts +0 -20
- package/dist/browser/retry.js +0 -19
- package/dist/browser/retry.js.map +0 -1
- package/dist/browser/runLocalStorage.d.ts +0 -8
- package/dist/browser/runLocalStorage.js +0 -3
- package/dist/browser/runLocalStorage.js.map +0 -1
- package/dist/browser/security.d.ts +0 -18
- package/dist/browser/security.js +0 -34
- package/dist/browser/security.js.map +0 -1
- package/dist/browser/status.d.ts +0 -19
- package/dist/browser/status.js +0 -34
- package/dist/browser/status.js.map +0 -1
- package/dist/browser/store/keyValueStore.d.ts +0 -17
- package/dist/browser/store/keyValueStore.js +0 -134
- package/dist/browser/store/keyValueStore.js.map +0 -1
- package/dist/browser/store/keyValueStoreClient.d.ts +0 -19
- package/dist/browser/store/keyValueStoreClient.js +0 -61
- package/dist/browser/store/keyValueStoreClient.js.map +0 -1
- package/dist/browser/triggerClient.d.ts +0 -300
- package/dist/browser/triggerClient.js +0 -1359
- package/dist/browser/triggerClient.js.map +0 -1
- package/dist/browser/triggers/dynamic.d.ts +0 -56
- package/dist/browser/triggers/dynamic.js +0 -93
- package/dist/browser/triggers/dynamic.js.map +0 -1
- package/dist/browser/triggers/eventTrigger.d.ts +0 -58
- package/dist/browser/triggers/eventTrigger.js +0 -64
- package/dist/browser/triggers/eventTrigger.js.map +0 -1
- package/dist/browser/triggers/externalSource.d.ts +0 -148
- package/dist/browser/triggers/externalSource.js +0 -100
- package/dist/browser/triggers/externalSource.js.map +0 -1
- package/dist/browser/triggers/invokeTrigger.d.ts +0 -39
- package/dist/browser/triggers/invokeTrigger.js +0 -53
- package/dist/browser/triggers/invokeTrigger.js.map +0 -1
- package/dist/browser/triggers/notifications.d.ts +0 -111
- package/dist/browser/triggers/notifications.js +0 -94
- package/dist/browser/triggers/notifications.js.map +0 -1
- package/dist/browser/triggers/scheduled.d.ts +0 -145
- package/dist/browser/triggers/scheduled.js +0 -197
- package/dist/browser/triggers/scheduled.js.map +0 -1
- package/dist/browser/triggers/webhook.d.ts +0 -143
- package/dist/browser/triggers/webhook.js +0 -128
- package/dist/browser/triggers/webhook.js.map +0 -1
- package/dist/browser/typed-emitter.d.ts +0 -37
- package/dist/browser/typed-emitter.js +0 -2
- package/dist/browser/typed-emitter.js.map +0 -1
- package/dist/browser/types.d.ts +0 -204
- package/dist/browser/types.js +0 -19
- package/dist/browser/types.js.map +0 -1
- package/dist/browser/utils/formatSchemaErrors.d.ts +0 -3
- package/dist/browser/utils/formatSchemaErrors.js +0 -7
- package/dist/browser/utils/formatSchemaErrors.js.map +0 -1
- package/dist/browser/utils/typedAsyncLocalStorage.d.ts +0 -6
- package/dist/browser/utils/typedAsyncLocalStorage.js +0 -14
- package/dist/browser/utils/typedAsyncLocalStorage.js.map +0 -1
- package/dist/browser/utils.d.ts +0 -1
- package/dist/browser/utils.js +0 -8
- package/dist/browser/utils.js.map +0 -1
- package/dist/browser/v3/cache.d.ts +0 -28
- package/dist/browser/v3/cache.js +0 -58
- package/dist/browser/v3/cache.js.map +0 -1
- package/dist/browser/v3/config.d.ts +0 -4
- package/dist/browser/v3/config.js +0 -4
- package/dist/browser/v3/config.js.map +0 -1
- package/dist/browser/v3/envvars.d.ts +0 -14
- package/dist/browser/v3/envvars.js +0 -219
- package/dist/browser/v3/envvars.js.map +0 -1
- package/dist/browser/v3/idempotencyKeys.d.ts +0 -44
- package/dist/browser/v3/idempotencyKeys.js +0 -72
- package/dist/browser/v3/idempotencyKeys.js.map +0 -1
- package/dist/browser/v3/index.d.ts +0 -21
- package/dist/browser/v3/index.js +0 -17
- package/dist/browser/v3/metadata.d.ts +0 -87
- package/dist/browser/v3/metadata.js +0 -105
- package/dist/browser/v3/metadata.js.map +0 -1
- package/dist/browser/v3/retry.d.ts +0 -15
- package/dist/browser/v3/retry.js +0 -408
- package/dist/browser/v3/retry.js.map +0 -1
- package/dist/browser/v3/runs.d.ts +0 -180
- package/dist/browser/v3/runs.js +0 -204
- package/dist/browser/v3/runs.js.map +0 -1
- package/dist/browser/v3/schedules/api.d.ts +0 -1
- package/dist/browser/v3/schedules/api.js +0 -2
- package/dist/browser/v3/schedules/api.js.map +0 -1
- package/dist/browser/v3/schedules/index.d.ts +0 -87
- package/dist/browser/v3/schedules/index.js +0 -215
- package/dist/browser/v3/schedules/index.js.map +0 -1
- package/dist/browser/v3/shared.d.ts +0 -90
- package/dist/browser/v3/shared.js +0 -546
- package/dist/browser/v3/shared.js.map +0 -1
- package/dist/browser/v3/tags.d.ts +0 -6
- package/dist/browser/v3/tags.js +0 -43
- package/dist/browser/v3/tags.js.map +0 -1
- package/dist/browser/v3/tasks.d.ts +0 -31
- package/dist/browser/v3/tasks.js +0 -30
- package/dist/browser/v3/tasks.js.map +0 -1
- package/dist/browser/v3/timeout.d.ts +0 -4
- package/dist/browser/v3/timeout.js +0 -7
- package/dist/browser/v3/timeout.js.map +0 -1
- package/dist/browser/v3/tracer.d.ts +0 -2
- package/dist/browser/v3/tracer.js +0 -4
- package/dist/browser/v3/tracer.js.map +0 -1
- package/dist/browser/v3/usage.d.ts +0 -77
- package/dist/browser/v3/usage.js +0 -112
- package/dist/browser/v3/usage.js.map +0 -1
- package/dist/browser/v3/wait.d.ts +0 -22
- package/dist/browser/v3/wait.js +0 -96
- package/dist/browser/v3/wait.js.map +0 -1
- package/dist/browser/version.d.ts +0 -1
- package/dist/browser/version.js +0 -2
- package/dist/browser/version.js.map +0 -1
- /package/dist/{browser → esm}/v3/index-browser.mjs.map +0 -0
|
@@ -1,180 +0,0 @@
|
|
|
1
|
-
import type { AnyRetrieveRunResult, AnyRunShape, ApiRequestOptions, InferRunTypes, ListProjectRunsQueryParams, ListRunsQueryParams, RescheduleRunRequestBody, RetrieveRunResult, RunShape, RunSubscription, TaskRunShape } from "@trigger.dev/core/v3";
|
|
2
|
-
import { ApiPromise, CanceledRunResponse, CursorPagePromise, ListRunResponseItem, ReplayRunResponse, RetrieveRunResponse } from "@trigger.dev/core/v3";
|
|
3
|
-
import { AnyRunHandle, AnyTask } from "./shared.js";
|
|
4
|
-
export type { AnyRetrieveRunResult, AnyRunShape, RetrieveRunResult, RunShape, TaskRunShape };
|
|
5
|
-
export declare const runs: {
|
|
6
|
-
replay: typeof replayRun;
|
|
7
|
-
cancel: typeof cancelRun;
|
|
8
|
-
retrieve: typeof retrieveRun;
|
|
9
|
-
list: typeof listRuns;
|
|
10
|
-
reschedule: typeof rescheduleRun;
|
|
11
|
-
poll: typeof poll;
|
|
12
|
-
subscribeToRun: typeof subscribeToRun;
|
|
13
|
-
subscribeToRunsWithTag: typeof subscribeToRunsWithTag;
|
|
14
|
-
};
|
|
15
|
-
export type ListRunsItem = ListRunResponseItem;
|
|
16
|
-
declare function listRuns(projectRef: string, params?: ListProjectRunsQueryParams, requestOptions?: ApiRequestOptions): CursorPagePromise<typeof ListRunResponseItem>;
|
|
17
|
-
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>>;
|
|
20
|
-
declare function replayRun(runId: string, requestOptions?: ApiRequestOptions): ApiPromise<ReplayRunResponse>;
|
|
21
|
-
declare function cancelRun(runId: string, requestOptions?: ApiRequestOptions): ApiPromise<CanceledRunResponse>;
|
|
22
|
-
declare function rescheduleRun(runId: string, body: RescheduleRunRequestBody, requestOptions?: ApiRequestOptions): ApiPromise<RetrieveRunResponse>;
|
|
23
|
-
export type PollOptions = {
|
|
24
|
-
pollIntervalMs?: number;
|
|
25
|
-
};
|
|
26
|
-
declare function poll<TRunId extends AnyRunHandle | AnyTask | string>(runId: RunId<TRunId>, options?: {
|
|
27
|
-
pollIntervalMs?: number;
|
|
28
|
-
}, requestOptions?: ApiRequestOptions): Promise<{
|
|
29
|
-
status: "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "COMPLETED" | "CANCELED" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED" | "TIMED_OUT";
|
|
30
|
-
error?: {
|
|
31
|
-
message: string;
|
|
32
|
-
name?: string | undefined;
|
|
33
|
-
stackTrace?: string | undefined;
|
|
34
|
-
} | undefined;
|
|
35
|
-
id: string;
|
|
36
|
-
startedAt?: Date | undefined;
|
|
37
|
-
tags: string[];
|
|
38
|
-
isTest: boolean;
|
|
39
|
-
createdAt: Date;
|
|
40
|
-
idempotencyKey?: string | undefined;
|
|
41
|
-
durationMs: number;
|
|
42
|
-
costInCents: number;
|
|
43
|
-
baseCostInCents: number;
|
|
44
|
-
version?: string | undefined;
|
|
45
|
-
metadata?: Record<string, any> | undefined;
|
|
46
|
-
schedule?: {
|
|
47
|
-
id: string;
|
|
48
|
-
generator: {
|
|
49
|
-
type: "CRON";
|
|
50
|
-
expression: string;
|
|
51
|
-
description: string;
|
|
52
|
-
};
|
|
53
|
-
externalId?: string | undefined;
|
|
54
|
-
deduplicationKey?: string | undefined;
|
|
55
|
-
} | undefined;
|
|
56
|
-
taskIdentifier: string;
|
|
57
|
-
payloadPresignedUrl?: string | undefined;
|
|
58
|
-
outputPresignedUrl?: string | undefined;
|
|
59
|
-
relatedRuns: {
|
|
60
|
-
root?: {
|
|
61
|
-
status: "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "COMPLETED" | "CANCELED" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED" | "TIMED_OUT";
|
|
62
|
-
id: string;
|
|
63
|
-
tags: string[];
|
|
64
|
-
isTest: boolean;
|
|
65
|
-
createdAt: Date;
|
|
66
|
-
durationMs: number;
|
|
67
|
-
costInCents: number;
|
|
68
|
-
baseCostInCents: number;
|
|
69
|
-
taskIdentifier: string;
|
|
70
|
-
depth: number;
|
|
71
|
-
triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
|
|
72
|
-
isQueued: boolean;
|
|
73
|
-
isExecuting: boolean;
|
|
74
|
-
isCompleted: boolean;
|
|
75
|
-
isSuccess: boolean;
|
|
76
|
-
isFailed: boolean;
|
|
77
|
-
isCancelled: boolean;
|
|
78
|
-
updatedAt: Date;
|
|
79
|
-
batchId?: string | undefined;
|
|
80
|
-
idempotencyKey?: string | undefined;
|
|
81
|
-
version?: string | undefined;
|
|
82
|
-
startedAt?: Date | undefined;
|
|
83
|
-
finishedAt?: Date | undefined;
|
|
84
|
-
delayedUntil?: Date | undefined;
|
|
85
|
-
ttl?: string | undefined;
|
|
86
|
-
expiredAt?: Date | undefined;
|
|
87
|
-
metadata?: Record<string, any> | undefined;
|
|
88
|
-
} | undefined;
|
|
89
|
-
parent?: {
|
|
90
|
-
status: "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "COMPLETED" | "CANCELED" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED" | "TIMED_OUT";
|
|
91
|
-
id: string;
|
|
92
|
-
tags: string[];
|
|
93
|
-
isTest: boolean;
|
|
94
|
-
createdAt: Date;
|
|
95
|
-
durationMs: number;
|
|
96
|
-
costInCents: number;
|
|
97
|
-
baseCostInCents: number;
|
|
98
|
-
taskIdentifier: string;
|
|
99
|
-
depth: number;
|
|
100
|
-
triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
|
|
101
|
-
isQueued: boolean;
|
|
102
|
-
isExecuting: boolean;
|
|
103
|
-
isCompleted: boolean;
|
|
104
|
-
isSuccess: boolean;
|
|
105
|
-
isFailed: boolean;
|
|
106
|
-
isCancelled: boolean;
|
|
107
|
-
updatedAt: Date;
|
|
108
|
-
batchId?: string | undefined;
|
|
109
|
-
idempotencyKey?: string | undefined;
|
|
110
|
-
version?: string | undefined;
|
|
111
|
-
startedAt?: Date | undefined;
|
|
112
|
-
finishedAt?: Date | undefined;
|
|
113
|
-
delayedUntil?: Date | undefined;
|
|
114
|
-
ttl?: string | undefined;
|
|
115
|
-
expiredAt?: Date | undefined;
|
|
116
|
-
metadata?: Record<string, any> | undefined;
|
|
117
|
-
} | undefined;
|
|
118
|
-
children?: {
|
|
119
|
-
status: "WAITING_FOR_DEPLOY" | "QUEUED" | "EXECUTING" | "REATTEMPTING" | "FROZEN" | "COMPLETED" | "CANCELED" | "FAILED" | "CRASHED" | "INTERRUPTED" | "SYSTEM_FAILURE" | "DELAYED" | "EXPIRED" | "TIMED_OUT";
|
|
120
|
-
id: string;
|
|
121
|
-
tags: string[];
|
|
122
|
-
isTest: boolean;
|
|
123
|
-
createdAt: Date;
|
|
124
|
-
durationMs: number;
|
|
125
|
-
costInCents: number;
|
|
126
|
-
baseCostInCents: number;
|
|
127
|
-
taskIdentifier: string;
|
|
128
|
-
depth: number;
|
|
129
|
-
triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
|
|
130
|
-
isQueued: boolean;
|
|
131
|
-
isExecuting: boolean;
|
|
132
|
-
isCompleted: boolean;
|
|
133
|
-
isSuccess: boolean;
|
|
134
|
-
isFailed: boolean;
|
|
135
|
-
isCancelled: boolean;
|
|
136
|
-
updatedAt: Date;
|
|
137
|
-
batchId?: string | undefined;
|
|
138
|
-
idempotencyKey?: string | undefined;
|
|
139
|
-
version?: string | undefined;
|
|
140
|
-
startedAt?: Date | undefined;
|
|
141
|
-
finishedAt?: Date | undefined;
|
|
142
|
-
delayedUntil?: Date | undefined;
|
|
143
|
-
ttl?: string | undefined;
|
|
144
|
-
expiredAt?: Date | undefined;
|
|
145
|
-
metadata?: Record<string, any> | undefined;
|
|
146
|
-
}[] | undefined;
|
|
147
|
-
};
|
|
148
|
-
depth: number;
|
|
149
|
-
triggerFunction: "triggerAndWait" | "trigger" | "batchTriggerAndWait" | "batchTrigger";
|
|
150
|
-
batchId?: string | undefined;
|
|
151
|
-
isQueued: boolean;
|
|
152
|
-
isExecuting: boolean;
|
|
153
|
-
isCompleted: boolean;
|
|
154
|
-
isSuccess: boolean;
|
|
155
|
-
isFailed: boolean;
|
|
156
|
-
isCancelled: boolean;
|
|
157
|
-
updatedAt: Date;
|
|
158
|
-
finishedAt?: Date | undefined;
|
|
159
|
-
delayedUntil?: Date | undefined;
|
|
160
|
-
ttl?: string | undefined;
|
|
161
|
-
expiredAt?: Date | undefined;
|
|
162
|
-
attempts: ({
|
|
163
|
-
status: "EXECUTING" | "COMPLETED" | "CANCELED" | "FAILED" | "PENDING" | "PAUSED";
|
|
164
|
-
id: string;
|
|
165
|
-
createdAt: Date;
|
|
166
|
-
updatedAt: Date;
|
|
167
|
-
startedAt?: Date | undefined;
|
|
168
|
-
completedAt?: Date | undefined;
|
|
169
|
-
error?: {
|
|
170
|
-
message: string;
|
|
171
|
-
name?: string | undefined;
|
|
172
|
-
stackTrace?: string | undefined;
|
|
173
|
-
} | undefined;
|
|
174
|
-
} | undefined)[];
|
|
175
|
-
attemptCount: number;
|
|
176
|
-
output?: InferRunTypes<TRunId>["output"] | undefined;
|
|
177
|
-
payload?: InferRunTypes<TRunId>["payload"] | undefined;
|
|
178
|
-
}>;
|
|
179
|
-
declare function subscribeToRun<TRunId extends AnyRunHandle | AnyTask | string>(runId: RunId<TRunId>): RunSubscription<InferRunTypes<TRunId>>;
|
|
180
|
-
declare function subscribeToRunsWithTag<TTasks extends AnyTask>(tag: string | string[]): RunSubscription<InferRunTypes<TTasks>>;
|
package/dist/browser/v3/runs.js
DELETED
|
@@ -1,204 +0,0 @@
|
|
|
1
|
-
import { accessoryAttributes, apiClientManager, flattenAttributes, isRequestOptions, mergeRequestOptions, } from "@trigger.dev/core/v3";
|
|
2
|
-
import { resolvePresignedPacketUrl } from "@trigger.dev/core/v3/utils/ioSerialization";
|
|
3
|
-
import { tracer } from "./tracer.js";
|
|
4
|
-
export const runs = {
|
|
5
|
-
replay: replayRun,
|
|
6
|
-
cancel: cancelRun,
|
|
7
|
-
retrieve: retrieveRun,
|
|
8
|
-
list: listRuns,
|
|
9
|
-
reschedule: rescheduleRun,
|
|
10
|
-
poll,
|
|
11
|
-
subscribeToRun,
|
|
12
|
-
subscribeToRunsWithTag,
|
|
13
|
-
};
|
|
14
|
-
function listRuns(paramsOrProjectRef, paramsOrOptions, requestOptions) {
|
|
15
|
-
const apiClient = apiClientManager.clientOrThrow();
|
|
16
|
-
const $requestOptions = listRunsRequestOptions(paramsOrProjectRef, paramsOrOptions, requestOptions);
|
|
17
|
-
if (typeof paramsOrProjectRef === "string") {
|
|
18
|
-
if (isRequestOptions(paramsOrOptions)) {
|
|
19
|
-
return apiClient.listProjectRuns(paramsOrProjectRef, {}, $requestOptions);
|
|
20
|
-
}
|
|
21
|
-
else {
|
|
22
|
-
return apiClient.listProjectRuns(paramsOrProjectRef, paramsOrOptions, $requestOptions);
|
|
23
|
-
}
|
|
24
|
-
}
|
|
25
|
-
return apiClient.listRuns(paramsOrProjectRef, $requestOptions);
|
|
26
|
-
}
|
|
27
|
-
function listRunsRequestOptions(paramsOrProjectRef, paramsOrOptions, requestOptions) {
|
|
28
|
-
if (typeof paramsOrProjectRef === "string") {
|
|
29
|
-
if (isRequestOptions(paramsOrOptions)) {
|
|
30
|
-
return mergeRequestOptions({
|
|
31
|
-
tracer,
|
|
32
|
-
name: "runs.list()",
|
|
33
|
-
icon: "runs",
|
|
34
|
-
attributes: {
|
|
35
|
-
projectRef: paramsOrProjectRef,
|
|
36
|
-
...accessoryAttributes({
|
|
37
|
-
items: [
|
|
38
|
-
{
|
|
39
|
-
text: paramsOrProjectRef,
|
|
40
|
-
variant: "normal",
|
|
41
|
-
},
|
|
42
|
-
],
|
|
43
|
-
style: "codepath",
|
|
44
|
-
}),
|
|
45
|
-
},
|
|
46
|
-
}, paramsOrOptions);
|
|
47
|
-
}
|
|
48
|
-
else {
|
|
49
|
-
return mergeRequestOptions({
|
|
50
|
-
tracer,
|
|
51
|
-
name: "runs.list()",
|
|
52
|
-
icon: "runs",
|
|
53
|
-
attributes: {
|
|
54
|
-
projectRef: paramsOrProjectRef,
|
|
55
|
-
...flattenAttributes(paramsOrOptions, "queryParams"),
|
|
56
|
-
...accessoryAttributes({
|
|
57
|
-
items: [
|
|
58
|
-
{
|
|
59
|
-
text: paramsOrProjectRef,
|
|
60
|
-
variant: "normal",
|
|
61
|
-
},
|
|
62
|
-
],
|
|
63
|
-
style: "codepath",
|
|
64
|
-
}),
|
|
65
|
-
},
|
|
66
|
-
}, requestOptions);
|
|
67
|
-
}
|
|
68
|
-
}
|
|
69
|
-
return mergeRequestOptions({
|
|
70
|
-
tracer,
|
|
71
|
-
name: "runs.list()",
|
|
72
|
-
icon: "runs",
|
|
73
|
-
attributes: {
|
|
74
|
-
...flattenAttributes(paramsOrProjectRef, "queryParams"),
|
|
75
|
-
},
|
|
76
|
-
}, isRequestOptions(paramsOrOptions) ? paramsOrOptions : requestOptions);
|
|
77
|
-
}
|
|
78
|
-
function retrieveRun(runId, requestOptions) {
|
|
79
|
-
const apiClient = apiClientManager.clientOrThrow();
|
|
80
|
-
const $requestOptions = mergeRequestOptions({
|
|
81
|
-
tracer,
|
|
82
|
-
name: "runs.retrieve()",
|
|
83
|
-
icon: "runs",
|
|
84
|
-
attributes: {
|
|
85
|
-
runId: typeof runId === "string" ? runId : runId.id,
|
|
86
|
-
...accessoryAttributes({
|
|
87
|
-
items: [
|
|
88
|
-
{
|
|
89
|
-
text: typeof runId === "string" ? runId : runId.id,
|
|
90
|
-
variant: "normal",
|
|
91
|
-
},
|
|
92
|
-
],
|
|
93
|
-
style: "codepath",
|
|
94
|
-
}),
|
|
95
|
-
},
|
|
96
|
-
}, requestOptions);
|
|
97
|
-
const $runId = typeof runId === "string" ? runId : runId.id;
|
|
98
|
-
return apiClient.retrieveRun($runId, $requestOptions).then((retrievedRun) => {
|
|
99
|
-
return resolvePayloadAndOutputUrls(retrievedRun);
|
|
100
|
-
});
|
|
101
|
-
}
|
|
102
|
-
async function resolvePayloadAndOutputUrls(run) {
|
|
103
|
-
const resolvedRun = { ...run };
|
|
104
|
-
if (run.payloadPresignedUrl && run.outputPresignedUrl) {
|
|
105
|
-
const [payload, output] = await Promise.all([
|
|
106
|
-
resolvePresignedPacketUrl(run.payloadPresignedUrl, tracer),
|
|
107
|
-
resolvePresignedPacketUrl(run.outputPresignedUrl, tracer),
|
|
108
|
-
]);
|
|
109
|
-
resolvedRun.payload = payload;
|
|
110
|
-
resolvedRun.output = output;
|
|
111
|
-
}
|
|
112
|
-
else if (run.payloadPresignedUrl) {
|
|
113
|
-
resolvedRun.payload = await resolvePresignedPacketUrl(run.payloadPresignedUrl, tracer);
|
|
114
|
-
}
|
|
115
|
-
else if (run.outputPresignedUrl) {
|
|
116
|
-
resolvedRun.output = await resolvePresignedPacketUrl(run.outputPresignedUrl, tracer);
|
|
117
|
-
}
|
|
118
|
-
return resolvedRun;
|
|
119
|
-
}
|
|
120
|
-
function replayRun(runId, requestOptions) {
|
|
121
|
-
const apiClient = apiClientManager.clientOrThrow();
|
|
122
|
-
const $requestOptions = mergeRequestOptions({
|
|
123
|
-
tracer,
|
|
124
|
-
name: "runs.replay()",
|
|
125
|
-
icon: "runs",
|
|
126
|
-
attributes: {
|
|
127
|
-
runId,
|
|
128
|
-
...accessoryAttributes({
|
|
129
|
-
items: [
|
|
130
|
-
{
|
|
131
|
-
text: runId,
|
|
132
|
-
variant: "normal",
|
|
133
|
-
},
|
|
134
|
-
],
|
|
135
|
-
style: "codepath",
|
|
136
|
-
}),
|
|
137
|
-
},
|
|
138
|
-
}, requestOptions);
|
|
139
|
-
return apiClient.replayRun(runId, $requestOptions);
|
|
140
|
-
}
|
|
141
|
-
function cancelRun(runId, requestOptions) {
|
|
142
|
-
const apiClient = apiClientManager.clientOrThrow();
|
|
143
|
-
const $requestOptions = mergeRequestOptions({
|
|
144
|
-
tracer,
|
|
145
|
-
name: "runs.cancel()",
|
|
146
|
-
icon: "runs",
|
|
147
|
-
attributes: {
|
|
148
|
-
runId,
|
|
149
|
-
...accessoryAttributes({
|
|
150
|
-
items: [
|
|
151
|
-
{
|
|
152
|
-
text: runId,
|
|
153
|
-
variant: "normal",
|
|
154
|
-
},
|
|
155
|
-
],
|
|
156
|
-
style: "codepath",
|
|
157
|
-
}),
|
|
158
|
-
},
|
|
159
|
-
}, requestOptions);
|
|
160
|
-
return apiClient.cancelRun(runId, $requestOptions);
|
|
161
|
-
}
|
|
162
|
-
function rescheduleRun(runId, body, requestOptions) {
|
|
163
|
-
const apiClient = apiClientManager.clientOrThrow();
|
|
164
|
-
const $requestOptions = mergeRequestOptions({
|
|
165
|
-
tracer,
|
|
166
|
-
name: "runs.reschedule()",
|
|
167
|
-
icon: "runs",
|
|
168
|
-
attributes: {
|
|
169
|
-
runId,
|
|
170
|
-
...accessoryAttributes({
|
|
171
|
-
items: [
|
|
172
|
-
{
|
|
173
|
-
text: runId,
|
|
174
|
-
variant: "normal",
|
|
175
|
-
},
|
|
176
|
-
],
|
|
177
|
-
style: "codepath",
|
|
178
|
-
}),
|
|
179
|
-
},
|
|
180
|
-
}, requestOptions);
|
|
181
|
-
return apiClient.rescheduleRun(runId, body, $requestOptions);
|
|
182
|
-
}
|
|
183
|
-
const MAX_POLL_ATTEMPTS = 500;
|
|
184
|
-
async function poll(runId, options, requestOptions) {
|
|
185
|
-
let attempts = 0;
|
|
186
|
-
while (attempts++ < MAX_POLL_ATTEMPTS) {
|
|
187
|
-
const run = await runs.retrieve(runId, requestOptions);
|
|
188
|
-
if (run.isCompleted) {
|
|
189
|
-
return run;
|
|
190
|
-
}
|
|
191
|
-
await new Promise((resolve) => setTimeout(resolve, options?.pollIntervalMs ?? 1000));
|
|
192
|
-
}
|
|
193
|
-
throw new Error(`Run ${typeof runId === "string" ? runId : runId.id} did not complete after ${MAX_POLL_ATTEMPTS} attempts`);
|
|
194
|
-
}
|
|
195
|
-
function subscribeToRun(runId) {
|
|
196
|
-
const $runId = typeof runId === "string" ? runId : runId.id;
|
|
197
|
-
const apiClient = apiClientManager.clientOrThrow();
|
|
198
|
-
return apiClient.subscribeToRun($runId);
|
|
199
|
-
}
|
|
200
|
-
function subscribeToRunsWithTag(tag) {
|
|
201
|
-
const apiClient = apiClientManager.clientOrThrow();
|
|
202
|
-
return apiClient.subscribeToRunsWithTag(tag);
|
|
203
|
-
}
|
|
204
|
-
//# sourceMappingURL=runs.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"runs.js","sourceRoot":"","sources":["../../../src/v3/runs.ts"],"names":[],"mappings":"AAcA,OAAO,EAOL,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAC;AAEvF,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAIrC,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;IACJ,cAAc;IACd,sBAAsB;CACvB,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,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,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;AAED,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,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,OAAO,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC;AAED,SAAS,sBAAsB,CAC7B,GAAsB;IAEtB,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,OAAO,SAAS,CAAC,sBAAsB,CAAwB,GAAG,CAAC,CAAC;AACtE,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export type { CreateScheduleOptions, ScheduledTaskPayload, ListScheduleOptions, UpdateScheduleOptions, } from "@trigger.dev/core/v3";
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../../src/v3/schedules/api.ts"],"names":[],"mappings":""}
|
|
@@ -1,87 +0,0 @@
|
|
|
1
|
-
import { ApiPromise, ApiRequestOptions, DeletedScheduleObject, InitOutput, OffsetLimitPagePromise, ScheduleObject } from "@trigger.dev/core/v3";
|
|
2
|
-
import { Task, TaskOptions } from "../shared.js";
|
|
3
|
-
import * as SchedulesAPI from "./api.js";
|
|
4
|
-
export type ScheduleOptions<TIdentifier extends string, TOutput, TInitOutput extends InitOutput> = TaskOptions<TIdentifier, SchedulesAPI.ScheduledTaskPayload, TOutput, TInitOutput> & {
|
|
5
|
-
/** You can optionally specify a CRON schedule on your task. You can also dynamically add a schedule in the dashboard or using the SDK functions.
|
|
6
|
-
*
|
|
7
|
-
* 1. Pass a CRON pattern string
|
|
8
|
-
* ```ts
|
|
9
|
-
* "0 0 * * *"
|
|
10
|
-
* ```
|
|
11
|
-
*
|
|
12
|
-
* 2. Or an object with a pattern and an optional timezone (default is "UTC")
|
|
13
|
-
* ```ts
|
|
14
|
-
* {
|
|
15
|
-
* pattern: "0 0 * * *",
|
|
16
|
-
* timezone: "America/Los_Angeles"
|
|
17
|
-
* }
|
|
18
|
-
* ```
|
|
19
|
-
*
|
|
20
|
-
* @link https://trigger.dev/docs/v3/tasks-scheduled
|
|
21
|
-
*/
|
|
22
|
-
cron?: string | {
|
|
23
|
-
pattern: string;
|
|
24
|
-
timezone?: string;
|
|
25
|
-
};
|
|
26
|
-
};
|
|
27
|
-
export declare function task<TIdentifier extends string, TOutput, TInitOutput extends InitOutput>(params: ScheduleOptions<TIdentifier, TOutput, TInitOutput>): Task<TIdentifier, SchedulesAPI.ScheduledTaskPayload, TOutput>;
|
|
28
|
-
/**
|
|
29
|
-
* Creates a new schedule
|
|
30
|
-
* @param options
|
|
31
|
-
* @param options.task - The identifier of the task to be scheduled (Must already exist and be a scheduled task)
|
|
32
|
-
* @param options.cron - The cron expression for the schedule (e.g. `0 0 * * *`)
|
|
33
|
-
* @param options.timezone - An optional timezone for the schedule in the IANA format (e.g. `America/Los_Angeles`). Defaults to "UTC".
|
|
34
|
-
* @param options.externalId - An optional external identifier for the schedule
|
|
35
|
-
* @param options.deduplicationKey - An optional deduplication key for the schedule
|
|
36
|
-
* @returns The created schedule
|
|
37
|
-
*/
|
|
38
|
-
export declare function create(options: SchedulesAPI.CreateScheduleOptions, requestOptions?: ApiRequestOptions): ApiPromise<ScheduleObject>;
|
|
39
|
-
/**
|
|
40
|
-
* Retrieves a schedule
|
|
41
|
-
* @param scheduleId - The ID of the schedule to retrieve
|
|
42
|
-
* @returns The retrieved schedule
|
|
43
|
-
*/
|
|
44
|
-
export declare function retrieve(scheduleId: string, requestOptions?: ApiRequestOptions): ApiPromise<ScheduleObject>;
|
|
45
|
-
/**
|
|
46
|
-
* Updates a schedule
|
|
47
|
-
* @param scheduleId - The ID of the schedule to update
|
|
48
|
-
* @param options - The updated schedule options
|
|
49
|
-
* @param options.task - The identifier of the task to be scheduled (Must already exist and be a scheduled task)
|
|
50
|
-
* @param options.cron - The cron expression for the schedule (e.g. `0 0 * * *`)
|
|
51
|
-
* @param options.timezone - An optional timezone for the schedule in the IANA format (e.g. `America/Los_Angeles`). Defaults to "UTC".
|
|
52
|
-
* @param options.externalId - An optional external identifier for the schedule
|
|
53
|
-
* @returns The updated schedule
|
|
54
|
-
*/
|
|
55
|
-
export declare function update(scheduleId: string, options: SchedulesAPI.UpdateScheduleOptions, requestOptions?: ApiRequestOptions): ApiPromise<ScheduleObject>;
|
|
56
|
-
/**
|
|
57
|
-
* Deletes a schedule
|
|
58
|
-
* @param scheduleId - The ID of the schedule to delete
|
|
59
|
-
*/
|
|
60
|
-
export declare function del(scheduleId: string, requestOptions?: ApiRequestOptions): ApiPromise<DeletedScheduleObject>;
|
|
61
|
-
/**
|
|
62
|
-
* Deactivates a schedule
|
|
63
|
-
* @param scheduleId - The ID of the schedule to deactivate
|
|
64
|
-
*/
|
|
65
|
-
export declare function deactivate(scheduleId: string, requestOptions?: ApiRequestOptions): ApiPromise<ScheduleObject>;
|
|
66
|
-
/**
|
|
67
|
-
* Activates a schedule
|
|
68
|
-
* @param scheduleId - The ID of the schedule to activate
|
|
69
|
-
*/
|
|
70
|
-
export declare function activate(scheduleId: string, requestOptions?: ApiRequestOptions): ApiPromise<ScheduleObject>;
|
|
71
|
-
/**
|
|
72
|
-
* Lists schedules
|
|
73
|
-
* @param options - The list options
|
|
74
|
-
* @param options.page - The page number
|
|
75
|
-
* @param options.perPage - The number of schedules per page
|
|
76
|
-
* @returns The list of schedules
|
|
77
|
-
*/
|
|
78
|
-
export declare function list(options?: SchedulesAPI.ListScheduleOptions, requestOptions?: ApiRequestOptions): OffsetLimitPagePromise<typeof ScheduleObject>;
|
|
79
|
-
/**
|
|
80
|
-
* Lists the possible timezones we support
|
|
81
|
-
* @param excludeUtc - By default "UTC" is included and is first. If true, "UTC" will be excluded.
|
|
82
|
-
*/
|
|
83
|
-
export declare function timezones(options?: {
|
|
84
|
-
excludeUtc?: boolean;
|
|
85
|
-
}): ApiPromise<{
|
|
86
|
-
timezones: string[];
|
|
87
|
-
}>;
|