@qodalis/cli 2.1.0 → 2.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qodalis/cli",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "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.1.0",
+    "@qodalis/cli-core": "2.2.0",
     "@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, 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, CliBranding, 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, CliBranding, CliState, CliEngineSnapshot, CliEvent, CliEventType, CliEventMap, CliEmitOptions, CustomEventType, CliEventHandler, CliServerConfig, ICliServerAuthService, CliServerCommandDescriptor, CliServerCapabilities, CliServerResponse, CliServerOutput, CliPanelPosition, CliPanelConfig, CliPanelHideAlignment, ICliPanelRef, CliPanelThemeInput, 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.1.0";
+declare const LIBRARY_VERSION = "2.2.0";
 declare const API_VERSION = 2;
 
 declare class CliAliasCommandProcessor implements ICliCommandProcessor {
@@ -2977,6 +2977,11 @@ declare class CliEngine {
      * Focus the terminal and fit to container.
      */
     focus(): void;
+    /**
+     * Restyle the terminal: its colors and the background around it.
+     * The `theme` command can still change it afterwards.
+     */
+    setTheme(theme: ITheme): void;
     /**
      * Get the underlying xterm.js Terminal instance.
      */
@@ -3182,6 +3187,12 @@ declare class CliServerConnection {
     onReconnected?: () => void;
     constructor(_config: CliServerConfig, _backgroundServices?: ICliBackgroundServiceRegistry, _logger?: ICliLogger, _authService?: ICliServerAuthService);
     get config(): CliServerConfig;
+    /**
+     * The last connect was refused for want of a sign-in (401 or 403 on the
+     * command list): the server is up, and a sign-in reconnects it.
+     */
+    get needsSignIn(): boolean;
+    private _needsSignIn;
     get connected(): boolean;
     get commands(): CliServerCommandDescriptor[];
     get capabilities(): CliServerCapabilities | null;
@@ -3689,7 +3700,19 @@ interface CliPanelSnapshot {
     /** Status text is shown in the header for top/bottom, compact dots otherwise. */
     showStatusIndicators: boolean;
     panelResizing: boolean;
+    /** CSS custom properties of the theme, for the wrapper and the hide tab. */
     themeStyles: Record<string, string>;
+    /** Whether the panel is light or dark. */
+    scheme: 'light' | 'dark';
+    /** Theme the host set for the terminals; undefined leaves them alone. */
+    terminalTheme?: ITheme;
+    /**
+     * Height of the on-screen keyboard over the page (0 when closed), from the
+     * visual viewport: the panel moves above it.
+     */
+    keyboardInset: number;
+    /** Height of the visible area (visual viewport), 0 when unknown; caps the panel's height. */
+    visibleHeight: number;
     closable: boolean;
     resizable: boolean;
     hideable: boolean;
@@ -3822,11 +3845,21 @@ declare class CliPanelController implements ICliPanelRef<CliEngine> {
     private documentListenersAttached;
     private rootElement;
     private themeObserver?;
+    /** The host's theme (`config.theme`); undefined leaves the terminals' own theme alone. */
+    private themeInput?;
+    private resolvedTheme;
+    private schemeQuery?;
+    private visualViewport?;
     constructor(options?: CliPanelControllerOptions);
     readonly subscribe: (listener: () => void) => (() => void);
     readonly getSnapshot: () => CliPanelSnapshot;
-    /** Apply a new panel configuration (chrome buttons, theme sync). */
+    /** Apply a new panel configuration (chrome buttons, theme, theme sync). */
     setOptions(config: CliPanelConfig | undefined): void;
+    /**
+     * Restyle the panel and every terminal in it (see `CliPanelConfig.theme`).
+     * `undefined` returns to the default palette and leaves the terminals' theme alone.
+     */
+    setTheme(theme: CliPanelThemeInput | undefined): void;
     /** Replace the change callbacks (wrappers call this when their props change). */
     setCallbacks(callbacks: CliPanelCallbacks): void;
     /** Update host-controlled values. Unchanged values are ignored. */
@@ -3886,9 +3919,9 @@ declare class CliPanelController implements ICliPanelRef<CliEngine> {
     toggleServersDropdown(anchor?: Element | null): void;
     /** Close the context menu and every dropdown. */
     closeMenus(): void;
-    /** Mouse down on the panel's resize bar. */
+    /** Pointer (mouse, touch or pen) down on the panel's resize bar. */
     startPanelResize(clientX: number, clientY: number): void;
-    /** Mouse down on the divider before pane `dividerIndex + 1` of a tab. */
+    /** Pointer down on the divider before pane `dividerIndex + 1` of a tab. */
     startPaneResize(tabId: number, dividerIndex: number, clientX: number, containerWidth: number): void;
     private readonly onPanelResizeMove;
     private readonly onPanelResizeEnd;
@@ -3908,6 +3941,17 @@ declare class CliPanelController implements ICliPanelRef<CliEngine> {
      * Engines are registered after they start, so their theme is set.
      */
     private startThemeSync;
+    private applyTheme;
+    /** Follow the system's light/dark setting while the theme is 'auto'. */
+    private watchSystemScheme;
+    private readonly onSystemSchemeChange;
+    /**
+     * Phone browsers open the keyboard over the page and shrink only the visual
+     * viewport; follow it so the panel stays above the keyboard.
+     */
+    private watchVisualViewport;
+    private unwatchVisualViewport;
+    private readonly onVisualViewportChange;
     private stopThemeSync;
     private ensureInitialized;
     private updateCollapsed;
@@ -4011,6 +4055,7 @@ declare function positionDropdownItemClass(s: CliPanelSnapshot, position: CliPan
 /** Size, visibility and theme variables of the panel wrapper. */
 declare function panelWrapperStyle(s: CliPanelSnapshot): Record<string, string>;
 declare function paneStyle(widthPercent: number): Record<string, string>;
+/** Menus render outside the panel element, so they carry the theme's variables themselves. */
 declare function contextMenuStyle(s: CliPanelSnapshot): Record<string, string>;
 interface PanelStatusIndicator {
     key: 'execution' | 'services' | 'lastCommand' | 'servers' | 'uptime' | 'notification';

package/public-api.d.ts

@@ -1,4 +1,4 @@
-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, CliBranding, 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, CliBranding, CliState, CliEngineSnapshot, CliEvent, CliEventType, CliEventMap, CliEmitOptions, CustomEventType, CliEventHandler, CliServerConfig, ICliServerAuthService, CliServerCommandDescriptor, CliServerCapabilities, CliServerResponse, CliServerOutput, CliPanelPosition, CliPanelConfig, CliPanelHideAlignment, ICliPanelRef, CliPanelThemeInput, 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.1.0";
+declare const LIBRARY_VERSION = "2.2.0";
 declare const API_VERSION = 2;
 
 declare class CliAliasCommandProcessor implements ICliCommandProcessor {
@@ -2977,6 +2977,11 @@ declare class CliEngine {
      * Focus the terminal and fit to container.
      */
     focus(): void;
+    /**
+     * Restyle the terminal: its colors and the background around it.
+     * The `theme` command can still change it afterwards.
+     */
+    setTheme(theme: ITheme): void;
     /**
      * Get the underlying xterm.js Terminal instance.
      */
@@ -3182,6 +3187,12 @@ declare class CliServerConnection {
     onReconnected?: () => void;
     constructor(_config: CliServerConfig, _backgroundServices?: ICliBackgroundServiceRegistry, _logger?: ICliLogger, _authService?: ICliServerAuthService);
     get config(): CliServerConfig;
+    /**
+     * The last connect was refused for want of a sign-in (401 or 403 on the
+     * command list): the server is up, and a sign-in reconnects it.
+     */
+    get needsSignIn(): boolean;
+    private _needsSignIn;
     get connected(): boolean;
     get commands(): CliServerCommandDescriptor[];
     get capabilities(): CliServerCapabilities | null;
@@ -3689,7 +3700,19 @@ interface CliPanelSnapshot {
     /** Status text is shown in the header for top/bottom, compact dots otherwise. */
     showStatusIndicators: boolean;
     panelResizing: boolean;
+    /** CSS custom properties of the theme, for the wrapper and the hide tab. */
     themeStyles: Record<string, string>;
+    /** Whether the panel is light or dark. */
+    scheme: 'light' | 'dark';
+    /** Theme the host set for the terminals; undefined leaves them alone. */
+    terminalTheme?: ITheme;
+    /**
+     * Height of the on-screen keyboard over the page (0 when closed), from the
+     * visual viewport: the panel moves above it.
+     */
+    keyboardInset: number;
+    /** Height of the visible area (visual viewport), 0 when unknown; caps the panel's height. */
+    visibleHeight: number;
     closable: boolean;
     resizable: boolean;
     hideable: boolean;
@@ -3822,11 +3845,21 @@ declare class CliPanelController implements ICliPanelRef<CliEngine> {
     private documentListenersAttached;
     private rootElement;
     private themeObserver?;
+    /** The host's theme (`config.theme`); undefined leaves the terminals' own theme alone. */
+    private themeInput?;
+    private resolvedTheme;
+    private schemeQuery?;
+    private visualViewport?;
     constructor(options?: CliPanelControllerOptions);
     readonly subscribe: (listener: () => void) => (() => void);
     readonly getSnapshot: () => CliPanelSnapshot;
-    /** Apply a new panel configuration (chrome buttons, theme sync). */
+    /** Apply a new panel configuration (chrome buttons, theme, theme sync). */
     setOptions(config: CliPanelConfig | undefined): void;
+    /**
+     * Restyle the panel and every terminal in it (see `CliPanelConfig.theme`).
+     * `undefined` returns to the default palette and leaves the terminals' theme alone.
+     */
+    setTheme(theme: CliPanelThemeInput | undefined): void;
     /** Replace the change callbacks (wrappers call this when their props change). */
     setCallbacks(callbacks: CliPanelCallbacks): void;
     /** Update host-controlled values. Unchanged values are ignored. */
@@ -3886,9 +3919,9 @@ declare class CliPanelController implements ICliPanelRef<CliEngine> {
     toggleServersDropdown(anchor?: Element | null): void;
     /** Close the context menu and every dropdown. */
     closeMenus(): void;
-    /** Mouse down on the panel's resize bar. */
+    /** Pointer (mouse, touch or pen) down on the panel's resize bar. */
     startPanelResize(clientX: number, clientY: number): void;
-    /** Mouse down on the divider before pane `dividerIndex + 1` of a tab. */
+    /** Pointer down on the divider before pane `dividerIndex + 1` of a tab. */
     startPaneResize(tabId: number, dividerIndex: number, clientX: number, containerWidth: number): void;
     private readonly onPanelResizeMove;
     private readonly onPanelResizeEnd;
@@ -3908,6 +3941,17 @@ declare class CliPanelController implements ICliPanelRef<CliEngine> {
      * Engines are registered after they start, so their theme is set.
      */
     private startThemeSync;
+    private applyTheme;
+    /** Follow the system's light/dark setting while the theme is 'auto'. */
+    private watchSystemScheme;
+    private readonly onSystemSchemeChange;
+    /**
+     * Phone browsers open the keyboard over the page and shrink only the visual
+     * viewport; follow it so the panel stays above the keyboard.
+     */
+    private watchVisualViewport;
+    private unwatchVisualViewport;
+    private readonly onVisualViewportChange;
     private stopThemeSync;
     private ensureInitialized;
     private updateCollapsed;
@@ -4011,6 +4055,7 @@ declare function positionDropdownItemClass(s: CliPanelSnapshot, position: CliPan
 /** Size, visibility and theme variables of the panel wrapper. */
 declare function panelWrapperStyle(s: CliPanelSnapshot): Record<string, string>;
 declare function paneStyle(widthPercent: number): Record<string, string>;
+/** Menus render outside the panel element, so they carry the theme's variables themselves. */
 declare function contextMenuStyle(s: CliPanelSnapshot): Record<string, string>;
 interface PanelStatusIndicator {
     key: 'execution' | 'services' | 'lastCommand' | 'servers' | 'uptime' | 'notification';