@visulima/email 1.0.0-alpha.2 → 1.0.0-alpha.21

package/README.md

@@ -1,15 +1,24 @@
-<div align="center">
-  <h3>visulima email</h3>
-  <p>
-  Email sending package with multiple provider support
-  </p>
-</div>
+<!-- START_PACKAGE_OG_IMAGE_PLACEHOLDER -->
+
+<a href="https://www.anolilab.com/open-source" align="center">
+
+  <img src="__assets__/package-og.svg" alt="email" />
+
+</a>
+
+<h3 align="center">A comprehensive email library with multi-provider support, crypto utilities, and template engines</h3>
+
+<!-- END_PACKAGE_OG_IMAGE_PLACEHOLDER -->
 
 <br />
 
 <div align="center">
 
-[![typescript-image]][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url]
+[![typescript-image][typescript-badge]][typescript-url]
+[![mit licence][license-badge]][license]
+[![npm downloads][npm-downloads-badge]][npm-downloads]
+[![Chat][chat-badge]][chat]
+[![PRs Welcome][prs-welcome-badge]][prs-welcome]
 
 </div>
 
@@ -128,7 +137,7 @@ await writeFile("draft.eml", eml);
 
 ### Using Different Providers
 
-````typescript
+```typescript
 import { createMail, MailMessage, smtpProvider, resendProvider } from "@visulima/email";
 
 // SMTP provider
@@ -150,13 +159,10 @@ const smtpMail = createMail(smtp);
 const resendMail = createMail(resend);
 
 // Send via specific provider
-const message = new MailMessage()
-    .to("user@example.com")
-    .from("sender@example.com")
-    .subject("Hello")
-    .html("<h1>Hello World</h1>");
+const message = new MailMessage().to("user@example.com").from("sender@example.com").subject("Hello").html("<h1>Hello World</h1>");
 
 await resendMail.send(message);
+```
 
 ### Direct Email Sending
 
@@ -1388,14 +1394,23 @@ If you would like to help take a look at the [list of issues](https://github.com
 - [Daniel Bannert](https://github.com/prisis)
 - [All Contributors](https://github.com/visulima/visulima/graphs/contributors)
 
+## Made with ❤️ at Anolilab
+
+This is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. [Anolilab](https://www.anolilab.com/open-source) is a Development and AI Studio. Contact us at [hello@anolilab.com](mailto:hello@anolilab.com) if you need any help with these technologies or just want to say hi!
+
 ## License
 
-The visulima email is open-sourced software licensed under the [MIT][license-url]
+The visulima email is open-sourced software licensed under the [MIT][license]
+
+<!-- badges -->
 
-[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
-[typescript-url]: https://www.typescriptlang.org/ "TypeScript"
-[license-image]: https://img.shields.io/npm/l/@visulima/email?color=blueviolet&style=for-the-badge
-[license-url]: LICENSE.md "license"
-[npm-image]: https://img.shields.io/npm/v/@visulima/email/latest.svg?style=for-the-badge&logo=npm
-[npm-url]: https://www.npmjs.com/package/@visulima/email/v/latest "npm"
-````
+[license-badge]: https://img.shields.io/npm/l/@visulima/email?style=for-the-badge
+[license]: https://github.com/visulima/visulima/blob/main/LICENSE
+[npm-downloads-badge]: https://img.shields.io/npm/dm/@visulima/email?style=for-the-badge
+[npm-downloads]: https://www.npmjs.com/package/@visulima/email
+[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
+[prs-welcome]: https://github.com/visulima/visulima/blob/main/.github/CONTRIBUTING.md
+[chat-badge]: https://img.shields.io/discord/932323359193186354.svg?style=for-the-badge
+[chat]: https://discord.gg/TtFJY8xkFK
+[typescript-badge]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
+[typescript-url]: https://www.typescriptlang.org/

package/dist/crypto/index.d.ts

@@ -1,4 +1,147 @@
-export { createDkimSigner, DkimSigner } from "./dkim-signer.d.ts";
-export { createSmimeEncrypter, SmimeEncrypter } from "./smime-encrypter.d.ts";
-export { createSmimeSigner, SmimeSigner } from "./smime-signer.d.ts";
-export type { DkimOptions, EmailEncrypter, EmailSigner, SmimeEncryptOptions, SmimeSignOptions } from "./types.d.ts";
+import { E as EmailOptions } from "../packem_shared/types.d-wwpgA3to.js";
+import { D as DkimOptions, E as EmailSigner, S as SmimeEncryptOptions, a as EmailEncrypter, b as SmimeSignOptions } from "../packem_shared/types.d-CNnnk-Ya.js";
+import 'node:buffer';
+/**
+* DKIM signer implementation
+*/
+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.
+*/
+declare const createDkimSigner: (options: DkimOptions) => DkimSigner;
+/**
+* S/MIME encrypter implementation using PKIjs
+* Note: Requires pkijs and asn1js for S/MIME operations
+* Uses Node.js crypto for all cryptographic operations
+*/
+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.
+*/
+declare const createSmimeEncrypter: (options: SmimeEncryptOptions) => SmimeEncrypter;
+/**
+* S/MIME signer implementation using PKIjs
+* Note: Requires pkijs and asn1js for S/MIME operations
+* Uses Node.js crypto for all cryptographic operations
+*/
+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.
+*/
+declare const createSmimeSigner: (options: SmimeSignOptions) => SmimeSigner;
+export { type DkimOptions, DkimSigner, type EmailEncrypter, type EmailSigner, type SmimeEncryptOptions, SmimeEncrypter, type SmimeSignOptions, SmimeSigner, createDkimSigner, createSmimeEncrypter, createSmimeSigner };

package/dist/crypto/index.js

@@ -1 +1 @@
-import{DkimSigner as m,createDkimSigner as i}from"../packem_shared/DkimSigner-pFd4c3fZ.js";import{SmimeEncrypter as S,createSmimeEncrypter as n}from"../packem_shared/SmimeEncrypter-CBevU534.js";import{SmimeSigner as c,createSmimeSigner as p}from"../packem_shared/SmimeSigner-CObA4jzT.js";export{m as DkimSigner,S as SmimeEncrypter,c as SmimeSigner,i as createDkimSigner,n as createSmimeEncrypter,p as createSmimeSigner};
+import{DkimSigner as m,createDkimSigner as i}from"../packem_shared/DkimSigner-CT2DSHD1.js";import{SmimeEncrypter as S,createSmimeEncrypter as n}from"../packem_shared/SmimeEncrypter-ZhHEgDwY.js";import{SmimeSigner as c,createSmimeSigner as p}from"../packem_shared/SmimeSigner-CYSVF6ez.js";export{m as DkimSigner,S as SmimeEncrypter,c as SmimeSigner,i as createDkimSigner,n as createSmimeEncrypter,p as createSmimeSigner};