@navios/commander 1.5.0 → 1.5.1

package/lib/index.d.cts

@@ -1,6 +1,6 @@
-import { a as CommandHandler, i as CommandOptions, n as CliModuleOptions, r as Command, t as CliModule } from "./cli-module.decorator-CRaNGvgl.cjs";
+import { a as CommandHandler, i as CommandOptions, n as CliModuleOptions, r as Command, t as CliModule } from "./cli-module.decorator-BzsOEMPH.cjs";
 import { AbstractAdapterInterface, AdapterEnvironment, AnyInjectableType, ClassType, ClassTypeWithInstance, InjectionToken, LogLevel, ModuleMetadata, NaviosApplication, NaviosModule } from "@navios/core";
-import { ZodObject, z } from "zod";
+import { z } from "zod/v4";
 export * from "@navios/core";
 
 //#region src/commands/help.command.d.mts
@@ -28,44 +28,44 @@ declare class HelpCommand implements CommandHandler<HelpOptions> {
  */
 interface AbstractCliAdapterInterface extends AbstractAdapterInterface {
   /**
-       * Run the CLI application with the given arguments.
-       * Parses arguments and executes the matching command.
-       *
-       * @param argv - Command-line arguments array (defaults to `process.argv`)
-       *
-       * @example
-       * ```typescript
-       * const adapter = app.getAdapter() as AbstractCliAdapterInterface
-       * await adapter.run(process.argv)
-       * ```
-       */
+   * Run the CLI application with the given arguments.
+   * Parses arguments and executes the matching command.
+   *
+   * @param argv - Command-line arguments array (defaults to `process.argv`)
+   *
+   * @example
+   * ```typescript
+   * const adapter = app.getAdapter() as AbstractCliAdapterInterface
+   * await adapter.run(process.argv)
+   * ```
+   */
   run(argv?: string[]): Promise<void>;
   /**
-       * Execute a command programmatically with the provided options.
-       *
-       * @param path - The command path (e.g., 'greet', 'user:create')
-       * @param options - The command options object
-       *
-       * @example
-       * ```typescript
-       * await adapter.executeCommand('user:create', {
-       *   name: 'John',
-       *   email: 'john@example.com',
-       * })
-       * ```
-       */
+   * Execute a command programmatically with the provided options.
+   *
+   * @param path - The command path (e.g., 'greet', 'user:create')
+   * @param options - The command options object
+   *
+   * @example
+   * ```typescript
+   * await adapter.executeCommand('user:create', {
+   *   name: 'John',
+   *   email: 'john@example.com',
+   * })
+   * ```
+   */
   executeCommand(path: string, options: Record<string, unknown>): Promise<void>;
   /**
-       * Get all registered command paths and their class references.
-       *
-       * @returns Array of objects containing path and class
-       *
-       * @example
-       * ```typescript
-       * const commands = adapter.getAllCommands()
-       * commands.forEach(({ path }) => console.log(path))
-       * ```
-       */
+   * Get all registered command paths and their class references.
+   *
+   * @returns Array of objects containing path and class
+   *
+   * @example
+   * ```typescript
+   * const commands = adapter.getAllCommands()
+   * commands.forEach(({ path }) => console.log(path))
+   * ```
+   */
   getAllCommands(): Array<{
     path: string;
     class: unknown;
@@ -109,39 +109,39 @@ interface CliEnvironment extends AdapterEnvironment {
  */
 interface CommanderLoggerOptions {
   /**
-       * Enabled log levels.
-       * @default ['log', 'error', 'warn', 'debug', 'verbose', 'fatal']
-       */
+   * Enabled log levels.
+   * @default ['log', 'error', 'warn', 'debug', 'verbose', 'fatal']
+   */
   logLevels?: LogLevel[];
   /**
-       * If true, will print the process ID in the log message.
-       * @default false
-       */
+   * If true, will print the process ID in the log message.
+   * @default false
+   */
   showPid?: boolean;
   /**
-       * If true, will print the log level in the log message.
-       * @default true
-       */
+   * If true, will print the log level in the log message.
+   * @default true
+   */
   showLogLevel?: boolean;
   /**
-       * If true, will print the prefix/app name in the log message.
-       * @default false
-       */
+   * If true, will print the prefix/app name in the log message.
+   * @default false
+   */
   showPrefix?: boolean;
   /**
-       * If true, will print the context in the log message.
-       * @default true
-       */
+   * If true, will print the context in the log message.
+   * @default true
+   */
   showContext?: boolean;
   /**
-       * If true, will print the absolute timestamp in the log message.
-       * @default false
-       */
+   * If true, will print the absolute timestamp in the log message.
+   * @default false
+   */
   showTimestamp?: boolean;
   /**
-       * If enabled, will print timestamp difference between current and previous log message.
-       * @default false
-       */
+   * If enabled, will print timestamp difference between current and previous log message.
+   * @default false
+   */
   showTimeDiff?: boolean;
 }
 /**
@@ -152,52 +152,52 @@ interface CommanderLoggerOptions {
  */
 interface CommanderTuiOptions {
   /**
-       * Exit on Ctrl+C.
-       * @default true
-       */
+   * Exit on Ctrl+C.
+   * @default true
+   */
   exitOnCtrlC?: boolean;
   /**
-       * Adapter to use for the TUI.
-       * @default 'none'
-       */
+   * Adapter to use for the TUI.
+   * @default 'none'
+   */
   adapter?: 'react' | 'solid' | 'ink' | 'none';
   /**
-       * Sidebar width in columns.
-       */
+   * Sidebar width in columns.
+   */
   sidebarWidth?: number;
   /**
-       * Sidebar position.
-       */
+   * Sidebar position.
+   */
   sidebarPosition?: 'left' | 'right';
   /**
-       * Sidebar header title.
-       */
+   * Sidebar header title.
+   */
   sidebarTitle?: string;
   /**
-       * Auto close after all screens complete successfully.
-       * Set to true for default delay (5000ms), or specify delay in milliseconds.
-       */
+   * Auto close after all screens complete successfully.
+   * Set to true for default delay (5000ms), or specify delay in milliseconds.
+   */
   autoClose?: boolean | number;
   /**
-       * Theme preset name ('dark', 'light', 'high-contrast') or custom theme object.
-       */
+   * Theme preset name ('dark', 'light', 'high-contrast') or custom theme object.
+   */
   theme?: string | Record<string, unknown>;
   /**
-       * Enable mouse support.
-       * @default false
-       */
+   * Enable mouse support.
+   * @default false
+   */
   useMouse?: boolean;
   /**
-       * Hide the default console logger screen from the sidebar.
-       * @default false
-       */
+   * Hide the default console logger screen from the sidebar.
+   * @default false
+   */
   hideDefaultScreen?: boolean;
   /**
-       * Use OpenTUI for terminal rendering.
-       * When true: Full TUI with sidebar, scrolling, interactive prompts.
-       * When false: Stdout mode - static screens print immediately, others on completion.
-       * @default true for Node.js, false for Bun (OpenTUI not supported)
-       */
+   * Use OpenTUI for terminal rendering.
+   * When true: Full TUI with sidebar, scrolling, interactive prompts.
+   * When false: Stdout mode - static screens print immediately, others on completion.
+   * @default true for Node.js, false for Bun (OpenTUI not supported)
+   */
   useOpenTUI?: boolean;
 }
 /**
@@ -207,23 +207,23 @@ interface CommanderTuiOptions {
  */
 interface CommanderFactoryOptions {
   /**
-       * Enabled log levels.
-       * @default ['log', 'error', 'warn', 'debug', 'verbose', 'fatal']
-       */
+   * Enabled log levels.
+   * @default ['log', 'error', 'warn', 'debug', 'verbose', 'fatal']
+   */
   logLevels?: LogLevel[];
   /**
-       * Logger display options. These override the default CLI-friendly logger settings.
-       * Ignored when enableTUI is true.
-       */
+   * Logger display options. These override the default CLI-friendly logger settings.
+   * Ignored when enableTUI is true.
+   */
   logger?: CommanderLoggerOptions;
   /**
-       * Enable TUI mode with @navios/commander-tui.
-       * Requires @navios/commander-tui to be installed.
-       */
+   * Enable TUI mode with @navios/commander-tui.
+   * Requires @navios/commander-tui to be installed.
+   */
   enableTUI?: boolean;
   /**
-       * TUI-specific options. Only used when enableTUI is true.
-       */
+   * TUI-specific options. Only used when enableTUI is true.
+   */
   tuiOptions?: CommanderTuiOptions;
 }
 /**
@@ -262,21 +262,21 @@ interface CommanderFactoryOptions {
  */
 declare class CommanderFactory {
   /**
-       * Creates a new CLI application instance configured with the provided module.
-       *
-       * @param appModule - The root CLI module class decorated with `@CliModule`
-       * @param options - Optional configuration options for the CLI application
-       * @returns A promise that resolves to a configured NaviosApplication instance
-       *
-       * @example
-       * ```typescript
-       * const app = await CommanderFactory.create(AppModule)
-       * await app.init()
-       *
-       * const adapter = app.getAdapter()
-       * await adapter.run(process.argv)
-       * ```
-       */
+   * Creates a new CLI application instance configured with the provided module.
+   *
+   * @param appModule - The root CLI module class decorated with `@CliModule`
+   * @param options - Optional configuration options for the CLI application
+   * @returns A promise that resolves to a configured NaviosApplication instance
+   *
+   * @example
+   * ```typescript
+   * const app = await CommanderFactory.create(AppModule)
+   * await app.init()
+   *
+   * const adapter = app.getAdapter()
+   * await adapter.run(process.argv)
+   * ```
+   */
   static create<TModule extends NaviosModule = NaviosModule>(appModule: ClassTypeWithInstance<TModule>, options?: CommanderFactoryOptions): Promise<NaviosApplication<CliEnvironment>>;
 }
 //#endregion
@@ -293,20 +293,20 @@ declare const CommandMetadataKey: unique symbol;
  */
 interface CommandMetadata {
   /**
-       * The command path (e.g., 'greet', 'user:create').
-       */
+   * The command path (e.g., 'greet', 'user:create').
+   */
   path: string;
   /**
-       * Optional description of the command for help text.
-       */
+   * Optional description of the command for help text.
+   */
   description?: string;
   /**
-       * Optional Zod schema for validating command options.
-       */
-  optionsSchema?: ZodObject;
+   * Optional zod/v4 schema for validating command options.
+   */
+  optionsSchema?: z.ZodObject;
   /**
-       * Map of custom attributes that can be attached to the command.
-       */
+   * Map of custom attributes that can be attached to the command.
+   */
   customAttributes: Map<string | symbol, any>;
 }
 /**
@@ -317,10 +317,10 @@ interface CommandMetadata {
  * @param context - The decorator context
  * @param path - The command path
  * @param description - Optional description for help text
- * @param optionsSchema - Optional Zod schema
+ * @param optionsSchema - Optional zod/v4 schema
  * @returns The command metadata
  */
-declare function getCommandMetadata(target: ClassType, context: ClassDecoratorContext, path: string, description?: string, optionsSchema?: ZodObject): CommandMetadata;
+declare function getCommandMetadata(target: ClassType, context: ClassDecoratorContext, path: string, description?: string, optionsSchema?: z.ZodObject): CommandMetadata;
 /**
  * Extracts command metadata from a class.
  *
@@ -371,84 +371,105 @@ declare class CommanderExecutionContext {
   private readonly commandPath;
   private readonly options;
   /**
-       * @internal
-       * Creates a new execution context.
-       */
+   * @internal
+   * Creates a new execution context.
+   */
   constructor(command: CommandMetadata, commandPath: string, options: any);
   /**
-       * Gets the command metadata.
-       *
-       * @returns The command metadata including path and options schema
-       */
+   * Gets the command metadata.
+   *
+   * @returns The command metadata including path and options schema
+   */
   getCommand(): CommandMetadata;
   /**
-       * Gets the command path that was invoked.
-       *
-       * @returns The command path (e.g., 'greet', 'user:create')
-       */
+   * Gets the command path that was invoked.
+   *
+   * @returns The command path (e.g., 'greet', 'user:create')
+   */
   getCommandPath(): string;
   /**
-       * Gets the validated command options.
-       *
-       * Options are validated against the command's Zod schema if one was provided.
-       *
-       * @returns The validated options object
-       */
+   * Gets the validated command options.
+   *
+   * Options are validated against the command's zod/v4 schema if one was provided.
+   *
+   * @returns The validated options object
+   */
   getOptions(): any;
 }
 //#endregion
-//#region src/services/commander-adapter.service.d.mts
+//#region src/services/cli-parser.service.d.mts
 /**
- * CLI adapter service that implements the AbstractCliAdapterInterface.
- * Handles command discovery, registration, parsing, and execution.
+ * Result of parsing command-line arguments.
  *
  * @public
  */
-declare class CommanderAdapterService implements AbstractCliAdapterInterface {
-  private container;
-  private commandRegistry;
-  private cliParser;
-  private logger;
-  private options;
-  private isReady;
+interface ParsedCliArgs {
   /**
-       * Sets up the adapter with the provided options.
-       * Called during application initialization.
-       */
-  setupAdapter(options: CliAdapterOptions): Promise<void>;
+   * The command path (e.g., 'greet', 'user:create').
+   * Multi-word commands are joined with spaces.
+   */
+  command: string;
   /**
-       * Called after all modules are loaded.
-       * Iterates through modules and extracts commands from customEntries.
-       */
-  onModulesInit(modules: Map<string, ModuleMetadata>): Promise<void>;
+   * Parsed options as key-value pairs.
+   * Keys are converted from kebab-case to camelCase.
+   */
+  options: Record<string, any>;
   /**
-       * Registers built-in commands like help.
-       */
-  private registerBuiltInCommands;
+   * 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
+ */
+declare class CliParserService {
   /**
-       * Signals that the adapter is ready to handle commands.
-       */
-  ready(): Promise<void>;
+   * Parses command-line arguments from process.argv
+   * Commands can be multi-word (e.g., 'db migrate', 'cache clear')
+   * Expected format: node script.js command [subcommand...] --flag value --boolean-flag positional1 positional2
+   *
+   * @param argv - Array of command-line arguments (typically process.argv)
+   * @param optionsSchema - Optional zod/v4 schema to determine boolean flags and option types
+   * @returns Parsed command (space-separated if multi-word), options, and positional arguments
+   */
+  parse(argv: string[], optionsSchema?: z.ZodObject): ParsedCliArgs;
+  /**
+   * Converts kebab-case to camelCase
+   */
+  private camelCase;
   /**
-       * Disposes of the adapter and cleans up resources.
-       */
-  dispose(): Promise<void>;
+   * Attempts to parse string values into appropriate types
+   */
+  private parseValue;
   /**
-       * Run the CLI application with the given arguments.
-       * Parses arguments and executes the matching command.
-       */
-  run(argv?: string[]): Promise<void>;
+   * Extracts boolean field names from a zod/v4 schema
+   * Handles z.ZodObject, zod/v4Optional, and zod/v4Default wrappers
+   */
+  private extractBooleanFields;
   /**
-       * Execute a command programmatically with the provided options.
-       */
-  executeCommand(path: string, options?: Record<string, unknown>): Promise<void>;
+   * Extracts array field names from a zod/v4 schema
+   * Handles z.ZodObject, zod/v4Optional, and zod/v4Default wrappers
+   */
+  private extractArrayFields;
   /**
-       * Get all registered command paths and their class references.
-       */
-  getAllCommands(): Array<{
-    path: string;
-    class: ClassType;
-  }>;
+   * Checks if a zod/v4 schema represents a boolean type
+   * Unwraps zod/v4Optional and zod/v4Default using zod/v4 v4 API
+   */
+  private isSchemaBoolean;
+  /**
+   * Checks if a zod/v4 schema represents an array type
+   * Unwraps zod/v4Optional and zod/v4Default using zod/v4 v4 API
+   */
+  private isSchemaArray;
 }
 //#endregion
 //#region src/metadata/command-entry.metadata.d.mts
@@ -490,16 +511,16 @@ declare function extractModuleCommands(moduleClass: ClassType): Set<ClassType>;
  */
 interface RegisteredCommand {
   /**
-       * The command class
-       */
+   * The command class
+   */
   class: ClassType;
   /**
-       * The command metadata from @Command decorator
-       */
+   * The command metadata from @Command decorator
+   */
   metadata: CommandMetadata;
   /**
-       * Name of the module this command belongs to
-       */
+   * Name of the module this command belongs to
+   */
   moduleName: string;
 }
 /**
@@ -511,138 +532,117 @@ interface RegisteredCommand {
 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 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
-       */
+   * 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
-       */
+   * 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
-       */
+   * 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
-       */
+   * 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
-       */
+   * 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.
-       */
+   * Gets a human-readable type name from a zod/v4 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().
-       */
+   * Gets metadata from a zod/v4 schema, traversing innerType if needed.
+   * zod/v4 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 all registered commands.
+   */
   clear(): void;
 }
 //#endregion
-//#region src/services/cli-parser.service.d.mts
+//#region src/services/commander-adapter.service.d.mts
 /**
- * Result of parsing command-line arguments.
+ * CLI adapter service that implements the AbstractCliAdapterInterface.
+ * Handles command discovery, registration, parsing, and execution.
  *
  * @public
  */
-interface ParsedCliArgs {
-  /**
-       * The command path (e.g., 'greet', 'user:create').
-       * Multi-word commands are joined with spaces.
-       */
-  command: string;
+declare class CommanderAdapterService implements AbstractCliAdapterInterface {
+  private container;
+  private commandRegistry;
+  private cliParser;
+  private logger;
+  private options;
+  private isReady;
   /**
-       * Parsed options as key-value pairs.
-       * Keys are converted from kebab-case to camelCase.
-       */
-  options: Record<string, any>;
+   * Sets up the adapter with the provided options.
+   * Called during application initialization.
+   */
+  setupAdapter(options: CliAdapterOptions): Promise<void>;
   /**
-       * 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
- */
-declare class CliParserService {
+   * Called after all modules are loaded.
+   * Iterates through modules and extracts commands from customEntries.
+   */
+  onModulesInit(modules: Map<string, ModuleMetadata>): Promise<void>;
   /**
-       * Parses command-line arguments from process.argv
-       * Commands can be multi-word (e.g., 'db migrate', 'cache clear')
-       * Expected format: node script.js command [subcommand...] --flag value --boolean-flag positional1 positional2
-       *
-       * @param argv - Array of command-line arguments (typically process.argv)
-       * @param optionsSchema - Optional Zod schema to determine boolean flags and option types
-       * @returns Parsed command (space-separated if multi-word), options, and positional arguments
-       */
-  parse(argv: string[], optionsSchema?: ZodObject): ParsedCliArgs;
-  /**
-       * Converts kebab-case to camelCase
-       */
-  private camelCase;
+   * Registers built-in commands like help.
+   */
+  private registerBuiltInCommands;
   /**
-       * Attempts to parse string values into appropriate types
-       */
-  private parseValue;
+   * Signals that the adapter is ready to handle commands.
+   */
+  ready(): Promise<void>;
   /**
-       * Extracts boolean field names from a Zod schema
-       * Handles ZodObject, ZodOptional, and ZodDefault wrappers
-       */
-  private extractBooleanFields;
+   * Disposes of the adapter and cleans up resources.
+   */
+  dispose(): Promise<void>;
   /**
-       * Extracts array field names from a Zod schema
-       * Handles ZodObject, ZodOptional, and ZodDefault wrappers
-       */
-  private extractArrayFields;
+   * Run the CLI application with the given arguments.
+   * Parses arguments and executes the matching command.
+   */
+  run(argv?: string[]): Promise<void>;
   /**
-       * Checks if a Zod schema represents a boolean type
-       * Unwraps ZodOptional and ZodDefault using Zod v4 API
-       */
-  private isSchemaBoolean;
+   * Execute a command programmatically with the provided options.
+   */
+  executeCommand(path: string, options?: Record<string, unknown>): Promise<void>;
   /**
-       * Checks if a Zod schema represents an array type
-       * Unwraps ZodOptional and ZodDefault using Zod v4 API
-       */
-  private isSchemaArray;
+   * Get all registered command paths and their class references.
+   */
+  getAllCommands(): Array<{
+    path: string;
+    class: ClassType;
+  }>;
 }
 //#endregion
 //#region src/define-environment.d.mts