@travetto/email 7.1.4 → 8.0.0-alpha.1

package/README.md

@@ -13,7 +13,7 @@ npm install @travetto/email
 yarn add @travetto/email
 ```
 
-A standard API for sending and rendering emails. The mail transport must be defined to allow for mail to be sent properly.  Out of the box, the only transport available by default is the [NullTransport](https://github.com/travetto/travetto/tree/main/module/email/src/transport.ts#L16) which will just drop emails. The structure of the API is derived from  [nodemailer](https://nodemailer.com/about/), but is compatible with any library that can handle the [EmailOptions](https://github.com/travetto/travetto/tree/main/module/email/src/types.ts#L45) input. 
+A standard API for sending and rendering emails. The mail transport must be defined to allow for mail to be sent properly.  Out of the box, the only transport available by default is the [NullTransport](https://github.com/travetto/travetto/tree/main/module/email/src/transport.ts#L16) which will just drop emails. The structure of the API is derived from  [nodemailer](https://nodemailer.com/about/), but is compatible with any library that can handle the [EmailOptions](https://github.com/travetto/travetto/tree/main/module/email/src/types.ts#L44) input. 
 
 To expose the necessary email transport, the following pattern is commonly used:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/email",
-  "version": "7.1.4",
+  "version": "8.0.0-alpha.1",
   "description": "Email transmission module.",
   "keywords": [
     "email",
@@ -23,9 +23,9 @@
     "directory": "module/email"
   },
   "dependencies": {
-    "@travetto/config": "^7.1.4",
-    "@travetto/di": "^7.1.4",
-    "@travetto/runtime": "^7.1.4",
+    "@travetto/config": "^8.0.0-alpha.1",
+    "@travetto/di": "^8.0.0-alpha.1",
+    "@travetto/runtime": "^8.0.0-alpha.1",
     "@types/mustache": "^4.2.6",
     "mustache": "^4.2.0"
   },

package/src/resource.ts

@@ -1,11 +1,11 @@
-import { AppError, Env, FileLoader, Runtime, RuntimeIndex } from '@travetto/runtime';
+import { RuntimeError, Env, FileLoader, Runtime, RuntimeIndex } from '@travetto/runtime';
 
 /** Build a resource loader that looks into a module and it's dependencies */
 export class EmailResourceLoader extends FileLoader {
   constructor(moduleName: string, globalResources?: string[]) {
     const found = RuntimeIndex.getModule(moduleName);
     if (!found) {
-      throw new AppError(`Unknown module - ${moduleName}`, { category: 'notfound', details: { module: moduleName } });
+      throw new RuntimeError(`Unknown module - ${moduleName}`, { category: 'notfound', details: { module: moduleName } });
     }
     super([
       ...Env.TRV_RESOURCES.list ?? [],

package/src/service.ts

@@ -37,9 +37,9 @@ export class MailService {
   async getCompiled(key: string): Promise<EmailCompiled> {
     if (!this.#compiled.has(key)) {
       const [html, text, subject] = await Promise.all([
-        RuntimeResources.read(`${key}.compiled.html`),
-        RuntimeResources.read(`${key}.compiled.text`),
-        RuntimeResources.read(`${key}.compiled.subject`)
+        RuntimeResources.readText(`${key}.compiled.html`),
+        RuntimeResources.readText(`${key}.compiled.text`),
+        RuntimeResources.readText(`${key}.compiled.subject`)
       ].map(file => file.then(MailUtil.purgeBrand)));
       if (this.#cacheResults) {
         this.#compiled.set(key, { html, text, subject });

package/src/template.ts

@@ -30,7 +30,7 @@ export class MustacheInterpolator implements MailInterpolator {
     const promises: Promise<string>[] = [];
     template = template.replace(/[{]{2,3}>\s+(\S+)([.]html)?\s*[}]{2,3}/g, (all: string, name: string) => {
       promises.push(
-        RuntimeResources.read(`${name}.html`) // Ensure html file
+        RuntimeResources.readText(`${name}.html`) // Ensure html file
           .then(contents => this.resolveNested(contents))
       );
       return `$%${promises.length - 1}%$`;

package/src/types.ts

@@ -1,7 +1,6 @@
-import type { Readable } from 'node:stream';
 import type { Url } from 'node:url';
 
-import type { FileLoader } from '@travetto/runtime';
+import type { BinaryType, FileLoader } from '@travetto/runtime';
 
 /**
  * An address
@@ -14,15 +13,15 @@ export interface EmailAddress {
 /**
  * An attachment for the email
  */
-interface AttachmentLike {
-  content?: string | Buffer | Readable;
+interface AttachmentLike<B extends BinaryType = BinaryType> {
+  content?: B | string;
   path?: string | Url;
 }
 
 /**
  * A full attachment
  */
-export interface EmailAttachment extends AttachmentLike {
+export interface EmailAttachment<B extends BinaryType = BinaryType> extends AttachmentLike<B> {
   filename?: string | false;
   cid?: string;
   encoding?: string;
@@ -30,7 +29,7 @@ export interface EmailAttachment extends AttachmentLike {
   contentTransferEncoding?: false | '7bit' | 'base64' | 'quoted-printable';
   contentDisposition?: 'attachment' | 'inline';
   headers?: Record<string, string | string[]>;
-  raw?: string | Buffer | Readable | AttachmentLike;
+  raw?: B | string;
 }
 
 type EmailContentType = 'html' | 'text' | 'subject';
@@ -42,7 +41,7 @@ export type EmailIdentityList = EmailIdentity | EmailIdentity[];
  * Full message options
  * @concrete
  */
-export interface EmailOptions {
+export interface EmailOptions<B extends BinaryType = BinaryType> {
   html: string;
   text?: string;
   subject: string;
@@ -59,8 +58,8 @@ export interface EmailOptions {
   inReplyTo?: EmailIdentity;
   references?: string | string[];
   headers?: Record<string, string | string[]>;
-  attachments?: EmailAttachment[];
-  alternatives?: EmailAttachment[];
+  attachments?: EmailAttachment<B>[];
+  alternatives?: EmailAttachment<B>[];
   messageId?: string;
   date?: Date | string;
   encoding?: string;

package/src/util.ts

@@ -1,4 +1,4 @@
-import { Runtime, BinaryUtil } from '@travetto/runtime';
+import { Runtime, CodecUtil, BinaryMetadataUtil } from '@travetto/runtime';
 
 import type { EmailAttachment, EmailIdentity, EmailIdentityList, EmailOptions } from './types.ts';
 
@@ -32,9 +32,9 @@ export class MailUtil {
     const contentMap = new Map<string, string>();
 
     // Max of 10mb
-    html = html.replace(/data:(image\/[^;]{1,50});base64,([^"']{1,10000000})/g, (__, contentType, content) => {
+    html = html.replace(/data:(image\/[^;]{1,50});base64,([^"']{1,10000000})/g, (__, contentType: string, content: string) =>
       // Ensure same data uris map to a single cid
-      if (!contentMap.has(content)) {
+      contentMap.getOrInsertComputed(content, () => {
         const contentId = `image-${idx += 1}`;
         const ext = contentType.split('/')[1];
         attachments.push({
@@ -43,20 +43,14 @@ export class MailUtil {
           headers: {
             'X-Attachment-Id': `${contentId}`
           },
-          content: Buffer.from(content, 'base64'),
+          content: CodecUtil.fromBase64String(content),
           contentDisposition: 'inline',
           contentType
         });
-        contentMap.set(content, contentId);
         return `cid:${contentId}`;
-      } else {
-        return contentMap.get(content)!;
-      }
-    });
+      }));
 
-    return {
-      html, attachments
-    };
+    return { html, attachments };
   }
 
   /**
@@ -78,7 +72,7 @@ export class MailUtil {
   static buildUniqueMessageId(message: EmailOptions): string {
     const from = this.getPrimaryEmail(message.from)!;
     const to = this.getPrimaryEmail(message.to)!;
-    const uniqueId = BinaryUtil.hash(`${to}${from}${message.subject}${Date.now()}`, 12);
+    const uniqueId = BinaryMetadataUtil.hash(`${to}${from}${message.subject}${Date.now()}`, { length: 12 });
     return `<${uniqueId}@${from.split('@')[1]}>`;
   }
 }