@trigger.dev/sdk 3.0.12 → 3.1.0

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

@@ -14,25 +14,8 @@ 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 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");
@@ -41,41 +40,23 @@ __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; } });
+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,6CAA2B;AAC3B,uDAAqC;AACrC,4CAA0B;AAC1B,gDAA8B;AAC9B,+CAA6B;AAS7B,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,qCAOmB;AANjB,+FAAA,IAAI,OAAA;AAON,kEAAkD;AAClD,wDAAwC;AAGxC,qCAA4C;AAAnC,oGAAA,SAAS,OAAA;AAAE,+FAAA,IAAI,OAAA"}

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

@@ -15,6 +15,8 @@ export declare const metadata: {
     set: typeof setMetadataKey;
     del: typeof deleteMetadataKey;
     save: typeof saveMetadata;
+    replace: typeof replaceMetadata;
+    flush: typeof flushMetadata;
 };
 export type RunMetadata = Record<string, DeserializedJson>;
 /**
@@ -46,34 +48,40 @@ 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;
+/**
+ * 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/commonjs/v3/metadata.js

@@ -18,6 +18,8 @@ exports.metadata = {
     set: setMetadataKey,
     del: deleteMetadataKey,
     save: saveMetadata,
+    replace: replaceMetadata,
+    flush: flushMetadata,
 };
 /**
  * Returns the metadata of the current run if inside a task run.
@@ -52,82 +54,55 @@ 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 = (0, v3_1.mergeRequestOptions)({
-        tracer: tracer_js_1.tracer,
-        name: "metadata.set()",
-        icon: "code-plus",
-        attributes: {
-            ...(0, v3_1.accessoryAttributes)({
-                items: [
-                    {
-                        text: key,
-                        variant: "normal",
-                    },
-                ],
-                style: "codepath",
-            }),
-            ...(0, v3_1.flattenAttributes)(value, key),
-        },
-    }, requestOptions);
-    await v3_1.runMetadata.setKey(key, value, $requestOptions);
+function setMetadataKey(key, value) {
+    v3_1.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 = (0, v3_1.mergeRequestOptions)({
-        tracer: tracer_js_1.tracer,
-        name: "metadata.del()",
-        icon: "code-minus",
-        attributes: {
-            ...(0, v3_1.accessoryAttributes)({
-                items: [
-                    {
-                        text: key,
-                        variant: "normal",
-                    },
-                ],
-                style: "codepath",
-            }),
-            key,
-        },
-    }, requestOptions);
-    await v3_1.runMetadata.deleteKey(key, $requestOptions);
+function deleteMetadataKey(key) {
+    v3_1.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
- * await metadata.save({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
+ * metadata.replace({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
+ */
+function replaceMetadata(metadata) {
+    v3_1.runMetadata.update(metadata);
+}
+/**
+ * @deprecated Use `metadata.replace()` instead.
+ */
+function saveMetadata(metadata) {
+    v3_1.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 saveMetadata(metadata, requestOptions) {
+async function flushMetadata(requestOptions) {
     const $requestOptions = (0, v3_1.mergeRequestOptions)({
         tracer: tracer_js_1.tracer,
-        name: "metadata.save()",
+        name: "metadata.flush()",
         icon: "code-plus",
-        attributes: {
-            ...(0, v3_1.flattenAttributes)(metadata),
-        },
     }, requestOptions);
-    await v3_1.runMetadata.update(metadata, $requestOptions);
+    await v3_1.runMetadata.flush($requestOptions);
 }
 //# sourceMappingURL=metadata.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/v3/metadata.ts"],"names":[],"mappings":";;;AACA,6CAM8B;AAC9B,2CAAqC;AAErC;;;;;;;;GAQG;AAEU,QAAA,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,gBAAW,CAAC,OAAO,EAAE,CAAC;AAC/B,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,cAAc,CAAC,GAAW;IACjC,OAAO,gBAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,cAAc,CAC3B,GAAW,EACX,KAAuB,EACvB,cAAkC;IAElC,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,WAAW;QACjB,UAAU,EAAE;YACV,GAAG,IAAA,wBAAmB,EAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,GAAG;wBACT,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;YACF,GAAG,IAAA,sBAAiB,EAAC,KAAK,EAAE,GAAG,CAAC;SACjC;KACF,EACD,cAAc,CACf,CAAC;IAEF,MAAM,gBAAW,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,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,YAAY;QAClB,UAAU,EAAE;YACV,GAAG,IAAA,wBAAmB,EAAC;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,gBAAW,CAAC,SAAS,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,YAAY,CACzB,QAAqB,EACrB,cAAkC;IAElC,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,WAAW;QACjB,UAAU,EAAE;YACV,GAAG,IAAA,sBAAiB,EAAC,QAAQ,CAAC;SAC/B;KACF,EACD,cAAc,CACf,CAAC;IAEF,MAAM,gBAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;AACtD,CAAC"}
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/v3/metadata.ts"],"names":[],"mappings":";;;AACA,6CAK8B;AAC9B,2CAAqC;AAErC;;;;;;;;GAQG;AAEU,QAAA,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,gBAAW,CAAC,OAAO,EAAE,CAAC;AAC/B,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,cAAc,CAAC,GAAW;IACjC,OAAO,gBAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,cAAc,CAAC,GAAW,EAAE,KAAuB;IAC1D,gBAAW,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,iBAAiB,CAAC,GAAW;IACpC,gBAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,eAAe,CAAC,QAAqB;IAC5C,gBAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CAAC,QAAqB;IACzC,gBAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,aAAa,CAAC,cAAkC;IAC7D,MAAM,eAAe,GAAG,IAAA,wBAAmB,EACzC;QACE,MAAM,EAAN,kBAAM;QACN,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,WAAW;KAClB,EACD,cAAc,CACf,CAAC;IAEF,MAAM,gBAAW,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;AAC3C,CAAC"}