@navios/commander 1.0.0-alpha.2 → 1.0.0

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

@@ -0,0 +1,31 @@
+import type { ClassType } from '@navios/core';
+/**
+ * Symbol key for storing commands in ModuleMetadata.customEntries.
+ * Used by @CliModule to store command classes.
+ *
+ * @public
+ */
+export declare const CommandEntryKey: unique symbol;
+/**
+ * Type for the command entry value stored in customEntries.
+ *
+ * @public
+ */
+export type CommandEntryValue = Set<ClassType>;
+/**
+ * Extracts commands from a module's metadata.
+ * Returns empty set if no commands are defined.
+ *
+ * @param moduleClass - The module class decorated with @CliModule or @Module
+ * @returns Set of command classes registered in the module
+ *
+ * @example
+ * ```typescript
+ * const commands = extractModuleCommands(AppModule)
+ * for (const command of commands) {
+ *   console.log(command.name)
+ * }
+ * ```
+ */
+export declare function extractModuleCommands(moduleClass: ClassType): Set<ClassType>;
+//# sourceMappingURL=command-entry.metadata.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"command-entry.metadata.d.mts","sourceRoot":"","sources":["../../../src/metadata/command-entry.metadata.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAI7C;;;;;GAKG;AACH,eAAO,MAAM,eAAe,eAA4B,CAAA;AAExD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,GAAG,CAAC,SAAS,CAAC,CAAA;AAE9C;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC,CAM5E"}

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

@@ -15,6 +15,10 @@ export interface CommandMetadata {
      * The command path (e.g., 'greet', 'user:create').
      */
     path: string;
+    /**
+     * Optional description of the command for help text.
+     */
+    description?: string;
     /**
      * Optional Zod schema for validating command options.
      */
@@ -31,10 +35,11 @@ export interface CommandMetadata {
  * @param target - The command class
  * @param context - The decorator context
  * @param path - The command path
+ * @param description - Optional description for help text
  * @param optionsSchema - Optional Zod schema
  * @returns The command metadata
  */
-export declare function getCommandMetadata(target: ClassType, context: ClassDecoratorContext, path: string, optionsSchema?: ZodObject): CommandMetadata;
+export declare function getCommandMetadata(target: ClassType, context: ClassDecoratorContext, path: string, description?: string, optionsSchema?: ZodObject): CommandMetadata;
 /**
  * Extracts command metadata from a class.
  *

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,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"}
+{"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,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,SAAS,CAAA;IACzB;;OAEG;IACH,gBAAgB,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAA;CAC5C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,qBAAqB,EAC9B,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,MAAM,EACpB,aAAa,CAAC,EAAE,SAAS,GACxB,eAAe,CAqBjB;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/metadata/index.d.mts

@@ -1,3 +1,3 @@
 export * from './command.metadata.mjs';
-export * from './cli-module.metadata.mjs';
+export * from './command-entry.metadata.mjs';
 //# sourceMappingURL=index.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/metadata/index.mts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,2BAA2B,CAAA"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/metadata/index.mts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,8BAA8B,CAAA"}

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

@@ -63,23 +63,13 @@ export declare class CliParserService {
     private extractArrayFields;
     /**
      * Checks if a Zod schema represents a boolean type
-     * Unwraps ZodOptional and ZodDefault
+     * Unwraps ZodOptional and ZodDefault using Zod v4 API
      */
     private isSchemaBoolean;
     /**
      * Checks if a Zod schema represents an array type
-     * Unwraps ZodOptional and ZodDefault
+     * Unwraps ZodOptional and ZodDefault using Zod v4 API
      */
     private isSchemaArray;
-    /**
-     * 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;
-        class: any;
-    }>): string;
 }
 //# sourceMappingURL=cli-parser.service.d.mts.map

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;;;;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"}
+{"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;CAgBtB"}

package/dist/src/services/command-registry.service.d.mts

@@ -0,0 +1,89 @@
+import type { ClassType } from '@navios/core';
+import type { CommandMetadata } from '../metadata/index.mjs';
+/**
+ * Represents a registered command with its metadata and module information.
+ *
+ * @public
+ */
+export interface RegisteredCommand {
+    /**
+     * The command class
+     */
+    class: ClassType;
+    /**
+     * The command metadata from @Command decorator
+     */
+    metadata: CommandMetadata;
+    /**
+     * Name of the module this command belongs to
+     */
+    moduleName: string;
+}
+/**
+ * Service for registering and looking up CLI commands.
+ * Used internally by the CLI adapter to manage discovered commands.
+ *
+ * @public
+ */
+export declare class CommandRegistryService {
+    private commands;
+    /**
+     * Register a command with its metadata.
+     *
+     * @param path - The command path (e.g., 'greet', 'user:create')
+     * @param command - The registered command data
+     * @throws Error if a command with the same path is already registered
+     */
+    register(path: string, command: RegisteredCommand): void;
+    /**
+     * Get a command by its path.
+     *
+     * @param path - The command path
+     * @returns The registered command or undefined if not found
+     */
+    getByPath(path: string): RegisteredCommand | undefined;
+    /**
+     * Get all registered commands.
+     *
+     * @returns Map of path to registered command
+     */
+    getAll(): Map<string, RegisteredCommand>;
+    /**
+     * Get all registered commands as an array of path and class pairs.
+     * Useful for listing available commands.
+     *
+     * @returns Array of objects containing path and class
+     */
+    getAllAsArray(): Array<{
+        path: string;
+        class: ClassType;
+    }>;
+    /**
+     * Formats help text listing all available commands with descriptions.
+     *
+     * @returns Formatted string listing all commands
+     */
+    formatCommandList(): string;
+    /**
+     * Formats help text for a specific command.
+     *
+     * @param commandPath - The command path to show help for
+     * @returns Formatted string with command help
+     */
+    formatCommandHelp(commandPath: string): string;
+    /**
+     * Gets a human-readable type name from a Zod schema.
+     */
+    private getSchemaTypeName;
+    /**
+     * Gets metadata from a Zod schema, traversing innerType if needed.
+     * Zod v4 stores meta at the outermost layer when .meta() is called last,
+     * or in innerType when .meta() is called before .optional()/.default().
+     */
+    private getSchemaMeta;
+    /**
+     * Clear all registered commands.
+     */
+    clear(): void;
+}
+//# sourceMappingURL=command-registry.service.d.mts.map

package/dist/src/services/command-registry.service.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-registry.service.d.mts","sourceRoot":"","sources":["../../../src/services/command-registry.service.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAI7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAE5D;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,SAAS,CAAA;IAChB;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;;;GAKG;AACH,qBACa,sBAAsB;IACjC,OAAO,CAAC,QAAQ,CAAuC;IAEvD;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,IAAI;IAOxD;;;;;OAKG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS;IAItD;;;;OAIG;IACH,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAIxC;;;;;OAKG;IACH,aAAa,IAAI,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,CAAC;IAQ1D;;;;OAIG;IACH,iBAAiB,IAAI,MAAM;IAa3B;;;;;OAKG;IACH,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAsC9C;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAuCzB;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAkBrB;;OAEG;IACH,KAAK,IAAI,IAAI;CAGd"}

package/dist/src/services/commander-adapter.service.d.mts

@@ -0,0 +1,56 @@
+import type { ClassType, ModuleMetadata } from '@navios/core';
+import type { AbstractCliAdapterInterface } from '../interfaces/abstract-cli-adapter.interface.mjs';
+import type { CliAdapterOptions } from '../interfaces/environment.interface.mjs';
+/**
+ * CLI adapter service that implements the AbstractCliAdapterInterface.
+ * Handles command discovery, registration, parsing, and execution.
+ *
+ * @public
+ */
+export declare class CommanderAdapterService implements AbstractCliAdapterInterface {
+    private container;
+    private commandRegistry;
+    private cliParser;
+    private logger;
+    private options;
+    private isReady;
+    /**
+     * Sets up the adapter with the provided options.
+     * Called during application initialization.
+     */
+    setupAdapter(options: CliAdapterOptions): Promise<void>;
+    /**
+     * Called after all modules are loaded.
+     * Iterates through modules and extracts commands from customEntries.
+     */
+    onModulesInit(modules: Map<string, ModuleMetadata>): Promise<void>;
+    /**
+     * Registers built-in commands like help.
+     */
+    private registerBuiltInCommands;
+    /**
+     * Signals that the adapter is ready to handle commands.
+     */
+    ready(): Promise<void>;
+    /**
+     * Disposes of the adapter and cleans up resources.
+     */
+    dispose(): Promise<void>;
+    /**
+     * Run the CLI application with the given arguments.
+     * Parses arguments and executes the matching command.
+     */
+    run(argv?: string[]): Promise<void>;
+    /**
+     * Execute a command programmatically with the provided options.
+     */
+    executeCommand(path: string, options?: Record<string, unknown>): Promise<void>;
+    /**
+     * Get all registered command paths and their class references.
+     */
+    getAllCommands(): Array<{
+        path: string;
+        class: ClassType;
+    }>;
+}
+//# sourceMappingURL=commander-adapter.service.d.mts.map

package/dist/src/services/commander-adapter.service.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commander-adapter.service.d.mts","sourceRoot":"","sources":["../../../src/services/commander-adapter.service.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAU7D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,kDAAkD,CAAA;AAEnG,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAA;AAchF;;;;;GAKG;AACH,qBACa,uBAAwB,YAAW,2BAA2B;IACzE,OAAO,CAAC,SAAS,CAAoB;IACrC,OAAO,CAAC,eAAe,CAAiC;IACxD,OAAO,CAAC,SAAS,CAA2B;IAC5C,OAAO,CAAC,MAAM,CAA2C;IAEzD,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,OAAO,CAAQ;IAEvB;;;OAGG;IACG,YAAY,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7D;;;OAGG;IACG,aAAa,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BxE;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAS/B;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAK9B;;;OAGG;IACG,GAAG,CAAC,IAAI,GAAE,MAAM,EAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAyCvD;;OAEG;IACG,cAAc,CAClB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACpC,OAAO,CAAC,IAAI,CAAC;IAyChB;;OAEG;IACH,cAAc,IAAI,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,CAAC;CAG5D"}

package/dist/src/services/index.d.mts

@@ -1,3 +1,4 @@
-export * from './module-loader.service.mjs';
 export * from './cli-parser.service.mjs';
+export * from './command-registry.service.mjs';
+export * from './commander-adapter.service.mjs';
 //# sourceMappingURL=index.d.mts.map

package/dist/src/services/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/services/index.mts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAA;AAC3C,cAAc,0BAA0B,CAAA"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/services/index.mts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAA;AACxC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,iCAAiC,CAAA"}

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

@@ -8,7 +8,7 @@ import type { CommanderExecutionContext } from '../interfaces/index.mjs';
  *
  * @example
  * ```typescript
- * import { inject, Injectable } from '@navios/di'
+ * import { inject, Injectable } from '@navios/core'
  * import { CommandExecutionContext } from '@navios/commander'
  *
  * @Injectable()