mail-time 3.0.0 → 4.1.0

package/index.d.cts

@@ -0,0 +1,322 @@
+export type MailTimePresetName = import("./presets.js").MailTimePresetName;
+export type MailTimePresetConfig = import("./presets.js").MailTimePresetConfig;
+export type MailTimePingResult = {
+    status: string;
+    code: number;
+    statusCode: number;
+    paused?: boolean;
+    error?: unknown;
+};
+export type MailTimeStorageClient = {
+    [key: string]: any;
+    query?: (queryText: string, values?: unknown[]) => Promise<{
+        rows?: unknown[];
+        rowCount?: number | null;
+    }>;
+};
+export type MailTimeMongoDb = {
+    [key: string]: any;
+};
+export type MailTimeTransport = {
+    [key: string]: any;
+};
+export type MailTimeJoSkAdapterOptions = {
+    [key: string]: any;
+    type?: "mongo" | "redis" | "postgres";
+    client?: MailTimeStorageClient;
+    db?: MailTimeMongoDb;
+    prefix?: string;
+    resetOnInit?: boolean;
+    useHashTags?: boolean;
+};
+export type MailTimeJoSkOptions = {
+    [key: string]: any;
+    adapter: MailTimeJoSkAdapterOptions | object;
+    debug?: boolean;
+    autoClear?: boolean;
+    zombieTime?: number;
+    minRevolvingDelay?: number;
+    maxRevolvingDelay?: number;
+    execute?: "batch" | "one";
+    concurrency?: number;
+    lockOwnerId?: string;
+    resetOnInit?: boolean;
+    onError?: (title: string, details: object) => void;
+    onExecuted?: (uid: string, details: object) => void;
+};
+export type MailTimeTask = {
+    uuid: string;
+    to?: string | string[];
+    tries: number;
+    sendAt: number;
+    isSent: boolean;
+    isCancelled: boolean;
+    isFailed: boolean;
+    isSending?: boolean;
+    sendingAt?: number;
+    template?: string | false;
+    transport: number;
+    concatSubject?: string | false;
+    mailOptions: MailTimeMailOptions[];
+};
+export type MailTimeIterateOptions = {
+    limit?: number;
+    sendingTimeout?: number;
+};
+export type CustomQueue = {
+    ping: () => Promise<MailTimePingResult>;
+    iterate: (opts?: MailTimeIterateOptions) => Promise<void> | void;
+    getPendingTo: (to: string, sendAt: number) => Promise<MailTimeTask | object | null>;
+    push: (email: MailTimeTask) => Promise<void> | void;
+    cancel: (uuid: string) => Promise<boolean>;
+    remove: (email: MailTimeTask | object, opts?: {
+        leaseTries: number;
+        leaseSendingAt: number;
+    }) => Promise<boolean>;
+    update: (email: MailTimeTask | object, updateObj: object) => Promise<boolean>;
+    ready?: () => Promise<void>;
+};
+export type MailTimeRejectedRecipient = {
+    address: string;
+    error: string;
+};
+export type MailTimeMailOptions = {
+    [key: string]: any;
+    to: string | string[];
+    sendAt?: Date | number;
+    template?: string;
+    concatSubject?: string;
+    text?: string | false;
+    html?: string | false;
+    subject?: string;
+    accepted?: string[];
+    rejected?: MailTimeRejectedRecipient[];
+};
+export type MailTimeConcatEmailsOptions = {
+    subject?: string;
+};
+export type MailTimeOptions = {
+    queue: RedisQueue | MongoQueue | PostgresQueue | CustomQueue;
+    type?: "server" | "client";
+    from?: string | ((transport: MailTimeTransport) => string);
+    transports?: MailTimeTransport[];
+    strategy?: "backup" | "balancer";
+    failsToNext?: number;
+    retries?: number;
+    maxTries?: number;
+    retryDelay?: number;
+    interval?: number;
+    keepHistory?: boolean;
+    concatEmails?: boolean | MailTimeConcatEmailsOptions;
+    concatSubject?: string;
+    concatDelimiter?: string;
+    concatDelay?: number;
+    concatThrottling?: number;
+    revolvingInterval?: number;
+    mode?: "one" | "batch";
+    concurrency?: number;
+    sendingTimeout?: number;
+    verifyTransports?: boolean;
+    template?: string;
+    prefix?: string;
+    debug?: boolean;
+    josk?: MailTimeJoSkOptions;
+    onError?: (error: unknown, email: MailTimeTask | null, details?: object) => void;
+    onSent?: (email: MailTimeTask, details?: object) => void;
+};
+/**
+ * @typedef {import('./presets.js').MailTimePresetName} MailTimePresetName
+ */
+/**
+ * @typedef {import('./presets.js').MailTimePresetConfig} MailTimePresetConfig
+ */
+/**
+ * @typedef {{ status: string, code: number, statusCode: number, paused?: boolean, error?: unknown }} MailTimePingResult
+ */
+/**
+ * @typedef {{ [key: string]: any, query?: (queryText: string, values?: unknown[]) => Promise<{ rows?: unknown[], rowCount?: number | null }> }} MailTimeStorageClient
+ */
+/**
+ * @typedef {{ [key: string]: any }} MailTimeMongoDb
+ */
+/**
+ * @typedef {{ [key: string]: any }} MailTimeTransport
+ */
+/**
+ * @typedef {{ [key: string]: any, type?: 'mongo' | 'redis' | 'postgres', client?: MailTimeStorageClient, db?: MailTimeMongoDb, prefix?: string, resetOnInit?: boolean, useHashTags?: boolean }} MailTimeJoSkAdapterOptions
+ */
+/**
+ * @typedef {{ [key: string]: any, adapter: MailTimeJoSkAdapterOptions | object, debug?: boolean, autoClear?: boolean, zombieTime?: number, minRevolvingDelay?: number, maxRevolvingDelay?: number, execute?: 'batch' | 'one', concurrency?: number, lockOwnerId?: string, resetOnInit?: boolean, onError?: (title: string, details: object) => void, onExecuted?: (uid: string, details: object) => void }} MailTimeJoSkOptions
+ */
+/**
+ * @typedef {{ uuid: string, to?: string | string[], tries: number, sendAt: number, isSent: boolean, isCancelled: boolean, isFailed: boolean, isSending?: boolean, sendingAt?: number, template?: string | false, transport: number, concatSubject?: string | false, mailOptions: MailTimeMailOptions[] }} MailTimeTask
+ */
+/**
+ * @typedef {{ limit?: number, sendingTimeout?: number }} MailTimeIterateOptions
+ */
+/**
+ * @typedef {{ ping: () => Promise<MailTimePingResult>, iterate: (opts?: MailTimeIterateOptions) => Promise<void> | void, getPendingTo: (to: string, sendAt: number) => Promise<MailTimeTask | object | null>, push: (email: MailTimeTask) => Promise<void> | void, cancel: (uuid: string) => Promise<boolean>, remove: (email: MailTimeTask | object, opts?: { leaseTries: number, leaseSendingAt: number }) => Promise<boolean>, update: (email: MailTimeTask | object, updateObj: object) => Promise<boolean>, ready?: () => Promise<void> }} CustomQueue
+ */
+/**
+ * @typedef {{ address: string, error: string }} MailTimeRejectedRecipient
+ */
+/**
+ * @typedef {{ [key: string]: any, to: string | string[], sendAt?: Date | number, template?: string, concatSubject?: string, text?: string | false, html?: string | false, subject?: string, accepted?: string[], rejected?: MailTimeRejectedRecipient[] }} MailTimeMailOptions
+ */
+/**
+ * @typedef {{ subject?: string }} MailTimeConcatEmailsOptions
+ */
+/**
+ * @typedef {{ queue: RedisQueue | MongoQueue | PostgresQueue | CustomQueue, type?: 'server' | 'client', from?: string | ((transport: MailTimeTransport) => string), transports?: MailTimeTransport[], strategy?: 'backup' | 'balancer', failsToNext?: number, retries?: number, maxTries?: number, retryDelay?: number, interval?: number, keepHistory?: boolean, concatEmails?: boolean | MailTimeConcatEmailsOptions, concatSubject?: string, concatDelimiter?: string, concatDelay?: number, concatThrottling?: number, revolvingInterval?: number, mode?: 'one' | 'batch', concurrency?: number, sendingTimeout?: number, verifyTransports?: boolean, template?: string, prefix?: string, debug?: boolean, josk?: MailTimeJoSkOptions, onError?: (error: unknown, email: MailTimeTask | null, details?: object) => void, onSent?: (email: MailTimeTask, details?: object) => void }} MailTimeOptions
+ */
+/** Class of MailTime */
+export class MailTime {
+    static set Template(newVal: string);
+    static get Template(): string;
+    /**
+     * Create a MailTime instance
+     * @param {MailTimeOptions} opts - configuration object
+     */
+    constructor(opts: MailTimeOptions);
+    queue: MongoQueue | RedisQueue | PostgresQueue | CustomQueue;
+    debug: boolean;
+    type: "server" | "client";
+    prefix: string;
+    maxTries: number;
+    retryDelay: number;
+    template: string;
+    keepHistory: boolean;
+    onSent: (email: MailTimeTask, details?: object) => void;
+    onError: (error: unknown, email: MailTimeTask | null, details?: object) => void;
+    revolvingInterval: number;
+    mode: "one" | "batch";
+    concurrency: number;
+    sendingTimeout: number;
+    failsToNext: number;
+    strategy: "backup" | "balancer";
+    transports: MailTimeTransport[];
+    transport: number;
+    verifyTransports: boolean;
+    from: boolean | ((transport: MailTimeTransport) => string);
+    /** @type {string} */
+    concatSubject: string;
+    concatEmails: boolean;
+    concatDelimiter: string;
+    concatDelay: number;
+    josk: {
+        [key: string]: any;
+        adapter: MailTimeJoSkAdapterOptions | object;
+        debug?: boolean;
+        autoClear?: boolean;
+        zombieTime?: number;
+        minRevolvingDelay?: number;
+        maxRevolvingDelay?: number;
+        execute?: "batch" | "one";
+        concurrency?: number;
+        lockOwnerId?: string;
+        resetOnInit?: boolean;
+        onError?: (title: string, details: object) => void;
+        onExecuted?: (uid: string, details: object) => void;
+    } | undefined;
+    scheduler: JoSk | undefined;
+    /**
+     * @async
+     * @memberOf MailTime
+     * @name ping
+     * @description Check package readiness and connection to Storage
+     * @returns {Promise<MailTimePingResult>}
+     * @throws {Error}
+     */
+    ping(): Promise<MailTimePingResult>;
+    /**
+     * @async
+     * @memberOf MailTime
+     * @name ready
+     * @description Wait until queue and scheduler storage are ready
+     * @returns {Promise<MailTime>}
+     */
+    ready(): Promise<MailTime>;
+    /**
+     * @memberOf MailTime
+     * @name destroy
+     * @description Stop the scheduler and block future dispatches. Without `{ drain: true }`, any in-flight SMTP attempts are neutralized on completion — they perform no storage writes, no `onSent`/`onError` callbacks, and no logging once `destroy()` returns; their claimed rows are recovered by stale-lock timeout (`sendingTimeout`). Pass `{ drain: true }` to instead let in-flight attempts run to completion (returns a Promise that resolves once they settle).
+     * @param {{ drain?: boolean }} [opts]
+     * @returns {boolean | Promise<boolean>}
+     */
+    destroy(opts?: {
+        drain?: boolean;
+    }): boolean | Promise<boolean>;
+    /**
+     * @async
+     * @memberOf MailTime
+     * @name drain
+     * @description Wait for all in-flight email send attempts to settle
+     * @returns {Promise<void>}
+     */
+    drain(): Promise<void>;
+    /**
+     * @memberOf MailTime
+     * @name pause
+     * @description Pause this server instance from competing for the queue-drain lease. In-flight SMTP sends finish; peer server instances keep draining. Reversible (unlike `destroy()`). No-op on `client` instances or after `destroy()`. To stop scanning *and* wait for in-flight sends: `mailTime.pause(); await mailTime.drain();`.
+     * @returns {boolean} `true` if newly paused; `false` if already paused, a client instance, or destroyed
+     */
+    pause(): boolean;
+    /**
+     * @memberOf MailTime
+     * @name resume
+     * @description Resume competing for the queue-drain lease after `pause()`; triggers an immediate scan. No-op on `client` instances, after `destroy()`, or when not paused.
+     * @returns {boolean} `true` if newly resumed; `false` if not paused, a client instance, or destroyed
+     */
+    resume(): boolean;
+    /**
+     * @memberOf MailTime
+     * @name isPaused
+     * @description Whether this instance is currently paused from draining the queue. Always `false` on `client` instances.
+     * @returns {boolean}
+     */
+    get isPaused(): boolean;
+    /**
+     * @memberOf MailTime
+     * @name send
+     * @description alias of `sendMail`
+     * @param {MailTimeMailOptions} opts - email options
+     * @returns {Promise<string>} uuid of the email
+     */
+    send(opts: MailTimeMailOptions): Promise<string>;
+    /**
+     * @async
+     * @memberOf MailTime
+     * @name sendMail
+     * @description add email to the queue or append to existing letter if {concatEmails: true}
+     * @param {MailTimeMailOptions} opts - email options
+     * @returns {Promise<string>} uuid of the email
+     * @throws {Error}
+     */
+    sendMail(opts?: MailTimeMailOptions): Promise<string>;
+    /**
+     * @async
+     * @memberOf MailTime
+     * @name cancel
+     * @description alias of `cancelMail`
+     * @param {string|Promise<string>} uuid - uuid returned from `send` or `sendMail`
+     * @returns {Promise<boolean>} returns `true` if cancelled or `false` if not found was sent or was cancelled previously
+     */
+    cancel(uuid: string | Promise<string>): Promise<boolean>;
+    /**
+     * @async
+     * @memberOf MailTime
+     * @name cancelMail
+     * @description remove email from the queue or mark as `isCancelled`
+     * @param {string|Promise<string>} uuid - uuid returned from `send` or `sendMail`
+     * @returns {Promise<boolean>} returns `true` if cancelled or `false` if not found was sent or was cancelled previously
+     */
+    cancelMail(uuid: string | Promise<string>): Promise<boolean>;
+}
+import { MongoQueue } from './adapters/mongo.js';
+import { RedisQueue } from './adapters/redis.js';
+import { PostgresQueue } from './adapters/postgres.js';
+import { mailTimePreset } from './presets.js';
+import { presets } from './presets.js';
+import { presetNames } from './presets.js';
+import { JoSk } from 'josk';
+export { MongoQueue, RedisQueue, PostgresQueue, mailTimePreset, presets, presetNames };

package/index.d.ts

@@ -0,0 +1,322 @@
+export type MailTimePresetName = import("./presets.js").MailTimePresetName;
+export type MailTimePresetConfig = import("./presets.js").MailTimePresetConfig;
+export type MailTimePingResult = {
+    status: string;
+    code: number;
+    statusCode: number;
+    paused?: boolean;
+    error?: unknown;
+};
+export type MailTimeStorageClient = {
+    [key: string]: any;
+    query?: (queryText: string, values?: unknown[]) => Promise<{
+        rows?: unknown[];
+        rowCount?: number | null;
+    }>;
+};
+export type MailTimeMongoDb = {
+    [key: string]: any;
+};
+export type MailTimeTransport = {
+    [key: string]: any;
+};
+export type MailTimeJoSkAdapterOptions = {
+    [key: string]: any;
+    type?: "mongo" | "redis" | "postgres";
+    client?: MailTimeStorageClient;
+    db?: MailTimeMongoDb;
+    prefix?: string;
+    resetOnInit?: boolean;
+    useHashTags?: boolean;
+};
+export type MailTimeJoSkOptions = {
+    [key: string]: any;
+    adapter: MailTimeJoSkAdapterOptions | object;
+    debug?: boolean;
+    autoClear?: boolean;
+    zombieTime?: number;
+    minRevolvingDelay?: number;
+    maxRevolvingDelay?: number;
+    execute?: "batch" | "one";
+    concurrency?: number;
+    lockOwnerId?: string;
+    resetOnInit?: boolean;
+    onError?: (title: string, details: object) => void;
+    onExecuted?: (uid: string, details: object) => void;
+};
+export type MailTimeTask = {
+    uuid: string;
+    to?: string | string[];
+    tries: number;
+    sendAt: number;
+    isSent: boolean;
+    isCancelled: boolean;
+    isFailed: boolean;
+    isSending?: boolean;
+    sendingAt?: number;
+    template?: string | false;
+    transport: number;
+    concatSubject?: string | false;
+    mailOptions: MailTimeMailOptions[];
+};
+export type MailTimeIterateOptions = {
+    limit?: number;
+    sendingTimeout?: number;
+};
+export type CustomQueue = {
+    ping: () => Promise<MailTimePingResult>;
+    iterate: (opts?: MailTimeIterateOptions) => Promise<void> | void;
+    getPendingTo: (to: string, sendAt: number) => Promise<MailTimeTask | object | null>;
+    push: (email: MailTimeTask) => Promise<void> | void;
+    cancel: (uuid: string) => Promise<boolean>;
+    remove: (email: MailTimeTask | object, opts?: {
+        leaseTries: number;
+        leaseSendingAt: number;
+    }) => Promise<boolean>;
+    update: (email: MailTimeTask | object, updateObj: object) => Promise<boolean>;
+    ready?: () => Promise<void>;
+};
+export type MailTimeRejectedRecipient = {
+    address: string;
+    error: string;
+};
+export type MailTimeMailOptions = {
+    [key: string]: any;
+    to: string | string[];
+    sendAt?: Date | number;
+    template?: string;
+    concatSubject?: string;
+    text?: string | false;
+    html?: string | false;
+    subject?: string;
+    accepted?: string[];
+    rejected?: MailTimeRejectedRecipient[];
+};
+export type MailTimeConcatEmailsOptions = {
+    subject?: string;
+};
+export type MailTimeOptions = {
+    queue: RedisQueue | MongoQueue | PostgresQueue | CustomQueue;
+    type?: "server" | "client";
+    from?: string | ((transport: MailTimeTransport) => string);
+    transports?: MailTimeTransport[];
+    strategy?: "backup" | "balancer";
+    failsToNext?: number;
+    retries?: number;
+    maxTries?: number;
+    retryDelay?: number;
+    interval?: number;
+    keepHistory?: boolean;
+    concatEmails?: boolean | MailTimeConcatEmailsOptions;
+    concatSubject?: string;
+    concatDelimiter?: string;
+    concatDelay?: number;
+    concatThrottling?: number;
+    revolvingInterval?: number;
+    mode?: "one" | "batch";
+    concurrency?: number;
+    sendingTimeout?: number;
+    verifyTransports?: boolean;
+    template?: string;
+    prefix?: string;
+    debug?: boolean;
+    josk?: MailTimeJoSkOptions;
+    onError?: (error: unknown, email: MailTimeTask | null, details?: object) => void;
+    onSent?: (email: MailTimeTask, details?: object) => void;
+};
+/**
+ * @typedef {import('./presets.js').MailTimePresetName} MailTimePresetName
+ */
+/**
+ * @typedef {import('./presets.js').MailTimePresetConfig} MailTimePresetConfig
+ */
+/**
+ * @typedef {{ status: string, code: number, statusCode: number, paused?: boolean, error?: unknown }} MailTimePingResult
+ */
+/**
+ * @typedef {{ [key: string]: any, query?: (queryText: string, values?: unknown[]) => Promise<{ rows?: unknown[], rowCount?: number | null }> }} MailTimeStorageClient
+ */
+/**
+ * @typedef {{ [key: string]: any }} MailTimeMongoDb
+ */
+/**
+ * @typedef {{ [key: string]: any }} MailTimeTransport
+ */
+/**
+ * @typedef {{ [key: string]: any, type?: 'mongo' | 'redis' | 'postgres', client?: MailTimeStorageClient, db?: MailTimeMongoDb, prefix?: string, resetOnInit?: boolean, useHashTags?: boolean }} MailTimeJoSkAdapterOptions
+ */
+/**
+ * @typedef {{ [key: string]: any, adapter: MailTimeJoSkAdapterOptions | object, debug?: boolean, autoClear?: boolean, zombieTime?: number, minRevolvingDelay?: number, maxRevolvingDelay?: number, execute?: 'batch' | 'one', concurrency?: number, lockOwnerId?: string, resetOnInit?: boolean, onError?: (title: string, details: object) => void, onExecuted?: (uid: string, details: object) => void }} MailTimeJoSkOptions
+ */
+/**
+ * @typedef {{ uuid: string, to?: string | string[], tries: number, sendAt: number, isSent: boolean, isCancelled: boolean, isFailed: boolean, isSending?: boolean, sendingAt?: number, template?: string | false, transport: number, concatSubject?: string | false, mailOptions: MailTimeMailOptions[] }} MailTimeTask
+ */
+/**
+ * @typedef {{ limit?: number, sendingTimeout?: number }} MailTimeIterateOptions
+ */
+/**
+ * @typedef {{ ping: () => Promise<MailTimePingResult>, iterate: (opts?: MailTimeIterateOptions) => Promise<void> | void, getPendingTo: (to: string, sendAt: number) => Promise<MailTimeTask | object | null>, push: (email: MailTimeTask) => Promise<void> | void, cancel: (uuid: string) => Promise<boolean>, remove: (email: MailTimeTask | object, opts?: { leaseTries: number, leaseSendingAt: number }) => Promise<boolean>, update: (email: MailTimeTask | object, updateObj: object) => Promise<boolean>, ready?: () => Promise<void> }} CustomQueue
+ */
+/**
+ * @typedef {{ address: string, error: string }} MailTimeRejectedRecipient
+ */
+/**
+ * @typedef {{ [key: string]: any, to: string | string[], sendAt?: Date | number, template?: string, concatSubject?: string, text?: string | false, html?: string | false, subject?: string, accepted?: string[], rejected?: MailTimeRejectedRecipient[] }} MailTimeMailOptions
+ */
+/**
+ * @typedef {{ subject?: string }} MailTimeConcatEmailsOptions
+ */
+/**
+ * @typedef {{ queue: RedisQueue | MongoQueue | PostgresQueue | CustomQueue, type?: 'server' | 'client', from?: string | ((transport: MailTimeTransport) => string), transports?: MailTimeTransport[], strategy?: 'backup' | 'balancer', failsToNext?: number, retries?: number, maxTries?: number, retryDelay?: number, interval?: number, keepHistory?: boolean, concatEmails?: boolean | MailTimeConcatEmailsOptions, concatSubject?: string, concatDelimiter?: string, concatDelay?: number, concatThrottling?: number, revolvingInterval?: number, mode?: 'one' | 'batch', concurrency?: number, sendingTimeout?: number, verifyTransports?: boolean, template?: string, prefix?: string, debug?: boolean, josk?: MailTimeJoSkOptions, onError?: (error: unknown, email: MailTimeTask | null, details?: object) => void, onSent?: (email: MailTimeTask, details?: object) => void }} MailTimeOptions
+ */
+/** Class of MailTime */
+export class MailTime {
+    static set Template(newVal: string);
+    static get Template(): string;
+    /**
+     * Create a MailTime instance
+     * @param {MailTimeOptions} opts - configuration object
+     */
+    constructor(opts: MailTimeOptions);
+    queue: MongoQueue | RedisQueue | PostgresQueue | CustomQueue;
+    debug: boolean;
+    type: "server" | "client";
+    prefix: string;
+    maxTries: number;
+    retryDelay: number;
+    template: string;
+    keepHistory: boolean;
+    onSent: (email: MailTimeTask, details?: object) => void;
+    onError: (error: unknown, email: MailTimeTask | null, details?: object) => void;
+    revolvingInterval: number;
+    mode: "one" | "batch";
+    concurrency: number;
+    sendingTimeout: number;
+    failsToNext: number;
+    strategy: "backup" | "balancer";
+    transports: MailTimeTransport[];
+    transport: number;
+    verifyTransports: boolean;
+    from: boolean | ((transport: MailTimeTransport) => string);
+    /** @type {string} */
+    concatSubject: string;
+    concatEmails: boolean;
+    concatDelimiter: string;
+    concatDelay: number;
+    josk: {
+        [key: string]: any;
+        adapter: MailTimeJoSkAdapterOptions | object;
+        debug?: boolean;
+        autoClear?: boolean;
+        zombieTime?: number;
+        minRevolvingDelay?: number;
+        maxRevolvingDelay?: number;
+        execute?: "batch" | "one";
+        concurrency?: number;
+        lockOwnerId?: string;
+        resetOnInit?: boolean;
+        onError?: (title: string, details: object) => void;
+        onExecuted?: (uid: string, details: object) => void;
+    } | undefined;
+    scheduler: JoSk | undefined;
+    /**
+     * @async
+     * @memberOf MailTime
+     * @name ping
+     * @description Check package readiness and connection to Storage
+     * @returns {Promise<MailTimePingResult>}
+     * @throws {Error}
+     */
+    ping(): Promise<MailTimePingResult>;
+    /**
+     * @async
+     * @memberOf MailTime
+     * @name ready
+     * @description Wait until queue and scheduler storage are ready
+     * @returns {Promise<MailTime>}
+     */
+    ready(): Promise<MailTime>;
+    /**
+     * @memberOf MailTime
+     * @name destroy
+     * @description Stop the scheduler and block future dispatches. Without `{ drain: true }`, any in-flight SMTP attempts are neutralized on completion — they perform no storage writes, no `onSent`/`onError` callbacks, and no logging once `destroy()` returns; their claimed rows are recovered by stale-lock timeout (`sendingTimeout`). Pass `{ drain: true }` to instead let in-flight attempts run to completion (returns a Promise that resolves once they settle).
+     * @param {{ drain?: boolean }} [opts]
+     * @returns {boolean | Promise<boolean>}
+     */
+    destroy(opts?: {
+        drain?: boolean;
+    }): boolean | Promise<boolean>;
+    /**
+     * @async
+     * @memberOf MailTime
+     * @name drain
+     * @description Wait for all in-flight email send attempts to settle
+     * @returns {Promise<void>}
+     */
+    drain(): Promise<void>;
+    /**
+     * @memberOf MailTime
+     * @name pause
+     * @description Pause this server instance from competing for the queue-drain lease. In-flight SMTP sends finish; peer server instances keep draining. Reversible (unlike `destroy()`). No-op on `client` instances or after `destroy()`. To stop scanning *and* wait for in-flight sends: `mailTime.pause(); await mailTime.drain();`.
+     * @returns {boolean} `true` if newly paused; `false` if already paused, a client instance, or destroyed
+     */
+    pause(): boolean;
+    /**
+     * @memberOf MailTime
+     * @name resume
+     * @description Resume competing for the queue-drain lease after `pause()`; triggers an immediate scan. No-op on `client` instances, after `destroy()`, or when not paused.
+     * @returns {boolean} `true` if newly resumed; `false` if not paused, a client instance, or destroyed
+     */
+    resume(): boolean;
+    /**
+     * @memberOf MailTime
+     * @name isPaused
+     * @description Whether this instance is currently paused from draining the queue. Always `false` on `client` instances.
+     * @returns {boolean}
+     */
+    get isPaused(): boolean;
+    /**
+     * @memberOf MailTime
+     * @name send
+     * @description alias of `sendMail`
+     * @param {MailTimeMailOptions} opts - email options
+     * @returns {Promise<string>} uuid of the email
+     */
+    send(opts: MailTimeMailOptions): Promise<string>;
+    /**
+     * @async
+     * @memberOf MailTime
+     * @name sendMail
+     * @description add email to the queue or append to existing letter if {concatEmails: true}
+     * @param {MailTimeMailOptions} opts - email options
+     * @returns {Promise<string>} uuid of the email
+     * @throws {Error}
+     */
+    sendMail(opts?: MailTimeMailOptions): Promise<string>;
+    /**
+     * @async
+     * @memberOf MailTime
+     * @name cancel
+     * @description alias of `cancelMail`
+     * @param {string|Promise<string>} uuid - uuid returned from `send` or `sendMail`
+     * @returns {Promise<boolean>} returns `true` if cancelled or `false` if not found was sent or was cancelled previously
+     */
+    cancel(uuid: string | Promise<string>): Promise<boolean>;
+    /**
+     * @async
+     * @memberOf MailTime
+     * @name cancelMail
+     * @description remove email from the queue or mark as `isCancelled`
+     * @param {string|Promise<string>} uuid - uuid returned from `send` or `sendMail`
+     * @returns {Promise<boolean>} returns `true` if cancelled or `false` if not found was sent or was cancelled previously
+     */
+    cancelMail(uuid: string | Promise<string>): Promise<boolean>;
+}
+import { MongoQueue } from './adapters/mongo.js';
+import { RedisQueue } from './adapters/redis.js';
+import { PostgresQueue } from './adapters/postgres.js';
+import { mailTimePreset } from './presets.js';
+import { presets } from './presets.js';
+import { presetNames } from './presets.js';
+import { JoSk } from 'josk';
+export { MongoQueue, RedisQueue, PostgresQueue, mailTimePreset, presets, presetNames };