@visulima/email 2.1.6 → 2.1.7

package/dist/utils/cache.d.ts

@@ -1,49 +1,49 @@
 /**
-* Generic cache interface for caching any type of data.
-* Implementations can use in-memory cache, LRU cache, Redis, etc.
-*/
+ * Generic cache interface for caching any type of data.
+ * Implementations can use in-memory cache, LRU cache, Redis, etc.
+ */
 interface Cache<T = unknown> {
   /**
-  * Clears all cached entries.
-  */
+   * Clears all cached entries.
+   */
   clear: () => Promise<void>;
   /**
-  * Deletes a cached entry.
-  * @param key The cache key.
-  */
+   * Deletes a cached entry.
+   * @param key The cache key.
+   */
   delete: (key: string) => Promise<void>;
   /**
-  * Gets a cached value.
-  * @param key The cache key.
-  * @returns The cached value or undefined if not found or expired.
-  */
+   * Gets a cached value.
+   * @param key The cache key.
+   * @returns The cached value or undefined if not found or expired.
+   */
   get: (key: string) => Promise<T | undefined>;
   /**
-  * Sets a cached value.
-  * @param key The cache key.
-  * @param value The value to cache.
-  * @param ttl Time-to-live in milliseconds.
-  */
+   * Sets a cached value.
+   * @param key The cache key.
+   * @param value The value to cache.
+   * @param ttl Time-to-live in milliseconds.
+   */
   set: (key: string, value: T, ttl: number) => Promise<void>;
 }
 /**
-* Options for creating an in-memory cache.
-*/
+ * Options for creating an in-memory cache.
+ */
 interface InMemoryCacheOptions {
   /**
-  * Maximum number of entries in the cache.
-  * @default 500
-  */
+   * Maximum number of entries in the cache.
+   * @default 500
+   */
   max?: number;
   /**
-  * Default TTL in milliseconds for entries.
-  * @default 3600000 (1 hour)
-  */
+   * Default TTL in milliseconds for entries.
+   * @default 3600000 (1 hour)
+   */
   ttl?: number;
 }
 /**
-* Default in-memory cache implementation using LRU cache.
-*/
+ * Default in-memory cache implementation using LRU cache.
+ */
 declare class InMemoryCache<T extends object = Record<string, unknown>> implements Cache<T> {
   private readonly cache;
   constructor(options?: InMemoryCacheOptions);

package/dist/utils/format-email-address.d.ts

@@ -1,10 +1,10 @@
-import { c as EmailAddress } from "../packem_shared/types.d-ejzh-xBP.js";
+import { c as EmailAddress } from "../packem_shared/types.d-B9295M4_.js";
 import 'node:buffer';
 /**
-* Formats an email address as "Name <email@example.com>" or just "email@example.com" if no name is provided.
-* @param address The email address object to format.
-* @returns The formatted email address string in RFC 5322 format.
-* @throws {EmailError} When the email address is invalid.
-*/
+ * Formats an email address as "Name <email@example.com>" or just "email@example.com" if no name is provided.
+ * @param address The email address object to format.
+ * @returns The formatted email address string in RFC 5322 format.
+ * @throws {EmailError} When the email address is invalid.
+ */
 declare const formatEmailAddress: (address: EmailAddress) => string;
 export { formatEmailAddress as default };

package/dist/utils/format-email-address.js

@@ -1 +1 @@
-import{s as m}from"../packem_shared/format-address-DTl-9O70.js";import r from"../packem_shared/EmailError-B-sEf3bp.js";import i from"./validation/validate-email.js";const n=a=>{if(!i(a.email))throw new r("email",`Invalid email address: ${a.email}`);if(a.name){const e=m(a.name);if(e)return`"${e}" <${a.email}>`}return a.email};export{n as default};
+import{s as m}from"../packem_shared/format-address-DTl-9O70.js";import r from"../packem_shared/EmailError-CDvYwuqz.js";import i from"./validation/validate-email.js";const n=a=>{if(!i(a.email))throw new r("email",`Invalid email address: ${a.email}`);if(a.name){const e=m(a.name);if(e)return`"${e}" <${a.email}>`}return a.email};export{n as default};

package/dist/utils/normalize-email-aliases.d.ts

@@ -1,22 +1,22 @@
 /**
-* Normalizes email aliases for supported email providers.
-* For example: example@gmail.com and example+another@gmail.com point to the same email address.
-* This function normalizes aliases to their canonical form.
-*
-* Supported providers:
-* - Gmail: Removes dots and plus aliases (example+test@gmail.com → example@gmail.com)
-* - Yahoo, Outlook, Hotmail, Live, MSN, iCloud, ProtonMail, Zoho, FastMail, Mail.com, GMX: Removes plus aliases only
-* @param email The email address to normalize.
-* @returns The normalized email address, or the original email if not supported or invalid.
-* @example
-* ```ts
-* import { normalizeEmailAliases } from "@visulima/email/utils/normalize-email-aliases";
-*
-* normalizeEmailAliases("example+test@gmail.com"); // "example@gmail.com"
-* normalizeEmailAliases("ex.ample@gmail.com"); // "example@gmail.com"
-* normalizeEmailAliases("user+tag@yahoo.com"); // "user@yahoo.com"
-* normalizeEmailAliases("user@example.com"); // "user@example.com" (unchanged)
-* ```
-*/
+ * Normalizes email aliases for supported email providers.
+ * For example: example@gmail.com and example+another@gmail.com point to the same email address.
+ * This function normalizes aliases to their canonical form.
+ *
+ * Supported providers:
+ * - Gmail: Removes dots and plus aliases (example+test@gmail.com → example@gmail.com)
+ * - Yahoo, Outlook, Hotmail, Live, MSN, iCloud, ProtonMail, Zoho, FastMail, Mail.com, GMX: Removes plus aliases only
+ * @param email The email address to normalize.
+ * @returns The normalized email address, or the original email if not supported or invalid.
+ * @example
+ * ```ts
+ * import { normalizeEmailAliases } from "@visulima/email/utils/normalize-email-aliases";
+ *
+ * normalizeEmailAliases("example+test@gmail.com"); // "example@gmail.com"
+ * normalizeEmailAliases("ex.ample@gmail.com"); // "example@gmail.com"
+ * normalizeEmailAliases("user+tag@yahoo.com"); // "user@yahoo.com"
+ * normalizeEmailAliases("user@example.com"); // "user@example.com" (unchanged)
+ * ```
+ */
 declare const normalizeEmailAliases: (email: string) => string;
 export { normalizeEmailAliases as default };

package/dist/utils/parse-address.d.ts

@@ -1,20 +1,20 @@
-import { c as EmailAddress } from "../packem_shared/types.d-ejzh-xBP.js";
+import { c as EmailAddress } from "../packem_shared/types.d-B9295M4_.js";
 import 'node:buffer';
 /**
-* Parses a string representation of an email address into an EmailAddress object.
-* Supports formats: "email@example.com", "Name <email@example.com>", "<email@example.com>".
-* @example Parsing an address with a name
-* ```ts
-* const address = parseAddress("John Doe <john@example.com>");
-* // { name: "John Doe", email: "john@example.com" }
-* ```
-* @example Parsing an address without a name
-* ```ts
-* const address = parseAddress("jane@example.com");
-* // { email: "jane@example.com" }
-* ```
-* @param address The string representation of the address to parse.
-* @returns An EmailAddress object if parsing is successful, or undefined if invalid.
-*/
+ * Parses a string representation of an email address into an EmailAddress object.
+ * Supports formats: "email@example.com", "Name &lt;email@example.com>", "&lt;email@example.com>".
+ * @example Parsing an address with a name
+ * ```ts
+ * const address = parseAddress("John Doe <john@example.com>");
+ * // { name: "John Doe", email: "john@example.com" }
+ * ```
+ * @example Parsing an address without a name
+ * ```ts
+ * const address = parseAddress("jane@example.com");
+ * // { email: "jane@example.com" }
+ * ```
+ * @param address The string representation of the address to parse.
+ * @returns An EmailAddress object if parsing is successful, or undefined if invalid.
+ */
 declare const parseAddress: (address: string) => EmailAddress | undefined;
 export { parseAddress as default };

package/dist/utils/parse-eml.d.ts

@@ -1,22 +1,22 @@
-import { E as EmailOptions } from "../packem_shared/types.d-ejzh-xBP.js";
+import { E as EmailOptions } from "../packem_shared/types.d-B9295M4_.js";
 import 'node:buffer';
 /**
-* Parses a raw EML / RFC 5322 MIME message back into {@link EmailOptions}.
-*
-* This closes the round-trip story for {@link "../mail".Mail.draft}: serialise a
-* message to EML, persist/transmit it, then `parseEml()` it back into options you
-* can hand to `mail.send()`. It understands the multipart layout produced by this
-* library's own `buildMimeMessage` (text/plain + text/html parts, quoted-printable
-* and base64 transfer encodings, RFC 2047 encoded headers) and common
-* single-part messages.
-*
-* Scope: it extracts `from`, `to`, `cc`, `bcc`, `replyTo`, `subject`, `text`,
-* `html`, `priority`, and remaining custom `headers`. Attachment bodies are not
-* decoded into {@link "../types".Attachment} objects (use a full MIME parser such
-* as `mailparser` for that); attachment parts are skipped.
-* @param eml The raw EML/MIME message string.
-* @returns The parsed email options.
-* @throws {Error} When the message has no `From` or `To`/`Cc`/`Bcc` recipient and therefore cannot satisfy the required {@link EmailOptions} shape.
-*/
+ * Parses a raw EML / RFC 5322 MIME message back into {@link EmailOptions}.
+ *
+ * This closes the round-trip story for {@link "../mail".Mail.draft}: serialise a
+ * message to EML, persist/transmit it, then `parseEml()` it back into options you
+ * can hand to `mail.send()`. It understands the multipart layout produced by this
+ * library's own `buildMimeMessage` (text/plain + text/html parts, quoted-printable
+ * and base64 transfer encodings, RFC 2047 encoded headers) and common
+ * single-part messages.
+ *
+ * Scope: it extracts `from`, `to`, `cc`, `bcc`, `replyTo`, `subject`, `text`,
+ * `html`, `priority`, and remaining custom `headers`. Attachment bodies are not
+ * decoded into {@link "../types".Attachment} objects (use a full MIME parser such
+ * as `mailparser` for that); attachment parts are skipped.
+ * @param eml The raw EML/MIME message string.
+ * @returns The parsed email options.
+ * @throws {Error} When the message has no `From` or `To`/`Cc`/`Bcc` recipient and therefore cannot satisfy the required {@link EmailOptions} shape.
+ */
 declare const parseEml: (eml: string) => EmailOptions;
 export { parseEml as default };

package/dist/utils/result.d.ts

@@ -1,49 +1,49 @@
-import { R as Result } from "../packem_shared/types.d-ejzh-xBP.js";
+import { R as Result } from "../packem_shared/types.d-B9295M4_.js";
 import 'node:buffer';
 /**
-* A successful {@link Result} with its data narrowed to be present.
-*/
+ * A successful {@link Result} with its data narrowed to be present.
+ */
 type OkResult<T> = Result<T> & {
   data: T;
   success: true;
 };
 /**
-* Returns whether a {@link Result} succeeded, narrowing `data` to be present.
-* @param result The result to test.
-* @returns `true` when the result is successful.
-*/
+ * Returns whether a {@link Result} succeeded, narrowing `data` to be present.
+ * @param result The result to test.
+ * @returns `true` when the result is successful.
+ */
 declare const isOk: <T>(result: Result<T>) => result is OkResult<T>;
 /**
-* Returns whether a {@link Result} failed.
-* @param result The result to test.
-* @returns `true` when the result is a failure.
-*/
+ * Returns whether a {@link Result} failed.
+ * @param result The result to test.
+ * @returns `true` when the result is a failure.
+ */
 declare const isErr: <T>(result: Result<T>) => boolean;
 /**
-* Returns the data of a successful {@link Result}, or throws its error.
-* @param result The result to unwrap.
-* @returns The contained data.
-* @throws {EmailError} The result's error (wrapped when it is not already an `Error`).
-*/
+ * Returns the data of a successful {@link Result}, or throws its error.
+ * @param result The result to unwrap.
+ * @returns The contained data.
+ * @throws {EmailError} The result's error (wrapped when it is not already an `Error`).
+ */
 declare const unwrap: <T>(result: Result<T>) => T;
 /**
-* Returns the data of a successful {@link Result}, or a fallback when it failed.
-* @param result The result to unwrap.
-* @param fallback The value to return on failure.
-* @returns The data, or the fallback.
-*/
+ * Returns the data of a successful {@link Result}, or a fallback when it failed.
+ * @param result The result to unwrap.
+ * @param fallback The value to return on failure.
+ * @returns The data, or the fallback.
+ */
 declare const unwrapOr: <T>(result: Result<T>, fallback: T) => T;
 /**
-* Maps the data of a successful {@link Result}, passing failures through unchanged.
-* @param result The result to map.
-* @param function_ The mapper applied to the data on success.
-* @returns A new result with the mapped data, or the original failure.
-*/
+ * Maps the data of a successful {@link Result}, passing failures through unchanged.
+ * @param result The result to map.
+ * @param function_ The mapper applied to the data on success.
+ * @returns A new result with the mapped data, or the original failure.
+ */
 declare const mapOk: <T, U>(result: Result<T>, function_: (data: T) => U) => Result<U>;
 /**
-* Runs an async function and captures its outcome as a {@link Result}, never throwing.
-* @param function_ The async function to run.
-* @returns A successful result with the value, or a failed result with the thrown error.
-*/
+ * Runs an async function and captures its outcome as a {@link Result}, never throwing.
+ * @param function_ The async function to run.
+ * @returns A successful result with the value, or a failed result with the thrown error.
+ */
 declare const tryAsync: <T>(function_: () => Promise<T>) => Promise<Result<T>>;
 export { OkResult, isErr, isOk, mapOk, tryAsync, unwrap, unwrapOr };

package/dist/utils/result.js

@@ -1 +1 @@
-import e from"../packem_shared/EmailError-B-sEf3bp.js";const c=s=>s.success,t=s=>!s.success,u=s=>{if(s.success)return s.data;throw s.error instanceof Error?s.error:new e("result","Called unwrap() on a failed result",{cause:s.error})},o=(s,r)=>s.success?s.data:r,n=(s,r)=>s.success?{data:r(s.data),success:!0}:{error:s.error,success:!1},d=async s=>{try{return{data:await s(),success:!0}}catch(r){return{error:r,success:!1}}};export{t as isErr,c as isOk,n as mapOk,d as tryAsync,u as unwrap,o as unwrapOr};
+import e from"../packem_shared/EmailError-CDvYwuqz.js";const c=s=>s.success,t=s=>!s.success,u=s=>{if(s.success)return s.data;throw s.error instanceof Error?s.error:new e("result","Called unwrap() on a failed result",{cause:s.error})},o=(s,r)=>s.success?s.data:r,n=(s,r)=>s.success?{data:r(s.data),success:!0}:{error:s.error,success:!1},d=async s=>{try{return{data:await s(),success:!0}}catch(r){return{error:r,success:!1}}};export{t as isErr,c as isOk,n as mapOk,d as tryAsync,u as unwrap,o as unwrapOr};

package/dist/utils/validation/check-feature-support.d.ts

@@ -1,53 +1,53 @@
-import { F as FeatureFlags, E as EmailOptions } from "../../packem_shared/types.d-ejzh-xBP.js";
+import { F as FeatureFlags, E as EmailOptions } from "../../packem_shared/types.d-B9295M4_.js";
 import 'node:buffer';
 /**
-* A single capability that a message uses but the target provider cannot represent.
-*/
+ * A single capability that a message uses but the target provider cannot represent.
+ */
 interface FeatureViolation {
   /**
-  * The provider capability flag that is not supported.
-  */
+   * The provider capability flag that is not supported.
+   */
   feature: keyof FeatureFlags;
   /**
-  * The message field that triggered the check.
-  */
+   * The message field that triggered the check.
+   */
   field: string;
   /**
-  * Human-readable explanation of the violation.
-  */
+   * Human-readable explanation of the violation.
+   */
   message: string;
 }
 /**
-* Result of a fail-fast provider capability check.
-*/
+ * Result of a fail-fast provider capability check.
+ */
 interface FeatureSupportResult {
   /**
-  * True when the message uses no capability the provider has explicitly disabled.
-  */
+   * True when the message uses no capability the provider has explicitly disabled.
+   */
   supported: boolean;
   /**
-  * The list of capabilities the message uses that the provider cannot represent.
-  */
+   * The list of capabilities the message uses that the provider cannot represent.
+   */
   violations: FeatureViolation[];
 }
 /**
-* Performs a fail-fast field-support check for a message against a provider's declared capabilities.
-*
-* A capability counts as a violation only when the message actually uses it **and** the provider
-* has explicitly declared it unsupported (`features[capability] === false`). Capabilities left
-* `undefined` are treated as "unknown" and never raise a violation, so providers that publish a
-* partial (or no) {@link FeatureFlags} map are never falsely rejected.
-* @param options The normalized email options about to be sent.
-* @param features The target provider's declared capabilities. When omitted the check is a no-op.
-* @returns A {@link FeatureSupportResult} describing any unsupported capabilities in use.
-* @example
-* ```ts
-* const { supported, violations } = checkFeatureSupport(message, provider.features);
-*
-* if (!supported) {
-*     throw new Error(violations.map((v) => v.message).join(", "));
-* }
-* ```
-*/
+ * Performs a fail-fast field-support check for a message against a provider's declared capabilities.
+ *
+ * A capability counts as a violation only when the message actually uses it **and** the provider
+ * has explicitly declared it unsupported (`features[capability] === false`). Capabilities left
+ * `undefined` are treated as "unknown" and never raise a violation, so providers that publish a
+ * partial (or no) {@link FeatureFlags} map are never falsely rejected.
+ * @param options The normalized email options about to be sent.
+ * @param features The target provider's declared capabilities. When omitted the check is a no-op.
+ * @returns A {@link FeatureSupportResult} describing any unsupported capabilities in use.
+ * @example
+ * ```ts
+ * const { supported, violations } = checkFeatureSupport(message, provider.features);
+ *
+ * if (!supported) {
+ *     throw new Error(violations.map((v) => v.message).join(", "));
+ * }
+ * ```
+ */
 declare function checkFeatureSupport(options: EmailOptions, features?: FeatureFlags): FeatureSupportResult;
 export { FeatureSupportResult, FeatureViolation, checkFeatureSupport as default };

package/dist/utils/validation/validate-email.d.ts

@@ -1,7 +1,7 @@
 /**
-* Validates an email address format according to basic RFC standards.
-* @param email The email address string to validate.
-* @returns True if the email address is valid, false otherwise.
-*/
+ * Validates an email address format according to basic RFC standards.
+ * @param email The email address string to validate.
+ * @returns True if the email address is valid, false otherwise.
+ */
 declare const validateEmail: (email: string) => boolean;
 export { validateEmail as default };