@nan0web/ui 1.0.1 → 1.0.2

package/README.md

@@ -2,7 +2,7 @@
 
 |[Status](https://github.com/nan0web/monorepo/blob/main/system.md#написання-сценаріїв)|Documentation|Test coverage|Features|Npm version|
 |---|---|---|---|---|
- |🟢 `96.6%` |🧪 [English 🏴󠁧󠁢󠁥󠁮󠁧󠁿](https://github.com/nan0web/ui/blob/main/README.md)<br />[Українською 🇺🇦](https://github.com/nan0web/ui/blob/main/docs/uk/README.md) |🟡 `80.9%` |✅ d.ts 📜 system.md 🕹️ playground |— |
+ |🟢 `96.8%` |🧪 [English 🏴󠁧󠁢󠁥󠁮󠁧󠁿](https://github.com/nan0web/ui/blob/main/README.md)<br />[Українською 🇺🇦](https://github.com/nan0web/ui/blob/main/docs/uk/README.md) |🟡 `81.1%` |✅ d.ts 📜 system.md 🕹️ playground |1.0.1 |
 
 A lightweight, agnostic UI framework designed with the **nan0web philosophy**
 — one application logic, many UI implementations.
@@ -132,6 +132,12 @@ console.info(String(view.frame)) // ← "\rHello, world"
 `Frame` manages visual rendering with width and height limits.
 Useful for fixed-size terminals or UI blocks.
 
+Render methods:
+
+- `APPEND` – adds content after previous frame
+- `REPLACE` – erases and replaces full frame area
+- `VISIBLE` – renders only visible part of frame
+
 How to create a Frame with fixed size?
 ```js
 import { Frame } from '@nan0web/ui'

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nan0web/ui",
-	"version": "1.0.1",
+	"version": "1.0.2",
 	"description": "NaN•Web UI. One application logic (algorithm) and many UI.",
 	"main": "src/index.js",
 	"types": "types/index.d.ts",

package/src/README.md.js

@@ -210,6 +210,12 @@ function testRender() {
 	 *
 	 * `Frame` manages visual rendering with width and height limits.
 	 * Useful for fixed-size terminals or UI blocks.
+	 *
+	 * Render methods:
+	 *
+	 * - `APPEND` – adds content after previous frame
+	 * - `REPLACE` – erases and replaces full frame area
+	 * - `VISIBLE` – renders only visible part of frame
 	 */
 	it("How to create a Frame with fixed size?", () => {
 		//import { Frame } from '@nan0web/ui'
@@ -225,6 +231,23 @@ function testRender() {
 		console.info(rendered.includes("Frame content")) // ← true
 		assert.ok(rendered.includes("Frame content"))
 	})
+	it("How to create a Frame with different render methods?", () => {
+		//import { Frame } from '@nan0web/ui'
+
+		const frame = new Frame({
+			value: [["Frame content"]],
+			width: 20,
+			height: 5,
+		})
+
+		frame.renderMethod = Frame.RenderMethod.REPLACE
+		const renderedReplace = frame.render()
+		assert.ok(renderedReplace.includes("Frame content"))
+
+		frame.renderMethod = Frame.RenderMethod.VISIBLE
+		const renderedVisible = frame.render()
+		assert.ok(renderedVisible.includes("Frame content"))
+	})
 
 	/**
 	 * @docs

package/src/core/Error/CancelError.js

@@ -0,0 +1,6 @@
+export default class CancelError extends Error {
+	constructor(message = "Operation cancelled by user") {
+		super(message)
+		this.name = "CancelError"
+	}
+}

package/src/core/InputAdapter.js

@@ -1,5 +1,6 @@
 import Event from "@nan0web/event/oop"
 import InputMessage from "./Message/InputMessage.js"
+import CancelError from "./Error/CancelError.js"
 
 /**
  * Abstract input adapter for UI implementations.
@@ -7,7 +8,8 @@ import InputMessage from "./Message/InputMessage.js"
  * @class InputAdapter
  * @extends Event
  */
-class InputAdapter extends Event {
+export default class InputAdapter extends Event {
+	static CancelError = CancelError
 	/**
 	 * Starts listening for input and emits an `input` event.
 	 *
@@ -36,6 +38,22 @@ class InputAdapter extends Event {
 	isReady() {
 		return true
 	}
-}
 
-export default InputAdapter
+	/**
+	 * Helper to ask a question.
+	 * @param {string} question - Question to ask.
+	 * @returns {Promise<string>}
+	 */
+	async ask(question) {
+		throw new Error('ask() method must be implemented in subclass')
+	}
+
+	/**
+	 * Generic selection prompt.
+	 * @param {Object} config - Selection configuration.
+	 * @returns {Promise<{ index: number, value: string | null }>}
+	 */
+	async select(config) {
+		throw new Error('select() method must be implemented in subclass')
+	}
+}

package/types/core/Error/CancelError.d.ts

@@ -0,0 +1,3 @@
+export default class CancelError extends Error {
+    constructor(message?: string);
+}

package/types/core/InputAdapter.d.ts

@@ -1,11 +1,11 @@
-export default InputAdapter;
 /**
  * Abstract input adapter for UI implementations.
  *
  * @class InputAdapter
  * @extends Event
  */
-declare class InputAdapter extends Event {
+export default class InputAdapter extends Event {
+    static CancelError: typeof CancelError;
     /**
      * Starts listening for input and emits an `input` event.
      *
@@ -24,5 +24,21 @@ declare class InputAdapter extends Event {
      * @returns {boolean} Always true in base class.
      */
     isReady(): boolean;
+    /**
+     * Helper to ask a question.
+     * @param {string} question - Question to ask.
+     * @returns {Promise<string>}
+     */
+    ask(question: string): Promise<string>;
+    /**
+     * Generic selection prompt.
+     * @param {Object} config - Selection configuration.
+     * @returns {Promise<{ index: number, value: string | null }>}
+     */
+    select(config: any): Promise<{
+        index: number;
+        value: string | null;
+    }>;
 }
 import Event from "@nan0web/event/oop";
+import CancelError from "./Error/CancelError.js";