@travetto/email 3.4.3 → 4.0.0-rc.0

package/__index__.ts

@@ -2,6 +2,5 @@ export * from './src/service';
 export * from './src/types';
 export * from './src/config';
 export * from './src/transport';
-export * from './src/resource';
 export * from './src/util';
 export * from './src/template';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/email",
-  "version": "3.4.3",
+  "version": "4.0.0-rc.0",
   "description": "Email transmission module.",
   "keywords": [
     "email",
@@ -23,9 +23,9 @@
     "directory": "module/email"
   },
   "dependencies": {
-    "@travetto/base": "^3.4.1",
-    "@travetto/config": "^3.4.3",
-    "@travetto/di": "^3.4.1",
+    "@travetto/base": "^4.0.0-rc.0",
+    "@travetto/config": "^4.0.0-rc.0",
+    "@travetto/di": "^4.0.0-rc.0",
     "@types/mustache": "^4.2.5",
     "mustache": "^4.2.0"
   },

package/src/service.ts

@@ -1,11 +1,10 @@
-import { GlobalEnv } from '@travetto/base';
+import { Env, RuntimeResources } from '@travetto/base';
 import { Injectable } from '@travetto/di';
 
 import { EmailCompiled, EmailOptions, SentEmail } from './types';
 import { MailTransport } from './transport';
 import { MailInterpolator } from './template';
 import { MailUtil } from './util';
-import { EmailResource } from './resource';
 
 type MessageWithoutBody = Omit<EmailOptions, keyof EmailCompiled>;
 
@@ -18,27 +17,24 @@ export class MailService {
   #compiled = new Map<string, EmailCompiled>();
   #transport: MailTransport;
   #interpolator: MailInterpolator;
-  #resources: EmailResource;
 
   constructor(
     transport: MailTransport,
     interpolator: MailInterpolator,
-    resources: EmailResource
   ) {
     this.#interpolator = interpolator;
     this.#transport = transport;
-    this.#resources = resources;
   }
 
   /**
    * Get compiled content by key
    */
   async getCompiled(key: string): Promise<EmailCompiled> {
-    if (GlobalEnv.dynamic || !this.#compiled.has(key)) {
+    if (Env.dynamic || !this.#compiled.has(key)) {
       const [html, text, subject] = await Promise.all([
-        this.#resources.read(`${key}.compiled.html`),
-        this.#resources.read(`${key}.compiled.text`),
-        this.#resources.read(`${key}.compiled.subject`)
+        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 });

package/src/template.ts

@@ -1,13 +1,12 @@
 import mustache from 'mustache';
 
-import { Inject, Injectable } from '@travetto/di';
-
-import { EmailResource } from './resource';
+import { Injectable } from '@travetto/di';
+import { RuntimeResources } from '@travetto/base';
 
 /**
  * Mail interpolation engine
  *
- * @concrete ./internal/types:MailInterpolatorTarget
+ * @concrete ./internal/types#MailInterpolatorTarget
  */
 export interface MailInterpolator {
   /**
@@ -24,9 +23,6 @@ export interface MailInterpolator {
 @Injectable()
 export class MustacheInterpolator implements MailInterpolator {
 
-  @Inject()
-  resources: EmailResource;
-
   /**
    * Resolved nested templates
    */
@@ -34,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(
-        this.resources.read(`${name}.html`) // Ensure html file
+        RuntimeResources.read(`${name}.html`) // Ensure html file
           .then(contents => this.resolveNested(contents))
       );
       return `$%${promises.length - 1}%$`;

package/src/transport.ts

@@ -3,7 +3,7 @@ import { EmailOptions, SentEmail } from './types';
 /**
  * Default mail transport
  *
- * @concrete ./internal/types:MailTransportTarget
+ * @concrete ./internal/types#MailTransportTarget
  */
 export interface MailTransport {
   send<S extends SentEmail = SentEmail>(mail: EmailOptions): Promise<S>;

package/src/types.ts

@@ -1,5 +1,5 @@
-import { Readable } from 'stream';
-import { Url } from 'url';
+import { Readable } from 'node:stream';
+import { Url } from 'node:url';
 
 /**
  * An address
@@ -66,7 +66,7 @@ export type EmailCompiled = Record<EmailContentType, string>;
 
 // Compilation support, defined here to allow for templates to not have a direct dependency on the compiler
 type BaseTemplateConfig = {
-  search?: string[];
+  search?: string[] | readonly string[];
   inline?: boolean;
 };
 

package/src/util.ts

@@ -1,4 +1,4 @@
-import { RootIndex } from '@travetto/manifest';
+import { RuntimeContext } from '@travetto/manifest';
 
 import { EmailAttachment } from './types';
 
@@ -15,7 +15,7 @@ export class MailUtil {
   static buildBrand(file: string, content: string, compile?: string): string {
     const out = [
       'WARNING: Do not modify.',
-      `File is generated from "${file.replace(RootIndex.manifest.workspacePath, '.')}"`,
+      `File is generated from "${file.replace(RuntimeContext.workspace.path, '.')}"`,
       compile ? `Run \`${compile.replaceAll('\n', ' ')}\` to regenerate` : ''
     ];
     return `<!-- ${out.join(' ').trim()}   -->\n${content}`;

package/src/resource.ts

@@ -1,10 +0,0 @@
-import { ResourceLoader } from '@travetto/base';
-import { InjectableFactory } from '@travetto/di';
-
-export class EmailResource extends ResourceLoader {
-
-  @InjectableFactory()
-  static getResources(): EmailResource {
-    return new EmailResource();
-  }
-}