@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.
Files changed (199) hide show
  1. package/dist/commonjs/triggers/invokeTrigger.d.ts +1 -1
  2. package/dist/commonjs/types.d.ts +4 -4
  3. package/dist/commonjs/v3/auth.d.ts +104 -0
  4. package/dist/commonjs/v3/auth.js +102 -0
  5. package/dist/commonjs/v3/auth.js.map +1 -0
  6. package/dist/commonjs/v3/idempotencyKeys.d.ts +2 -46
  7. package/dist/commonjs/v3/idempotencyKeys.js +1 -69
  8. package/dist/commonjs/v3/idempotencyKeys.js.map +1 -1
  9. package/dist/commonjs/v3/index.d.ts +4 -19
  10. package/dist/commonjs/v3/index.js +18 -35
  11. package/dist/commonjs/v3/index.js.map +1 -1
  12. package/dist/commonjs/v3/metadata.d.ts +75 -12
  13. package/dist/commonjs/v3/metadata.js +93 -53
  14. package/dist/commonjs/v3/metadata.js.map +1 -1
  15. package/dist/commonjs/v3/runs.d.ts +33 -756
  16. package/dist/commonjs/v3/runs.js +12 -1
  17. package/dist/commonjs/v3/runs.js.map +1 -1
  18. package/dist/commonjs/v3/shared.d.ts +10 -380
  19. package/dist/commonjs/v3/shared.js +125 -68
  20. package/dist/commonjs/v3/shared.js.map +1 -1
  21. package/dist/commonjs/v3/tasks.d.ts +6 -5
  22. package/dist/commonjs/v3/tasks.js +4 -5
  23. package/dist/commonjs/v3/tasks.js.map +1 -1
  24. package/dist/commonjs/v3/tracer.d.ts +1 -1
  25. package/dist/commonjs/v3/tracer.js +2 -2
  26. package/dist/commonjs/v3/tracer.js.map +1 -1
  27. package/dist/commonjs/v3/waitUntil.d.ts +9 -0
  28. package/dist/commonjs/v3/waitUntil.js +16 -0
  29. package/dist/commonjs/v3/waitUntil.js.map +1 -0
  30. package/dist/commonjs/version.js +1 -1
  31. package/dist/esm/v3/auth.d.ts +104 -0
  32. package/dist/esm/v3/auth.js +98 -0
  33. package/dist/esm/v3/auth.js.map +1 -0
  34. package/dist/esm/v3/idempotencyKeys.d.ts +2 -46
  35. package/dist/esm/v3/idempotencyKeys.js +1 -68
  36. package/dist/esm/v3/idempotencyKeys.js.map +1 -1
  37. package/dist/esm/v3/index-browser.d.mts +2 -0
  38. package/dist/esm/v3/index-browser.mjs +3 -0
  39. package/dist/esm/v3/index.d.ts +4 -19
  40. package/dist/esm/v3/index.js +4 -22
  41. package/dist/esm/v3/index.js.map +1 -1
  42. package/dist/esm/v3/metadata.d.ts +75 -12
  43. package/dist/esm/v3/metadata.js +94 -54
  44. package/dist/esm/v3/metadata.js.map +1 -1
  45. package/dist/esm/v3/runs.d.ts +61 -784
  46. package/dist/esm/v3/runs.js +12 -1
  47. package/dist/esm/v3/runs.js.map +1 -1
  48. package/dist/esm/v3/shared.d.ts +10 -380
  49. package/dist/esm/v3/shared.js +121 -65
  50. package/dist/esm/v3/shared.js.map +1 -1
  51. package/dist/esm/v3/tasks.d.ts +6 -5
  52. package/dist/esm/v3/tasks.js +4 -4
  53. package/dist/esm/v3/tasks.js.map +1 -1
  54. package/dist/esm/v3/tracer.d.ts +1 -1
  55. package/dist/esm/v3/tracer.js +1 -1
  56. package/dist/esm/v3/tracer.js.map +1 -1
  57. package/dist/esm/v3/waitUntil.d.ts +9 -0
  58. package/dist/esm/v3/waitUntil.js +13 -0
  59. package/dist/esm/v3/waitUntil.js.map +1 -0
  60. package/dist/esm/version.js +1 -1
  61. package/package.json +9 -5
  62. package/dist/browser/apiClient.d.ts +0 -737
  63. package/dist/browser/apiClient.js +0 -687
  64. package/dist/browser/apiClient.js.map +0 -1
  65. package/dist/browser/concurrencyLimit.d.ts +0 -10
  66. package/dist/browser/concurrencyLimit.js +0 -13
  67. package/dist/browser/concurrencyLimit.js.map +0 -1
  68. package/dist/browser/errors.d.ts +0 -66
  69. package/dist/browser/errors.js +0 -95
  70. package/dist/browser/errors.js.map +0 -1
  71. package/dist/browser/httpEndpoint.d.ts +0 -87
  72. package/dist/browser/httpEndpoint.js +0 -125
  73. package/dist/browser/httpEndpoint.js.map +0 -1
  74. package/dist/browser/index.d.ts +0 -23
  75. package/dist/browser/index.js +0 -35
  76. package/dist/browser/index.js.map +0 -1
  77. package/dist/browser/integrations.d.ts +0 -11
  78. package/dist/browser/integrations.js +0 -2
  79. package/dist/browser/integrations.js.map +0 -1
  80. package/dist/browser/io.d.ts +0 -453
  81. package/dist/browser/io.js +0 -1159
  82. package/dist/browser/io.js.map +0 -1
  83. package/dist/browser/ioWithIntegrations.d.ts +0 -4
  84. package/dist/browser/ioWithIntegrations.js +0 -29
  85. package/dist/browser/ioWithIntegrations.js.map +0 -1
  86. package/dist/browser/job.d.ts +0 -96
  87. package/dist/browser/job.js +0 -206
  88. package/dist/browser/job.js.map +0 -1
  89. package/dist/browser/retry.d.ts +0 -20
  90. package/dist/browser/retry.js +0 -19
  91. package/dist/browser/retry.js.map +0 -1
  92. package/dist/browser/runLocalStorage.d.ts +0 -8
  93. package/dist/browser/runLocalStorage.js +0 -3
  94. package/dist/browser/runLocalStorage.js.map +0 -1
  95. package/dist/browser/security.d.ts +0 -18
  96. package/dist/browser/security.js +0 -34
  97. package/dist/browser/security.js.map +0 -1
  98. package/dist/browser/status.d.ts +0 -19
  99. package/dist/browser/status.js +0 -34
  100. package/dist/browser/status.js.map +0 -1
  101. package/dist/browser/store/keyValueStore.d.ts +0 -17
  102. package/dist/browser/store/keyValueStore.js +0 -134
  103. package/dist/browser/store/keyValueStore.js.map +0 -1
  104. package/dist/browser/store/keyValueStoreClient.d.ts +0 -19
  105. package/dist/browser/store/keyValueStoreClient.js +0 -61
  106. package/dist/browser/store/keyValueStoreClient.js.map +0 -1
  107. package/dist/browser/triggerClient.d.ts +0 -300
  108. package/dist/browser/triggerClient.js +0 -1359
  109. package/dist/browser/triggerClient.js.map +0 -1
  110. package/dist/browser/triggers/dynamic.d.ts +0 -56
  111. package/dist/browser/triggers/dynamic.js +0 -93
  112. package/dist/browser/triggers/dynamic.js.map +0 -1
  113. package/dist/browser/triggers/eventTrigger.d.ts +0 -58
  114. package/dist/browser/triggers/eventTrigger.js +0 -64
  115. package/dist/browser/triggers/eventTrigger.js.map +0 -1
  116. package/dist/browser/triggers/externalSource.d.ts +0 -148
  117. package/dist/browser/triggers/externalSource.js +0 -100
  118. package/dist/browser/triggers/externalSource.js.map +0 -1
  119. package/dist/browser/triggers/invokeTrigger.d.ts +0 -39
  120. package/dist/browser/triggers/invokeTrigger.js +0 -53
  121. package/dist/browser/triggers/invokeTrigger.js.map +0 -1
  122. package/dist/browser/triggers/notifications.d.ts +0 -111
  123. package/dist/browser/triggers/notifications.js +0 -94
  124. package/dist/browser/triggers/notifications.js.map +0 -1
  125. package/dist/browser/triggers/scheduled.d.ts +0 -145
  126. package/dist/browser/triggers/scheduled.js +0 -197
  127. package/dist/browser/triggers/scheduled.js.map +0 -1
  128. package/dist/browser/triggers/webhook.d.ts +0 -143
  129. package/dist/browser/triggers/webhook.js +0 -128
  130. package/dist/browser/triggers/webhook.js.map +0 -1
  131. package/dist/browser/typed-emitter.d.ts +0 -37
  132. package/dist/browser/typed-emitter.js +0 -2
  133. package/dist/browser/typed-emitter.js.map +0 -1
  134. package/dist/browser/types.d.ts +0 -204
  135. package/dist/browser/types.js +0 -19
  136. package/dist/browser/types.js.map +0 -1
  137. package/dist/browser/utils/formatSchemaErrors.d.ts +0 -3
  138. package/dist/browser/utils/formatSchemaErrors.js +0 -7
  139. package/dist/browser/utils/formatSchemaErrors.js.map +0 -1
  140. package/dist/browser/utils/typedAsyncLocalStorage.d.ts +0 -6
  141. package/dist/browser/utils/typedAsyncLocalStorage.js +0 -14
  142. package/dist/browser/utils/typedAsyncLocalStorage.js.map +0 -1
  143. package/dist/browser/utils.d.ts +0 -1
  144. package/dist/browser/utils.js +0 -8
  145. package/dist/browser/utils.js.map +0 -1
  146. package/dist/browser/v3/cache.d.ts +0 -28
  147. package/dist/browser/v3/cache.js +0 -58
  148. package/dist/browser/v3/cache.js.map +0 -1
  149. package/dist/browser/v3/config.d.ts +0 -4
  150. package/dist/browser/v3/config.js +0 -4
  151. package/dist/browser/v3/config.js.map +0 -1
  152. package/dist/browser/v3/envvars.d.ts +0 -14
  153. package/dist/browser/v3/envvars.js +0 -219
  154. package/dist/browser/v3/envvars.js.map +0 -1
  155. package/dist/browser/v3/idempotencyKeys.d.ts +0 -44
  156. package/dist/browser/v3/idempotencyKeys.js +0 -72
  157. package/dist/browser/v3/idempotencyKeys.js.map +0 -1
  158. package/dist/browser/v3/index.d.ts +0 -21
  159. package/dist/browser/v3/index.js +0 -17
  160. package/dist/browser/v3/metadata.d.ts +0 -87
  161. package/dist/browser/v3/metadata.js +0 -105
  162. package/dist/browser/v3/metadata.js.map +0 -1
  163. package/dist/browser/v3/retry.d.ts +0 -15
  164. package/dist/browser/v3/retry.js +0 -408
  165. package/dist/browser/v3/retry.js.map +0 -1
  166. package/dist/browser/v3/runs.d.ts +0 -180
  167. package/dist/browser/v3/runs.js +0 -204
  168. package/dist/browser/v3/runs.js.map +0 -1
  169. package/dist/browser/v3/schedules/api.d.ts +0 -1
  170. package/dist/browser/v3/schedules/api.js +0 -2
  171. package/dist/browser/v3/schedules/api.js.map +0 -1
  172. package/dist/browser/v3/schedules/index.d.ts +0 -87
  173. package/dist/browser/v3/schedules/index.js +0 -215
  174. package/dist/browser/v3/schedules/index.js.map +0 -1
  175. package/dist/browser/v3/shared.d.ts +0 -90
  176. package/dist/browser/v3/shared.js +0 -546
  177. package/dist/browser/v3/shared.js.map +0 -1
  178. package/dist/browser/v3/tags.d.ts +0 -6
  179. package/dist/browser/v3/tags.js +0 -43
  180. package/dist/browser/v3/tags.js.map +0 -1
  181. package/dist/browser/v3/tasks.d.ts +0 -31
  182. package/dist/browser/v3/tasks.js +0 -30
  183. package/dist/browser/v3/tasks.js.map +0 -1
  184. package/dist/browser/v3/timeout.d.ts +0 -4
  185. package/dist/browser/v3/timeout.js +0 -7
  186. package/dist/browser/v3/timeout.js.map +0 -1
  187. package/dist/browser/v3/tracer.d.ts +0 -2
  188. package/dist/browser/v3/tracer.js +0 -4
  189. package/dist/browser/v3/tracer.js.map +0 -1
  190. package/dist/browser/v3/usage.d.ts +0 -77
  191. package/dist/browser/v3/usage.js +0 -112
  192. package/dist/browser/v3/usage.js.map +0 -1
  193. package/dist/browser/v3/wait.d.ts +0 -22
  194. package/dist/browser/v3/wait.js +0 -96
  195. package/dist/browser/v3/wait.js.map +0 -1
  196. package/dist/browser/version.d.ts +0 -1
  197. package/dist/browser/version.js +0 -2
  198. package/dist/browser/version.js.map +0 -1
  199. /package/dist/{browser → esm}/v3/index-browser.mjs.map +0 -0
@@ -1,58 +0,0 @@
1
- import { SemanticInternalAttributes } from "@trigger.dev/core/v3";
2
- import { tracer } from "./tracer.js";
3
- export class InMemoryCache {
4
- _cache = new Map();
5
- get(key) {
6
- return this._cache.get(key);
7
- }
8
- set(key, value) {
9
- this._cache.set(key, value);
10
- return undefined;
11
- }
12
- delete(key) {
13
- this._cache.delete(key);
14
- return undefined;
15
- }
16
- }
17
- /**
18
- * Create a cache function that uses the provided store to cache values. Using InMemoryCache is safe because each task run is isolated.
19
- * @param store
20
- * @returns
21
- */
22
- export function createCache(store) {
23
- return function cache(cacheKey, fn) {
24
- return tracer.startActiveSpan("cache", async (span) => {
25
- span.setAttribute("cache.key", cacheKey);
26
- span.setAttribute(SemanticInternalAttributes.STYLE_ICON, "device-sd-card");
27
- const cacheEntry = await store.get(cacheKey);
28
- if (cacheEntry) {
29
- span.updateName(`cache.hit ${cacheKey}`);
30
- return cacheEntry.value;
31
- }
32
- span.updateName(`cache.miss ${cacheKey}`);
33
- const value = await tracer.startActiveSpan("cache.getFreshValue", async (span) => {
34
- return await fn();
35
- }, {
36
- attributes: {
37
- "cache.key": cacheKey,
38
- [SemanticInternalAttributes.STYLE_ICON]: "device-sd-card",
39
- },
40
- });
41
- await tracer.startActiveSpan("cache.set", async (span) => {
42
- await store.set(cacheKey, {
43
- value,
44
- metadata: {
45
- createdTime: Date.now(),
46
- },
47
- });
48
- }, {
49
- attributes: {
50
- "cache.key": cacheKey,
51
- [SemanticInternalAttributes.STYLE_ICON]: "device-sd-card",
52
- },
53
- });
54
- return value;
55
- });
56
- };
57
- }
58
- //# sourceMappingURL=cache.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"cache.js","sourceRoot":"","sources":["../../../src/v3/cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AA0BrC,MAAM,OAAO,aAAa;IAChB,MAAM,GAAmC,IAAI,GAAG,EAAE,CAAC;IAE3D,GAAG,CAAC,GAAW;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED,GAAG,CAAC,GAAW,EAAE,KAAwB;QACvC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAE5B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,GAAW;QAChB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAExB,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,KAAiB;IAC3C,OAAO,SAAS,KAAK,CACnB,QAAgB,EAChB,EAAgC;QAEhC,OAAO,MAAM,CAAC,eAAe,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACpD,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YACzC,IAAI,CAAC,YAAY,CAAC,0BAA0B,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;YAE3E,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAE7C,IAAI,UAAU,EAAE,CAAC;gBACf,IAAI,CAAC,UAAU,CAAC,aAAa,QAAQ,EAAE,CAAC,CAAC;gBAEzC,OAAO,UAAU,CAAC,KAAK,CAAC;YAC1B,CAAC;YAED,IAAI,CAAC,UAAU,CAAC,cAAc,QAAQ,EAAE,CAAC,CAAC;YAE1C,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,eAAe,CACxC,qBAAqB,EACrB,KAAK,EAAE,IAAI,EAAE,EAAE;gBACb,OAAO,MAAM,EAAE,EAAE,CAAC;YACpB,CAAC,EACD;gBACE,UAAU,EAAE;oBACV,WAAW,EAAE,QAAQ;oBACrB,CAAC,0BAA0B,CAAC,UAAU,CAAC,EAAE,gBAAgB;iBAC1D;aACF,CACF,CAAC;YAEF,MAAM,MAAM,CAAC,eAAe,CAC1B,WAAW,EACX,KAAK,EAAE,IAAI,EAAE,EAAE;gBACb,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE;oBACxB,KAAK;oBACL,QAAQ,EAAE;wBACR,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE;qBACxB;iBACF,CAAC,CAAC;YACL,CAAC,EACD;gBACE,UAAU,EAAE;oBACV,WAAW,EAAE,QAAQ;oBACrB,CAAC,0BAA0B,CAAC,UAAU,CAAC,EAAE,gBAAgB;iBAC1D;aACF,CACF,CAAC;YAEF,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC"}
@@ -1,4 +0,0 @@
1
- import type { TriggerConfig } from "@trigger.dev/core/v3";
2
- export type { HandleErrorArgs, HandleErrorFunction, ResolveEnvironmentVariablesFunction, ResolveEnvironmentVariablesParams, ResolveEnvironmentVariablesResult, } from "@trigger.dev/core/v3";
3
- export declare function defineConfig(config: TriggerConfig): TriggerConfig;
4
- export type { TriggerConfig };
@@ -1,4 +0,0 @@
1
- export function defineConfig(config) {
2
- return config;
3
- }
4
- //# sourceMappingURL=config.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/v3/config.ts"],"names":[],"mappings":"AAUA,MAAM,UAAU,YAAY,CAAC,MAAqB;IAChD,OAAO,MAAM,CAAC;AAChB,CAAC"}
@@ -1,14 +0,0 @@
1
- import type { ApiPromise, ApiRequestOptions, CreateEnvironmentVariableParams, EnvironmentVariableResponseBody, EnvironmentVariableValue, EnvironmentVariables, ImportEnvironmentVariablesParams, UpdateEnvironmentVariableParams } from "@trigger.dev/core/v3";
2
- export type { CreateEnvironmentVariableParams, ImportEnvironmentVariablesParams };
3
- export declare function upload(projectRef: string, slug: string, params: ImportEnvironmentVariablesParams, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
4
- export declare function upload(params: ImportEnvironmentVariablesParams, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
5
- export declare function list(projectRef: string, slug: string, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariables>;
6
- export declare function list(requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariables>;
7
- export declare function create(projectRef: string, slug: string, params: CreateEnvironmentVariableParams, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
8
- export declare function create(params: CreateEnvironmentVariableParams, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
9
- export declare function retrieve(projectRef: string, slug: string, name: string, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableValue>;
10
- export declare function retrieve(name: string, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableValue>;
11
- export declare function del(projectRef: string, slug: string, name: string, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
12
- export declare function del(name: string, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
13
- export declare function update(projectRef: string, slug: string, name: string, params: UpdateEnvironmentVariableParams, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
14
- export declare function update(name: string, params: UpdateEnvironmentVariableParams, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
@@ -1,219 +0,0 @@
1
- import { apiClientManager, isRequestOptions, mergeRequestOptions, taskContext, } from "@trigger.dev/core/v3";
2
- import { tracer } from "./tracer.js";
3
- export function upload(projectRefOrParams, slugOrRequestOptions, params, requestOptions) {
4
- let $projectRef;
5
- let $params;
6
- let $slug;
7
- const $requestOptions = overloadRequestOptions("upload", slugOrRequestOptions, requestOptions);
8
- if (taskContext.ctx) {
9
- if (typeof projectRefOrParams === "string") {
10
- $projectRef = projectRefOrParams;
11
- $slug =
12
- typeof slugOrRequestOptions === "string"
13
- ? slugOrRequestOptions
14
- : taskContext.ctx.environment.slug;
15
- if (!params) {
16
- throw new Error("params is required");
17
- }
18
- $params = params;
19
- }
20
- else {
21
- $params = projectRefOrParams;
22
- $projectRef = taskContext.ctx.project.ref;
23
- $slug = taskContext.ctx.environment.slug;
24
- }
25
- }
26
- else {
27
- if (typeof projectRefOrParams !== "string") {
28
- throw new Error("projectRef is required");
29
- }
30
- if (!slugOrRequestOptions || typeof slugOrRequestOptions !== "string") {
31
- throw new Error("slug is required");
32
- }
33
- if (!params) {
34
- throw new Error("params is required");
35
- }
36
- $projectRef = projectRefOrParams;
37
- $slug = slugOrRequestOptions;
38
- $params = params;
39
- }
40
- const apiClient = apiClientManager.clientOrThrow();
41
- return apiClient.importEnvVars($projectRef, $slug, $params, $requestOptions);
42
- }
43
- export function list(projectRefOrRequestOptions, slug, requestOptions) {
44
- const $projectRef = !isRequestOptions(projectRefOrRequestOptions)
45
- ? projectRefOrRequestOptions
46
- : taskContext.ctx?.project.ref;
47
- const $slug = slug ?? taskContext.ctx?.environment.slug;
48
- let $requestOptions = isRequestOptions(projectRefOrRequestOptions)
49
- ? projectRefOrRequestOptions
50
- : requestOptions;
51
- if (!$projectRef) {
52
- throw new Error("projectRef is required");
53
- }
54
- if (!$slug) {
55
- throw new Error("slug is required");
56
- }
57
- $requestOptions = mergeRequestOptions({
58
- tracer,
59
- name: "envvars.list()",
60
- icon: "id-badge",
61
- }, $requestOptions);
62
- const apiClient = apiClientManager.clientOrThrow();
63
- return apiClient.listEnvVars($projectRef, $slug, $requestOptions);
64
- }
65
- export function create(projectRefOrParams, slugOrRequestOptions, params, requestOptions) {
66
- let $projectRef;
67
- let $slug;
68
- let $params;
69
- const $requestOptions = overloadRequestOptions("create", slugOrRequestOptions, requestOptions);
70
- if (taskContext.ctx) {
71
- if (typeof projectRefOrParams === "string") {
72
- $projectRef = projectRefOrParams;
73
- $slug =
74
- typeof slugOrRequestOptions === "string"
75
- ? slugOrRequestOptions
76
- : taskContext.ctx.environment.slug;
77
- if (!params) {
78
- throw new Error("params is required");
79
- }
80
- $params = params;
81
- }
82
- else {
83
- $params = projectRefOrParams;
84
- $projectRef = taskContext.ctx.project.ref;
85
- $slug = taskContext.ctx.environment.slug;
86
- }
87
- }
88
- else {
89
- if (typeof projectRefOrParams !== "string") {
90
- throw new Error("projectRef is required");
91
- }
92
- if (!slugOrRequestOptions || typeof slugOrRequestOptions !== "string") {
93
- throw new Error("slug is required");
94
- }
95
- if (!params) {
96
- throw new Error("params is required");
97
- }
98
- $projectRef = projectRefOrParams;
99
- $slug = slugOrRequestOptions;
100
- $params = params;
101
- }
102
- const apiClient = apiClientManager.clientOrThrow();
103
- return apiClient.createEnvVar($projectRef, $slug, $params, $requestOptions);
104
- }
105
- export function retrieve(projectRefOrName, slugOrRequestOptions, name, requestOptions) {
106
- let $projectRef;
107
- let $slug;
108
- let $name;
109
- const $requestOptions = overloadRequestOptions("retrieve", slugOrRequestOptions, requestOptions);
110
- if (typeof name === "string") {
111
- $projectRef = projectRefOrName;
112
- $slug =
113
- typeof slugOrRequestOptions === "string"
114
- ? slugOrRequestOptions
115
- : taskContext.ctx?.environment.slug;
116
- $name = name;
117
- }
118
- else {
119
- $projectRef = taskContext.ctx?.project.ref;
120
- $slug = taskContext.ctx?.environment.slug;
121
- $name = projectRefOrName;
122
- }
123
- if (!$projectRef) {
124
- throw new Error("projectRef is required");
125
- }
126
- if (!$slug) {
127
- throw new Error("slug is required");
128
- }
129
- const apiClient = apiClientManager.clientOrThrow();
130
- return apiClient.retrieveEnvVar($projectRef, $slug, $name, $requestOptions);
131
- }
132
- export function del(projectRefOrName, slugOrRequestOptions, name, requestOptions) {
133
- let $projectRef;
134
- let $slug;
135
- let $name;
136
- const $requestOptions = overloadRequestOptions("del", slugOrRequestOptions, requestOptions);
137
- if (typeof name === "string") {
138
- $projectRef = projectRefOrName;
139
- $slug =
140
- typeof slugOrRequestOptions === "string"
141
- ? slugOrRequestOptions
142
- : taskContext.ctx?.environment.slug;
143
- $name = name;
144
- }
145
- else {
146
- $projectRef = taskContext.ctx?.project.ref;
147
- $slug = taskContext.ctx?.environment.slug;
148
- $name = projectRefOrName;
149
- }
150
- if (!$projectRef) {
151
- throw new Error("projectRef is required");
152
- }
153
- if (!$slug) {
154
- throw new Error("slug is required");
155
- }
156
- const apiClient = apiClientManager.clientOrThrow();
157
- return apiClient.deleteEnvVar($projectRef, $slug, $name, $requestOptions);
158
- }
159
- export function update(projectRefOrName, slugOrParams, nameOrRequestOptions, params, requestOptions) {
160
- let $projectRef;
161
- let $slug;
162
- let $name;
163
- let $params;
164
- const $requestOptions = overloadRequestOptions("update", nameOrRequestOptions, requestOptions);
165
- if (taskContext.ctx) {
166
- if (typeof slugOrParams === "string") {
167
- $projectRef = slugOrParams;
168
- $slug = slugOrParams ?? taskContext.ctx.environment.slug;
169
- $name =
170
- typeof nameOrRequestOptions === "string"
171
- ? nameOrRequestOptions
172
- : taskContext.ctx.environment.slug;
173
- if (!params) {
174
- throw new Error("params is required");
175
- }
176
- $params = params;
177
- }
178
- else {
179
- $params = slugOrParams;
180
- $projectRef = taskContext.ctx.project.ref;
181
- $slug = taskContext.ctx.environment.slug;
182
- $name = projectRefOrName;
183
- }
184
- }
185
- else {
186
- if (typeof slugOrParams !== "string") {
187
- throw new Error("slug is required");
188
- }
189
- if (!projectRefOrName) {
190
- throw new Error("projectRef is required");
191
- }
192
- if (!params) {
193
- throw new Error("params is required");
194
- }
195
- $projectRef = projectRefOrName;
196
- $slug = slugOrParams;
197
- $name = name;
198
- $params = params;
199
- }
200
- const apiClient = apiClientManager.clientOrThrow();
201
- return apiClient.updateEnvVar($projectRef, $slug, $name, $params, $requestOptions);
202
- }
203
- function overloadRequestOptions(name, slugOrRequestOptions, requestOptions) {
204
- if (isRequestOptions(slugOrRequestOptions)) {
205
- return mergeRequestOptions({
206
- tracer,
207
- name: `envvars.${name}()`,
208
- icon: "id-badge",
209
- }, slugOrRequestOptions);
210
- }
211
- else {
212
- return mergeRequestOptions({
213
- tracer,
214
- name: `envvars.${name}()`,
215
- icon: "id-badge",
216
- }, requestOptions);
217
- }
218
- }
219
- //# sourceMappingURL=envvars.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"envvars.js","sourceRoot":"","sources":["../../../src/v3/envvars.ts"],"names":[],"mappings":"AAUA,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,GACZ,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAcrC,MAAM,UAAU,MAAM,CACpB,kBAA6D,EAC7D,oBAAiD,EACjD,MAAyC,EACzC,cAAkC;IAElC,IAAI,WAAmB,CAAC;IACxB,IAAI,OAAyC,CAAC;IAC9C,IAAI,KAAa,CAAC;IAClB,MAAM,eAAe,GAAG,sBAAsB,CAAC,QAAQ,EAAE,oBAAoB,EAAE,cAAc,CAAC,CAAC;IAE/F,IAAI,WAAW,CAAC,GAAG,EAAE,CAAC;QACpB,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE,CAAC;YAC3C,WAAW,GAAG,kBAAkB,CAAC;YACjC,KAAK;gBACH,OAAO,oBAAoB,KAAK,QAAQ;oBACtC,CAAC,CAAC,oBAAoB;oBACtB,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC;YAEvC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;YACxC,CAAC;YAED,OAAO,GAAG,MAAM,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,kBAAkB,CAAC;YAC7B,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC;YAC1C,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC;QAC3C,CAAC;IACH,CAAC;SAAM,CAAC;QACN,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,oBAAoB,IAAI,OAAO,oBAAoB,KAAK,QAAQ,EAAE,CAAC;YACtE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACxC,CAAC;QAED,WAAW,GAAG,kBAAkB,CAAC;QACjC,KAAK,GAAG,oBAAoB,CAAC;QAC7B,OAAO,GAAG,MAAM,CAAC;IACnB,CAAC;IAED,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,OAAO,SAAS,CAAC,aAAa,CAAC,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC;AAC/E,CAAC;AAQD,MAAM,UAAU,IAAI,CAClB,0BAAuD,EACvD,IAAa,EACb,cAAkC;IAElC,MAAM,WAAW,GAAG,CAAC,gBAAgB,CAAC,0BAA0B,CAAC;QAC/D,CAAC,CAAC,0BAA0B;QAC5B,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC;IACjC,MAAM,KAAK,GAAG,IAAI,IAAI,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,CAAC;IACxD,IAAI,eAAe,GAAG,gBAAgB,CAAC,0BAA0B,CAAC;QAChE,CAAC,CAAC,0BAA0B;QAC5B,CAAC,CAAC,cAAc,CAAC;IAEnB,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACtC,CAAC;IAED,eAAe,GAAG,mBAAmB,CACnC;QACE,MAAM;QACN,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,UAAU;KACjB,EACD,eAAe,CAChB,CAAC;IAEF,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,OAAO,SAAS,CAAC,WAAW,CAAC,WAAW,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;AACpE,CAAC;AAYD,MAAM,UAAU,MAAM,CACpB,kBAA4D,EAC5D,oBAAiD,EACjD,MAAwC,EACxC,cAAkC;IAElC,IAAI,WAAmB,CAAC;IACxB,IAAI,KAAa,CAAC;IAClB,IAAI,OAAwC,CAAC;IAC7C,MAAM,eAAe,GAAG,sBAAsB,CAAC,QAAQ,EAAE,oBAAoB,EAAE,cAAc,CAAC,CAAC;IAE/F,IAAI,WAAW,CAAC,GAAG,EAAE,CAAC;QACpB,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE,CAAC;YAC3C,WAAW,GAAG,kBAAkB,CAAC;YACjC,KAAK;gBACH,OAAO,oBAAoB,KAAK,QAAQ;oBACtC,CAAC,CAAC,oBAAoB;oBACtB,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC;YAEvC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;YACxC,CAAC;YAED,OAAO,GAAG,MAAM,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,kBAAkB,CAAC;YAC7B,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC;YAC1C,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC;QAC3C,CAAC;IACH,CAAC;SAAM,CAAC;QACN,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,oBAAoB,IAAI,OAAO,oBAAoB,KAAK,QAAQ,EAAE,CAAC;YACtE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACxC,CAAC;QAED,WAAW,GAAG,kBAAkB,CAAC;QACjC,KAAK,GAAG,oBAAoB,CAAC;QAC7B,OAAO,GAAG,MAAM,CAAC;IACnB,CAAC;IAED,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,OAAO,SAAS,CAAC,YAAY,CAAC,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC;AAC9E,CAAC;AAYD,MAAM,UAAU,QAAQ,CACtB,gBAAwB,EACxB,oBAAiD,EACjD,IAAa,EACb,cAAkC;IAElC,IAAI,WAAmB,CAAC;IACxB,IAAI,KAAa,CAAC;IAClB,IAAI,KAAa,CAAC;IAClB,MAAM,eAAe,GAAG,sBAAsB,CAAC,UAAU,EAAE,oBAAoB,EAAE,cAAc,CAAC,CAAC;IAEjG,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,WAAW,GAAG,gBAAgB,CAAC;QAC/B,KAAK;YACH,OAAO,oBAAoB,KAAK,QAAQ;gBACtC,CAAC,CAAC,oBAAoB;gBACtB,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,IAAK,CAAC;QACzC,KAAK,GAAG,IAAI,CAAC;IACf,CAAC;SAAM,CAAC;QACN,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,GAAI,CAAC;QAC5C,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,IAAK,CAAC;QAC3C,KAAK,GAAG,gBAAgB,CAAC;IAC3B,CAAC;IAED,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,OAAO,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;AAC9E,CAAC;AAYD,MAAM,UAAU,GAAG,CACjB,gBAAwB,EACxB,oBAAiD,EACjD,IAAa,EACb,cAAkC;IAElC,IAAI,WAAmB,CAAC;IACxB,IAAI,KAAa,CAAC;IAClB,IAAI,KAAa,CAAC;IAClB,MAAM,eAAe,GAAG,sBAAsB,CAAC,KAAK,EAAE,oBAAoB,EAAE,cAAc,CAAC,CAAC;IAE5F,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,WAAW,GAAG,gBAAgB,CAAC;QAC/B,KAAK;YACH,OAAO,oBAAoB,KAAK,QAAQ;gBACtC,CAAC,CAAC,oBAAoB;gBACtB,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,IAAK,CAAC;QACzC,KAAK,GAAG,IAAI,CAAC;IACf,CAAC;SAAM,CAAC;QACN,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,GAAI,CAAC;QAC5C,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,IAAK,CAAC;QAC3C,KAAK,GAAG,gBAAgB,CAAC;IAC3B,CAAC;IAED,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,OAAO,SAAS,CAAC,YAAY,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;AAC5E,CAAC;AAcD,MAAM,UAAU,MAAM,CACpB,gBAAwB,EACxB,YAAsD,EACtD,oBAAiD,EACjD,MAAwC,EACxC,cAAkC;IAElC,IAAI,WAAmB,CAAC;IACxB,IAAI,KAAa,CAAC;IAClB,IAAI,KAAa,CAAC;IAClB,IAAI,OAAwC,CAAC;IAC7C,MAAM,eAAe,GAAG,sBAAsB,CAAC,QAAQ,EAAE,oBAAoB,EAAE,cAAc,CAAC,CAAC;IAE/F,IAAI,WAAW,CAAC,GAAG,EAAE,CAAC;QACpB,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;YACrC,WAAW,GAAG,YAAY,CAAC;YAC3B,KAAK,GAAG,YAAY,IAAI,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC;YACzD,KAAK;gBACH,OAAO,oBAAoB,KAAK,QAAQ;oBACtC,CAAC,CAAC,oBAAoB;oBACtB,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC;YAEvC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;YACxC,CAAC;YAED,OAAO,GAAG,MAAM,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,YAAY,CAAC;YACvB,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC;YAC1C,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC;YACzC,KAAK,GAAG,gBAAgB,CAAC;QAC3B,CAAC;IACH,CAAC;SAAM,CAAC;QACN,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACxC,CAAC;QAED,WAAW,GAAG,gBAAgB,CAAC;QAC/B,KAAK,GAAG,YAAY,CAAC;QACrB,KAAK,GAAG,IAAK,CAAC;QACd,OAAO,GAAG,MAAM,CAAC;IACnB,CAAC;IAED,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,OAAO,SAAS,CAAC,YAAY,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC;AACrF,CAAC;AAED,SAAS,sBAAsB,CAC7B,IAAY,EACZ,oBAAiD,EACjD,cAAkC;IAElC,IAAI,gBAAgB,CAAC,oBAAoB,CAAC,EAAE,CAAC;QAC3C,OAAO,mBAAmB,CACxB;YACE,MAAM;YACN,IAAI,EAAE,WAAW,IAAI,IAAI;YACzB,IAAI,EAAE,UAAU;SACjB,EACD,oBAAoB,CACrB,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,OAAO,mBAAmB,CACxB;YACE,MAAM;YACN,IAAI,EAAE,WAAW,IAAI,IAAI;YACzB,IAAI,EAAE,UAAU;SACjB,EACD,cAAc,CACf,CAAC;IACJ,CAAC;AACH,CAAC"}
@@ -1,44 +0,0 @@
1
- import { type IdempotencyKey } from "@trigger.dev/core/v3";
2
- export declare const idempotencyKeys: {
3
- create: typeof createIdempotencyKey;
4
- };
5
- export type { IdempotencyKey };
6
- export declare function isIdempotencyKey(value: string | string[] | IdempotencyKey): value is IdempotencyKey;
7
- /**
8
- * Creates a deterministic idempotency key based on the provided key material.
9
- *
10
- * If running inside a task, the task run ID is automatically included in the key material, giving you a unique key per task run.
11
- * This ensures that a given child task is only triggered once per task run, even if the parent task is retried.
12
- *
13
- * @param {string | string[]} key The key material to create the idempotency key from.
14
- * @param {object} [options] Additional options.
15
- * @param {"run" | "attempt" | "global"} [options.scope="run"] The scope of the idempotency key.
16
- *
17
- * @returns {Promise<IdempotencyKey>} The idempotency key as a branded string.
18
- *
19
- * @example
20
- *
21
- * ```typescript
22
- * import { idempotencyKeys, task } from "@trigger.dev/sdk/v3";
23
- *
24
- * export const myTask = task({
25
- * id: "my-task",
26
- * run: async (payload: any) => {
27
- * const idempotencyKey = await idempotencyKeys.create("my-task-key");
28
- *
29
- * // Use the idempotency key when triggering child tasks
30
- * await childTask.triggerAndWait(payload, { idempotencyKey });
31
- * }
32
- * });
33
- * ```
34
- *
35
- * You can also use the `scope` parameter to create a key that is unique per task run, task run attempts (retries of the same run), or globally:
36
- *
37
- * ```typescript
38
- * await idempotencyKeys.create("my-task-key", { scope: "attempt" }); // Creates a key that is unique per task run attempt
39
- * await idempotencyKeys.create("my-task-key", { scope: "global" }); // Skips including the task run ID
40
- * ```
41
- */
42
- declare function createIdempotencyKey(key: string | string[], options?: {
43
- scope?: "run" | "attempt" | "global";
44
- }): Promise<IdempotencyKey>;
@@ -1,72 +0,0 @@
1
- import { taskContext } from "@trigger.dev/core/v3";
2
- export const idempotencyKeys = {
3
- create: createIdempotencyKey,
4
- };
5
- export function isIdempotencyKey(value) {
6
- // Cannot check the brand at runtime because it doesn't exist (it's a TypeScript-only construct)
7
- return typeof value === "string" && value.length === 64;
8
- }
9
- /**
10
- * Creates a deterministic idempotency key based on the provided key material.
11
- *
12
- * If running inside a task, the task run ID is automatically included in the key material, giving you a unique key per task run.
13
- * This ensures that a given child task is only triggered once per task run, even if the parent task is retried.
14
- *
15
- * @param {string | string[]} key The key material to create the idempotency key from.
16
- * @param {object} [options] Additional options.
17
- * @param {"run" | "attempt" | "global"} [options.scope="run"] The scope of the idempotency key.
18
- *
19
- * @returns {Promise<IdempotencyKey>} The idempotency key as a branded string.
20
- *
21
- * @example
22
- *
23
- * ```typescript
24
- * import { idempotencyKeys, task } from "@trigger.dev/sdk/v3";
25
- *
26
- * export const myTask = task({
27
- * id: "my-task",
28
- * run: async (payload: any) => {
29
- * const idempotencyKey = await idempotencyKeys.create("my-task-key");
30
- *
31
- * // Use the idempotency key when triggering child tasks
32
- * await childTask.triggerAndWait(payload, { idempotencyKey });
33
- * }
34
- * });
35
- * ```
36
- *
37
- * You can also use the `scope` parameter to create a key that is unique per task run, task run attempts (retries of the same run), or globally:
38
- *
39
- * ```typescript
40
- * await idempotencyKeys.create("my-task-key", { scope: "attempt" }); // Creates a key that is unique per task run attempt
41
- * await idempotencyKeys.create("my-task-key", { scope: "global" }); // Skips including the task run ID
42
- * ```
43
- */
44
- async function createIdempotencyKey(key, options) {
45
- const idempotencyKey = await generateIdempotencyKey([...(Array.isArray(key) ? key : [key])].concat(injectScope(options?.scope ?? "run")));
46
- return idempotencyKey;
47
- }
48
- function injectScope(scope) {
49
- switch (scope) {
50
- case "run": {
51
- if (taskContext?.ctx) {
52
- return [taskContext.ctx.run.id];
53
- }
54
- break;
55
- }
56
- case "attempt": {
57
- if (taskContext?.ctx) {
58
- return [taskContext.ctx.attempt.id];
59
- }
60
- break;
61
- }
62
- }
63
- return [];
64
- }
65
- async function generateIdempotencyKey(keyMaterial) {
66
- const hash = await crypto.subtle.digest("SHA-256", new TextEncoder().encode(keyMaterial.join("-")));
67
- // Return a hex string, using cross-runtime compatible methods
68
- return Array.from(new Uint8Array(hash))
69
- .map((byte) => byte.toString(16).padStart(2, "0"))
70
- .join("");
71
- }
72
- //# sourceMappingURL=idempotencyKeys.js.map
@@ -1 +0,0 @@
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"}
@@ -1,21 +0,0 @@
1
- export * from "./cache.js";
2
- export * from "./config.js";
3
- export { retry, type RetryOptions } from "./retry.js";
4
- export { queue } from "./shared.js";
5
- export * from "./tasks.js";
6
- export * from "./wait.js";
7
- export * from "./usage.js";
8
- export * from "./idempotencyKeys.js";
9
- export * from "./tags.js";
10
- export * from "./metadata.js";
11
- export * from "./timeout.js";
12
- export type { Context };
13
- import type { Context } from "./shared.js";
14
- import type { ApiClientConfiguration } from "@trigger.dev/core/v3";
15
- export type { ApiClientConfiguration };
16
- export { ApiError, AuthenticationError, BadRequestError, ConflictError, InternalServerError, NotFoundError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, AbortTaskRunError, logger, type LogLevel, } from "@trigger.dev/core/v3";
17
- export { runs, type RunShape, type AnyRunShape, type TaskRunShape, type RetrieveRunResult, type AnyRetrieveRunResult, } from "./runs.js";
18
- export * as schedules from "./schedules/index.js";
19
- export * as envvars from "./envvars.js";
20
- export type { ImportEnvironmentVariablesParams } from "./envvars.js";
21
- export { configure, auth } from "./auth.js";
@@ -1,17 +0,0 @@
1
- export * from "./cache.js";
2
- export * from "./config.js";
3
- export { retry } from "./retry.js";
4
- export { queue } from "./shared.js";
5
- export * from "./tasks.js";
6
- export * from "./wait.js";
7
- export * from "./usage.js";
8
- export * from "./idempotencyKeys.js";
9
- export * from "./tags.js";
10
- export * from "./metadata.js";
11
- export * from "./timeout.js";
12
- export { ApiError, AuthenticationError, BadRequestError, ConflictError, InternalServerError, NotFoundError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, AbortTaskRunError, logger, } from "@trigger.dev/core/v3";
13
- export { runs, } from "./runs.js";
14
- export * as schedules from "./schedules/index.js";
15
- export * as envvars from "./envvars.js";
16
- export { configure, auth } from "./auth.js";
17
- //# sourceMappingURL=index.js.map
@@ -1,87 +0,0 @@
1
- import { DeserializedJson } from "@trigger.dev/core";
2
- import { ApiRequestOptions } from "@trigger.dev/core/v3";
3
- /**
4
- * Provides access to run metadata operations.
5
- * @namespace
6
- * @property {Function} current - Get the current run's metadata.
7
- * @property {Function} get - Get a specific key from the current run's metadata.
8
- * @property {Function} set - Set a key in the current run's metadata.
9
- * @property {Function} del - Delete a key from the current run's metadata.
10
- * @property {Function} save - Update the entire metadata object for the current run.
11
- */
12
- export declare const metadata: {
13
- current: typeof currentMetadata;
14
- get: typeof getMetadataKey;
15
- set: typeof setMetadataKey;
16
- del: typeof deleteMetadataKey;
17
- save: typeof saveMetadata;
18
- replace: typeof replaceMetadata;
19
- flush: typeof flushMetadata;
20
- };
21
- export type RunMetadata = Record<string, DeserializedJson>;
22
- /**
23
- * Returns the metadata of the current run if inside a task run.
24
- * This function allows you to access the entire metadata object for the current run.
25
- *
26
- * @returns {RunMetadata | undefined} The current run's metadata or undefined if not in a run context.
27
- *
28
- * @example
29
- * const currentMetadata = metadata.current();
30
- * console.log(currentMetadata);
31
- */
32
- declare function currentMetadata(): RunMetadata | undefined;
33
- /**
34
- * Get a specific key from the metadata of the current run if inside a task run.
35
- *
36
- * @param {string} key - The key to retrieve from the metadata.
37
- * @returns {DeserializedJson | undefined} The value associated with the key, or undefined if not found or not in a run context.
38
- *
39
- * @example
40
- * const user = metadata.get("user");
41
- * console.log(user.name); // "Eric"
42
- * console.log(user.id); // "user_1234"
43
- */
44
- declare function getMetadataKey(key: string): DeserializedJson | undefined;
45
- /**
46
- * Set a key in the metadata of the current run if inside a task run.
47
- * This function allows you to update or add a new key-value pair to the run's metadata.
48
- *
49
- * @param {string} key - The key to set in the metadata.
50
- * @param {DeserializedJson} value - The value to associate with the key.
51
- *
52
- * @example
53
- * metadata.set("progress", 0.5);
54
- */
55
- declare function setMetadataKey(key: string, value: DeserializedJson): void;
56
- /**
57
- * Delete a key from the metadata of the current run if inside a task run.
58
- *
59
- * @param {string} key - The key to delete from the metadata.
60
- *
61
- * @example
62
- * metadata.del("progress");
63
- */
64
- declare function deleteMetadataKey(key: string): void;
65
- /**
66
- * Update the entire metadata object for the current run if inside a task run.
67
- * This function allows you to replace the entire metadata object with a new one.
68
- *
69
- * @param {RunMetadata} metadata - The new metadata object to set for the run.
70
- * @returns {void}
71
- *
72
- * @example
73
- * metadata.replace({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
74
- */
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>;
87
- export {};