@upstash/qstash 2.4.3 → 2.5.1-canary

package/README.md

@@ -84,7 +84,7 @@ const isValid = await r.verify({
    * The signature from the `Upstash-Signature` header.
    *
    * Please note that on some platforms (e.g. Vercel or Netlify) you might
-   * receive the header in lower case: `upstash-signature` 
+   * receive the header in lower case: `upstash-signature`
    *
    */
   signature: "string";

package/chunk-CP4IU45K.mjs

@@ -0,0 +1,59 @@
+// 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
+};

package/chunk-UUR7N6E6.js

@@ -0,0 +1,59 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { newObj[key] = obj[key]; } } } newObj.default = obj; return newObj; } } function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }// src/receiver.ts
+var _jose = require('jose'); var jose = _interopRequireWildcard(_jose);
+var _cryptojs = require('crypto-js'); var _cryptojs2 = _interopRequireDefault(_cryptojs);
+var SignatureError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "SignatureError";
+  }
+};
+var Receiver = class {
+  
+  
+  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 = _cryptojs2.default.SHA256(request.body).toString(_cryptojs2.default.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;
+  }
+};
+
+
+
+
+exports.SignatureError = SignatureError; exports.Receiver = Receiver;

package/{dist/index.d.mts → index.d.mts}

@@ -1,3 +1,5 @@
+import { BodyInit, HeadersInit } from 'undici';
+
 /**
  * Necessary to verify the signature of a request.
  */
@@ -37,7 +39,7 @@ declare class SignatureError extends Error {
     constructor(message: string);
 }
 /**
- * Receiver offers a simlpe way to verify the signature of a request.
+ * Receiver offers a simple way to verify the signature of a request.
  */
 declare class Receiver {
     private readonly currentSigningKey;
@@ -52,7 +54,7 @@ declare class Receiver {
      *
      * If that fails, the signature is invalid and a `SignatureError` is thrown.
      */
-    verify(req: VerifyRequest): Promise<boolean>;
+    verify(request: VerifyRequest): Promise<boolean>;
     /**
      * Verify signature with a specific signing key
      */
@@ -92,9 +94,9 @@ type UpstashRequest = {
 type UpstashResponse<TResult> = TResult & {
     error?: string;
 };
-interface Requester {
-    request: <TResult = unknown>(req: UpstashRequest) => Promise<UpstashResponse<TResult>>;
-}
+type Requester = {
+    request: <TResult = unknown>(request: UpstashRequest) => Promise<UpstashResponse<TResult>>;
+};
 type RetryConfig = false | {
     /**
      * The number of retries to attempt before giving up.
@@ -181,7 +183,7 @@ declare class DLQ {
     /**
      * List messages in the dlq
      */
-    listMessages(opts?: {
+    listMessages(options?: {
         cursor?: string;
     }): Promise<{
         messages: DlqMessage[];
@@ -194,13 +196,54 @@ declare class DLQ {
     /**
      * Remove multiple messages from the dlq using their `dlqId`s
      */
-    deleteMany(req: {
+    deleteMany(request: {
         dlqIds: string[];
     }): Promise<{
         deleted: number;
     }>;
 }
 
+type QueueResponse = {
+    createdAt: number;
+    updatedAt: number;
+    name: string;
+    parallelism: number;
+    lag: number;
+};
+type UpsertQueueRequest = {
+    parallelism: number;
+};
+type EnqueueRequest = PublishRequest;
+declare class Queue {
+    private readonly http;
+    private readonly queueName;
+    constructor(http: Requester, queueName?: string);
+    /**
+     * Create or update the queue
+     */
+    upsert(request: UpsertQueueRequest): Promise<void>;
+    /**
+     * Get the queue details
+     */
+    get(): Promise<QueueResponse>;
+    /**
+     * List queues
+     */
+    list(): Promise<QueueResponse[]>;
+    /**
+     * Delete the queue
+     */
+    delete(): Promise<void>;
+    /**
+     * Enqueue a message to a queue.
+     */
+    enqueue(request: EnqueueRequest): Promise<PublishResponse<PublishRequest>>;
+    /**
+     * Enqueue a message to a queue, serializing the body to JSON.
+     */
+    enqueueJSON<TBody = unknown>(request: PublishRequest<TBody>): Promise<PublishResponse<PublishRequest<TBody>>>;
+}
+
 type Schedule = {
     scheduleId: string;
     cron: string;
@@ -285,7 +328,7 @@ declare class Schedules {
     /**
      * Create a schedule
      */
-    create(req: CreateScheduleRequest): Promise<{
+    create(request: CreateScheduleRequest): Promise<{
         scheduleId: string;
     }>;
     /**
@@ -350,11 +393,11 @@ declare class Topics {
     /**
      * Create a new topic with the given name and endpoints
      */
-    addEndpoints(req: AddEndpointsRequest): Promise<void>;
+    addEndpoints(request: AddEndpointsRequest): Promise<void>;
     /**
      * Remove endpoints from a topic.
      */
-    removeEndpoints(req: RemoveEndpointsRequest): Promise<void>;
+    removeEndpoints(request: RemoveEndpointsRequest): Promise<void>;
     /**
      * Get a list of all topics.
      */
@@ -519,11 +562,26 @@ type PublishJsonRequest = Omit<PublishRequest, "body"> & {
 };
 type EventsRequest = {
     cursor?: number;
+    filter?: EventsRequestFilter;
+};
+type EventsRequestFilter = {
+    messageId?: string;
+    state?: State;
+    url?: string;
+    topicName?: string;
+    scheduleId?: string;
+    queueName?: string;
+    fromDate?: number;
+    toDate?: number;
+    count?: number;
 };
 type GetEventsResponse = {
     cursor?: number;
     events: Event[];
 };
+type QueueRequest = {
+    queueName?: string;
+};
 declare class Client {
     http: Requester;
     constructor(config: ClientConfig);
@@ -551,21 +609,26 @@ declare class Client {
      * Create, read or delete schedules.
      */
     get schedules(): Schedules;
-    private processHeaders;
-    publish<TRequest extends PublishRequest>(req: TRequest): Promise<PublishResponse<TRequest>>;
+    /**
+     * Access the queue API.
+     *
+     * Create, read, update or delete queues.
+     */
+    queue(request?: QueueRequest): Queue;
+    publish<TRequest extends PublishRequest>(request: TRequest): Promise<PublishResponse<TRequest>>;
     /**
      * publishJSON is a utility wrapper around `publish` that automatically serializes the body
      * and sets the `Content-Type` header to `application/json`.
      */
-    publishJSON<TBody = unknown, TRequest extends PublishRequest<TBody> = PublishRequest<TBody>>(req: TRequest): Promise<PublishResponse<TRequest>>;
+    publishJSON<TBody = unknown, TRequest extends PublishRequest<TBody> = PublishRequest<TBody>>(request: TRequest): Promise<PublishResponse<TRequest>>;
     /**
      * Batch publish messages to QStash.
      */
-    batch(req: PublishRequest[]): Promise<PublishResponse<PublishRequest>[]>;
+    batch(request: PublishRequest[]): Promise<PublishResponse<PublishRequest>[]>;
     /**
      * Batch publish messages to QStash, serializing each body to JSON.
      */
-    batchJSON<TBody = unknown, TRequest extends PublishRequest<TBody> = PublishRequest<TBody>>(req: TRequest[]): Promise<PublishResponse<TRequest>[]>;
+    batchJSON<TBody = unknown, TRequest extends PublishRequest<TBody> = PublishRequest<TBody>>(request: TRequest[]): Promise<PublishResponse<TRequest>[]>;
     /**
      * Retrieve your logs.
      *
@@ -585,7 +648,7 @@ declare class Client {
      * }
      * ```
      */
-    events(req?: EventsRequest): Promise<GetEventsResponse>;
+    events(request?: EventsRequest): Promise<GetEventsResponse>;
 }
 type PublishToUrlResponse = {
     messageId: string;
@@ -607,4 +670,4 @@ declare class QstashRatelimitError extends QstashError {
     constructor(args: unknown);
 }
 
-export { AddEndpointsRequest, Client, CreateScheduleRequest, Endpoint, Event, EventsRequest, GetEventsResponse, Message, Messages, PublishJsonRequest, PublishRequest, PublishResponse, PublishToTopicResponse, PublishToUrlResponse, QstashError, QstashRatelimitError, Receiver, ReceiverConfig, RemoveEndpointsRequest, Schedule, Schedules, SignatureError, State, Topic, Topics, VerifyRequest, WithCursor };
+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 };

package/{dist/index.d.ts → index.d.ts}

@@ -1,3 +1,5 @@
+import { BodyInit, HeadersInit } from 'undici';
+
 /**
  * Necessary to verify the signature of a request.
  */
@@ -37,7 +39,7 @@ declare class SignatureError extends Error {
     constructor(message: string);
 }
 /**
- * Receiver offers a simlpe way to verify the signature of a request.
+ * Receiver offers a simple way to verify the signature of a request.
  */
 declare class Receiver {
     private readonly currentSigningKey;
@@ -52,7 +54,7 @@ declare class Receiver {
      *
      * If that fails, the signature is invalid and a `SignatureError` is thrown.
      */
-    verify(req: VerifyRequest): Promise<boolean>;
+    verify(request: VerifyRequest): Promise<boolean>;
     /**
      * Verify signature with a specific signing key
      */
@@ -92,9 +94,9 @@ type UpstashRequest = {
 type UpstashResponse<TResult> = TResult & {
     error?: string;
 };
-interface Requester {
-    request: <TResult = unknown>(req: UpstashRequest) => Promise<UpstashResponse<TResult>>;
-}
+type Requester = {
+    request: <TResult = unknown>(request: UpstashRequest) => Promise<UpstashResponse<TResult>>;
+};
 type RetryConfig = false | {
     /**
      * The number of retries to attempt before giving up.
@@ -181,7 +183,7 @@ declare class DLQ {
     /**
      * List messages in the dlq
      */
-    listMessages(opts?: {
+    listMessages(options?: {
         cursor?: string;
     }): Promise<{
         messages: DlqMessage[];
@@ -194,13 +196,54 @@ declare class DLQ {
     /**
      * Remove multiple messages from the dlq using their `dlqId`s
      */
-    deleteMany(req: {
+    deleteMany(request: {
         dlqIds: string[];
     }): Promise<{
         deleted: number;
     }>;
 }
 
+type QueueResponse = {
+    createdAt: number;
+    updatedAt: number;
+    name: string;
+    parallelism: number;
+    lag: number;
+};
+type UpsertQueueRequest = {
+    parallelism: number;
+};
+type EnqueueRequest = PublishRequest;
+declare class Queue {
+    private readonly http;
+    private readonly queueName;
+    constructor(http: Requester, queueName?: string);
+    /**
+     * Create or update the queue
+     */
+    upsert(request: UpsertQueueRequest): Promise<void>;
+    /**
+     * Get the queue details
+     */
+    get(): Promise<QueueResponse>;
+    /**
+     * List queues
+     */
+    list(): Promise<QueueResponse[]>;
+    /**
+     * Delete the queue
+     */
+    delete(): Promise<void>;
+    /**
+     * Enqueue a message to a queue.
+     */
+    enqueue(request: EnqueueRequest): Promise<PublishResponse<PublishRequest>>;
+    /**
+     * Enqueue a message to a queue, serializing the body to JSON.
+     */
+    enqueueJSON<TBody = unknown>(request: PublishRequest<TBody>): Promise<PublishResponse<PublishRequest<TBody>>>;
+}
+
 type Schedule = {
     scheduleId: string;
     cron: string;
@@ -285,7 +328,7 @@ declare class Schedules {
     /**
      * Create a schedule
      */
-    create(req: CreateScheduleRequest): Promise<{
+    create(request: CreateScheduleRequest): Promise<{
         scheduleId: string;
     }>;
     /**
@@ -350,11 +393,11 @@ declare class Topics {
     /**
      * Create a new topic with the given name and endpoints
      */
-    addEndpoints(req: AddEndpointsRequest): Promise<void>;
+    addEndpoints(request: AddEndpointsRequest): Promise<void>;
     /**
      * Remove endpoints from a topic.
      */
-    removeEndpoints(req: RemoveEndpointsRequest): Promise<void>;
+    removeEndpoints(request: RemoveEndpointsRequest): Promise<void>;
     /**
      * Get a list of all topics.
      */
@@ -519,11 +562,26 @@ type PublishJsonRequest = Omit<PublishRequest, "body"> & {
 };
 type EventsRequest = {
     cursor?: number;
+    filter?: EventsRequestFilter;
+};
+type EventsRequestFilter = {
+    messageId?: string;
+    state?: State;
+    url?: string;
+    topicName?: string;
+    scheduleId?: string;
+    queueName?: string;
+    fromDate?: number;
+    toDate?: number;
+    count?: number;
 };
 type GetEventsResponse = {
     cursor?: number;
     events: Event[];
 };
+type QueueRequest = {
+    queueName?: string;
+};
 declare class Client {
     http: Requester;
     constructor(config: ClientConfig);
@@ -551,21 +609,26 @@ declare class Client {
      * Create, read or delete schedules.
      */
     get schedules(): Schedules;
-    private processHeaders;
-    publish<TRequest extends PublishRequest>(req: TRequest): Promise<PublishResponse<TRequest>>;
+    /**
+     * Access the queue API.
+     *
+     * Create, read, update or delete queues.
+     */
+    queue(request?: QueueRequest): Queue;
+    publish<TRequest extends PublishRequest>(request: TRequest): Promise<PublishResponse<TRequest>>;
     /**
      * publishJSON is a utility wrapper around `publish` that automatically serializes the body
      * and sets the `Content-Type` header to `application/json`.
      */
-    publishJSON<TBody = unknown, TRequest extends PublishRequest<TBody> = PublishRequest<TBody>>(req: TRequest): Promise<PublishResponse<TRequest>>;
+    publishJSON<TBody = unknown, TRequest extends PublishRequest<TBody> = PublishRequest<TBody>>(request: TRequest): Promise<PublishResponse<TRequest>>;
     /**
      * Batch publish messages to QStash.
      */
-    batch(req: PublishRequest[]): Promise<PublishResponse<PublishRequest>[]>;
+    batch(request: PublishRequest[]): Promise<PublishResponse<PublishRequest>[]>;
     /**
      * Batch publish messages to QStash, serializing each body to JSON.
      */
-    batchJSON<TBody = unknown, TRequest extends PublishRequest<TBody> = PublishRequest<TBody>>(req: TRequest[]): Promise<PublishResponse<TRequest>[]>;
+    batchJSON<TBody = unknown, TRequest extends PublishRequest<TBody> = PublishRequest<TBody>>(request: TRequest[]): Promise<PublishResponse<TRequest>[]>;
     /**
      * Retrieve your logs.
      *
@@ -585,7 +648,7 @@ declare class Client {
      * }
      * ```
      */
-    events(req?: EventsRequest): Promise<GetEventsResponse>;
+    events(request?: EventsRequest): Promise<GetEventsResponse>;
 }
 type PublishToUrlResponse = {
     messageId: string;
@@ -607,4 +670,4 @@ declare class QstashRatelimitError extends QstashError {
     constructor(args: unknown);
 }
 
-export { AddEndpointsRequest, Client, CreateScheduleRequest, Endpoint, Event, EventsRequest, GetEventsResponse, Message, Messages, PublishJsonRequest, PublishRequest, PublishResponse, PublishToTopicResponse, PublishToUrlResponse, QstashError, QstashRatelimitError, Receiver, ReceiverConfig, RemoveEndpointsRequest, Schedule, Schedules, SignatureError, State, Topic, Topics, VerifyRequest, WithCursor };
+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 };