@upstash/qstash 2.9.0 → 2.9.1-rc.1

package/workflow.d.mts

@@ -1,2 +1,2 @@
-export { am as AsyncStepFunction, af as DisabledWorkflowContext, F as FailureFunctionPayload, ap as FinishCondition, ar as LogLevel, ao as ParallelCallState, ak as RawStep, aq as RequiredExceptFields, a9 as RouteFunction, S as Step, an as StepFunction, aj as StepType, ai as StepTypes, al as SyncStepFunction, ab as Workflow, ag as WorkflowClient, ae as WorkflowContext, at as WorkflowLogger, as as WorkflowLoggerOptions, ah as WorkflowReceiver, aa as WorkflowServeOptions, ac as processOptions, ad as serve } from './client-BVG9vt90.mjs';
+export { an as AsyncStepFunction, ag as DisabledWorkflowContext, F as FailureFunctionPayload, aq as FinishCondition, as as LogLevel, ap as ParallelCallState, al as RawStep, ar as RequiredExceptFields, aa as RouteFunction, S as Step, ao as StepFunction, ak as StepType, aj as StepTypes, am as SyncStepFunction, ac as Workflow, ah as WorkflowClient, af as WorkflowContext, au as WorkflowLogger, at as WorkflowLoggerOptions, ai as WorkflowReceiver, ab as WorkflowServeOptions, ad as processOptions, ae as serve } from './client-Gv4WRTxB.mjs';
 import 'neverthrow';

package/workflow.d.ts

@@ -1,2 +1,2 @@
-export { am as AsyncStepFunction, af as DisabledWorkflowContext, F as FailureFunctionPayload, ap as FinishCondition, ar as LogLevel, ao as ParallelCallState, ak as RawStep, aq as RequiredExceptFields, a9 as RouteFunction, S as Step, an as StepFunction, aj as StepType, ai as StepTypes, al as SyncStepFunction, ab as Workflow, ag as WorkflowClient, ae as WorkflowContext, at as WorkflowLogger, as as WorkflowLoggerOptions, ah as WorkflowReceiver, aa as WorkflowServeOptions, ac as processOptions, ad as serve } from './client-BVG9vt90.js';
+export { an as AsyncStepFunction, ag as DisabledWorkflowContext, F as FailureFunctionPayload, aq as FinishCondition, as as LogLevel, ap as ParallelCallState, al as RawStep, ar as RequiredExceptFields, aa as RouteFunction, S as Step, ao as StepFunction, ak as StepType, aj as StepTypes, am as SyncStepFunction, ac as Workflow, ah as WorkflowClient, af as WorkflowContext, au as WorkflowLogger, at as WorkflowLoggerOptions, ai as WorkflowReceiver, ab as WorkflowServeOptions, ad as processOptions, ae as serve } from './client-Gv4WRTxB.js';
 import 'neverthrow';

package/workflow.js

@@ -398,6 +398,43 @@ function decodeBase64(base64) {
     }
   }
 }
+function buildBulkActionFilterPayload(request, options) {
+  const hasDlqIds = "dlqIds" in request && request.dlqIds !== void 0;
+  const hasAll = "all" in request && Boolean(request.all);
+  const filterKeys = Object.keys(request).filter((k) => k !== "dlqIds" && k !== "all");
+  const hasFilters = filterKeys.length > 0;
+  if (hasDlqIds && hasAll) {
+    throw new QstashError("dlqIds and all: true are mutually exclusive.");
+  }
+  if (hasDlqIds && hasFilters) {
+    throw new QstashError(
+      `dlqIds cannot be combined with filter fields: ${filterKeys.join(", ")}.`
+    );
+  }
+  if (hasAll && hasFilters) {
+    throw new QstashError(
+      `all: true cannot be combined with filter fields: ${filterKeys.join(", ")}.`
+    );
+  }
+  if (hasAll)
+    return {};
+  const { urlGroup, callerIp, ...rest } = request;
+  const payload = {
+    ...rest,
+    ...urlGroup === void 0 || typeof urlGroup !== "string" ? {} : { topicName: urlGroup },
+    ...callerIp === void 0 || typeof callerIp !== "string" ? {} : options?.callerIpCasing ? { callerIP: callerIp } : { callerIp }
+  };
+  if (Object.keys(payload).length === 0) {
+    throw new QstashError(
+      "No filters provided. Pass { all: true } to explicitly target all messages."
+    );
+  }
+  return payload;
+}
+function normalizeCursor(response) {
+  const cursor = response.cursor;
+  return { ...response, cursor: cursor || void 0 };
+}
 function getRuntime() {
   if (typeof process === "object" && typeof process.versions == "object" && process.versions.bun)
     return `bun@${process.versions.bun}`;
@@ -627,17 +664,20 @@ var DLQ = class {
   /**
    * List messages in the dlq
    */
-  async listMessages(options) {
+  async listMessages(options = {}) {
+    const { urlGroup, ...restFilter } = options.filter ?? {};
     const filterPayload = {
-      ...options?.filter,
-      topicName: options?.filter?.urlGroup
+      ...restFilter,
+      ...urlGroup === void 0 ? {} : { topicName: urlGroup }
     };
     const messagesPayload = await this.http.request({
       method: "GET",
       path: ["v2", "dlq"],
       query: {
-        cursor: options?.cursor,
-        count: options?.count,
+        cursor: options.cursor,
+        count: options.count,
+        order: options.order,
+        trimBody: options.trimBody,
         ...filterPayload
       }
     });
@@ -653,26 +693,70 @@ var DLQ = class {
     };
   }
   /**
-   * Remove a message from the dlq using it's `dlqId`
+   * Remove messages from the dlq.
+   *
+   * Can be called with:
+   * - A single dlqId: `delete("id")`
+   * - An array of dlqIds: `delete(["id1", "id2"])`
+   * - An object with dlqIds: `delete({ dlqIds: ["id1", "id2"] })`
+   * - A filter object: `delete({ url: "https://example.com", label: "label" })`
+   * - All messages: `delete({ all: true })`
+   *
+   * Note: passing an empty array returns `{ deleted: 0 }` without making a request.
    */
-  async delete(dlqMessageId) {
-    return await this.http.request({
-      method: "DELETE",
-      path: ["v2", "dlq", dlqMessageId],
-      parseResponseAsJson: false
-      // there is no response
-    });
+  async delete(request) {
+    if (typeof request === "string") {
+      await this.http.request({
+        method: "DELETE",
+        path: ["v2", "dlq", request],
+        parseResponseAsJson: false
+      });
+      return { deleted: 1 };
+    }
+    if (Array.isArray(request) && request.length === 0)
+      return { deleted: 0 };
+    const filters = Array.isArray(request) ? { dlqIds: request } : request;
+    return normalizeCursor(
+      await this.http.request({
+        method: "DELETE",
+        path: ["v2", "dlq"],
+        query: buildBulkActionFilterPayload(filters)
+      })
+    );
   }
   /**
    * Remove multiple messages from the dlq using their `dlqId`s
+   *
+   * @deprecated Use `delete` instead
    */
   async deleteMany(request) {
-    return await this.http.request({
-      method: "DELETE",
-      path: ["v2", "dlq"],
-      headers: { "Content-Type": "application/json" },
-      body: JSON.stringify({ dlqIds: request.dlqIds })
-    });
+    return await this.delete(request);
+  }
+  /**
+   * Retry messages from the dlq.
+   *
+   * Can be called with:
+   * - A single dlqId: `retry("id")`
+   * - An array of dlqIds: `retry(["id1", "id2"])`
+   * - An object with dlqIds: `retry({ dlqIds: ["id1", "id2"] })`
+   * - A filter object: `retry({ url: "https://example.com", label: "label" })`
+   * - All messages: `retry({ all: true })`
+   *
+   * Note: passing an empty array returns `{ responses: [] }` without making a request.
+   */
+  async retry(request) {
+    if (typeof request === "string")
+      request = [request];
+    if (Array.isArray(request) && request.length === 0)
+      return { responses: [] };
+    const filters = Array.isArray(request) ? { dlqIds: request } : request;
+    return normalizeCursor(
+      await this.http.request({
+        method: "POST",
+        path: ["v2", "dlq", "retry"],
+        query: buildBulkActionFilterPayload(filters)
+      })
+    );
   }
 };
 
@@ -773,7 +857,15 @@ var HttpClient = class {
     const url = new URL([request.baseUrl ?? this.baseUrl, ...request.path].join("/"));
     if (request.query) {
       for (const [key, value] of Object.entries(request.query)) {
-        if (value !== void 0) {
+        if (value === void 0)
+          continue;
+        if (Array.isArray(value)) {
+          for (const item of value) {
+            url.searchParams.append(key, item);
+          }
+        } else if (value instanceof Date) {
+          url.searchParams.set(key, value.getTime().toString());
+        } else {
           url.searchParams.set(key, value.toString());
         }
       }
@@ -1004,29 +1096,57 @@ var Messages = class {
     return message;
   }
   /**
-   * Cancel a message
+   * Cancel messages.
+   *
+   * Can be called with:
+   * - A single messageId: `cancel("id")`
+   * - An array of messageIds: `cancel(["id1", "id2"])`
+   * - A filter object: `cancel({ flowControlKey: "key", label: "label" })`
+   * - All messages: `cancel({ all: true })`
    */
-  async delete(messageId) {
+  async cancel(request) {
+    if (typeof request === "string") {
+      return await this.http.request({
+        method: "DELETE",
+        path: ["v2", "messages", request]
+      });
+    }
+    if (Array.isArray(request) && request.length === 0)
+      return { cancelled: 0 };
+    const filters = Array.isArray(request) ? { messageIds: request } : request;
     return await this.http.request({
+      method: "DELETE",
+      path: ["v2", "messages"],
+      query: buildBulkActionFilterPayload(filters, { callerIpCasing: true })
+    });
+  }
+  /**
+   * Delete a message.
+   *
+   * @deprecated Use `cancel(messageId: string)` instead
+   */
+  async delete(messageId) {
+    await this.http.request({
       method: "DELETE",
       path: ["v2", "messages", messageId],
       parseResponseAsJson: false
     });
   }
+  /**
+   * Cancel multiple messages by their messageIds.
+   *
+   * @deprecated Use `cancel(messageIds: string[])` instead
+   */
   async deleteMany(messageIds) {
-    const result = await this.http.request({
-      method: "DELETE",
-      path: ["v2", "messages"],
-      headers: { "Content-Type": "application/json" },
-      body: JSON.stringify({ messageIds })
-    });
+    const result = await this.cancel(messageIds);
     return result.cancelled;
   }
+  /**
+   * Cancel all messages
+   * @deprecated Use `cancel({all: true})` to cancel all
+   */
   async deleteAll() {
-    const result = await this.http.request({
-      method: "DELETE",
-      path: ["v2", "messages"]
-    });
+    const result = await this.cancel({ all: true });
     return result.cancelled;
   }
 };
@@ -1360,7 +1480,7 @@ var UrlGroups = class {
 };
 
 // version.ts
-var VERSION = "v2.9.0";
+var VERSION = "v2.9.1-rc.1";
 
 // src/client/client.ts
 var Client = class {
@@ -1555,39 +1675,47 @@ var Client = class {
    * }
    * ```
    */
-  async logs(request) {
-    const query = {};
-    if (typeof request?.cursor === "number" && request.cursor > 0) {
-      query.cursor = request.cursor.toString();
-    } else if (typeof request?.cursor === "string" && request.cursor !== "") {
-      query.cursor = request.cursor;
-    }
-    for (const [key, value] of Object.entries(request?.filter ?? {})) {
-      if (typeof value === "number" && value < 0) {
-        continue;
-      }
-      if (key === "urlGroup") {
-        query.topicName = value.toString();
-      } else if (typeof value !== "undefined") {
-        query[key] = value.toString();
-      }
-    }
+  async logs(request = {}) {
+    const {
+      urlGroup,
+      // eslint-disable-next-line @typescript-eslint/no-deprecated
+      topicName,
+      fromDate,
+      toDate,
+      callerIp,
+      messageIds,
+      // eslint-disable-next-line @typescript-eslint/no-deprecated
+      count: filterCount,
+      ...restFilter
+    } = request.filter ?? {};
+    const filterPayload = {
+      ...restFilter,
+      topicName: urlGroup ?? topicName,
+      fromDate,
+      toDate,
+      callerIp
+    };
+    let cursorString;
+    if (typeof request.cursor === "number" && request.cursor > 0) {
+      cursorString = request.cursor.toString();
+    } else if (typeof request.cursor === "string" && request.cursor !== "") {
+      cursorString = request.cursor;
+    }
+    const query = {
+      cursor: cursorString,
+      count: request.count ?? filterCount,
+      order: request.order,
+      trimBody: request.trimBody,
+      messageIds,
+      ...filterPayload
+    };
     const responsePayload = await this.http.request({
       path: ["v2", "events"],
       method: "GET",
       query
     });
-    const logs = responsePayload.events.map((event) => {
-      return {
-        ...event,
-        urlGroup: event.topicName
-      };
-    });
-    return {
-      cursor: responsePayload.cursor,
-      logs,
-      events: logs
-    };
+    const logs = responsePayload.events.map((event) => ({ ...event, urlGroup: event.topicName }));
+    return { cursor: responsePayload.cursor, logs, events: logs };
   }
   /**
    * @deprecated Will be removed in the next major release. Use the `logs` method instead.

package/workflow.mjs

@@ -6,7 +6,7 @@ import {
   WorkflowLogger,
   processOptions,
   serve
-} from "./chunk-QYBCXZKB.mjs";
+} from "./chunk-RUCOF5QZ.mjs";
 export {
   DisabledWorkflowContext,
   StepTypes,