@upstash/qstash 2.1.9 → 2.1.11

package/dist/{chunk-EQTYEU4U.js → chunk-EROSIHWE.js}

@@ -109,4 +109,3 @@ var Receiver = class {
 
 
 exports.__spreadValues = __spreadValues; exports.__spreadProps = __spreadProps; exports.__async = __async; exports.__forAwait = __forAwait; exports.SignatureError = SignatureError; exports.Receiver = Receiver;
-//# sourceMappingURL=chunk-EQTYEU4U.js.map

package/dist/{chunk-G4FL5XMG.mjs → chunk-FK4ORXI6.mjs}

@@ -109,4 +109,3 @@ export {
   SignatureError,
   Receiver
 };
-//# sourceMappingURL=chunk-G4FL5XMG.mjs.map

package/dist/index.d.mts

@@ -113,73 +113,6 @@ type RetryConfig = false | {
     backoff?: (retryCount: number) => number;
 };
 
-type Endpoint = {
-    /**
-     * The name of the endpoint (optional)
-     */
-    name?: string;
-    /**
-     * The url of the endpoint
-     */
-    url: string;
-};
-type AddEndpointsRequest = {
-    /**
-     * The name of the topic.
-     * Must be unique and only contain alphanumeric, hyphen, underscore and periods.
-     */
-    name: string;
-    endpoints: Endpoint[];
-};
-type RemoveEndpointsRequest = {
-    /**
-     * The name of the topic.
-     * Must be unique and only contain alphanumeric, hyphen, underscore and periods.
-     */
-    name: string;
-    endpoints: ({
-        name: string;
-        url?: string;
-    } | {
-        name?: string;
-        url: string;
-    })[];
-};
-type Topic = {
-    /**
-     * The name of this topic.
-     */
-    name: string;
-    /**
-     * A list of all subscribed endpoints
-     */
-    endpoints: Endpoint[];
-};
-declare class Topics {
-    private readonly http;
-    constructor(http: Requester);
-    /**
-     * Create a new topic with the given name and endpoints
-     */
-    addEndpoints(req: AddEndpointsRequest): Promise<void>;
-    /**
-     * Remove endpoints from a topic.
-     */
-    removeEndpoints(req: RemoveEndpointsRequest): Promise<void>;
-    /**
-     * Get a list of all topics.
-     */
-    list(): Promise<Topic[]>;
-    /**
-     * Get a single topic
-     */
-    get(name: string): Promise<Topic>;
-    /**
-     * Delete a topic
-     */
-    delete(name: string): Promise<void>;
-}
-
 type Message = {
     /**
      * A unique identifier for this message.
@@ -214,13 +147,17 @@ type Message = {
      */
     notBefore?: number;
     /**
-     * A unix timestamp (milliseconds) when this messages was crated.
+     * A unix timestamp (milliseconds) when this messages was created.
      */
     createdAt: number;
     /**
      * The callback url if configured.
      */
     callback?: string;
+    /**
+     * The failure callback url if configured.
+     */
+    failureCallback?: string;
 };
 declare class Messages {
     private readonly http;
@@ -235,6 +172,27 @@ declare class Messages {
     delete(messageId: string): Promise<void>;
 }
 
+type DlqMessage = Message & {
+    dlqId: string;
+};
+declare class DLQ {
+    private readonly http;
+    constructor(http: Requester);
+    /**
+     * List messages in the dlq
+     */
+    listMessages(opts?: {
+        cursor?: string;
+    }): Promise<{
+        messages: DlqMessage[];
+        cursor?: string;
+    }>;
+    /**
+     * Remove a message from the dlq using it's `dlqId`
+     */
+    delete(dlqMessageId: string): Promise<void>;
+}
+
 type Schedule = {
     scheduleId: string;
     cron: string;
@@ -246,6 +204,7 @@ type Schedule = {
     retries: number;
     delay?: number;
     callback?: string;
+    failureCallback?: string;
 };
 type CreateScheduleRequest = {
     /**
@@ -277,7 +236,7 @@ type CreateScheduleRequest = {
      */
     delay?: number;
     /**
-     * In case your destination server is unavaialble or returns a status code outside of the 200-299
+     * In case your destination server is unavailable 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
@@ -293,6 +252,14 @@ type CreateScheduleRequest = {
      * @default undefined
      */
     callback?: string;
+    /**
+     * Use a failure callback url to handle messages that could not be delivered.
+     *
+     * The failure callback url must be publicly accessible
+     *
+     * @default undefined
+     */
+    failureCallback?: string;
     /**
      * The method to use when sending a request to your API
      *
@@ -327,6 +294,73 @@ declare class Schedules {
     delete(scheduleId: string): Promise<void>;
 }
 
+type Endpoint = {
+    /**
+     * The name of the endpoint (optional)
+     */
+    name?: string;
+    /**
+     * The url of the endpoint
+     */
+    url: string;
+};
+type AddEndpointsRequest = {
+    /**
+     * The name of the topic.
+     * Must be unique and only contain alphanumeric, hyphen, underscore and periods.
+     */
+    name: string;
+    endpoints: Endpoint[];
+};
+type RemoveEndpointsRequest = {
+    /**
+     * The name of the topic.
+     * Must be unique and only contain alphanumeric, hyphen, underscore and periods.
+     */
+    name: string;
+    endpoints: ({
+        name: string;
+        url?: string;
+    } | {
+        name?: string;
+        url: string;
+    })[];
+};
+type Topic = {
+    /**
+     * The name of this topic.
+     */
+    name: string;
+    /**
+     * A list of all subscribed endpoints
+     */
+    endpoints: Endpoint[];
+};
+declare class Topics {
+    private readonly http;
+    constructor(http: Requester);
+    /**
+     * Create a new topic with the given name and endpoints
+     */
+    addEndpoints(req: AddEndpointsRequest): Promise<void>;
+    /**
+     * Remove endpoints from a topic.
+     */
+    removeEndpoints(req: RemoveEndpointsRequest): Promise<void>;
+    /**
+     * Get a list of all topics.
+     */
+    list(): Promise<Topic[]>;
+    /**
+     * Get a single topic
+     */
+    get(name: string): Promise<Topic>;
+    /**
+     * Delete a topic
+     */
+    delete(name: string): Promise<void>;
+}
+
 type State = "CREATED" | "ACTIVE" | "DELIVERED" | "ERROR" | "RETRY" | "FAILED";
 type Event = {
     time: number;
@@ -342,27 +376,6 @@ type WithCursor<T> = T & {
     cursor?: number;
 };
 
-type DlqMessage = Message & {
-    dlqId: string;
-};
-declare class DLQ {
-    private readonly http;
-    constructor(http: Requester);
-    /**
-     * List messages in the dlq
-     */
-    listMessages(opts?: {
-        cursor?: string;
-    }): Promise<{
-        messages: DlqMessage[];
-        cursor?: string;
-    }>;
-    /**
-     * Remove a message from the dlq using it's `dlqId`
-     */
-    delete(dlqMessageId: string): Promise<void>;
-}
-
 type ClientConfig = {
     /**
      * Url of the qstash api server.
@@ -461,6 +474,14 @@ type PublishRequest<TBody = BodyInit> = {
      * @default undefined
      */
     callback?: string;
+    /**
+     * Use a failure callback url to handle messages that could not be delivered.
+     *
+     * The failure callback url must be publicly accessible
+     *
+     * @default undefined
+     */
+    failureCallback?: string;
     /**
      * The method to use when sending a request to your API
      *

package/dist/index.d.ts

@@ -113,73 +113,6 @@ type RetryConfig = false | {
     backoff?: (retryCount: number) => number;
 };
 
-type Endpoint = {
-    /**
-     * The name of the endpoint (optional)
-     */
-    name?: string;
-    /**
-     * The url of the endpoint
-     */
-    url: string;
-};
-type AddEndpointsRequest = {
-    /**
-     * The name of the topic.
-     * Must be unique and only contain alphanumeric, hyphen, underscore and periods.
-     */
-    name: string;
-    endpoints: Endpoint[];
-};
-type RemoveEndpointsRequest = {
-    /**
-     * The name of the topic.
-     * Must be unique and only contain alphanumeric, hyphen, underscore and periods.
-     */
-    name: string;
-    endpoints: ({
-        name: string;
-        url?: string;
-    } | {
-        name?: string;
-        url: string;
-    })[];
-};
-type Topic = {
-    /**
-     * The name of this topic.
-     */
-    name: string;
-    /**
-     * A list of all subscribed endpoints
-     */
-    endpoints: Endpoint[];
-};
-declare class Topics {
-    private readonly http;
-    constructor(http: Requester);
-    /**
-     * Create a new topic with the given name and endpoints
-     */
-    addEndpoints(req: AddEndpointsRequest): Promise<void>;
-    /**
-     * Remove endpoints from a topic.
-     */
-    removeEndpoints(req: RemoveEndpointsRequest): Promise<void>;
-    /**
-     * Get a list of all topics.
-     */
-    list(): Promise<Topic[]>;
-    /**
-     * Get a single topic
-     */
-    get(name: string): Promise<Topic>;
-    /**
-     * Delete a topic
-     */
-    delete(name: string): Promise<void>;
-}
-
 type Message = {
     /**
      * A unique identifier for this message.
@@ -214,13 +147,17 @@ type Message = {
      */
     notBefore?: number;
     /**
-     * A unix timestamp (milliseconds) when this messages was crated.
+     * A unix timestamp (milliseconds) when this messages was created.
      */
     createdAt: number;
     /**
      * The callback url if configured.
      */
     callback?: string;
+    /**
+     * The failure callback url if configured.
+     */
+    failureCallback?: string;
 };
 declare class Messages {
     private readonly http;
@@ -235,6 +172,27 @@ declare class Messages {
     delete(messageId: string): Promise<void>;
 }
 
+type DlqMessage = Message & {
+    dlqId: string;
+};
+declare class DLQ {
+    private readonly http;
+    constructor(http: Requester);
+    /**
+     * List messages in the dlq
+     */
+    listMessages(opts?: {
+        cursor?: string;
+    }): Promise<{
+        messages: DlqMessage[];
+        cursor?: string;
+    }>;
+    /**
+     * Remove a message from the dlq using it's `dlqId`
+     */
+    delete(dlqMessageId: string): Promise<void>;
+}
+
 type Schedule = {
     scheduleId: string;
     cron: string;
@@ -246,6 +204,7 @@ type Schedule = {
     retries: number;
     delay?: number;
     callback?: string;
+    failureCallback?: string;
 };
 type CreateScheduleRequest = {
     /**
@@ -277,7 +236,7 @@ type CreateScheduleRequest = {
      */
     delay?: number;
     /**
-     * In case your destination server is unavaialble or returns a status code outside of the 200-299
+     * In case your destination server is unavailable 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
@@ -293,6 +252,14 @@ type CreateScheduleRequest = {
      * @default undefined
      */
     callback?: string;
+    /**
+     * Use a failure callback url to handle messages that could not be delivered.
+     *
+     * The failure callback url must be publicly accessible
+     *
+     * @default undefined
+     */
+    failureCallback?: string;
     /**
      * The method to use when sending a request to your API
      *
@@ -327,6 +294,73 @@ declare class Schedules {
     delete(scheduleId: string): Promise<void>;
 }
 
+type Endpoint = {
+    /**
+     * The name of the endpoint (optional)
+     */
+    name?: string;
+    /**
+     * The url of the endpoint
+     */
+    url: string;
+};
+type AddEndpointsRequest = {
+    /**
+     * The name of the topic.
+     * Must be unique and only contain alphanumeric, hyphen, underscore and periods.
+     */
+    name: string;
+    endpoints: Endpoint[];
+};
+type RemoveEndpointsRequest = {
+    /**
+     * The name of the topic.
+     * Must be unique and only contain alphanumeric, hyphen, underscore and periods.
+     */
+    name: string;
+    endpoints: ({
+        name: string;
+        url?: string;
+    } | {
+        name?: string;
+        url: string;
+    })[];
+};
+type Topic = {
+    /**
+     * The name of this topic.
+     */
+    name: string;
+    /**
+     * A list of all subscribed endpoints
+     */
+    endpoints: Endpoint[];
+};
+declare class Topics {
+    private readonly http;
+    constructor(http: Requester);
+    /**
+     * Create a new topic with the given name and endpoints
+     */
+    addEndpoints(req: AddEndpointsRequest): Promise<void>;
+    /**
+     * Remove endpoints from a topic.
+     */
+    removeEndpoints(req: RemoveEndpointsRequest): Promise<void>;
+    /**
+     * Get a list of all topics.
+     */
+    list(): Promise<Topic[]>;
+    /**
+     * Get a single topic
+     */
+    get(name: string): Promise<Topic>;
+    /**
+     * Delete a topic
+     */
+    delete(name: string): Promise<void>;
+}
+
 type State = "CREATED" | "ACTIVE" | "DELIVERED" | "ERROR" | "RETRY" | "FAILED";
 type Event = {
     time: number;
@@ -342,27 +376,6 @@ type WithCursor<T> = T & {
     cursor?: number;
 };
 
-type DlqMessage = Message & {
-    dlqId: string;
-};
-declare class DLQ {
-    private readonly http;
-    constructor(http: Requester);
-    /**
-     * List messages in the dlq
-     */
-    listMessages(opts?: {
-        cursor?: string;
-    }): Promise<{
-        messages: DlqMessage[];
-        cursor?: string;
-    }>;
-    /**
-     * Remove a message from the dlq using it's `dlqId`
-     */
-    delete(dlqMessageId: string): Promise<void>;
-}
-
 type ClientConfig = {
     /**
      * Url of the qstash api server.
@@ -461,6 +474,14 @@ type PublishRequest<TBody = BodyInit> = {
      * @default undefined
      */
     callback?: string;
+    /**
+     * Use a failure callback url to handle messages that could not be delivered.
+     *
+     * The failure callback url must be publicly accessible
+     *
+     * @default undefined
+     */
+    failureCallback?: string;
     /**
      * The method to use when sending a request to your API
      *