@qodalis/cli 2.0.0-beta.20 → 2.0.0-beta.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qodalis/cli",
-  "version": "2.0.0-beta.20",
+  "version": "2.0.0-beta.21",
   "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-beta.20",
+    "@qodalis/cli-core": "2.0.0-beta.21",
     "@xterm/xterm": "^5.5.0",
     "@xterm/addon-fit": "^0.10.0",
     "@xterm/addon-web-links": "^0.11.0",

package/public-api.d.mts

@@ -165,7 +165,7 @@ declare const CliKeyValueStore_TOKEN: any;
  */
 declare const SyntaxHighlighterRegistry_TOKEN: any;
 
-declare const LIBRARY_VERSION = "2.0.0-beta.20";
+declare const LIBRARY_VERSION = "2.0.0-beta.21";
 declare const API_VERSION = 2;
 
 declare class CliAliasCommandProcessor implements ICliCommandProcessor {
@@ -2850,6 +2850,21 @@ interface CliEngineOptions extends CliOptions {
      * `/assets/wasm/` and `/wasm/`; the CLI works without it.
      */
     wasmUrl?: string;
+    /**
+     * The welcome banner and greeting shown at startup. `false` starts with
+     * just the prompt (embedded terminals, playgrounds, terminals driven by
+     * `execute()`); an object configures the banner like
+     * `welcomeModule.configure()`.
+     * @default true
+     */
+    welcome?: boolean | CliWelcomeMessageConfig;
+    /**
+     * Focus the terminal when it starts. Turn it off when the terminal sits
+     * next to other inputs that should keep the keyboard (an editor that
+     * rebuilds the terminal while the user types); `focus()` still works.
+     * @default true
+     */
+    autoFocus?: boolean;
 }
 declare class CliEngine {
     private readonly container;
@@ -2931,6 +2946,8 @@ declare class CliEngine {
      * greeting, which runs after every other `onAfterBoot` hook.
      */
     private modulesToBoot;
+    /** Whether startup shows the welcome banner (which also shows the first prompt). */
+    private get showsWelcome();
     /** 7. Replace the boot report with the terminal and mark the CLI booted. */
     private completeBoot;
     /**
@@ -3026,7 +3043,7 @@ declare function getTerminalOptions(userOptions?: Partial<ITerminalOptions & ITe
  * Create and configure an xterm.js Terminal with all required addons,
  * open it into the given container, and return the instances.
  */
-declare function initializeTerminal(container: HTMLElement, opts: ITerminalOptions & ITerminalInitOnlyOptions): TerminalSetupResult;
+declare function initializeTerminal(container: HTMLElement, opts: ITerminalOptions & ITerminalInitOnlyOptions, focus?: boolean): TerminalSetupResult;
 /**
  * Wait until the container element has non-zero dimensions.
  * xterm.js requires the host element to be laid out before open() is called.

package/public-api.d.ts

@@ -165,7 +165,7 @@ declare const CliKeyValueStore_TOKEN: any;
  */
 declare const SyntaxHighlighterRegistry_TOKEN: any;
 
-declare const LIBRARY_VERSION = "2.0.0-beta.20";
+declare const LIBRARY_VERSION = "2.0.0-beta.21";
 declare const API_VERSION = 2;
 
 declare class CliAliasCommandProcessor implements ICliCommandProcessor {
@@ -2850,6 +2850,21 @@ interface CliEngineOptions extends CliOptions {
      * `/assets/wasm/` and `/wasm/`; the CLI works without it.
      */
     wasmUrl?: string;
+    /**
+     * The welcome banner and greeting shown at startup. `false` starts with
+     * just the prompt (embedded terminals, playgrounds, terminals driven by
+     * `execute()`); an object configures the banner like
+     * `welcomeModule.configure()`.
+     * @default true
+     */
+    welcome?: boolean | CliWelcomeMessageConfig;
+    /**
+     * Focus the terminal when it starts. Turn it off when the terminal sits
+     * next to other inputs that should keep the keyboard (an editor that
+     * rebuilds the terminal while the user types); `focus()` still works.
+     * @default true
+     */
+    autoFocus?: boolean;
 }
 declare class CliEngine {
     private readonly container;
@@ -2931,6 +2946,8 @@ declare class CliEngine {
      * greeting, which runs after every other `onAfterBoot` hook.
      */
     private modulesToBoot;
+    /** Whether startup shows the welcome banner (which also shows the first prompt). */
+    private get showsWelcome();
     /** 7. Replace the boot report with the terminal and mark the CLI booted. */
     private completeBoot;
     /**
@@ -3026,7 +3043,7 @@ declare function getTerminalOptions(userOptions?: Partial<ITerminalOptions & ITe
  * Create and configure an xterm.js Terminal with all required addons,
  * open it into the given container, and return the instances.
  */
-declare function initializeTerminal(container: HTMLElement, opts: ITerminalOptions & ITerminalInitOnlyOptions): TerminalSetupResult;
+declare function initializeTerminal(container: HTMLElement, opts: ITerminalOptions & ITerminalInitOnlyOptions, focus?: boolean): TerminalSetupResult;
 /**
  * Wait until the container element has non-zero dimensions.
  * xterm.js requires the host element to be laid out before open() is called.

package/public-api.js

@@ -512,7 +512,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-beta.20";
+var LIBRARY_VERSION = "2.0.0-beta.21";
 var API_VERSION = 2;
 var ANONYMOUS = "\0anonymous";
 function aliasOwner(context2) {
@@ -4188,7 +4188,7 @@ function getTerminalOptions(userOptions) {
     ...userOptions ?? {}
   };
 }
-function initializeTerminal(container, opts) {
+function initializeTerminal(container, opts, focus = true) {
   const terminal = new xterm.Terminal(opts);
   const fitAddon = new addonFit.FitAddon();
   terminal.loadAddon(fitAddon);
@@ -4209,7 +4209,9 @@ function initializeTerminal(container, opts) {
   container.style.background = opts.theme?.background ?? "#000";
   const wheelListener = (e) => e.preventDefault();
   container.addEventListener("wheel", wheelListener, { passive: false });
-  terminal.focus();
+  if (focus) {
+    terminal.focus();
+  }
   const dragDropService = new CliDragDropService(container);
   return { terminal, fitAddon, serializeAddon, dragDropService, wheelListener };
 }
@@ -22586,6 +22588,9 @@ var CliEngine = class {
     }
     await this.completeBoot(bootLog);
     await this.runAfterBootHooks(modules);
+    if (this.options?.welcome === false && !this.options?.snapshot) {
+      this.executionContext.showPrompt();
+    }
     if (this.options?.snapshot) {
       await this.restoreSnapshot(this.options.snapshot);
     }
@@ -22600,7 +22605,11 @@ var CliEngine = class {
     this.terminalOptions = getTerminalOptions(
       this.options?.terminalOptions
     );
-    const setup = initializeTerminal(this.container, this.terminalOptions);
+    const setup = initializeTerminal(
+      this.container,
+      this.terminalOptions,
+      this.options?.autoFocus !== false
+    );
     this.terminal = setup.terminal;
     this.fitAddon = setup.fitAddon;
     this.serializeAddon = setup.serializeAddon;
@@ -22737,13 +22746,21 @@ var CliEngine = class {
    */
   modulesToBoot() {
     const serverModule = createServerModule();
-    return this.options?.snapshot ? [serverModule, ...this.userModules] : [
-      welcomeModule,
+    if (!this.showsWelcome) {
+      return [serverModule, ...this.userModules];
+    }
+    const welcome = this.options?.welcome;
+    return [
+      typeof welcome === "object" ? welcomeModule.configure(welcome) : welcomeModule,
       serverModule,
       ...this.userModules,
       greetingModule
     ];
   }
+  /** Whether startup shows the welcome banner (which also shows the first prompt). */
+  get showsWelcome() {
+    return !this.options?.snapshot && this.options?.welcome !== false;
+  }
   /** 7. Replace the boot report with the terminal and mark the CLI booted. */
   async completeBoot(bootLog) {
     await bootLog.finish(