@upstash/qstash 2.5.1 → 2.5.3

package/index.d.mts

@@ -1,5 +1,3 @@
-import { BodyInit, HeadersInit } from 'undici';
-
 /**
  * Necessary to verify the signature of a request.
  */
@@ -61,6 +59,23 @@ declare class Receiver {
     private verifyWithKey;
 }
 
+type State = "CREATED" | "ACTIVE" | "DELIVERED" | "ERROR" | "RETRY" | "FAILED";
+type Event = {
+    time: number;
+    state: State;
+    messageId: string;
+    nextDeliveryTime?: number;
+    error?: string;
+    url: string;
+    topicName?: string;
+    endpointName?: string;
+};
+type WithCursor<T> = T & {
+    cursor?: number;
+};
+type BodyInit = Blob | FormData | URLSearchParams | ReadableStream<Uint8Array> | string;
+type HeadersInit = Headers | Record<string, string> | [string, string][] | IterableIterator<[string, string]>;
+
 type UpstashRequest = {
     /**
      * The path to the resource.
@@ -160,6 +175,10 @@ type Message = {
      * The failure callback url if configured.
      */
     failureCallback?: string;
+    /**
+     * The queue name if this message was sent to a queue.
+     */
+    queueName?: string;
 };
 declare class Messages {
     private readonly http;
@@ -213,7 +232,6 @@ type QueueResponse = {
 type UpsertQueueRequest = {
     parallelism: number;
 };
-type EnqueueRequest = PublishRequest;
 declare class Queue {
     private readonly http;
     private readonly queueName;
@@ -237,7 +255,7 @@ declare class Queue {
     /**
      * Enqueue a message to a queue.
      */
-    enqueue(request: EnqueueRequest): Promise<PublishResponse<PublishRequest>>;
+    enqueue<TRequest extends PublishRequest>(request: TRequest): Promise<PublishResponse<TRequest>>;
     /**
      * Enqueue a message to a queue, serializing the body to JSON.
      */
@@ -378,6 +396,14 @@ type RemoveEndpointsRequest = {
     })[];
 };
 type Topic = {
+    /**
+     * A unix timestamp (milliseconds)
+     */
+    createdAt: number;
+    /**
+     * A unix timestamp (milliseconds)
+     */
+    updatedAt: number;
     /**
      * The name of this topic.
      */
@@ -412,21 +438,6 @@ declare class Topics {
     delete(name: string): Promise<void>;
 }
 
-type State = "CREATED" | "ACTIVE" | "DELIVERED" | "ERROR" | "RETRY" | "FAILED";
-type Event = {
-    time: number;
-    state: State;
-    messageId: string;
-    nextDeliveryTime?: number;
-    error?: string;
-    url: string;
-    topicName?: string;
-    endpointName?: string;
-};
-type WithCursor<T> = T & {
-    cursor?: number;
-};
-
 type ClientConfig = {
     /**
      * Url of the qstash api server.
@@ -445,6 +456,9 @@ type ClientConfig = {
      */
     retry?: RetryConfig;
 };
+type PublishBatchRequest<TBody = BodyInit> = PublishRequest<TBody> & {
+    queueName?: string;
+};
 type PublishRequest<TBody = BodyInit> = {
     /**
      * The message to send.
@@ -624,11 +638,11 @@ declare class Client {
     /**
      * Batch publish messages to QStash.
      */
-    batch(request: PublishRequest[]): Promise<PublishResponse<PublishRequest>[]>;
+    batch(request: PublishBatchRequest[]): Promise<PublishResponse<PublishRequest>[]>;
     /**
      * Batch publish messages to QStash, serializing each body to JSON.
      */
-    batchJSON<TBody = unknown, TRequest extends PublishRequest<TBody> = PublishRequest<TBody>>(request: TRequest[]): Promise<PublishResponse<TRequest>[]>;
+    batchJSON<TBody = unknown, TRequest extends PublishBatchRequest<TBody> = PublishBatchRequest<TBody>>(request: TRequest[]): Promise<PublishResponse<TRequest>[]>;
     /**
      * Retrieve your logs.
      *
@@ -670,4 +684,4 @@ declare class QstashRatelimitError extends QstashError {
     constructor(args: unknown);
 }
 
-export { type AddEndpointsRequest, Client, type CreateScheduleRequest, type Endpoint, type Event, type EventsRequest, type GetEventsResponse, type Message, Messages, type PublishJsonRequest, type PublishRequest, type PublishResponse, type PublishToTopicResponse, type PublishToUrlResponse, QstashError, QstashRatelimitError, type QueueRequest, Receiver, type ReceiverConfig, type RemoveEndpointsRequest, type Schedule, Schedules, SignatureError, type State, type Topic, Topics, type VerifyRequest, type WithCursor };
+export { type AddEndpointsRequest, type BodyInit, Client, type CreateScheduleRequest, type Endpoint, type Event, type EventsRequest, type GetEventsResponse, type HeadersInit, type Message, Messages, type PublishBatchRequest, type PublishJsonRequest, type PublishRequest, type PublishResponse, type PublishToTopicResponse, type PublishToUrlResponse, QstashError, QstashRatelimitError, type QueueRequest, Receiver, type ReceiverConfig, type RemoveEndpointsRequest, type Schedule, Schedules, SignatureError, type State, type Topic, Topics, type VerifyRequest, type WithCursor };

package/index.d.ts

@@ -1,5 +1,3 @@
-import { BodyInit, HeadersInit } from 'undici';
-
 /**
  * Necessary to verify the signature of a request.
  */
@@ -61,6 +59,23 @@ declare class Receiver {
     private verifyWithKey;
 }
 
+type State = "CREATED" | "ACTIVE" | "DELIVERED" | "ERROR" | "RETRY" | "FAILED";
+type Event = {
+    time: number;
+    state: State;
+    messageId: string;
+    nextDeliveryTime?: number;
+    error?: string;
+    url: string;
+    topicName?: string;
+    endpointName?: string;
+};
+type WithCursor<T> = T & {
+    cursor?: number;
+};
+type BodyInit = Blob | FormData | URLSearchParams | ReadableStream<Uint8Array> | string;
+type HeadersInit = Headers | Record<string, string> | [string, string][] | IterableIterator<[string, string]>;
+
 type UpstashRequest = {
     /**
      * The path to the resource.
@@ -160,6 +175,10 @@ type Message = {
      * The failure callback url if configured.
      */
     failureCallback?: string;
+    /**
+     * The queue name if this message was sent to a queue.
+     */
+    queueName?: string;
 };
 declare class Messages {
     private readonly http;
@@ -213,7 +232,6 @@ type QueueResponse = {
 type UpsertQueueRequest = {
     parallelism: number;
 };
-type EnqueueRequest = PublishRequest;
 declare class Queue {
     private readonly http;
     private readonly queueName;
@@ -237,7 +255,7 @@ declare class Queue {
     /**
      * Enqueue a message to a queue.
      */
-    enqueue(request: EnqueueRequest): Promise<PublishResponse<PublishRequest>>;
+    enqueue<TRequest extends PublishRequest>(request: TRequest): Promise<PublishResponse<TRequest>>;
     /**
      * Enqueue a message to a queue, serializing the body to JSON.
      */
@@ -378,6 +396,14 @@ type RemoveEndpointsRequest = {
     })[];
 };
 type Topic = {
+    /**
+     * A unix timestamp (milliseconds)
+     */
+    createdAt: number;
+    /**
+     * A unix timestamp (milliseconds)
+     */
+    updatedAt: number;
     /**
      * The name of this topic.
      */
@@ -412,21 +438,6 @@ declare class Topics {
     delete(name: string): Promise<void>;
 }
 
-type State = "CREATED" | "ACTIVE" | "DELIVERED" | "ERROR" | "RETRY" | "FAILED";
-type Event = {
-    time: number;
-    state: State;
-    messageId: string;
-    nextDeliveryTime?: number;
-    error?: string;
-    url: string;
-    topicName?: string;
-    endpointName?: string;
-};
-type WithCursor<T> = T & {
-    cursor?: number;
-};
-
 type ClientConfig = {
     /**
      * Url of the qstash api server.
@@ -445,6 +456,9 @@ type ClientConfig = {
      */
     retry?: RetryConfig;
 };
+type PublishBatchRequest<TBody = BodyInit> = PublishRequest<TBody> & {
+    queueName?: string;
+};
 type PublishRequest<TBody = BodyInit> = {
     /**
      * The message to send.
@@ -624,11 +638,11 @@ declare class Client {
     /**
      * Batch publish messages to QStash.
      */
-    batch(request: PublishRequest[]): Promise<PublishResponse<PublishRequest>[]>;
+    batch(request: PublishBatchRequest[]): Promise<PublishResponse<PublishRequest>[]>;
     /**
      * Batch publish messages to QStash, serializing each body to JSON.
      */
-    batchJSON<TBody = unknown, TRequest extends PublishRequest<TBody> = PublishRequest<TBody>>(request: TRequest[]): Promise<PublishResponse<TRequest>[]>;
+    batchJSON<TBody = unknown, TRequest extends PublishBatchRequest<TBody> = PublishBatchRequest<TBody>>(request: TRequest[]): Promise<PublishResponse<TRequest>[]>;
     /**
      * Retrieve your logs.
      *
@@ -670,4 +684,4 @@ declare class QstashRatelimitError extends QstashError {
     constructor(args: unknown);
 }
 
-export { type AddEndpointsRequest, Client, type CreateScheduleRequest, type Endpoint, type Event, type EventsRequest, type GetEventsResponse, type Message, Messages, type PublishJsonRequest, type PublishRequest, type PublishResponse, type PublishToTopicResponse, type PublishToUrlResponse, QstashError, QstashRatelimitError, type QueueRequest, Receiver, type ReceiverConfig, type RemoveEndpointsRequest, type Schedule, Schedules, SignatureError, type State, type Topic, Topics, type VerifyRequest, type WithCursor };
+export { type AddEndpointsRequest, type BodyInit, Client, type CreateScheduleRequest, type Endpoint, type Event, type EventsRequest, type GetEventsResponse, type HeadersInit, type Message, Messages, type PublishBatchRequest, type PublishJsonRequest, type PublishRequest, type PublishResponse, type PublishToTopicResponse, type PublishToUrlResponse, QstashError, QstashRatelimitError, type QueueRequest, Receiver, type ReceiverConfig, type RemoveEndpointsRequest, type Schedule, Schedules, SignatureError, type State, type Topic, Topics, type VerifyRequest, type WithCursor };

package/index.js

@@ -151,7 +151,6 @@ var Messages = class {
 };
 
 // src/client/utils.ts
-var _undici = require('undici');
 var isIgnoredHeader = (header) => {
   const lowerCaseHeader = header.toLowerCase();
   return lowerCaseHeader.startsWith("content-type") || lowerCaseHeader.startsWith("upstash-");
@@ -168,7 +167,7 @@ function prefixHeaders(headers) {
   return headers;
 }
 function processHeaders(request) {
-  const headers = prefixHeaders(new (0, _undici.Headers)(request.headers));
+  const headers = prefixHeaders(new Headers(request.headers));
   headers.set("Upstash-Method", _nullishCoalesce(request.method, () => ( "POST")));
   if (request.delay !== void 0) {
     headers.set("Upstash-Delay", `${request.delay.toFixed(0)}s`);
@@ -195,7 +194,6 @@ function processHeaders(request) {
 }
 
 // src/client/queue.ts
-
 var Queue = class {
   
   
@@ -279,7 +277,7 @@ var Queue = class {
    * Enqueue a message to a queue, serializing the body to JSON.
    */
   async enqueueJSON(request) {
-    const headers = prefixHeaders(new (0, _undici.Headers)(request.headers));
+    const headers = prefixHeaders(new Headers(request.headers));
     headers.set("Content-Type", "application/json");
     const response = await this.enqueue({
       ...request,
@@ -291,7 +289,6 @@ var Queue = class {
 };
 
 // src/client/schedules.ts
-
 var Schedules = class {
   
   constructor(http) {
@@ -301,7 +298,7 @@ var Schedules = class {
    * Create a schedule
    */
   async create(request) {
-    const headers = prefixHeaders(new (0, _undici.Headers)(request.headers));
+    const headers = prefixHeaders(new Headers(request.headers));
     if (!headers.has("Content-Type")) {
       headers.set("Content-Type", "application/json");
     }
@@ -419,7 +416,6 @@ var Topics = class {
 };
 
 // src/client/client.ts
-
 var Client = class {
   
   constructor(config) {
@@ -484,7 +480,7 @@ var Client = class {
    * and sets the `Content-Type` header to `application/json`.
    */
   async publishJSON(request) {
-    const headers = prefixHeaders(new (0, _undici.Headers)(request.headers));
+    const headers = prefixHeaders(new Headers(request.headers));
     headers.set("Content-Type", "application/json");
     const response = await this.publish({
       ...request,
@@ -504,7 +500,8 @@ var Client = class {
       messages.push({
         destination: _nullishCoalesce(message.url, () => ( message.topic)),
         headers: headerEntries,
-        body: message.body
+        body: message.body,
+        ...message.queueName && { queue: message.queueName }
       });
     }
     const response = await this.http.request({
@@ -525,7 +522,7 @@ var Client = class {
       if ("body" in message) {
         message.body = JSON.stringify(message.body);
       }
-      message.headers = new (0, _undici.Headers)(message.headers);
+      message.headers = new Headers(message.headers);
       message.headers.set("Content-Type", "application/json");
     }
     const response = await this.batch(request);

package/index.mjs

@@ -151,7 +151,6 @@ var Messages = class {
 };
 
 // src/client/utils.ts
-import { Headers as Headers2 } from "undici";
 var isIgnoredHeader = (header) => {
   const lowerCaseHeader = header.toLowerCase();
   return lowerCaseHeader.startsWith("content-type") || lowerCaseHeader.startsWith("upstash-");
@@ -168,7 +167,7 @@ function prefixHeaders(headers) {
   return headers;
 }
 function processHeaders(request) {
-  const headers = prefixHeaders(new Headers2(request.headers));
+  const headers = prefixHeaders(new Headers(request.headers));
   headers.set("Upstash-Method", request.method ?? "POST");
   if (request.delay !== void 0) {
     headers.set("Upstash-Delay", `${request.delay.toFixed(0)}s`);
@@ -195,7 +194,6 @@ function processHeaders(request) {
 }
 
 // src/client/queue.ts
-import { Headers as Headers3 } from "undici";
 var Queue = class {
   http;
   queueName;
@@ -279,7 +277,7 @@ var Queue = class {
    * Enqueue a message to a queue, serializing the body to JSON.
    */
   async enqueueJSON(request) {
-    const headers = prefixHeaders(new Headers3(request.headers));
+    const headers = prefixHeaders(new Headers(request.headers));
     headers.set("Content-Type", "application/json");
     const response = await this.enqueue({
       ...request,
@@ -291,7 +289,6 @@ var Queue = class {
 };
 
 // src/client/schedules.ts
-import { Headers as Headers4 } from "undici";
 var Schedules = class {
   http;
   constructor(http) {
@@ -301,7 +298,7 @@ var Schedules = class {
    * Create a schedule
    */
   async create(request) {
-    const headers = prefixHeaders(new Headers4(request.headers));
+    const headers = prefixHeaders(new Headers(request.headers));
     if (!headers.has("Content-Type")) {
       headers.set("Content-Type", "application/json");
     }
@@ -419,7 +416,6 @@ var Topics = class {
 };
 
 // src/client/client.ts
-import { Headers as Headers5 } from "undici";
 var Client = class {
   http;
   constructor(config) {
@@ -484,7 +480,7 @@ var Client = class {
    * and sets the `Content-Type` header to `application/json`.
    */
   async publishJSON(request) {
-    const headers = prefixHeaders(new Headers5(request.headers));
+    const headers = prefixHeaders(new Headers(request.headers));
     headers.set("Content-Type", "application/json");
     const response = await this.publish({
       ...request,
@@ -504,7 +500,8 @@ var Client = class {
       messages.push({
         destination: message.url ?? message.topic,
         headers: headerEntries,
-        body: message.body
+        body: message.body,
+        ...message.queueName && { queue: message.queueName }
       });
     }
     const response = await this.http.request({
@@ -525,7 +522,7 @@ var Client = class {
       if ("body" in message) {
         message.body = JSON.stringify(message.body);
       }
-      message.headers = new Headers5(message.headers);
+      message.headers = new Headers(message.headers);
       message.headers.set("Content-Type", "application/json");
     }
     const response = await this.batch(request);

package/package.json

@@ -1 +1 @@
-{"version":"v2.5.1","name":"@upstash/qstash","description":"Official Typescript client for QStash","author":"Andreas Thomas <dev@chronark.com>","license":"MIT","homepage":"https://github.com/upstash/sdk-qstash-ts#readme","repository":{"type":"git","url":"git+https://github.com/upstash/sdk-qstash-ts.git"},"bugs":{"url":"https://github.com/upstash/sdk-qstash-ts/issues"},"main":"./index.js","module":"./index.mjs","types":"./index.d.ts","files":["./**"],"exports":{".":{"import":"./index.mjs","require":"./index.js"},"./nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"},"./dist/nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"}},"typesVersions":{"*":{"nextjs":["./nextjs.d.ts"]}},"keywords":["qstash","queue","events","serverless","upstash"],"scripts":{"build":"tsup && cp README.md ./dist/ && cp package.json ./dist/ && cp LICENSE ./dist/","test":"bun test","fmt":"prettier --write .","lint":"tsc && eslint \"src/**/*.{js,ts,tsx}\" --quiet --fix"},"devDependencies":{"@biomejs/biome":"^1.3.3","@commitlint/cli":"^19.2.2","@commitlint/config-conventional":"^19.2.2","@types/crypto-js":"^4.2.0","@types/node":"^20.5.7","@typescript-eslint/eslint-plugin":"^7.0.1","@typescript-eslint/parser":"^7.0.1","bun-types":"latest","eslint":"^8","eslint-plugin-unicorn":"^51.0.1","husky":"^9.0.10","next":"^14.0.2","prettier":"^3.2.5","tsup":"latest","typescript":"^5.4.5","vitest":"latest"},"dependencies":{"crypto-js":">=4.2.0","jose":"^ 5.2.3","undici":"^6.16.0"}}
+{"version":"v2.5.3","name":"@upstash/qstash","description":"Official Typescript client for QStash","author":"Andreas Thomas <dev@chronark.com>","license":"MIT","homepage":"https://github.com/upstash/sdk-qstash-ts#readme","repository":{"type":"git","url":"git+https://github.com/upstash/sdk-qstash-ts.git"},"bugs":{"url":"https://github.com/upstash/sdk-qstash-ts/issues"},"main":"./index.js","module":"./index.mjs","types":"./index.d.ts","files":["./**"],"exports":{".":{"import":"./index.mjs","require":"./index.js"},"./nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"},"./dist/nextjs":{"import":"./nextjs.mjs","require":"./nextjs.js"}},"typesVersions":{"*":{"nextjs":["./nextjs.d.ts"]}},"keywords":["qstash","queue","events","serverless","upstash"],"scripts":{"build":"tsup && cp README.md ./dist/ && cp package.json ./dist/ && cp LICENSE ./dist/","test":"bun test","fmt":"prettier --write .","lint":"tsc && eslint \"src/**/*.{js,ts,tsx}\" --quiet --fix"},"devDependencies":{"@commitlint/cli":"^19.2.2","@commitlint/config-conventional":"^19.2.2","@types/bun":"^1.1.1","@types/crypto-js":"^4.2.0","@typescript-eslint/eslint-plugin":"^7.0.1","@typescript-eslint/parser":"^7.0.1","bun-types":"^1.1.7","eslint":"^8","eslint-plugin-unicorn":"^51.0.1","husky":"^9.0.10","next":"^14.0.2","prettier":"^3.2.5","tsup":"latest","typescript":"^5.4.5","undici-types":"^6.16.0","vitest":"latest"},"dependencies":{"crypto-js":">=4.2.0","jose":"^ 5.2.3"}}