@travetto/registry 5.0.0-rc.1 → 5.0.0-rc.10

package/README.md

@@ -27,7 +27,7 @@ This flow ensures all files are loaded and processed before application starts.
 
 **Code: Sample Registry**
 ```typescript
-import { Class } from '@travetto/base';
+import { Class } from '@travetto/runtime';
 import { MetadataRegistry } from '@travetto/registry';
 
 interface Group {
@@ -82,47 +82,43 @@ As mentioned in [Manifest](https://github.com/travetto/travetto/tree/main/module
 **Code: Sample Class Diffing**
 ```typescript
 
-#handleFileChanges(file: string, classes: Class[] = []): void {
+#handleFileChanges(importFile: string, classes: Class[] = []): number {
     const next = new Map<string, Class>(classes.map(cls => [cls.Ⲑid, cls] as const));
 
     let prev = new Map<string, Class>();
-    if (this.#classes.has(file)) {
-      prev = new Map(this.#classes.get(file)!.entries());
+    if (this.#classes.has(importFile)) {
+      prev = new Map(this.#classes.get(importFile)!.entries());
     }
 
     const keys = new Set([...Array.from(prev.keys()), ...Array.from(next.keys())]);
 
-    if (!this.#classes.has(file)) {
-      this.#classes.set(file, new Map());
+    if (!this.#classes.has(importFile)) {
+      this.#classes.set(importFile, new Map());
     }
 
     let changes = 0;
 
-    /**
-     * Determine delta based on the various classes (if being added, removed or updated)
-     */
+    // Determine delta based on the various classes (if being added, removed or updated)
     for (const k of keys) {
       if (!next.has(k)) {
         changes += 1;
         this.emit({ type: 'removing', prev: prev.get(k)! });
-        this.#classes.get(file)!.delete(k);
+        this.#classes.get(importFile)!.delete(k);
       } else {
-        this.#classes.get(file)!.set(k, next.get(k)!);
+        this.#classes.get(importFile)!.set(k, next.get(k)!);
         if (!prev.has(k)) {
           changes += 1;
           this.emit({ type: 'added', curr: next.get(k)! });
         } else {
-          const prevMeta = RuntimeIndex.getFunctionMetadataFromClass(prev.get(k));
-          const nextMeta = RuntimeIndex.getFunctionMetadataFromClass(next.get(k));
-          if (prevMeta?.hash !== nextMeta?.hash) {
+          const prevHash = describeFunction(prev.get(k)!)?.hash;
+          const nextHash = describeFunction(next.get(k)!)?.hash;
+          if (prevHash !== nextHash) {
             changes += 1;
             this.emit({ type: 'changed', curr: next.get(k)!, prev: prev.get(k) });
           }
         }
       }
     }
-    if (!changes) {
-      this.#emitter.emit('unchanged-file', file);
-    }
+    return changes;
   }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/registry",
-  "version": "5.0.0-rc.1",
+  "version": "5.0.0-rc.10",
   "description": "Patterns and utilities for handling registration of metadata and functionality for run-time use",
   "keywords": [
     "ast-transformations",
@@ -27,11 +27,11 @@
     "directory": "module/registry"
   },
   "dependencies": {
-    "@travetto/base": "^5.0.0-rc.1"
+    "@travetto/runtime": "^5.0.0-rc.10"
   },
   "peerDependencies": {
-    "@travetto/cli": "^5.0.0-rc.1",
-    "@travetto/transformer": "^5.0.0-rc.0"
+    "@travetto/cli": "^5.0.0-rc.11",
+    "@travetto/transformer": "^5.0.0-rc.7"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {

package/src/internal/commonjs-loader.ts

@@ -1,7 +1,7 @@
 import { Module } from 'node:module';
 
-import { path, RuntimeIndex } from '@travetto/manifest';
-import { Env } from '@travetto/base';
+import { path } from '@travetto/manifest';
+import { Runtime, RuntimeIndex } from '@travetto/runtime';
 
 import { RetargettingProxy } from '../proxy';
 
@@ -32,7 +32,7 @@ export class DynamicCommonjsLoader {
         mod = moduleLoad.apply(null, [request, parent]);
       } catch (err: unknown) {
         const name = Module._resolveFilename!(request, parent);
-        if (err instanceof Error && Env.dynamic && !name.startsWith('test/')) {
+        if (err instanceof Error && Runtime.dynamic && !name.startsWith('test/')) {
           const errMsg = err.message;
           console.debug(`Unable to load ${name}: stubbing out with error proxy.`, errMsg);
           const e = (): never => { throw new Error(errMsg); };
@@ -62,8 +62,7 @@ export class DynamicCommonjsLoader {
     } else {
       this.#modules.get(file)!.setTarget(mod);
     }
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    return this.#modules.get(file)!.get() as T;
+    return this.#modules.get(file)!.get<T>();
   }
 
   async init(): Promise<void> {

package/src/internal/file-loader.ts

@@ -1,5 +1,5 @@
-import { ManifestModuleUtil, RuntimeIndex } from '@travetto/manifest';
-import { watchCompiler, WatchEvent, RuntimeContext } from '@travetto/base';
+import { ManifestModuleUtil } from '@travetto/manifest';
+import { watchCompiler, WatchEvent, Runtime, RuntimeIndex } from '@travetto/runtime';
 
 interface ModuleLoader {
   init?(): Promise<void>;
@@ -24,7 +24,7 @@ class $DynamicFileLoader {
       await this.#loader.unload(ev.output);
     }
     if (ev.action === 'create' || ev.action === 'delete') {
-      RuntimeIndex.reinitForModule(RuntimeContext.main.name);
+      RuntimeIndex.reinitForModule(Runtime.main.name);
     }
     if (ev.action === 'create' || ev.action === 'update') {
       await this.#loader.load(ev.output);

package/src/proxy.ts

@@ -1,6 +1,6 @@
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type ConcreteClass<T = any> = new (...args: any[]) => T;
-const ProxyTargetⲐ = Symbol.for('@travetto/base:proxy-target');
+import { Any, castKey, castTo, classConstruct } from '@travetto/runtime';
+
+const ProxyTargetⲐ = Symbol.for('@travetto/runtime:proxy-target');
 
 const AsyncGeneratorFunction = Object.getPrototypeOf(async function* () { });
 const GeneratorFunction = Object.getPrototypeOf(function* () { });
@@ -14,8 +14,7 @@ function isFunction(o: unknown): o is Function {
 /**
  * Handler for for proxying modules while watching
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export class RetargettingHandler<T> implements ProxyHandler<any> {
+export class RetargettingHandler<T> implements ProxyHandler<Any> {
   constructor(public target: T) { }
 
   isExtensible(target: T): boolean {
@@ -35,31 +34,26 @@ export class RetargettingHandler<T> implements ProxyHandler<any> {
   }
 
   apply(target: T, thisArg: T, argArray?: unknown[]): unknown {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    return (this.target as unknown as Function).apply(this.target, argArray);
+    return castTo<Function>(this.target).apply(this.target, argArray);
   }
 
   construct(target: T, argArray: unknown[], newTarget?: unknown): object {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    return new (this.target as unknown as ConcreteClass)(...argArray);
+    return classConstruct(castTo(this.target), argArray);
   }
 
   setPrototypeOf(target: T, v: unknown): boolean {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    return Object.setPrototypeOf(this.target, v as Record<string, unknown>);
+    return Object.setPrototypeOf(this.target, castTo(v));
   }
 
   getPrototypeOf(target: T): object | null {
     return Object.getPrototypeOf(this.target);
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  get(target: T, prop: PropertyKey, receiver: unknown): any {
+  get(target: T, prop: PropertyKey, receiver: unknown): Any {
     if (prop === ProxyTargetⲐ) {
       return this.target;
     }
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    let ret = this.target[prop as keyof T];
+    let ret = this.target[castKey<T>(prop)];
     if (isFunction(ret) && !/^class\s/.test(Function.prototype.toString.call(ret))) {
       // Bind class members to class instance instead of proxy propagating
       ret = ret.bind(this.target);
@@ -68,13 +62,11 @@ export class RetargettingHandler<T> implements ProxyHandler<any> {
   }
 
   has(target: T, prop: PropertyKey): boolean {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    return (this.target as Object).hasOwnProperty(prop);
+    return castTo<object>(this.target).hasOwnProperty(prop);
   }
 
   set(target: T, prop: PropertyKey, value: unknown): boolean {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/consistent-type-assertions
-    this.target[prop as keyof T] = value as any;
+    this.target[castKey<T>(prop)] = castTo(value);
     return true;
   }
 
@@ -86,8 +78,7 @@ export class RetargettingHandler<T> implements ProxyHandler<any> {
   }
 
   deleteProperty(target: T, p: PropertyKey): boolean {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    return delete this.target[p as keyof T];
+    return delete this.target[castKey<T>(p)];
   }
 
   defineProperty(target: T, p: PropertyKey, attributes: PropertyDescriptor): boolean {
@@ -107,8 +98,7 @@ export class RetargettingProxy<T> {
    * Unwrap proxy
    */
   static unwrap<U>(el: U): U {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/consistent-type-assertions
-    return (el ? ((el as any)[ProxyTargetⲐ] ?? el) : el) as U;
+    return castTo<{ [ProxyTargetⲐ]: U }>(el)?.[ProxyTargetⲐ] ?? el;
   }
 
   #handler: RetargettingHandler<T>;
@@ -116,8 +106,7 @@ export class RetargettingProxy<T> {
 
   constructor(initial: T) {
     this.#handler = new RetargettingHandler(initial);
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    this.#instance = new Proxy({}, this.#handler as ProxyHandler<object>);
+    this.#instance = new Proxy({}, castTo(this.#handler));
   }
 
   setTarget(next: T): void {
@@ -130,8 +119,7 @@ export class RetargettingProxy<T> {
     return this.#handler.target;
   }
 
-  get(): T {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    return this.#instance as T;
+  get<V extends T>(): V {
+    return castTo(this.#instance);
   }
 }

package/src/registry.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from 'node:events';
-import { Class, Env } from '@travetto/base';
+import { Class, Env } from '@travetto/runtime';
 import { ChangeSource, ChangeEvent, ChangeHandler } from './types';
 
 /**

package/src/service/metadata.ts

@@ -1,4 +1,4 @@
-import { Class } from '@travetto/base';
+import { Class } from '@travetto/runtime';
 
 import { Registry } from '../registry';
 import { ChangeEvent } from '../types';
@@ -107,8 +107,7 @@ export abstract class MetadataRegistry<C extends { class: Class }, M = unknown,
    * Find parent class for a given class object
    */
   getParentClass(cls: Class): Class | null {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const parent = Object.getPrototypeOf(cls) as Class;
+    const parent: Class = Object.getPrototypeOf(cls);
     return parent.name && parent !== Object ? parent : null;
   }
 

package/src/service/root.ts

@@ -1,4 +1,4 @@
-import { Class } from '@travetto/base';
+import { Class } from '@travetto/runtime';
 
 import { Registry } from '../registry';
 import { ClassSource } from '../source/class-source';

package/src/source/class-source.ts

@@ -1,23 +1,26 @@
 import { EventEmitter } from 'node:events';
 
-import { type FindConfig, RuntimeIndex } from '@travetto/manifest';
-import { Class, Env } from '@travetto/base';
+import { type FindConfig } from '@travetto/manifest';
+import { Class, Env, Runtime, RuntimeIndex, describeFunction, flushPendingFunctions } from '@travetto/runtime';
 
 import { DynamicFileLoader } from '../internal/file-loader';
 import { ChangeSource, ChangeEvent, ChangeHandler } from '../types';
-import { PendingRegister } from '../decorator';
 
 const moduleFindConfig: FindConfig = {
   module: (m) => {
     const role = Env.TRV_ROLE.val;
     return m.roles.includes('std') && (
-      !Env.production || m.prod ||
+      !Runtime.production || m.prod ||
       ((role === 'doc' || role === 'test') && m.roles.includes(role))
     );
   },
   folder: f => f === 'src' || f === '$index'
 };
 
+function isClass(cls: Function): cls is Class {
+  return !!describeFunction(cls).class;
+}
+
 /**
  * A class change source. Meant to be hooked into the
  * compiler as a way to listen to changes via the compiler
@@ -37,63 +40,76 @@ export class ClassSource implements ChangeSource<Class> {
    * Flush classes
    */
   #flush(): void {
-    for (const [file, classes] of PendingRegister.flush()) {
-      if (!classes || !classes.length) {
-        continue;
-      }
-      this.#classes.set(file, new Map());
-      for (const cls of classes) {
-        const src = RuntimeIndex.getFunctionMetadata(cls)!.source;
-        this.#classes.get(src)!.set(cls.Ⲑid, cls);
-        this.emit({ type: 'added', curr: cls });
+    for (const cls of flushPendingFunctions().filter(isClass)) {
+      const src = Runtime.getImport(cls);
+      if (!this.#classes.has(src)) {
+        this.#classes.set(src, new Map());
       }
+      this.#classes.get(src)!.set(cls.Ⲑid, cls);
+      this.emit({ type: 'added', curr: cls });
     }
   }
 
   /**
-   * Listen for a single file, and process all the classes within
+   * Process changes for a single file, looking for add/remove/update of classes
    */
-  #handleFileChanges(file: string, classes: Class[] = []): void {
+  #handleFileChanges(importFile: string, classes: Class[] = []): number {
     const next = new Map<string, Class>(classes.map(cls => [cls.Ⲑid, cls] as const));
 
     let prev = new Map<string, Class>();
-    if (this.#classes.has(file)) {
-      prev = new Map(this.#classes.get(file)!.entries());
+    if (this.#classes.has(importFile)) {
+      prev = new Map(this.#classes.get(importFile)!.entries());
     }
 
     const keys = new Set([...Array.from(prev.keys()), ...Array.from(next.keys())]);
 
-    if (!this.#classes.has(file)) {
-      this.#classes.set(file, new Map());
+    if (!this.#classes.has(importFile)) {
+      this.#classes.set(importFile, new Map());
     }
 
     let changes = 0;
 
-    /**
-     * Determine delta based on the various classes (if being added, removed or updated)
-     */
+    // Determine delta based on the various classes (if being added, removed or updated)
     for (const k of keys) {
       if (!next.has(k)) {
         changes += 1;
         this.emit({ type: 'removing', prev: prev.get(k)! });
-        this.#classes.get(file)!.delete(k);
+        this.#classes.get(importFile)!.delete(k);
       } else {
-        this.#classes.get(file)!.set(k, next.get(k)!);
+        this.#classes.get(importFile)!.set(k, next.get(k)!);
         if (!prev.has(k)) {
           changes += 1;
           this.emit({ type: 'added', curr: next.get(k)! });
         } else {
-          const prevMeta = RuntimeIndex.getFunctionMetadataFromClass(prev.get(k));
-          const nextMeta = RuntimeIndex.getFunctionMetadataFromClass(next.get(k));
-          if (prevMeta?.hash !== nextMeta?.hash) {
+          const prevHash = describeFunction(prev.get(k)!)?.hash;
+          const nextHash = describeFunction(next.get(k)!)?.hash;
+          if (prevHash !== nextHash) {
             changes += 1;
             this.emit({ type: 'changed', curr: next.get(k)!, prev: prev.get(k) });
           }
         }
       }
     }
-    if (!changes) {
-      this.#emitter.emit('unchanged-file', file);
+    return changes;
+  }
+
+  /**
+   * Process all class changes
+   */
+  #handleChanges(classes: Class[] = []): void {
+    const classesByFile = new Map<string, Class[]>();
+    for (const el of classes) {
+      const imp = Runtime.getImport(el);
+      if (!classesByFile.has(imp)) {
+        classesByFile.set(imp, []);
+      }
+      classesByFile.get(imp)!.push(el);
+    }
+
+    for (const [imp, els] of classesByFile.entries()) {
+      if (!this.#handleFileChanges(imp, els)) {
+        this.#emitter.emit('unchanged-import', imp);
+      }
     }
   }
 
@@ -111,11 +127,10 @@ export class ClassSource implements ChangeSource<Class> {
    * Initialize
    */
   async init(): Promise<void> {
-    if (Env.dynamic) {
+    if (Runtime.dynamic) {
       DynamicFileLoader.onLoadEvent(ev => {
-        for (const [file, classes] of PendingRegister.flush(true)) {
-          this.#handleFileChanges(file, classes);
-        }
+        this.#handleChanges(flushPendingFunctions().filter(isClass));
+
         if (ev.action === 'create') {
           this.#flush();
         }
@@ -124,8 +139,8 @@ export class ClassSource implements ChangeSource<Class> {
     }
 
     // Ensure everything is loaded
-    for (const mod of RuntimeIndex.find(moduleFindConfig)) {
-      await import(mod.import);
+    for (const entry of RuntimeIndex.find(moduleFindConfig)) {
+      await Runtime.importFrom(entry.import);
     }
 
     // Flush all load events
@@ -140,9 +155,9 @@ export class ClassSource implements ChangeSource<Class> {
   }
 
   /**
-   * Add callback for when a file is changed, but emits no class changes
+   * Add callback for when a import is changed, but emits no class changes
    */
-  onNonClassChanges(callback: (file: string) => void): void {
-    this.#emitter.on('unchanged-file', callback);
+  onNonClassChanges(callback: (imp: string) => void): void {
+    this.#emitter.on('unchanged-import', callback);
   }
 }

package/src/source/method-source.ts

@@ -1,7 +1,6 @@
 import { EventEmitter } from 'node:events';
 
-import { Class } from '@travetto/base';
-import { RuntimeIndex } from '@travetto/manifest';
+import { Class, describeFunction } from '@travetto/runtime';
 
 import { ChangeSource, ChangeEvent, ChangeHandler } from '../types';
 
@@ -30,8 +29,8 @@ export class MethodSource implements ChangeSource<[Class, Function]> {
    * On a class being emitted, check methods
    */
   onClassEvent(e: ChangeEvent<Class>): void {
-    const next = RuntimeIndex.getFunctionMetadataFromClass(e.curr!)?.methods ?? {};
-    const prev = RuntimeIndex.getFunctionMetadataFromClass(e.prev!)?.methods ?? {};
+    const next = describeFunction(e.curr!)?.methods ?? {};
+    const prev = describeFunction(e.prev!)?.methods ?? {};
 
     /**
      * Go through each method, comparing hashes.  To see added/removed and changed

package/src/decorator.ts

@@ -1,44 +0,0 @@
-import { Class } from '@travetto/base';
-import { RuntimeIndex } from '@travetto/manifest';
-
-/**
- * Register a class as pending
- */
-class $PendingRegister {
-  map = new Map<string, Class[]>();
-  ordered: [string, Class[]][] = [];
-
-  /**
-   * Register class as pending
-   */
-  add(cls: Class): void {
-    const src = RuntimeIndex.getFunctionMetadata(cls)!.source;
-    if (!this.map.has(src)) {
-      const sub: Class[] = [];
-      this.map.set(src, sub);
-      this.ordered.push([src, sub]);
-    }
-    this.map.get(src)!.push(cls);
-  }
-
-  /**
-   * Clear pending classes
-   */
-  flush(log?: boolean): [string, Class[]][] {
-    if (log) {
-      console.debug('Pending changes', { changes: this.ordered.map(([, x]) => x.map(y => y.Ⲑid)) });
-    }
-    const out = this.ordered.slice(0);
-    this.map.clear();
-    this.ordered = [];
-    return out;
-  }
-}
-
-export const PendingRegister = new $PendingRegister();
-
-/**
- * Decorator to track class as pending
- */
-export const Register = () =>
-  (target: Class): void => PendingRegister.add(target);

package/support/transformer.register.ts

@@ -1,36 +0,0 @@
-import ts from 'typescript';
-
-import { TransformerState, AfterClass, DecoratorUtil } from '@travetto/transformer';
-
-const REGISTER_MOD = '@travetto/registry/src/decorator';
-const SKIP_SRC = /^@travetto\/(base|manifest)\/(src|support)/;
-
-/**
- * Registration of all classes to support the registry
- */
-export class RegisterTransformer {
-
-  /**
-   * After visiting each class, register all the collected metadata
-   */
-  @AfterClass()
-  static registerClass(state: TransformerState, node: ts.ClassDeclaration): ts.ClassDeclaration {
-    if (
-      state.importName === REGISTER_MOD ||
-      SKIP_SRC.test(state.importName)
-    ) {  // Cannot process self
-      return node;
-    }
-
-    return state.factory.updateClassDeclaration(
-      node,
-      DecoratorUtil.spliceDecorators(
-        node, undefined, [state.createDecorator(REGISTER_MOD, 'Register')], 0
-      ),
-      node.name,
-      node.typeParameters,
-      node.heritageClauses,
-      node.members
-    );
-  }
-}