@upstash/qstash 0.0.2 → 0.0.3

package/esm/client.js

@@ -18,27 +18,106 @@ export class Client {
             authorization: config.authorization,
         });
     }
+    /**
+     * Access the topic API.
+     *
+     * Create, read, update or delete topics.
+     */
     get topics() {
         return new Topics(this.http);
     }
+    /**
+     * Access the endpoint API.
+     *
+     * Create, read, update or delete endpoints.
+     */
     get endpoints() {
         return new Endpoints(this.http);
     }
+    /**
+     * Access the message API.
+     *
+     * Read or cancel messages.
+     */
     get messages() {
         return new Messages(this.http);
     }
+    /**
+     * Access the schedule API.
+     *
+     * Read or delete schedules.
+     */
     get schedules() {
         return new Schedules(this.http);
     }
     async publish(req) {
+        const destination = req.url ?? req.topic;
+        if (!destination) {
+            throw new Error("Either url or topic must be set");
+        }
+        const headers = new Headers(req.headers);
+        if (req.delay) {
+            headers.set("Upstash-Delay", req.delay.toFixed());
+        }
+        if (req.notBefore) {
+            headers.set("Upstash-Not-Before", req.notBefore.toFixed());
+        }
+        if (req.deadline) {
+            headers.set("Upstash-Deadline", req.deadline.toFixed());
+        }
+        if (req.deduplicationID) {
+            headers.set("Upstash-Deduplication-ID", req.deduplicationID);
+        }
+        if (req.contentBasedDeduplication) {
+            headers.set("Upstash-Content-Based-Deduplication", "true");
+        }
+        if (req.retries) {
+            headers.set("Upstash-Retries", req.retries.toFixed());
+        }
+        if (req.cron) {
+            headers.set("Upstash-Cron", req.cron);
+        }
         const res = await this.http.request({
-            path: ["v1", "publish", req.destination],
-            body: req.cron,
-            headers: req.headers,
+            path: ["v1", "publish", destination],
+            body: req.body,
+            headers,
             method: "POST",
         });
         return res;
     }
+    /**
+     * publishJSON is a utility wrapper around `publish` that automatically serializes the body
+     * and sets the `Content-Type` header to `application/json`.
+     */
+    async publishJSON(req) {
+        const headers = new Headers(req.headers);
+        headers.set("Content-Type", "application/json");
+        const res = await this.publish({
+            ...req,
+            headers,
+            body: JSON.stringify(req.body),
+        });
+        return res;
+    }
+    /**
+     * Retrieve your logs.
+     *
+     * The logs endpoint is paginated and returns only 100 logs at a time.
+     * If you want to receive more logs, you can use the cursor to paginate.
+     *
+     * The cursor is a unix timestamp with millisecond precision
+     *
+     * @example
+     * ```ts
+     * let cursor = Date.now()
+     * const logs: Log[] = []
+     * while (cursor > 0) {
+     *   const res = await qstash.logs({ cursor })
+     *   logs.push(...res.logs)
+     *   cursor = res.cursor ?? 0
+     * }
+     * ```
+     */
     async logs(req) {
         const query = {};
         if (req?.cursor && req.cursor > 0) {

package/esm/http.js

@@ -42,10 +42,8 @@ export class HttpClient {
         }
     }
     async request(req) {
-        const headers = new Headers({
-            ...req.headers,
-            "Upstash-Authorization": `Bearer ${this.authorization}`,
-        });
+        const headers = new Headers(req.headers);
+        headers.set("Upstash-Authorization", `Bearer ${this.authorization}`);
         const requestOptions = {
             method: req.method,
             headers,
@@ -75,10 +73,9 @@ export class HttpClient {
         if (!res) {
             throw error ?? new Error("Exhausted all retries");
         }
-        const body = (await res.json());
         if (res.status < 200 || res.status >= 300) {
-            throw new QstashError(body.error ?? res.statusText);
+            throw new QstashError(await res.text() ?? res.statusText);
         }
-        return body;
+        return (await res.json());
     }
 }

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/platforms/nodejs.js",
   "types": "./types/platforms/nodejs.d.ts",
   "name": "@upstash/qstash",
-  "version": "v0.0.2",
+  "version": "v0.0.3",
   "description": "Official Deno/Typescript client for qStash",
   "repository": {
     "type": "git",

package/script/client.js

@@ -21,27 +21,106 @@ class Client {
             authorization: config.authorization,
         });
     }
+    /**
+     * Access the topic API.
+     *
+     * Create, read, update or delete topics.
+     */
     get topics() {
         return new topics_js_1.Topics(this.http);
     }
+    /**
+     * Access the endpoint API.
+     *
+     * Create, read, update or delete endpoints.
+     */
     get endpoints() {
         return new endpoints_js_1.Endpoints(this.http);
     }
+    /**
+     * Access the message API.
+     *
+     * Read or cancel messages.
+     */
     get messages() {
         return new messages_js_1.Messages(this.http);
     }
+    /**
+     * Access the schedule API.
+     *
+     * Read or delete schedules.
+     */
     get schedules() {
         return new schedules_js_1.Schedules(this.http);
     }
     async publish(req) {
+        const destination = req.url ?? req.topic;
+        if (!destination) {
+            throw new Error("Either url or topic must be set");
+        }
+        const headers = new Headers(req.headers);
+        if (req.delay) {
+            headers.set("Upstash-Delay", req.delay.toFixed());
+        }
+        if (req.notBefore) {
+            headers.set("Upstash-Not-Before", req.notBefore.toFixed());
+        }
+        if (req.deadline) {
+            headers.set("Upstash-Deadline", req.deadline.toFixed());
+        }
+        if (req.deduplicationID) {
+            headers.set("Upstash-Deduplication-ID", req.deduplicationID);
+        }
+        if (req.contentBasedDeduplication) {
+            headers.set("Upstash-Content-Based-Deduplication", "true");
+        }
+        if (req.retries) {
+            headers.set("Upstash-Retries", req.retries.toFixed());
+        }
+        if (req.cron) {
+            headers.set("Upstash-Cron", req.cron);
+        }
         const res = await this.http.request({
-            path: ["v1", "publish", req.destination],
-            body: req.cron,
-            headers: req.headers,
+            path: ["v1", "publish", destination],
+            body: req.body,
+            headers,
             method: "POST",
         });
         return res;
     }
+    /**
+     * publishJSON is a utility wrapper around `publish` that automatically serializes the body
+     * and sets the `Content-Type` header to `application/json`.
+     */
+    async publishJSON(req) {
+        const headers = new Headers(req.headers);
+        headers.set("Content-Type", "application/json");
+        const res = await this.publish({
+            ...req,
+            headers,
+            body: JSON.stringify(req.body),
+        });
+        return res;
+    }
+    /**
+     * Retrieve your logs.
+     *
+     * The logs endpoint is paginated and returns only 100 logs at a time.
+     * If you want to receive more logs, you can use the cursor to paginate.
+     *
+     * The cursor is a unix timestamp with millisecond precision
+     *
+     * @example
+     * ```ts
+     * let cursor = Date.now()
+     * const logs: Log[] = []
+     * while (cursor > 0) {
+     *   const res = await qstash.logs({ cursor })
+     *   logs.push(...res.logs)
+     *   cursor = res.cursor ?? 0
+     * }
+     * ```
+     */
     async logs(req) {
         const query = {};
         if (req?.cursor && req.cursor > 0) {

package/script/http.js

@@ -45,10 +45,8 @@ class HttpClient {
         }
     }
     async request(req) {
-        const headers = new Headers({
-            ...req.headers,
-            "Upstash-Authorization": `Bearer ${this.authorization}`,
-        });
+        const headers = new Headers(req.headers);
+        headers.set("Upstash-Authorization", `Bearer ${this.authorization}`);
         const requestOptions = {
             method: req.method,
             headers,
@@ -78,11 +76,10 @@ class HttpClient {
         if (!res) {
             throw error ?? new Error("Exhausted all retries");
         }
-        const body = (await res.json());
         if (res.status < 200 || res.status >= 300) {
-            throw new error_js_1.QstashError(body.error ?? res.statusText);
+            throw new error_js_1.QstashError(await res.text() ?? res.statusText);
         }
-        return body;
+        return (await res.json());
     }
 }
 exports.HttpClient = HttpClient;

package/types/client.d.ts

@@ -16,14 +16,21 @@ export declare type ClientConfig = {
      */
     authorization: string;
 };
-declare type PublishRequest = {
+declare type Destination = {
     /**
      * The url of a publicly accessible server where you want to send this message to.
      * The url must have a valid scheme (http or https).
-     *
-     * Alternatively, you can specify a topic name or id instead of a url to publish to a topic.
      */
-    destination: string;
+    url: string;
+    topic?: never;
+} | {
+    url?: never;
+    /**
+     * Either the name or id of a topic to send this message to.
+     */
+    topic: string;
+};
+export declare type PublishRequest = Destination & {
     /**
      * The message to send.
      *
@@ -32,12 +39,6 @@ declare type PublishRequest = {
      * You can leave this empty if you want to send a message with no body.
      */
     body?: BodyInit;
-    /**
-     * Optionally specify a cron expression to repeatedly send this message to the destination.
-     *
-     * @default undefined
-     */
-    cron?: string;
     /**
      * Optionally send along headers with the message.
      * These headers will be sent to your destination.
@@ -109,6 +110,22 @@ declare type PublishRequest = {
      * @default The maximum retry quota associated with your account.
      */
     retries?: number;
+} & ({
+    /**
+     * Optionally specify a cron expression to repeatedly send this message to the destination.
+     *
+     * @default undefined
+     */
+    cron: string;
+} | {
+    cron?: never;
+});
+export declare type PublishJsonRequest = Omit<PublishRequest, "body"> & {
+    /**
+     * The message to send.
+     * This can be anything as long as it can be serialized to JSON.
+     */
+    body: unknown;
 };
 export declare type LogsRequest = {
     cursor?: number;
@@ -120,11 +137,55 @@ export declare type GetLogsRespone = {
 export declare class Client {
     http: Requester;
     constructor(config: ClientConfig);
+    /**
+     * Access the topic API.
+     *
+     * Create, read, update or delete topics.
+     */
     get topics(): Topics;
+    /**
+     * Access the endpoint API.
+     *
+     * Create, read, update or delete endpoints.
+     */
     get endpoints(): Endpoints;
+    /**
+     * Access the message API.
+     *
+     * Read or cancel messages.
+     */
     get messages(): Messages;
+    /**
+     * Access the schedule API.
+     *
+     * Read or delete schedules.
+     */
     get schedules(): Schedules;
-    publish<R extends PublishRequest = PublishRequest>(req: R): Promise<PublishResponse<R>>;
+    publish<R extends PublishRequest>(req: R): Promise<PublishResponse<R>>;
+    /**
+     * publishJSON is a utility wrapper around `publish` that automatically serializes the body
+     * and sets the `Content-Type` header to `application/json`.
+     */
+    publishJSON<R extends PublishJsonRequest = PublishJsonRequest>(req: R): Promise<PublishResponse<R>>;
+    /**
+     * Retrieve your logs.
+     *
+     * The logs endpoint is paginated and returns only 100 logs at a time.
+     * If you want to receive more logs, you can use the cursor to paginate.
+     *
+     * The cursor is a unix timestamp with millisecond precision
+     *
+     * @example
+     * ```ts
+     * let cursor = Date.now()
+     * const logs: Log[] = []
+     * while (cursor > 0) {
+     *   const res = await qstash.logs({ cursor })
+     *   logs.push(...res.logs)
+     *   cursor = res.cursor ?? 0
+     * }
+     * ```
+     */
     logs(req?: LogsRequest): Promise<GetLogsRespone>;
 }
 declare type PublishResponse<PublishRequest> = PublishRequest extends {