@upstash/qstash 0.0.3 → 0.0.7

package/script/topics.js

@@ -1,75 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Topics = void 0;
-class Topics {
-    constructor(http) {
-        Object.defineProperty(this, "http", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.http = http;
-    }
-    /**
-     * Create a new topic with the given name.
-     */
-    async create(req) {
-        return await this.http.request({
-            method: "POST",
-            path: ["v1", "topics"],
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify({ name: req.name }),
-        });
-    }
-    /**
-     * Get a list of all topics.
-     */
-    async list() {
-        return await this.http.request({
-            method: "GET",
-            path: ["v1", "topics"],
-            headers: { "Content-Type": "application/json" },
-        });
-    }
-    /**
-     * Get a single topic by name or ID.
-     */
-    async get(req) {
-        const idOrName = req.id ?? req.name;
-        if (!idOrName) {
-            throw new Error("Either id or name must be provided");
-        }
-        return await this.http.request({
-            method: "GET",
-            path: ["v1", "topics", idOrName],
-            headers: { "Content-Type": "application/json" },
-        });
-    }
-    /**
-     * Update a topic
-     */
-    async update(req) {
-        return await this.http.request({
-            method: "PUT",
-            path: ["v1", "topics", req.id],
-            body: JSON.stringify({ name: req.name }),
-            headers: { "Content-Type": "application/json" },
-        });
-    }
-    /**
-     * Delete a topic by name or ID.
-     */
-    async delete(req) {
-        const idOrName = req.id ?? req.name;
-        if (!idOrName) {
-            throw new Error("Either id or name must be provided");
-        }
-        return await this.http.request({
-            method: "DELETE",
-            path: ["v1", "topics", idOrName],
-            headers: { "Content-Type": "application/json" },
-        });
-    }
-}
-exports.Topics = Topics;

package/script/types.js

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

package/types/client.d.ts

@@ -1,198 +0,0 @@
-import { Requester } from "./http.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
-     *
-     * @default "https://qstash.upstash.io"
-     */
-    baseUrl?: string;
-    /**
-     * The authorization token from the upstash console.
-     */
-    authorization: string;
-};
-declare type Destination = {
-    /**
-     * The url of a publicly accessible server where you want to send this message to.
-     * The url must have a valid scheme (http or https).
-     */
-    url: string;
-    topic?: never;
-} | {
-    url?: never;
-    /**
-     * Either the name or id of a topic to send this message to.
-     */
-    topic: string;
-};
-export declare type PublishRequest = Destination & {
-    /**
-     * The message to send.
-     *
-     * This can be anything, but please set the `Content-Type` header accordingly.
-     *
-     * You can leave this empty if you want to send a message with no body.
-     */
-    body?: BodyInit;
-    /**
-     * Optionally send along headers with the message.
-     * These headers will be sent to your destination.
-     *
-     * We highly recommend sending a `Content-Type` header along, as this will help your destination
-     * server to understand the content of the message.
-     */
-    headers?: HeadersInit;
-    /**
-     * Optionally delay the delivery of this message.
-     *
-     * In seconds.
-     *
-     * @default undefined
-     */
-    delay?: number;
-    /**
-     * Optionally set the absolute delay of this message.
-     * This will override the delay option.
-     * The message will not delivered until the specified time.
-     *
-     * Unix timestamp in seconds.
-     *
-     * @default undefined
-     */
-    notBefore?: number;
-    /**
-     * We will no longer try to deliver the message after this time
-     *
-     * Unix timestamp with second precicion
-     *
-     * @default undefined
-     */
-    deadline?: number;
-    /**
-     * Provide a unique id for deduplication. This id will be used to detect duplicate messages.
-     * If a duplicate message is detected, the request will be accepted but not enqueued.
-     *
-     * We store deduplication ids for 90 days. Afterwards it is possible that the message with the
-     * same deduplication id is delivered again.
-     *
-     * When scheduling a message, the deduplication happens before the schedule is created.
-     *
-     * @default undefined
-     */
-    deduplicationID?: string;
-    /**
-     * If true, the message content will get hashed and used as deduplication id.
-     * If a duplicate message is detected, the request will be accepted but not enqueued.
-     *
-     * The content based hash includes the following values:
-     *    - All headers, except Upstash-Authorization, this includes all headers you are sending.
-     *    - The entire raw request body The destination from the url path
-     *
-     * We store deduplication ids for 90 days. Afterwards it is possible that the message with the
-     * same deduplication id is delivered again.
-     *
-     * When scheduling a message, the deduplication happens before the schedule is created.
-     *
-     * @default false
-     */
-    contentBasedDeduplication?: boolean;
-    /**
-     * In case your destination server is unavaialble or returns a status code outside of the 200-299
-     * range, we will retry the request after a certain amount of time.
-     *
-     * Configure how many times you would like the delivery to be retried
-     *
-     * @default The maximum retry quota associated with your account.
-     */
-    retries?: number;
-} & ({
-    /**
-     * Optionally specify a cron expression to repeatedly send this message to the destination.
-     *
-     * @default undefined
-     */
-    cron: string;
-} | {
-    cron?: never;
-});
-export declare type PublishJsonRequest = Omit<PublishRequest, "body"> & {
-    /**
-     * The message to send.
-     * This can be anything as long as it can be serialized to JSON.
-     */
-    body: unknown;
-};
-export declare type LogsRequest = {
-    cursor?: number;
-};
-export declare type GetLogsRespone = {
-    cursor?: number;
-    logs: Log[];
-};
-export declare class Client {
-    http: Requester;
-    constructor(config: ClientConfig);
-    /**
-     * Access the topic API.
-     *
-     * Create, read, update or delete topics.
-     */
-    get topics(): Topics;
-    /**
-     * Access the endpoint API.
-     *
-     * Create, read, update or delete endpoints.
-     */
-    get endpoints(): Endpoints;
-    /**
-     * Access the message API.
-     *
-     * Read or cancel messages.
-     */
-    get messages(): Messages;
-    /**
-     * Access the schedule API.
-     *
-     * Read or delete schedules.
-     */
-    get schedules(): Schedules;
-    publish<R extends PublishRequest>(req: R): Promise<PublishResponse<R>>;
-    /**
-     * publishJSON is a utility wrapper around `publish` that automatically serializes the body
-     * and sets the `Content-Type` header to `application/json`.
-     */
-    publishJSON<R extends PublishJsonRequest = PublishJsonRequest>(req: R): Promise<PublishResponse<R>>;
-    /**
-     * Retrieve your logs.
-     *
-     * The logs endpoint is paginated and returns only 100 logs at a time.
-     * If you want to receive more logs, you can use the cursor to paginate.
-     *
-     * The cursor is a unix timestamp with millisecond precision
-     *
-     * @example
-     * ```ts
-     * let cursor = Date.now()
-     * const logs: Log[] = []
-     * while (cursor > 0) {
-     *   const res = await qstash.logs({ cursor })
-     *   logs.push(...res.logs)
-     *   cursor = res.cursor ?? 0
-     * }
-     * ```
-     */
-    logs(req?: LogsRequest): Promise<GetLogsRespone>;
-}
-declare type PublishResponse<PublishRequest> = PublishRequest extends {
-    cron: string;
-} ? {
-    scheduleID: string;
-} : {
-    messageID: string;
-};
-export {};

package/types/endpoints.d.ts

@@ -1,59 +0,0 @@
-import { Requester } from "./http.js";
-export declare type CreateEndpointRequest = {
-    /**
-     * The url of the endpoint.
-     */
-    url: string;
-    /**
-     * The name of the topic to subscribe to.
-     */
-    topicName: string;
-};
-export declare type GetEndpointRequest = {
-    id: string;
-};
-export declare type UpdateEndpointRequest = {
-    id: string;
-    url?: string;
-};
-export declare type DeleteEndpointRequest = {
-    id: string;
-};
-export declare type Endpoint = {
-    /**
-     * ID for this endpoint
-     */
-    id: string;
-    /**
-     * The url of this endpoint.
-     */
-    url: string;
-    /**
-     * The topic id this endpoint is subscribed to.
-     */
-    topicID: string;
-};
-export declare class Endpoints {
-    private readonly http;
-    constructor(http: Requester);
-    /**
-     * Create a new endpoint with the given name.
-     */
-    create(req: CreateEndpointRequest): Promise<Endpoint>;
-    /**
-     * Get a list of all endpoints.
-     */
-    list(): Promise<Endpoint[]>;
-    /**
-     * Get a single endpoint.
-     */
-    get(req: GetEndpointRequest): Promise<Endpoint>;
-    /**
-     * Update a endpoint
-     */
-    update(req: UpdateEndpointRequest): Promise<Endpoint>;
-    /**
-     * Delete a endpoint.
-     */
-    delete(req: DeleteEndpointRequest): Promise<void>;
-}

package/types/error.d.ts

@@ -1,6 +0,0 @@
-/**
- * Result of 500 Internal Server Error
- */
-export declare class QstashError extends Error {
-    constructor(message: string);
-}

package/types/http.d.ts

@@ -1,65 +0,0 @@
-export declare type UpstashRequest = {
-    /**
-     * The path to the resource.
-     */
-    path: string[];
-    /**
-     * A BodyInit object or null to set request's body.
-     */
-    body?: BodyInit | null;
-    /**
-     * A Headers object, an object literal, or an array of two-item arrays to set
-     * request's headers.
-     */
-    headers?: HeadersInit;
-    /**
-     * A boolean to set request's keepalive.
-     */
-    keepalive?: boolean;
-    /**
-     * 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;
-};
-export interface Requester {
-    request: <TResult = unknown>(req: UpstashRequest) => Promise<UpstashResponse<TResult>>;
-}
-export declare type RetryConfig = false | {
-    /**
-     * The number of retries to attempt before giving up.
-     *
-     * @default 5
-     */
-    retries?: number;
-    /**
-     * A backoff function receives the current retry cound and returns a number in milliseconds to wait before retrying.
-     *
-     * @default
-     * ```ts
-     * Math.exp(retryCount) * 50
-     * ```
-     */
-    backoff?: (retryCount: number) => number;
-};
-export declare type HttpClientConfig = {
-    baseUrl: string;
-    authorization: string;
-    retry?: RetryConfig;
-};
-export declare class HttpClient implements Requester {
-    readonly baseUrl: string;
-    readonly authorization: string;
-    readonly options?: {
-        backend?: string;
-    };
-    readonly retry: {
-        attempts: number;
-        backoff: (retryCount: number) => number;
-    };
-    constructor(config: HttpClientConfig);
-    request<TResult>(req: UpstashRequest): Promise<UpstashResponse<TResult>>;
-}

package/types/messages.d.ts

@@ -1,66 +0,0 @@
-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/platforms/nodejs.d.ts

@@ -1 +0,0 @@
-export { Client } from "../client.js";

package/types/schedules.d.ts

@@ -1,63 +0,0 @@
-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/topics.d.ts

@@ -1,64 +0,0 @@
-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/types.d.ts

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