@trigger.dev/sdk 3.0.12 → 3.1.0

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

@@ -0,0 +1,104 @@
+import { type ApiClientConfiguration } 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 declare function configure(options: ApiClientConfiguration): void;
+export declare const auth: {
+    configure: typeof configure;
+    createPublicToken: typeof createPublicToken;
+    withAuth: typeof withAuth;
+};
+type PublicTokenPermissionAction = "read";
+type PublicTokenPermissionProperties = {
+    /**
+     * Grant access to specific tasks
+     */
+    tasks?: string | string[];
+    /**
+     * Grant access to specific run tags
+     */
+    tags?: string | string[];
+    /**
+     * Grant access to specific runs
+     */
+    runs?: string | string[] | true;
+    /**
+     * Grant access to specific batch runs
+     */
+    batch?: string | string[];
+};
+export type PublicTokenPermissions = {
+    [key in PublicTokenPermissionAction]?: PublicTokenPermissionProperties;
+};
+export type CreatePublicTokenOptions = {
+    /**
+     * A collection of permission scopes to be granted to the token.
+     *
+     * @example
+     *
+     * ```typescript
+     * scopes: {
+     *   read: {
+     *     tags: ["file:1234"]
+     *   }
+     * }
+     * ```
+     */
+    scopes?: PublicTokenPermissions;
+    /**
+     * The expiration time for the token. This can be a number representing the time in milliseconds, a `Date` object, or a string.
+     *
+     * @example
+     *
+     * ```typescript
+     * expirationTime: "1h"
+     * ```
+     */
+    expirationTime?: number | Date | string;
+};
+/**
+ * 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"]
+ *   }
+ * });
+ * ```
+ */
+declare function createPublicToken(options?: CreatePublicTokenOptions): Promise<string>;
+/**
+ * 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.
+ */
+declare function withAuth<R extends (...args: any[]) => Promise<any>>(config: ApiClientConfiguration, fn: R): Promise<ReturnType<R>>;
+export {};

package/dist/browser/v3/auth.js

@@ -0,0 +1,95 @@
+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}`);
+                    }
+                }
+            }
+        }
+    }
+    return flattenedPermissions;
+}
+//# sourceMappingURL=auth.js.map

package/dist/browser/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;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC"}

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

@@ -0,0 +1,28 @@
+export type CacheMetadata = {
+    createdTime: number;
+    ttl?: number | null;
+};
+export type CacheEntry<Value = unknown> = {
+    metadata: CacheMetadata;
+    value: Value;
+};
+export type Eventually<Value> = Value | null | undefined | Promise<Value | null | undefined>;
+export type CacheStore<Value = any> = {
+    name?: string;
+    get: (key: string) => Eventually<CacheEntry<Value>>;
+    set: (key: string, value: CacheEntry<Value>) => unknown | Promise<unknown>;
+    delete: (key: string) => unknown | Promise<unknown>;
+};
+export type CacheFunction = <Value>(cacheKey: string, fn: () => Promise<Value> | Value) => Promise<Value> | Value;
+export declare class InMemoryCache<Value = any> {
+    private _cache;
+    get(key: string): Eventually<CacheEntry<Value>>;
+    set(key: string, value: CacheEntry<Value>): unknown;
+    delete(key: string): unknown;
+}
+/**
+ * Create a cache function that uses the provided store to cache values. Using InMemoryCache is safe because each task run is isolated.
+ * @param store
+ * @returns
+ */
+export declare function createCache(store: CacheStore): CacheFunction;

package/dist/browser/v3/cache.js

@@ -0,0 +1,58 @@
+import { SemanticInternalAttributes } from "@trigger.dev/core/v3";
+import { tracer } from "./tracer.js";
+export class InMemoryCache {
+    _cache = new Map();
+    get(key) {
+        return this._cache.get(key);
+    }
+    set(key, value) {
+        this._cache.set(key, value);
+        return undefined;
+    }
+    delete(key) {
+        this._cache.delete(key);
+        return undefined;
+    }
+}
+/**
+ * Create a cache function that uses the provided store to cache values. Using InMemoryCache is safe because each task run is isolated.
+ * @param store
+ * @returns
+ */
+export function createCache(store) {
+    return function cache(cacheKey, fn) {
+        return tracer.startActiveSpan("cache", async (span) => {
+            span.setAttribute("cache.key", cacheKey);
+            span.setAttribute(SemanticInternalAttributes.STYLE_ICON, "device-sd-card");
+            const cacheEntry = await store.get(cacheKey);
+            if (cacheEntry) {
+                span.updateName(`cache.hit ${cacheKey}`);
+                return cacheEntry.value;
+            }
+            span.updateName(`cache.miss ${cacheKey}`);
+            const value = await tracer.startActiveSpan("cache.getFreshValue", async (span) => {
+                return await fn();
+            }, {
+                attributes: {
+                    "cache.key": cacheKey,
+                    [SemanticInternalAttributes.STYLE_ICON]: "device-sd-card",
+                },
+            });
+            await tracer.startActiveSpan("cache.set", async (span) => {
+                await store.set(cacheKey, {
+                    value,
+                    metadata: {
+                        createdTime: Date.now(),
+                    },
+                });
+            }, {
+                attributes: {
+                    "cache.key": cacheKey,
+                    [SemanticInternalAttributes.STYLE_ICON]: "device-sd-card",
+                },
+            });
+            return value;
+        });
+    };
+}
+//# sourceMappingURL=cache.js.map

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

@@ -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"}

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

@@ -0,0 +1,4 @@
+import type { TriggerConfig } from "@trigger.dev/core/v3";
+export type { HandleErrorArgs, HandleErrorFunction, ResolveEnvironmentVariablesFunction, ResolveEnvironmentVariablesParams, ResolveEnvironmentVariablesResult, } from "@trigger.dev/core/v3";
+export declare function defineConfig(config: TriggerConfig): TriggerConfig;
+export type { TriggerConfig };

package/dist/browser/v3/config.js

@@ -0,0 +1,4 @@
+export function defineConfig(config) {
+    return config;
+}
+//# sourceMappingURL=config.js.map

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

@@ -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"}

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

@@ -0,0 +1,14 @@
+import type { ApiPromise, ApiRequestOptions, CreateEnvironmentVariableParams, EnvironmentVariableResponseBody, EnvironmentVariableValue, EnvironmentVariables, ImportEnvironmentVariablesParams, UpdateEnvironmentVariableParams } from "@trigger.dev/core/v3";
+export type { CreateEnvironmentVariableParams, ImportEnvironmentVariablesParams };
+export declare function upload(projectRef: string, slug: string, params: ImportEnvironmentVariablesParams, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
+export declare function upload(params: ImportEnvironmentVariablesParams, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
+export declare function list(projectRef: string, slug: string, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariables>;
+export declare function list(requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariables>;
+export declare function create(projectRef: string, slug: string, params: CreateEnvironmentVariableParams, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
+export declare function create(params: CreateEnvironmentVariableParams, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
+export declare function retrieve(projectRef: string, slug: string, name: string, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableValue>;
+export declare function retrieve(name: string, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableValue>;
+export declare function del(projectRef: string, slug: string, name: string, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
+export declare function del(name: string, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
+export declare function update(projectRef: string, slug: string, name: string, params: UpdateEnvironmentVariableParams, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;
+export declare function update(name: string, params: UpdateEnvironmentVariableParams, requestOptions?: ApiRequestOptions): ApiPromise<EnvironmentVariableResponseBody>;

package/dist/browser/v3/envvars.js

@@ -0,0 +1,219 @@
+import { apiClientManager, isRequestOptions, mergeRequestOptions, taskContext, } from "@trigger.dev/core/v3";
+import { tracer } from "./tracer.js";
+export function upload(projectRefOrParams, slugOrRequestOptions, params, requestOptions) {
+    let $projectRef;
+    let $params;
+    let $slug;
+    const $requestOptions = overloadRequestOptions("upload", slugOrRequestOptions, requestOptions);
+    if (taskContext.ctx) {
+        if (typeof projectRefOrParams === "string") {
+            $projectRef = projectRefOrParams;
+            $slug =
+                typeof slugOrRequestOptions === "string"
+                    ? slugOrRequestOptions
+                    : taskContext.ctx.environment.slug;
+            if (!params) {
+                throw new Error("params is required");
+            }
+            $params = params;
+        }
+        else {
+            $params = projectRefOrParams;
+            $projectRef = taskContext.ctx.project.ref;
+            $slug = taskContext.ctx.environment.slug;
+        }
+    }
+    else {
+        if (typeof projectRefOrParams !== "string") {
+            throw new Error("projectRef is required");
+        }
+        if (!slugOrRequestOptions || typeof slugOrRequestOptions !== "string") {
+            throw new Error("slug is required");
+        }
+        if (!params) {
+            throw new Error("params is required");
+        }
+        $projectRef = projectRefOrParams;
+        $slug = slugOrRequestOptions;
+        $params = params;
+    }
+    const apiClient = apiClientManager.clientOrThrow();
+    return apiClient.importEnvVars($projectRef, $slug, $params, $requestOptions);
+}
+export function list(projectRefOrRequestOptions, slug, requestOptions) {
+    const $projectRef = !isRequestOptions(projectRefOrRequestOptions)
+        ? projectRefOrRequestOptions
+        : taskContext.ctx?.project.ref;
+    const $slug = slug ?? taskContext.ctx?.environment.slug;
+    let $requestOptions = isRequestOptions(projectRefOrRequestOptions)
+        ? projectRefOrRequestOptions
+        : requestOptions;
+    if (!$projectRef) {
+        throw new Error("projectRef is required");
+    }
+    if (!$slug) {
+        throw new Error("slug is required");
+    }
+    $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "envvars.list()",
+        icon: "id-badge",
+    }, $requestOptions);
+    const apiClient = apiClientManager.clientOrThrow();
+    return apiClient.listEnvVars($projectRef, $slug, $requestOptions);
+}
+export function create(projectRefOrParams, slugOrRequestOptions, params, requestOptions) {
+    let $projectRef;
+    let $slug;
+    let $params;
+    const $requestOptions = overloadRequestOptions("create", slugOrRequestOptions, requestOptions);
+    if (taskContext.ctx) {
+        if (typeof projectRefOrParams === "string") {
+            $projectRef = projectRefOrParams;
+            $slug =
+                typeof slugOrRequestOptions === "string"
+                    ? slugOrRequestOptions
+                    : taskContext.ctx.environment.slug;
+            if (!params) {
+                throw new Error("params is required");
+            }
+            $params = params;
+        }
+        else {
+            $params = projectRefOrParams;
+            $projectRef = taskContext.ctx.project.ref;
+            $slug = taskContext.ctx.environment.slug;
+        }
+    }
+    else {
+        if (typeof projectRefOrParams !== "string") {
+            throw new Error("projectRef is required");
+        }
+        if (!slugOrRequestOptions || typeof slugOrRequestOptions !== "string") {
+            throw new Error("slug is required");
+        }
+        if (!params) {
+            throw new Error("params is required");
+        }
+        $projectRef = projectRefOrParams;
+        $slug = slugOrRequestOptions;
+        $params = params;
+    }
+    const apiClient = apiClientManager.clientOrThrow();
+    return apiClient.createEnvVar($projectRef, $slug, $params, $requestOptions);
+}
+export function retrieve(projectRefOrName, slugOrRequestOptions, name, requestOptions) {
+    let $projectRef;
+    let $slug;
+    let $name;
+    const $requestOptions = overloadRequestOptions("retrieve", slugOrRequestOptions, requestOptions);
+    if (typeof name === "string") {
+        $projectRef = projectRefOrName;
+        $slug =
+            typeof slugOrRequestOptions === "string"
+                ? slugOrRequestOptions
+                : taskContext.ctx?.environment.slug;
+        $name = name;
+    }
+    else {
+        $projectRef = taskContext.ctx?.project.ref;
+        $slug = taskContext.ctx?.environment.slug;
+        $name = projectRefOrName;
+    }
+    if (!$projectRef) {
+        throw new Error("projectRef is required");
+    }
+    if (!$slug) {
+        throw new Error("slug is required");
+    }
+    const apiClient = apiClientManager.clientOrThrow();
+    return apiClient.retrieveEnvVar($projectRef, $slug, $name, $requestOptions);
+}
+export function del(projectRefOrName, slugOrRequestOptions, name, requestOptions) {
+    let $projectRef;
+    let $slug;
+    let $name;
+    const $requestOptions = overloadRequestOptions("del", slugOrRequestOptions, requestOptions);
+    if (typeof name === "string") {
+        $projectRef = projectRefOrName;
+        $slug =
+            typeof slugOrRequestOptions === "string"
+                ? slugOrRequestOptions
+                : taskContext.ctx?.environment.slug;
+        $name = name;
+    }
+    else {
+        $projectRef = taskContext.ctx?.project.ref;
+        $slug = taskContext.ctx?.environment.slug;
+        $name = projectRefOrName;
+    }
+    if (!$projectRef) {
+        throw new Error("projectRef is required");
+    }
+    if (!$slug) {
+        throw new Error("slug is required");
+    }
+    const apiClient = apiClientManager.clientOrThrow();
+    return apiClient.deleteEnvVar($projectRef, $slug, $name, $requestOptions);
+}
+export function update(projectRefOrName, slugOrParams, nameOrRequestOptions, params, requestOptions) {
+    let $projectRef;
+    let $slug;
+    let $name;
+    let $params;
+    const $requestOptions = overloadRequestOptions("update", nameOrRequestOptions, requestOptions);
+    if (taskContext.ctx) {
+        if (typeof slugOrParams === "string") {
+            $projectRef = slugOrParams;
+            $slug = slugOrParams ?? taskContext.ctx.environment.slug;
+            $name =
+                typeof nameOrRequestOptions === "string"
+                    ? nameOrRequestOptions
+                    : taskContext.ctx.environment.slug;
+            if (!params) {
+                throw new Error("params is required");
+            }
+            $params = params;
+        }
+        else {
+            $params = slugOrParams;
+            $projectRef = taskContext.ctx.project.ref;
+            $slug = taskContext.ctx.environment.slug;
+            $name = projectRefOrName;
+        }
+    }
+    else {
+        if (typeof slugOrParams !== "string") {
+            throw new Error("slug is required");
+        }
+        if (!projectRefOrName) {
+            throw new Error("projectRef is required");
+        }
+        if (!params) {
+            throw new Error("params is required");
+        }
+        $projectRef = projectRefOrName;
+        $slug = slugOrParams;
+        $name = name;
+        $params = params;
+    }
+    const apiClient = apiClientManager.clientOrThrow();
+    return apiClient.updateEnvVar($projectRef, $slug, $name, $params, $requestOptions);
+}
+function overloadRequestOptions(name, slugOrRequestOptions, requestOptions) {
+    if (isRequestOptions(slugOrRequestOptions)) {
+        return mergeRequestOptions({
+            tracer,
+            name: `envvars.${name}()`,
+            icon: "id-badge",
+        }, slugOrRequestOptions);
+    }
+    else {
+        return mergeRequestOptions({
+            tracer,
+            name: `envvars.${name}()`,
+            icon: "id-badge",
+        }, requestOptions);
+    }
+}
+//# sourceMappingURL=envvars.js.map

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

@@ -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"}

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

@@ -0,0 +1,44 @@
+import { type IdempotencyKey } from "@trigger.dev/core/v3";
+export declare const idempotencyKeys: {
+    create: typeof createIdempotencyKey;
+};
+export type { 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>;