@upstash/qstash 2.9.1 → 2.10.0

package/{client-jh_SomWB.d.ts → client-CsM1dTnz.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,146 @@ type RetryConfig = false | {
     backoff?: (retryCount: number) => number;
 };
 
+type RequireAtLeastOne<T> = {
+    [K in keyof T]-?: Required<Pick<T, K>>;
+}[keyof T];
+type NeverKeys<T> = {
+    [K in keyof T]?: never;
+};
+/** Two-branch exclusive union: A or B, never both. */
+type Exclusive<A, B> = (A & NeverKeys<B>) | (B & NeverKeys<A>);
+/** Shared filter fields accepted by every qstash & workflow endpoint. */
+type UniversalFilterFields = {
+    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;
+};
+type DLQFilterFields = UniversalFilterFields & QStashIdentityFields & DLQResponseFields & {
+    /**
+     * @deprecated `api` filter has been removed from the API and will be ignored
+     */
+    api?: string;
+};
+type MessageCancelFilterFields = UniversalFilterFields & Omit<QStashIdentityFields, "messageId">;
+/**
+ * Doesn't allow a single messageId because this is a bulk action.
+ * Cancel does not support cursor.
+ */
+type MessageCancelFilters = {
+    messageIds: string[];
+    filter?: never;
+    all?: never;
+    count?: never;
+} | ({
+    filter: RequireAtLeastOne<MessageCancelFilterFields>;
+    messageIds?: never;
+    all?: never;
+} & MessageCancelCount) | ({
+    all: true;
+    messageIds?: never;
+    filter?: never;
+} & MessageCancelCount);
+type MessageCancelCount = {
+    /**
+     * Maximum number of messages to cancel per call.
+     *
+     * @default 100
+     */
+    count?: number;
+};
+/**
+ * DLQ bulk actions support three modes:
+ * - By dlqIds (no cursor)
+ * - By filter fields (with optional cursor)
+ * - All (with optional cursor)
+ */
+type DLQBulkActionFilters = {
+    dlqIds: string | string[];
+    filter?: never;
+    all?: never;
+    count?: never;
+    cursor?: never;
+} | ({
+    filter: RequireAtLeastOne<DLQFilterFields>;
+    dlqIds?: never;
+    all?: never;
+} & DLQBulkActionCount) | ({
+    all: true;
+    dlqIds?: never;
+    filter?: never;
+} & DLQBulkActionCount);
+type DLQBulkActionCount = {
+    cursor?: string;
+    /**
+     * Maximum number of messages to process per call.
+     *
+     * @default 100
+     */
+    count?: number;
+};
+type DLQListRequest = Exclusive<{
+    dlqIds: string | string[];
+}, {
+    filter?: DLQFilterFields;
+    cursor?: string;
+}>;
+type LogsListRequest = Exclusive<{
+    messageIds: string[];
+}, {
+    filter?: LogsListFilters;
+    /**
+     * Passing `number` may silently break due to JavaScript integer precision
+     * limits — cursor values can exceed `Number.MAX_SAFE_INTEGER`. Use `string` instead.
+     */
+    cursor?: string | number;
+}>;
+type LogsListFilters = UniversalFilterFields & Omit<QStashIdentityFields, "messageId"> & LogsFilterFields & {
+    /**
+     * @deprecated `api` filter has been removed from the API and will be ignored
+     */
+    api?: string;
+    /**
+     * @deprecated use `messageIds` in the root instead of `messageId` in the `filter` object
+     *
+     * Example:
+     * ```ts
+     * await client.logs({ messageIds: ["id1", "id2"] })
+     * ```
+     */
+    messageId?: string;
+    /**
+     * @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 +767,44 @@ 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({ filter: { flowControlKey: "key", label: "label" } })`
+     * - All messages: `cancel({ all: true })`
+     *
+     * Pass `count` to limit the number of messages processed per call (defaults to 100).
+     * Call in a loop until `cancelled` is 0:
+     *
+     * ```ts
+     * let cancelled: number;
+     * do {
+     *   const result = await messages.cancel({ all: true, count: 100 });
+     *   cancelled = result.cancelled;
+     * } while (cancelled > 0);
+     * ```
+     */
+    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,77 +832,85 @@ 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);
     /**
      * List messages in the dlq
+     *
+     * Can be called with:
+     * - Filters: `listMessages({ filter: { url: "https://example.com" } })`
+     * - DLQ IDs: `listMessages({ dlqIds: ["id1", "id2"] })`
+     * - No filter (list all): `listMessages()`
      */
     listMessages(options?: {
-        cursor?: string;
         count?: number;
-        filter?: DLQFilter;
-    }): Promise<{
+    } & DLQListRequest): 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({ filter: { url: "https://example.com", label: "label" } })`
+     * - All messages: `delete({ all: true })`
+     *
+     * Pass `count` to limit the number of messages processed per call (defaults to 100).
+     * Call in a loop until cursor is undefined:
+     *
+     * ```ts
+     * let cursor: string | undefined;
+     * do {
+     *   const result = await dlq.delete({ all: true, count: 100, cursor });
+     *   cursor = result.cursor;
+     * } while (cursor);
+     * ```
      */
-    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({ filter: { url: "https://example.com", label: "label" } })`
+     * - All messages: `retry({ all: true })`
+     *
+     * Pass `count` to limit the number of messages processed per call (defaults to 100).
+     * Call in a loop until cursor is undefined:
+     *
+     * ```ts
+     * let cursor: string | undefined;
+     * do {
+     *   const result = await dlq.retry({ all: true, count: 100, cursor });
+     *   cursor = result.cursor;
+     * } while (cursor);
+     * ```
+     */
+    retry(request: string | string[] | DLQBulkActionFilters): Promise<{
+        cursor?: string;
+        responses: {
+            messageId: string;
+        }[];
     }>;
 }
 
@@ -1117,6 +1299,19 @@ type CreateScheduleRequest = {
      * @default undefined
      */
     label?: string;
+    /**
+     * Configure which fields should be redacted in logs.
+     *
+     * - `body: true` redacts the request body
+     * - `header: true` redacts all headers
+     * - `header: ["X"]` redacts specific headers (e.g., ["Authorization"])
+     *
+     * @default undefined
+     */
+    redact?: {
+        body?: true;
+        header?: true | string[];
+    };
 } & Pick<PublishRequest, "retryDelay">;
 declare class Schedules {
     private readonly http;
@@ -2074,6 +2269,19 @@ type PublishRequest<TBody = BodyInit> = {
      * @default undefined
      */
     label?: string;
+    /**
+     * Configure which fields should be redacted in logs.
+     *
+     * - `body: true` redacts the request body
+     * - `header: true` redacts all headers
+     * - `header: ["X"]` redacts specific headers (e.g., ["Authorization"])
+     *
+     * @default undefined
+     */
+    redact?: {
+        body?: true;
+        header?: true | string[];
+    };
 } & ({
     /**
      * The url where the message should be sent to.
@@ -2158,29 +2366,15 @@ type PublishJsonRequest = Omit<PublishRequest, "body"> & {
     body: unknown;
 };
 type LogsRequest = {
-    cursor?: string | number;
-    filter?: LogsRequestFilter;
-};
+    /** Max 1000. Defaults to 10 when `groupBy` is used. */
+    count?: number;
+} & LogsListRequest;
 /**
  * Deprecated. Use `LogsRequest` instead.
  *
  * @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[];