@upstash/qstash 0.0.11 → 0.0.14

package/types/pkg/client/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 = {
+    scheduled: string;
+    cron: string;
+    createdAt: number;
+    content: {
+        header: Record<string, string[]>;
+        body: string;
+    };
+    destination: {
+        type: "topic";
+        topicId: string;
+        url?: never;
+    } | {
+        type: "url";
+        topicd?: 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/pkg/client/topics.d.ts

@@ -0,0 +1,64 @@
+import { Requester } from "./http.js";
+export declare type CreateTopicRequest = {
+    /**
+     * The name of the topic.
+     * Must be unique and only contain alphanumeric, hyphen, underscore and periods.
+     */
+    name: string;
+};
+export declare type GetTopicRequest = {
+    name: string;
+    id?: never;
+} | {
+    id: string;
+    name?: never;
+};
+export declare type UpdateTopicRequest = {
+    id: string;
+    name?: string;
+};
+export declare type DeleteTopicRequest = {
+    name: string;
+    id?: never;
+} | {
+    id: string;
+    name?: never;
+};
+export declare type Topic = {
+    /**
+     * id for this topic
+     */
+    id: string;
+    /**
+     * The name of this topic.
+     */
+    name: string;
+    /**
+     * A list of all subscribed endpoints
+     */
+    endpointIds: string[];
+};
+export declare class Topics {
+    private readonly http;
+    constructor(http: Requester);
+    /**
+     * Create a new topic with the given name.
+     */
+    create(req: CreateTopicRequest): Promise<Topic>;
+    /**
+     * Get a list of all topics.
+     */
+    list(): Promise<Topic[]>;
+    /**
+     * Get a single topic by name or id.
+     */
+    get(req: GetTopicRequest): Promise<Topic>;
+    /**
+     * Update a topic
+     */
+    update(req: UpdateTopicRequest): Promise<Topic>;
+    /**
+     * Delete a topic by name or id.
+     */
+    delete(req: DeleteTopicRequest): Promise<void>;
+}

package/types/pkg/client/types.d.ts

@@ -0,0 +1,20 @@
+export declare type State = "created" | "planned" | "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/types/{consumer.d.ts → pkg/consumer.d.ts}

@@ -1,6 +1,18 @@
+import { crypto } from "../deps/deno.land/std@0.147.0/crypto/mod.js";
+export declare type SubtleCrypto = typeof crypto.subtle;
+/**
+ * Necessary to verify the signature of a request.
+ */
 export declare type ConsumerConfig = {
+    /**
+     * The current signing key. Get it from `https://console.upstash.com/qstash
+     */
     currentSigningKey: string;
+    /**
+     * The next signing key. Get it from `https://console.upstash.com/qstash
+     */
     nextSigningKey: string;
+    subtleCrypto: SubtleCrypto;
 };
 export declare type VerifyRequest = {
     /**
@@ -10,7 +22,7 @@ export declare type VerifyRequest = {
     /**
      * The raw request body.
      */
-    body: string;
+    body: string | Uint8Array;
     /**
      * URL of the endpoint where the request was sent to.
      */
@@ -25,6 +37,7 @@ export declare class SignatureError extends Error {
 export declare class Consumer {
     private readonly currentSigningKey;
     private readonly nextSigningKey;
+    private readonly subtleCrypto;
     constructor(config: ConsumerConfig);
     /**
      * Verify the signature of a request.