@upstash/qstash 2.4.2 → 2.5.0

package/dist/index.d.mts

@@ -201,6 +201,47 @@ declare class DLQ {
     }>;
 }
 
+type QueueResponse = {
+    createdAt: number;
+    updatedAt: number;
+    name: string;
+    parallelism: number;
+    lag: number;
+};
+type UpsertQueueRequest = {
+    parallelism: number;
+};
+type EnqueueRequest = PublishRequest;
+declare class Queue {
+    private readonly http;
+    private readonly queueName;
+    constructor(http: Requester, queueName?: string);
+    /**
+     * Create or update the queue
+     */
+    upsert(req: UpsertQueueRequest): Promise<void>;
+    /**
+     * Get the queue details
+     */
+    get(): Promise<QueueResponse>;
+    /**
+     * List queues
+     */
+    list(): Promise<QueueResponse[]>;
+    /**
+     * Delete the queue
+     */
+    delete(): Promise<void>;
+    /**
+     * Enqueue a message to a queue.
+     */
+    enqueue(req: EnqueueRequest): Promise<PublishResponse<PublishRequest>>;
+    /**
+     * Enqueue a message to a queue, serializing the body to JSON.
+     */
+    enqueueJSON<TBody = unknown>(req: PublishRequest<TBody>): Promise<PublishResponse<PublishRequest<TBody>>>;
+}
+
 type Schedule = {
     scheduleId: string;
     cron: string;
@@ -469,9 +510,10 @@ type PublishRequest<TBody = BodyInit> = {
      * In case your destination server is unavaialble or returns a status code outside of the 200-299
      * range, we will retry the request after a certain amount of time.
      *
-     * Configure how many times you would like the delivery to be retried
+     * Configure how many times you would like the delivery to be retried up to the maxRetries limit
+     * defined in your plan.
      *
-     * @default The maximum retry quota associated with your account.
+     * @default 3
      */
     retries?: number;
     /**
@@ -518,11 +560,26 @@ type PublishJsonRequest = Omit<PublishRequest, "body"> & {
 };
 type EventsRequest = {
     cursor?: number;
+    filter?: EventsRequestFilter;
+};
+type EventsRequestFilter = {
+    messageId?: string;
+    state?: State;
+    url?: string;
+    topicName?: string;
+    scheduleId?: string;
+    queueName?: string;
+    fromDate?: number;
+    toDate?: number;
+    count?: number;
 };
 type GetEventsResponse = {
     cursor?: number;
     events: Event[];
 };
+type QueueRequest = {
+    queueName?: string;
+};
 declare class Client {
     http: Requester;
     constructor(config: ClientConfig);
@@ -550,7 +607,12 @@ declare class Client {
      * Create, read or delete schedules.
      */
     get schedules(): Schedules;
-    private processHeaders;
+    /**
+     * Access the queue API.
+     *
+     * Create, read, update or delete queues.
+     */
+    queue(req?: QueueRequest): Queue;
     publish<TRequest extends PublishRequest>(req: TRequest): Promise<PublishResponse<TRequest>>;
     /**
      * publishJSON is a utility wrapper around `publish` that automatically serializes the body
@@ -560,11 +622,11 @@ declare class Client {
     /**
      * Batch publish messages to QStash.
      */
-    batch(req: PublishRequest[]): Promise<(PublishToUrlResponse | PublishToTopicResponse)[]>;
+    batch(req: PublishRequest[]): Promise<PublishResponse<PublishRequest>[]>;
     /**
      * Batch publish messages to QStash, serializing each body to JSON.
      */
-    batchJSON<TBody = unknown, TRequest extends PublishRequest<TBody> = PublishRequest<TBody>>(req: TRequest[]): Promise<(PublishToUrlResponse | PublishToTopicResponse)[]>;
+    batchJSON<TBody = unknown, TRequest extends PublishRequest<TBody> = PublishRequest<TBody>>(req: TRequest[]): Promise<PublishResponse<TRequest>[]>;
     /**
      * Retrieve your logs.
      *
@@ -606,4 +668,4 @@ declare class QstashRatelimitError extends QstashError {
     constructor(args: unknown);
 }
 
-export { AddEndpointsRequest, Client, CreateScheduleRequest, Endpoint, Event, EventsRequest, GetEventsResponse, Message, Messages, PublishJsonRequest, PublishRequest, QstashError, QstashRatelimitError, Receiver, ReceiverConfig, RemoveEndpointsRequest, Schedule, Schedules, SignatureError, State, Topic, Topics, VerifyRequest, WithCursor };
+export { AddEndpointsRequest, Client, CreateScheduleRequest, Endpoint, Event, EventsRequest, GetEventsResponse, Message, Messages, PublishJsonRequest, PublishRequest, PublishResponse, PublishToTopicResponse, PublishToUrlResponse, QstashError, QstashRatelimitError, QueueRequest, Receiver, ReceiverConfig, RemoveEndpointsRequest, Schedule, Schedules, SignatureError, State, Topic, Topics, VerifyRequest, WithCursor };

package/dist/index.d.ts

@@ -201,6 +201,47 @@ declare class DLQ {
     }>;
 }
 
+type QueueResponse = {
+    createdAt: number;
+    updatedAt: number;
+    name: string;
+    parallelism: number;
+    lag: number;
+};
+type UpsertQueueRequest = {
+    parallelism: number;
+};
+type EnqueueRequest = PublishRequest;
+declare class Queue {
+    private readonly http;
+    private readonly queueName;
+    constructor(http: Requester, queueName?: string);
+    /**
+     * Create or update the queue
+     */
+    upsert(req: UpsertQueueRequest): Promise<void>;
+    /**
+     * Get the queue details
+     */
+    get(): Promise<QueueResponse>;
+    /**
+     * List queues
+     */
+    list(): Promise<QueueResponse[]>;
+    /**
+     * Delete the queue
+     */
+    delete(): Promise<void>;
+    /**
+     * Enqueue a message to a queue.
+     */
+    enqueue(req: EnqueueRequest): Promise<PublishResponse<PublishRequest>>;
+    /**
+     * Enqueue a message to a queue, serializing the body to JSON.
+     */
+    enqueueJSON<TBody = unknown>(req: PublishRequest<TBody>): Promise<PublishResponse<PublishRequest<TBody>>>;
+}
+
 type Schedule = {
     scheduleId: string;
     cron: string;
@@ -469,9 +510,10 @@ type PublishRequest<TBody = BodyInit> = {
      * In case your destination server is unavaialble or returns a status code outside of the 200-299
      * range, we will retry the request after a certain amount of time.
      *
-     * Configure how many times you would like the delivery to be retried
+     * Configure how many times you would like the delivery to be retried up to the maxRetries limit
+     * defined in your plan.
      *
-     * @default The maximum retry quota associated with your account.
+     * @default 3
      */
     retries?: number;
     /**
@@ -518,11 +560,26 @@ type PublishJsonRequest = Omit<PublishRequest, "body"> & {
 };
 type EventsRequest = {
     cursor?: number;
+    filter?: EventsRequestFilter;
+};
+type EventsRequestFilter = {
+    messageId?: string;
+    state?: State;
+    url?: string;
+    topicName?: string;
+    scheduleId?: string;
+    queueName?: string;
+    fromDate?: number;
+    toDate?: number;
+    count?: number;
 };
 type GetEventsResponse = {
     cursor?: number;
     events: Event[];
 };
+type QueueRequest = {
+    queueName?: string;
+};
 declare class Client {
     http: Requester;
     constructor(config: ClientConfig);
@@ -550,7 +607,12 @@ declare class Client {
      * Create, read or delete schedules.
      */
     get schedules(): Schedules;
-    private processHeaders;
+    /**
+     * Access the queue API.
+     *
+     * Create, read, update or delete queues.
+     */
+    queue(req?: QueueRequest): Queue;
     publish<TRequest extends PublishRequest>(req: TRequest): Promise<PublishResponse<TRequest>>;
     /**
      * publishJSON is a utility wrapper around `publish` that automatically serializes the body
@@ -560,11 +622,11 @@ declare class Client {
     /**
      * Batch publish messages to QStash.
      */
-    batch(req: PublishRequest[]): Promise<(PublishToUrlResponse | PublishToTopicResponse)[]>;
+    batch(req: PublishRequest[]): Promise<PublishResponse<PublishRequest>[]>;
     /**
      * Batch publish messages to QStash, serializing each body to JSON.
      */
-    batchJSON<TBody = unknown, TRequest extends PublishRequest<TBody> = PublishRequest<TBody>>(req: TRequest[]): Promise<(PublishToUrlResponse | PublishToTopicResponse)[]>;
+    batchJSON<TBody = unknown, TRequest extends PublishRequest<TBody> = PublishRequest<TBody>>(req: TRequest[]): Promise<PublishResponse<TRequest>[]>;
     /**
      * Retrieve your logs.
      *
@@ -606,4 +668,4 @@ declare class QstashRatelimitError extends QstashError {
     constructor(args: unknown);
 }
 
-export { AddEndpointsRequest, Client, CreateScheduleRequest, Endpoint, Event, EventsRequest, GetEventsResponse, Message, Messages, PublishJsonRequest, PublishRequest, QstashError, QstashRatelimitError, Receiver, ReceiverConfig, RemoveEndpointsRequest, Schedule, Schedules, SignatureError, State, Topic, Topics, VerifyRequest, WithCursor };
+export { AddEndpointsRequest, Client, CreateScheduleRequest, Endpoint, Event, EventsRequest, GetEventsResponse, Message, Messages, PublishJsonRequest, PublishRequest, PublishResponse, PublishToTopicResponse, PublishToUrlResponse, QstashError, QstashRatelimitError, QueueRequest, Receiver, ReceiverConfig, RemoveEndpointsRequest, Schedule, Schedules, SignatureError, State, Topic, Topics, VerifyRequest, WithCursor };

package/dist/index.js

@@ -183,6 +183,138 @@ function prefixHeaders(headers) {
   }
   return headers;
 }
+function processHeaders(req) {
+  var _a;
+  const headers = prefixHeaders(new Headers(req.headers));
+  headers.set("Upstash-Method", (_a = req.method) != null ? _a : "POST");
+  if (typeof req.delay !== "undefined") {
+    headers.set("Upstash-Delay", `${req.delay.toFixed()}s`);
+  }
+  if (typeof req.notBefore !== "undefined") {
+    headers.set("Upstash-Not-Before", req.notBefore.toFixed());
+  }
+  if (typeof req.deduplicationId !== "undefined") {
+    headers.set("Upstash-Deduplication-Id", req.deduplicationId);
+  }
+  if (typeof req.contentBasedDeduplication !== "undefined") {
+    headers.set("Upstash-Content-Based-Deduplication", "true");
+  }
+  if (typeof req.retries !== "undefined") {
+    headers.set("Upstash-Retries", req.retries.toFixed());
+  }
+  if (typeof req.callback !== "undefined") {
+    headers.set("Upstash-Callback", req.callback);
+  }
+  if (typeof req.failureCallback !== "undefined") {
+    headers.set("Upstash-Failure-Callback", req.failureCallback);
+  }
+  return headers;
+}
+
+// src/client/queue.ts
+var Queue = class {
+  constructor(http, queueName) {
+    this.http = http;
+    this.queueName = queueName;
+  }
+  /**
+   * Create or update the queue
+   */
+  upsert(req) {
+    return _chunkEROSIHWEjs.__async.call(void 0, this, null, function* () {
+      if (!this.queueName) {
+        throw new Error("Please provide a queue name to the Queue constructor");
+      }
+      const body = {
+        queueName: this.queueName,
+        parallelism: req.parallelism
+      };
+      yield this.http.request({
+        method: "POST",
+        path: ["v2", "queues"],
+        headers: {
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify(body),
+        parseResponseAsJson: false
+      });
+    });
+  }
+  /**
+   * Get the queue details
+   */
+  get() {
+    return _chunkEROSIHWEjs.__async.call(void 0, this, null, function* () {
+      if (!this.queueName) {
+        throw new Error("Please provide a queue name to the Queue constructor");
+      }
+      return yield this.http.request({
+        method: "GET",
+        path: ["v2", "queues", this.queueName]
+      });
+    });
+  }
+  /**
+   * List queues
+   */
+  list() {
+    return _chunkEROSIHWEjs.__async.call(void 0, this, null, function* () {
+      return yield this.http.request({
+        method: "GET",
+        path: ["v2", "queues"]
+      });
+    });
+  }
+  /**
+   * Delete the queue
+   */
+  delete() {
+    return _chunkEROSIHWEjs.__async.call(void 0, this, null, function* () {
+      if (!this.queueName) {
+        throw new Error("Please provide a queue name to the Queue constructor");
+      }
+      yield this.http.request({
+        method: "DELETE",
+        path: ["v2", "queues", this.queueName],
+        parseResponseAsJson: false
+      });
+    });
+  }
+  /**
+   * Enqueue a message to a queue.
+   */
+  enqueue(req) {
+    return _chunkEROSIHWEjs.__async.call(void 0, this, null, function* () {
+      var _a;
+      if (!this.queueName) {
+        throw new Error("Please provide a queue name to the Queue constructor");
+      }
+      const headers = processHeaders(req);
+      const destination = (_a = req.url) != null ? _a : req.topic;
+      const res = yield this.http.request({
+        path: ["v2", "enqueue", this.queueName, destination],
+        body: req.body,
+        headers,
+        method: "POST"
+      });
+      return res;
+    });
+  }
+  /**
+   * Enqueue a message to a queue, serializing the body to JSON.
+   */
+  enqueueJSON(req) {
+    return _chunkEROSIHWEjs.__async.call(void 0, this, null, function* () {
+      const headers = prefixHeaders(new Headers(req.headers));
+      headers.set("Content-Type", "application/json");
+      const res = yield this.enqueue(_chunkEROSIHWEjs.__spreadProps.call(void 0, _chunkEROSIHWEjs.__spreadValues.call(void 0, {}, req), {
+        body: JSON.stringify(req.body),
+        headers
+      }));
+      return res;
+    });
+  }
+};
 
 // src/client/schedules.ts
 var Schedules = class {
@@ -368,37 +500,18 @@ var Client = class {
   get schedules() {
     return new Schedules(this.http);
   }
-  processHeaders(req) {
-    var _a;
-    const headers = prefixHeaders(new Headers(req.headers));
-    headers.set("Upstash-Method", (_a = req.method) != null ? _a : "POST");
-    if (typeof req.delay !== "undefined") {
-      headers.set("Upstash-Delay", `${req.delay.toFixed()}s`);
-    }
-    if (typeof req.notBefore !== "undefined") {
-      headers.set("Upstash-Not-Before", req.notBefore.toFixed());
-    }
-    if (typeof req.deduplicationId !== "undefined") {
-      headers.set("Upstash-Deduplication-Id", req.deduplicationId);
-    }
-    if (typeof req.contentBasedDeduplication !== "undefined") {
-      headers.set("Upstash-Content-Based-Deduplication", "true");
-    }
-    if (typeof req.retries !== "undefined") {
-      headers.set("Upstash-Retries", req.retries.toFixed());
-    }
-    if (typeof req.callback !== "undefined") {
-      headers.set("Upstash-Callback", req.callback);
-    }
-    if (typeof req.failureCallback !== "undefined") {
-      headers.set("Upstash-Failure-Callback", req.failureCallback);
-    }
-    return headers;
+  /**
+   * Access the queue API.
+   * 
+   * Create, read, update or delete queues.
+   */
+  queue(req) {
+    return new Queue(this.http, req == null ? void 0 : req.queueName);
   }
   publish(req) {
     return _chunkEROSIHWEjs.__async.call(void 0, this, null, function* () {
       var _a;
-      const headers = this.processHeaders(req);
+      const headers = processHeaders(req);
       const res = yield this.http.request({
         path: ["v2", "publish", (_a = req.url) != null ? _a : req.topic],
         body: req.body,
@@ -431,7 +544,7 @@ var Client = class {
       var _a;
       const messages = [];
       for (const message of req) {
-        const headers = this.processHeaders(message);
+        const headers = processHeaders(message);
         const headerEntries = Object.fromEntries(headers.entries());
         messages.push({
           destination: (_a = message.url) != null ? _a : message.topic,
@@ -487,9 +600,18 @@ var Client = class {
    */
   events(req) {
     return _chunkEROSIHWEjs.__async.call(void 0, this, null, function* () {
+      var _a;
       const query = {};
       if ((req == null ? void 0 : req.cursor) && req.cursor > 0) {
-        query.cursor = req.cursor;
+        query.cursor = req.cursor.toString();
+      }
+      for (const [key, value] of Object.entries((_a = req == null ? void 0 : req.filter) != null ? _a : {})) {
+        if (typeof value === "number" && value < 0) {
+          continue;
+        }
+        if (typeof value !== "undefined") {
+          query[key] = value.toString();
+        }
       }
       const res = yield this.http.request({
         path: ["v2", "events"],

package/dist/index.mjs

@@ -183,6 +183,138 @@ function prefixHeaders(headers) {
   }
   return headers;
 }
+function processHeaders(req) {
+  var _a;
+  const headers = prefixHeaders(new Headers(req.headers));
+  headers.set("Upstash-Method", (_a = req.method) != null ? _a : "POST");
+  if (typeof req.delay !== "undefined") {
+    headers.set("Upstash-Delay", `${req.delay.toFixed()}s`);
+  }
+  if (typeof req.notBefore !== "undefined") {
+    headers.set("Upstash-Not-Before", req.notBefore.toFixed());
+  }
+  if (typeof req.deduplicationId !== "undefined") {
+    headers.set("Upstash-Deduplication-Id", req.deduplicationId);
+  }
+  if (typeof req.contentBasedDeduplication !== "undefined") {
+    headers.set("Upstash-Content-Based-Deduplication", "true");
+  }
+  if (typeof req.retries !== "undefined") {
+    headers.set("Upstash-Retries", req.retries.toFixed());
+  }
+  if (typeof req.callback !== "undefined") {
+    headers.set("Upstash-Callback", req.callback);
+  }
+  if (typeof req.failureCallback !== "undefined") {
+    headers.set("Upstash-Failure-Callback", req.failureCallback);
+  }
+  return headers;
+}
+
+// src/client/queue.ts
+var Queue = class {
+  constructor(http, queueName) {
+    this.http = http;
+    this.queueName = queueName;
+  }
+  /**
+   * Create or update the queue
+   */
+  upsert(req) {
+    return __async(this, null, function* () {
+      if (!this.queueName) {
+        throw new Error("Please provide a queue name to the Queue constructor");
+      }
+      const body = {
+        queueName: this.queueName,
+        parallelism: req.parallelism
+      };
+      yield this.http.request({
+        method: "POST",
+        path: ["v2", "queues"],
+        headers: {
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify(body),
+        parseResponseAsJson: false
+      });
+    });
+  }
+  /**
+   * Get the queue details
+   */
+  get() {
+    return __async(this, null, function* () {
+      if (!this.queueName) {
+        throw new Error("Please provide a queue name to the Queue constructor");
+      }
+      return yield this.http.request({
+        method: "GET",
+        path: ["v2", "queues", this.queueName]
+      });
+    });
+  }
+  /**
+   * List queues
+   */
+  list() {
+    return __async(this, null, function* () {
+      return yield this.http.request({
+        method: "GET",
+        path: ["v2", "queues"]
+      });
+    });
+  }
+  /**
+   * Delete the queue
+   */
+  delete() {
+    return __async(this, null, function* () {
+      if (!this.queueName) {
+        throw new Error("Please provide a queue name to the Queue constructor");
+      }
+      yield this.http.request({
+        method: "DELETE",
+        path: ["v2", "queues", this.queueName],
+        parseResponseAsJson: false
+      });
+    });
+  }
+  /**
+   * Enqueue a message to a queue.
+   */
+  enqueue(req) {
+    return __async(this, null, function* () {
+      var _a;
+      if (!this.queueName) {
+        throw new Error("Please provide a queue name to the Queue constructor");
+      }
+      const headers = processHeaders(req);
+      const destination = (_a = req.url) != null ? _a : req.topic;
+      const res = yield this.http.request({
+        path: ["v2", "enqueue", this.queueName, destination],
+        body: req.body,
+        headers,
+        method: "POST"
+      });
+      return res;
+    });
+  }
+  /**
+   * Enqueue a message to a queue, serializing the body to JSON.
+   */
+  enqueueJSON(req) {
+    return __async(this, null, function* () {
+      const headers = prefixHeaders(new Headers(req.headers));
+      headers.set("Content-Type", "application/json");
+      const res = yield this.enqueue(__spreadProps(__spreadValues({}, req), {
+        body: JSON.stringify(req.body),
+        headers
+      }));
+      return res;
+    });
+  }
+};
 
 // src/client/schedules.ts
 var Schedules = class {
@@ -368,37 +500,18 @@ var Client = class {
   get schedules() {
     return new Schedules(this.http);
   }
-  processHeaders(req) {
-    var _a;
-    const headers = prefixHeaders(new Headers(req.headers));
-    headers.set("Upstash-Method", (_a = req.method) != null ? _a : "POST");
-    if (typeof req.delay !== "undefined") {
-      headers.set("Upstash-Delay", `${req.delay.toFixed()}s`);
-    }
-    if (typeof req.notBefore !== "undefined") {
-      headers.set("Upstash-Not-Before", req.notBefore.toFixed());
-    }
-    if (typeof req.deduplicationId !== "undefined") {
-      headers.set("Upstash-Deduplication-Id", req.deduplicationId);
-    }
-    if (typeof req.contentBasedDeduplication !== "undefined") {
-      headers.set("Upstash-Content-Based-Deduplication", "true");
-    }
-    if (typeof req.retries !== "undefined") {
-      headers.set("Upstash-Retries", req.retries.toFixed());
-    }
-    if (typeof req.callback !== "undefined") {
-      headers.set("Upstash-Callback", req.callback);
-    }
-    if (typeof req.failureCallback !== "undefined") {
-      headers.set("Upstash-Failure-Callback", req.failureCallback);
-    }
-    return headers;
+  /**
+   * Access the queue API.
+   * 
+   * Create, read, update or delete queues.
+   */
+  queue(req) {
+    return new Queue(this.http, req == null ? void 0 : req.queueName);
   }
   publish(req) {
     return __async(this, null, function* () {
       var _a;
-      const headers = this.processHeaders(req);
+      const headers = processHeaders(req);
       const res = yield this.http.request({
         path: ["v2", "publish", (_a = req.url) != null ? _a : req.topic],
         body: req.body,
@@ -431,7 +544,7 @@ var Client = class {
       var _a;
       const messages = [];
       for (const message of req) {
-        const headers = this.processHeaders(message);
+        const headers = processHeaders(message);
         const headerEntries = Object.fromEntries(headers.entries());
         messages.push({
           destination: (_a = message.url) != null ? _a : message.topic,
@@ -487,9 +600,18 @@ var Client = class {
    */
   events(req) {
     return __async(this, null, function* () {
+      var _a;
       const query = {};
       if ((req == null ? void 0 : req.cursor) && req.cursor > 0) {
-        query.cursor = req.cursor;
+        query.cursor = req.cursor.toString();
+      }
+      for (const [key, value] of Object.entries((_a = req == null ? void 0 : req.filter) != null ? _a : {})) {
+        if (typeof value === "number" && value < 0) {
+          continue;
+        }
+        if (typeof value !== "undefined") {
+          query[key] = value.toString();
+        }
       }
       const res = yield this.http.request({
         path: ["v2", "events"],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@upstash/qstash",
-  "version": "v2.4.2",
+  "version": "v2.5.0",
   "description": "Official Typescript client for QStash",
   "repository": {
     "type": "git",