@navios/commander 0.8.0 → 1.0.0-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@navios/commander",
-  "version": "0.8.0",
+  "version": "1.0.0-alpha.2",
   "author": {
     "name": "Oleksandr Hanzha",
     "email": "alex@granted.name"
@@ -35,6 +35,6 @@
     "zod": "^4.2.1"
   },
   "dependencies": {
-    "@navios/di": "^0.8.0"
+    "@navios/di": "^0.9.2"
   }
 }

package/src/decorators/cli-module.decorator.mts

@@ -1,4 +1,4 @@
-import type { ClassType } from '@navios/core'
+import type { ClassType, Registry } from '@navios/core'
 
 import { Injectable, InjectableScope, InjectionToken } from '@navios/core'
 
@@ -20,6 +20,23 @@ export interface CliModuleOptions {
    * Imported modules' commands will be available in this module.
    */
   imports?: ClassType[] | Set<ClassType>
+  /**
+   * Service override classes to import for side effects.
+   * These classes are imported to ensure their @Injectable decorators execute,
+   * allowing them to register with the DI system. Overrides should use the same
+   * InjectionToken as the original service with a higher priority.
+   */
+  overrides?: ClassType[] | Set<ClassType>
+  /**
+   * Priority level for the module.
+   * Higher priority modules will be loaded first.
+   */
+  priority?: number
+  /**
+   * Registry to use for the module.
+   * Registry is used to store the module and its commands.
+   */
+  registry?: Registry
 }
 
 /**
@@ -45,9 +62,16 @@ export interface CliModuleOptions {
  * ```
  */
 export function CliModule(
-  { commands = [], imports = [] }: CliModuleOptions = {
+  {
+    commands = [],
+    imports = [],
+    overrides = [],
+    priority,
+    registry,
+  }: CliModuleOptions = {
     commands: [],
     imports: [],
+    overrides: [],
   },
 ) {
   return (target: ClassType, context: ClassDecoratorContext) => {
@@ -65,10 +89,15 @@ export function CliModule(
     for (const importedModule of imports) {
       moduleMetadata.imports.add(importedModule)
     }
+    for (const override of overrides) {
+      moduleMetadata.overrides.add(override)
+    }
 
     return Injectable({
       token,
       scope: InjectableScope.Singleton,
+      priority,
+      registry,
     })(target, context)
   }
 }

package/src/decorators/command.decorator.mts

@@ -1,4 +1,4 @@
-import type { ClassType } from '@navios/core'
+import type { ClassType, Registry } from '@navios/core'
 import type { ZodObject } from 'zod'
 
 import { Injectable, InjectableScope, InjectionToken } from '@navios/core'
@@ -21,6 +21,16 @@ export interface CommandOptions {
    * If provided, options will be validated and parsed according to this schema.
    */
   optionsSchema?: ZodObject
+  /**
+   * Priority level for the command.
+   * Higher priority commands will be loaded first.
+   */
+  priority?: number
+  /**
+   * Registry to use for the command.
+   * Registry is used to store the command and its options schema.
+   */
+  registry?: Registry
 }
 
 /**
@@ -53,7 +63,12 @@ export interface CommandOptions {
  * }
  * ```
  */
-export function Command({ path, optionsSchema }: CommandOptions) {
+export function Command({
+  path,
+  optionsSchema,
+  priority,
+  registry,
+}: CommandOptions) {
   return function (target: ClassType, context: ClassDecoratorContext) {
     if (context.kind !== 'class') {
       throw new Error(
@@ -67,6 +82,8 @@ export function Command({ path, optionsSchema }: CommandOptions) {
     return Injectable({
       token,
       scope: InjectableScope.Singleton,
+      priority,
+      registry,
     })(target, context)
   }
 }

package/src/metadata/cli-module.metadata.mts

@@ -20,6 +20,10 @@ export interface CliModuleMetadata {
    * Set of other modules imported by this module.
    */
   imports: Set<ClassType>
+  /**
+   * Set of service override classes imported for side effects.
+   */
+  overrides: Set<ClassType>
   /**
    * Map of custom attributes that can be attached to the module.
    */
@@ -48,6 +52,7 @@ export function getCliModuleMetadata(
       const newMetadata: CliModuleMetadata = {
         commands: new Set<ClassType>(),
         imports: new Set<ClassType>(),
+        overrides: new Set<ClassType>(),
         customAttributes: new Map<string | symbol, any>(),
       }
       context.metadata[CliModuleMetadataKey] = newMetadata

package/src/services/module-loader.service.mts

@@ -1,6 +1,12 @@
 import type { ClassTypeWithInstance, NaviosModule } from '@navios/core'
 
-import { Container, inject, Injectable } from '@navios/core'
+import {
+  Container,
+  getInjectableToken,
+  inject,
+  Injectable,
+  Logger,
+} from '@navios/core'
 
 import type { CommandHandler } from '../interfaces/index.mjs'
 import type { CliModuleMetadata, CommandMetadata } from '../metadata/index.mjs'
@@ -36,6 +42,9 @@ export interface CommandWithMetadata {
  */
 @Injectable()
 export class CliModuleLoaderService {
+  private logger = inject(Logger, {
+    context: CliModuleLoaderService.name,
+  })
   protected container = inject(Container)
   private modulesMetadata: Map<string, CliModuleMetadata> = new Map()
   private loadedModules: Map<string, any> = new Map()
@@ -65,7 +74,8 @@ export class CliModuleLoaderService {
     if (parentMetadata) {
       this.mergeMetadata(metadata, parentMetadata)
     }
-    const moduleName = module.name
+    const moduleToken = getInjectableToken(module)
+    const moduleName = moduleToken.id
     if (this.modulesMetadata.has(moduleName)) {
       return
     }
@@ -85,6 +95,7 @@ export class CliModuleLoaderService {
       this.traverseModules(importedModule, metadata),
     )
     await Promise.all(loadingPromises)
+    this.validateOverrides(metadata, moduleName)
     const instance = await this.container.get(module)
     if (instance.onModuleInit) {
       await instance.onModuleInit()
@@ -92,6 +103,67 @@ export class CliModuleLoaderService {
     this.loadedModules.set(moduleName, instance)
   }
 
+  private validateOverrides(
+    metadata: CliModuleMetadata,
+    moduleName: string,
+  ): void {
+    if (!metadata.overrides || metadata.overrides.size === 0) {
+      return
+    }
+
+    const registry = this.container.getRegistry()
+
+    for (const overrideClass of metadata.overrides) {
+      try {
+        // Get the token for the override class
+        const overrideToken = getInjectableToken(overrideClass)
+
+        // Get all registrations for this token (sorted by priority, highest first)
+        const allRegistrations = registry.getAll(overrideToken)
+
+        if (allRegistrations.length === 0) {
+          this.logger.warn(
+            `[Navios Commander] Override ${overrideClass.name} in module ${moduleName} is not registered. ` +
+              `Make sure it has @Injectable decorator.`,
+          )
+          continue
+        }
+
+        // Check if the override class has the highest priority
+        const highestPriorityRegistration = allRegistrations[0]
+        if (highestPriorityRegistration.target !== overrideClass) {
+          const overrideRegistration = allRegistrations.find(
+            (r) => r.target === overrideClass,
+          )
+
+          if (!overrideRegistration) {
+            this.logger.warn(
+              `[Navios Commander] Override ${overrideClass.name} in module ${moduleName} is registered ` +
+                `but not found in registry for token ${overrideToken.toString()}.`,
+            )
+          } else {
+            this.logger.warn(
+              `[Navios Commander] Override ${overrideClass.name} in module ${moduleName} is not active. ` +
+                `Current active service: ${highestPriorityRegistration.target.name} ` +
+                `(priority: ${highestPriorityRegistration.priority}). ` +
+                `Override priority: ${overrideRegistration.priority}. ` +
+                `Override needs higher priority to take effect.`,
+            )
+          }
+        } else {
+          this.logger.debug(
+            `[Navios Commander] Override ${overrideClass.name} in module ${moduleName} is active ` +
+              `(priority: ${highestPriorityRegistration.priority})`,
+          )
+        }
+      } catch (error) {
+        this.logger.warn(
+          `[Navios Commander] Failed to validate override ${overrideClass.name} in module ${moduleName}: ${error}`,
+        )
+      }
+    }
+  }
+
   private mergeMetadata(
     metadata: CliModuleMetadata,
     parentMetadata: CliModuleMetadata,