@upstash/qstash - npm Package Compare versions

Comparing version 2.0.0-canary.21 to 2.0.0-canary.22

./dist/index.js

@@ -224,2 +224,31 @@ "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
+// src/client/dlq.ts
+var DLQ = class {
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * List messages in the dlq
+   */
+  listMessages() {
+    return _chunkEQTYEU4Ujs.__async.call(void 0, this, null, function* () {
+      return yield this.http.request({
+        method: "GET",
+        path: ["v2", "dlq", "messages"]
+      });
+    });
+  }
+  /**
+   * Remove a message from the dlq using it's `dlqId`
+   */
+  delete(dlqMessageId) {
+    return _chunkEQTYEU4Ujs.__async.call(void 0, this, null, function* () {
+      return yield this.http.request({
+        method: "DELETE",
+        path: ["v2", "dlq", "messages", dlqMessageId]
+      });
+    });
+  }
+};
+
 // src/client/client.ts
@@ -243,2 +272,10 @@ var Client = class {
   /**
+   * Access the dlq API.
+   *
+   * List or remove messages from the DLQ.
+   */
+  get dlq() {
+    return new DLQ(this.http);
+  }
+  /**
    * Access the message API.
@@ -254,3 +291,3 @@ *
    *
-   * Read or delete schedules.
+   * Create, read or delete schedules.
    */
@@ -257,0 +294,0 @@ get schedules() {

dist/index.d.ts

@@ -177,3 +177,44 @@ /**
 
-type Message = {};
+type Message = {
+    /**
+     * A unique identifier for this message.
+     */
+    messageId: string;
+    /**
+     * The topic name if this message was sent to a topic.
+     */
+    topicName?: string;
+    /**
+     * The url where this message is sent to.
+     */
+    url: string;
+    /**
+     * The http method used to deliver the message
+     */
+    method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+    /**
+     * The http headers sent along with the message to your API.
+     */
+    header?: Record<string, string[]>;
+    /**
+     * The http body sent to your API
+     */
+    body?: string;
+    /**
+     * Maxmimum number of retries.
+     */
+    maxRetries?: number;
+    /**
+     * A unix timestamp (milliseconds) after which this message may get delivered.
+     */
+    notBefore?: number;
+    /**
+     * A unix timestamp (milliseconds) when this messages was crated.
+     */
+    createdAt: number;
+    /**
+     * The callback url if configured.
+     */
+    callback?: string;
+};
 declare class Messages {
@@ -301,2 +342,18 @@ private readonly http;
 
+type DlqMessage = Message & {
+    dlqId: string;
+};
+declare class DLQ {
+    private readonly http;
+    constructor(http: Requester);
+    /**
+     * List messages in the dlq
+     */
+    listMessages(): Promise<DlqMessage[]>;
+    /**
+     * Remove a message from the dlq using it's `dlqId`
+     */
+    delete(dlqMessageId: string): Promise<void>;
+}
+
 type ClientConfig = {
@@ -435,2 +492,8 @@ /**
     /**
+     * Access the dlq API.
+     *
+     * List or remove messages from the DLQ.
+     */
+    get dlq(): DLQ;
+    /**
      * Access the message API.
@@ -444,3 +507,3 @@ *
      *
-     * Read or delete schedules.
+     * Create, read or delete schedules.
      */
@@ -490,2 +553,2 @@ get schedules(): Schedules;
 
-export { AddEndpointsRequest, Client, CreateScheduleRequest, Endpoint, Event, EventsRequest, GetEventsResponse, Messages, PublishJsonRequest, PublishRequest, QstashError, Receiver, ReceiverConfig, RemoveEndpointsRequest, Schedule, Schedules, SignatureError, State, Topic, Topics, VerifyRequest, WithCursor };
+export { AddEndpointsRequest, Client, CreateScheduleRequest, Endpoint, Event, EventsRequest, GetEventsResponse, Message, Messages, PublishJsonRequest, PublishRequest, QstashError, Receiver, ReceiverConfig, RemoveEndpointsRequest, Schedule, Schedules, SignatureError, State, Topic, Topics, VerifyRequest, WithCursor };

dist/index.js

@@ -224,2 +224,31 @@ "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
+// src/client/dlq.ts
+var DLQ = class {
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * List messages in the dlq
+   */
+  listMessages() {
+    return _chunkEQTYEU4Ujs.__async.call(void 0, this, null, function* () {
+      return yield this.http.request({
+        method: "GET",
+        path: ["v2", "dlq", "messages"]
+      });
+    });
+  }
+  /**
+   * Remove a message from the dlq using it's `dlqId`
+   */
+  delete(dlqMessageId) {
+    return _chunkEQTYEU4Ujs.__async.call(void 0, this, null, function* () {
+      return yield this.http.request({
+        method: "DELETE",
+        path: ["v2", "dlq", "messages", dlqMessageId]
+      });
+    });
+  }
+};
+
 // src/client/client.ts
@@ -243,2 +272,10 @@ var Client = class {
   /**
+   * Access the dlq API.
+   *
+   * List or remove messages from the DLQ.
+   */
+  get dlq() {
+    return new DLQ(this.http);
+  }
+  /**
    * Access the message API.
@@ -254,3 +291,3 @@ *
    *
-   * Read or delete schedules.
+   * Create, read or delete schedules.
    */
@@ -257,0 +294,0 @@ get schedules() {

package.json

 {
   "name": "@upstash/qstash",
-  "version": "2.0.0-canary.21",
+  "version": "2.0.0-canary.22",
   "description": "Official Typescript client for QStash",
@@ -5,0 +5,0 @@ "repository": {

No alert changes

Improved metrics

Total package byte prevSize

157507

increased by6.85%

Lines of code

2134

increased by8.66%

No dependency changes