@nu-art/commando 0.204.13 → 0.204.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nu-art/commando",
-  "version": "0.204.13",
+  "version": "0.204.14",
   "description": "",
   "keywords": [
     "TacB0sS",
@@ -31,6 +31,7 @@
     "build": "tsc"
   },
   "dependencies": {
+    "neo-blessed": "^0.2.0",
     "@nu-art/ts-common": "~0.204.0"
   },
   "devDependencies": {

package/screen/Screen.d.ts

@@ -0,0 +1,19 @@
+import { ResolvableContent } from '@nu-art/ts-common';
+import { BoxOptions, ScreenOptions, WidgetTypes } from './types';
+import * as blessed from 'neo-blessed';
+export declare abstract class Screen<State extends object> {
+    protected state: State;
+    private screen;
+    protected readonly widgets: blessed.Widgets.Node[];
+    constructor(props?: ScreenOptions);
+    setState(state: ResolvableContent<Partial<State>>): void;
+    createWidget(type: WidgetTypes, props: Omit<BoxOptions, 'parent'>): any;
+    getFocusedWidget(): any;
+    protected abstract render(): void;
+    enable(): void;
+    disable(): void;
+    /**
+     * Clears all widgets from the screen and optionally clears the screen.
+     */
+    clearScreen(clearContent?: boolean): void;
+}

package/screen/Screen.js

@@ -0,0 +1,77 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Screen = void 0;
+const ts_common_1 = require("@nu-art/ts-common");
+// @ts-ignore
+const blessed = __importStar(require("neo-blessed"));
+class Screen {
+    constructor(props) {
+        var _a;
+        this.widgets = [];
+        this.screen = blessed.screen(props);
+        (_a = props === null || props === void 0 ? void 0 : props.keyBinding) === null || _a === void 0 ? void 0 : _a.map(keyBinding => {
+            this.screen.key(keyBinding.keys, keyBinding.callback);
+        });
+    }
+    setState(state) {
+        this.state = Object.freeze((0, ts_common_1.mergeObject)(this.state, state));
+        this.render();
+    }
+    createWidget(type, props) {
+        const widget = blessed[type](Object.assign(Object.assign({}, props), { parent: this.screen }));
+        this.widgets.push(widget);
+        return widget;
+    }
+    getFocusedWidget() {
+        return this.screen.focused;
+    }
+    enable() {
+        this.widgets.forEach(widget => {
+            widget.focusable = true;
+            widget.interactive = true;
+        });
+        this.screen.render();
+    }
+    disable() {
+        this.widgets.forEach(widget => {
+            widget.focusable = false;
+            widget.interactive = false;
+        });
+        this.screen.render();
+    }
+    /**
+     * Clears all widgets from the screen and optionally clears the screen.
+     */
+    clearScreen(clearContent = true) {
+        this.widgets.forEach(widget => widget.detach());
+        this.widgets.forEach(widget => (0, ts_common_1.removeFromArray)(this.widgets, widget));
+        if (clearContent) {
+            this.screen.clear();
+        }
+        this.screen.render();
+    }
+}
+exports.Screen = Screen;

package/screen/types.d.ts

@@ -0,0 +1,193 @@
+/// <reference types="node" />
+import * as blessed from 'neo-blessed';
+/**
+ * Styles configuration for the box component.
+ */
+export type BoxStyle = {
+    /** Foreground color. */
+    fg?: string;
+    /** Background color. */
+    bg?: string;
+    /** Make text bold. */
+    bold?: boolean;
+    /** Underline text. */
+    underline?: boolean;
+    /** Make text blink. */
+    blink?: boolean;
+    /** Border styling. */
+    border?: {
+        /** Border type, can be line or background color. */
+        type?: 'line' | 'bg';
+        /** Border color. */
+        fg?: string;
+    };
+    /** Style when hovered over. */
+    hover?: {
+        fg?: string;
+        bg?: string;
+        border?: {
+            fg?: string;
+            bg?: string;
+        };
+    };
+    /** Style when focused. */
+    focus?: {
+        fg?: string;
+        bg?: string;
+        border?: {
+            fg?: string;
+            bg?: string;
+        };
+    };
+    /** Scrollbar styling. */
+    scrollbar?: {
+        bg?: string;
+        fg?: string;
+    };
+};
+/**
+ * Options for configuring a box component in neo-blessed.
+ */
+export type BoxOptions = {
+    /** Parent screen object. */
+    parent?: blessed.Widgets.Screen;
+    /** Top position (can be in pixels or percentage). */
+    top?: number | string;
+    /** Left position (can be in pixels or percentage). */
+    left?: number | string;
+    /** Width of the box (can be in pixels or percentage). */
+    width?: number | string;
+    /** Height of the box (can be in pixels or percentage). */
+    height?: number | string;
+    /** Text content of the box. */
+    content?: string;
+    /** Enables processing of inline tags. */
+    tags?: boolean;
+    /** Enables key handling for this component. */
+    keys?: boolean;
+    /** Enables vi-like navigation. */
+    vi?: boolean;
+    /** Enables mouse interaction. */
+    mouse?: boolean;
+    /** Makes the box scrollable. */
+    scrollable?: boolean;
+    /** Always show the scrollbar if the box is scrollable. */
+    alwaysScroll?: boolean;
+    /** Border configuration. */
+    border?: {
+        /** Type of border ('line' for lines, 'bg' for background). */
+        type: 'line' | 'bg';
+        /** Color of the border. */
+        fg?: string;
+    };
+    /** Label text displayed at the top or next to the widget. */
+    label?: string;
+    /** Styling options for the box. */
+    style?: BoxStyle;
+    /** Vertical alignment of the content. */
+    valign?: 'top' | 'middle' | 'bottom';
+    /** Horizontal alignment of the content. */
+    align?: 'left' | 'center' | 'right';
+    /** Whether the box should respond to input. */
+    interactive?: boolean;
+    /** Configuration for the scrollbar. */
+    scrollbar?: {
+        /** Character used to display the scrollbar. */
+        ch?: string;
+        /** Styling for the track of the scrollbar. */
+        track?: {
+            bg?: string;
+        };
+        /** Style adjustments for the scrollbar. */
+        style?: {
+            inverse?: boolean;
+        };
+    };
+    /** Optional children components, allowing nested structures. */
+    children?: BoxOptions[];
+};
+export type ScreenOptions = {
+    /** Enables smart cursor routing, optimizing re-rendering. */
+    smartCSR?: boolean;
+    /** Enables a faster version of smartCSR for high performance rendering. */
+    fastCSR?: boolean;
+    /** Uses background color erase for reducing flickering. */
+    useBCE?: boolean;
+    /** Specifies the terminal type. Useful for consistent behavior across terminal types. */
+    terminal?: string;
+    /** Allows for full Unicode support. */
+    fullUnicode?: boolean;
+    /** Enables debugging, which logs information about screen operations. */
+    debug?: boolean;
+    /** Path to a file where debug logs will be written. */
+    log?: string;
+    /** Sets the terminal window title (not supported by all terminals). */
+    title?: string;
+    /** Automatically adds padding around the screen content. */
+    autoPadding?: boolean;
+    /** Controls cursor visibility and behavior. */
+    cursor?: {
+        artificial?: boolean;
+        blink?: boolean;
+        shape?: 'block' | 'underline' | 'line';
+    };
+    /** Enables mouse interaction support. */
+    mouse?: boolean;
+    /** Custom input stream for the screen, often used in testing. */
+    input?: NodeJS.ReadableStream;
+    /** Custom output stream for the screen, often used in testing. */
+    output?: NodeJS.WritableStream;
+    /** Time in milliseconds to wait after a resize event before redrawing the screen. */
+    resizeTimeout?: number;
+    keyBinding: {
+        keys: string[];
+        callback: VoidFunction;
+    }[];
+};
+/**
+ * Documentation object simulating an enumeration for widget types.
+ */
+declare const WidgetDocs: {
+    /** A generic container that can hold other widgets or text. */
+    box: null;
+    /** Displays static text on the screen. */
+    text: null;
+    /** Shows a list of selectable items. */
+    list: null;
+    /** Designed for logging continuous text data. */
+    log: null;
+    /** A multi-line text input area for user input. */
+    textarea: null;
+    /** A single-line text input area for user input. */
+    textbox: null;
+    /** Holds input fields, buttons, and other form-related widgets. */
+    form: null;
+    /** Displays a progress bar for showing task progress. */
+    progressbar: null;
+    /** Displays tabular data. */
+    table: null;
+    /** Extends `list` with table-like functionality. */
+    listtable: null;
+    /** Prompts the user to input data. */
+    prompt: null;
+    /** Displays a message box for notifications or alerts. */
+    message: null;
+    /** Shows a loading spinner or message during operations. */
+    loading: null;
+    /** For creating groups of radio buttons for options. */
+    radioset: null;
+    /** A selectable radio button within a radioset. */
+    radiobutton: null;
+    /** Displays a checkbox that users can toggle. */
+    checkbox: null;
+    /** A single-line text input for user data. */
+    input: null;
+    /** A clickable button that can trigger actions. */
+    button: null;
+    /** A visual separator line. */
+    line: null;
+    /** A box that supports vertical scrolling of its content. */
+    scrollablebox: null;
+};
+export type WidgetTypes = keyof typeof WidgetDocs;
+export {};

package/screen/types.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Documentation object simulating an enumeration for widget types.
+ */
+const WidgetDocs = {
+    /** A generic container that can hold other widgets or text. */
+    box: null,
+    /** Displays static text on the screen. */
+    text: null,
+    /** Shows a list of selectable items. */
+    list: null,
+    /** Designed for logging continuous text data. */
+    log: null,
+    /** A multi-line text input area for user input. */
+    textarea: null,
+    /** A single-line text input area for user input. */
+    textbox: null,
+    /** Holds input fields, buttons, and other form-related widgets. */
+    form: null,
+    /** Displays a progress bar for showing task progress. */
+    progressbar: null,
+    /** Displays tabular data. */
+    table: null,
+    /** Extends `list` with table-like functionality. */
+    listtable: null,
+    /** Prompts the user to input data. */
+    prompt: null,
+    /** Displays a message box for notifications or alerts. */
+    message: null,
+    /** Shows a loading spinner or message during operations. */
+    loading: null,
+    /** For creating groups of radio buttons for options. */
+    radioset: null,
+    /** A selectable radio button within a radioset. */
+    radiobutton: null,
+    /** Displays a checkbox that users can toggle. */
+    checkbox: null,
+    /** A single-line text input for user data. */
+    input: null,
+    /** A clickable button that can trigger actions. */
+    button: null,
+    /** A visual separator line. */
+    line: null,
+    /** A box that supports vertical scrolling of its content. */
+    scrollablebox: null
+};