@upstash/qstash 2.9.0 → 2.9.1-rc.1

package/{chunk-QYBCXZKB.mjs → chunk-RUCOF5QZ.mjs}

@@ -372,6 +372,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}`;
@@ -601,17 +638,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
       }
     });
@@ -627,26 +667,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)
+      })
+    );
   }
 };
 
@@ -747,7 +831,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());
         }
       }
@@ -978,29 +1070,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;
   }
 };
@@ -1334,7 +1454,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 {
@@ -1529,39 +1649,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/{chunk-M7SEEFAC.mjs → chunk-SN6OPGRS.mjs}

@@ -1,6 +1,6 @@
 import {
   BaseProvider
-} from "./chunk-QYBCXZKB.mjs";
+} from "./chunk-RUCOF5QZ.mjs";
 
 // src/client/api/email.ts
 var EmailProvider = class extends BaseProvider {

package/{chunk-H5OAU75L.mjs → chunk-STWPT5EV.mjs}

@@ -1,7 +1,7 @@
 import {
   Receiver,
   serve
-} from "./chunk-QYBCXZKB.mjs";
+} from "./chunk-RUCOF5QZ.mjs";
 
 // node_modules/defu/dist/defu.mjs
 function isPlainObject(value) {

package/{client-BVG9vt90.d.ts → client-Gv4WRTxB.d.mts}

@@ -103,7 +103,7 @@ type LogPayload = Omit<Log, "urlGroup"> & {
     topicName: string;
 };
 /**
- * Deprecated. Use the `EventPayload` type instead.
+ * Deprecated. Use the `LogPayload` type instead.
  *
  * @deprecated
  */
@@ -464,7 +464,7 @@ type UpstashRequest = {
      * A string to set request's method.
      */
     method?: HTTPMethods;
-    query?: Record<string, string | number | boolean | undefined>;
+    query?: Record<string, string | number | boolean | Date | string[] | undefined>;
     /**
      * if enabled, call `res.json()`
      *
@@ -505,6 +505,81 @@ type RetryConfig = false | {
     backoff?: (retryCount: number) => number;
 };
 
+type NeverAll<T> = {
+    [K in keyof T]?: never;
+};
+type RequireAtLeastOne<T> = {
+    [K in keyof T]-?: Required<Pick<T, K>>;
+}[keyof T];
+/**
+ * Three-way exclusive union: at-least-one-filter OR `{ all: true }` OR IDs.
+ * Exactly one branch can be satisfied at a time.
+ *
+ * The filter and all branches intentionally omit `NeverAll<Ids>` so that
+ * TypeScript's `"key" in request` narrowing correctly isolates the IDs branch.
+ * Excess-property checks on object literals still prevent mixing ID keys with filters.
+ */
+type FilterAllOrIds<F extends Record<string, unknown>, Ids extends Record<string, unknown>> = (F & RequireAtLeastOne<F> & {
+    all?: never;
+}) | ({
+    all: true;
+} & NeverAll<F>) | (Ids & NeverAll<F> & {
+    all?: never;
+});
+/** Shared filter fields accepted by every qstash & workflow endpoint. */
+type UniversalFilterFields = {
+    /**
+     * aslkdjasd
+     */
+    fromDate?: Date | number;
+    toDate?: Date | number;
+    callerIp?: string;
+    label?: string;
+    flowControlKey?: string;
+};
+/** QStash-specific identity filters (DLQ + message endpoints). */
+type QStashIdentityFields = {
+    messageId?: string;
+    url?: string;
+    urlGroup?: string;
+    scheduleId?: string;
+    queueName?: string;
+};
+/** DLQ-specific response filter. */
+type DLQResponseFields = {
+    responseStatus?: number;
+};
+/** Logs-specific filter fields exclusive to log endpoints. */
+type LogsFilterFields = {
+    state?: State;
+    messageIds?: string[];
+};
+/**
+ * Doesn't allow a single messageId because this is a bulk action
+ */
+type MessageCancelFilters = FilterAllOrIds<UniversalFilterFields & Omit<QStashIdentityFields, "messageId">, {
+    messageIds: string[];
+}>;
+type DLQBulkActionFilters = FilterAllOrIds<UniversalFilterFields & QStashIdentityFields & DLQResponseFields, {
+    dlqIds: string | string[];
+}>;
+type DLQListFilters = UniversalFilterFields & QStashIdentityFields & DLQResponseFields;
+type LogsListFilters = UniversalFilterFields & QStashIdentityFields & LogsFilterFields & {
+    /**
+     * @deprecated use `urlGroup` instead
+     */
+    topicName?: string;
+    /**
+     * @deprecated use `count` option in the root instead of the `filter` object
+     *
+     * Example:
+     * ```ts
+     * await client.logs({ count: 50 })
+     * ```
+     */
+    count?: number;
+};
+
 type Message = {
     /**
      * A unique identifier for this message.
@@ -627,10 +702,33 @@ declare class Messages {
      */
     get(messageId: string): Promise<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 })`
+     */
+    cancel(request: string | string[] | MessageCancelFilters): Promise<{
+        cancelled: number;
+    }>;
+    /**
+     * Delete a message.
+     *
+     * @deprecated Use `cancel(messageId: string)` instead
      */
     delete(messageId: string): Promise<void>;
+    /**
+     * Cancel multiple messages by their messageIds.
+     *
+     * @deprecated Use `cancel(messageIds: string[])` instead
+     */
     deleteMany(messageIds: string[]): Promise<number>;
+    /**
+     * Cancel all messages
+     * @deprecated Use `cancel({all: true})` to cancel all
+     */
     deleteAll(): Promise<number>;
 }
 
@@ -658,52 +756,6 @@ type DlqMessage = Message & {
      */
     responseBodyBase64?: string;
 };
-type DLQFilter = {
-    /**
-     * Filter DLQ entries by message id
-     */
-    messageId?: string;
-    /**
-     * Filter DLQ entries by url
-     */
-    url?: string;
-    /**
-     * Filter DLQ entries by url group name
-     */
-    urlGroup?: string;
-    /**
-     * Filter DLQ entries by api name
-     */
-    api?: string;
-    /**
-     * Filter DLQ entries by queue name
-     */
-    queueName?: string;
-    /**
-     * Filter DLQ entries by schedule id
-     */
-    scheduleId?: string;
-    /**
-     * Filter DLQ entries by starting time, in milliseconds
-     */
-    fromDate?: number;
-    /**
-     * Filter DLQ entries by ending time, in milliseconds
-     */
-    toDate?: number;
-    /**
-     * Filter DLQ entries by label
-     */
-    label?: string;
-    /**
-     * Filter DLQ entries by HTTP status of the response
-     */
-    responseStatus?: number;
-    /**
-     * Filter DLQ entries by IP address of the publisher of the message
-     */
-    callerIp?: string;
-};
 declare class DLQ {
     private readonly http;
     constructor(http: Requester);
@@ -713,22 +765,58 @@ declare class DLQ {
     listMessages(options?: {
         cursor?: string;
         count?: number;
-        filter?: DLQFilter;
+        /** Defaults to `latestFirst` */
+        order?: "earliestFirst" | "latestFirst";
+        trimBody?: number;
+        filter?: DLQListFilters;
     }): Promise<{
         messages: DlqMessage[];
         cursor?: string;
     }>;
     /**
-     * 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.
      */
-    delete(dlqMessageId: string): Promise<void>;
+    delete(request: string | string[] | DLQBulkActionFilters): Promise<{
+        deleted: number;
+        cursor?: string;
+    }>;
     /**
      * Remove multiple messages from the dlq using their `dlqId`s
+     *
+     * @deprecated Use `delete` instead
      */
     deleteMany(request: {
         dlqIds: string[];
     }): Promise<{
         deleted: number;
+        cursor?: string;
+    }>;
+    /**
+     * 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.
+     */
+    retry(request: string | string[] | DLQBulkActionFilters): Promise<{
+        cursor?: string;
+        responses: {
+            messageId: string;
+        }[];
     }>;
 }
 
@@ -2034,7 +2122,12 @@ type PublishJsonRequest = Omit<PublishRequest, "body"> & {
 };
 type LogsRequest = {
     cursor?: string | number;
-    filter?: LogsRequestFilter;
+    /** Max 1000. Defaults to 10 when `groupBy` is used. */
+    count?: number;
+    /** Defaults to `latestFirst` */
+    order?: "earliestFirst" | "latestFirst";
+    trimBody?: number;
+    filter?: LogsListFilters;
 };
 /**
  * Deprecated. Use `LogsRequest` instead.
@@ -2042,20 +2135,6 @@ type LogsRequest = {
  * @deprecated
  */
 type EventsRequest = LogsRequest;
-type LogsRequestFilter = {
-    messageId?: string;
-    state?: State;
-    url?: string;
-    urlGroup?: string;
-    topicName?: string;
-    api?: string;
-    scheduleId?: string;
-    queueName?: string;
-    fromDate?: number;
-    toDate?: number;
-    count?: number;
-    label?: string;
-};
 type GetLogsResponse = {
     cursor?: string;
     logs: Log[];
@@ -2206,4 +2285,4 @@ type PublishResponse<TRequest> = TRequest extends {
     urlGroup: string;
 } ? PublishToUrlGroupsResponse : PublishToApiResponse;
 
-export { type StreamEnabled as $, type AddEndpointsRequest as A, BaseProvider as B, type ChatRateLimit as C, type EventPayload as D, type EmailOwner as E, type FailureFunctionPayload as F, type GetLogsResponse as G, type HTTPMethods as H, type GetLogsPayload as I, type GetEventsPayload as J, type BodyInit as K, type LLMOwner as L, type Message as M, type HeadersInit as N, type RequestOptions as O, type ProviderInfo as P, type QueueRequest as Q, type RateLimit as R, type Step as S, type FlowControl as T, type UrlGroup as U, type VerifyRequest as V, type WithCursor as W, Chat as X, type ChatCompletionMessage as Y, type ChatCompletion as Z, type ChatCompletionChunk as _, type ReceiverConfig as a, type StreamDisabled as a0, type StreamParameter as a1, type OpenAIChatModel as a2, type PromptChatRequest as a3, type ChatRequest as a4, upstash as a5, openai as a6, anthropic as a7, custom as a8, type RouteFunction as a9, type WorkflowServeOptions as aa, Workflow as ab, processOptions as ac, serve as ad, WorkflowContext as ae, DisabledWorkflowContext as af, type WorkflowClient as ag, type WorkflowReceiver as ah, StepTypes as ai, type StepType as aj, type RawStep as ak, type SyncStepFunction as al, type AsyncStepFunction as am, type StepFunction as an, type ParallelCallState as ao, type FinishCondition as ap, type RequiredExceptFields as aq, type LogLevel as ar, type WorkflowLoggerOptions as as, WorkflowLogger as at, SignatureError as b, Receiver as c, type PublishBatchRequest as d, type PublishRequest as e, type PublishJsonRequest as f, type LogsRequest as g, type EventsRequest as h, type GetEventsResponse as i, Client as j, type PublishToApiResponse as k, type PublishToUrlResponse as l, type PublishToUrlGroupsResponse as m, type PublishResponse as n, type MessagePayload as o, Messages as p, type Schedule as q, type CreateScheduleRequest as r, Schedules as s, type Endpoint as t, type RemoveEndpointsRequest as u, UrlGroups as v, type State as w, type Log as x, type Event as y, type LogPayload as z };
+export { type ChatCompletionChunk as $, type AddEndpointsRequest as A, BaseProvider as B, type ChatRateLimit as C, type LogPayload as D, type EmailOwner as E, type FailureFunctionPayload as F, type GetLogsResponse as G, type HTTPMethods as H, type EventPayload as I, type GetLogsPayload as J, type GetEventsPayload as K, type LLMOwner as L, type Message as M, type BodyInit as N, type HeadersInit as O, type ProviderInfo as P, type QueueRequest as Q, type RateLimit as R, type Step as S, type RequestOptions as T, type UniversalFilterFields as U, type VerifyRequest as V, type WithCursor as W, type FlowControl as X, Chat as Y, type ChatCompletionMessage as Z, type ChatCompletion as _, type ReceiverConfig as a, type StreamEnabled as a0, type StreamDisabled as a1, type StreamParameter as a2, type OpenAIChatModel as a3, type PromptChatRequest as a4, type ChatRequest as a5, upstash as a6, openai as a7, anthropic as a8, custom as a9, type RouteFunction as aa, type WorkflowServeOptions as ab, Workflow as ac, processOptions as ad, serve as ae, WorkflowContext as af, DisabledWorkflowContext as ag, type WorkflowClient as ah, type WorkflowReceiver as ai, StepTypes as aj, type StepType as ak, type RawStep as al, type SyncStepFunction as am, type AsyncStepFunction as an, type StepFunction as ao, type ParallelCallState as ap, type FinishCondition as aq, type RequiredExceptFields as ar, type LogLevel as as, type WorkflowLoggerOptions as at, WorkflowLogger as au, SignatureError as b, Receiver as c, type PublishBatchRequest as d, type PublishRequest as e, type PublishJsonRequest as f, type LogsRequest as g, type EventsRequest as h, type GetEventsResponse as i, Client as j, type PublishToApiResponse as k, type PublishToUrlResponse as l, type PublishToUrlGroupsResponse as m, type PublishResponse as n, type MessagePayload as o, Messages as p, type Schedule as q, type CreateScheduleRequest as r, Schedules as s, type Endpoint as t, type RemoveEndpointsRequest as u, type UrlGroup as v, UrlGroups as w, type State as x, type Log as y, type Event as z };