@upstash/qstash 0.0.0 → 0.0.2

package/esm/client.js

@@ -1,6 +1,8 @@
 import { HttpClient } from "./http.js";
-import { Topics } from "./topic.js";
-import { Endpoints } from "./endpoint.js";
+import { Topics } from "./topics.js";
+import { Messages } from "./messages.js";
+import { Schedules } from "./schedules.js";
+import { Endpoints } from "./endpoints.js";
 export class Client {
     constructor(config) {
         Object.defineProperty(this, "http", {
@@ -22,6 +24,12 @@ export class Client {
     get endpoints() {
         return new Endpoints(this.http);
     }
+    get messages() {
+        return new Messages(this.http);
+    }
+    get schedules() {
+        return new Schedules(this.http);
+    }
     async publish(req) {
         const res = await this.http.request({
             path: ["v1", "publish", req.destination],
@@ -31,4 +39,16 @@ export class Client {
         });
         return res;
     }
+    async logs(req) {
+        const query = {};
+        if (req?.cursor && req.cursor > 0) {
+            query["cursor"] = req.cursor;
+        }
+        const res = await this.http.request({
+            path: ["v1", "logs"],
+            method: "GET",
+            query,
+        });
+        return res;
+    }
 }

package/esm/http.js

@@ -47,17 +47,24 @@ export class HttpClient {
             "Upstash-Authorization": `Bearer ${this.authorization}`,
         });
         const requestOptions = {
-            method: "POST",
+            method: req.method,
             headers,
             body: req.body,
             keepalive: req.keepalive,
         };
-        await fetch("https://qstash-debug.requestcatcher.com/test", requestOptions);
+        const url = new URL([this.baseUrl, ...(req.path ?? [])].join("/"));
+        if (req.query) {
+            for (const [key, value] of Object.entries(req.query)) {
+                if (typeof value !== "undefined") {
+                    url.searchParams.set(key, value.toString());
+                }
+            }
+        }
         let res = null;
         let error = null;
         for (let i = 0; i <= this.retry.attempts; i++) {
             try {
-                res = await fetch([this.baseUrl, ...(req.path ?? [])].join("/"), requestOptions);
+                res = await fetch(url.toString(), requestOptions);
                 break;
             }
             catch (err) {

package/esm/messages.js

@@ -0,0 +1,64 @@
+export class Messages {
+    constructor(http) {
+        Object.defineProperty(this, "http", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.http = http;
+    }
+    /**
+     * Get a message
+     */
+    async get(req) {
+        return await this.http.request({
+            method: "GET",
+            path: ["v1", "messages", req.id],
+            headers: { "Content-Type": "application/json" },
+        });
+    }
+    /**
+     * List your messages
+     */
+    async list(req) {
+        return await this.http.request({
+            method: "GET",
+            path: ["v1", "messages"],
+            headers: { "Content-Type": "application/json" },
+            query: { cursor: req?.cursor },
+        });
+    }
+    /**
+     * List logs from a message
+     */
+    async logs(req) {
+        return await this.http.request({
+            method: "GET",
+            path: ["v1", "messages", req.id, "logs"],
+            headers: { "Content-Type": "application/json" },
+            query: { cursor: req.cursor },
+        });
+    }
+    /**
+     * List tasks for a message
+     */
+    async tasks(req) {
+        return await this.http.request({
+            method: "GET",
+            path: ["v1", "messages", req.id, "tasks"],
+            headers: { "Content-Type": "application/json" },
+            query: { cursor: req.cursor },
+        });
+    }
+    /**
+     * Cancel a topic by name or ID.
+     */
+    async delete(req) {
+        return await this.http.request({
+            method: "DELETE",
+            path: ["v1", "messages", req.id],
+            headers: { "Content-Type": "application/json" },
+        });
+    }
+}

package/esm/schedules.js

@@ -0,0 +1,41 @@
+export class Schedules {
+    constructor(http) {
+        Object.defineProperty(this, "http", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.http = http;
+    }
+    /**
+     * Get a schedule
+     */
+    async get(req) {
+        return await this.http.request({
+            method: "GET",
+            path: ["v1", "schedules", req.id],
+            headers: { "Content-Type": "application/json" },
+        });
+    }
+    /**
+     * List your schedules
+     */
+    async list() {
+        return await this.http.request({
+            method: "GET",
+            path: ["v1", "schedules"],
+            headers: { "Content-Type": "application/json" },
+        });
+    }
+    /**
+     * Delete a schedule
+     */
+    async delete(req) {
+        return await this.http.request({
+            method: "DELETE",
+            path: ["v1", "schedules", req.id],
+            headers: { "Content-Type": "application/json" },
+        });
+    }
+}

package/esm/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

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

package/script/client.js

@@ -2,8 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
 const http_js_1 = require("./http.js");
-const topic_js_1 = require("./topic.js");
-const endpoint_js_1 = require("./endpoint.js");
+const topics_js_1 = require("./topics.js");
+const messages_js_1 = require("./messages.js");
+const schedules_js_1 = require("./schedules.js");
+const endpoints_js_1 = require("./endpoints.js");
 class Client {
     constructor(config) {
         Object.defineProperty(this, "http", {
@@ -20,10 +22,16 @@ class Client {
         });
     }
     get topics() {
-        return new topic_js_1.Topics(this.http);
+        return new topics_js_1.Topics(this.http);
     }
     get endpoints() {
-        return new endpoint_js_1.Endpoints(this.http);
+        return new endpoints_js_1.Endpoints(this.http);
+    }
+    get messages() {
+        return new messages_js_1.Messages(this.http);
+    }
+    get schedules() {
+        return new schedules_js_1.Schedules(this.http);
     }
     async publish(req) {
         const res = await this.http.request({
@@ -34,5 +42,17 @@ class Client {
         });
         return res;
     }
+    async logs(req) {
+        const query = {};
+        if (req?.cursor && req.cursor > 0) {
+            query["cursor"] = req.cursor;
+        }
+        const res = await this.http.request({
+            path: ["v1", "logs"],
+            method: "GET",
+            query,
+        });
+        return res;
+    }
 }
 exports.Client = Client;

package/script/http.js

@@ -50,17 +50,24 @@ class HttpClient {
             "Upstash-Authorization": `Bearer ${this.authorization}`,
         });
         const requestOptions = {
-            method: "POST",
+            method: req.method,
             headers,
             body: req.body,
             keepalive: req.keepalive,
         };
-        await fetch("https://qstash-debug.requestcatcher.com/test", requestOptions);
+        const url = new URL([this.baseUrl, ...(req.path ?? [])].join("/"));
+        if (req.query) {
+            for (const [key, value] of Object.entries(req.query)) {
+                if (typeof value !== "undefined") {
+                    url.searchParams.set(key, value.toString());
+                }
+            }
+        }
         let res = null;
         let error = null;
         for (let i = 0; i <= this.retry.attempts; i++) {
             try {
-                res = await fetch([this.baseUrl, ...(req.path ?? [])].join("/"), requestOptions);
+                res = await fetch(url.toString(), requestOptions);
                 break;
             }
             catch (err) {

package/script/messages.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Messages = void 0;
+class Messages {
+    constructor(http) {
+        Object.defineProperty(this, "http", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.http = http;
+    }
+    /**
+     * Get a message
+     */
+    async get(req) {
+        return await this.http.request({
+            method: "GET",
+            path: ["v1", "messages", req.id],
+            headers: { "Content-Type": "application/json" },
+        });
+    }
+    /**
+     * List your messages
+     */
+    async list(req) {
+        return await this.http.request({
+            method: "GET",
+            path: ["v1", "messages"],
+            headers: { "Content-Type": "application/json" },
+            query: { cursor: req?.cursor },
+        });
+    }
+    /**
+     * List logs from a message
+     */
+    async logs(req) {
+        return await this.http.request({
+            method: "GET",
+            path: ["v1", "messages", req.id, "logs"],
+            headers: { "Content-Type": "application/json" },
+            query: { cursor: req.cursor },
+        });
+    }
+    /**
+     * List tasks for a message
+     */
+    async tasks(req) {
+        return await this.http.request({
+            method: "GET",
+            path: ["v1", "messages", req.id, "tasks"],
+            headers: { "Content-Type": "application/json" },
+            query: { cursor: req.cursor },
+        });
+    }
+    /**
+     * Cancel a topic by name or ID.
+     */
+    async delete(req) {
+        return await this.http.request({
+            method: "DELETE",
+            path: ["v1", "messages", req.id],
+            headers: { "Content-Type": "application/json" },
+        });
+    }
+}
+exports.Messages = Messages;

package/script/schedules.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schedules = void 0;
+class Schedules {
+    constructor(http) {
+        Object.defineProperty(this, "http", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.http = http;
+    }
+    /**
+     * Get a schedule
+     */
+    async get(req) {
+        return await this.http.request({
+            method: "GET",
+            path: ["v1", "schedules", req.id],
+            headers: { "Content-Type": "application/json" },
+        });
+    }
+    /**
+     * List your schedules
+     */
+    async list() {
+        return await this.http.request({
+            method: "GET",
+            path: ["v1", "schedules"],
+            headers: { "Content-Type": "application/json" },
+        });
+    }
+    /**
+     * Delete a schedule
+     */
+    async delete(req) {
+        return await this.http.request({
+            method: "DELETE",
+            path: ["v1", "schedules", req.id],
+            headers: { "Content-Type": "application/json" },
+        });
+    }
+}
+exports.Schedules = Schedules;

package/script/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/types/client.d.ts

@@ -1,6 +1,9 @@
 import { Requester } from "./http.js";
-import { Topics } from "./topic.js";
-import { Endpoints } from "./endpoint.js";
+import { Topics } from "./topics.js";
+import { Messages } from "./messages.js";
+import { Schedules } from "./schedules.js";
+import { Endpoints } from "./endpoints.js";
+import type { Log } from "./types.js";
 export declare type ClientConfig = {
     /**
      * Url of the qstash api server
@@ -107,12 +110,22 @@ declare type PublishRequest = {
      */
     retries?: number;
 };
+export declare type LogsRequest = {
+    cursor?: number;
+};
+export declare type GetLogsRespone = {
+    cursor?: number;
+    logs: Log[];
+};
 export declare class Client {
     http: Requester;
     constructor(config: ClientConfig);
     get topics(): Topics;
     get endpoints(): Endpoints;
+    get messages(): Messages;
+    get schedules(): Schedules;
     publish<R extends PublishRequest = PublishRequest>(req: R): Promise<PublishResponse<R>>;
+    logs(req?: LogsRequest): Promise<GetLogsRespone>;
 }
 declare type PublishResponse<PublishRequest> = PublishRequest extends {
     cron: string;

package/types/http.d.ts

@@ -20,6 +20,7 @@ export declare type UpstashRequest = {
      * A string to set request's method.
      */
     method?: "GET" | "POST" | "PUT" | "DELETE";
+    query?: Record<string, string | number | boolean | undefined>;
 };
 export declare type UpstashResponse<TResult> = TResult & {
     error?: string;

package/types/messages.d.ts

@@ -0,0 +1,66 @@
+import { Requester } from "./http.js";
+import type { Log, Task } from "./types.js";
+export declare type GetMessageRequest = {
+    id: string;
+};
+export declare type CancelMessageRequest = {
+    id: string;
+};
+export declare type Message = {
+    messageID: string;
+    header: Record<string, string[]>;
+    body: string;
+} & ({
+    url: string;
+    topicID?: never;
+} | {
+    url?: never;
+    topicID: string;
+});
+export declare type ListMessagesRequest = {
+    cursor?: number;
+};
+export declare type ListMessagesResponse = {
+    cursor?: number;
+    messages: Message[];
+};
+export declare type ListLogsRequest = {
+    id: string;
+    cursor?: number;
+};
+export declare type ListLogsResponse = {
+    cursor?: number;
+    logs: Log[];
+};
+export declare type ListTasksRequest = {
+    id: string;
+    cursor?: number;
+};
+export declare type ListTasksResponse = {
+    cursor?: number;
+    logs: Task[];
+};
+export declare class Messages {
+    private readonly http;
+    constructor(http: Requester);
+    /**
+     * Get a message
+     */
+    get(req: GetMessageRequest): Promise<Message>;
+    /**
+     * List your messages
+     */
+    list(req?: ListMessagesRequest): Promise<ListMessagesResponse>;
+    /**
+     * List logs from a message
+     */
+    logs(req: ListLogsRequest): Promise<ListLogsResponse>;
+    /**
+     * List tasks for a message
+     */
+    tasks(req: ListTasksRequest): Promise<ListTasksResponse>;
+    /**
+     * Cancel a topic by name or ID.
+     */
+    delete(req: CancelMessageRequest): Promise<void>;
+}

package/types/schedules.d.ts

@@ -0,0 +1,63 @@
+import { Requester } from "./http.js";
+import type { Log, Task } from "./types.js";
+export declare type GetScheduleRequest = {
+    id: string;
+};
+export declare type DeleteScheduleRequest = {
+    id: string;
+};
+export declare type Schedule = {
+    scheduleID: string;
+    cron: string;
+    createdAt: number;
+    content: {
+        header: Record<string, string[]>;
+        body: string;
+    };
+    destination: {
+        type: "topicID";
+        topicID: string;
+        url?: never;
+    } | {
+        type: "url";
+        topicID?: never;
+        url: string;
+    };
+    settings: {
+        deadline?: number;
+        notBefore?: number;
+        retries?: number;
+    };
+};
+export declare type ListLogsRequest = {
+    id: string;
+    cursor?: number;
+};
+export declare type ListLogsResponse = {
+    cursor?: number;
+    logs: Log[];
+};
+export declare type ListTasksRequest = {
+    id: string;
+    cursor?: number;
+};
+export declare type ListTasksResponse = {
+    cursor?: number;
+    logs: Task[];
+};
+export declare class Schedules {
+    private readonly http;
+    constructor(http: Requester);
+    /**
+     * Get a schedule
+     */
+    get(req: GetScheduleRequest): Promise<Schedule>;
+    /**
+     * List your schedules
+     */
+    list(): Promise<Schedule[]>;
+    /**
+     * Delete a schedule
+     */
+    delete(req: DeleteScheduleRequest): Promise<void>;
+}

package/types/types.d.ts

@@ -0,0 +1,20 @@
+export declare type State = "created" | "scheduled" | "active" | "delivered" | "error" | "failed" | "canceled";
+export declare type Log = {
+    time: number;
+    state: State;
+    messageID: string;
+    taskID: string;
+    nextScheduledAt?: number;
+    error?: string;
+};
+export declare type WithCursor<T> = T & {
+    cursor?: number;
+};
+export declare type Task = {
+    taskID: string;
+    state: State;
+    maxRetry: number;
+    retried: number;
+    completedAt?: number;
+    url: string;
+};

package/.releaserc

@@ -1,14 +0,0 @@
-{
-  "branches": [
-    {
-      "name": "release"
-    },
-    {
-      "name": "main",
-      "channel": "next",
-      "prerelease": "next"
-    }
-  ],
-  "dryRun": false,
-  "ci": true
-}