@trigger.dev/sdk 0.0.0-prerelease-20240920143613 → 0.0.0-prerelease-20240926084729

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

@@ -0,0 +1,79 @@
+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;
+};
+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.
+ * @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);
+ */
+declare function setMetadataKey(key: string, value: DeserializedJson, requestOptions?: ApiRequestOptions): Promise<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");
+ */
+declare function deleteMetadataKey(key: string, requestOptions?: ApiRequestOptions): Promise<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.
+ *
+ * @example
+ * await metadata.save({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
+ */
+declare function saveMetadata(metadata: RunMetadata, requestOptions?: ApiRequestOptions): Promise<void>;
+export {};

package/dist/esm/v3/metadata.js

@@ -0,0 +1,130 @@
+import { accessoryAttributes, flattenAttributes, 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,
+};
+/**
+ * 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.
+ * @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);
+ */
+async function setMetadataKey(key, value, requestOptions) {
+    const $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "metadata.set()",
+        icon: "code-plus",
+        attributes: {
+            ...accessoryAttributes({
+                items: [
+                    {
+                        text: key,
+                        variant: "normal",
+                    },
+                ],
+                style: "codepath",
+            }),
+            ...flattenAttributes(value, key),
+        },
+    }, requestOptions);
+    await runMetadata.setKey(key, value, $requestOptions);
+}
+/**
+ * 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");
+ */
+async function deleteMetadataKey(key, requestOptions) {
+    const $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "metadata.del()",
+        icon: "code-minus",
+        attributes: {
+            ...accessoryAttributes({
+                items: [
+                    {
+                        text: key,
+                        variant: "normal",
+                    },
+                ],
+                style: "codepath",
+            }),
+            key,
+        },
+    }, requestOptions);
+    await runMetadata.deleteKey(key, $requestOptions);
+}
+/**
+ * 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.
+ *
+ * @example
+ * await metadata.save({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
+ */
+async function saveMetadata(metadata, requestOptions) {
+    const $requestOptions = mergeRequestOptions({
+        tracer,
+        name: "metadata.save()",
+        icon: "code-plus",
+        attributes: {
+            ...flattenAttributes(metadata),
+        },
+    }, requestOptions);
+    await runMetadata.update(metadata, $requestOptions);
+}
+//# sourceMappingURL=metadata.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/v3/metadata.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EAEnB,iBAAiB,EACjB,mBAAmB,EACnB,WAAW,GACZ,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;;;;;;GAQG;AAEH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,OAAO,EAAE,eAAe;IACxB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,iBAAiB;IACtB,IAAI,EAAE,YAAY;CACnB,CAAC;AAIF;;;;;;;;;GASG;AACH,SAAS,eAAe;IACtB,OAAO,WAAW,CAAC,OAAO,EAAE,CAAC;AAC/B,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,cAAc,CAAC,GAAW;IACjC,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,cAAc,CAC3B,GAAW,EACX,KAAuB,EACvB,cAAkC;IAElC,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,WAAW;QACjB,UAAU,EAAE;YACV,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,GAAG;wBACT,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;YACF,GAAG,iBAAiB,CAAC,KAAK,EAAE,GAAG,CAAC;SACjC;KACF,EACD,cAAc,CACf,CAAC;IAEF,MAAM,WAAW,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;AACxD,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,iBAAiB,CAAC,GAAW,EAAE,cAAkC;IAC9E,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,YAAY;QAClB,UAAU,EAAE;YACV,GAAG,mBAAmB,CAAC;gBACrB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,GAAG;wBACT,OAAO,EAAE,QAAQ;qBAClB;iBACF;gBACD,KAAK,EAAE,UAAU;aAClB,CAAC;YACF,GAAG;SACJ;KACF,EACD,cAAc,CACf,CAAC;IAEF,MAAM,WAAW,CAAC,SAAS,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;;;;;GAUG;AACH,KAAK,UAAU,YAAY,CACzB,QAAqB,EACrB,cAAkC;IAElC,MAAM,eAAe,GAAG,mBAAmB,CACzC;QACE,MAAM;QACN,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,WAAW;QACjB,UAAU,EAAE;YACV,GAAG,iBAAiB,CAAC,QAAQ,CAAC;SAC/B;KACF,EACD,cAAc,CACf,CAAC;IAEF,MAAM,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;AACtD,CAAC"}