@travetto/email 7.0.0-rc.1 → 7.0.0-rc.3

package/package.json

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

package/src/resource.ts

@@ -10,9 +10,9 @@ export class EmailResourceLoader extends FileLoader {
     super([
       ...Env.TRV_RESOURCES.list ?? [],
       `${module}#resources`,
-      ...RuntimeIndex.getDependentModules(mod, 'children').map(x => `${x.name}#resources`),
+      ...RuntimeIndex.getDependentModules(mod, 'children').map(indexedMod => `${indexedMod.name}#resources`),
       '@@#resources',
       ...globalResources ?? []
-    ].map(v => Runtime.modulePath(v)));
+    ].map(name => Runtime.modulePath(name)));
   }
 }

package/src/service.ts

@@ -17,6 +17,7 @@ export class MailService {
   #compiled = new Map<string, EmailCompiled>();
   #transport: MailTransport;
   #interpolator: MailInterpolator;
+  #cacheResults = true;
 
   constructor(
     transport: MailTransport,
@@ -26,18 +27,23 @@ export class MailService {
     this.#transport = transport;
   }
 
+  setCacheState(active: boolean): void {
+    this.#cacheResults = active;
+  }
+
   /**
    * Get compiled content by key
    */
   async getCompiled(key: string): Promise<EmailCompiled> {
-    if (Runtime.dynamic || !this.#compiled.has(key)) {
+    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`)
-      ].map(x => x.then(MailUtil.purgeBrand)));
-
-      this.#compiled.set(key, { html, text, subject });
+      ].map(file => file.then(MailUtil.purgeBrand)));
+      if (this.#cacheResults) {
+        this.#compiled.set(key, { html, text, subject });
+      }
     }
     return this.#compiled.get(key)!;
   }
@@ -49,12 +55,12 @@ export class MailService {
    * @returns
    */
   async renderMessage(keyOrMessage: string | EmailCompiled | EmailOptions, ctx: Record<string, unknown>): Promise<EmailCompiled> {
-    const tpl = (typeof keyOrMessage === 'string' ? await this.getCompiled(keyOrMessage) : keyOrMessage);
+    const template = (typeof keyOrMessage === 'string' ? await this.getCompiled(keyOrMessage) : keyOrMessage);
 
     const [html, text, subject] = await Promise.all([
-      this.#interpolator.render(tpl.html, ctx),
-      this.#interpolator.render(tpl.text ?? '', ctx),
-      this.#interpolator.render(tpl.subject, ctx)
+      this.#interpolator.render(template.html, ctx),
+      this.#interpolator.render(template.text ?? '', ctx),
+      this.#interpolator.render(template.subject, ctx)
     ]);
 
     return { html, text, subject };
@@ -107,13 +113,13 @@ export class MailService {
    * Send multiple messages.
    */
   async sendAll<S extends SentEmail = SentEmail>(messages: EmailOptions[], base: Partial<EmailOptions> = {}): Promise<S[]> {
-    return Promise.all(messages.map(msg => this.send<S>({
+    return Promise.all(messages.map(message => this.send<S>({
       ...base,
-      ...msg,
-      ...(msg.context || base.context ? {
+      ...message,
+      ...(message.context || base.context ? {
         context: {
           ...(base.context || {}),
-          ...(msg.context || {})
+          ...(message.context || {})
         }
       } : {})
     })));

package/src/template.ts

@@ -10,8 +10,8 @@ import { RuntimeResources } from '@travetto/runtime';
  */
 export interface MailInterpolator {
   /**
-  * Resolved nested templates
-  */
+   * Resolved nested templates
+   */
   resolveNested(template: string): Promise<string>;
 
   /**

package/src/types.ts

@@ -84,4 +84,4 @@ type EmailTemplateContent = Record<EmailContentType, () => (Promise<string> | st
 
 export type EmailTemplateLocation = { file: string, module: string };
 export type EmailTemplateModule = EmailTemplateResource & EmailTemplateContent;
-export type EmailTemplateImport = { prepare(loc: EmailTemplateLocation): Promise<EmailTemplateModule> };
+export type EmailTemplateImport = { prepare(location: EmailTemplateLocation): Promise<EmailTemplateModule> };

package/src/util.ts

@@ -35,20 +35,20 @@ export class MailUtil {
     html = html.replace(/data:(image\/[^;]{1,50});base64,([^"']{1,10000000})/g, (__, contentType, content) => {
       // Ensure same data uris map to a single cid
       if (!contentMap.has(content)) {
-        const cid = `image-${idx += 1}`;
+        const contentId = `image-${idx += 1}`;
         const ext = contentType.split('/')[1];
         attachments.push({
-          cid,
-          filename: `${cid}.${ext}`,
+          cid: contentId,
+          filename: `${contentId}.${ext}`,
           headers: {
-            'X-Attachment-Id': `${cid}`
+            'X-Attachment-Id': `${contentId}`
           },
           content: Buffer.from(content, 'base64'),
           contentDisposition: 'inline',
           contentType
         });
-        contentMap.set(content, cid);
-        return `cid:${cid}`;
+        contentMap.set(content, contentId);
+        return `cid:${contentId}`;
       } else {
         return contentMap.get(content)!;
       }
@@ -62,14 +62,14 @@ export class MailUtil {
   /**
    * Get the primary email, if set from an email identity or identity list
    */
-  static getPrimaryEmail(src?: EmailIdentity | EmailIdentityList): string | undefined {
-    if (!src) {
+  static getPrimaryEmail(identity?: EmailIdentity | EmailIdentityList): string | undefined {
+    if (!identity) {
       return;
     }
-    if (Array.isArray(src)) {
-      src = src[0];
+    if (Array.isArray(identity)) {
+      identity = identity[0];
     }
-    return (typeof src === 'string') ? src : src.address;
+    return (typeof identity === 'string') ? identity : identity.address;
   }
 
   /**
@@ -78,7 +78,7 @@ export class MailUtil {
   static buildUniqueMessageId(message: EmailOptions): string {
     const from = this.getPrimaryEmail(message.from)!;
     const to = this.getPrimaryEmail(message.to)!;
-    const uid = BinaryUtil.hash(`${to}${from}${message.subject}${Date.now()}`, 12);
-    return `<${uid}@${from.split('@')[1]}>`;
+    const uniqueId = BinaryUtil.hash(`${to}${from}${message.subject}${Date.now()}`, 12);
+    return `<${uniqueId}@${from.split('@')[1]}>`;
   }
 }