@visulima/email 1.0.0-alpha.9 → 1.0.1

package/dist/crypto/dkim-signer.d.ts

@@ -1,48 +0,0 @@
-import type { EmailOptions } from "../types.d.ts";
-import type { DkimOptions, EmailSigner } from "./types.d.ts";
-/**
- * DKIM signer implementation
- */
-export declare class DkimSigner implements EmailSigner {
-    /**
-     * Sanitizes a display name for use in quoted email headers per RFC 5322.
-     * Removes/replaces CR, LF, tabs with space, escapes backslashes and quotes,
-     * and strips non-printable control characters.
-     * @param name The display name to sanitize.
-     * @returns The sanitized display name, or empty string if nothing remains.
-     */
-    private static sanitizeDisplayName;
-    /**
-     * Formats an email address for use in email headers.
-     * @param address The email address object to format.
-     * @param address.email The email address string.
-     * @param address.name Optional display name for the email address.
-     * @returns The formatted email address string in RFC 5322 format.
-     */
-    private static formatAddress;
-    /**
-     * Formats email addresses for headers.
-     * @param addresses The email address(es) to format (single or array).
-     * @returns The formatted email addresses string (comma-separated if multiple).
-     */
-    private static formatAddresses;
-    private readonly options;
-    /**
-     * Creates a new DKIM signer.
-     * @param options DKIM signing options.
-     */
-    constructor(options: DkimOptions);
-    /**
-     * Signs an email message with DKIM.
-     * @param email The email options to sign.
-     * @returns The email options with DKIM signature header added.
-     * @throws {Error} When signing fails (e.g., invalid private key).
-     */
-    sign(email: EmailOptions): Promise<EmailOptions>;
-}
-/**
- * Creates a DKIM signer instance.
- * @param options DKIM signing options.
- * @returns A new DkimSigner instance.
- */
-export declare const createDkimSigner: (options: DkimOptions) => DkimSigner;

package/dist/crypto/smime-encrypter.d.ts

@@ -1,53 +0,0 @@
-import type { EmailOptions } from "../types.d.ts";
-import type { EmailEncrypter, SmimeEncryptOptions } from "./types.d.ts";
-/**
- * S/MIME encrypter implementation using PKIjs
- * Note: Requires pkijs and asn1js for S/MIME operations
- * Uses Node.js crypto for all cryptographic operations
- */
-export declare class SmimeEncrypter implements EmailEncrypter {
-    /**
-     * Collects and normalizes all recipients (to, cc, bcc) from email options.
-     * Normalizes each to an array, extracts email addresses, and deduplicates.
-     * @param email The email options containing recipients.
-     * @returns An array of unique email addresses (strings).
-     */
-    private static collectRecipients;
-    /**
-     * Formats an email address for use in email headers.
-     * @param address The email address to format (string or EmailAddress object).
-     * @returns The formatted email address string in RFC 5322 format.
-     */
-    private static formatAddress;
-    /**
-     * Formats email addresses for use in email headers.
-     * @param addresses The email addresses to format (single or array, string or EmailAddress objects).
-     * @returns The formatted email addresses string (comma-separated if multiple).
-     */
-    private static formatAddresses;
-    private readonly options;
-    /**
-     * Creates a new S/MIME encrypter.
-     * @param options S/MIME encryption options.
-     */
-    constructor(options: SmimeEncryptOptions);
-    /**
-     * Encrypts an email message with S/MIME.
-     * @param email The email options to encrypt.
-     * @returns The encrypted email options.
-     * @throws {Error} When encryption fails (e.g., invalid certificate).
-     */
-    encrypt(email: EmailOptions): Promise<EmailOptions>;
-    /**
-     * Builds the email message string from email options.
-     * @param email The email options to build the message from.
-     * @returns The formatted email message as a string.
-     */
-    private buildMessage;
-}
-/**
- * Creates a new S/MIME encrypter instance.
- * @param options The S/MIME encryption options.
- * @returns A new SmimeEncrypter instance ready to encrypt emails.
- */
-export declare const createSmimeEncrypter: (options: SmimeEncryptOptions) => SmimeEncrypter;

package/dist/crypto/smime-signer.d.ts

@@ -1,48 +0,0 @@
-import type { EmailOptions } from "../types.d.ts";
-import type { EmailSigner, SmimeSignOptions } from "./types.d.ts";
-/**
- * S/MIME signer implementation using PKIjs
- * Note: Requires pkijs and asn1js for S/MIME operations
- * Uses Node.js crypto for all cryptographic operations
- */
-export declare class SmimeSigner implements EmailSigner {
-    /**
-     * Formats an email address for use in email headers.
-     * @param address The email address object to format.
-     * @param address.email The email address string.
-     * @param address.name Optional display name for the email address.
-     * @returns The formatted email address string in RFC 5322 format.
-     */
-    private static formatAddress;
-    private readonly options;
-    /**
-     * Creates a new S/MIME signer.
-     * @param options S/MIME signing options.
-     */
-    constructor(options: SmimeSignOptions);
-    /**
-     * Signs an email message with S/MIME.
-     * @param email The email options to sign.
-     * @returns The email options with S/MIME signature.
-     * @throws {Error} When signing fails (e.g., invalid certificate/key).
-     */
-    sign(email: EmailOptions): Promise<EmailOptions>;
-    /**
-     * Builds the email message string from email options.
-     * @param email The email options to build the message from.
-     * @returns The formatted email message as a string.
-     */
-    private buildMessage;
-    /**
-     * Formats email addresses for use in email headers.
-     * @param addresses The email addresses to format (single or array).
-     * @returns The formatted email addresses string (comma-separated if multiple).
-     */
-    private formatAddresses;
-}
-/**
- * Creates a new S/MIME signer instance.
- * @param options The S/MIME signing options.
- * @returns A new SmimeSigner instance ready to sign emails.
- */
-export declare const createSmimeSigner: (options: SmimeSignOptions) => SmimeSigner;

package/dist/crypto/types.d.ts

@@ -1,101 +0,0 @@
-import type { EmailOptions } from "../types.d.ts";
-/**
- * Options for DKIM signing
- */
-export interface DkimOptions {
-    /**
-     * Body canonicalization algorithm ('simple' or 'relaxed')
-     * Default: 'simple'
-     */
-    bodyCanon?: "relaxed" | "simple";
-    /**
-     * Domain name used for DKIM signing
-     */
-    domainName: string;
-    /**
-     * Header canonicalization algorithm ('simple' or 'relaxed')
-     * Default: 'simple'
-     */
-    headerCanon?: "relaxed" | "simple";
-    /**
-     * List of header names to ignore when signing
-     */
-    headersToIgnore?: string[];
-    /**
-     * Key selector used for DNS lookup
-     */
-    keySelector: string;
-    /**
-     * Passphrase for the private key (if encrypted)
-     */
-    passphrase?: string;
-    /**
-     * Private key for signing (PEM format)
-     * Can be a string with the key content or a path prefixed with 'file://'
-     */
-    privateKey: string;
-}
-/**
- * Options for S/MIME signing
- */
-export interface SmimeSignOptions {
-    /**
-     * Path to the certificate file (PEM format)
-     */
-    certificate: string;
-    /**
-     * Path to intermediate certificates (optional)
-     */
-    intermediateCerts?: string[];
-    /**
-     * Signing options flags
-     * Reserved for future use
-     */
-    options?: number;
-    /**
-     * Passphrase for the private key (if encrypted)
-     */
-    passphrase?: string;
-    /**
-     * Path to the private key file (PEM format)
-     */
-    privateKey: string;
-}
-/**
- * Options for S/MIME encryption
- */
-export interface SmimeEncryptOptions {
-    /**
-     * Encryption algorithm (cipher)
-     * Supported: 'aes-256-cbc', 'aes-192-cbc', 'aes-128-cbc'
-     * Default: 'aes-256-cbc'
-     */
-    algorithm?: string;
-    /**
-     * Certificate(s) for encryption
-     * Can be a single certificate path or a map of email -> certificate path
-     */
-    certificates: string | Record<string, string>;
-}
-/**
- * Interface for email signers
- */
-export interface EmailSigner {
-    /**
-     * Sign an email message
-     * @param email The email options to sign
-     * @returns The signed email options (may include additional headers or modified content)
-     */
-    sign: (email: EmailOptions) => Promise<EmailOptions>;
-}
-/**
- * Interface for email encrypters
- */
-export interface EmailEncrypter {
-    /**
-     * Encrypt an email message
-     * @param email The email options to encrypt
-     * @returns The encrypted email options (content will be encrypted)
-     */
-    encrypt: (email: EmailOptions) => Promise<EmailOptions>;
-}

package/dist/draft-mail-message.d.ts

@@ -1,13 +0,0 @@
-import MailMessage from "./mail-message.d.ts";
-/**
- * Draft mail message - extends MailMessage with X-Unsent header automatically set.
- * Draft messages cannot be sent directly - they must be converted to regular messages first.
- */
-export declare class DraftMailMessage extends MailMessage {
-    /**
-     * Creates a new draft mail message.
-     * The X-Unsent header is automatically set to '1' to mark this as a draft.
-     */
-    constructor();
-}
-export default DraftMailMessage;

package/dist/errors/email-error.d.ts

@@ -1,17 +0,0 @@
-import { VisulimaError } from "@visulima/error";
-/**
- * Base error class for email package operations.
- * @param component The component name where the error occurred.
- * @param message The error message describing what went wrong.
- * @param options Optional error options including cause, code, and hint.
- */
-declare class EmailError extends VisulimaError {
-    readonly component: string;
-    readonly code?: string;
-    constructor(component: string, message: string, options?: {
-        cause?: Error | unknown;
-        code?: string;
-        hint?: string | string[];
-    });
-}
-export default EmailError;

package/dist/errors/required-option-error.d.ts

@@ -1,10 +0,0 @@
-import EmailError from "./email-error.d.ts";
-/**
- * Error for missing required options
- * @param component The component name where the error occurred
- * @param name The name(s) of the missing required option(s)
- */
-declare class RequiredOptionError extends EmailError {
-    constructor(component: string, name: string | string[]);
-}
-export default RequiredOptionError;