@nan0web/ui 1.0.3 → 1.1.0

package/src/View/View.js

@@ -3,13 +3,13 @@ import Frame, { FrameRenderMethod } from "../Frame/Frame.js"
 import Locale from "../Locale.js"
 import StdOut from "../StdOut.js"
 import StdIn from "../StdIn.js"
-import InputMessage from "../core/Message/InputMessage.js"
 import RenderOptions from "./RenderOptions.js"
+import UiMessage from "../core/Message/Message.js"
 
 /**
  * @typedef {Object} ComponentFn
  * @property {string} name
- * @property {(input: InputMessage) => Promise<any>} ask
+ * @property {(input: UiMessage) => Promise<any>} ask
  * @property {Function} bind
  */
 
@@ -256,8 +256,8 @@ export default class View {
 	}
 
 	/**
-	 * @param {InputMessage} input
-	 * @returns {Promise<InputMessage | null>}
+	 * @param {UiMessage} input
+	 * @returns {Promise<UiMessage | null>}
 	 */
 	async ask(input) {
 		const name = input.constructor.name.replace(/Input$/, "")
@@ -268,9 +268,9 @@ export default class View {
 		let result = null
 		do {
 			const answer = await this.stdin.read()
-			result = /** @type {typeof InputMessage} */ (input.constructor).from(answer)
-		} while (!result.isValid && !result.escaped)
-		return result.escaped ? null : result
+			result = /** @type {typeof UiMessage} */ (input.constructor).from(answer)
+		} while (!result.isValid && !result.head.cancelled)
+		return result.head.cancelled ? null : result
 	}
 
 	/**

package/src/core/Form/Form.js

@@ -1,6 +1,6 @@
+import Message from "@nan0web/co"
 import FormMessage from "./Message.js"
 import FormInput from "./Input.js"
-import Message from "@nan0web/co"
 
 /**
  * Abstract form for data entry.
@@ -112,10 +112,10 @@ export default class UIForm extends FormMessage {
 	/**
 	 * Validates the entire form.
 	 *
-	 * @returns {{isValid: boolean, errors: Object}} Validation result.
+	 * @returns {Map<string, string>} Map of validation errors, empty if valid.
 	 */
 	validate() {
-		const errors = {}
+		const errors = new Map()
 		let isValid = true
 
 		this.fields.forEach((field) => {
@@ -123,7 +123,7 @@ export default class UIForm extends FormMessage {
 
 			// Required validation based on field definition or schema
 			if (field.required && (fieldValue === '' || fieldValue === null || fieldValue === undefined)) {
-				errors[field.name] = 'This field is required'
+				errors.set(field.name, 'This field is required')
 				isValid = false
 				return
 			}
@@ -132,12 +132,14 @@ export default class UIForm extends FormMessage {
 			const { isValid: fieldValid, errors: fieldErrors } = this.validateField(field.name, fieldValue)
 
 			if (!fieldValid) {
-				Object.assign(errors, fieldErrors)
+				for (const [key, err] of Object.entries(fieldErrors)) {
+					errors.set(key, err)
+				}
 				isValid = false
 			}
 		})
 
-		return { isValid, errors }
+		return errors
 	}
 
 	/**

package/src/core/Form/Input.js

@@ -16,8 +16,8 @@
  * @property {string} type - Input type (text, email, number, select, etc.).
  * @property {boolean} required - Whether the field is required.
  * @property {string} placeholder - Placeholder text.
- * @property {Array<string>} options - Select options (if type is 'select').
- * @property {Function|null} validation - Custom validation function.
+ * @property {InputOptions} options - Select options (if type is 'select').
+ * @property {Function} validation - Custom validation function.
  * @property {*} defaultValue - Default value.
  */
 export default class FormInput {
@@ -27,7 +27,7 @@ export default class FormInput {
 	/** @type {boolean} */ required = false
 	/** @type {string} */ placeholder = ''
 	/** @type {InputOptions} */ options = []
-	/** @type {Function|null} */ validation = null
+	/** @type {Function} */ validation = () => true
 	/** @type {*} */ defaultValue = null
 
 	/**
@@ -39,7 +39,7 @@ export default class FormInput {
 		NUMBER: 'number',
 		SELECT: 'select',
 		CHECKBOX: 'checkbox',
-		TEXTAREA: 'textarea'
+		TEXTAREA: 'textarea',
 	}
 
 	/**
@@ -52,7 +52,7 @@ export default class FormInput {
 	 * @param {boolean} [props.required=false] - Is required.
 	 * @param {string} [props.placeholder=''] - Placeholder.
 	 * @param {InputOptions} [props.options=[]] - Select options or async function to retrieve data with the search and page.
-	 * @param {Function} [props.validation=null] - Custom validation.
+	 * @param {Function} [props.validation] - Custom validation.
 	 * @param {*} [props.defaultValue=null] - Default value.
 	 */
 	constructor(props) {
@@ -64,7 +64,7 @@ export default class FormInput {
 			placeholder = this.placeholder,
 			options = [],
 			validation = this.validation,
-			defaultValue = this.defaultValue
+			defaultValue = this.defaultValue,
 		} = props
 
 		if (!name) {
@@ -86,11 +86,11 @@ export default class FormInput {
 	requireValidType() {
 		if (!Object.values(FormInput.TYPES).includes(this.type)) {
 			throw new TypeError([
-				"FormInput.type is invalid!",
-				["Provided", this.type].join(": "),
-				"Available types:",
-				...Object.values(FormInput.TYPES).map(t => `  - ${t}`)
-			].join("\n"))
+				'FormInput.type is invalid!',
+				['Provided', this.type].join(': '),
+				'Available types:',
+				...Object.values(FormInput.TYPES).map((t) => `  - ${t}`),
+			].join('\n'))
 		}
 	}
 
@@ -107,7 +107,7 @@ export default class FormInput {
 			required: this.required,
 			placeholder: this.placeholder,
 			options: this.options,
-			defaultValue: this.defaultValue
+			defaultValue: this.defaultValue,
 		}
 	}
 
@@ -117,7 +117,7 @@ export default class FormInput {
 	 */
 	static from(input) {
 		if (input instanceof FormInput) return input
-		if ("string" === typeof input) {
+		if (typeof input === 'string') {
 			return new FormInput({ name: input, label: input })
 		}
 		return new FormInput(input)

package/src/core/Form/Message.js

@@ -1,12 +1,13 @@
-import InputMessage from "../Message/InputMessage.js"
+import UiMessage from "../Message/Message.js"
 
 /**
- * FormMessage – specialized InputMessage for forms.
+ * FormMessage – specialized UiMessage for forms.
+ * It carries form-specific data and schema for validation.
  *
  * @class FormMessage
- * @extends InputMessage
+ * @extends UiMessage
  */
-export default class FormMessage extends InputMessage {
+export default class FormMessage extends UiMessage {
 	/**
 	 * Creates a FormMessage.
 	 *
@@ -80,4 +81,4 @@ export default class FormMessage extends InputMessage {
 
 		return { isValid: Object.keys(errors).length === 0, errors }
 	}
-}
+}

package/src/core/InputAdapter.js

@@ -1,6 +1,6 @@
 import Event from "@nan0web/event/oop"
-import InputMessage from "./Message/InputMessage.js"
 import CancelError from "./Error/CancelError.js"
+import UiMessage from "./Message/Message.js"
 
 /**
  * Abstract input adapter for UI implementations.
@@ -21,7 +21,7 @@ export default class InputAdapter extends Event {
 	 */
 	start() {
 		this.emit('input',
-			InputMessage.from({ value: "Adapter started" })
+			UiMessage.from({ body: "Adapter started" })
 		)
 	}
 

package/src/core/Message/Message.js

@@ -1,12 +1,36 @@
-import { Message as BaseMessage } from "@nan0web/co"
+import { Message } from "@nan0web/co"
 
 /**
- * Base UI message class.
+ * @typedef {Object} MessageBodySchema
+ * @property {boolean} [required]
+ * @property {string} [help]
+ * @property {RegExp} [pattern]
+ * @property {string[]} [options]
+ * @property {*} [defaultValue]
+ * @property {Function} [validate]
+ */
+
+/**
+ * Base message class for UI communications.
+ * A message holds structured data (body) defined by a static Body class.
+ * It can represent commands, forms, alerts, or any UI unit.
+ *
+ * @class UiMessage
+ * @extends Message
  *
- * @class UIMessage
- * @extends BaseMessage
+ * @example
+ * class UserLoginMessage extends UiMessage {
+ *   static Body = class {
+ *     static username = { required: true, help: "Enter username" }
+ *     static password = { required: true, type: "password" }
+ *     constructor({ username = "", password = "" }) {
+ *       this.username = username
+ *       this.password = password
+ *     }
+ *   }
+ * }
  */
-class UIMessage extends BaseMessage {
+export default class UiMessage extends Message {
 	static TYPES = {
 		TEXT: 'text',
 		FORM: 'form',
@@ -25,7 +49,7 @@ class UIMessage extends BaseMessage {
 	id = ""
 
 	/**
-	 * Creates a UIMessage.
+	 * Creates a UiMessage.
 	 *
 	 * @param {Object} [input={}] - Message properties.
 	 */
@@ -45,14 +69,62 @@ class UIMessage extends BaseMessage {
 	}
 
 	/**
-	 * Creates a UIMessage instance from plain data.
+	 * Checks whether the message contains any body content.
 	 *
-	 * @param {Object} data - Message data.
-	 * @returns {UIMessage}
+	 * @returns {boolean}
 	 */
-	static from(data) {
-		if (data instanceof UIMessage) return data
-		return new this(data)
+	get empty() {
+		return !this.body
+	}
+
+	/**
+	 * Validates the message body against its schema.
+	 *
+	 * NOTE: The signature must exactly match `Message.validate` – it returns a
+	 * `Map<string,string>` regardless of the generic type, otherwise TypeScript
+	 * reports incompatibility with the base class.
+	 *
+	 * @param {any} [body=this.body] - Optional body to validate.
+	 * @returns {Map<string,string>} Map of validation errors, empty if valid.
+	 */
+	validate(body = this.body) {
+		/** @type {any} */
+		const Class = /** @type {typeof Message} */ (this.constructor).Body
+		const result = new Map()
+		const entries = /** @type {Array<[string, MessageBodySchema]>} */ (Object.entries(Class))
+
+		for (const [field, schema] of entries) {
+			const value = body[field]
+			const fn = schema?.validate
+			if ("function" === typeof fn) {
+				const ok = fn.apply(body, [value])
+				if (ok !== true) {
+					result.set(field, String(ok))
+					continue
+				}
+			}
+			const required = schema?.required ?? false
+			if (required && !value) {
+				result.set(field, "Required")
+				continue
+			}
+			if (schema?.pattern && schema.pattern instanceof RegExp) {
+				if (!schema.pattern.test(value)) {
+					result.set(field, `Does not match pattern: ${schema.pattern}`)
+					continue
+				}
+			}
+			if (schema?.options) {
+				if (!Array.isArray(schema.options)) {
+					throw new Error("Schema options must be an array of possible values")
+				}
+				if (!schema.options.includes(value)) {
+					result.set(field, "Enumeration must have one value")
+					continue
+				}
+			}
+		}
+		return result
 	}
 
 	/**
@@ -61,17 +133,35 @@ class UIMessage extends BaseMessage {
 	 * @returns {boolean}
 	 */
 	isValidType() {
-		return Object.values(UIMessage.TYPES).includes(this.type)
+		return Object.values(UiMessage.TYPES).includes(this.type)
 	}
 
 	/**
-	 * Checks whether the message contains any body content.
+	 * Creates a UiMessage instance from plain data.
 	 *
-	 * @returns {boolean}
+	 * @param {Object} data - Message data.
+	 * @returns {UiMessage}
 	 */
-	isEmpty() {
-		return !this.body || this.body.length === 0
+	static from(data) {
+		if (data instanceof UiMessage) return data
+		return new this(data)
 	}
-}
 
-export default UIMessage
+	/**
+	 * Initializes body from input using static Body schema.
+	 *
+	 * @param {Object} input - Input object.
+	 * @param {Function} BodyClass - Static body class with defaults and schema.
+	 * @returns {Object} Parsed body.
+	 */
+	static parseBody(input = {}, BodyClass) {
+		const result = {}
+		const entries = /** @type {Array<[string, MessageBodySchema]>} */ (Object.entries(BodyClass))
+
+		for (const [field, schema] of entries) {
+			const { defaultValue = undefined, ...schemaProps } = schema
+			result[field] = input[field] ?? defaultValue
+		}
+		return result
+	}
+}

package/src/core/Message/OutputMessage.js

@@ -1,12 +1,12 @@
-import UIMessage from "./Message.js"
+import UiMessage from "./Message.js"
 
 /**
  * OutputMessage – message sent from the system to the UI.
  *
  * @class OutputMessage
- * @extends UIMessage
+ * @extends UiMessage
  */
-export default class OutputMessage extends UIMessage {
+export default class OutputMessage extends UiMessage {
 	static PRIORITY = {
 		LOW: 0,
 		NORMAL: 1,
@@ -52,9 +52,9 @@ export default class OutputMessage extends UIMessage {
 		this.priority = Number(priority)
 
 		if (!this.type && this.error) {
-			this.type = UIMessage.TYPES.ERROR
+			this.type = UiMessage.TYPES.ERROR
 		} else if (!this.type) {
-			this.type = UIMessage.TYPES.INFO
+			this.type = UiMessage.TYPES.INFO
 		}
 	}
 
@@ -72,11 +72,11 @@ export default class OutputMessage extends UIMessage {
 	}
 	/** @returns {boolean} */
 	get isError() {
-		return this.error !== null || this.type === UIMessage.TYPES.ERROR
+		return this.error !== null || this.type === UiMessage.TYPES.ERROR
 	}
 	/** @returns {boolean} */
 	get isInfo() {
-		return this.type === UIMessage.TYPES.INFO || this.type === UIMessage.TYPES.SUCCESS
+		return this.type === UiMessage.TYPES.INFO || this.type === UiMessage.TYPES.SUCCESS
 	}
 
 	/**

package/src/core/Message/index.js

@@ -1,7 +1,6 @@
-import UIMessage from "./Message.js"
-import InputMessage from "./InputMessage.js"
+import UiMessage from "./Message.js"
 import OutputMessage from "./OutputMessage.js"
 
-export { UIMessage, InputMessage, OutputMessage }
+export { UiMessage, OutputMessage }
 
-export default UIMessage
+export default UiMessage

package/src/core/Stream.js

@@ -1,7 +1,7 @@
 import StreamEntry from "./StreamEntry.js"
 
 /**
- * Agnostic UI stream for processing progress.
+ * Agnostic UI stream for processing progress using async generators.
  *
  * @class UIStream
  */
@@ -16,6 +16,9 @@ export default class UIStream {
 	static createProcessor(signal, processorFn) {
 		return async function* () {
 			try {
+				if (signal.aborted) {
+					throw new DOMException('Aborted', 'AbortError')
+				}
 				const result = await processorFn()
 				yield result
 			} catch (/** @type {any} */ error) {
@@ -29,17 +32,17 @@ export default class UIStream {
 	}
 
 	/**
-	 * Runs a generator with progress callbacks and abort handling.
+	 * Runs an async generator with progress callbacks and abort handling.
 	 *
 	 * @param {AbortSignal} signal - Abort signal.
-	 * @param {Function} generator - Function returning an async iterator.
+	 * @param {() => AsyncGenerator<StreamEntry>} generatorFn - Function that returns an async generator.
 	 * @param {Function} [onProgress] - Called with (progress, item).
 	 * @param {Function} [onError] - Called with (errorMessage, item).
 	 * @param {Function} [onComplete] - Called with (item) when done.
 	 * @returns {Promise<void>}
 	 */
-	static async process(signal, generator, onProgress, onError, onComplete) {
-		const iter = generator()
+	static async process(signal, generatorFn, onProgress, onError, onComplete) {
+		const iter = generatorFn()
 
 		try {
 			for await (const item of iter) {
@@ -47,13 +50,11 @@ export default class UIStream {
 					throw new DOMException('Aborted', 'AbortError')
 				}
 
-				if (item.progress !== undefined) {
-					onProgress?.(item.progress, item)
-				} else if (item.error) {
-					onError?.(item.error, item)
-				} else if (item.done) {
+				if (item.done) {
 					onComplete?.(item)
 					break
+				} else if (item.error) {
+					onError?.(item.error, item)
 				} else {
 					// Intermediate results
 					onProgress?.(null, item)