@iobroker/js-controller-cli 7.2.3 → 8.0.0-alpha.2-20260923-99da17fcc

package/build/cjs/lib/setup/setupLicense.d.ts

@@ -1,9 +1,18 @@
 import type { Client as ObjectsRedisClient } from '@iobroker/db-objects-redis';
+import type { ProcessCommandOptions } from '../../lib/cli/cliCommand.js';
+/** Options for the license command */
 export interface CLILicenseOptions {
+    /** The objects database client */
     objects: ObjectsRedisClient;
 }
+/**
+ * CLI command to read and apply ioBroker licenses
+ */
 export declare class License {
     private readonly objects;
+    /**
+     * @param options The objects database client
+     */
     constructor(options: CLILicenseOptions);
     /**
      * Read info from  '/etc/iob_vendor.json' and executes instructions stored there
@@ -12,4 +21,8 @@ export declare class License {
      */
     setLicense(file: string): Promise<void>;
 }
+/**
+ * @param options Process command options
+ */
+export declare function processCommandLicense(options: ProcessCommandOptions): void;
 //# sourceMappingURL=setupLicense.d.ts.map

package/build/cjs/lib/setup/setupLicense.js

@@ -5,6 +5,7 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -28,14 +29,22 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var setupLicense_exports = {};
 __export(setupLicense_exports, {
-  License: () => License
+  License: () => License,
+  processCommandLicense: () => processCommandLicense
 });
 module.exports = __toCommonJS(setupLicense_exports);
 var import_js_controller_common = require("@iobroker/js-controller-common");
 var import_fs_extra = __toESM(require("fs-extra"), 1);
 var import_jsonwebtoken = __toESM(require("jsonwebtoken"), 1);
+var import_dbConnection = require("../../lib/setup/dbConnection.js");
 class License {
+  static {
+    __name(this, "License");
+  }
   objects;
+  /**
+   * @param options The objects database client
+   */
   constructor(options) {
     this.objects = options.objects;
   }
@@ -104,8 +113,30 @@ class License {
     }
   }
 }
+function processCommandLicense(options) {
+  const { args, params, callback } = options;
+  const file = args[0];
+  if (!file) {
+    console.warn(`Please specify the path to the license file or place license text directly!
+${import_js_controller_common.tools.appName.toLowerCase()} license <license.file or license.text>`);
+    return void callback(import_js_controller_common.EXIT_CODES.INVALID_ARGUMENTS);
+  }
+  (0, import_dbConnection.dbConnect)(params, async ({ objects }) => {
+    const license = new License({ objects });
+    try {
+      await license.setLicense(file);
+      console.log(`License updated.`);
+      return void callback();
+    } catch (err) {
+      console.error(`Cannot update license: ${err.message}`);
+      return void callback(import_js_controller_common.EXIT_CODES.CANNOT_UPDATE_LICENSE);
+    }
+  });
+}
+__name(processCommandLicense, "processCommandLicense");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  License
+  License,
+  processCommandLicense
 });
 //# sourceMappingURL=setupLicense.js.map

package/build/cjs/lib/setup/setupLicense.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../../src/lib/setup/setupLicense.ts"],
-  "sourcesContent": ["import type { Client as ObjectsRedisClient } from '@iobroker/db-objects-redis';\nimport { tools } from '@iobroker/js-controller-common';\nimport fs from 'fs-extra';\nimport jwt from 'jsonwebtoken';\n\nexport interface CLILicenseOptions {\n    objects: ObjectsRedisClient;\n}\n\nexport class License {\n    private readonly objects: ObjectsRedisClient;\n\n    constructor(options: CLILicenseOptions) {\n        this.objects = options.objects;\n    }\n\n    /**\n     * Read info from  '/etc/iob_vendor.json' and executes instructions stored there\n     *\n     * @param file path of license file\n     */\n    async setLicense(file: string): Promise<void> {\n        if (fs.existsSync(file)) {\n            file = fs.readFileSync(file, 'utf8');\n        }\n        // try to encode license\n        const license = jwt.decode(file);\n        if (!license) {\n            throw new Error('License cannot be decoded');\n        }\n        if (!tools.isObject(license) || !license.name) {\n            throw new Error('Name not found in the license');\n        }\n        const adapter = license.name.split('.')[1];\n        if (!adapter) {\n            throw new Error(`Invalid license name ${license.name}`);\n        }\n\n        // read all instances of this adapter\n        const arr = await this.objects.getObjectListAsync(\n            {\n                startkey: `system.adapter.${adapter}.`,\n                endkey: `system.adapter.${adapter}.\\u9999`,\n            },\n            { checked: true },\n        );\n\n        let updated = 0;\n\n        if (arr.rows.length) {\n            for (let g = 0; g < arr.rows.length; g++) {\n                const obj = arr.rows[g].value;\n                if (obj && obj.type === 'instance') {\n                    obj.native = obj.native || {};\n                    obj.native.license = file;\n                    updated++;\n                    try {\n                        await this.objects.setObjectAsync(obj._id, obj);\n                        console.log(`Instance \"${obj._id}\" updated`);\n                    } catch (err) {\n                        console.error(`Cannot update \"${obj._id}\": ${err}`);\n                    }\n                }\n            }\n        }\n\n        if (!updated) {\n            console.warn(`no instances of ${adapter} found`);\n            if (arr.rows.length) {\n                for (let g = 0; g < arr.rows.length; g++) {\n                    const obj = arr.rows[g].value;\n                    if (obj && obj.type === 'adapter') {\n                        obj.native = obj.native || {};\n                        obj.native.license = file;\n                        updated++;\n                        try {\n                            await this.objects.setObjectAsync(obj._id, obj);\n                            console.log(`Adapter \"${obj._id}\" updated`);\n                        } catch (err) {\n                            console.error(`Cannot update \"${obj._id}\": ${err}`);\n                        }\n                    }\n                }\n            }\n        }\n\n        if (!updated) {\n            console.error(`no installations of ${adapter} found`);\n        }\n    }\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA;;;;;AAAA,kCAAsB;AACtB,sBAAe;AACf,0BAAgB;AAMV,MAAO,QAAO;EACC;EAEjB,YAAY,SAA0B;AAClC,SAAK,UAAU,QAAQ;EAC3B;;;;;;EAOA,MAAM,WAAW,MAAY;AACzB,QAAI,gBAAAA,QAAG,WAAW,IAAI,GAAG;AACrB,aAAO,gBAAAA,QAAG,aAAa,MAAM,MAAM;IACvC;AAEA,UAAM,UAAU,oBAAAC,QAAI,OAAO,IAAI;AAC/B,QAAI,CAAC,SAAS;AACV,YAAM,IAAI,MAAM,2BAA2B;IAC/C;AACA,QAAI,CAAC,kCAAM,SAAS,OAAO,KAAK,CAAC,QAAQ,MAAM;AAC3C,YAAM,IAAI,MAAM,+BAA+B;IACnD;AACA,UAAM,UAAU,QAAQ,KAAK,MAAM,GAAG,EAAE,CAAC;AACzC,QAAI,CAAC,SAAS;AACV,YAAM,IAAI,MAAM,wBAAwB,QAAQ,IAAI,EAAE;IAC1D;AAGA,UAAM,MAAM,MAAM,KAAK,QAAQ,mBAC3B;MACI,UAAU,kBAAkB,OAAO;MACnC,QAAQ,kBAAkB,OAAO;OAErC,EAAE,SAAS,KAAI,CAAE;AAGrB,QAAI,UAAU;AAEd,QAAI,IAAI,KAAK,QAAQ;AACjB,eAAS,IAAI,GAAG,IAAI,IAAI,KAAK,QAAQ,KAAK;AACtC,cAAM,MAAM,IAAI,KAAK,CAAC,EAAE;AACxB,YAAI,OAAO,IAAI,SAAS,YAAY;AAChC,cAAI,SAAS,IAAI,UAAU,CAAA;AAC3B,cAAI,OAAO,UAAU;AACrB;AACA,cAAI;AACA,kBAAM,KAAK,QAAQ,eAAe,IAAI,KAAK,GAAG;AAC9C,oBAAQ,IAAI,aAAa,IAAI,GAAG,WAAW;UAC/C,SAAS,KAAK;AACV,oBAAQ,MAAM,kBAAkB,IAAI,GAAG,MAAM,GAAG,EAAE;UACtD;QACJ;MACJ;IACJ;AAEA,QAAI,CAAC,SAAS;AACV,cAAQ,KAAK,mBAAmB,OAAO,QAAQ;AAC/C,UAAI,IAAI,KAAK,QAAQ;AACjB,iBAAS,IAAI,GAAG,IAAI,IAAI,KAAK,QAAQ,KAAK;AACtC,gBAAM,MAAM,IAAI,KAAK,CAAC,EAAE;AACxB,cAAI,OAAO,IAAI,SAAS,WAAW;AAC/B,gBAAI,SAAS,IAAI,UAAU,CAAA;AAC3B,gBAAI,OAAO,UAAU;AACrB;AACA,gBAAI;AACA,oBAAM,KAAK,QAAQ,eAAe,IAAI,KAAK,GAAG;AAC9C,sBAAQ,IAAI,YAAY,IAAI,GAAG,WAAW;YAC9C,SAAS,KAAK;AACV,sBAAQ,MAAM,kBAAkB,IAAI,GAAG,MAAM,GAAG,EAAE;YACtD;UACJ;QACJ;MACJ;IACJ;AAEA,QAAI,CAAC,SAAS;AACV,cAAQ,MAAM,uBAAuB,OAAO,QAAQ;IACxD;EACJ;;",
+  "sourcesContent": ["import type { Client as ObjectsRedisClient } from '@iobroker/db-objects-redis';\nimport { tools, EXIT_CODES } from '@iobroker/js-controller-common';\nimport fs from 'fs-extra';\nimport jwt from 'jsonwebtoken';\nimport type { ProcessCommandOptions } from '@/lib/cli/cliCommand.js';\nimport { dbConnect } from '@/lib/setup/dbConnection.js';\n\n/** Options for the license command */\nexport interface CLILicenseOptions {\n    /** The objects database client */\n    objects: ObjectsRedisClient;\n}\n\n/**\n * CLI command to read and apply ioBroker licenses\n */\nexport class License {\n    private readonly objects: ObjectsRedisClient;\n\n    /**\n     * @param options The objects database client\n     */\n    constructor(options: CLILicenseOptions) {\n        this.objects = options.objects;\n    }\n\n    /**\n     * Read info from  '/etc/iob_vendor.json' and executes instructions stored there\n     *\n     * @param file path of license file\n     */\n    async setLicense(file: string): Promise<void> {\n        if (fs.existsSync(file)) {\n            file = fs.readFileSync(file, 'utf8');\n        }\n        // try to encode license\n        const license = jwt.decode(file);\n        if (!license) {\n            throw new Error('License cannot be decoded');\n        }\n        if (!tools.isObject(license) || !license.name) {\n            throw new Error('Name not found in the license');\n        }\n        const adapter = license.name.split('.')[1];\n        if (!adapter) {\n            throw new Error(`Invalid license name ${license.name}`);\n        }\n\n        // read all instances of this adapter\n        const arr = await this.objects.getObjectListAsync(\n            {\n                startkey: `system.adapter.${adapter}.`,\n                endkey: `system.adapter.${adapter}.\\u9999`,\n            },\n            { checked: true },\n        );\n\n        let updated = 0;\n\n        if (arr.rows.length) {\n            for (let g = 0; g < arr.rows.length; g++) {\n                const obj = arr.rows[g].value;\n                if (obj && obj.type === 'instance') {\n                    obj.native = obj.native || {};\n                    obj.native.license = file;\n                    updated++;\n                    try {\n                        await this.objects.setObjectAsync(obj._id, obj);\n                        console.log(`Instance \"${obj._id}\" updated`);\n                    } catch (err) {\n                        console.error(`Cannot update \"${obj._id}\": ${err}`);\n                    }\n                }\n            }\n        }\n\n        if (!updated) {\n            console.warn(`no instances of ${adapter} found`);\n            if (arr.rows.length) {\n                for (let g = 0; g < arr.rows.length; g++) {\n                    const obj = arr.rows[g].value;\n                    if (obj && obj.type === 'adapter') {\n                        obj.native = obj.native || {};\n                        obj.native.license = file;\n                        updated++;\n                        try {\n                            await this.objects.setObjectAsync(obj._id, obj);\n                            console.log(`Adapter \"${obj._id}\" updated`);\n                        } catch (err) {\n                            console.error(`Cannot update \"${obj._id}\": ${err}`);\n                        }\n                    }\n                }\n            }\n        }\n\n        if (!updated) {\n            console.error(`no installations of ${adapter} found`);\n        }\n    }\n}\n\n/**\n * @param options Process command options\n */\nexport function processCommandLicense(options: ProcessCommandOptions): void {\n    const { args, params, callback } = options;\n\n    const file = args[0];\n    if (!file) {\n        console.warn(\n            `Please specify the path to the license file or place license text directly!\\n${tools.appName.toLowerCase()} license <license.file or license.text>`,\n        );\n        return void callback(EXIT_CODES.INVALID_ARGUMENTS);\n    }\n    dbConnect(params, async ({ objects }) => {\n        const license = new License({ objects });\n        try {\n            await license.setLicense(file);\n            console.log(`License updated.`);\n            return void callback();\n        } catch (err) {\n            console.error(`Cannot update license: ${err.message}`);\n            return void callback(EXIT_CODES.CANNOT_UPDATE_LICENSE);\n        }\n    });\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA;;;;;;AAAA,kCAAkC;AAClC,sBAAe;AACf,0BAAgB;AAEhB,0BAA0B;AAWpB,MAAO,QAAO;EAfpB,OAeoB;;;EACC;;;;EAKjB,YAAY,SAA0B;AAClC,SAAK,UAAU,QAAQ;EAC3B;;;;;;EAOA,MAAM,WAAW,MAAY;AACzB,QAAI,gBAAAA,QAAG,WAAW,IAAI,GAAG;AACrB,aAAO,gBAAAA,QAAG,aAAa,MAAM,MAAM;IACvC;AAEA,UAAM,UAAU,oBAAAC,QAAI,OAAO,IAAI;AAC/B,QAAI,CAAC,SAAS;AACV,YAAM,IAAI,MAAM,2BAA2B;IAC/C;AACA,QAAI,CAAC,kCAAM,SAAS,OAAO,KAAK,CAAC,QAAQ,MAAM;AAC3C,YAAM,IAAI,MAAM,+BAA+B;IACnD;AACA,UAAM,UAAU,QAAQ,KAAK,MAAM,GAAG,EAAE,CAAC;AACzC,QAAI,CAAC,SAAS;AACV,YAAM,IAAI,MAAM,wBAAwB,QAAQ,IAAI,EAAE;IAC1D;AAGA,UAAM,MAAM,MAAM,KAAK,QAAQ,mBAC3B;MACI,UAAU,kBAAkB,OAAO;MACnC,QAAQ,kBAAkB,OAAO;OAErC,EAAE,SAAS,KAAI,CAAE;AAGrB,QAAI,UAAU;AAEd,QAAI,IAAI,KAAK,QAAQ;AACjB,eAAS,IAAI,GAAG,IAAI,IAAI,KAAK,QAAQ,KAAK;AACtC,cAAM,MAAM,IAAI,KAAK,CAAC,EAAE;AACxB,YAAI,OAAO,IAAI,SAAS,YAAY;AAChC,cAAI,SAAS,IAAI,UAAU,CAAA;AAC3B,cAAI,OAAO,UAAU;AACrB;AACA,cAAI;AACA,kBAAM,KAAK,QAAQ,eAAe,IAAI,KAAK,GAAG;AAC9C,oBAAQ,IAAI,aAAa,IAAI,GAAG,WAAW;UAC/C,SAAS,KAAK;AACV,oBAAQ,MAAM,kBAAkB,IAAI,GAAG,MAAM,GAAG,EAAE;UACtD;QACJ;MACJ;IACJ;AAEA,QAAI,CAAC,SAAS;AACV,cAAQ,KAAK,mBAAmB,OAAO,QAAQ;AAC/C,UAAI,IAAI,KAAK,QAAQ;AACjB,iBAAS,IAAI,GAAG,IAAI,IAAI,KAAK,QAAQ,KAAK;AACtC,gBAAM,MAAM,IAAI,KAAK,CAAC,EAAE;AACxB,cAAI,OAAO,IAAI,SAAS,WAAW;AAC/B,gBAAI,SAAS,IAAI,UAAU,CAAA;AAC3B,gBAAI,OAAO,UAAU;AACrB;AACA,gBAAI;AACA,oBAAM,KAAK,QAAQ,eAAe,IAAI,KAAK,GAAG;AAC9C,sBAAQ,IAAI,YAAY,IAAI,GAAG,WAAW;YAC9C,SAAS,KAAK;AACV,sBAAQ,MAAM,kBAAkB,IAAI,GAAG,MAAM,GAAG,EAAE;YACtD;UACJ;QACJ;MACJ;IACJ;AAEA,QAAI,CAAC,SAAS;AACV,cAAQ,MAAM,uBAAuB,OAAO,QAAQ;IACxD;EACJ;;AAME,SAAU,sBAAsB,SAA8B;AAChE,QAAM,EAAE,MAAM,QAAQ,SAAQ,IAAK;AAEnC,QAAM,OAAO,KAAK,CAAC;AACnB,MAAI,CAAC,MAAM;AACP,YAAQ,KACJ;EAAgF,kCAAM,QAAQ,YAAW,CAAE,yCAAyC;AAExJ,WAAO,KAAK,SAAS,uCAAW,iBAAiB;EACrD;AACA,qCAAU,QAAQ,OAAO,EAAE,QAAO,MAAM;AACpC,UAAM,UAAU,IAAI,QAAQ,EAAE,QAAO,CAAE;AACvC,QAAI;AACA,YAAM,QAAQ,WAAW,IAAI;AAC7B,cAAQ,IAAI,kBAAkB;AAC9B,aAAO,KAAK,SAAQ;IACxB,SAAS,KAAK;AACV,cAAQ,MAAM,0BAA0B,IAAI,OAAO,EAAE;AACrD,aAAO,KAAK,SAAS,uCAAW,qBAAqB;IACzD;EACJ,CAAC;AACL;AArBgB;",
   "names": ["fs", "jwt"]
 }

package/build/cjs/lib/setup/setupList.d.ts

@@ -1,7 +1,7 @@
 /**
  *      List different objects for CLI
  *
- *      Copyright 2013-2024 bluefox <dogafox@gmail.com>
+ *      Copyright 2013-2026 bluefox <dogafox@gmail.com>
  *
  *      MIT License
  *
@@ -27,21 +27,75 @@ interface CLIListOptions {
     processExit: (exitCode?: number) => void;
 }
 export type ListType = 'objects' | 'o' | 'states' | 's' | 'adapters' | 'a' | 'instances' | 'i' | 'users' | 'u' | 'groups' | 'g' | 'hosts' | 'h' | 'enums' | 'e' | 'files' | 'f';
+/**
+ * CLI command to list adapters, instances, objects and files
+ */
 export declare class List {
     private config;
     private objects;
     private states;
     private readonly processExit;
+    /**
+     * @param options The objects/states clients, config and process-exit callback
+     */
     constructor(options: CLIListOptions);
     private static _perm2str;
+    /**
+     * Print the table header for a file listing
+     *
+     * @param adapter Optional adapter name printed above the header
+     */
     showFileHeader(adapter?: string): void;
+    /**
+     * Print a single file as a table row
+     *
+     * @param adapter The adapter the file belongs to
+     * @param path The directory path of the file
+     * @param file The file entry to print
+     */
     showFile(adapter: string, path: string, file: ioBroker.ReadDirResult): void;
+    /**
+     * Print the table header for an object listing
+     */
     showObjectHeader(): void;
+    /**
+     * Print a single object as a table row
+     *
+     * @param obj The object to print
+     */
     showObject(obj: ioBroker.AnyObject): void;
+    /**
+     * Recursively list the files in a directory of an adapter
+     *
+     * @param adapter The adapter the files belong to
+     * @param path The directory path to list
+     * @param allFiles Accumulator of files collected so far, or the callback
+     * @param callback Called with all collected files
+     */
     listDirectory(adapter: string, path: string | null | undefined, allFiles?: File[] | ((allFiles: File[]) => void), callback?: (allFiles: File[]) => void): void;
+    /**
+     * Comparator that sorts two file entries by their full path
+     *
+     * @param a The first file entry
+     * @param b The second file entry
+     */
     sortFiles(a: File, b: File): number;
+    /**
+     * List the files of the given adapters
+     *
+     * @param adapters The adapters whose files should be listed
+     * @param filter Optional name filter, or the callback
+     * @param callback Called once all files have been listed
+     */
     listAdaptersFiles(adapters: string[], filter?: null | string, callback?: () => void): void | Promise<void>;
     private _readOnlineState;
+    /**
+     * List items of the given type matching the filter
+     *
+     * @param type The kind of items to list (e.g. adapters, instances, objects)
+     * @param filter A filter applied to the listed items
+     * @param flags Additional flags controlling the output
+     */
     list(type: ListType, filter: string, flags: FlagObject): void;
 }
 export {};

package/build/cjs/lib/setup/setupList.js

@@ -5,6 +5,7 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -31,14 +32,19 @@ __export(setupList_exports, {
   List: () => List
 });
 module.exports = __toCommonJS(setupList_exports);
-var import_js_controller_common = require("@iobroker/js-controller-common");
 var import_fs_extra = __toESM(require("fs-extra"), 1);
-var import_js_controller_common2 = require("@iobroker/js-controller-common");
+var import_js_controller_common = require("@iobroker/js-controller-common");
 class List {
+  static {
+    __name(this, "List");
+  }
   config;
   objects;
   states;
   processExit;
+  /**
+   * @param options The objects/states clients, config and process-exit callback
+   */
   constructor(options) {
     options = options || {};
     if (!options.states) {
@@ -50,7 +56,7 @@ class List {
     if (!options.processExit) {
       throw new Error("Invalid arguments: processExit is missing");
     }
-    this.config = import_fs_extra.default.readJSONSync(import_js_controller_common2.tools.getConfigFileName());
+    this.config = import_fs_extra.default.readJSONSync(import_js_controller_common.tools.getConfigFileName());
     this.objects = options.objects;
     this.states = options.states;
     this.processExit = options.processExit;
@@ -68,6 +74,11 @@ class List {
     result += perm & 1 ? "x" : "-";
     return result;
   }
+  /**
+   * Print the table header for a file listing
+   *
+   * @param adapter Optional adapter name printed above the header
+   */
   showFileHeader(adapter) {
     if (adapter) {
       console.log(`
@@ -76,6 +87,13 @@ class List {
     console.log("   Modified at  |Permission|     User     |     Group    | Size | Name");
     console.log("----------------+----------+--------------+--------------+------+---------");
   }
+  /**
+   * Print a single file as a table row
+   *
+   * @param adapter The adapter the file belongs to
+   * @param path The directory path of the file
+   * @param file The file entry to print
+   */
   showFile(adapter, path, file) {
     let text = "";
     let time = "";
@@ -106,10 +124,18 @@ class List {
       console.log(text);
     }
   }
+  /**
+   * Print the table header for an object listing
+   */
   showObjectHeader() {
     console.log("ObjectAC | StateAC |     User     |     Group    | ID");
     console.log("---------+---------+--------------+--------------+--------------");
   }
+  /**
+   * Print a single object as a table row
+   *
+   * @param obj The object to print
+   */
   showObject(obj) {
     let text = "";
     if (obj.acl) {
@@ -126,6 +152,14 @@ class List {
     text += ` ${obj._id}`;
     console.log(text);
   }
+  /**
+   * Recursively list the files in a directory of an adapter
+   *
+   * @param adapter The adapter the files belong to
+   * @param path The directory path to list
+   * @param allFiles Accumulator of files collected so far, or the callback
+   * @param callback Called with all collected files
+   */
   listDirectory(adapter, path, allFiles, callback) {
     if (typeof path === "function") {
       callback = path;
@@ -186,6 +220,12 @@ class List {
       }
     });
   }
+  /**
+   * Comparator that sorts two file entries by their full path
+   *
+   * @param a The first file entry
+   * @param b The second file entry
+   */
   sortFiles(a, b) {
     let a1 = a.path + a.file.file;
     if (a1[0] !== "/") {
@@ -197,6 +237,13 @@ class List {
     }
     return a1.localeCompare(b1);
   }
+  /**
+   * List the files of the given adapters
+   *
+   * @param adapters The adapters whose files should be listed
+   * @param filter Optional name filter, or the callback
+   * @param callback Called once all files have been listed
+   */
   listAdaptersFiles(adapters, filter, callback) {
     if (typeof filter === "function") {
       callback = filter;
@@ -214,21 +261,21 @@ class List {
         files.sort(this.sortFiles);
         this.showFileHeader(adapter);
         files.filter((f) => !filter || `${f.path}/${f.file.file}`.startsWith(filter)).forEach((f) => this.showFile(f.adapter, f.path, f.file));
-        this.listAdaptersFiles(adapters, filter, callback);
+        return this.listAdaptersFiles(adapters, filter, callback);
       });
     } else {
-      return import_js_controller_common2.tools.maybeCallback(callback);
+      return import_js_controller_common.tools.maybeCallback(callback);
     }
   }
   _readOnlineState(lines, flags, cb, _result) {
     const result = _result || [];
-    if (!lines || !lines.length) {
+    if (!lines?.length) {
       cb(result);
     } else {
       const task = lines.shift();
       const id = `${task.id}.alive`;
-      this.states.getState(id, (err, state) => {
-        if (state && state.val) {
+      this.states.getState(id, (_err, state) => {
+        if (state?.val) {
           result.push(`+ ${task.value}`);
         } else if (!flags.alive) {
           result.push(`  ${task.value}`);
@@ -237,6 +284,13 @@ class List {
       });
     }
   }
+  /**
+   * List items of the given type matching the filter
+   *
+   * @param type The kind of items to list (e.g. adapters, instances, objects)
+   * @param filter A filter applied to the listed items
+   * @param flags Additional flags controlling the output
+   */
   list(type, filter, flags) {
     this.objects.getObject("system.config", (err, systemConf) => {
       const lang = systemConf?.common?.language || "en";
@@ -248,10 +302,10 @@ class List {
               this.processExit();
               return;
             }
-            const reg = filter ? new RegExp(import_js_controller_common2.tools.pattern2RegEx(filter)) : null;
+            const reg = filter ? new RegExp(import_js_controller_common.tools.pattern2RegEx(filter)) : null;
             for (const obj of objs.rows) {
               let name = obj.value?.common?.name;
-              if (import_js_controller_common2.tools.isObject(name)) {
+              if (import_js_controller_common.tools.isObject(name)) {
                 name = name[lang] || name.en;
               }
               if (!reg || reg.test(obj.value._id) || name && reg.test(name)) {
@@ -301,7 +355,7 @@ class List {
               this.processExit();
               return;
             }
-            const reg = filter ? new RegExp(import_js_controller_common2.tools.pattern2RegEx(`system.adapter.${filter}`)) : null;
+            const reg = filter ? new RegExp(import_js_controller_common.tools.pattern2RegEx(`system.adapter.${filter}`)) : null;
             const adapterList = [];
             for (const obj of objs.rows) {
               if (obj.value.type !== "adapter") {
@@ -310,7 +364,7 @@ class List {
               if (!reg || reg.test(obj.value._id) || obj.value.common && reg.test(obj.value.common.name)) {
                 const id = obj.value._id;
                 let name = obj.value.common.name;
-                if (import_js_controller_common2.tools.isObject(name)) {
+                if (import_js_controller_common.tools.isObject(name)) {
                   name = name[lang] || name.en;
                 }
                 adapterList.push({
@@ -332,7 +386,7 @@ class List {
               this.processExit();
               return;
             }
-            const reg = filter ? new RegExp(import_js_controller_common2.tools.pattern2RegEx(`system.adapter.${filter}`)) : null;
+            const reg = filter ? new RegExp(import_js_controller_common.tools.pattern2RegEx(`system.adapter.${filter}`)) : null;
             objs.rows.sort((a, b) => {
               if (a.id > b.id) {
                 return 1;
@@ -347,7 +401,7 @@ class List {
                 continue;
               }
               let name = row.value.common?.name;
-              if (import_js_controller_common2.tools.isObject(name)) {
+              if (import_js_controller_common.tools.isObject(name)) {
                 name = name[lang] || name.en;
               }
               if (!reg || reg.test(row.value._id) || name && reg.test(name)) {
@@ -411,17 +465,17 @@ class List {
                 this.processExit();
                 return;
               }
-              const reg = filter ? new RegExp(import_js_controller_common2.tools.pattern2RegEx(`system.user.${filter}`)) : null;
+              const reg = filter ? new RegExp(import_js_controller_common.tools.pattern2RegEx(`system.user.${filter}`)) : null;
               console.log("    ID                                 | Name        | Active   | Groups");
               console.log("---------------------------------------+-------------+----------+--------------");
               for (const obj of objs.rows) {
                 if (obj.value.type !== "user") {
                   continue;
                 }
-                if (!reg || reg.test(obj.value._id) || obj.value.common && reg.test(import_js_controller_common2.tools.isObject(obj.value.common.name) ? obj.value.common.name[lang] || obj.value.common.name.en : obj.value.common.name)) {
+                if (!reg || reg.test(obj.value._id) || obj.value.common && reg.test(import_js_controller_common.tools.isObject(obj.value.common.name) ? obj.value.common.name[lang] || obj.value.common.name.en : obj.value.common.name)) {
                   const id = obj.value._id;
                   let name = obj.value.common.name;
-                  if (import_js_controller_common2.tools.isObject(name)) {
+                  if (import_js_controller_common.tools.isObject(name)) {
                     name = name[lang] || name.en;
                   }
                   const text = `${id.padEnd(39)}| ${name.padEnd(11)} | ${obj.value.common.enabled ? " enabled" : "disabled"} |`;
@@ -447,7 +501,7 @@ class List {
               this.processExit();
               return;
             }
-            const reg = filter ? new RegExp(import_js_controller_common2.tools.pattern2RegEx(`system.group.${filter}`)) : null;
+            const reg = filter ? new RegExp(import_js_controller_common.tools.pattern2RegEx(`system.group.${filter}`)) : null;
             console.log("");
             console.log("  system.group      | object  | state   | file      | user  | others                 | users");
             console.log("                    | l r w d | l r w d | l r w c d | w c d |                        |");
@@ -456,7 +510,7 @@ class List {
               if (obj.value.type !== "group") {
                 continue;
               }
-              if (!reg || reg.test(obj.value._id) || obj.value.common && reg.test(import_js_controller_common2.tools.isObject(obj.value.common.name) ? obj.value.common.name[lang] || obj.value.common.name.en : obj.value.common.name)) {
+              if (!reg || reg.test(obj.value._id) || obj.value.common && reg.test(import_js_controller_common.tools.isObject(obj.value.common.name) ? obj.value.common.name[lang] || obj.value.common.name.en : obj.value.common.name)) {
                 const id = obj.value._id.substring(13);
                 if (id === "administrator") {
                   obj.value.common.acl = {
@@ -577,7 +631,7 @@ class List {
                   this.processExit();
                   return;
                 }
-                const reg = filter ? new RegExp(import_js_controller_common2.tools.pattern2RegEx(`system.host.${filter}`)) : null;
+                const reg = filter ? new RegExp(import_js_controller_common.tools.pattern2RegEx(`system.host.${filter}`)) : null;
                 for (const obj of objs.rows) {
                   if (obj.value.type !== "host") {
                     continue;
@@ -585,7 +639,7 @@ class List {
                   if (!reg || reg.test(obj.value._id) || obj.value.common && reg.test(obj.value.common.name)) {
                     const id = obj.value._id.substring(12);
                     let name = obj.value.common.name;
-                    if (import_js_controller_common2.tools.isObject(name)) {
+                    if (import_js_controller_common.tools.isObject(name)) {
                       name = name[lang] || name.en;
                     }
                     const hostname = obj.value.common.hostname;
@@ -620,13 +674,13 @@ class List {
               this.processExit();
               return;
             }
-            const reg = filter ? new RegExp(import_js_controller_common2.tools.pattern2RegEx(`enum.${filter}`)) : null;
+            const reg = filter ? new RegExp(import_js_controller_common.tools.pattern2RegEx(`enum.${filter}`)) : null;
             for (const obj of objs.rows) {
               if (obj.value.type !== "enum") {
                 continue;
               }
               let name = obj.value.common?.name;
-              if (import_js_controller_common2.tools.isObject(name)) {
+              if (import_js_controller_common.tools.isObject(name)) {
                 name = name[lang] || name.en;
               }
               if (!reg || reg.test(obj.value._id) || name && reg.test(name)) {
@@ -658,7 +712,7 @@ class List {
             if (names) {
               names.shift();
             }
-            this.listAdaptersFiles(adapters, names ? names.join("/") : null, () => this.processExit());
+            return this.listAdaptersFiles(adapters, names ? names.join("/") : null, () => this.processExit());
           });
           break;
       }