@gravito/signal 1.0.0-alpha.2

package/dist/index.d.ts

@@ -0,0 +1,278 @@
+import { Queueable } from '@gravito/stream';
+export { Queueable } from '@gravito/stream';
+import { GravitoOrbit, PlanetCore } from 'gravito-core';
+
+interface Transport {
+    /**
+     * Send the given message
+     */
+    send(message: Message): Promise<void>;
+}
+
+interface Address {
+    name?: string;
+    address: string;
+}
+interface Attachment {
+    filename: string;
+    content: string | Buffer;
+    contentType?: string;
+    cid?: string;
+    encoding?: string;
+}
+interface Envelope {
+    from?: Address | undefined;
+    to?: Address[] | undefined;
+    cc?: Address[] | undefined;
+    bcc?: Address[] | undefined;
+    replyTo?: Address | undefined;
+    subject?: string | undefined;
+    priority?: 'high' | 'normal' | 'low' | undefined;
+    attachments?: Attachment[] | undefined;
+}
+interface Message extends Envelope {
+    from: Address;
+    to: Address[];
+    subject: string;
+    html: string;
+    text?: string;
+    headers?: Record<string, string>;
+}
+interface MailConfig {
+    /**
+     * Default sender address
+     */
+    from?: Address;
+    /**
+     * The transport mechanism used to send emails
+     */
+    transport?: Transport;
+    /**
+     * Enable development mode (intercepts emails)
+     */
+    devMode?: boolean | undefined;
+    /**
+     * Directory where email templates are located (for OrbitPrism)
+     * Default: src/emails
+     */
+    viewsDir?: string | undefined;
+    /**
+     * URL prefix for Dev UI
+     * Default: /__mail
+     */
+    devUiPrefix?: string | undefined;
+    /**
+     * Translation function for i18n support
+     */
+    translator?: ((key: string, replace?: Record<string, unknown>, locale?: string) => string) | undefined;
+}
+
+interface MailboxEntry {
+    id: string;
+    envelope: Envelope;
+    html: string;
+    text?: string;
+    sentAt: Date;
+}
+declare class DevMailbox {
+    private entries;
+    private maxEntries;
+    add(message: Message): MailboxEntry;
+    list(): MailboxEntry[];
+    get(id: string): MailboxEntry | undefined;
+    delete(id: string): boolean;
+    clear(): void;
+}
+
+interface RenderResult {
+    html: string;
+    text?: string;
+}
+interface Renderer {
+    /**
+     * Render the content into HTML and optionally plain text
+     */
+    render(data: Record<string, unknown>): Promise<RenderResult>;
+}
+
+type ComponentType = any;
+declare abstract class Mailable implements Queueable {
+    protected envelope: Partial<Envelope>;
+    protected renderer?: Renderer;
+    private rendererResolver?;
+    protected renderData: Record<string, unknown>;
+    from(address: string | Address): this;
+    to(address: string | Address | (string | Address)[]): this;
+    cc(address: string | Address | (string | Address)[]): this;
+    bcc(address: string | Address | (string | Address)[]): this;
+    replyTo(address: string | Address): this;
+    subject(subject: string): this;
+    priority(level: 'high' | 'normal' | 'low'): this;
+    attach(attachment: Attachment): this;
+    /**
+     * Set the content using raw HTML string.
+     */
+    html(content: string): this;
+    /**
+     * Set the content using an OrbitPrism template.
+     * @param template Template name (relative to viewsDir/emails)
+     * @param data Data to pass to the template
+     */
+    view(template: string, data?: Record<string, unknown>): this;
+    /**
+     * Set the content using a React component.
+     * Dynamically imports ReactRenderer to avoid hard dependency errors if React is not installed.
+     */
+    react<P extends object>(component: ComponentType, props?: P): this;
+    /**
+     * Set the content using a Vue component.
+     * Dynamically imports VueRenderer to avoid hard dependency errors if Vue is not installed.
+     */
+    vue<P extends object>(component: ComponentType, props?: P): this;
+    /**
+     * Setup the mailable. This is where you call from(), to(), view(), etc.
+     */
+    abstract build(): this;
+    queueName?: string;
+    connectionName?: string;
+    delaySeconds?: number;
+    onQueue(queue: string): this;
+    onConnection(connection: string): this;
+    delay(seconds: number): this;
+    /**
+     * Queue the mailable for sending.
+     */
+    queue(): Promise<void>;
+    protected currentLocale?: string;
+    protected translator?: (key: string, replace?: Record<string, unknown>, locale?: string) => string;
+    /**
+     * Set the locale for the message.
+     */
+    locale(locale: string): this;
+    /**
+     * Internal: Set the translator function (called by OrbitSignal)
+     */
+    setTranslator(translator: (key: string, replace?: Record<string, unknown>, locale?: string) => string): void;
+    /**
+     * Translate a string using the configured translator.
+     */
+    t(key: string, replace?: Record<string, unknown>): string;
+    /**
+     * Compile the envelope based on config defaults and mailable settings.
+     */
+    buildEnvelope(configPromise: MailConfig | Promise<MailConfig>): Promise<Envelope>;
+    /**
+     * execute the renderer
+     */
+    renderContent(): Promise<{
+        html: string;
+        text?: string;
+    }>;
+    private normalizeAddressArray;
+}
+
+declare class OrbitSignal implements GravitoOrbit {
+    private static instance?;
+    private config;
+    private devMailbox?;
+    constructor(config?: MailConfig);
+    /**
+     * Get the singleton instance of OrbitSignal
+     */
+    static getInstance(): OrbitSignal;
+    /**
+     * Configure the OrbitSignal instance
+     */
+    static configure(config: MailConfig): OrbitSignal;
+    /**
+     * Install the orbit into PlanetCore
+     */
+    install(core: PlanetCore): void;
+    /**
+     * Send a mailable instance
+     */
+    send(mailable: Mailable): Promise<void>;
+    /**
+     * Queue a mailable instance
+     *
+     * Push a mailable into the queue for execution.
+     * Requires OrbitStream to be installed and available in the context.
+     */
+    queue(mailable: Mailable): Promise<void>;
+}
+declare module 'hono' {
+    interface ContextVariableMap {
+        mail: {
+            send: (mailable: Mailable) => Promise<void>;
+            queue: (mailable: Mailable) => Promise<void>;
+        };
+    }
+}
+declare module 'gravito-core' {
+    interface GravitoVariables {
+        /** Mail service for sending emails */
+        mail?: {
+            send: (mailable: Mailable) => Promise<void>;
+            queue: (mailable: Mailable) => Promise<void>;
+        };
+    }
+}
+
+declare class HtmlRenderer implements Renderer {
+    private content;
+    constructor(content: string);
+    render(): Promise<RenderResult>;
+    private stripHtml;
+}
+
+declare class TemplateRenderer implements Renderer {
+    private engine;
+    private template;
+    constructor(templateName: string, viewsDir?: string);
+    render(data: Record<string, unknown>): Promise<RenderResult>;
+    private stripHtml;
+}
+
+declare class LogTransport implements Transport {
+    send(message: Message): Promise<void>;
+}
+
+declare class MemoryTransport implements Transport {
+    private mailbox;
+    constructor(mailbox: DevMailbox);
+    send(message: Message): Promise<void>;
+}
+
+interface SesConfig {
+    region: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+}
+declare class SesTransport implements Transport {
+    private transporter;
+    constructor(config: SesConfig);
+    send(message: Message): Promise<void>;
+    private formatAddress;
+}
+
+interface SmtpConfig {
+    host: string;
+    port: number;
+    secure?: boolean;
+    auth?: {
+        user: string;
+        pass: string;
+    };
+    tls?: {
+        rejectUnauthorized?: boolean;
+        ciphers?: string;
+    };
+}
+declare class SmtpTransport implements Transport {
+    private transporter;
+    constructor(config: SmtpConfig);
+    send(message: Message): Promise<void>;
+    private formatAddress;
+}
+
+export { type Address, type Attachment, DevMailbox, type Envelope, HtmlRenderer, LogTransport, type MailConfig, Mailable, type MailboxEntry, MemoryTransport, type Message, OrbitSignal, type RenderResult, type Renderer, SesTransport, SmtpTransport, TemplateRenderer, type Transport };