rosinterface 1.3.0 → 1.3.2

package/dist/cli/Generate.js

@@ -44,25 +44,37 @@ const path = __importStar(require("path"));
 const chalk_1 = __importDefault(require("chalk"));
 const ora_1 = __importDefault(require("ora"));
 const dotenv_1 = __importDefault(require("dotenv"));
+// Load .env (if available)
 dotenv_1.default.config();
 const program = new commander_1.Command();
 program
     .name('ros-codegen')
     .description('Generates TypeScript interfaces from your live MikroTik router')
     .version('1.2.0')
+    // Mandatory Generation Params
     .requiredOption('-p, --path <menu>', 'MikroTik Menu Path (e.g. /ppp/secret)')
     .requiredOption('-n, --name <interface>', 'Name of the output Interface (e.g. PPPSecret)')
     .option('-o, --output <dir>', 'Output directory', './src/generated')
+    // Optional Connection Params (Overrides .env if provided)
     .option('--host <host>', 'Router Host/IP')
     .option('--user <user>', 'Router Username')
     .option('--pass <password>', 'Router Password')
     .option('--port <port>', 'Router API Port')
     .option('--tls', 'Use TLS (SSL) connection', false)
     .action(async (options) => {
+    // ==========================================
+    // 1. CREDENTIALS RESOLUTION STRATEGY
+    // Priority: CLI Flag > Environment Variable
+    // ==========================================
     const host = options.host || process.env.MIKROTIK_HOST;
     const user = options.user || process.env.MIKROTIK_USER;
     const password = options.pass || process.env.MIKROTIK_PASS;
+    // TLS Logic: Flag OR Env Var string 'true'
     const useTLS = options.tls || process.env.MIKROTIK_USE_TLS === 'true';
+    // Port Logic:
+    // 1. CLI Flag
+    // 2. Env Var
+    // 3. Default based on TLS (8729 vs 8728)
     let port;
     if (options.port) {
         port = parseInt(options.port, 10);
@@ -73,6 +85,7 @@ program
     else {
         port = useTLS ? 8729 : 8728;
     }
+    // Pre-flight Validation
     if (!host || !user || !password) {
         console.error(chalk_1.default.red('Error: Missing credentials.'));
         console.error(chalk_1.default.yellow('You must provide credentials via .env file OR CLI flags.'));
@@ -83,23 +96,27 @@ Usage Example:
         process.exit(1);
     }
     const spinner = (0, ora_1.default)(`Connecting to ${host}:${port}...`).start();
+    // Initialize Client
     const client = new MikrotikClient_1.MikrotikClient({
         host: host,
         user: user,
         password: password,
         port: port,
         useTLS: useTLS,
-        allowInsecureConfig: true
+        allowInsecureConfig: true // Suppress warnings for CLI tool since hardcoding is expected here
     });
     try {
         await client.connect();
         spinner.text = `Fetching schema from ${options.path}...`;
+        // Fetch Real Data (The "Truth")
         const data = await client.write(`${options.path}/print`);
         if (data.length === 0) {
             spinner.warn(chalk_1.default.yellow(' Warning: No data found in this menu. Generated interface will be empty or generic.'));
         }
+        // Infer Schema
         spinner.text = 'Inferring Types & Generating Code...';
         const tsCode = SchemaInferrer_1.SchemaInferrer.generateInterface(options.name, data);
+        // Add File Header
         const fileContent = `
 /**
  * AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
@@ -110,11 +127,13 @@ Usage Example:
 
 ${tsCode}
 `;
+        // Write to File
         const outputDir = path.resolve(options.output);
         await fs.ensureDir(outputDir);
         const filePath = path.join(outputDir, `${options.name}.ts`);
         await fs.writeFile(filePath, fileContent);
         spinner.succeed(chalk_1.default.green(`Successfully generated ${options.name}.ts in ${options.output}`));
+        // Show Preview
         console.log(chalk_1.default.gray('\nPreview:'));
         console.log(chalk_1.default.cyan(tsCode.split('\n').slice(0, 15).join('\n') + '\n...'));
     }

package/dist/cli/Generate.js.map

@@ -1 +1 @@
-{"version":3,"file":"Generate.js","sourceRoot":"","sources":["../../src/cli/Generate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAAoC;AACpC,6DAA0D;AAC1D,qDAAkD;AAClD,6CAA+B;AAC/B,2CAA6B;AAC7B,kDAA0B;AAC1B,8CAAsB;AACtB,oDAA4B;AAG5B,gBAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACF,IAAI,CAAC,aAAa,CAAC;KACnB,WAAW,CAAC,gEAAgE,CAAC;KAC7E,OAAO,CAAC,OAAO,CAAC;KAEhB,cAAc,CAAC,mBAAmB,EAAE,uCAAuC,CAAC;KAC5E,cAAc,CAAC,wBAAwB,EAAE,+CAA+C,CAAC;KACzF,MAAM,CAAC,oBAAoB,EAAE,kBAAkB,EAAE,iBAAiB,CAAC;KAGnE,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC;KACzC,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC;KAC1C,MAAM,CAAC,mBAAmB,EAAE,iBAAiB,CAAC;KAC9C,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC;KAC1C,MAAM,CAAC,OAAO,EAAE,0BAA0B,EAAE,KAAK,CAAC;KAElD,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;IAMtB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IACvD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IACvD,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IAG3D,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,KAAK,MAAM,CAAC;IAMtE,IAAI,IAAY,CAAC;IACjB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACf,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACtC,CAAC;SAAM,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;QACnC,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IACnD,CAAC;SAAM,CAAC;QACJ,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAChC,CAAC;IAGD,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC,CAAC;QACxD,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,MAAM,CAAC,0DAA0D,CAAC,CAAC,CAAC;QACxF,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC;;;aAGtB,CAAC,CAAC,CAAC;QACJ,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,aAAG,EAAC,iBAAiB,IAAI,IAAI,IAAI,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;IAGhE,MAAM,MAAM,GAAG,IAAI,+BAAc,CAAC;QAC9B,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,MAAM;QACd,mBAAmB,EAAE,IAAI;KAC5B,CAAC,CAAC;IAEH,IAAI,CAAC;QACD,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QAEvB,OAAO,CAAC,IAAI,GAAG,wBAAwB,OAAO,CAAC,IAAI,KAAK,CAAC;QAGzD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,QAAQ,CAAC,CAAC;QAEzD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpB,OAAO,CAAC,IAAI,CAAC,eAAK,CAAC,MAAM,CAAC,qFAAqF,CAAC,CAAC,CAAC;QACtH,CAAC;QAGD,OAAO,CAAC,IAAI,GAAG,sCAAsC,CAAC;QACtD,MAAM,MAAM,GAAG,+BAAc,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAGpE,MAAM,WAAW,GAAG;;;;aAInB,OAAO,CAAC,IAAI;WACd,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;;;EAGjC,MAAM;CACP,CAAC;QAGU,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC;QAE5D,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAE1C,OAAO,CAAC,OAAO,CAAC,eAAK,CAAC,KAAK,CAAC,0BAA0B,OAAO,CAAC,IAAI,UAAU,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAG/F,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QACtC,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAElF,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QAClB,OAAO,CAAC,IAAI,CAAC,eAAK,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAE7C,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;YAChC,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,wBAAwB,IAAI,IAAI,IAAI,kBAAkB,CAAC,CAAC,CAAC;QACrF,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1D,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,kCAAkC,IAAI,mBAAmB,CAAC,CAAC,CAAC;QACxF,CAAC;aAAM,CAAC;YACJ,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAC5C,CAAC;IACL,CAAC;YAAS,CAAC;QACP,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;AACL,CAAC,CAAC,CAAC;AAEP,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}
+{"version":3,"file":"Generate.js","sourceRoot":"","sources":["../../src/cli/Generate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAAoC;AACpC,6DAA0D;AAC1D,qDAAkD;AAClD,6CAA+B;AAC/B,2CAA6B;AAC7B,kDAA0B;AAC1B,8CAAsB;AACtB,oDAA4B;AAE5B,2BAA2B;AAC3B,gBAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACF,IAAI,CAAC,aAAa,CAAC;KACnB,WAAW,CAAC,gEAAgE,CAAC;KAC7E,OAAO,CAAC,OAAO,CAAC;IACjB,8BAA8B;KAC7B,cAAc,CAAC,mBAAmB,EAAE,uCAAuC,CAAC;KAC5E,cAAc,CAAC,wBAAwB,EAAE,+CAA+C,CAAC;KACzF,MAAM,CAAC,oBAAoB,EAAE,kBAAkB,EAAE,iBAAiB,CAAC;IAEpE,0DAA0D;KACzD,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC;KACzC,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC;KAC1C,MAAM,CAAC,mBAAmB,EAAE,iBAAiB,CAAC;KAC9C,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC;KAC1C,MAAM,CAAC,OAAO,EAAE,0BAA0B,EAAE,KAAK,CAAC;KAElD,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;IACtB,6CAA6C;IAC7C,qCAAqC;IACrC,4CAA4C;IAC5C,6CAA6C;IAE7C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IACvD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IACvD,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;IAE3D,2CAA2C;IAC3C,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,KAAK,MAAM,CAAC;IAEtE,cAAc;IACd,cAAc;IACd,aAAa;IACb,yCAAyC;IACzC,IAAI,IAAY,CAAC;IACjB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACf,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACtC,CAAC;SAAM,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;QACnC,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IACnD,CAAC;SAAM,CAAC;QACJ,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAChC,CAAC;IAED,wBAAwB;IACxB,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC,CAAC;QACxD,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,MAAM,CAAC,0DAA0D,CAAC,CAAC,CAAC;QACxF,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC;;;aAGtB,CAAC,CAAC,CAAC;QACJ,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,aAAG,EAAC,iBAAiB,IAAI,IAAI,IAAI,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;IAEhE,oBAAoB;IACpB,MAAM,MAAM,GAAG,IAAI,+BAAc,CAAC;QAC9B,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,MAAM;QACd,mBAAmB,EAAE,IAAI,CAAC,mEAAmE;KAChG,CAAC,CAAC;IAEH,IAAI,CAAC;QACD,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QAEvB,OAAO,CAAC,IAAI,GAAG,wBAAwB,OAAO,CAAC,IAAI,KAAK,CAAC;QAEzD,gCAAgC;QAChC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,QAAQ,CAAC,CAAC;QAEzD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpB,OAAO,CAAC,IAAI,CAAC,eAAK,CAAC,MAAM,CAAC,qFAAqF,CAAC,CAAC,CAAC;QACtH,CAAC;QAED,eAAe;QACf,OAAO,CAAC,IAAI,GAAG,sCAAsC,CAAC;QACtD,MAAM,MAAM,GAAG,+BAAc,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAEpE,kBAAkB;QAClB,MAAM,WAAW,GAAG;;;;aAInB,OAAO,CAAC,IAAI;WACd,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;;;EAGjC,MAAM;CACP,CAAC;QAEU,gBAAgB;QAChB,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC;QAE5D,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAE1C,OAAO,CAAC,OAAO,CAAC,eAAK,CAAC,KAAK,CAAC,0BAA0B,OAAO,CAAC,IAAI,UAAU,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAE/F,eAAe;QACf,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QACtC,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAElF,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QAClB,OAAO,CAAC,IAAI,CAAC,eAAK,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAE7C,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;YAChC,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,wBAAwB,IAAI,IAAI,IAAI,kBAAkB,CAAC,CAAC,CAAC;QACrF,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1D,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,kCAAkC,IAAI,mBAAmB,CAAC,CAAC,CAAC;QACxF,CAAC;aAAM,CAAC;YACJ,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAC5C,CAAC;IACL,CAAC;YAAS,CAAC;QACP,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;AACL,CAAC,CAAC,CAAC;AAEP,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/dist/cli/SchemaInferrer.d.ts

@@ -1,4 +1,13 @@
+/**
+ * Analyzes raw MikroTik data and infers TypeScript types.
+ */
 export declare class SchemaInferrer {
+    /**
+     * Main entry point: Generates the Interface string from raw data items.
+     */
     static generateInterface(interfaceName: string, dataSample: Record<string, any>[]): string;
+    /**
+     * Heuristic Engine to determine the best TypeScript type.
+     */
     private static inferType;
 }

package/dist/cli/SchemaInferrer.js

@@ -1,9 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchemaInferrer = void 0;
+/**
+ * Analyzes raw MikroTik data and infers TypeScript types.
+ */
 class SchemaInferrer {
+    /**
+     * Main entry point: Generates the Interface string from raw data items.
+     */
     static generateInterface(interfaceName, dataSample) {
         const fieldStats = {};
+        // Collect all possible values for each field across the sample
         dataSample.forEach(item => {
             Object.keys(item).forEach(key => {
                 if (!fieldStats[key])
@@ -11,30 +18,42 @@ class SchemaInferrer {
                 fieldStats[key].add(String(item[key]));
             });
         });
+        // Build the Interface lines
         const lines = [];
         lines.push(`export interface ${interfaceName} {`);
         Object.keys(fieldStats).sort().forEach(key => {
             const values = Array.from(fieldStats[key]);
             const type = this.inferType(key, values);
+            // MikroTik fields are mostly optional as they depend on configuration
             const isOptional = true;
-            const propName = key.includes('-') ? `'${key}'` : key;
+            const propName = key.includes('-') ? `'${key}'` : key; // Quote kebab-case
             lines.push(`    /** Sample values: ${values.slice(0, 3).join(', ')}... */`);
             lines.push(`    ${propName}${isOptional ? '?' : ''}: ${type};`);
         });
         lines.push(`}`);
         return lines.join('\n');
     }
+    /**
+     * Heuristic Engine to determine the best TypeScript type.
+     */
     static inferType(key, values) {
+        // Boolean Detection (true/false/yes/no)
         const isBoolean = values.every(v => ['true', 'false', 'yes', 'no'].includes(v.toLowerCase()));
         if (isBoolean)
-            return 'boolean | string';
+            return 'boolean | string'; // string fallback for safety
+        // Number Detection
+        // Checks if all values look like numbers (ignoring empty strings)
         const isNumber = values.every(v => v === '' || !isNaN(Number(v)));
         if (isNumber && values.length > 0)
             return 'number | string';
+        // Enum / Union Type Detection
+        // If we see very few unique values (e.g. 'running' | 'stopped'), create a Union.
+        // Limit: Max 10 unique values to consider it an Enum.
         if (values.length > 0 && values.length < 10 && !isNumber) {
             const union = values.map(v => `'${v}'`).join(' | ');
-            return `${union} | string`;
+            return `${union} | string`; // Append string to allow future values
         }
+        // Default
         return 'string';
     }
 }

package/dist/cli/SchemaInferrer.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaInferrer.js","sourceRoot":"","sources":["../../src/cli/SchemaInferrer.ts"],"names":[],"mappings":";;;AAGA,MAAa,cAAc;IAKhB,MAAM,CAAC,iBAAiB,CAAC,aAAqB,EAAE,UAAiC;QACpF,MAAM,UAAU,GAAgC,EAAE,CAAC;QAGnD,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACtB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBAC5B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;oBAAE,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,CAAC;gBAClD,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAGH,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,oBAAoB,aAAa,IAAI,CAAC,CAAC;QAElD,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACzC,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAGzC,MAAM,UAAU,GAAG,IAAI,CAAC;YACxB,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;YAEtD,KAAK,CAAC,IAAI,CAAC,0BAA0B,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5E,KAAK,CAAC,IAAI,CAAC,OAAO,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,GAAG,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAKO,MAAM,CAAC,SAAS,CAAC,GAAW,EAAE,MAAgB;QAElD,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC9F,IAAI,SAAS;YAAE,OAAO,kBAAkB,CAAC;QAIzC,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClE,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,iBAAiB,CAAC;QAK5D,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpD,OAAO,GAAG,KAAK,WAAW,CAAC;QAC/B,CAAC;QAGD,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ;AA5DD,wCA4DC"}
+{"version":3,"file":"SchemaInferrer.js","sourceRoot":"","sources":["../../src/cli/SchemaInferrer.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,cAAc;IAEvB;;OAEG;IACI,MAAM,CAAC,iBAAiB,CAAC,aAAqB,EAAE,UAAiC;QACpF,MAAM,UAAU,GAAgC,EAAE,CAAC;QAEnD,+DAA+D;QAC/D,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACtB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBAC5B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;oBAAE,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,CAAC;gBAClD,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,4BAA4B;QAC5B,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,oBAAoB,aAAa,IAAI,CAAC,CAAC;QAElD,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACzC,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAEzC,sEAAsE;YACtE,MAAM,UAAU,GAAG,IAAI,CAAC;YACxB,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,mBAAmB;YAE1E,KAAK,CAAC,IAAI,CAAC,0BAA0B,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5E,KAAK,CAAC,IAAI,CAAC,OAAO,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,GAAG,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,SAAS,CAAC,GAAW,EAAE,MAAgB;QAClD,wCAAwC;QACxC,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAC9F,IAAI,SAAS;YAAE,OAAO,kBAAkB,CAAC,CAAC,6BAA6B;QAEvE,mBAAmB;QACnB,kEAAkE;QAClE,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClE,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,iBAAiB,CAAC;QAE5D,8BAA8B;QAC9B,iFAAiF;QACjF,sDAAsD;QACtD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpD,OAAO,GAAG,KAAK,WAAW,CAAC,CAAC,uCAAuC;QACvE,CAAC;QAED,UAAU;QACV,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ;AA5DD,wCA4DC"}

package/dist/client/CommandBuilder.d.ts

@@ -1,5 +1,12 @@
 import { MikrotikClient, Subscription } from './MikrotikClient';
 import { MikrotikCollection } from '../utils/MikrotikCollection';
+/**
+ * CommandBuilder.ts
+ * * The Fluent Interface Engine with Offline-First Capabilities.
+ * * Provides syntax sugar for constructing MikroTik commands.
+ * * Supports Real-Time Streaming, Persistent Queueing, Smart Caching,
+ * * and Enterprise REST Features (Idempotency, Projections).
+ */
 export declare class CommandBuilder<T extends Record<string, any>> {
     private readonly client;
     private readonly menuPath;
@@ -8,28 +15,356 @@ export declare class CommandBuilder<T extends Record<string, any>> {
     private propList;
     private _idempotent;
     private isPersistentRequest;
+    /**
+     * Short-lived cache to prevent read-spamming the router.
+     * TTL: 5 Seconds.
+     */
     private static queryCache;
     private static readonly CACHE_TTL_MS;
     constructor(client: MikrotikClient, menuPath: string);
+    /**
+     * Adds a **Query Filter** (Equal Match) to the command.
+     *
+     * This method appends a filter parameter (`?key=value`) to the API request.
+     * Only items matching this condition will be returned or affected.
+     *
+     * **Feature: Auto-Kebab Case**
+     * You can use standard JavaScript camelCase keys. They are automatically converted
+     * to MikroTik's kebab-case format.
+     * - Input: `macAddress` -> Output: `?mac-address=...`
+     * - Input: `rxByte`     -> Output: `?rx-byte=...`
+     *
+     * @param key The field name to filter by (e.g., 'name', 'disabled', 'macAddress').
+     * @param value The value to match. Booleans are converted to 'true'/'false' strings.
+     * @returns The current builder instance for chaining.
+     *
+     * @example
+     * // Find a specific user by name
+     * client.command('/ppp/secret')
+     * .where('name', 'john_doe')
+     * .print();
+     *
+     * @example
+     * // Find all disabled interfaces (camelCase supported)
+     * client.command('/interface')
+     * .where('disabled', true) // Sends ?disabled=true
+     * .print();
+     */
     where(key: string, value: string | number | boolean): this;
+    /**
+     * Adds an **Existence Filter** to the command.
+     *
+     * Matches items where the specified key exists (is defined), regardless of its value.
+     * This is useful for finding items that have optional properties set.
+     * Corresponds to the MikroTik API syntax `?key=`.
+     *
+     * @param key The field name to check for existence.
+     * @returns The current builder instance for chaining.
+     *
+     * @example
+     * // Find all firewall rules that have a comment
+     * client.command('/ip/firewall/filter')
+     * .whereExists('comment')
+     * .print();
+     */
     whereExists(key: string): this;
+    /**
+     * **Field Projection (.select)**
+     *
+     * Restricts the fields returned by the router to a specific list.
+     * Using this method significantly reduces CPU load on the router and network bandwidth,
+     * especially when querying large tables like the routing table or logs.
+     * Corresponds to the MikroTik API argument `.proplist`.
+     *
+     * **Feature: Auto-Kebab Case**
+     * Inputs like `rxByte` are automatically converted to `rx-byte`.
+     *
+     * **Usage Levels:**
+     * * 1. **Novice:** Simple array of strings. `['name', 'address']`
+     * * 2. **Advanced (Surgical):** Type-safe list of keys ensuring they exist in interface T.
+     *
+     * @param fields An array of field names to retrieve (can be type-safe keys).
+     * @returns The current builder instance for chaining.
+     *
+     * @example
+     * // Get only the name and uptime of active users (ignoring traffic stats)
+     * const users = await client.command<PPPActive>('/ppp/active')
+     * .select(['name', 'uptime']) // optimized request
+     * .print();
+     */
     select(fields: (keyof T | string)[]): this;
+    /**
+     * **Enable Idempotency (.idempotent)**
+     *
+     * Flags the next operation to be **"Safe from Duplicates"**.
+     *
+     * * **Effect:** If you call `.add()` and the item already exists (based on a unique key like 'name'),
+     * the library will NOT throw an error. Instead, it will gracefully fetch and return the existing item.
+     * * **Requirement:** This is primarily supported in REST mode (v7+). In Socket mode, behavior depends on driver support.
+     *
+     * @returns The current builder instance for chaining.
+     * @example
+     * // Safe Create: Won't fail if 'vlan10' exists
+     * client.command('/interface/vlan')
+     * .idempotent()
+     * .add({ name: 'vlan10', 'vlan-id': 10 });
+     */
     idempotent(keyField?: string): this;
+    /**
+     * **Offline Tolerance Strategy**
+     *
+     * Marks the current command as **Persistent**.
+     * Normally, if the router is disconnected, a command fails immediately.
+     * With `.persistent()`, the command is added to an internal retry queue
+     * and will be executed automatically as soon as the connection is restored.
+     *
+     * **Use Case:** Critical background tasks (e.g., scheduled billing cuts) that
+     * must eventually run, even if the network is currently unstable.
+     *
+     * @returns The current builder instance.
+     * @example
+     * // Even if the router is down, this will run when it comes back up.
+     * client.command('/system/reboot').persistent().send();
+     */
     persistent(): this;
+    /**
+     * **Server-Side Search (Multi-Item)**
+     *
+     * Executes a search directly on the RouterOS CPU.
+     * Unlike client-side filtering, this method instructs the router to filter
+     * the data *before* sending it over the network.
+     *
+     * **Performance Note:**
+     * extremely efficient for large tables (like thousands of PPPoE secrets),
+     * as only the matching rows travel over the wire.
+     *
+     * @param criteria An object with key-value pairs to match (e.g., `{ disabled: 'true', profile: 'default' }`).
+     * @returns A `MikrotikCollection` containing only the matching items.
+     *
+     * @example
+     * // Fetch all users in the 'default' profile
+     * const users = await client.command('/ppp/secret').findBy({ profile: 'default' });
+     */
     findBy(criteria: Partial<T>): Promise<MikrotikCollection<T>>;
+    /**
+     * **Server-Side Search (Single-Item)**
+     *
+     * The most efficient way to retrieve a single specific resource.
+     * It applies the filters, executes the query, and returns the first result.
+     *
+     * @param criteria Unique identifiers (e.g., `{ name: 'admin' }` or `{ macAddress: '00:...' }`).
+     * @returns The found item object, or `null` if no match was found.
+     *
+     * @example
+     * // Find a specific interface by name
+     * const ether1 = await client.command('/interface').findOne({ name: 'ether1' });
+     * if (ether1) console.log(ether1.mac_address);
+     */
     findOne(criteria: Partial<T>): Promise<T | null>;
+    /**
+     * **Execution Terminator: Print with Caching**
+     *
+     * Finalizes the builder chain and sends the `print` command to the router.
+     *
+     * **Feature: Smart Caching (TTL 5s)**
+     * To prevent flooding the router with redundant read requests (e.g., multiple UI components
+     * asking for the same data), this method implements a **Read-Through Cache**.
+     * 1.  **Cache Hit:** If the exact same query was made < 5 seconds ago, returns local data immediately.
+     * 2.  **Cache Miss:** Fetches from the router, stores the result, and returns it.
+     *
+     * **Feature: Garbage Collection**
+     * Includes a probabilistic strategy (5% chance) to prune expired cache entries
+     * on every call to keep memory footprint low.
+     *
+     * @param extraParams Optional explicit parameters (e.g., `{ 'count-only': 'true' }`).
+     * @returns A `MikrotikCollection` (v1.2.0) equipped with pagination and transformation tools.
+     *
+     * @example
+     * // EXAMPLE 1: Standard Fetch (Basic Array)
+     * // Get all active PPPoE users as a simple array
+     * const users = await client.command('/ppp/active').print().then(c => c.toArray());
+     *
+     * @example
+     * // EXAMPLE 2: Pagination (Frontend Tables)
+     * // Get Page 2 of secrets, 25 items per page
+     * const page2 = await client.command('/ppp/secret')
+     * .where('disabled', 'false')
+     * .print()
+     * .then(c => c.toPages(2, 25));
+     *
+     * @example
+     * // EXAMPLE 3: High-Performance Lookup (O(1) Map)
+     * // Index users by name for instant access without looping
+     * const userMap = await client.command('/ppp/secret')
+     * .print()
+     * .then(c => c.toMap('name'));
+     *
+     * console.log(userMap['juan_perez']?.password); // Instant access!
+     *
+     * @example
+     * // EXAMPLE 4: Reporting (Grouping)
+     * // Group active connections by Service Type (pppoe vs ovpn)
+     * const report = await client.command('/ppp/active')
+     * .print()
+     * .then(c => c.toGrouped('service'));
+     *
+     * console.log(`PPPoE Users: ${report['pppoe']?.length || 0}`);
+     */
     print(extraParams?: Record<string, any>): Promise<MikrotikCollection<T>>;
+    /**
+     * Helper to clean expired cache entries to prevent memory leaks.
+     */
     private pruneCache;
+    /**
+     * **Execution Terminator: First Result**
+     *
+     * Syntactic sugar for fetching a list and retrieving only the first item.
+     * Useful when you know the query will return a single result or you only care about the top record.
+     *
+     * @returns The first item of type `T`, or `null` if the collection is empty.
+     * @example
+     * // Get the first active admin user
+     * const admin = await client.command('/user').where('group', 'full').first();
+     */
     first(): Promise<T | null>;
+    /**
+     * **Execution Terminator: Create Resource (ADD)**
+     *
+     * Sends an `/add` command to the router to create a new item.
+     *
+     * **Feature: Automatic Cache Invalidation**
+     * Upon success, this method automatically invalidates the local cache for this menu path.
+     * This guarantees that the next `.print()` call will fetch fresh data from the router,
+     * including the item you just created.
+     *
+     * **Feature: Offline Queueing**
+     * If the router is unreachable and `.persistent()` was used (or global offline mode is on),
+     * the command is saved to the `OfflineQueue` for later execution.
+     *
+     * **Feature: Idempotency**
+     * If `.idempotent()` was called, passes the flag to the client to safely handle duplicates.
+     *
+     * @param data The object containing the properties for the new item.
+     * @returns The MikroTik internal ID (e.g., `*1A`) of the created item, or `'QUEUED_OFFLINE'`.
+     *
+     * @example
+     * // Add a new firewall address list entry
+     * const id = await client.command('/ip/firewall/address-list').add({
+     * list: 'allowed_users',
+     * address: '192.168.88.50',
+     * comment: 'Added via API'
+     * });
+     */
     add(data: Partial<T>): Promise<string | T>;
+    /**
+     * **Get or Create (Syntactic Sugar)**
+     * * A shorthand method that enables idempotency and executes the add.
+     * * Semantically clearer for business logic "Ensure this exists".
+     * * @param data The data to ensure exists.
+     * @returns The Single item created or recovered.
+     */
     getOrCreate(data: Partial<T>): Promise<T>;
-    set(id: string, data: Partial<T>): Promise<void>;
-    remove(id: string | string[]): Promise<void>;
+    /**
+     * **Execution Terminator: Update Resource (SET)**
+     *
+     * Sends a `/set` command to modify an existing item.
+     *
+     * **Feature: Idempotency & Cache**
+     * Like `.add()`, this triggers cache invalidation. It also handles the tricky
+     * `.id` parameter requirement of MikroTik automatically.
+     *
+     * @param id The internal ID of the item (e.g., `*14`) or a unique name if supported by the menu.
+     * @param data An object containing ONLY the fields you want to change (Partial update).
+     *
+     * @example
+     * // Update a PPPoE secret's password
+     * await client.command('/ppp/secret').set('*1F', {
+     * password: 'new_secure_password',
+     * comment: 'Password changed on ' + new Date().toISOString()
+     * });
+     */
+    set(id: string, data: Partial<T>): Promise<T>;
+    /**
+     * **Execution Terminator: Delete Resource (REMOVE)**
+     *
+     * Sends a `/remove` command to delete one or more items.
+     *
+     * **Feature: Batch Deletion**
+     * You can pass an array of IDs to delete multiple items in a single API call,
+     * which is significantly faster than a loop of delete calls.
+     *
+     * @param id A single ID string (e.g., `*1A`) or an array of IDs.
+     *
+     * @example
+     * // Remove a single item
+     * await client.command('/queue/simple').remove('*A1');
+     *
+     * @example
+     * // Batch remove (Kick multiple active connections)
+     * const idsToKick = ['*8001', '*8002', '*8003'];
+     * await client.command('/ppp/active').remove(idsToKick);
+     */
+    remove(id: string | string[]): Promise<string[]>;
+    /**
+     * **Streaming Terminator: Data Watcher**
+     *
+     * Initiates a standard real-time stream using the RouterOS `=follow=` protocol.
+     * Used for monitoring **changes in configuration or state** (e.g., "Tell me when a new log appears"
+     * or "Notify me when a user connects").
+     *
+     * **Protocol Internals:**
+     * This method automatically constructs the complex packet structure required by RouterOS:
+     * - Filters are sent as Queries (`?name=...`).
+     * - Properties are sent as Attributes (`=.proplist=...`).
+     * - The Streaming Flag (`=follow=`) is appended at the end.
+     *
+     * @param callback Function to execute whenever a new data packet arrives.
+     * @returns A `Subscription` object with a `.stop()` method to cancel the stream.
+     *
+     * @example
+     * // Monitor the System Log in real-time
+     * const logStream = client.command('/log')
+     * .where('topics', 'error') // Only listen for errors
+     * .listen((entry) => {
+     * console.log(`NEW ERROR: ${entry.message}`);
+     * });
+     *
+     * // Stop after 1 minute
+     * setTimeout(() => logStream.stop(), 60000);
+     */
     listen(callback: (item: T) => void): Subscription;
+    /**
+     * **Streaming Terminator: Traffic & Torch**
+     *
+     * A specialized listener designed for commands that stream data but **do not** support
+     * the standard `/print` syntax, specifically `/interface/monitor-traffic` and `/tool/torch`.
+     *
+     * **Difference from .listen():**
+     * Standard listeners use Query parameters (`?key=value`). Monitor commands require
+     * Action parameters (`=key=value`). This method automatically converts your `.where()`
+     * filters into the correct format for these tools.
+     *
+     * @param callback Function to execute with the live metric data.
+     * @returns A `Subscription` object.
+     *
+     * @example
+     * // Monitor Bandwidth on Ether1
+     * client.command('/interface') // or '/interface/monitor-traffic'
+     * .where('interface', 'ether1')
+     * .listenMonitor((stats) => {
+     * console.log(`RX: ${stats['rx-bits-per-second']} bps`);
+     * });
+     */
     listenMonitor(callback: (item: T) => void): Subscription;
+    /**
+     * Clears cache entries related to the current menu path.
+     */
     private invalidatePathCache;
     private shouldDefer;
     private isClientConnected;
+    /**
+     * Merges query params (filters) and property list (selects).
+     */
     private getParams;
     private formatValue;
     private prepareParams;