@upstash/qstash 2.6.3 → 2.6.4-workflow-alpha.1

package/README.md

@@ -55,11 +55,11 @@ import { Client } from "@upstash/qstash";
  */
 import "isomorphic-fetch";
 
-const client = new Client({
+const c = new Client({
   token: "<QSTASH_TOKEN>",
 });
 
-const res = await client.publishJSON({
+const res = await c.publishJSON({
   url: "https://my-api...",
   // or urlGroup: "the name or id of a url group"
   body: {
@@ -107,7 +107,7 @@ No need for complicated setup your LLM request. We'll call LLM and schedule it f
 ```ts
 import { Client, openai } from "@upstash/qstash";
 
-const client = new Client({
+const c = new Client({
   token: "<QSTASH_TOKEN>",
 });
 
@@ -131,11 +131,7 @@ const result = await client.publishJSON({
 You can easily start streaming Upstash or OpenAI responses from your favorite framework(Next.js) or library
 
 ```ts
-import { Client, upstash } from "@upstash/qstash";
-
-const client = new Client({
-  token: "<QSTASH_TOKEN>",
-});
+import { upstash } from "@upstash/qstash";
 
 const response = await client.chat().create({
   provider: upstash(), // Optionally, provider: "custom({token: "XXX", baseUrl: "https://api.openai.com"})". This will allow you to call every OpenAI compatible API out there.
@@ -155,43 +151,6 @@ const response = await client.chat().create({
 });
 ```
 
-### Add Observability via Helicone
-
-Helicone is a powerful observability platform that provides valuable insights into your LLM usage. Integrating Helicone with QStash is straightforward.
-
-To enable Helicone observability in QStash, you simply need to pass your Helicone API key when initializing your model. Here's how to do it for both custom models and OpenAI:
-
-#### For Custom Models (e.g., Meta-Llama)
-
-```ts
-import { Client, custom } from "@upstash/qstash";
-
-const client = new Client({
-  token: "<QSTASH_TOKEN>",
-});
-
-await client.publishJSON({
-  api: {
-    name: "llm",
-    provider: custom({
-      token: "XXX",
-      baseUrl: "https://api.together.xyz",
-    }),
-    analytics: { name: "helicone", token: process.env.HELICONE_API_KEY! },
-  },
-  body: {
-    model: "meta-llama/Llama-3-8b-chat-hf",
-    messages: [
-      {
-        role: "user",
-        content: "hello",
-      },
-    ],
-  },
-  callback: "https://oz.requestcatcher.com/",
-});
-```
-
 ## Docs
 
 See [the documentation](https://docs.upstash.com/qstash) for details.
@@ -199,7 +158,3 @@ See [the documentation](https://docs.upstash.com/qstash) for details.
 ## Contributing
 
 ### [Install Deno](https://deno.land/#installation)
-
-```
-
-```

package/package.json

@@ -1 +1 @@
-{"version":"v2.6.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":{"types":"./nextjs.d.ts","import":"./nextjs.mjs","require":"./nextjs.js"},"./dist/nextjs":{"types":"./nextjs.d.ts","import":"./nextjs.mjs","require":"./nextjs.js"},"./nuxt":{"types":"./nuxt.d.ts","import":"./nuxt.mjs","require":"./nuxt.js"},"./svelte":{"types":"./svelte.d.ts","import":"./svelte.mjs","require":"./svelte.js"},"./solidjs":{"types":"./solidjs.d.ts","import":"./solidjs.mjs","require":"./solidjs.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","ai":"^3.1.28","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":{"@solidjs/start":"^1.0.6","@sveltejs/kit":"^2.5.18","crypto-js":">=4.2.0","h3":"^1.12.0","jose":"^ 5.2.3"}}
+{"version":"2.6.4-workflow-alpha.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":["dist"],"exports":{".":{"import":"./index.mjs","require":"./index.js"},"./nextjs":{"types":"./nextjs.d.ts","import":"./nextjs.mjs","require":"./nextjs.js"},"./dist/nextjs":{"types":"./nextjs.d.ts","import":"./nextjs.mjs","require":"./nextjs.js"},"./nuxt":{"types":"./nuxt.d.ts","import":"./nuxt.mjs","require":"./nuxt.js"},"./svelte":{"types":"./svelte.d.ts","import":"./svelte.mjs","require":"./svelte.js"},"./solidjs":{"types":"./solidjs.d.ts","import":"./solidjs.mjs","require":"./solidjs.js"},"./workflow":{"types":"./workflow.d.ts","import":"./workflow.mjs","require":"./workflow.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","ai":"^3.1.28","bun-types":"^1.1.7","eslint":"^8","eslint-plugin-unicorn":"^51.0.1","husky":"^9.0.10","neverthrow":"^7.0.0","next":"^14.0.2","prettier":"^3.2.5","tsup":"latest","typescript":"^5.4.5","undici-types":"^6.16.0","vitest":"latest"},"dependencies":{"@solidjs/start":"^1.0.6","@sveltejs/kit":"^2.5.18","crypto-js":">=4.2.0","h3":"^1.12.0","jose":"^ 5.2.3"}}

package/chunk-CP4IU45K.mjs

@@ -1,59 +0,0 @@
-// src/receiver.ts
-import * as jose from "jose";
-import crypto from "crypto-js";
-var SignatureError = class extends Error {
-  constructor(message) {
-    super(message);
-    this.name = "SignatureError";
-  }
-};
-var Receiver = class {
-  currentSigningKey;
-  nextSigningKey;
-  constructor(config) {
-    this.currentSigningKey = config.currentSigningKey;
-    this.nextSigningKey = config.nextSigningKey;
-  }
-  /**
-   * Verify the signature of a request.
-   *
-   * Tries to verify the signature with the current signing key.
-   * If that fails, maybe because you have rotated the keys recently, it will
-   * try to verify the signature with the next signing key.
-   *
-   * If that fails, the signature is invalid and a `SignatureError` is thrown.
-   */
-  async verify(request) {
-    const isValid = await this.verifyWithKey(this.currentSigningKey, request);
-    if (isValid) {
-      return true;
-    }
-    return this.verifyWithKey(this.nextSigningKey, request);
-  }
-  /**
-   * Verify signature with a specific signing key
-   */
-  async verifyWithKey(key, request) {
-    const jwt = await jose.jwtVerify(request.signature, new TextEncoder().encode(key), {
-      issuer: "Upstash",
-      clockTolerance: request.clockTolerance
-    }).catch((error) => {
-      throw new SignatureError(error.message);
-    });
-    const p = jwt.payload;
-    if (request.url !== void 0 && p.sub !== request.url) {
-      throw new SignatureError(`invalid subject: ${p.sub}, want: ${request.url}`);
-    }
-    const bodyHash = crypto.SHA256(request.body).toString(crypto.enc.Base64url);
-    const padding = new RegExp(/=+$/);
-    if (p.body.replace(padding, "") !== bodyHash.replace(padding, "")) {
-      throw new SignatureError(`body hash does not match, want: ${p.body}, got: ${bodyHash}`);
-    }
-    return true;
-  }
-};
-
-export {
-  SignatureError,
-  Receiver
-};