@navios/commander 0.5.2 → 0.7.0

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

@@ -1,11 +1,56 @@
-import type { ClassType } from '@navios/di';
+import type { ClassType } from '@navios/core';
+/**
+ * @internal
+ * Symbol key used to store CLI module metadata on classes.
+ */
 export declare const CliModuleMetadataKey: unique symbol;
+/**
+ * Metadata associated with a CLI module.
+ *
+ * @public
+ */
 export interface CliModuleMetadata {
+    /**
+     * Set of command classes registered in this module.
+     */
     commands: Set<ClassType>;
+    /**
+     * Set of other modules imported by this module.
+     */
     imports: Set<ClassType>;
+    /**
+     * Map of custom attributes that can be attached to the module.
+     */
     customAttributes: Map<string | symbol, any>;
 }
+/**
+ * Gets or creates CLI module metadata for a class.
+ *
+ * @internal
+ * @param target - The module class
+ * @param context - The decorator context
+ * @returns The module metadata
+ */
 export declare function getCliModuleMetadata(target: ClassType, context: ClassDecoratorContext): CliModuleMetadata;
+/**
+ * Extracts CLI module metadata from a class.
+ *
+ * @param target - The module class
+ * @returns The module metadata
+ * @throws {Error} If the class is not decorated with @CliModule
+ *
+ * @example
+ * ```typescript
+ * const metadata = extractCliModuleMetadata(AppModule)
+ * console.log(metadata.commands.size) // Number of commands
+ * ```
+ */
 export declare function extractCliModuleMetadata(target: ClassType): CliModuleMetadata;
+/**
+ * Checks if a class has CLI module metadata.
+ *
+ * @param target - The class to check
+ * @returns `true` if the class is decorated with @CliModule, `false` otherwise
+ */
 export declare function hasCliModuleMetadata(target: ClassType): boolean;
 //# sourceMappingURL=cli-module.metadata.d.mts.map

package/dist/src/metadata/cli-module.metadata.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"cli-module.metadata.d.mts","sourceRoot":"","sources":["../../../src/metadata/cli-module.metadata.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAE3C,eAAO,MAAM,oBAAoB,eAAiC,CAAA;AAElE,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,GAAG,CAAC,SAAS,CAAC,CAAA;IACxB,OAAO,EAAE,GAAG,CAAC,SAAS,CAAC,CAAA;IACvB,gBAAgB,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAA;CAC5C;AAED,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,qBAAqB,GAC7B,iBAAiB,CAoBnB;AAED,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,SAAS,GAChB,iBAAiB,CAWnB;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAG/D"}
+{"version":3,"file":"cli-module.metadata.d.mts","sourceRoot":"","sources":["../../../src/metadata/cli-module.metadata.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAE7C;;;GAGG;AACH,eAAO,MAAM,oBAAoB,eAAiC,CAAA;AAElE;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAC,SAAS,CAAC,CAAA;IACxB;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC,SAAS,CAAC,CAAA;IACvB;;OAEG;IACH,gBAAgB,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAA;CAC5C;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,qBAAqB,GAC7B,iBAAiB,CAoBnB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,SAAS,GAAG,iBAAiB,CAS7E;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAG/D"}

package/dist/src/metadata/command.metadata.d.mts

@@ -1,12 +1,59 @@
-import type { ClassType } from '@navios/di';
+import type { ClassType } from '@navios/core';
 import type { ZodObject } from 'zod';
+/**
+ * @internal
+ * Symbol key used to store command metadata on classes.
+ */
 export declare const CommandMetadataKey: unique symbol;
+/**
+ * Metadata associated with a command.
+ *
+ * @public
+ */
 export interface CommandMetadata {
+    /**
+     * The command path (e.g., 'greet', 'user:create').
+     */
     path: string;
+    /**
+     * Optional Zod schema for validating command options.
+     */
     optionsSchema?: ZodObject;
+    /**
+     * Map of custom attributes that can be attached to the command.
+     */
     customAttributes: Map<string | symbol, any>;
 }
+/**
+ * Gets or creates command metadata for a class.
+ *
+ * @internal
+ * @param target - The command class
+ * @param context - The decorator context
+ * @param path - The command path
+ * @param optionsSchema - Optional Zod schema
+ * @returns The command metadata
+ */
 export declare function getCommandMetadata(target: ClassType, context: ClassDecoratorContext, path: string, optionsSchema?: ZodObject): CommandMetadata;
+/**
+ * Extracts command metadata from a class.
+ *
+ * @param target - The command class
+ * @returns The command metadata
+ * @throws {Error} If the class is not decorated with @Command
+ *
+ * @example
+ * ```typescript
+ * const metadata = extractCommandMetadata(GreetCommand)
+ * console.log(metadata.path) // 'greet'
+ * ```
+ */
 export declare function extractCommandMetadata(target: ClassType): CommandMetadata;
+/**
+ * Checks if a class has command metadata.
+ *
+ * @param target - The class to check
+ * @returns `true` if the class is decorated with @Command, `false` otherwise
+ */
 export declare function hasCommandMetadata(target: ClassType): boolean;
 //# sourceMappingURL=command.metadata.d.mts.map

package/dist/src/metadata/command.metadata.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"command.metadata.d.mts","sourceRoot":"","sources":["../../../src/metadata/command.metadata.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AAEpC,eAAO,MAAM,kBAAkB,eAA+B,CAAA;AAE9D,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,CAAC,EAAE,SAAS,CAAA;IACzB,gBAAgB,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAA;CAC5C;AAED,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,qBAAqB,EAC9B,IAAI,EAAE,MAAM,EACZ,aAAa,CAAC,EAAE,SAAS,GACxB,eAAe,CAoBjB;AAED,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,SAAS,GAAG,eAAe,CASzE;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAI7D"}
+{"version":3,"file":"command.metadata.d.mts","sourceRoot":"","sources":["../../../src/metadata/command.metadata.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AAEpC;;;GAGG;AACH,eAAO,MAAM,kBAAkB,eAA+B,CAAA;AAE9D;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,CAAA;IACzB;;OAEG;IACH,gBAAgB,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAA;CAC5C;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,qBAAqB,EAC9B,IAAI,EAAE,MAAM,EACZ,aAAa,CAAC,EAAE,SAAS,GACxB,eAAe,CAoBjB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,SAAS,GAAG,eAAe,CASzE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAI7D"}

package/dist/src/services/cli-parser.service.d.mts

@@ -1,9 +1,37 @@
 import type { ZodObject } from 'zod';
+/**
+ * Result of parsing command-line arguments.
+ *
+ * @public
+ */
 export interface ParsedCliArgs {
+    /**
+     * The command path (e.g., 'greet', 'user:create').
+     * Multi-word commands are joined with spaces.
+     */
     command: string;
+    /**
+     * Parsed options as key-value pairs.
+     * Keys are converted from kebab-case to camelCase.
+     */
     options: Record<string, any>;
+    /**
+     * Positional arguments that don't match any option flags.
+     */
     positionals: string[];
 }
+/**
+ * Service for parsing command-line arguments.
+ *
+ * Handles parsing of various CLI argument formats including:
+ * - Long options: `--key value` or `--key=value`
+ * - Short options: `-k value` or `-abc` (multiple flags)
+ * - Boolean flags
+ * - Array options
+ * - Positional arguments
+ *
+ * @public
+ */
 export declare class CliParserService {
     /**
      * Parses command-line arguments from process.argv
@@ -44,7 +72,10 @@ export declare class CliParserService {
      */
     private isSchemaArray;
     /**
-     * Formats help text for available commands
+     * Formats help text listing all available commands.
+     *
+     * @param commands - Array of command objects with path and class
+     * @returns Formatted string listing all commands
      */
     formatCommandList(commands: Array<{
         path: string;

package/dist/src/services/cli-parser.service.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"cli-parser.service.d.mts","sourceRoot":"","sources":["../../../src/services/cli-parser.service.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAW,MAAM,KAAK,CAAA;AAI7C,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC5B,WAAW,EAAE,MAAM,EAAE,CAAA;CACtB;AAED,qBACa,gBAAgB;IAC3B;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,SAAS,GAAG,aAAa;IAsI/D;;OAEG;IACH,OAAO,CAAC,SAAS;IAIjB;;OAEG;IACH,OAAO,CAAC,UAAU;IAkClB;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IA0B5B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAwB1B;;;OAGG;IACH,OAAO,CAAC,eAAe;IAiBvB;;;OAGG;IACH,OAAO,CAAC,aAAa;IAiBrB;;OAEG;IACH,iBAAiB,CAAC,QAAQ,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,GAAG,CAAA;KAAE,CAAC,GAAG,MAAM;CAOzE"}
+{"version":3,"file":"cli-parser.service.d.mts","sourceRoot":"","sources":["../../../src/services/cli-parser.service.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAW,MAAM,KAAK,CAAA;AAI7C;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC5B;;OAEG;IACH,WAAW,EAAE,MAAM,EAAE,CAAA;CACtB;AAED;;;;;;;;;;;GAWG;AACH,qBACa,gBAAgB;IAC3B;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,SAAS,GAAG,aAAa;IAuI/D;;OAEG;IACH,OAAO,CAAC,SAAS;IAIjB;;OAEG;IACH,OAAO,CAAC,UAAU;IAkClB;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IA0B5B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAwB1B;;;OAGG;IACH,OAAO,CAAC,eAAe;IAiBvB;;;OAGG;IACH,OAAO,CAAC,aAAa;IAiBrB;;;;;OAKG;IACH,iBAAiB,CAAC,QAAQ,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,GAAG,CAAA;KAAE,CAAC,GAAG,MAAM;CAOzE"}

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

@@ -1,21 +1,57 @@
-import type { ClassTypeWithInstance } from '@navios/di';
-import { Container } from '@navios/di';
-import type { CommandHandler, Module } from '../interfaces/index.mjs';
+import type { ClassTypeWithInstance, NaviosModule } from '@navios/core';
+import { Container } from '@navios/core';
+import type { CommandHandler } from '../interfaces/index.mjs';
 import type { CliModuleMetadata, CommandMetadata } from '../metadata/index.mjs';
+/**
+ * Command class with its associated metadata.
+ *
+ * @public
+ */
 export interface CommandWithMetadata {
+    /**
+     * The command class constructor.
+     */
     class: ClassTypeWithInstance<CommandHandler>;
+    /**
+     * The command metadata including path and options schema.
+     */
     metadata: CommandMetadata;
 }
-export declare class ModuleLoaderService {
+/**
+ * Service for loading and managing CLI modules and commands.
+ *
+ * Handles module traversal, command registration, and metadata collection.
+ * This service is used internally by CommanderApplication.
+ *
+ * @public
+ */
+export declare class CliModuleLoaderService {
     protected container: Container;
     private modulesMetadata;
     private loadedModules;
     private commandsMetadata;
     private initialized;
-    loadModules(appModule: ClassTypeWithInstance<Module>): Promise<void>;
+    /**
+     * Loads all modules starting from the root app module.
+     *
+     * Traverses the module tree, loads imported modules, and collects command metadata.
+     *
+     * @param appModule - The root CLI module
+     */
+    loadModules(appModule: ClassTypeWithInstance<NaviosModule>): Promise<void>;
     private traverseModules;
     private mergeMetadata;
+    /**
+     * Gets all loaded module metadata.
+     *
+     * @returns Map of module names to their metadata
+     */
     getAllModules(): Map<string, CliModuleMetadata>;
+    /**
+     * Gets all command classes indexed by command class name.
+     *
+     * @returns Map of command class names to command classes
+     */
     getAllCommands(): Map<string, ClassTypeWithInstance<any>>;
     /**
      * Get all commands with their metadata, indexed by command path.
@@ -28,6 +64,9 @@ export declare class ModuleLoaderService {
      * Returns undefined if command is not found.
      */
     getCommandByPath(path: string): CommandWithMetadata | undefined;
+    /**
+     * Disposes of all loaded modules and commands, clearing internal state.
+     */
     dispose(): void;
 }
 //# sourceMappingURL=module-loader.service.d.mts.map

package/dist/src/services/module-loader.service.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"module-loader.service.d.mts","sourceRoot":"","sources":["../../../src/services/module-loader.service.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAEvD,OAAO,EAAE,SAAS,EAAsB,MAAM,YAAY,CAAA;AAE1D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAO/E,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,qBAAqB,CAAC,cAAc,CAAC,CAAA;IAC5C,QAAQ,EAAE,eAAe,CAAA;CAC1B;AAED,qBACa,mBAAmB;IAC9B,SAAS,CAAC,SAAS,YAAoB;IACvC,OAAO,CAAC,eAAe,CAA4C;IACnE,OAAO,CAAC,aAAa,CAA8B;IACnD,OAAO,CAAC,gBAAgB,CAA8C;IACtE,OAAO,CAAC,WAAW,CAAQ;IAErB,WAAW,CAAC,SAAS,EAAE,qBAAqB,CAAC,MAAM,CAAC;YAQ5C,eAAe;IAmC7B,OAAO,CAAC,aAAa;IAcrB,aAAa,IAAI,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAI/C,cAAc,IAAI,GAAG,CAAC,MAAM,EAAE,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAUzD;;;;OAIG;IACH,0BAA0B,IAAI,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAI9D;;;OAGG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS;IAI/D,OAAO;CAMR"}
+{"version":3,"file":"module-loader.service.d.mts","sourceRoot":"","sources":["../../../src/services/module-loader.service.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvE,OAAO,EAAE,SAAS,EAAsB,MAAM,cAAc,CAAA;AAE5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAC7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAO/E;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,qBAAqB,CAAC,cAAc,CAAC,CAAA;IAC5C;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAA;CAC1B;AAED;;;;;;;GAOG;AACH,qBACa,sBAAsB;IACjC,SAAS,CAAC,SAAS,YAAoB;IACvC,OAAO,CAAC,eAAe,CAA4C;IACnE,OAAO,CAAC,aAAa,CAA8B;IACnD,OAAO,CAAC,gBAAgB,CAA8C;IACtE,OAAO,CAAC,WAAW,CAAQ;IAE3B;;;;;;OAMG;IACG,WAAW,CAAC,SAAS,EAAE,qBAAqB,CAAC,YAAY,CAAC;YAQlD,eAAe;IAmC7B,OAAO,CAAC,aAAa;IAcrB;;;;OAIG;IACH,aAAa,IAAI,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAI/C;;;;OAIG;IACH,cAAc,IAAI,GAAG,CAAC,MAAM,EAAE,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAUzD;;;;OAIG;IACH,0BAA0B,IAAI,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAI9D;;;OAGG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS;IAI/D;;OAEG;IACH,OAAO;CAMR"}

package/dist/src/tokens/execution-context.token.d.mts

@@ -1,5 +1,27 @@
-import { InjectionToken } from '@navios/di';
+import { InjectionToken } from '@navios/core';
 import type { CommanderExecutionContext } from '../interfaces/index.mjs';
-export declare const ExecutionContextInjectionToken = "CommanderExecutionContextInjectionToken";
-export declare const ExecutionContext: InjectionToken<CommanderExecutionContext, undefined, false>;
+/**
+ * Injection token for accessing the current command execution context.
+ *
+ * Use this token with `inject()` to access the `CommanderExecutionContext` in services
+ * that need information about the currently executing command.
+ *
+ * @example
+ * ```typescript
+ * import { inject, Injectable } from '@navios/di'
+ * import { CommandExecutionContext } from '@navios/commander'
+ *
+ * @Injectable()
+ * class MyService {
+ *   private ctx = inject(CommandExecutionContext)
+ *
+ *   doSomething() {
+ *     const commandPath = this.ctx.getCommandPath()
+ *     const options = this.ctx.getOptions()
+ *     // Use context information...
+ *   }
+ * }
+ * ```
+ */
+export declare const CommandExecutionContext: InjectionToken<CommanderExecutionContext, undefined, false>;
 //# sourceMappingURL=execution-context.token.d.mts.map

package/dist/src/tokens/execution-context.token.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"execution-context.token.d.mts","sourceRoot":"","sources":["../../../src/tokens/execution-context.token.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AAExE,eAAO,MAAM,8BAA8B,4CACA,CAAA;AAE3C,eAAO,MAAM,gBAAgB,6DAE5B,CAAA"}
+{"version":3,"file":"execution-context.token.d.mts","sourceRoot":"","sources":["../../../src/tokens/execution-context.token.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAE7C,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AAKxE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,uBAAuB,6DAGjC,CAAA"}