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

package/dist/commonjs/triggers/invokeTrigger.d.ts

@@ -20,8 +20,8 @@ export declare class InvokeTrigger<TSchema extends ZodType = z.ZodTypeAny> imple
         title: string;
         source: string;
         examples: {
-            name: string;
             id: string;
+            name: string;
             icon?: string | undefined;
             payload?: any;
         }[];

package/dist/commonjs/types.d.ts

@@ -116,13 +116,13 @@ export declare const EventSpecificationExampleSchema: z.ZodObject<{
     icon: z.ZodOptional<z.ZodString>;
     payload: z.ZodAny;
 }, "strip", z.ZodTypeAny, {
-    name: string;
     id: string;
+    name: string;
     icon?: string | undefined;
     payload?: any;
 }, {
-    name: string;
     id: string;
+    name: string;
     icon?: string | undefined;
     payload?: any;
 }>;
@@ -181,17 +181,17 @@ export declare function waitForEventSchema(schema: z.ZodTypeAny): z.ZodObject<{
     context: z.ZodOptional<z.ZodAny>;
     accountId: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
+    id: string;
     name: string;
     source: string;
-    id: string;
     timestamp: Date;
     payload?: any;
     context?: any;
     accountId?: string | undefined;
 }, {
+    id: string;
     name: string;
     source: string;
-    id: string;
     timestamp: Date;
     payload?: any;
     context?: any;

package/dist/commonjs/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" | "write";
+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/commonjs/v3/auth.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.auth = void 0;
+exports.configure = configure;
+const v3_1 = require("@trigger.dev/core/v3");
+const v3_2 = require("@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"
+ * });
+ * ```
+ */
+function configure(options) {
+    v3_1.apiClientManager.setGlobalAPIClientConfiguration(options);
+}
+exports.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 = v3_1.apiClientManager.clientOrThrow();
+    const claims = await apiClient.generateJWTClaims();
+    return await (0, v3_2.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 v3_1.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/commonjs/v3/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../../src/v3/auth.ts"],"names":[],"mappings":";;;AAoBA,8BAEC;AAtBD,6CAAqF;AACrF,6CAA2E;AAE3E;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,SAAS,CAAC,OAA+B;IACvD,qBAAgB,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;AAC5D,CAAC;AAEY,QAAA,IAAI,GAAG;IAClB,SAAS;IACT,iBAAiB;IACjB,QAAQ;CACT,CAAC;AA0DF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,KAAK,UAAU,iBAAiB,CAAC,OAAkC;IACjE,MAAM,SAAS,GAAG,qBAAgB,CAAC,aAAa,EAAE,CAAC;IAEnD,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,iBAAiB,EAAE,CAAC;IAEnD,OAAO,MAAM,IAAA,gBAAoB,EAAC;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,qBAAgB,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/commonjs/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/commonjs/v3/idempotencyKeys.js

@@ -1,76 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.idempotencyKeys = void 0;
-exports.isIdempotencyKey = isIdempotencyKey;
 const v3_1 = require("@trigger.dev/core/v3");
 exports.idempotencyKeys = {
-    create: createIdempotencyKey,
+    create: v3_1.createIdempotencyKey,
 };
-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 (v3_1.taskContext?.ctx) {
-                return [v3_1.taskContext.ctx.run.id];
-            }
-            break;
-        }
-        case "attempt": {
-            if (v3_1.taskContext?.ctx) {
-                return [v3_1.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/commonjs/v3/idempotencyKeys.js.map

@@ -1 +1 @@
-{"version":3,"file":"idempotencyKeys.js","sourceRoot":"","sources":["../../../src/v3/idempotencyKeys.ts"],"names":[],"mappings":";;;AAYA,4CAKC;AAjBD,6CAAmD;AAEtC,QAAA,eAAe,GAAG;IAC7B,MAAM,EAAE,oBAAoB;CAC7B,CAAC;AAQF,SAAgB,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,gBAAW,EAAE,GAAG,EAAE,CAAC;gBACrB,OAAO,CAAC,gBAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAClC,CAAC;YACD,MAAM;QACR,CAAC;QACD,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,IAAI,gBAAW,EAAE,GAAG,EAAE,CAAC;gBACrB,OAAO,CAAC,gBAAW,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,6CAAiF;AAEpE,QAAA,eAAe,GAAG;IAC7B,MAAM,EAAE,yBAAoB;CAC7B,CAAC"}

package/dist/commonjs/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/commonjs/v3/index.js

@@ -26,8 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.envvars = exports.schedules = exports.runs = exports.logger = exports.AbortTaskRunError = exports.UnprocessableEntityError = exports.RateLimitError = exports.PermissionDeniedError = exports.NotFoundError = exports.InternalServerError = exports.ConflictError = exports.BadRequestError = exports.AuthenticationError = exports.ApiError = exports.queue = exports.retry = void 0;
-exports.configure = configure;
+exports.auth = exports.configure = exports.envvars = exports.schedules = exports.runs = exports.logger = exports.AbortTaskRunError = exports.UnprocessableEntityError = exports.RateLimitError = exports.PermissionDeniedError = exports.NotFoundError = exports.InternalServerError = exports.ConflictError = exports.BadRequestError = exports.AuthenticationError = exports.ApiError = exports.queue = exports.retry = void 0;
 __exportStar(require("./cache.js"), exports);
 __exportStar(require("./config.js"), exports);
 var retry_js_1 = require("./retry.js");
@@ -36,46 +35,30 @@ var shared_js_1 = require("./shared.js");
 Object.defineProperty(exports, "queue", { enumerable: true, get: function () { return shared_js_1.queue; } });
 __exportStar(require("./tasks.js"), exports);
 __exportStar(require("./wait.js"), exports);
+__exportStar(require("./waitUntil.js"), exports);
 __exportStar(require("./usage.js"), exports);
 __exportStar(require("./idempotencyKeys.js"), exports);
 __exportStar(require("./tags.js"), exports);
 __exportStar(require("./metadata.js"), exports);
 __exportStar(require("./timeout.js"), exports);
-const v3_1 = require("@trigger.dev/core/v3");
-var v3_2 = require("@trigger.dev/core/v3");
-Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return v3_2.ApiError; } });
-Object.defineProperty(exports, "AuthenticationError", { enumerable: true, get: function () { return v3_2.AuthenticationError; } });
-Object.defineProperty(exports, "BadRequestError", { enumerable: true, get: function () { return v3_2.BadRequestError; } });
-Object.defineProperty(exports, "ConflictError", { enumerable: true, get: function () { return v3_2.ConflictError; } });
-Object.defineProperty(exports, "InternalServerError", { enumerable: true, get: function () { return v3_2.InternalServerError; } });
-Object.defineProperty(exports, "NotFoundError", { enumerable: true, get: function () { return v3_2.NotFoundError; } });
-Object.defineProperty(exports, "PermissionDeniedError", { enumerable: true, get: function () { return v3_2.PermissionDeniedError; } });
-Object.defineProperty(exports, "RateLimitError", { enumerable: true, get: function () { return v3_2.RateLimitError; } });
-Object.defineProperty(exports, "UnprocessableEntityError", { enumerable: true, get: function () { return v3_2.UnprocessableEntityError; } });
-Object.defineProperty(exports, "AbortTaskRunError", { enumerable: true, get: function () { return v3_2.AbortTaskRunError; } });
-Object.defineProperty(exports, "logger", { enumerable: true, get: function () { return v3_2.logger; } });
+__exportStar(require("./waitUntil.js"), exports);
+var v3_1 = require("@trigger.dev/core/v3");
+Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return v3_1.ApiError; } });
+Object.defineProperty(exports, "AuthenticationError", { enumerable: true, get: function () { return v3_1.AuthenticationError; } });
+Object.defineProperty(exports, "BadRequestError", { enumerable: true, get: function () { return v3_1.BadRequestError; } });
+Object.defineProperty(exports, "ConflictError", { enumerable: true, get: function () { return v3_1.ConflictError; } });
+Object.defineProperty(exports, "InternalServerError", { enumerable: true, get: function () { return v3_1.InternalServerError; } });
+Object.defineProperty(exports, "NotFoundError", { enumerable: true, get: function () { return v3_1.NotFoundError; } });
+Object.defineProperty(exports, "PermissionDeniedError", { enumerable: true, get: function () { return v3_1.PermissionDeniedError; } });
+Object.defineProperty(exports, "RateLimitError", { enumerable: true, get: function () { return v3_1.RateLimitError; } });
+Object.defineProperty(exports, "UnprocessableEntityError", { enumerable: true, get: function () { return v3_1.UnprocessableEntityError; } });
+Object.defineProperty(exports, "AbortTaskRunError", { enumerable: true, get: function () { return v3_1.AbortTaskRunError; } });
+Object.defineProperty(exports, "logger", { enumerable: true, get: function () { return v3_1.logger; } });
 var runs_js_1 = require("./runs.js");
 Object.defineProperty(exports, "runs", { enumerable: true, get: function () { return runs_js_1.runs; } });
 exports.schedules = __importStar(require("./schedules/index.js"));
 exports.envvars = __importStar(require("./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"
- * });
- * ```
- */
-function configure(options) {
-    v3_1.apiClientManager.setGlobalAPIClientConfiguration(options);
-}
+var auth_js_1 = require("./auth.js");
+Object.defineProperty(exports, "configure", { enumerable: true, get: function () { return auth_js_1.configure; } });
+Object.defineProperty(exports, "auth", { enumerable: true, get: function () { return auth_js_1.auth; } });
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v3/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyDA,8BAEC;AA3DD,6CAA2B;AAC3B,8CAA4B;AAC5B,uCAAsD;AAA7C,iGAAA,KAAK,OAAA;AACd,yCAAoC;AAA3B,kGAAA,KAAK,OAAA;AACd,6CAA2B;AAC3B,4CAA0B;AAC1B,6CAA2B;AAC3B,uDAAqC;AACrC,4CAA0B;AAC1B,gDAA8B;AAC9B,+CAA6B;AAM7B,6CAAwD;AAIxD,2CAa8B;AAZ5B,8FAAA,QAAQ,OAAA;AACR,yGAAA,mBAAmB,OAAA;AACnB,qGAAA,eAAe,OAAA;AACf,mGAAA,aAAa,OAAA;AACb,yGAAA,mBAAmB,OAAA;AACnB,mGAAA,aAAa,OAAA;AACb,2GAAA,qBAAqB,OAAA;AACrB,oGAAA,cAAc,OAAA;AACd,8GAAA,wBAAwB,OAAA;AACxB,uGAAA,iBAAiB,OAAA;AACjB,4FAAA,MAAM,OAAA;AAIR,qCAAiC;AAAxB,+FAAA,IAAI,OAAA;AACb,kEAAkD;AAClD,wDAAwC;AAGxC;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,SAAS,CAAC,OAA+B;IACvD,qBAAgB,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;AAC5D,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v3/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,8CAA4B;AAC5B,uCAAsD;AAA7C,iGAAA,KAAK,OAAA;AACd,yCAAoC;AAA3B,kGAAA,KAAK,OAAA;AACd,6CAA2B;AAC3B,4CAA0B;AAC1B,iDAA+B;AAC/B,6CAA2B;AAC3B,uDAAqC;AACrC,4CAA0B;AAC1B,gDAA8B;AAC9B,+CAA6B;AAC7B,iDAA+B;AAS/B,2CAa8B;AAZ5B,8FAAA,QAAQ,OAAA;AACR,yGAAA,mBAAmB,OAAA;AACnB,qGAAA,eAAe,OAAA;AACf,mGAAA,aAAa,OAAA;AACb,yGAAA,mBAAmB,OAAA;AACnB,mGAAA,aAAa,OAAA;AACb,2GAAA,qBAAqB,OAAA;AACrB,oGAAA,cAAc,OAAA;AACd,8GAAA,wBAAwB,OAAA;AACxB,uGAAA,iBAAiB,OAAA;AACjB,4FAAA,MAAM,OAAA;AAIR,qCAQmB;AAPjB,+FAAA,IAAI,OAAA;AAQN,kEAAkD;AAClD,wDAAwC;AAGxC,qCAA4C;AAAnC,oGAAA,SAAS,OAAA;AAAE,+FAAA,IAAI,OAAA"}

package/dist/commonjs/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 {};