@trigger.dev/sdk 0.0.0-prerelease-20241023140846 → 0.0.0-prerelease-20241119135607

package/dist/esm/v3/auth.js

@@ -0,0 +1,98 @@
+import { apiClientManager } from "@trigger.dev/core/v3";
+import { generateJWT as internal_generateJWT } from "@trigger.dev/core/v3";
+/**
+ * Register the global API client configuration. Alternatively, you can set the `TRIGGER_SECRET_KEY` and `TRIGGER_API_URL` environment variables.
+ * @param options The API client configuration.
+ * @param options.baseURL The base URL of the Trigger API. (default: `https://api.trigger.dev`)
+ * @param options.accessToken The accessToken to authenticate with the Trigger API. (default: `process.env.TRIGGER_SECRET_KEY`) This can be found in your Trigger.dev project "API Keys" settings.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { configure } from "@trigger.dev/sdk/v3";
+ *
+ * configure({
+ *  baseURL: "https://api.trigger.dev",
+ *  accessToken: "tr_dev_1234567890"
+ * });
+ * ```
+ */
+export function configure(options) {
+    apiClientManager.setGlobalAPIClientConfiguration(options);
+}
+export const auth = {
+    configure,
+    createPublicToken,
+    withAuth,
+};
+/**
+ * Creates a public token using the provided options.
+ *
+ * @param options - Optional parameters for creating the public token.
+ * @param options.scopes - An array of permission scopes to be included in the token.
+ * @param options.expirationTime - The expiration time for the token.
+ * @returns A promise that resolves to a string representing the generated public token.
+ *
+ * @example
+ *
+ * ```typescript
+ * import { auth } from "@trigger.dev/sdk/v3";
+ *
+ * const publicToken = await auth.createPublicToken({
+ *  scopes: {
+ *   read: {
+ *     tags: ["file:1234"]
+ *   }
+ * });
+ * ```
+ */
+async function createPublicToken(options) {
+    const apiClient = apiClientManager.clientOrThrow();
+    const claims = await apiClient.generateJWTClaims();
+    return await internal_generateJWT({
+        secretKey: apiClient.accessToken,
+        payload: {
+            ...claims,
+            scopes: options?.scopes ? flattenScopes(options.scopes) : undefined,
+        },
+        expirationTime: options?.expirationTime,
+    });
+}
+/**
+ * Executes a provided asynchronous function with a specified API client configuration.
+ *
+ * @template R - The type of the asynchronous function to be executed.
+ * @param {ApiClientConfiguration} config - The configuration for the API client.
+ * @param {R} fn - The asynchronous function to be executed.
+ * @returns {Promise<ReturnType<R>>} A promise that resolves to the return type of the provided function.
+ */
+async function withAuth(config, fn) {
+    return apiClientManager.runWithConfig(config, fn);
+}
+function flattenScopes(permissions) {
+    const flattenedPermissions = [];
+    for (const [action, properties] of Object.entries(permissions)) {
+        if (properties) {
+            if (typeof properties === "boolean" && properties) {
+                flattenedPermissions.push(action);
+            }
+            else if (typeof properties === "object") {
+                for (const [property, value] of Object.entries(properties)) {
+                    if (Array.isArray(value)) {
+                        for (const item of value) {
+                            flattenedPermissions.push(`${action}:${property}:${item}`);
+                        }
+                    }
+                    else if (typeof value === "string") {
+                        flattenedPermissions.push(`${action}:${property}:${value}`);
+                    }
+                    else if (typeof value === "boolean" && value) {
+                        flattenedPermissions.push(`${action}:${property}`);
+                    }
+                }
+            }
+        }
+    }
+    return flattenedPermissions;
+}
+//# sourceMappingURL=auth.js.map

package/dist/esm/v3/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../../src/v3/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACrF,OAAO,EAAE,WAAW,IAAI,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAE3E;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,SAAS,CAAC,OAA+B;IACvD,gBAAgB,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;AAC5D,CAAC;AAED,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,SAAS;IACT,iBAAiB;IACjB,QAAQ;CACT,CAAC;AA0DF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,KAAK,UAAU,iBAAiB,CAAC,OAAkC;IACjE,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,iBAAiB,EAAE,CAAC;IAEnD,OAAO,MAAM,oBAAoB,CAAC;QAChC,SAAS,EAAE,SAAS,CAAC,WAAW;QAChC,OAAO,EAAE;YACP,GAAG,MAAM;YACT,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;SACpE;QACD,cAAc,EAAE,OAAO,EAAE,cAAc;KACxC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,QAAQ,CACrB,MAA8B,EAC9B,EAAK;IAEL,OAAO,gBAAgB,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,aAAa,CAAC,WAAmC;IACxD,MAAM,oBAAoB,GAAa,EAAE,CAAC;IAE1C,KAAK,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/D,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,OAAO,UAAU,KAAK,SAAS,IAAI,UAAU,EAAE,CAAC;gBAClD,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACpC,CAAC;iBAAM,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;gBAC1C,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC3D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;wBACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;4BACzB,oBAAoB,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC;wBAC7D,CAAC;oBACH,CAAC;yBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;wBACrC,oBAAoB,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,QAAQ,IAAI,KAAK,EAAE,CAAC,CAAC;oBAC9D,CAAC;yBAAM,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,EAAE,CAAC;wBAC/C,oBAAoB,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,QAAQ,EAAE,CAAC,CAAC;oBACrD,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC"}

package/dist/esm/v3/idempotencyKeys.d.ts

@@ -1,49 +1,5 @@
+import { createIdempotencyKey, type IdempotencyKey } from "@trigger.dev/core/v3";
 export declare const idempotencyKeys: {
     create: typeof createIdempotencyKey;
 };
-declare const __brand: unique symbol;
-type Brand<B> = {
-    [__brand]: B;
-};
-type Branded<T, B> = T & Brand<B>;
-export type IdempotencyKey = Branded<string, "IdempotencyKey">;
-export declare function isIdempotencyKey(value: string | string[] | IdempotencyKey): value is IdempotencyKey;
-/**
- * Creates a deterministic idempotency key based on the provided key material.
- *
- * If running inside a task, the task run ID is automatically included in the key material, giving you a unique key per task run.
- * This ensures that a given child task is only triggered once per task run, even if the parent task is retried.
- *
- * @param {string | string[]} key The key material to create the idempotency key from.
- * @param {object} [options] Additional options.
- * @param {"run" | "attempt" | "global"} [options.scope="run"] The scope of the idempotency key.
- *
- * @returns {Promise<IdempotencyKey>} The idempotency key as a branded string.
- *
- * @example
- *
- * ```typescript
- * import { idempotencyKeys, task } from "@trigger.dev/sdk/v3";
- *
- * export const myTask = task({
- *  id: "my-task",
- *  run: async (payload: any) => {
- *   const idempotencyKey = await idempotencyKeys.create("my-task-key");
- *
- *   // Use the idempotency key when triggering child tasks
- *   await childTask.triggerAndWait(payload, { idempotencyKey });
- *  }
- * });
- * ```
- *
- * 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:
- *
- * ```typescript
- *  await idempotencyKeys.create("my-task-key", { scope: "attempt" }); // Creates a key that is unique per task run attempt
- *  await idempotencyKeys.create("my-task-key", { scope: "global" }); // Skips including the task run ID
- * ```
- */
-declare function createIdempotencyKey(key: string | string[], options?: {
-    scope?: "run" | "attempt" | "global";
-}): Promise<IdempotencyKey>;
-export {};
+export type { IdempotencyKey };

package/dist/esm/v3/idempotencyKeys.js

@@ -1,72 +1,5 @@
-import { taskContext } from "@trigger.dev/core/v3";
+import { createIdempotencyKey } from "@trigger.dev/core/v3";
 export const idempotencyKeys = {
     create: createIdempotencyKey,
 };
-export function isIdempotencyKey(value) {
-    // Cannot check the brand at runtime because it doesn't exist (it's a TypeScript-only construct)
-    return typeof value === "string" && value.length === 64;
-}
-/**
- * Creates a deterministic idempotency key based on the provided key material.
- *
- * If running inside a task, the task run ID is automatically included in the key material, giving you a unique key per task run.
- * This ensures that a given child task is only triggered once per task run, even if the parent task is retried.
- *
- * @param {string | string[]} key The key material to create the idempotency key from.
- * @param {object} [options] Additional options.
- * @param {"run" | "attempt" | "global"} [options.scope="run"] The scope of the idempotency key.
- *
- * @returns {Promise<IdempotencyKey>} The idempotency key as a branded string.
- *
- * @example
- *
- * ```typescript
- * import { idempotencyKeys, task } from "@trigger.dev/sdk/v3";
- *
- * export const myTask = task({
- *  id: "my-task",
- *  run: async (payload: any) => {
- *   const idempotencyKey = await idempotencyKeys.create("my-task-key");
- *
- *   // Use the idempotency key when triggering child tasks
- *   await childTask.triggerAndWait(payload, { idempotencyKey });
- *  }
- * });
- * ```
- *
- * 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:
- *
- * ```typescript
- *  await idempotencyKeys.create("my-task-key", { scope: "attempt" }); // Creates a key that is unique per task run attempt
- *  await idempotencyKeys.create("my-task-key", { scope: "global" }); // Skips including the task run ID
- * ```
- */
-async function createIdempotencyKey(key, options) {
-    const idempotencyKey = await generateIdempotencyKey([...(Array.isArray(key) ? key : [key])].concat(injectScope(options?.scope ?? "run")));
-    return idempotencyKey;
-}
-function injectScope(scope) {
-    switch (scope) {
-        case "run": {
-            if (taskContext?.ctx) {
-                return [taskContext.ctx.run.id];
-            }
-            break;
-        }
-        case "attempt": {
-            if (taskContext?.ctx) {
-                return [taskContext.ctx.attempt.id];
-            }
-            break;
-        }
-    }
-    return [];
-}
-async function generateIdempotencyKey(keyMaterial) {
-    const hash = await crypto.subtle.digest("SHA-256", new TextEncoder().encode(keyMaterial.join("-")));
-    // Return a hex string, using cross-runtime compatible methods
-    return Array.from(new Uint8Array(hash))
-        .map((byte) => byte.toString(16).padStart(2, "0"))
-        .join("");
-}
 //# sourceMappingURL=idempotencyKeys.js.map

package/dist/esm/v3/idempotencyKeys.js.map

@@ -1 +1 @@
-{"version":3,"file":"idempotencyKeys.js","sourceRoot":"","sources":["../../../src/v3/idempotencyKeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,MAAM,EAAE,oBAAoB;CAC7B,CAAC;AAQF,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"}
+{"version":3,"file":"idempotencyKeys.js","sourceRoot":"","sources":["../../../src/v3/idempotencyKeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAuB,MAAM,sBAAsB,CAAC;AAEjF,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,MAAM,EAAE,oBAAoB;CAC7B,CAAC"}

package/dist/esm/v3/index-browser.d.mts

@@ -0,0 +1,2 @@
+export { runs, type RunShape, type AnyRunShape } from "./runs.js";
+export { configure, auth } from "./auth.js";

package/dist/esm/v3/index-browser.mjs

@@ -0,0 +1,3 @@
+export { runs } from "./runs.js";
+export { configure, auth } from "./auth.js";
+//# sourceMappingURL=index-browser.mjs.map

package/dist/esm/v3/index.d.ts

@@ -4,35 +4,20 @@ export { retry, type RetryOptions } from "./retry.js";
 export { queue } from "./shared.js";
 export * from "./tasks.js";
 export * from "./wait.js";
+export * from "./waitUntil.js";
 export * from "./usage.js";
 export * from "./idempotencyKeys.js";
 export * from "./tags.js";
 export * from "./metadata.js";
 export * from "./timeout.js";
+export * from "./waitUntil.js";
 export type { Context };
 import type { Context } from "./shared.js";
 import type { ApiClientConfiguration } from "@trigger.dev/core/v3";
 export type { ApiClientConfiguration };
 export { ApiError, AuthenticationError, BadRequestError, ConflictError, InternalServerError, NotFoundError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, AbortTaskRunError, logger, type LogLevel, } from "@trigger.dev/core/v3";
-export { runs } from "./runs.js";
+export { runs, type RunShape, type AnyRunShape, type TaskRunShape, type RealtimeRun, type RetrieveRunResult, type AnyRetrieveRunResult, } from "./runs.js";
 export * as schedules from "./schedules/index.js";
 export * as envvars from "./envvars.js";
 export type { ImportEnvironmentVariablesParams } from "./envvars.js";
-/**
- * Register the global API client configuration. Alternatively, you can set the `TRIGGER_SECRET_KEY` and `TRIGGER_API_URL` environment variables.
- * @param options The API client configuration.
- * @param options.baseURL The base URL of the Trigger API. (default: `https://api.trigger.dev`)
- * @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.
- *
- * @example
- *
- * ```typescript
- * import { configure } from "@trigger.dev/sdk/v3";
- *
- * configure({
- *  baseURL: "https://api.trigger.dev",
- *  secretKey: "tr_dev_1234567890"
- * });
- * ```
- */
-export declare function configure(options: ApiClientConfiguration): void;
+export { configure, auth } from "./auth.js";

package/dist/esm/v3/index.js

@@ -4,34 +4,16 @@ export { retry } from "./retry.js";
 export { queue } from "./shared.js";
 export * from "./tasks.js";
 export * from "./wait.js";
+export * from "./waitUntil.js";
 export * from "./usage.js";
 export * from "./idempotencyKeys.js";
 export * from "./tags.js";
 export * from "./metadata.js";
 export * from "./timeout.js";
-import { apiClientManager } from "@trigger.dev/core/v3";
+export * from "./waitUntil.js";
 export { ApiError, AuthenticationError, BadRequestError, ConflictError, InternalServerError, NotFoundError, PermissionDeniedError, RateLimitError, UnprocessableEntityError, AbortTaskRunError, logger, } from "@trigger.dev/core/v3";
-export { runs } from "./runs.js";
+export { runs, } from "./runs.js";
 export * as schedules from "./schedules/index.js";
 export * as envvars from "./envvars.js";
-/**
- * Register the global API client configuration. Alternatively, you can set the `TRIGGER_SECRET_KEY` and `TRIGGER_API_URL` environment variables.
- * @param options The API client configuration.
- * @param options.baseURL The base URL of the Trigger API. (default: `https://api.trigger.dev`)
- * @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.
- *
- * @example
- *
- * ```typescript
- * import { configure } from "@trigger.dev/sdk/v3";
- *
- * configure({
- *  baseURL: "https://api.trigger.dev",
- *  secretKey: "tr_dev_1234567890"
- * });
- * ```
- */
-export function configure(options) {
-    apiClientManager.setGlobalAPIClientConfiguration(options);
-}
+export { configure, auth } from "./auth.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/v3/index.js.map

@@ -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;AAM7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAIxD,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,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AAGxC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,SAAS,CAAC,OAA+B;IACvD,gBAAgB,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;AAC5D,CAAC"}
+{"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,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAS/B,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,GAOL,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"}

package/dist/esm/v3/metadata.d.ts

@@ -15,6 +15,13 @@ export declare const metadata: {
     set: typeof setMetadataKey;
     del: typeof deleteMetadataKey;
     save: typeof saveMetadata;
+    replace: typeof replaceMetadata;
+    flush: typeof flushMetadata;
+    stream: typeof stream;
+    append: typeof appendMetadataKey;
+    remove: typeof removeMetadataKey;
+    increment: typeof incrementMetadataKey;
+    decrement: typeof decrementMetadataKey;
 };
 export type RunMetadata = Record<string, DeserializedJson>;
 /**
@@ -46,34 +53,90 @@ declare function getMetadataKey(key: string): DeserializedJson | undefined;
  *
  * @param {string} key - The key to set in the metadata.
  * @param {DeserializedJson} value - The value to associate with the key.
- * @param {ApiRequestOptions} [requestOptions] - Optional API request options.
- * @returns {Promise<void>} A promise that resolves when the metadata is updated.
  *
  * @example
- * await metadata.set("progress", 0.5);
+ * metadata.set("progress", 0.5);
  */
-declare function setMetadataKey(key: string, value: DeserializedJson, requestOptions?: ApiRequestOptions): Promise<void>;
+declare function setMetadataKey(key: string, value: DeserializedJson): void;
 /**
  * Delete a key from the metadata of the current run if inside a task run.
  *
  * @param {string} key - The key to delete from the metadata.
- * @param {ApiRequestOptions} [requestOptions] - Optional API request options.
- * @returns {Promise<void>} A promise that resolves when the key is deleted from the metadata.
  *
  * @example
- * await metadata.del("progress");
+ * metadata.del("progress");
  */
-declare function deleteMetadataKey(key: string, requestOptions?: ApiRequestOptions): Promise<void>;
+declare function deleteMetadataKey(key: string): void;
 /**
  * Update the entire metadata object for the current run if inside a task run.
  * This function allows you to replace the entire metadata object with a new one.
  *
  * @param {RunMetadata} metadata - The new metadata object to set for the run.
- * @param {ApiRequestOptions} [requestOptions] - Optional API request options.
- * @returns {Promise<void>} A promise that resolves when the metadata is updated.
+ * @returns {void}
  *
  * @example
- * await metadata.save({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
+ * metadata.replace({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
  */
-declare function saveMetadata(metadata: RunMetadata, requestOptions?: ApiRequestOptions): Promise<void>;
+declare function replaceMetadata(metadata: RunMetadata): void;
+/**
+ * @deprecated Use `metadata.replace()` instead.
+ */
+declare function saveMetadata(metadata: RunMetadata): void;
+/**
+ * Increments a numeric value in the metadata of the current run by the specified amount.
+ * This function allows you to atomically increment a numeric metadata value.
+ *
+ * @param {string} key - The key of the numeric value to increment.
+ * @param {number} value - The amount to increment the value by.
+ *
+ * @example
+ * metadata.increment("counter", 1); // Increments counter by 1
+ * metadata.increment("score", 10); // Increments score by 10
+ */
+declare function incrementMetadataKey(key: string, value?: number): void;
+/**
+ * Decrements a numeric value in the metadata of the current run by the specified amount.
+ * This function allows you to atomically decrement a numeric metadata value.
+ *
+ * @param {string} key - The key of the numeric value to decrement.
+ * @param {number} value - The amount to decrement the value by.
+ *
+ * @example
+ * metadata.decrement("counter", 1); // Decrements counter by 1
+ * metadata.decrement("score", 5); // Decrements score by 5
+ */
+declare function decrementMetadataKey(key: string, value?: number): void;
+/**
+ * Appends a value to an array in the metadata of the current run.
+ * If the key doesn't exist, it creates a new array with the value.
+ * If the key exists but isn't an array, it converts the existing value to an array.
+ *
+ * @param {string} key - The key of the array in metadata.
+ * @param {DeserializedJson} value - The value to append to the array.
+ *
+ * @example
+ * metadata.append("logs", "User logged in");
+ * metadata.append("events", { type: "click", timestamp: Date.now() });
+ */
+declare function appendMetadataKey(key: string, value: DeserializedJson): void;
+/**
+ * Removes a value from an array in the metadata of the current run.
+ *
+ * @param {string} key - The key of the array in metadata.
+ * @param {DeserializedJson} value - The value to remove from the array.
+ *
+ * @example
+ *
+ * metadata.remove("logs", "User logged in");
+ * metadata.remove("events", { type: "click", timestamp: Date.now() });
+ */
+declare function removeMetadataKey(key: string, value: DeserializedJson): void;
+/**
+ * Flushes metadata to the Trigger.dev instance
+ *
+ * @param {ApiRequestOptions} [requestOptions] - Optional request options to customize the API request.
+ * @returns {Promise<void>} A promise that resolves when the metadata flush operation is complete.
+ */
+declare function flushMetadata(requestOptions?: ApiRequestOptions): Promise<void>;
+declare function stream<T>(key: string, value: AsyncIterable<T> | ReadableStream<T>, signal?: AbortSignal): Promise<AsyncIterable<T>>;
 export {};

package/dist/esm/v3/metadata.js

@@ -1,4 +1,4 @@
-import { accessoryAttributes, flattenAttributes, mergeRequestOptions, runMetadata, } from "@trigger.dev/core/v3";
+import { mergeRequestOptions, runMetadata, } from "@trigger.dev/core/v3";
 import { tracer } from "./tracer.js";
 /**
  * Provides access to run metadata operations.
@@ -15,6 +15,13 @@ export const metadata = {
     set: setMetadataKey,
     del: deleteMetadataKey,
     save: saveMetadata,
+    replace: replaceMetadata,
+    flush: flushMetadata,
+    stream: stream,
+    append: appendMetadataKey,
+    remove: removeMetadataKey,
+    increment: incrementMetadataKey,
+    decrement: decrementMetadataKey,
 };
 /**
  * Returns the metadata of the current run if inside a task run.
@@ -49,82 +56,115 @@ function getMetadataKey(key) {
  *
  * @param {string} key - The key to set in the metadata.
  * @param {DeserializedJson} value - The value to associate with the key.
- * @param {ApiRequestOptions} [requestOptions] - Optional API request options.
- * @returns {Promise<void>} A promise that resolves when the metadata is updated.
  *
  * @example
- * await metadata.set("progress", 0.5);
+ * metadata.set("progress", 0.5);
  */
-async function setMetadataKey(key, value, requestOptions) {
-    const $requestOptions = mergeRequestOptions({
-        tracer,
-        name: "metadata.set()",
-        icon: "code-plus",
-        attributes: {
-            ...accessoryAttributes({
-                items: [
-                    {
-                        text: key,
-                        variant: "normal",
-                    },
-                ],
-                style: "codepath",
-            }),
-            ...flattenAttributes(value, key),
-        },
-    }, requestOptions);
-    await runMetadata.setKey(key, value, $requestOptions);
+function setMetadataKey(key, value) {
+    runMetadata.setKey(key, value);
 }
 /**
  * Delete a key from the metadata of the current run if inside a task run.
  *
  * @param {string} key - The key to delete from the metadata.
- * @param {ApiRequestOptions} [requestOptions] - Optional API request options.
- * @returns {Promise<void>} A promise that resolves when the key is deleted from the metadata.
  *
  * @example
- * await metadata.del("progress");
+ * metadata.del("progress");
  */
-async function deleteMetadataKey(key, requestOptions) {
-    const $requestOptions = mergeRequestOptions({
-        tracer,
-        name: "metadata.del()",
-        icon: "code-minus",
-        attributes: {
-            ...accessoryAttributes({
-                items: [
-                    {
-                        text: key,
-                        variant: "normal",
-                    },
-                ],
-                style: "codepath",
-            }),
-            key,
-        },
-    }, requestOptions);
-    await runMetadata.deleteKey(key, $requestOptions);
+function deleteMetadataKey(key) {
+    runMetadata.deleteKey(key);
 }
 /**
  * Update the entire metadata object for the current run if inside a task run.
  * This function allows you to replace the entire metadata object with a new one.
  *
  * @param {RunMetadata} metadata - The new metadata object to set for the run.
- * @param {ApiRequestOptions} [requestOptions] - Optional API request options.
- * @returns {Promise<void>} A promise that resolves when the metadata is updated.
+ * @returns {void}
+ *
+ * @example
+ * metadata.replace({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
+ */
+function replaceMetadata(metadata) {
+    runMetadata.update(metadata);
+}
+/**
+ * @deprecated Use `metadata.replace()` instead.
+ */
+function saveMetadata(metadata) {
+    runMetadata.update(metadata);
+}
+/**
+ * Increments a numeric value in the metadata of the current run by the specified amount.
+ * This function allows you to atomically increment a numeric metadata value.
+ *
+ * @param {string} key - The key of the numeric value to increment.
+ * @param {number} value - The amount to increment the value by.
+ *
+ * @example
+ * metadata.increment("counter", 1); // Increments counter by 1
+ * metadata.increment("score", 10); // Increments score by 10
+ */
+function incrementMetadataKey(key, value = 1) {
+    runMetadata.incrementKey(key, value);
+}
+/**
+ * Decrements a numeric value in the metadata of the current run by the specified amount.
+ * This function allows you to atomically decrement a numeric metadata value.
+ *
+ * @param {string} key - The key of the numeric value to decrement.
+ * @param {number} value - The amount to decrement the value by.
+ *
+ * @example
+ * metadata.decrement("counter", 1); // Decrements counter by 1
+ * metadata.decrement("score", 5); // Decrements score by 5
+ */
+function decrementMetadataKey(key, value = 1) {
+    runMetadata.decrementKey(key, value);
+}
+/**
+ * Appends a value to an array in the metadata of the current run.
+ * If the key doesn't exist, it creates a new array with the value.
+ * If the key exists but isn't an array, it converts the existing value to an array.
+ *
+ * @param {string} key - The key of the array in metadata.
+ * @param {DeserializedJson} value - The value to append to the array.
+ *
+ * @example
+ * metadata.append("logs", "User logged in");
+ * metadata.append("events", { type: "click", timestamp: Date.now() });
+ */
+function appendMetadataKey(key, value) {
+    runMetadata.appendKey(key, value);
+}
+/**
+ * Removes a value from an array in the metadata of the current run.
+ *
+ * @param {string} key - The key of the array in metadata.
+ * @param {DeserializedJson} value - The value to remove from the array.
  *
  * @example
- * await metadata.save({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
+ *
+ * metadata.remove("logs", "User logged in");
+ * metadata.remove("events", { type: "click", timestamp: Date.now() });
  */
-async function saveMetadata(metadata, requestOptions) {
+function removeMetadataKey(key, value) {
+    runMetadata.removeFromKey(key, value);
+}
+/**
+ * Flushes metadata to the Trigger.dev instance
+ *
+ * @param {ApiRequestOptions} [requestOptions] - Optional request options to customize the API request.
+ * @returns {Promise<void>} A promise that resolves when the metadata flush operation is complete.
+ */
+async function flushMetadata(requestOptions) {
     const $requestOptions = mergeRequestOptions({
         tracer,
-        name: "metadata.save()",
+        name: "metadata.flush()",
         icon: "code-plus",
-        attributes: {
-            ...flattenAttributes(metadata),
-        },
     }, requestOptions);
-    await runMetadata.update(metadata, $requestOptions);
+    await runMetadata.flush($requestOptions);
+}
+async function stream(key, value, signal) {
+    return runMetadata.stream(key, value, signal);
 }
 //# sourceMappingURL=metadata.js.map

package/dist/esm/v3/metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/v3/metadata.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EAEnB,iBAAiB,EACjB,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;CACnB,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;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,cAAc,CAC3B,GAAW,EACX,KAAuB,EACvB,cAAkC;IAElC,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,WAAW;QACjB,UAAU,EAAE;YACV,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,GAAG;wBACT,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;YACF,GAAG,iBAAiB,CAAC,KAAK,EAAE,GAAG,CAAC;SACjC;KACF,EACD,cAAc,CACf,CAAC;IAEF,MAAM,WAAW,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;AACxD,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,iBAAiB,CAAC,GAAW,EAAE,cAAkC;IAC9E,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,YAAY;QAClB,UAAU,EAAE;YACV,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,GAAG;wBACT,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;YACF,GAAG;SACJ;KACF,EACD,cAAc,CACf,CAAC;IAEF,MAAM,WAAW,CAAC,SAAS,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,YAAY,CACzB,QAAqB,EACrB,cAAkC;IAElC,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,WAAW;QACjB,UAAU,EAAE;YACV,GAAG,iBAAiB,CAAC,QAAQ,CAAC;SAC/B;KACF,EACD,cAAc,CACf,CAAC;IAEF,MAAM,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;AACtD,CAAC"}
+{"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;IACpB,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,iBAAiB;IACzB,MAAM,EAAE,iBAAiB;IACzB,SAAS,EAAE,oBAAoB;IAC/B,SAAS,EAAE,oBAAoB;CAChC,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;;;;;;;;;;GAUG;AACH,SAAS,oBAAoB,CAAC,GAAW,EAAE,QAAgB,CAAC;IAC1D,WAAW,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,oBAAoB,CAAC,GAAW,EAAE,QAAgB,CAAC;IAC1D,WAAW,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,iBAAiB,CAAC,GAAW,EAAE,KAAuB;IAC7D,WAAW,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,iBAAiB,CAAC,GAAW,EAAE,KAAuB;IAC7D,WAAW,CAAC,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACxC,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;AAED,KAAK,UAAU,MAAM,CACnB,GAAW,EACX,KAA2C,EAC3C,MAAoB;IAEpB,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAChD,CAAC"}