@trigger.dev/sdk 3.1.0 → 3.1.2

package/dist/browser/v3/idempotencyKeys.js

@@ -1,72 +0,0 @@
-import { taskContext } 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/browser/v3/idempotencyKeys.js.map

@@ -1 +0,0 @@
-{"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/browser/v3/metadata.d.ts

@@ -1,87 +0,0 @@
-import { DeserializedJson } from "@trigger.dev/core";
-import { ApiRequestOptions } from "@trigger.dev/core/v3";
-/**
- * Provides access to run metadata operations.
- * @namespace
- * @property {Function} current - Get the current run's metadata.
- * @property {Function} get - Get a specific key from the current run's metadata.
- * @property {Function} set - Set a key in the current run's metadata.
- * @property {Function} del - Delete a key from the current run's metadata.
- * @property {Function} save - Update the entire metadata object for the current run.
- */
-export declare const metadata: {
-    current: typeof currentMetadata;
-    get: typeof getMetadataKey;
-    set: typeof setMetadataKey;
-    del: typeof deleteMetadataKey;
-    save: typeof saveMetadata;
-    replace: typeof replaceMetadata;
-    flush: typeof flushMetadata;
-};
-export type RunMetadata = Record<string, DeserializedJson>;
-/**
- * Returns the metadata of the current run if inside a task run.
- * This function allows you to access the entire metadata object for the current run.
- *
- * @returns {RunMetadata | undefined} The current run's metadata or undefined if not in a run context.
- *
- * @example
- * const currentMetadata = metadata.current();
- * console.log(currentMetadata);
- */
-declare function currentMetadata(): RunMetadata | undefined;
-/**
- * Get a specific key from the metadata of the current run if inside a task run.
- *
- * @param {string} key - The key to retrieve from the metadata.
- * @returns {DeserializedJson | undefined} The value associated with the key, or undefined if not found or not in a run context.
- *
- * @example
- * const user = metadata.get("user");
- * console.log(user.name); // "Eric"
- * console.log(user.id); // "user_1234"
- */
-declare function getMetadataKey(key: string): DeserializedJson | undefined;
-/**
- * Set a key in the metadata of the current run if inside a task run.
- * This function allows you to update or add a new key-value pair to the run's metadata.
- *
- * @param {string} key - The key to set in the metadata.
- * @param {DeserializedJson} value - The value to associate with the key.
- *
- * @example
- * metadata.set("progress", 0.5);
- */
-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.
- *
- * @example
- * metadata.del("progress");
- */
-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.
- * @returns {void}
- *
- * @example
- * metadata.replace({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
- */
-declare function replaceMetadata(metadata: RunMetadata): void;
-/**
- * @deprecated Use `metadata.replace()` instead.
- */
-declare function saveMetadata(metadata: RunMetadata): 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>;
-export {};

package/dist/browser/v3/metadata.js

@@ -1,105 +0,0 @@
-import { mergeRequestOptions, runMetadata, } from "@trigger.dev/core/v3";
-import { tracer } from "./tracer.js";
-/**
- * Provides access to run metadata operations.
- * @namespace
- * @property {Function} current - Get the current run's metadata.
- * @property {Function} get - Get a specific key from the current run's metadata.
- * @property {Function} set - Set a key in the current run's metadata.
- * @property {Function} del - Delete a key from the current run's metadata.
- * @property {Function} save - Update the entire metadata object for the current run.
- */
-export const metadata = {
-    current: currentMetadata,
-    get: getMetadataKey,
-    set: setMetadataKey,
-    del: deleteMetadataKey,
-    save: saveMetadata,
-    replace: replaceMetadata,
-    flush: flushMetadata,
-};
-/**
- * Returns the metadata of the current run if inside a task run.
- * This function allows you to access the entire metadata object for the current run.
- *
- * @returns {RunMetadata | undefined} The current run's metadata or undefined if not in a run context.
- *
- * @example
- * const currentMetadata = metadata.current();
- * console.log(currentMetadata);
- */
-function currentMetadata() {
-    return runMetadata.current();
-}
-/**
- * Get a specific key from the metadata of the current run if inside a task run.
- *
- * @param {string} key - The key to retrieve from the metadata.
- * @returns {DeserializedJson | undefined} The value associated with the key, or undefined if not found or not in a run context.
- *
- * @example
- * const user = metadata.get("user");
- * console.log(user.name); // "Eric"
- * console.log(user.id); // "user_1234"
- */
-function getMetadataKey(key) {
-    return runMetadata.getKey(key);
-}
-/**
- * Set a key in the metadata of the current run if inside a task run.
- * This function allows you to update or add a new key-value pair to the run's metadata.
- *
- * @param {string} key - The key to set in the metadata.
- * @param {DeserializedJson} value - The value to associate with the key.
- *
- * @example
- * metadata.set("progress", 0.5);
- */
-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.
- *
- * @example
- * metadata.del("progress");
- */
-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.
- * @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);
-}
-/**
- * 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.flush()",
-        icon: "code-plus",
-    }, requestOptions);
-    await runMetadata.flush($requestOptions);
-}
-//# sourceMappingURL=metadata.js.map

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

@@ -1 +0,0 @@
-{"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"}

package/dist/browser/v3/retry.d.ts

@@ -1,15 +0,0 @@
-import { FetchRetryOptions, RetryOptions } from "@trigger.dev/core/v3";
-export type { RetryOptions };
-declare function onThrow<T>(fn: (options: {
-    attempt: number;
-    maxAttempts: number;
-}) => Promise<T>, options: RetryOptions): Promise<T>;
-export interface RetryFetchRequestInit extends RequestInit {
-    retry?: FetchRetryOptions;
-    timeoutInMs?: number;
-}
-declare function retryFetch(input: RequestInfo | URL, init?: RetryFetchRequestInit | undefined): Promise<Response>;
-export declare const retry: {
-    onThrow: typeof onThrow;
-    fetch: typeof retryFetch;
-};