@travetto/registry 2.1.4 → 2.2.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/registry",
   "displayName": "Registry",
-  "version": "2.1.4",
+  "version": "2.2.1",
   "description": "Patterns and utilities for handling registration of metadata and functionality for run-time use",
   "keywords": [
     "ast-transformations",
@@ -28,8 +28,8 @@
     "directory": "module/registry"
   },
   "dependencies": {
-    "@travetto/compiler": "^2.1.3",
-    "@travetto/transformer": "^2.1.3"
+    "@travetto/compiler": "^2.2.1",
+    "@travetto/transformer": "^2.2.1"
   },
   "docDependencies": {
     "@travetto/di": true

package/src/decorator.ts

@@ -16,7 +16,7 @@ class $PendingRegister {
    * @param `ᚕmethods` Methods and their hashes
    * @param `ᚕabstract` Is the class abstract
    */
-  initMeta(cls: Class, ᚕfile: string, ᚕhash: number, ᚕmethods: Record<string, { hash: number }>, ᚕabstract: boolean, ᚕsynthetic: boolean) {
+  initMeta(cls: Class, ᚕfile: string, ᚕhash: number, ᚕmethods: Record<string, { hash: number }>, ᚕabstract: boolean, ᚕsynthetic: boolean): boolean {
     const meta = {
       ᚕid: ModuleUtil.getId(ᚕfile, cls.name),
       ᚕfile,
@@ -26,8 +26,8 @@ class $PendingRegister {
       ᚕsynthetic,
     };
 
-    const keys = [...Object.keys(meta)] as (keyof typeof meta)[];
-    Object.defineProperties(cls, keys.reduce((all, k) => {
+    const keys = [...Object.keys(meta)];
+    Object.defineProperties(cls, keys.reduce<Partial<Record<keyof typeof meta, PropertyDescriptor>>>((all, k) => {
       all[k] = {
         value: meta[k],
         enumerable: false,
@@ -35,7 +35,7 @@ class $PendingRegister {
         writable: false
       };
       return all;
-    }, {} as { [K in keyof typeof meta]: PropertyDescriptor }));
+    }, {}));
 
     return true;
   }
@@ -43,7 +43,7 @@ class $PendingRegister {
   /**
    * Register class as pending
    */
-  add(cls: Class) {
+  add(cls: Class): void {
     if (!this.map.has(cls.ᚕfile)) {
       const sub: Class[] = [];
       this.map.set(cls.ᚕfile, sub);
@@ -55,7 +55,7 @@ class $PendingRegister {
   /**
    * Clear pending classes
    */
-  flush() {
+  flush(): [string, Class[]][] {
     const out = this.ordered.slice(0);
     this.map.clear();
     this.ordered = [];
@@ -69,7 +69,7 @@ export const PendingRegister = new $PendingRegister();
  * Decorator to track class as pending
  */
 export function Register() {
-  return (target: Class) => PendingRegister.add(target);
+  return (target: Class): void => PendingRegister.add(target);
 }
 
 Register.initMeta = PendingRegister.initMeta;

package/src/registry.ts

@@ -53,7 +53,7 @@ export abstract class Registry implements ChangeSource<Class> {
   /**
    * Reset parents
    */
-  protected resetParents() {
+  protected resetParents(): void {
     for (const parent of this.#parents) {
       parent.reset();
     }
@@ -86,7 +86,7 @@ export abstract class Registry implements ChangeSource<Class> {
     }
   }
 
-  get resolved() {
+  get resolved(): boolean {
     return this.#resolved;
   }
 
@@ -100,7 +100,7 @@ export abstract class Registry implements ChangeSource<Class> {
   /**
    * Verify initialized state
    */
-  verifyInitialized() {
+  verifyInitialized(): void {
     if (!this.#resolved) {
       throw new Error(`${this.constructor.name} has not been initialized, you probably need to call RootRegistry.init()`);
     }
@@ -131,7 +131,7 @@ export abstract class Registry implements ChangeSource<Class> {
   /**
    * Uninstall a class or list of classes
    */
-  uninstall(classes: Class | Class[], e: ChangeEvent<Class>) {
+  uninstall(classes: Class | Class[], e: ChangeEvent<Class>): void {
     if (!Array.isArray(classes)) {
       classes = [classes];
     }
@@ -143,7 +143,7 @@ export abstract class Registry implements ChangeSource<Class> {
   /**
    * Install a class or a list of classes
    */
-  install(classes: Class | Class[], e: ChangeEvent<Class>) {
+  install(classes: Class | Class[], e: ChangeEvent<Class>): void {
     if (!Array.isArray(classes)) {
       classes = [classes];
     }
@@ -155,7 +155,7 @@ export abstract class Registry implements ChangeSource<Class> {
   /**
    * Listen for events from the parent
    */
-  onEvent(event: ChangeEvent<Class>) {
+  onEvent(event: ChangeEvent<Class>): void {
     console.debug('Received', { id: this.constructor.ᚕid, type: event.type, targetId: (event.curr ?? event.prev)!.ᚕid });
 
     switch (event.type) {
@@ -177,7 +177,7 @@ export abstract class Registry implements ChangeSource<Class> {
   /**
    * Emit a new event
    */
-  emit(e: ChangeEvent<Class>) {
+  emit(e: ChangeEvent<Class>): void {
     this.#emitter.emit('change', e);
   }
 
@@ -191,28 +191,28 @@ export abstract class Registry implements ChangeSource<Class> {
   /**
    * Remove listeners
    */
-  off<T>(callback: ChangeHandler<Class<T>>) {
+  off<T>(callback: ChangeHandler<Class<T>>): void {
     this.#emitter.off('change', callback);
   }
 
   /**
    * Connect changes sources
    */
-  listen(source: ChangeSource<Class>) {
+  listen(source: ChangeSource<Class>): void {
     source.on(e => this.onEvent(e));
   }
 
   /**
    * On registry reset
    */
-  onReset() {
+  onReset(): void {
     this.#resolved = false;
   }
 
   /**
    * Reset entire registry
    */
-  reset() {
+  reset(): void {
     this.onReset();
     for (const des of this.#dependents) {
       des.reset();

package/src/service/metadata.ts

@@ -39,7 +39,7 @@ export abstract class MetadataRegistry<C extends { class: Class }, M = unknown,
   /**
    * Code to call when uninstall is finalized
    */
-  onUninstallFinalize<T>(cls: Class<T>) {
+  onUninstallFinalize<T>(cls: Class<T>): void {
 
   }
 
@@ -51,7 +51,7 @@ export abstract class MetadataRegistry<C extends { class: Class }, M = unknown,
   /**
    * Is class found by id or by Class
    */
-  has(cls: string | Class) {
+  has(cls: string | Class): boolean {
     return this.entries.has(id(cls));
   }
 
@@ -72,21 +72,21 @@ export abstract class MetadataRegistry<C extends { class: Class }, M = unknown,
   /**
    * Is there a class that is expiring
    */
-  hasExpired(cls: string | Class) {
+  hasExpired(cls: string | Class): boolean {
     return this.expired.has(id(cls));
   }
 
   /**
    * Is there a pending state for the class
    */
-  hasPending(cls: string | Class) {
+  hasPending(cls: string | Class): boolean {
     return this.pending.has(id(cls));
   }
 
   /**
    * Get list of all classes that have been registered
    */
-  getClasses() {
+  getClasses(): Class[] {
     return Array.from(this.entries.values()).map(x => x.class);
   }
 
@@ -94,7 +94,7 @@ export abstract class MetadataRegistry<C extends { class: Class }, M = unknown,
    * Trigger initial install, moves pending to finalized (active)
    */
   override initialInstall(): Class[] {
-    return Array.from(this.pending.values()).map(x => x.class as Class).filter(x => !!x);
+    return Array.from(this.pending.values()).map(x => x.class).filter((x): x is Class => !!x);
   }
 
   /**
@@ -108,6 +108,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;
     return parent.name && parent !== Object ? parent : null;
   }
@@ -139,7 +140,7 @@ export abstract class MetadataRegistry<C extends { class: Class }, M = unknown,
   /**
    * Register a pending class, with partial config to overlay
    */
-  register(cls: Class, pConfig: Partial<C> = {}) {
+  register(cls: Class, pConfig: Partial<C> = {}): void {
     const conf = this.getOrCreatePending(cls);
     Util.deepAssign(conf, pConfig);
   }
@@ -147,7 +148,7 @@ export abstract class MetadataRegistry<C extends { class: Class }, M = unknown,
   /**
    * Register a pending field, with partial config to overlay
    */
-  registerField(cls: Class, field: F, pConfig: Partial<M>) {
+  registerField(cls: Class, field: F, pConfig: Partial<M>): void {
     const conf = this.getOrCreatePendingField(cls, field);
     Util.deepAssign(conf, pConfig);
   }
@@ -155,7 +156,7 @@ export abstract class MetadataRegistry<C extends { class: Class }, M = unknown,
   /**
    * On an install event, finalize
    */
-  onInstall(cls: Class, e: ChangeEvent<Class>) {
+  onInstall(cls: Class, e: ChangeEvent<Class>): void {
     if (this.pending.has(cls.ᚕid) || this.pendingFields.has(cls.ᚕid)) {
       console.debug('Installing', { service: this.constructor.name, id: cls.ᚕid });
       const result = this.onInstallFinalize(cls);
@@ -170,7 +171,7 @@ export abstract class MetadataRegistry<C extends { class: Class }, M = unknown,
   /**
    * On an uninstall event, remove
    */
-  onUninstall(cls: Class, e: ChangeEvent<Class>) {
+  onUninstall(cls: Class, e: ChangeEvent<Class>): void {
     if (this.entries.has(cls.ᚕid)) {
       console.debug('Uninstalling', { service: this.constructor.name, id: cls.ᚕid });
       this.expired.set(cls.ᚕid, this.entries.get(cls.ᚕid)!);
@@ -186,7 +187,7 @@ export abstract class MetadataRegistry<C extends { class: Class }, M = unknown,
   /**
    * Clear all caches
    */
-  override onReset() {
+  override onReset(): void {
     super.onReset();
     this.entries.clear();
     this.pending.clear();

package/src/service/root.ts

@@ -15,7 +15,7 @@ class $RootRegistry extends Registry {
   /**
    * Send event to all all of the children
    */
-  override async onEvent(e: ChangeEvent<Class>) {
+  override async onEvent(e: ChangeEvent<Class>): Promise<void> {
     await super.onEvent(e); // Process event, and
     this.emit(e); // Send to children
   }
@@ -23,7 +23,7 @@ class $RootRegistry extends Registry {
   /**
    * Reset self and parents
    */
-  override onReset() {
+  override onReset(): void {
     this.resetParents();
   }
 }

package/src/source/class-source.ts

@@ -25,7 +25,7 @@ export class ClassSource implements ChangeSource<Class> {
   /**
    * Flush classes
    */
-  #flush() {
+  #flush(): void {
     for (const [file, classes] of PendingRegister.flush()) {
       if (!classes || !classes.length) {
         continue;
@@ -41,8 +41,8 @@ export class ClassSource implements ChangeSource<Class> {
   /**
    * Listen for a single file, and process all the classes within
    */
-  async #handleFileChanges(file: string, classes: Class[] = []) {
-    const next = new Map(classes.map(cls => [cls.ᚕid, cls] as [string, Class]));
+  async #handleFileChanges(file: string, classes: Class[] = []): Promise<void> {
+    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)) {
@@ -76,7 +76,7 @@ export class ClassSource implements ChangeSource<Class> {
   /**
    * Flush all pending classes
    */
-  processFiles() {
+  processFiles(): void {
     console.debug('Pending changes', { changes: PendingRegister.ordered.map(([, x]) => x.map(y => y.ᚕid)) });
     for (const [file, classes] of PendingRegister.flush()) {
       this.#handleFileChanges(file, classes);
@@ -86,7 +86,7 @@ export class ClassSource implements ChangeSource<Class> {
   /**
    * Emit a change event
    */
-  emit(e: ChangeEvent<Class>) {
+  emit(e: ChangeEvent<Class>): void {
     console.debug('Emitting change', { type: e.type, curr: e.curr?.ᚕid, prev: e.prev?.ᚕid });
     this.#emitter.emit('change', e);
   }
@@ -94,14 +94,14 @@ export class ClassSource implements ChangeSource<Class> {
   /**
    * Clear all classes
    */
-  reset() {
+  reset(): void {
     this.#classes.clear();
   }
 
   /**
    * Initialize
    */
-  async init() {
+  async init(): Promise<void> {
     this.#flush();
   }
 

package/src/source/method-source.ts

@@ -17,16 +17,16 @@ export class MethodSource implements ChangeSource<[Class, Function]> {
     classSource.on(e => this.onClassEvent(e));
   }
 
-  async init() { }
+  async init(): Promise<void> { }
 
-  emit(ev: ChangeEvent<[Class, Function]>) {
+  emit(ev: ChangeEvent<[Class, Function]>): void {
     this.#emitter.emit('change', ev);
   }
 
   /**
    * On a class being emitted, check methods
    */
-  onClassEvent(e: ChangeEvent<Class>) {
+  onClassEvent(e: ChangeEvent<Class>): void {
     const next = e.curr?.ᚕmethods ?? {};
     const prev = e.prev?.ᚕmethods ?? {};
 

package/support/phase.init.ts

@@ -4,7 +4,7 @@
 export const init = {
   key: '@trv:registry/init',
   after: ['@trv:base/load'],
-  action: async () => {
+  action: async (): Promise<unknown> => {
     const { RootRegistry } = await import('../src/service/root');
     return RootRegistry.init();
   }

package/support/phase.reset.ts

@@ -4,7 +4,7 @@
 export const init = {
   key: '@trv:registry/reset',
   before: ['@trv:compiler/reset'],
-  action: async () => {
+  action: async (): Promise<void> => {
     const { RootRegistry } = await import('../src/service/root');
     await RootRegistry.reset();
   }

package/support/transformer.class-metadata.ts

@@ -29,7 +29,7 @@ export class RegisterTransformer {
    * Hash each class
    */
   @OnClass()
-  static preprocessClass(state: TransformerState & RegisterInfo, node: ts.ClassDeclaration) {
+  static preprocessClass(state: TransformerState & RegisterInfo, node: ts.ClassDeclaration): ts.ClassDeclaration {
     state[cls] = SystemUtil.naiveHash(node.getText());
     return node;
   }
@@ -38,7 +38,7 @@ export class RegisterTransformer {
    * Hash each method
    */
   @OnMethod()
-  static processMethod(state: TransformerState & RegisterInfo, node: ts.MethodDeclaration) {
+  static processMethod(state: TransformerState & RegisterInfo, node: ts.MethodDeclaration): ts.MethodDeclaration {
     if (ts.isIdentifier(node.name) && !CoreUtil.isAbstract(node) && ts.isClassDeclaration(node.parent)) {
       const hash = SystemUtil.naiveHash(node.getText());
       const conf = { hash };
@@ -52,7 +52,7 @@ export class RegisterTransformer {
    * After visiting each class, register all the collected metadata
    */
   @AfterClass()
-  static registerClass(state: TransformerState & RegisterInfo, node: ts.ClassDeclaration) {
+  static registerClass(state: TransformerState & RegisterInfo, node: ts.ClassDeclaration): ts.ClassDeclaration {
     if (state.module === REGISTER_MOD) {  // Cannot process self
       return node;
     }
@@ -96,7 +96,7 @@ export class RegisterTransformer {
    * Give proper functions a file name
    */
   @AfterFunction()
-  static registerFunction(state: TransformerState & RegisterInfo, node: ts.FunctionDeclaration | ts.FunctionExpression) {
+  static registerFunction(state: TransformerState & RegisterInfo, node: ts.FunctionDeclaration | ts.FunctionExpression): typeof node {
     if (!ts.isFunctionDeclaration(node)) {
       return node;
     }