@qodalis/cli 2.0.0-rc.2 → 2.0.0-rc.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qodalis/cli",
-  "version": "2.0.0-rc.2",
+  "version": "2.0.0-rc.4",
   "description": "Framework-agnostic CLI engine for @qodalis terminal applications.",
   "author": "Nicolae Lupei, Qodalis Solutions",
   "license": "MIT",
@@ -30,7 +30,7 @@
     "./assets/*": "./assets/*"
   },
   "dependencies": {
-    "@qodalis/cli-core": "2.0.0-rc.2",
+    "@qodalis/cli-core": "2.0.0-rc.4",
     "@xterm/xterm": "^6.0.0",
     "@xterm/addon-fit": "^0.11.0",
     "@xterm/addon-web-links": "^0.12.0",

package/public-api.d.mts

@@ -1,4 +1,4 @@
-import { ICliCommandProcessor, ICliCommandParameterDescriptor as ICliCommandParameterDescriptor$1, ICliCommandProcessorRegistry, ICliCommandChildProcessor, CliProcessorMetadata, CliStateConfiguration, ICliExecutionContext, CliProcessCommand, ICliCommandAuthor, CliThemeInfo, ICliExecutionProcess, ICliUserSession, ICliSpinner, ICliPercentageProgressBar, ICliTextAnimator, ICliTerminalWriter, ICliCommandExecutorService, ICliClipboard, ICliStateStore, CliOptions, ICliLogger, ICliServiceProvider, ICliTranslationService, ICliInputReader, ICliBackgroundServiceRegistry, ICliHttpClient, ICliNotifier, ICliManagedInterval, ICliManagedTimer, ICliEventBus, ICliKeyValueStore, CliStateStoreOptions, ICliCompletionProvider, ICliFilePickerProvider, CliFullScreenOptions, ICliProcessRegistry, ICliBackgroundService, ICliServiceContext, ICliBackgroundServiceInfo, ICliServiceLogEntry, CliServiceEventHandler, ICliGlobalParameterHandler, CliForegroundColor, CliBackgroundColor, CliToken, CliProvider, CliTableOptions, CliLogLevel, CliPercentageProgressBarUpdateValueOptions, CliTextAnimatorOptions, ICliModule, CliModuleRegistry, Package, ICliPingServerService, CliLineOptions, CliSelectOption, CliSelectOptions, CliMultiSelectOption, CliMultiSelectOptions, CliNumberOptions, CliDateOptions, CliFilePickerOptions, CliFileResult, ICliProcessRegisterOptions, ICliProcessEntry, ICliDragDropService, CliHttpRequestOptions, CliNotification, ICliPermissionRegistry, CliPermissionDefinition, CliState, CliEngineSnapshot, CliEvent, CliEventType, CliEventMap, CliEmitOptions, CustomEventType, CliEventHandler, CliServerConfig, ICliServerAuthService, CliServerCommandDescriptor, CliServerCapabilities, CliServerResponse, CliServerOutput, CliPanelPosition, CliPanelConfig, CliPanelHideAlignment, ICliPanelRef, CliPanelState } from '@qodalis/cli-core';
+import { ICliCommandProcessor, ICliCommandParameterDescriptor as ICliCommandParameterDescriptor$1, ICliCommandProcessorRegistry, ICliCommandChildProcessor, CliProcessorMetadata, CliStateConfiguration, ICliExecutionContext, CliProcessCommand, ICliCommandAuthor, ICliCommandControls, CliThemeInfo, ICliExecutionProcess, ICliUserSession, ICliSpinner, ICliPercentageProgressBar, ICliTextAnimator, ICliTerminalWriter, ICliCommandExecutorService, ICliClipboard, ICliStateStore, CliOptions, ICliLogger, ICliServiceProvider, ICliTranslationService, ICliInputReader, ICliBackgroundServiceRegistry, ICliHttpClient, ICliNotifier, ICliManagedInterval, ICliManagedTimer, ICliEventBus, ICliKeyValueStore, CliStateStoreOptions, ICliCompletionProvider, ICliFilePickerProvider, CliFullScreenOptions, ICliProcessRegistry, ICliBackgroundService, ICliServiceContext, ICliBackgroundServiceInfo, ICliServiceLogEntry, CliServiceEventHandler, ICliGlobalParameterHandler, CliForegroundColor, CliBackgroundColor, CliToken, CliProvider, CliTableOptions, CliLogLevel, CliPercentageProgressBarUpdateValueOptions, CliTextAnimatorOptions, ICliModule, CliModuleRegistry, Package, ICliPingServerService, CliLineOptions, CliSelectOption, CliSelectOptions, CliMultiSelectOption, CliMultiSelectOptions, CliNumberOptions, CliDateOptions, CliFilePickerOptions, CliFileResult, ICliProcessRegisterOptions, ICliProcessEntry, ICliDragDropService, CliHttpRequestOptions, CliNotification, ICliPermissionRegistry, CliPermissionDefinition, CliState, CliEngineSnapshot, CliEvent, CliEventType, CliEventMap, CliEmitOptions, CustomEventType, CliEventHandler, CliServerConfig, ICliServerAuthService, CliServerCommandDescriptor, CliServerCapabilities, CliServerResponse, CliServerOutput, CliPanelPosition, CliPanelConfig, CliPanelHideAlignment, ICliPanelRef, CliPanelState } from '@qodalis/cli-core';
 export { ICliUserSessionService_TOKEN, ICliUsersStoreService_TOKEN } from '@qodalis/cli-core';
 import { ITheme, Terminal, ITerminalAddon, ITerminalOptions, ITerminalInitOnlyOptions } from '@xterm/xterm';
 import * as rxjs from 'rxjs';
@@ -165,7 +165,7 @@ declare const CliKeyValueStore_TOKEN: any;
  */
 declare const SyntaxHighlighterRegistry_TOKEN: any;
 
-declare const LIBRARY_VERSION = "2.0.0-rc.2";
+declare const LIBRARY_VERSION = "2.0.0-rc.4";
 declare const API_VERSION = 2;
 
 declare class CliAliasCommandProcessor implements ICliCommandProcessor {
@@ -655,6 +655,7 @@ declare class CliNanoCommandProcessor implements ICliCommandProcessor {
     author: any;
     acceptsRawInput: boolean;
     metadata: CliProcessorMetadata;
+    controls: ICliCommandControls;
     private buffer;
     private renderer;
     private filePath;
@@ -740,6 +741,7 @@ declare class CliKillCommandProcessor implements ICliCommandProcessor {
 
 declare class CliHtopCommandProcessor implements ICliCommandProcessor {
     command: string;
+    controls: ICliCommandControls;
     description: string;
     author: any;
     metadata?: CliProcessorMetadata;
@@ -3334,6 +3336,7 @@ declare class CliServerCommandProcessor implements ICliCommandProcessor {
 
 declare class CliSshCommandProcessor implements ICliCommandProcessor {
     command: string;
+    controls: ICliCommandControls;
     aliases: string[];
     description: string;
     acceptsRawInput: boolean;

package/public-api.d.ts

@@ -1,4 +1,4 @@
-import { ICliCommandProcessor, ICliCommandParameterDescriptor as ICliCommandParameterDescriptor$1, ICliCommandProcessorRegistry, ICliCommandChildProcessor, CliProcessorMetadata, CliStateConfiguration, ICliExecutionContext, CliProcessCommand, ICliCommandAuthor, CliThemeInfo, ICliExecutionProcess, ICliUserSession, ICliSpinner, ICliPercentageProgressBar, ICliTextAnimator, ICliTerminalWriter, ICliCommandExecutorService, ICliClipboard, ICliStateStore, CliOptions, ICliLogger, ICliServiceProvider, ICliTranslationService, ICliInputReader, ICliBackgroundServiceRegistry, ICliHttpClient, ICliNotifier, ICliManagedInterval, ICliManagedTimer, ICliEventBus, ICliKeyValueStore, CliStateStoreOptions, ICliCompletionProvider, ICliFilePickerProvider, CliFullScreenOptions, ICliProcessRegistry, ICliBackgroundService, ICliServiceContext, ICliBackgroundServiceInfo, ICliServiceLogEntry, CliServiceEventHandler, ICliGlobalParameterHandler, CliForegroundColor, CliBackgroundColor, CliToken, CliProvider, CliTableOptions, CliLogLevel, CliPercentageProgressBarUpdateValueOptions, CliTextAnimatorOptions, ICliModule, CliModuleRegistry, Package, ICliPingServerService, CliLineOptions, CliSelectOption, CliSelectOptions, CliMultiSelectOption, CliMultiSelectOptions, CliNumberOptions, CliDateOptions, CliFilePickerOptions, CliFileResult, ICliProcessRegisterOptions, ICliProcessEntry, ICliDragDropService, CliHttpRequestOptions, CliNotification, ICliPermissionRegistry, CliPermissionDefinition, CliState, CliEngineSnapshot, CliEvent, CliEventType, CliEventMap, CliEmitOptions, CustomEventType, CliEventHandler, CliServerConfig, ICliServerAuthService, CliServerCommandDescriptor, CliServerCapabilities, CliServerResponse, CliServerOutput, CliPanelPosition, CliPanelConfig, CliPanelHideAlignment, ICliPanelRef, CliPanelState } from '@qodalis/cli-core';
+import { ICliCommandProcessor, ICliCommandParameterDescriptor as ICliCommandParameterDescriptor$1, ICliCommandProcessorRegistry, ICliCommandChildProcessor, CliProcessorMetadata, CliStateConfiguration, ICliExecutionContext, CliProcessCommand, ICliCommandAuthor, ICliCommandControls, CliThemeInfo, ICliExecutionProcess, ICliUserSession, ICliSpinner, ICliPercentageProgressBar, ICliTextAnimator, ICliTerminalWriter, ICliCommandExecutorService, ICliClipboard, ICliStateStore, CliOptions, ICliLogger, ICliServiceProvider, ICliTranslationService, ICliInputReader, ICliBackgroundServiceRegistry, ICliHttpClient, ICliNotifier, ICliManagedInterval, ICliManagedTimer, ICliEventBus, ICliKeyValueStore, CliStateStoreOptions, ICliCompletionProvider, ICliFilePickerProvider, CliFullScreenOptions, ICliProcessRegistry, ICliBackgroundService, ICliServiceContext, ICliBackgroundServiceInfo, ICliServiceLogEntry, CliServiceEventHandler, ICliGlobalParameterHandler, CliForegroundColor, CliBackgroundColor, CliToken, CliProvider, CliTableOptions, CliLogLevel, CliPercentageProgressBarUpdateValueOptions, CliTextAnimatorOptions, ICliModule, CliModuleRegistry, Package, ICliPingServerService, CliLineOptions, CliSelectOption, CliSelectOptions, CliMultiSelectOption, CliMultiSelectOptions, CliNumberOptions, CliDateOptions, CliFilePickerOptions, CliFileResult, ICliProcessRegisterOptions, ICliProcessEntry, ICliDragDropService, CliHttpRequestOptions, CliNotification, ICliPermissionRegistry, CliPermissionDefinition, CliState, CliEngineSnapshot, CliEvent, CliEventType, CliEventMap, CliEmitOptions, CustomEventType, CliEventHandler, CliServerConfig, ICliServerAuthService, CliServerCommandDescriptor, CliServerCapabilities, CliServerResponse, CliServerOutput, CliPanelPosition, CliPanelConfig, CliPanelHideAlignment, ICliPanelRef, CliPanelState } from '@qodalis/cli-core';
 export { ICliUserSessionService_TOKEN, ICliUsersStoreService_TOKEN } from '@qodalis/cli-core';
 import { ITheme, Terminal, ITerminalAddon, ITerminalOptions, ITerminalInitOnlyOptions } from '@xterm/xterm';
 import * as rxjs from 'rxjs';
@@ -165,7 +165,7 @@ declare const CliKeyValueStore_TOKEN: any;
  */
 declare const SyntaxHighlighterRegistry_TOKEN: any;
 
-declare const LIBRARY_VERSION = "2.0.0-rc.2";
+declare const LIBRARY_VERSION = "2.0.0-rc.4";
 declare const API_VERSION = 2;
 
 declare class CliAliasCommandProcessor implements ICliCommandProcessor {
@@ -655,6 +655,7 @@ declare class CliNanoCommandProcessor implements ICliCommandProcessor {
     author: any;
     acceptsRawInput: boolean;
     metadata: CliProcessorMetadata;
+    controls: ICliCommandControls;
     private buffer;
     private renderer;
     private filePath;
@@ -740,6 +741,7 @@ declare class CliKillCommandProcessor implements ICliCommandProcessor {
 
 declare class CliHtopCommandProcessor implements ICliCommandProcessor {
     command: string;
+    controls: ICliCommandControls;
     description: string;
     author: any;
     metadata?: CliProcessorMetadata;
@@ -3334,6 +3336,7 @@ declare class CliServerCommandProcessor implements ICliCommandProcessor {
 
 declare class CliSshCommandProcessor implements ICliCommandProcessor {
     command: string;
+    controls: ICliCommandControls;
     aliases: string[];
     description: string;
     acceptsRawInput: boolean;

package/public-api.js

@@ -519,7 +519,7 @@ var CliKeyValueStore_TOKEN = cliCore.createCliToken("cli-key-value-store");
 var SyntaxHighlighterRegistry_TOKEN = cliCore.createCliToken("syntax-highlighter-registry");
 
 // src/lib/version.ts
-var LIBRARY_VERSION = "2.0.0-rc.2";
+var LIBRARY_VERSION = "2.0.0-rc.4";
 var API_VERSION = 2;
 var ANONYMOUS = "\0anonymous";
 function aliasOwner(context2) {
@@ -10155,6 +10155,26 @@ var CliNanoCommandProcessor = class {
       icon: "\u{1F4DD}",
       module: "system"
     };
+    this.controls = {
+      textInput: true,
+      keys: [
+        { label: "Save", key: "Ctrl+S", data: cliCore.CliKeyData.ctrl("s"), description: "Save the file" },
+        { label: "Exit", key: "Ctrl+X", data: cliCore.CliKeyData.ctrl("x"), description: "Exit (asks to save changes)" },
+        { label: "Find", key: "Ctrl+W", data: cliCore.CliKeyData.ctrl("w"), description: "Search" },
+        { label: "Cut", key: "Ctrl+K", data: cliCore.CliKeyData.ctrl("k"), description: "Cut the line" },
+        { label: "Paste", key: "Ctrl+U", data: cliCore.CliKeyData.ctrl("u"), description: "Paste the cut text" },
+        { label: "Help", key: "Ctrl+G", data: cliCore.CliKeyData.ctrl("g"), description: "Show the help" },
+        { label: "Esc", key: "Esc", data: cliCore.CliKeyData.escape, description: "Cancel a prompt" },
+        { label: "\u2190", key: "Left", data: cliCore.CliKeyData.left, description: "Left", repeat: true },
+        { label: "\u2191", key: "Up", data: cliCore.CliKeyData.up, description: "Up", repeat: true },
+        { label: "\u2193", key: "Down", data: cliCore.CliKeyData.down, description: "Down", repeat: true },
+        { label: "\u2192", key: "Right", data: cliCore.CliKeyData.right, description: "Right", repeat: true },
+        { label: "Home", key: "Home", data: cliCore.CliKeyData.home, description: "Start of the line" },
+        { label: "End", key: "End", data: cliCore.CliKeyData.end, description: "End of the line" },
+        { label: "PgUp", key: "PageUp", data: cliCore.CliKeyData.pageUp, description: "Page up", repeat: true },
+        { label: "PgDn", key: "PageDown", data: cliCore.CliKeyData.pageDown, description: "Page down", repeat: true }
+      ]
+    };
     this.filePath = null;
     this.fs = null;
     this.resizeDisposable = null;
@@ -11525,6 +11545,18 @@ function pad(str, len) {
 var CliHtopCommandProcessor = class {
   constructor() {
     this.command = "htop";
+    this.controls = {
+      keys: [
+        { label: "\u2191", key: "Up", data: cliCore.CliKeyData.up, description: "Select the previous process", repeat: true },
+        { label: "\u2193", key: "Down", data: cliCore.CliKeyData.down, description: "Select the next process", repeat: true },
+        { label: "KILL", key: "K", data: "k", description: "Kill the process" },
+        { label: "START", key: "S", data: "s", description: "Start the service" },
+        { label: "STOP", key: "T", data: "t", description: "Stop the service" },
+        { label: "RESTART", key: "R", data: "r", description: "Restart the service" },
+        { label: "LOGS", key: "L", data: "l", description: "Show the logs" },
+        { label: "Q", key: "Q", data: "q", description: "Quit" }
+      ]
+    };
     this.description = "Interactive process and service monitor";
     this.author = cliCore.DefaultLibraryAuthor;
     this.metadata = {
@@ -21271,6 +21303,20 @@ var ServerDefaultProcessor = class {
 var CliSshCommandProcessor = class {
   constructor() {
     this.command = "ssh";
+    this.controls = {
+      textInput: true,
+      keys: [
+        { label: "ESC", key: "Esc", data: cliCore.CliKeyData.escape, description: "Escape" },
+        { label: "TAB", key: "Tab", data: "	", description: "Complete" },
+        { label: "^C", key: "Ctrl+C", data: cliCore.CliKeyData.ctrl("c"), description: "Interrupt" },
+        { label: "^D", key: "Ctrl+D", data: cliCore.CliKeyData.ctrl("d"), description: "End of input" },
+        { label: "^L", key: "Ctrl+L", data: cliCore.CliKeyData.ctrl("l"), description: "Clear the screen" },
+        { label: "\u2190", key: "Left", data: cliCore.CliKeyData.left, description: "Left", repeat: true },
+        { label: "\u2191", key: "Up", data: cliCore.CliKeyData.up, description: "Up", repeat: true },
+        { label: "\u2193", key: "Down", data: cliCore.CliKeyData.down, description: "Down", repeat: true },
+        { label: "\u2192", key: "Right", data: cliCore.CliKeyData.right, description: "Right", repeat: true }
+      ]
+    };
     this.aliases = ["shell"];
     this.description = "Open a remote shell session on a server";
     this.acceptsRawInput = true;
@@ -22139,6 +22185,50 @@ async function initializeServices(options) {
   };
 }
 
+// src/lib/completion/cli-completion-path.ts
+function resolveCompletionPath(tokens, tokenIndex, processors, currentToken = "") {
+  const parsed = tokens.slice(0, tokenIndex).map(toParsedToken);
+  let processor;
+  let descriptors = [];
+  let candidates = processors;
+  let isFlagValue = false;
+  for (let i = 0; i < parsed.length; i++) {
+    const token = parsed[i];
+    if (token.kind === "flag") {
+      if (!flagTakesNextWord(token, descriptors)) continue;
+      if (i + 1 < parsed.length) {
+        if (parsed[i + 1].kind === "word") i++;
+      } else if (!currentToken.startsWith("-")) {
+        isFlagValue = true;
+      }
+      continue;
+    }
+    const name = token.value.toLowerCase();
+    const match = candidates?.find(
+      (p) => p.command.toLowerCase() === name || p.aliases?.some((a) => a.toLowerCase() === name)
+    );
+    if (match) {
+      processor = match;
+      descriptors = [...match.parameters ?? [], ...descriptors];
+    }
+    candidates = match?.processors?.length ? match.processors : void 0;
+  }
+  return { processor, descriptors, subCommands: candidates, isFlagValue };
+}
+function toParsedToken(text) {
+  const flag = /^(--?)([a-zA-Z0-9_][^\s=]*)(=.*)?$/.exec(text);
+  if (!flag) {
+    return { kind: "word", value: text };
+  }
+  return {
+    kind: "flag",
+    name: flag[2],
+    value: flag[3]?.slice(1) ?? true,
+    hasEquals: flag[3] !== void 0,
+    ...flag[1] === "-" ? { short: true } : {}
+  };
+}
+
 // src/lib/completion/cli-command-completion-provider.ts
 var CliCommandCompletionProvider = class {
   constructor(registry) {
@@ -22150,22 +22240,16 @@ var CliCommandCompletionProvider = class {
     if (tokenIndex === 0) {
       return this.getCommandNames(this.registry.processors, token);
     }
-    const mainCommand = tokens[0];
-    const processor = this.registry.findProcessor(mainCommand, []);
-    if (!processor?.processors?.length) {
+    const path = resolveCompletionPath(
+      tokens,
+      tokenIndex,
+      this.registry.processors,
+      token
+    );
+    if (path.isFlagValue || !path.subCommands) {
       return [];
     }
-    let current = processor;
-    for (let i = 1; i < tokenIndex; i++) {
-      const sub = current.processors?.find(
-        (p) => p.command === tokens[i]
-      );
-      if (!sub?.processors?.length) {
-        return [];
-      }
-      current = sub;
-    }
-    return this.getCommandNames(current.processors ?? [], token);
+    return this.getCommandNames(path.subCommands, token);
   }
   getCommandNames(processors, prefix) {
     const names = [];
@@ -22187,24 +22271,24 @@ var CliParameterCompletionProvider = class {
     this.priority = 200;
   }
   getCompletions(context2) {
-    const { tokens, token } = context2;
+    const { tokens, tokenIndex, token } = context2;
     if (!token.startsWith("-")) {
       return [];
     }
     if (tokens.length === 0) {
       return [];
     }
-    const mainCommand = tokens[0];
-    const chainCommands = tokens.slice(1).filter((t) => !t.startsWith("-"));
-    const processor = this.registry.findProcessorInCollection(
-      mainCommand,
-      chainCommands,
-      this.registry.processors
+    const path = resolveCompletionPath(
+      tokens,
+      tokenIndex,
+      this.registry.processors,
+      token
     );
+    const seen = /* @__PURE__ */ new Set();
     const allParameters = [
-      ...processor?.parameters ?? [],
+      ...path.descriptors,
       ...this.executor.getGlobalParameters()
-    ];
+    ].filter((p) => !seen.has(p.name) && !!seen.add(p.name));
     if (allParameters.length === 0) {
       return [];
     }