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

package/dist/commonjs/v3/metadata.js

@@ -18,6 +18,13 @@ exports.metadata = {
     set: setMetadataKey,
     del: deleteMetadataKey,
     save: saveMetadata,
+    replace: replaceMetadata,
+    flush: flushMetadata,
+    stream: stream,
+    append: appendMetadataKey,
+    remove: removeMetadataKey,
+    increment: incrementMetadataKey,
+    decrement: decrementMetadataKey,
 };
 /**
  * Returns the metadata of the current run if inside a task run.
@@ -52,82 +59,115 @@ 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
+ * 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);
+}
+/**
+ * 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
+ */
+function incrementMetadataKey(key, value = 1) {
+    v3_1.runMetadata.incrementKey(key, value);
+}
+/**
+ * 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
+ */
+function decrementMetadataKey(key, value = 1) {
+    v3_1.runMetadata.decrementKey(key, value);
+}
+/**
+ * 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() });
+ */
+function appendMetadataKey(key, value) {
+    v3_1.runMetadata.appendKey(key, value);
+}
+/**
+ * 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
- * await metadata.save({ progress: 0.6, user: { name: "Alice", id: "user_5678" } });
+ *
+ * metadata.remove("logs", "User logged in");
+ * metadata.remove("events", { type: "click", timestamp: Date.now() });
  */
-async function saveMetadata(metadata, requestOptions) {
+function removeMetadataKey(key, value) {
+    v3_1.runMetadata.removeFromKey(key, value);
+}
+/**
+ * Flushes metadata to the Trigger.dev instance
+ *
+ * @param {ApiRequestOptions} [requestOptions] - Optional request options to customize the API request.
+ * @returns {Promise<void>} A promise that resolves when the metadata flush operation is complete.
+ */
+async function flushMetadata(requestOptions) {
     const $requestOptions = (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);
+}
+async function stream(key, value, signal) {
+    return v3_1.runMetadata.stream(key, value, signal);
 }
 //# 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;IACpB,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,iBAAiB;IACzB,MAAM,EAAE,iBAAiB;IACzB,SAAS,EAAE,oBAAoB;IAC/B,SAAS,EAAE,oBAAoB;CAChC,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;;;;;;;;;;GAUG;AACH,SAAS,oBAAoB,CAAC,GAAW,EAAE,QAAgB,CAAC;IAC1D,gBAAW,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,oBAAoB,CAAC,GAAW,EAAE,QAAgB,CAAC;IAC1D,gBAAW,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,iBAAiB,CAAC,GAAW,EAAE,KAAuB;IAC7D,gBAAW,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,iBAAiB,CAAC,GAAW,EAAE,KAAuB;IAC7D,gBAAW,CAAC,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACxC,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;AAED,KAAK,UAAU,MAAM,CACnB,GAAW,EACX,KAA2C,EAC3C,MAAoB;IAEpB,OAAO,gBAAW,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAChD,CAAC"}