@nan0web/ui-cli 1.0.1 → 1.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nan0web/ui-cli",
-	"version": "1.0.1",
+	"version": "1.0.2",
 	"description": "NaN•Web UI CLI. Command line interface for One application logic (algorithm) and many UI.",
 	"main": "src/index.js",
 	"types": "types/index.d.ts",
@@ -40,9 +40,9 @@
 		"@nan0web/i18n": "^1.0.1",
 		"@nan0web/log": "1.0.1",
 		"@nan0web/test": "1.1.0",
-		"@nan0web/ui": "1.0.2"
+		"@nan0web/ui": "1.0.3"
 	},
 	"dependencies": {
-		"@nan0web/co": "^1.1.2"
+		"@nan0web/co": "^1.1.3"
 	}
 }

package/src/CommandHelp.js

@@ -2,10 +2,14 @@ import { Message } from "@nan0web/co"
 import Logger from "@nan0web/log"
 
 /**
- * @typedef {Object} CommandHelpField
- * @property {string} [help]        - Human readable description.
- * @property {string} [placeholder] - Placeholder for usage (e.g. "<user>").
- * @property {string} [alias]       - Short alias (single‑letter).
+ * @typedef {Object} CommandHelpField MessageBodySchema
+ * @property {string}  [help]         - Human readable description.
+ * @property {string}  [placeholder]  - Placeholder for usage (e.g. "<user>").
+ * @property {string}  [alias]        - Short alias (single‑letter).
+ * @property {any}     [defaultValue] - Default value.
+ * @property {any}     [type]         - Data type.
+ * @property {boolean} [required]     - Is field required or not.
+ * @property {RegExp}  [pattern]      - Regular expression pattern for validation.
  */
 
 /**
@@ -96,10 +100,12 @@ export default class CommandHelp {
 		const flagParts = []
 
 		bodyProps.forEach(prop => {
+			/** @type {CommandHelpField} */
 			const schema = this.BodyClass[prop] || {}
 			const alias = schema.alias ? `-${schema.alias}, ` : ""
-			if (schema.placeholder) {
-				placeholderParts.push(`[${alias}--${prop}=${schema.placeholder}]`)
+			const placeholder = schema.placeholder || schema.defaultValue
+			if (placeholder) {
+				placeholderParts.push(`[${alias}--${prop}=${placeholder}]`)
 			} else {
 				flagParts.push(`[${alias}--${prop}]`)
 			}
@@ -140,6 +146,7 @@ export default class CommandHelp {
 
 		lines.push("Options:")
 		bodyProps.forEach(prop => {
+			/** @type {CommandHelpField} */
 			const schema = this.BodyClass[prop] || {}
 			if (typeof schema !== "object") return
 
@@ -147,16 +154,36 @@ export default class CommandHelp {
 				? `--${prop}, -${schema.alias}`
 				: `--${prop}`
 
-			const type = schema.placeholder !== undefined ? "string" : "boolean"
-			const required = schema.default === undefined ? " *" : ""
+			const type = undefined !== schema.type ? String(schema.type)
+				: undefined !== schema.defaultValue ? typeof schema.defaultValue
+				: undefined !== schema.placeholder ? typeof schema.placeholder
+				: "any"
+			const required = schema.required || schema.pattern || schema.defaultValue === undefined ? " *" : "  "
 			const description = schema.help || "No description"
 
 			// Pad flags to align the type column with the expectations.
-			lines.push(`  ${flags.padEnd(30)} ${type.padEnd(8)}${required}  ${description}`)
+			lines.push(`  ${flags.padEnd(30)} ${type.padEnd(9)}${required} ${description}`)
 		})
 		lines.push("")
 	}
 
+	/**
+	 * @param {object} body
+	 * @returns {Map<string, any>} A map of errors, empty map if no errors.
+	 */
+	validate(body) {
+		const Class = /** @type {typeof this.BodyClass} */ (body.constructor)
+		const result = new Map()
+		for (const [name, schema] of Object.entries(Class)) {
+			const fn = schema?.validate
+			if ("function" !== typeof fn) continue
+			const ok = fn.apply(body, [body[name]])
+			if (true === ok) continue
+			result.set(name, ok)
+		}
+		return result
+	}
+
 	/**
 	 * Renders Subcommands, if any.
 	 *

package/src/index.js

@@ -17,6 +17,8 @@ export {
 	Input,
 } from "./ui/index.js"
 
+/** @typedef {import("./CommandHelp.js").CommandHelpField} CommandHelpField */
+
 export {
 	CLI,
 	CLIInputAdapter,

package/types/CommandHelp.d.ts

@@ -1,8 +1,12 @@
 /**
- * @typedef {Object} CommandHelpField
- * @property {string} [help]        - Human readable description.
- * @property {string} [placeholder] - Placeholder for usage (e.g. "<user>").
- * @property {string} [alias]       - Short alias (single‑letter).
+ * @typedef {Object} CommandHelpField MessageBodySchema
+ * @property {string}  [help]         - Human readable description.
+ * @property {string}  [placeholder]  - Placeholder for usage (e.g. "<user>").
+ * @property {string}  [alias]        - Short alias (single‑letter).
+ * @property {any}     [defaultValue] - Default value.
+ * @property {any}     [type]         - Data type.
+ * @property {boolean} [required]     - Is field required or not.
+ * @property {RegExp}  [pattern]      - Regular expression pattern for validation.
  */
 /**
  * CommandHelp – generates CLI help from a Message body schema.
@@ -37,8 +41,16 @@ export default class CommandHelp {
      * Prints the generated help to the logger.
      */
     print(): void;
+    /**
+     * @param {object} body
+     * @returns {Map<string, any>} A map of errors, empty map if no errors.
+     */
+    validate(body: object): Map<string, any>;
     #private;
 }
+/**
+ * MessageBodySchema
+ */
 export type CommandHelpField = {
     /**
      * - Human readable description.
@@ -52,6 +64,22 @@ export type CommandHelpField = {
      * - Short alias (single‑letter).
      */
     alias?: string | undefined;
+    /**
+     * - Default value.
+     */
+    defaultValue?: any;
+    /**
+     * - Data type.
+     */
+    type?: any;
+    /**
+     * - Is field required or not.
+     */
+    required?: boolean | undefined;
+    /**
+     * - Regular expression pattern for validation.
+     */
+    pattern?: RegExp | undefined;
 };
 import { Message } from "@nan0web/co";
 import Logger from "@nan0web/log";

package/types/index.d.ts

@@ -1,6 +1,7 @@
 export { str2argv } from "./utils/parse.js";
 export const renderers: Map<string, (data: any) => string>;
 export default CLIInputAdapter;
+export type CommandHelpField = import("./CommandHelp.js").CommandHelpField;
 import CLI from "./CLI.js";
 import CLIInputAdapter from "./InputAdapter.js";
 import { CancelError } from "@nan0web/ui/core";