@upstash/qstash 0.0.14 → 0.1.0

package/README.md

@@ -23,11 +23,18 @@ See
 [the list of APIs](https://docs.upstash.com/features/restapi#rest---redis-api-compatibility)
 supported.
 
+## Status of the SDK
+
+It is currently in beta and we are actively collecting feedback from the
+community. Please report any issues you encounter or feature requests in the
+[GitHub issues](https://github.com/upstash/sdk-qstash-ts/issues) or talk to us
+on [Discord](https://discord.gg/w9SenAtbme). Thank you!
+
 ## How does qStash work?
 
-qStash is the message broker between your serverless apps. You send a HTTP
+qStash is the message broker between your serverless apps. You send aa HTTP
 request to qStash, that includes a destination, a payload and optional settings.
-We store your message durable and will deliver it to the destination server via
+We store your message durable and will deliver it to the destination API via
 HTTP. In case the destination is not ready to receive the message, we will retry
 the message later, to guarentee at-least-once delivery.
 
@@ -47,43 +54,51 @@ npm install @upstash/qstash
 import { Redis } from "https://deno.land/x/upstash_qstash/mod.ts";
 ```
 
-### Activate qStash
+### Get your authorization token
 
-Go to [upstash](https://console.upstash.com/qstash) and activate qStash.
+Go to [upstash](https://console.upstash.com/qstash) and copy the token.
 
 ## Basic Usage:
 
 ### Publishing a message
 
 ```ts
-import { Client } from "@upstash/qstash"
-
-const q = new Client({
-  token: <QSTASH_TOKEN>,
-})
-
-const res = await q.publishJSON({
-    body: { hello: "world" },
-})
+import { Client } from "@upstash/qstash";
+/**
+ * Import a fetch polyfill only if you are using node prior to v18.
+ * This is not necessary for nextjs, deno or cloudflare workers.
+ */
+import "isomorphic-fetch";
+
+const c = new Client({
+  token: "<QSTASH_TOKEN>",
+});
 
-console.log(res.messageId)
+const res = await c.publishJSON({
+  destination: "https://my-api...",
+  body: {
+    hello: "world",
+  },
+});
+console.log(res);
+// { messageId: "msg_xxxxxxxxxxxxxxxx" }
 ```
 
-### Consuming a message
+### Receiving a message
 
 How to consume a message depends on your http server. QStash does not receive
 the http request directly, but should be called by you as the first step in your
 handler function.
 
 ```ts
-import { Consumer } from "@upstash/qstash";
+import { Receiver } from "@upstash/qstash";
 
-const c = new Consumer({
+const r = new Receiver({
   currentSigningKey: "..",
   nextSigningKey: "..",
 });
 
-const isValid = await c.verify({
+const isValid = await r.verify({
   /**
    * The signature from the `Upstash-Signature` header.
    */
@@ -103,17 +118,8 @@ const isValid = await c.verify({
 
 ## Docs
 
-See [the documentation](https://docs.upstash.com/features/qstash) for details.
+See [the documentation](https://docs.upstash.com/qstash) for details.
 
 ## Contributing
 
 ### [Install Deno](https://deno.land/#installation)
-
-### Running tests
-
-```sh
-QSTASH_TOKEN=".." deno test -A
-```
-
-```
-```

package/esm/entrypoints/cloudflare.js

@@ -1,7 +1,7 @@
 // dnt-shim-ignore
-import * as c from "../pkg/consumer.js";
+import * as r from "../pkg/receiver.js";
 export * from "../pkg/client/client.js";
-export class Consumer extends c.Consumer {
+export class Receiver extends r.Receiver {
     constructor(config) {
         super({
             ...config,

package/esm/entrypoints/nextjs.js

@@ -1,5 +1,5 @@
 import * as dntShim from "../_dnt.shims.js";
-import { Consumer } from "../pkg/consumer.js";
+import { Receiver } from "../pkg/receiver.js";
 export function verifySignature(handler, config) {
     const currentSigningKey = config?.currentSigningKey ??
         // @ts-ignore Deno can't compile
@@ -13,7 +13,7 @@ export function verifySignature(handler, config) {
     if (!nextSigningKey) {
         throw new Error("nextSigningKey is required, either in the config or as env variable QSTASH_NEXT_SIGNING_KEY");
     }
-    const consumer = new Consumer({
+    const receiver = new Receiver({
         currentSigningKey,
         nextSigningKey,
         subtleCrypto: dntShim.crypto.subtle,
@@ -28,13 +28,14 @@ export function verifySignature(handler, config) {
         }
         const chunks = [];
         for await (const chunk of req) {
-            chunks.push(typeof chunk === 'string' ? Buffer.from(chunk) : chunk);
+            chunks.push(typeof chunk === "string" ? Buffer.from(chunk) : chunk);
         }
         const body = Buffer.concat(chunks).toString("utf-8");
-        // const body = (await buffer(req)).toString();
-        console.log(req.headers, body);
-        const url = config?.url ?? new URL(req.url, `https://${process.env.VERCEL_URL}`).href;
-        const isValid = await consumer.verify({ signature, body, url });
+        // const url = config?.url ?? new URL(
+        //   req.url!,
+        //   `https://${process.env.VERCEL_URL}`,
+        // ).href;
+        const isValid = await receiver.verify({ signature, body });
         if (!isValid) {
             res.status(400);
             res.send("Invalid signature");
@@ -50,7 +51,6 @@ export function verifySignature(handler, config) {
         }
         catch {
             req.body = body;
-            console.log("body is not json");
         }
         return handler(req, res);
     };

package/esm/entrypoints/nodejs.js

@@ -1,11 +1,12 @@
 // dnt-shim-ignore
 import * as dntShim from "../_dnt.shims.js";
-import * as c from "../pkg/consumer.js";
+import * as r from "../pkg/receiver.js";
 export * from "../pkg/client/client.js";
-export class Consumer extends c.Consumer {
+export class Receiver extends r.Receiver {
     constructor(config) {
         super({
             ...config,
+            // use the shimmed one from deno
             subtleCrypto: dntShim.crypto.subtle,
         });
     }

package/esm/pkg/{consumer.js → receiver.js}

@@ -6,9 +6,9 @@ export class SignatureError extends Error {
     }
 }
 /**
- * Consumer offers a simlpe way to verify the signature of a request.
+ * Receiver offers a simlpe way to verify the signature of a request.
  */
-export class Consumer {
+export class Receiver {
     constructor(config) {
         Object.defineProperty(this, "currentSigningKey", {
             enumerable: true,
@@ -63,11 +63,10 @@ export class Consumer {
             throw new SignatureError("signature does not match");
         }
         const p = JSON.parse(new TextDecoder().decode(base64Url.decode(payload)));
-        console.log(JSON.stringify(p, null, 2));
         if (p.iss !== "Upstash") {
             throw new SignatureError(`invalid issuer: ${p.iss}`);
         }
-        if (p.sub !== req.url) {
+        if (typeof req.url !== "undefined" && p.sub !== req.url) {
             throw new SignatureError(`invalid subject: ${p.sub}, want: ${req.url}`);
         }
         const now = Math.floor(Date.now() / 1000);

package/package.json

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

package/script/entrypoints/cloudflare.js

@@ -27,10 +27,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Consumer = void 0;
-const c = __importStar(require("../pkg/consumer.js"));
+exports.Receiver = void 0;
+const r = __importStar(require("../pkg/receiver.js"));
 __exportStar(require("../pkg/client/client.js"), exports);
-class Consumer extends c.Consumer {
+class Receiver extends r.Receiver {
     constructor(config) {
         super({
             ...config,
@@ -39,4 +39,4 @@ class Consumer extends c.Consumer {
         });
     }
 }
-exports.Consumer = Consumer;
+exports.Receiver = Receiver;

package/script/entrypoints/nextjs.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.verifySignature = void 0;
 const dntShim = __importStar(require("../_dnt.shims.js"));
-const consumer_js_1 = require("../pkg/consumer.js");
+const receiver_js_1 = require("../pkg/receiver.js");
 function verifySignature(handler, config) {
     const currentSigningKey = config?.currentSigningKey ??
         // @ts-ignore Deno can't compile
@@ -39,7 +39,7 @@ function verifySignature(handler, config) {
     if (!nextSigningKey) {
         throw new Error("nextSigningKey is required, either in the config or as env variable QSTASH_NEXT_SIGNING_KEY");
     }
-    const consumer = new consumer_js_1.Consumer({
+    const receiver = new receiver_js_1.Receiver({
         currentSigningKey,
         nextSigningKey,
         subtleCrypto: dntShim.crypto.subtle,
@@ -54,13 +54,14 @@ function verifySignature(handler, config) {
         }
         const chunks = [];
         for await (const chunk of req) {
-            chunks.push(typeof chunk === 'string' ? Buffer.from(chunk) : chunk);
+            chunks.push(typeof chunk === "string" ? Buffer.from(chunk) : chunk);
         }
         const body = Buffer.concat(chunks).toString("utf-8");
-        // const body = (await buffer(req)).toString();
-        console.log(req.headers, body);
-        const url = config?.url ?? new URL(req.url, `https://${process.env.VERCEL_URL}`).href;
-        const isValid = await consumer.verify({ signature, body, url });
+        // const url = config?.url ?? new URL(
+        //   req.url!,
+        //   `https://${process.env.VERCEL_URL}`,
+        // ).href;
+        const isValid = await receiver.verify({ signature, body });
         if (!isValid) {
             res.status(400);
             res.send("Invalid signature");
@@ -76,7 +77,6 @@ function verifySignature(handler, config) {
         }
         catch {
             req.body = body;
-            console.log("body is not json");
         }
         return handler(req, res);
     };

package/script/entrypoints/nodejs.js

@@ -26,17 +26,18 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Consumer = void 0;
+exports.Receiver = void 0;
 // dnt-shim-ignore
 const dntShim = __importStar(require("../_dnt.shims.js"));
-const c = __importStar(require("../pkg/consumer.js"));
+const r = __importStar(require("../pkg/receiver.js"));
 __exportStar(require("../pkg/client/client.js"), exports);
-class Consumer extends c.Consumer {
+class Receiver extends r.Receiver {
     constructor(config) {
         super({
             ...config,
+            // use the shimmed one from deno
             subtleCrypto: dntShim.crypto.subtle,
         });
     }
 }
-exports.Consumer = Consumer;
+exports.Receiver = Receiver;

package/script/pkg/{consumer.js → receiver.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Consumer = exports.SignatureError = void 0;
+exports.Receiver = exports.SignatureError = void 0;
 const deps_js_1 = require("../deps.js");
 class SignatureError extends Error {
     constructor(message) {
@@ -10,9 +10,9 @@ class SignatureError extends Error {
 }
 exports.SignatureError = SignatureError;
 /**
- * Consumer offers a simlpe way to verify the signature of a request.
+ * Receiver offers a simlpe way to verify the signature of a request.
  */
-class Consumer {
+class Receiver {
     constructor(config) {
         Object.defineProperty(this, "currentSigningKey", {
             enumerable: true,
@@ -67,11 +67,10 @@ class Consumer {
             throw new SignatureError("signature does not match");
         }
         const p = JSON.parse(new TextDecoder().decode(deps_js_1.base64Url.decode(payload)));
-        console.log(JSON.stringify(p, null, 2));
         if (p.iss !== "Upstash") {
             throw new SignatureError(`invalid issuer: ${p.iss}`);
         }
-        if (p.sub !== req.url) {
+        if (typeof req.url !== "undefined" && p.sub !== req.url) {
             throw new SignatureError(`invalid subject: ${p.sub}, want: ${req.url}`);
         }
         const now = Math.floor(Date.now() / 1000);
@@ -93,4 +92,4 @@ class Consumer {
         return true;
     }
 }
-exports.Consumer = Consumer;
+exports.Receiver = Receiver;

package/types/entrypoints/cloudflare.d.ts

@@ -1,5 +1,5 @@
-import * as c from "../pkg/consumer.js";
+import * as r from "../pkg/receiver.js";
 export * from "../pkg/client/client.js";
-export declare class Consumer extends c.Consumer {
-    constructor(config: Omit<c.ConsumerConfig, "crypto">);
+export declare class Receiver extends r.Receiver {
+    constructor(config: Omit<r.ReceiverConfig, "crypto">);
 }

package/types/entrypoints/nodejs.d.ts

@@ -1,5 +1,5 @@
-import * as c from "../pkg/consumer.js";
+import * as r from "../pkg/receiver.js";
 export * from "../pkg/client/client.js";
-export declare class Consumer extends c.Consumer {
-    constructor(config: Omit<c.ConsumerConfig, "crypto">);
+export declare class Receiver extends r.Receiver {
+    constructor(config: Omit<r.ReceiverConfig, "crypto">);
 }

package/types/pkg/{consumer.d.ts → receiver.d.ts}

@@ -3,7 +3,7 @@ export declare type SubtleCrypto = typeof crypto.subtle;
 /**
  * Necessary to verify the signature of a request.
  */
-export declare type ConsumerConfig = {
+export declare type ReceiverConfig = {
     /**
      * The current signing key. Get it from `https://console.upstash.com/qstash
      */
@@ -25,20 +25,22 @@ export declare type VerifyRequest = {
     body: string | Uint8Array;
     /**
      * URL of the endpoint where the request was sent to.
+     *
+     * Omit empty to disable checking the url.
      */
-    url: string;
+    url?: string;
 };
 export declare class SignatureError extends Error {
     constructor(message: string);
 }
 /**
- * Consumer offers a simlpe way to verify the signature of a request.
+ * Receiver offers a simlpe way to verify the signature of a request.
  */
-export declare class Consumer {
+export declare class Receiver {
     private readonly currentSigningKey;
     private readonly nextSigningKey;
     private readonly subtleCrypto;
-    constructor(config: ConsumerConfig);
+    constructor(config: ReceiverConfig);
     /**
      * Verify the signature of a request.
      *