@travetto/email-compiler 3.4.5 → 4.0.0-rc.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/email-compiler",
-  "version": "3.4.5",
+  "version": "4.0.0-rc.0",
   "description": "Email compiling module",
   "keywords": [
     "email",
@@ -26,12 +26,12 @@
     "directory": "module/email-compiler"
   },
   "dependencies": {
-    "@travetto/base": "^3.4.2",
-    "@travetto/config": "^3.4.4",
-    "@travetto/di": "^3.4.2",
-    "@travetto/email": "^3.4.4",
-    "@travetto/image": "^3.4.3",
-    "@travetto/worker": "^3.4.2",
+    "@travetto/base": "^4.0.0-rc.0",
+    "@travetto/config": "^4.0.0-rc.0",
+    "@travetto/di": "^4.0.0-rc.0",
+    "@travetto/email": "^4.0.0-rc.0",
+    "@travetto/image": "^4.0.0-rc.0",
+    "@travetto/worker": "^4.0.0-rc.0",
     "@types/inline-css": "^3.0.3",
     "html-entities": "^2.4.0",
     "inline-css": "^4.0.2",
@@ -39,7 +39,7 @@
     "sass": "^1.69.5"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.4.7"
+    "@travetto/cli": "^4.0.0-rc.0"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/compiler.ts

@@ -1,16 +1,14 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 
-import { CompilerClient, TypedObject } from '@travetto/base';
+import { FileLoader, TypedObject, WatchEvent, watchCompiler } from '@travetto/base';
 import { EmailCompileSource, EmailCompiled, EmailCompileContext, MailUtil } from '@travetto/email';
-import { RootIndex, path } from '@travetto/manifest';
-import { ManualAsyncIterator as Queue } from '@travetto/worker';
+import { RuntimeIndex, path } from '@travetto/manifest';
+import { WorkQueue } 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
  */
@@ -20,20 +18,23 @@ 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 });
+      (async (): Promise<void> => {
+        for await (const ev of fs.watch(src, {
+          recursive: true,
+          signal,
+          persistent: false
+        })) {
+          const exists = ev.filename ? await fs.stat(ev.filename).catch(() => false) : false;
+          handler({ action: !!exists ? 'create' : 'delete', file: path.toPosix(ev.filename!), folder: src });
         }
-      });
-      signal.addEventListener('abort', () => cleanup.unsubscribe());
+      })();
     }
   }
 
   /** Load Template */
   static async loadTemplate(file: string): Promise<EmailCompileContext> {
-    const entry = RootIndex.getEntry(file);
+    const entry = RuntimeIndex.getEntry(file);
     if (!entry) {
       throw new Error(`Unable to find template for ${file}`);
     }
@@ -53,7 +54,7 @@ export class EmailCompiler {
    * Grab list of all available templates
    */
   static findAllTemplates(mod?: string): string[] {
-    return RootIndex
+    return RuntimeIndex
       .find({
         module: m => !mod ? m.roles.includes('std') : mod === m.name,
         folder: f => f === 'support',
@@ -66,8 +67,8 @@ export class EmailCompiler {
    * Get output files
    */
   static getOutputFiles(file: string): EmailCompiled {
-    const entry = RootIndex.getEntry(file)!;
-    const mod = RootIndex.getModule(entry.module)!;
+    const entry = RuntimeIndex.getEntry(file)!;
+    const mod = RuntimeIndex.getModule(entry.module)!;
     return EmailCompileUtil.getOutputs(file, path.join(mod.sourcePath, 'resources'));
   }
 
@@ -118,29 +119,23 @@ export class EmailCompiler {
    * Watch compilation
    */
   static async * watchCompile(): AsyncIterable<string> {
-    const all = this.findAllTemplates()
-      .map(x => RootIndex.resolveModulePath(`${RootIndex.getEntry(x)!.module}#resources`))
-      .reduce<{ set: Set<string>, arr: string[] }>((a, v) => {
-        if (!a.set.has(v)) {
-          a.set.add(v);
-          a.arr.push(v);
-        }
-        return a;
-      }, { set: new Set(), arr: [] }).arr;
+    const all = FileLoader.resolvePaths(
+      this.findAllTemplates().map(x => `${RuntimeIndex.getEntry(x)!.module}#resources`)
+    );
 
     const ctrl = new AbortController();
-    const stream = new Queue<WatchEvent>([], ctrl.signal);
+    const stream = new WorkQueue<WatchEvent>([], ctrl.signal);
 
     // watch resources
     this.#watchFolders(all, ev => stream.add(ev), ctrl.signal);
 
     // Watch template files
-    new CompilerClient().onFileChange(ev => {
-      const src = RootIndex.getEntry(ev.file);
+    watchCompiler(ev => {
+      const src = RuntimeIndex.getEntry(ev.file);
       if (src && EmailCompileUtil.isTemplateFile(src.sourceFile)) {
         setTimeout(() => stream.add({ ...ev, file: src.sourceFile }), 100); // Wait for it to be loaded
       }
-    });
+    }, { signal: ctrl.signal });
 
     for await (const { file, action } of stream) {
       if (action === 'delete') {
@@ -154,7 +149,7 @@ export class EmailCompiler {
           yield file;
         } else if (VALID_FILE(file)) {
           const rootFile = file.replace(/\/resources.*/, '/package.json');
-          const mod = RootIndex.getFromSource(rootFile)!.module;
+          const mod = RuntimeIndex.getFromSource(rootFile)!.module;
           const changed = await this.compileAll(mod);
           console.log(`Successfully compiled ${changed.length} templates`, { changed, file });
           yield* changed;

package/src/util.ts

@@ -1,5 +1,5 @@
-import util from 'util';
-import { Readable } from 'stream';
+import util from 'node:util';
+import { Readable } from 'node:stream';
 
 import { ResourceLoader, StreamUtil } from '@travetto/base';
 import {
@@ -80,12 +80,12 @@ export class EmailCompileUtil {
   /**
    * Compile SCSS content with roots as search paths for additional assets
    */
-  static async compileSass(src: { data: string } | { file: string }, roots: string[]): Promise<string> {
+  static async compileSass(src: { data: string } | { file: string }, roots: string[] | readonly string[]): Promise<string> {
     const sass = await import('sass');
     const result = await util.promisify(sass.render)({
       ...src,
       sourceMap: false,
-      includePaths: roots
+      includePaths: roots.slice(0)
     });
     return result!.css.toString();
   }

package/support/bin/config.ts

@@ -1,6 +1,6 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 
-import { IndexedModule, RootIndex, path } from '@travetto/manifest';
+import { IndexedModule, RuntimeIndex, path } from '@travetto/manifest';
 import { YamlUtil } from '@travetto/yaml';
 
 interface ConfigType {
@@ -40,7 +40,7 @@ export class $EditorConfig {
   };
 
   #getEmailConfig(mod: IndexedModule): string {
-    return this.#configFile[mod.name] ??= path.resolve(mod.sourcePath, 'resources/email/dev.yml');
+    return this.#configFile[mod.name] ??= path.resolve(mod.sourcePath, 'resources/email/local.yml');
   }
 
   /**
@@ -48,7 +48,7 @@ export class $EditorConfig {
    */
   async get(file: string): Promise<ConfigType> {
     try {
-      const mod = RootIndex.getModuleFromSource(file)!;
+      const mod = RuntimeIndex.getModuleFromSource(file)!;
       const resolved = this.#getEmailConfig(mod);
       const content = await fs.readFile(resolved, 'utf8');
       return YamlUtil.parse<ConfigType>(content);
@@ -74,7 +74,7 @@ export class $EditorConfig {
 
   async ensureConfig(file: string): Promise<string> {
     console.log('Ensuring config', file);
-    const mod = RootIndex.getModuleFromSource(file)!;
+    const mod = RuntimeIndex.getModuleFromSource(file)!;
     const resolved = this.#getEmailConfig(mod);
     if (!(await fs.stat(resolved).catch(() => { }))) {
       await fs.mkdir(path.dirname(resolved), { recursive: true });

package/support/bin/editor.ts

@@ -1,4 +1,4 @@
-import { ShutdownManager } from '@travetto/base';
+import { ExecUtil } from '@travetto/base';
 
 import { EmailCompilationManager } from './manager';
 import { EditorSendService } from './send';
@@ -54,8 +54,8 @@ export class EditorState {
   }
 
   response(response: OutboundMessage): void {
-    if (process.send) {
-      process.send(response);
+    if (process.connected) {
+      process.send?.(response);
     }
   }
 
@@ -108,7 +108,7 @@ export class EditorState {
       }
     });
 
-    process.on('disconnect', () => ShutdownManager.execute());
+    ExecUtil.exitOnDisconnect();
     process.send?.('ready');
 
     for await (const f of EmailCompiler.watchCompile()) {

package/support/bin/manager.ts

@@ -1,4 +1,4 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 
 import { type MailInterpolator, type EmailCompiled } from '@travetto/email';
 import { DependencyRegistry } from '@travetto/di';

package/support/bin/send.ts

@@ -3,7 +3,7 @@ import { MailTransportTarget } from '@travetto/email/src/internal/types';
 import { DependencyRegistry } from '@travetto/di';
 
 import { EditorConfig } from './config';
-import { RootIndex } from '@travetto/manifest';
+import { RuntimeIndex } from '@travetto/manifest';
 
 /**
  * Util for sending emails
@@ -16,7 +16,7 @@ export class EditorSendService {
    * Get mail service
    */
   static async getMailService(file: string): Promise<MailService> {
-    const mod = RootIndex.getModuleFromSource(file)!.name;
+    const mod = RuntimeIndex.getModuleFromSource(file)!.name;
 
     if (!this.#svc[mod]) {
       const senderConfig = await EditorConfig.getSenderConfig(file);
@@ -34,7 +34,7 @@ export class EditorSendService {
         DependencyRegistry.install(cls, { curr: cls, type: 'added' });
       } else if (!DependencyRegistry.getCandidateTypes(MailTransportTarget).length) {
         const errorMessage = `
-Please configure your email setup and/or credentials for testing. In the file \`email/dev.yml\`, you can specify \`sender\` configuration.
+Please configure your email setup and/or credentials for testing. In the file \`email/local.yml\`, you can specify \`sender\` configuration.
 Email sending will not work until the above is fixed. A sample configuration would look like:     
 
 ${EditorConfig.getDefaultConfig()}`.trim();

package/support/cli.email_compile.ts

@@ -1,6 +1,6 @@
 import { RootRegistry } from '@travetto/registry';
 import { CliCommandShape, CliCommand, cliTpl } from '@travetto/cli';
-import { Env, defineEnv } from '@travetto/base';
+import { Env } from '@travetto/base';
 
 import { EmailCompiler } from '../src/compiler';
 
@@ -14,8 +14,8 @@ export class EmailCompileCommand implements CliCommandShape {
   watch?: boolean;
 
   preMain(): void {
-    Env.addToList('TRV_PROFILES', 'email-dev');
-    defineEnv({ debug: false, dynamic: this.watch });
+    Env.DEBUG.set(false);
+    Env.TRV_DYNAMIC.set(this.watch);
   }
 
   async main(): Promise<void> {

package/support/cli.email_editor.ts

@@ -1,4 +1,4 @@
-import { Env, defineEnv } from '@travetto/base';
+import { Env } from '@travetto/base';
 import { CliCommand, CliUtil } from '@travetto/cli';
 import { RootRegistry } from '@travetto/registry';
 
@@ -6,12 +6,11 @@ import { EditorState } from './bin/editor';
 import { EmailCompilationManager } from './bin/manager';
 
 /** The email editor compilation service and output serving */
-@CliCommand()
+@CliCommand({ addEnv: true })
 export class EmailEditorCommand {
 
   preMain(): void {
-    Env.addToList('TRV_PROFILES', 'email-dev');
-    defineEnv({ envName: 'dev', dynamic: true });
+    Env.TRV_DYNAMIC.set(true);
   }
 
   async main(): Promise<void> {

package/support/cli.email_test.ts

@@ -1,7 +1,6 @@
 import { path } from '@travetto/manifest';
 import { RootRegistry } from '@travetto/registry';
 import { CliCommandShape, CliCommand } from '@travetto/cli';
-import { Env, defineEnv } from '@travetto/base';
 
 import { EmailCompilationManager } from './bin/manager';
 import { EditorConfig } from './bin/config';
@@ -12,14 +11,9 @@ import { EmailCompiler } from '../src/compiler';
 /**
  * CLI Entry point for running the email server
  */
-@CliCommand()
+@CliCommand({ addEnv: true })
 export class EmailTestCommand implements CliCommandShape {
 
-  preMain(): void {
-    Env.addToList('TRV_PROFILES', 'email-dev');
-    defineEnv({ envName: 'dev' });
-  }
-
   async main(file: string, to: string): Promise<void> {
     file = path.resolve(file);
     await RootRegistry.init();