@travetto/email-compiler 3.3.7 → 3.4.0-rc.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/email-compiler",
-  "version": "3.3.7",
+  "version": "3.4.0-rc.0",
   "description": "Email compiling module",
   "keywords": [
     "email",
@@ -26,19 +26,20 @@
     "directory": "module/email-compiler"
   },
   "dependencies": {
-    "@travetto/base": "^3.3.3",
-    "@travetto/config": "^3.3.4",
-    "@travetto/di": "^3.3.3",
-    "@travetto/email": "^3.3.4",
-    "@travetto/image": "^3.3.3",
-    "@types/inline-css": "^3.0.1",
+    "@travetto/base": "^3.4.0-rc.0",
+    "@travetto/config": "^3.4.0-rc.0",
+    "@travetto/di": "^3.4.0-rc.0",
+    "@travetto/email": "^3.4.0-rc.0",
+    "@travetto/image": "^3.4.0-rc.0",
+    "@travetto/worker": "^3.4.0-rc.0",
+    "@types/inline-css": "^3.0.2",
     "html-entities": "^2.4.0",
     "inline-css": "^4.0.2",
     "purgecss": "^5.0.0",
-    "sass": "^1.68.0"
+    "sass": "^1.69.5"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.3.5"
+    "@travetto/cli": "^3.4.0-rc.0"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/compiler.ts

@@ -4,16 +4,34 @@ import { FileQueryProvider, TypedObject } from '@travetto/base';
 import { EmailCompileSource, EmailCompiled, EmailCompileContext, MailUtil } from '@travetto/email';
 import { RootIndex, path } from '@travetto/manifest';
 import { DynamicFileLoader } from '@travetto/base/src/internal/file-loader';
+import { ManualAsyncIterator as Queue } from '@travetto/worker';
 
 import { EmailCompileUtil } from './util';
 
 const VALID_FILE = (file: string): boolean => /[.](scss|css|png|jpe?g|gif|ya?ml)$/.test(file) && !/[.]compiled[.]/.test(file);
 
+type WatchEvent = { action: 'create' | 'update' | 'delete', file: string, folder: string };
+
 /**
  * Email compilation support
  */
 export class EmailCompiler {
 
+  /**
+   * Watch folders as needed
+   */
+  static async #watchFolders(folders: string[], handler: (ev: WatchEvent) => void, signal: AbortSignal): Promise<void> {
+    const lib = await import('@parcel/watcher');
+    for (const src of folders) {
+      const cleanup = await lib.subscribe(src, async (err, events) => {
+        for (const ev of events) {
+          handler({ action: ev.type, file: path.toPosix(ev.path), folder: src });
+        }
+      });
+      signal.addEventListener('abort', () => cleanup.unsubscribe());
+    }
+  }
+
   /** Load Template */
   static async loadTemplate(file: string): Promise<EmailCompileContext> {
     const entry = RootIndex.getEntry(file);
@@ -22,25 +40,13 @@ export class EmailCompiler {
     }
     const root = (await import(entry.outputFile)).default;
     const og: EmailCompileSource = await root.wrap();
-    const res = {
+    const res: EmailCompileContext = {
       file: entry.sourceFile,
       module: entry.module,
+      images: {},
+      styles: {},
       ...og
     };
-
-    const mod = RootIndex.getModule(entry.module)!;
-
-    const resourcePaths = [
-      path.resolve(mod.sourcePath, 'resources'),
-      path.resolve(RootIndex.manifest.workspacePath, 'resources')
-    ];
-
-    const styles = res.styles ??= {};
-    (styles.search ??= []).push(...resourcePaths);
-
-    const images = res.images ??= {};
-    (images.search ??= []).push(...resourcePaths);
-
     return res;
   }
 
@@ -106,7 +112,6 @@ export class EmailCompiler {
     return keys;
   }
 
-
   /**
    * Watch compilation
    */
@@ -118,14 +123,20 @@ export class EmailCompiler {
       )].map(x => path.resolve(RootIndex.getModule(x)!.sourcePath, 'resources'))
     );
 
-    const stream = all.watchFiles();
+    const ctrl = new AbortController();
+    const stream = new Queue<WatchEvent>([], ctrl.signal);
 
+    // watch resources
+    this.#watchFolders(all.paths, ev => stream.add(ev), ctrl.signal);
+
+    // Watch template files
     DynamicFileLoader.onLoadEvent((ev) => {
       const src = RootIndex.getEntry(ev.file);
       if (src && EmailCompileUtil.isTemplateFile(src.sourceFile)) {
         stream.add({ ...ev, file: src.sourceFile });
       }
     });
+
     for await (const { file, action } of stream) {
       if (action === 'delete') {
         continue;

package/src/util.ts

@@ -137,11 +137,11 @@ export class EmailCompileUtil {
   static async inlineImages(html: string, opts: EmailTemplateImageConfig): Promise<string> {
     const { tokens, finalize } = await this.tokenizeResources(html, this.#HTML_CSS_IMAGE_URLS);
     const pendingImages: [token: string, ext: string, stream: Readable | Promise<Readable>][] = [];
-    const resources = new FileResourceProvider(opts.search ?? []);
+    const resource = new FileResourceProvider({ includeCommon: true, paths: opts.search ?? [] });
 
     for (const [token, src] of tokens) {
       const ext = path.extname(src);
-      const stream = await resources.readStream(src);
+      const stream = await resource.readStream(src);
       pendingImages.push([token, ext, /^[.](jpe?g|png)$/.test(ext) ?
         ImageConverter.optimize(ext === '.png' ? 'png' : 'jpeg', stream) : stream]);
     }
@@ -183,7 +183,7 @@ export class EmailCompileUtil {
       styles.push(opts.global);
     }
 
-    const resource = new FileResourceProvider(opts.search ?? []);
+    const resource = new FileResourceProvider({ includeCommon: true, paths: opts.search ?? [] });
     const main = await resource.read('/email/main.scss').then(d => d, () => '');
 
     if (main) {
@@ -191,9 +191,7 @@ export class EmailCompileUtil {
     }
 
     if (styles.length) {
-      const compiled = await this.compileSass(
-        { data: styles.join('\n') },
-        [...opts.search ?? []]);
+      const compiled = await this.compileSass({ data: styles.join('\n') }, resource.paths);
 
       // Remove all unused styles
       const finalStyles = await this.pruneCss(html, compiled);

package/support/cli.email_editor.ts

@@ -1,5 +1,5 @@
 import { GlobalEnvConfig } from '@travetto/base';
-import { CliCommand } from '@travetto/cli';
+import { CliCommand, CliUtil } from '@travetto/cli';
 import { RootRegistry } from '@travetto/registry';
 
 import { EditorState } from './bin/editor';
@@ -18,6 +18,9 @@ export class EmailEditorCommand {
   }
 
   async main(): Promise<void> {
+    if (await CliUtil.runWithRestart(this)) {
+      return;
+    }
     await RootRegistry.init();
     await new EditorState(await EmailCompilationManager.createInstance()).init();
   }