@trigger.dev/sdk 3.0.13 → 3.1.0
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/browser/apiClient.d.ts +737 -0
- package/dist/browser/apiClient.js +687 -0
- package/dist/browser/apiClient.js.map +1 -0
- package/dist/browser/concurrencyLimit.d.ts +10 -0
- package/dist/browser/concurrencyLimit.js +13 -0
- package/dist/browser/concurrencyLimit.js.map +1 -0
- package/dist/browser/errors.d.ts +66 -0
- package/dist/browser/errors.js +95 -0
- package/dist/browser/errors.js.map +1 -0
- package/dist/browser/httpEndpoint.d.ts +87 -0
- package/dist/browser/httpEndpoint.js +125 -0
- package/dist/browser/httpEndpoint.js.map +1 -0
- package/dist/browser/index.d.ts +23 -0
- package/dist/browser/index.js +35 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/browser/integrations.d.ts +11 -0
- package/dist/browser/integrations.js +2 -0
- package/dist/browser/integrations.js.map +1 -0
- package/dist/browser/io.d.ts +453 -0
- package/dist/browser/io.js +1159 -0
- package/dist/browser/io.js.map +1 -0
- package/dist/browser/ioWithIntegrations.d.ts +4 -0
- package/dist/browser/ioWithIntegrations.js +29 -0
- package/dist/browser/ioWithIntegrations.js.map +1 -0
- package/dist/browser/job.d.ts +96 -0
- package/dist/browser/job.js +206 -0
- package/dist/browser/job.js.map +1 -0
- package/dist/browser/package.json +3 -0
- package/dist/browser/retry.d.ts +20 -0
- package/dist/browser/retry.js +19 -0
- package/dist/browser/retry.js.map +1 -0
- package/dist/browser/runLocalStorage.d.ts +8 -0
- package/dist/browser/runLocalStorage.js +3 -0
- package/dist/browser/runLocalStorage.js.map +1 -0
- package/dist/browser/security.d.ts +18 -0
- package/dist/browser/security.js +34 -0
- package/dist/browser/security.js.map +1 -0
- package/dist/browser/status.d.ts +19 -0
- package/dist/browser/status.js +34 -0
- package/dist/browser/status.js.map +1 -0
- package/dist/browser/store/keyValueStore.d.ts +17 -0
- package/dist/browser/store/keyValueStore.js +134 -0
- package/dist/browser/store/keyValueStore.js.map +1 -0
- package/dist/browser/store/keyValueStoreClient.d.ts +19 -0
- package/dist/browser/store/keyValueStoreClient.js +61 -0
- package/dist/browser/store/keyValueStoreClient.js.map +1 -0
- package/dist/browser/triggerClient.d.ts +300 -0
- package/dist/browser/triggerClient.js +1359 -0
- package/dist/browser/triggerClient.js.map +1 -0
- package/dist/browser/triggers/dynamic.d.ts +56 -0
- package/dist/browser/triggers/dynamic.js +93 -0
- package/dist/browser/triggers/dynamic.js.map +1 -0
- package/dist/browser/triggers/eventTrigger.d.ts +58 -0
- package/dist/browser/triggers/eventTrigger.js +64 -0
- package/dist/browser/triggers/eventTrigger.js.map +1 -0
- package/dist/browser/triggers/externalSource.d.ts +148 -0
- package/dist/browser/triggers/externalSource.js +100 -0
- package/dist/browser/triggers/externalSource.js.map +1 -0
- package/dist/browser/triggers/invokeTrigger.d.ts +39 -0
- package/dist/browser/triggers/invokeTrigger.js +53 -0
- package/dist/browser/triggers/invokeTrigger.js.map +1 -0
- package/dist/browser/triggers/notifications.d.ts +111 -0
- package/dist/browser/triggers/notifications.js +94 -0
- package/dist/browser/triggers/notifications.js.map +1 -0
- package/dist/browser/triggers/scheduled.d.ts +145 -0
- package/dist/browser/triggers/scheduled.js +197 -0
- package/dist/browser/triggers/scheduled.js.map +1 -0
- package/dist/browser/triggers/webhook.d.ts +143 -0
- package/dist/browser/triggers/webhook.js +128 -0
- package/dist/browser/triggers/webhook.js.map +1 -0
- package/dist/browser/typed-emitter.d.ts +37 -0
- package/dist/browser/typed-emitter.js +2 -0
- package/dist/browser/typed-emitter.js.map +1 -0
- package/dist/browser/types.d.ts +204 -0
- package/dist/browser/types.js +19 -0
- package/dist/browser/types.js.map +1 -0
- package/dist/browser/utils/formatSchemaErrors.d.ts +3 -0
- package/dist/browser/utils/formatSchemaErrors.js +7 -0
- package/dist/browser/utils/formatSchemaErrors.js.map +1 -0
- package/dist/browser/utils/typedAsyncLocalStorage.d.ts +6 -0
- package/dist/browser/utils/typedAsyncLocalStorage.js +14 -0
- package/dist/browser/utils/typedAsyncLocalStorage.js.map +1 -0
- package/dist/browser/utils.d.ts +1 -0
- package/dist/browser/utils.js +8 -0
- package/dist/browser/utils.js.map +1 -0
- package/dist/browser/v3/auth.d.ts +104 -0
- package/dist/browser/v3/auth.js +95 -0
- package/dist/browser/v3/auth.js.map +1 -0
- package/dist/browser/v3/cache.d.ts +28 -0
- package/dist/browser/v3/cache.js +58 -0
- package/dist/browser/v3/cache.js.map +1 -0
- package/dist/browser/v3/config.d.ts +4 -0
- package/dist/browser/v3/config.js +4 -0
- package/dist/browser/v3/config.js.map +1 -0
- package/dist/browser/v3/envvars.d.ts +14 -0
- package/dist/browser/v3/envvars.js +219 -0
- package/dist/browser/v3/envvars.js.map +1 -0
- package/dist/browser/v3/idempotencyKeys.d.ts +44 -0
- package/dist/browser/v3/idempotencyKeys.js +72 -0
- package/dist/browser/v3/idempotencyKeys.js.map +1 -0
- package/dist/browser/v3/index-browser.mjs.map +1 -0
- package/dist/browser/v3/index.d.ts +2 -0
- package/dist/browser/v3/index.js +3 -0
- package/dist/browser/v3/metadata.d.ts +87 -0
- package/dist/browser/v3/metadata.js +105 -0
- package/dist/browser/v3/metadata.js.map +1 -0
- package/dist/browser/v3/retry.d.ts +15 -0
- package/dist/browser/v3/retry.js +408 -0
- package/dist/browser/v3/retry.js.map +1 -0
- package/dist/browser/v3/runs.d.ts +180 -0
- package/dist/browser/v3/runs.js +204 -0
- package/dist/browser/v3/runs.js.map +1 -0
- package/dist/browser/v3/schedules/api.d.ts +1 -0
- package/dist/browser/v3/schedules/api.js +2 -0
- package/dist/browser/v3/schedules/api.js.map +1 -0
- package/dist/browser/v3/schedules/index.d.ts +87 -0
- package/dist/browser/v3/schedules/index.js +215 -0
- package/dist/browser/v3/schedules/index.js.map +1 -0
- package/dist/browser/v3/shared.d.ts +90 -0
- package/dist/browser/v3/shared.js +546 -0
- package/dist/browser/v3/shared.js.map +1 -0
- package/dist/browser/v3/tags.d.ts +6 -0
- package/dist/browser/v3/tags.js +43 -0
- package/dist/browser/v3/tags.js.map +1 -0
- package/dist/browser/v3/tasks.d.ts +31 -0
- package/dist/browser/v3/tasks.js +30 -0
- package/dist/browser/v3/tasks.js.map +1 -0
- package/dist/browser/v3/timeout.d.ts +4 -0
- package/dist/browser/v3/timeout.js +7 -0
- package/dist/browser/v3/timeout.js.map +1 -0
- package/dist/browser/v3/tracer.d.ts +2 -0
- package/dist/browser/v3/tracer.js +4 -0
- package/dist/browser/v3/tracer.js.map +1 -0
- package/dist/browser/v3/usage.d.ts +77 -0
- package/dist/browser/v3/usage.js +112 -0
- package/dist/browser/v3/usage.js.map +1 -0
- package/dist/browser/v3/wait.d.ts +22 -0
- package/dist/browser/v3/wait.js +96 -0
- package/dist/browser/v3/wait.js.map +1 -0
- package/dist/browser/version.d.ts +1 -0
- package/dist/browser/version.js +2 -0
- package/dist/browser/version.js.map +1 -0
- package/dist/commonjs/v3/auth.d.ts +104 -0
- package/dist/commonjs/v3/auth.js +99 -0
- package/dist/commonjs/v3/auth.js.map +1 -0
- package/dist/commonjs/v3/idempotencyKeys.d.ts +2 -7
- package/dist/commonjs/v3/idempotencyKeys.js.map +1 -1
- package/dist/commonjs/v3/index.d.ts +2 -19
- package/dist/commonjs/v3/index.js +16 -35
- package/dist/commonjs/v3/index.js.map +1 -1
- package/dist/commonjs/v3/metadata.d.ts +20 -12
- package/dist/commonjs/v3/metadata.js +28 -53
- package/dist/commonjs/v3/metadata.js.map +1 -1
- package/dist/commonjs/v3/runs.d.ts +36 -759
- package/dist/commonjs/v3/runs.js +12 -1
- package/dist/commonjs/v3/runs.js.map +1 -1
- package/dist/commonjs/v3/shared.d.ts +9 -380
- package/dist/commonjs/v3/shared.js +99 -54
- package/dist/commonjs/v3/shared.js.map +1 -1
- package/dist/commonjs/v3/tasks.d.ts +5 -5
- package/dist/commonjs/v3/tasks.js +3 -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/version.js +1 -1
- package/dist/esm/v3/auth.d.ts +104 -0
- package/dist/esm/v3/auth.js +95 -0
- package/dist/esm/v3/auth.js.map +1 -0
- package/dist/esm/v3/idempotencyKeys.d.ts +2 -7
- package/dist/esm/v3/idempotencyKeys.js.map +1 -1
- package/dist/esm/v3/index.d.ts +2 -19
- package/dist/esm/v3/index.js +2 -22
- package/dist/esm/v3/index.js.map +1 -1
- package/dist/esm/v3/metadata.d.ts +20 -12
- package/dist/esm/v3/metadata.js +29 -54
- package/dist/esm/v3/metadata.js.map +1 -1
- package/dist/esm/v3/runs.d.ts +34 -757
- package/dist/esm/v3/runs.js +12 -1
- package/dist/esm/v3/runs.js.map +1 -1
- package/dist/esm/v3/shared.d.ts +9 -380
- package/dist/esm/v3/shared.js +96 -51
- package/dist/esm/v3/shared.js.map +1 -1
- package/dist/esm/v3/tasks.d.ts +5 -5
- package/dist/esm/v3/tasks.js +3 -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/version.js +1 -1
- package/package.json +13 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"idempotencyKeys.js","sourceRoot":"","sources":["../../../src/v3/idempotencyKeys.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"idempotencyKeys.js","sourceRoot":"","sources":["../../../src/v3/idempotencyKeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAExE,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,MAAM,EAAE,oBAAoB;CAC7B,CAAC;AAIF,MAAM,UAAU,gBAAgB,CAC9B,KAAyC;IAEzC,gGAAgG;IAChG,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,KAAK,EAAE,CAAC;AAC1D,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,KAAK,UAAU,oBAAoB,CACjC,GAAsB,EACtB,OAAkD;IAElD,MAAM,cAAc,GAAG,MAAM,sBAAsB,CACjD,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,IAAI,KAAK,CAAC,CAAC,CACrF,CAAC;IAEF,OAAO,cAAgC,CAAC;AAC1C,CAAC;AAED,SAAS,WAAW,CAAC,KAAmC;IACtD,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,IAAI,WAAW,EAAE,GAAG,EAAE,CAAC;gBACrB,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAClC,CAAC;YACD,MAAM;QACR,CAAC;QACD,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,IAAI,WAAW,EAAE,GAAG,EAAE,CAAC;gBACrB,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACtC,CAAC;YACD,MAAM;QACR,CAAC;IACH,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,KAAK,UAAU,sBAAsB,CAAC,WAAqB;IACzD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CACrC,SAAS,EACT,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAChD,CAAC;IAEF,8DAA8D;IAC9D,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;SACpC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;SACjD,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC"}
|
package/dist/esm/v3/index.d.ts
CHANGED
|
@@ -14,25 +14,8 @@ import type { Context } from "./shared.js";
|
|
|
14
14
|
import type { ApiClientConfiguration } from "@trigger.dev/core/v3";
|
|
15
15
|
export type { ApiClientConfiguration };
|
|
16
16
|
export { ApiError, AuthenticationError, BadRequestError, ConflictError, InternalServerError, NotFoundError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, AbortTaskRunError, logger, type LogLevel, } from "@trigger.dev/core/v3";
|
|
17
|
-
export { runs } from "./runs.js";
|
|
17
|
+
export { runs, type RunShape, type AnyRunShape, type TaskRunShape, type RetrieveRunResult, type AnyRetrieveRunResult, } from "./runs.js";
|
|
18
18
|
export * as schedules from "./schedules/index.js";
|
|
19
19
|
export * as envvars from "./envvars.js";
|
|
20
20
|
export type { ImportEnvironmentVariablesParams } from "./envvars.js";
|
|
21
|
-
|
|
22
|
-
* Register the global API client configuration. Alternatively, you can set the `TRIGGER_SECRET_KEY` and `TRIGGER_API_URL` environment variables.
|
|
23
|
-
* @param options The API client configuration.
|
|
24
|
-
* @param options.baseURL The base URL of the Trigger API. (default: `https://api.trigger.dev`)
|
|
25
|
-
* @param options.secretKey The secret key to authenticate with the Trigger API. (default: `process.env.TRIGGER_SECRET_KEY`) This can be found in your Trigger.dev project "API Keys" settings.
|
|
26
|
-
*
|
|
27
|
-
* @example
|
|
28
|
-
*
|
|
29
|
-
* ```typescript
|
|
30
|
-
* import { configure } from "@trigger.dev/sdk/v3";
|
|
31
|
-
*
|
|
32
|
-
* configure({
|
|
33
|
-
* baseURL: "https://api.trigger.dev",
|
|
34
|
-
* secretKey: "tr_dev_1234567890"
|
|
35
|
-
* });
|
|
36
|
-
* ```
|
|
37
|
-
*/
|
|
38
|
-
export declare function configure(options: ApiClientConfiguration): void;
|
|
21
|
+
export { configure, auth } from "./auth.js";
|
package/dist/esm/v3/index.js
CHANGED
|
@@ -9,29 +9,9 @@ export * from "./idempotencyKeys.js";
|
|
|
9
9
|
export * from "./tags.js";
|
|
10
10
|
export * from "./metadata.js";
|
|
11
11
|
export * from "./timeout.js";
|
|
12
|
-
import { apiClientManager } from "@trigger.dev/core/v3";
|
|
13
12
|
export { ApiError, AuthenticationError, BadRequestError, ConflictError, InternalServerError, NotFoundError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, AbortTaskRunError, logger, } from "@trigger.dev/core/v3";
|
|
14
|
-
export { runs } from "./runs.js";
|
|
13
|
+
export { runs, } from "./runs.js";
|
|
15
14
|
export * as schedules from "./schedules/index.js";
|
|
16
15
|
export * as envvars from "./envvars.js";
|
|
17
|
-
|
|
18
|
-
* Register the global API client configuration. Alternatively, you can set the `TRIGGER_SECRET_KEY` and `TRIGGER_API_URL` environment variables.
|
|
19
|
-
* @param options The API client configuration.
|
|
20
|
-
* @param options.baseURL The base URL of the Trigger API. (default: `https://api.trigger.dev`)
|
|
21
|
-
* @param options.secretKey The secret key to authenticate with the Trigger API. (default: `process.env.TRIGGER_SECRET_KEY`) This can be found in your Trigger.dev project "API Keys" settings.
|
|
22
|
-
*
|
|
23
|
-
* @example
|
|
24
|
-
*
|
|
25
|
-
* ```typescript
|
|
26
|
-
* import { configure } from "@trigger.dev/sdk/v3";
|
|
27
|
-
*
|
|
28
|
-
* configure({
|
|
29
|
-
* baseURL: "https://api.trigger.dev",
|
|
30
|
-
* secretKey: "tr_dev_1234567890"
|
|
31
|
-
* });
|
|
32
|
-
* ```
|
|
33
|
-
*/
|
|
34
|
-
export function configure(options) {
|
|
35
|
-
apiClientManager.setGlobalAPIClientConfiguration(options);
|
|
36
|
-
}
|
|
16
|
+
export { configure, auth } from "./auth.js";
|
|
37
17
|
//# sourceMappingURL=index.js.map
|
package/dist/esm/v3/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v3/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,KAAK,EAAqB,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v3/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,KAAK,EAAqB,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAS7B,OAAO,EACL,QAAQ,EACR,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,qBAAqB,EACrB,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EACjB,MAAM,GAEP,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,IAAI,GAML,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AAGxC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC"}
|
|
@@ -15,6 +15,8 @@ export declare const metadata: {
|
|
|
15
15
|
set: typeof setMetadataKey;
|
|
16
16
|
del: typeof deleteMetadataKey;
|
|
17
17
|
save: typeof saveMetadata;
|
|
18
|
+
replace: typeof replaceMetadata;
|
|
19
|
+
flush: typeof flushMetadata;
|
|
18
20
|
};
|
|
19
21
|
export type RunMetadata = Record<string, DeserializedJson>;
|
|
20
22
|
/**
|
|
@@ -46,34 +48,40 @@ declare function getMetadataKey(key: string): DeserializedJson | undefined;
|
|
|
46
48
|
*
|
|
47
49
|
* @param {string} key - The key to set in the metadata.
|
|
48
50
|
* @param {DeserializedJson} value - The value to associate with the key.
|
|
49
|
-
* @param {ApiRequestOptions} [requestOptions] - Optional API request options.
|
|
50
|
-
* @returns {Promise<void>} A promise that resolves when the metadata is updated.
|
|
51
51
|
*
|
|
52
52
|
* @example
|
|
53
|
-
*
|
|
53
|
+
* metadata.set("progress", 0.5);
|
|
54
54
|
*/
|
|
55
|
-
declare function setMetadataKey(key: string, value: DeserializedJson
|
|
55
|
+
declare function setMetadataKey(key: string, value: DeserializedJson): void;
|
|
56
56
|
/**
|
|
57
57
|
* Delete a key from the metadata of the current run if inside a task run.
|
|
58
58
|
*
|
|
59
59
|
* @param {string} key - The key to delete from the metadata.
|
|
60
|
-
* @param {ApiRequestOptions} [requestOptions] - Optional API request options.
|
|
61
|
-
* @returns {Promise<void>} A promise that resolves when the key is deleted from the metadata.
|
|
62
60
|
*
|
|
63
61
|
* @example
|
|
64
|
-
*
|
|
62
|
+
* metadata.del("progress");
|
|
65
63
|
*/
|
|
66
|
-
declare function deleteMetadataKey(key: string
|
|
64
|
+
declare function deleteMetadataKey(key: string): void;
|
|
67
65
|
/**
|
|
68
66
|
* Update the entire metadata object for the current run if inside a task run.
|
|
69
67
|
* This function allows you to replace the entire metadata object with a new one.
|
|
70
68
|
*
|
|
71
69
|
* @param {RunMetadata} metadata - The new metadata object to set for the run.
|
|
72
|
-
* @
|
|
73
|
-
* @returns {Promise<void>} A promise that resolves when the metadata is updated.
|
|
70
|
+
* @returns {void}
|
|
74
71
|
*
|
|
75
72
|
* @example
|
|
76
|
-
*
|
|
73
|
+
* metadata.replace({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
|
|
77
74
|
*/
|
|
78
|
-
declare function
|
|
75
|
+
declare function replaceMetadata(metadata: RunMetadata): void;
|
|
76
|
+
/**
|
|
77
|
+
* @deprecated Use `metadata.replace()` instead.
|
|
78
|
+
*/
|
|
79
|
+
declare function saveMetadata(metadata: RunMetadata): void;
|
|
80
|
+
/**
|
|
81
|
+
* Flushes metadata to the Trigger.dev instance
|
|
82
|
+
*
|
|
83
|
+
* @param {ApiRequestOptions} [requestOptions] - Optional request options to customize the API request.
|
|
84
|
+
* @returns {Promise<void>} A promise that resolves when the metadata flush operation is complete.
|
|
85
|
+
*/
|
|
86
|
+
declare function flushMetadata(requestOptions?: ApiRequestOptions): Promise<void>;
|
|
79
87
|
export {};
|
package/dist/esm/v3/metadata.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { mergeRequestOptions, runMetadata, } from "@trigger.dev/core/v3";
|
|
2
2
|
import { tracer } from "./tracer.js";
|
|
3
3
|
/**
|
|
4
4
|
* Provides access to run metadata operations.
|
|
@@ -15,6 +15,8 @@ export const metadata = {
|
|
|
15
15
|
set: setMetadataKey,
|
|
16
16
|
del: deleteMetadataKey,
|
|
17
17
|
save: saveMetadata,
|
|
18
|
+
replace: replaceMetadata,
|
|
19
|
+
flush: flushMetadata,
|
|
18
20
|
};
|
|
19
21
|
/**
|
|
20
22
|
* Returns the metadata of the current run if inside a task run.
|
|
@@ -49,82 +51,55 @@ function getMetadataKey(key) {
|
|
|
49
51
|
*
|
|
50
52
|
* @param {string} key - The key to set in the metadata.
|
|
51
53
|
* @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
54
|
*
|
|
55
55
|
* @example
|
|
56
|
-
*
|
|
56
|
+
* metadata.set("progress", 0.5);
|
|
57
57
|
*/
|
|
58
|
-
|
|
59
|
-
|
|
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);
|
|
58
|
+
function setMetadataKey(key, value) {
|
|
59
|
+
runMetadata.setKey(key, value);
|
|
77
60
|
}
|
|
78
61
|
/**
|
|
79
62
|
* Delete a key from the metadata of the current run if inside a task run.
|
|
80
63
|
*
|
|
81
64
|
* @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
65
|
*
|
|
85
66
|
* @example
|
|
86
|
-
*
|
|
67
|
+
* metadata.del("progress");
|
|
87
68
|
*/
|
|
88
|
-
|
|
89
|
-
|
|
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);
|
|
69
|
+
function deleteMetadataKey(key) {
|
|
70
|
+
runMetadata.deleteKey(key);
|
|
107
71
|
}
|
|
108
72
|
/**
|
|
109
73
|
* Update the entire metadata object for the current run if inside a task run.
|
|
110
74
|
* This function allows you to replace the entire metadata object with a new one.
|
|
111
75
|
*
|
|
112
76
|
* @param {RunMetadata} metadata - The new metadata object to set for the run.
|
|
113
|
-
* @
|
|
114
|
-
* @returns {Promise<void>} A promise that resolves when the metadata is updated.
|
|
77
|
+
* @returns {void}
|
|
115
78
|
*
|
|
116
79
|
* @example
|
|
117
|
-
*
|
|
80
|
+
* metadata.replace({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
|
|
81
|
+
*/
|
|
82
|
+
function replaceMetadata(metadata) {
|
|
83
|
+
runMetadata.update(metadata);
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* @deprecated Use `metadata.replace()` instead.
|
|
87
|
+
*/
|
|
88
|
+
function saveMetadata(metadata) {
|
|
89
|
+
runMetadata.update(metadata);
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* Flushes metadata to the Trigger.dev instance
|
|
93
|
+
*
|
|
94
|
+
* @param {ApiRequestOptions} [requestOptions] - Optional request options to customize the API request.
|
|
95
|
+
* @returns {Promise<void>} A promise that resolves when the metadata flush operation is complete.
|
|
118
96
|
*/
|
|
119
|
-
async function
|
|
97
|
+
async function flushMetadata(requestOptions) {
|
|
120
98
|
const $requestOptions = mergeRequestOptions({
|
|
121
99
|
tracer,
|
|
122
|
-
name: "metadata.
|
|
100
|
+
name: "metadata.flush()",
|
|
123
101
|
icon: "code-plus",
|
|
124
|
-
attributes: {
|
|
125
|
-
...flattenAttributes(metadata),
|
|
126
|
-
},
|
|
127
102
|
}, requestOptions);
|
|
128
|
-
await runMetadata.
|
|
103
|
+
await runMetadata.flush($requestOptions);
|
|
129
104
|
}
|
|
130
105
|
//# sourceMappingURL=metadata.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/v3/metadata.ts"],"names":[],"mappings":"AACA,OAAO,
|
|
1
|
+
{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/v3/metadata.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,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;IAClB,OAAO,EAAE,eAAe;IACxB,KAAK,EAAE,aAAa;CACrB,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;;;;;;;;;GASG;AACH,SAAS,cAAc,CAAC,GAAW,EAAE,KAAuB;IAC1D,WAAW,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,iBAAiB,CAAC,GAAW;IACpC,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,eAAe,CAAC,QAAqB;IAC5C,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CAAC,QAAqB;IACzC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,aAAa,CAAC,cAAkC;IAC7D,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,WAAW;KAClB,EACD,cAAc,CACf,CAAC;IAEF,MAAM,WAAW,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;AAC3C,CAAC"}
|