@iobroker/js-controller-cli 7.0.2 → 7.0.3

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

@@ -18,6 +18,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
@@ -27,6 +31,7 @@ __export(setupInstall_exports, {
   Install: () => Install
 });
 module.exports = __toCommonJS(setupInstall_exports);
+var __import_meta_url = typeof document === "undefined" ? new (require("url".replace("", ""))).URL("file:" + __filename).href : document.currentScript && document.currentScript.src || new URL("main.js", document.baseURI).href;
 var import_js_controller_common = require("@iobroker/js-controller-common");
 var import_fs_extra = __toESM(require("fs-extra"), 1);
 var import_node_path = __toESM(require("node:path"), 1);
@@ -40,8 +45,7 @@ var import_utils = require("../../lib/setup/utils.js");
 var import_customError = require("../../lib/setup/customError.js");
 var import_constants = require("@iobroker/js-controller-common-db/constants");
 var import_node_module = require("node:module");
-const import_meta = {};
-const require2 = (0, import_node_module.createRequire)(import_meta.url || `file://${__filename}`);
+const require2 = (0, import_node_module.createRequire)(__import_meta_url || `file://${__filename}`);
 const hostname = import_js_controller_common.tools.getHostName();
 const osPlatform = process.platform;
 const RECOMMENDED_NPM_VERSION = 8;
@@ -73,6 +77,12 @@ class Install {
     this.tarballRegex = /\/tarball\/[^/]+$/;
     this.upload = new import_setupUpload.Upload(options);
   }
+  /**
+   * Enables or disables given instances
+   *
+   * @param instances all instance objects
+   * @param enabled if enable or disable
+   */
   async enableInstances(instances, enabled) {
     if (instances?.length) {
       const ts = Date.now();
@@ -89,17 +99,24 @@ class Install {
       }
     }
   }
-  async downloadPacket(repoUrl, packetName, options, stoppedList) {
-    let url;
+  /**
+   * Download given packet
+   *
+   * @param repoUrlOrRepo repository url or already the repository object
+   * @param packetName name of the package to install
+   * @param options options.stopDb will stop the db before upgrade ONLY use it for controller upgrade - db is gone afterwards, does not work with stoppedList
+   * @param stoppedList list of stopped instances (as instance objects)
+   */
+  async downloadPacket(repoUrlOrRepo, packetName, options, stoppedList) {
     if (!options || typeof options !== "object") {
       options = {};
     }
     stoppedList = stoppedList || [];
     let sources;
-    if (!repoUrl || !import_js_controller_common.tools.isObject(repoUrl)) {
-      sources = await (0, import_utils.getRepository)({ repoName: repoUrl, objects: this.objects });
+    if (!repoUrlOrRepo || !import_js_controller_common.tools.isObject(repoUrlOrRepo)) {
+      sources = await (0, import_utils.getRepository)({ repoName: repoUrlOrRepo, objects: this.objects });
     } else {
-      sources = repoUrl;
+      sources = repoUrlOrRepo;
     }
     if (options.stopDb && stoppedList.length) {
       console.warn("[downloadPacket] stoppedList cannot be used if stopping of databases is requested");
@@ -118,61 +135,42 @@ class Install {
         version = "";
       }
     }
+    const source = sources[packetName];
+    if (!source) {
+      const errMessage = `Unknown packet name ${packetName}. Please install packages from outside the repository using "${import_js_controller_common.tools.appNameLowerCase} url <url-or-package>"!`;
+      console.error(`host.${hostname} ${errMessage}`);
+      throw new import_customError.IoBrokerError({
+        code: import_js_controller_common.EXIT_CODES.UNKNOWN_PACKET_NAME,
+        message: errMessage
+      });
+    }
     options.packetName = packetName;
-    options.unsafePerm = sources[packetName]?.unsafePerm;
-    if ((sources[packetName]?.stopBeforeUpdate || osPlatform === "win32") && !stoppedList.length) {
+    options.unsafePerm = source.unsafePerm;
+    if ((source.stopBeforeUpdate || osPlatform === "win32") && !stoppedList.length) {
       stoppedList = await this._getInstancesOfAdapter(packetName);
       await this.enableInstances(stoppedList, false);
     }
-    if (!sources[packetName]) {
-      try {
-        const sourcesDist = import_fs_extra.default.readJsonSync(`${import_js_controller_common.tools.getControllerDir()}/conf/sources-dist.json`);
-        sources[packetName] = sourcesDist[packetName];
-      } catch {
+    if (options.stopDb) {
+      if (this.objects.destroy) {
+        await this.objects.destroy();
+        console.log("Stopped Objects DB");
       }
-    }
-    if (sources[packetName]) {
-      url = sources[packetName].url;
-      if (url && packetName === "js-controller" && import_fs_extra.default.pathExistsSync(`${import_js_controller_common.tools.getControllerDir()}/../../node_modules/${import_js_controller_common.tools.appName.toLowerCase()}.js-controller`)) {
-        url = null;
-      }
-      if (!url && packetName !== "example") {
-        if (options.stopDb) {
-          if (this.objects.destroy) {
-            await this.objects.destroy();
-            console.log("Stopped Objects DB");
-          }
-          if (this.states.destroy) {
-            await this.states.destroy();
-            console.log("Stopped States DB");
-          }
-        }
-        await this._npmInstallWithCheck(`${import_js_controller_common.tools.appName.toLowerCase()}.${packetName}${version ? `@${version}` : ""}`, options, debug);
-        return { packetName, stoppedList };
-      } else if (url && url.match(this.tarballRegex)) {
-        if (options.stopDb) {
-          if (this.objects.destroy) {
-            await this.objects.destroy();
-            console.log("Stopped Objects DB");
-          }
-          if (this.states.destroy) {
-            await this.states.destroy();
-            console.log("Stopped States DB");
-          }
-        }
-        await this._npmInstallWithCheck(url, options, debug);
-        return { packetName, stoppedList };
-      } else if (!url) {
-        console.warn(`host.${hostname} Adapter "${packetName}" can be updated only together with ${import_js_controller_common.tools.appName.toLowerCase()}.js-controller`);
-        return { packetName, stoppedList };
+      if (this.states.destroy) {
+        await this.states.destroy();
+        console.log("Stopped States DB");
       }
     }
-    console.error(`host.${hostname} Unknown packet name ${packetName}. Please install packages from outside the repository using "${import_js_controller_common.tools.appNameLowerCase} url <url-or-package>"!`);
-    throw new import_customError.IoBrokerError({
-      code: import_js_controller_common.EXIT_CODES.UNKNOWN_PACKET_NAME,
-      message: `Unknown packetName ${packetName}. Please install packages from outside the repository using npm!`
-    });
+    const npmPacketName = source.packetName ? `${import_js_controller_common.tools.appName.toLowerCase()}.${packetName}@npm:${source.packetName}` : `${import_js_controller_common.tools.appName.toLowerCase()}.${packetName}`;
+    await this._npmInstallWithCheck(`${npmPacketName}${version ? `@${version}` : ""}`, options, debug);
+    return { packetName, stoppedList };
   }
+  /**
+   * Install npm module from url
+   *
+   * @param npmUrl parameter passed to `npm install <npmUrl>`
+   * @param options additional packet download options
+   * @param debug if debug output should be printed
+   */
   async _npmInstallWithCheck(npmUrl, options, debug) {
     try {
       let npmVersion;
@@ -208,10 +206,15 @@ class Install {
     }
     try {
       return await this._npmInstall({ npmUrl, options, debug, isRetry: false });
-    } catch (err) {
-      console.error(`Could not install ${npmUrl}: ${err.message}`);
+    } catch (e) {
+      console.error(`Could not install ${npmUrl}: ${e.message}`);
     }
   }
+  /**
+   * Extract the adapterName e.g. `hm-rpc` from url
+   *
+   * @param npmUrl url of the npm packet
+   */
   getAdapterNameFromUrl(npmUrl) {
     npmUrl = npmUrl.replace(/\\/g, "/").replace(/\.git$/, "").toLowerCase();
     if (npmUrl.includes("#")) {
@@ -225,10 +228,15 @@ class Install {
     }
     return npmUrl;
   }
+  /**
+   * Perform npm installation of given package
+   *
+   * @param installOptions options of package to install
+   */
   async _npmInstall(installOptions) {
     const { npmUrl, debug, isRetry } = installOptions;
     let { options } = installOptions;
-    if (typeof options !== "object") {
+    if (!import_js_controller_common.tools.isObject(options)) {
       options = {};
     }
     if (this.isRootOnUnix) {
@@ -278,6 +286,11 @@ class Install {
     console.error(`host.${hostname} Cannot install ${npmUrl}: ${result.exitCode}`);
     return this.processExit(import_js_controller_common.EXIT_CODES.CANNOT_INSTALL_NPM_PACKET);
   }
+  /**
+   * Handle the NPM `ENOTEMPTY` error, by deleting different affected directories and retrying installation
+   *
+   * @param notEmptyErrorOptions options of package to install
+   */
   handleNpmNotEmptyError(notEmptyErrorOptions) {
     const { debug, npmUrl, options, result } = notEmptyErrorOptions;
     console.info("Try to solve ENOTEMPTY error automatically");
@@ -310,6 +323,7 @@ class Install {
       throw new Error(`host.${hostname}: Cannot uninstall ${packageName}: ${result.exitCode}`);
     }
   }
+  // this command is executed always on THIS host
   async _checkDependencies(deps, globalDeps, _options) {
     if (!deps && !globalDeps) {
       return;
@@ -427,6 +441,13 @@ class Install {
       }
     }
   }
+  /**
+   * Installs given adapter
+   *
+   * @param adapter The adapter name
+   * @param repoUrl
+   * @param _installCount
+   */
   async installAdapter(adapter, repoUrl, _installCount) {
     _installCount = _installCount || 0;
     const fullName = adapter;
@@ -516,6 +537,12 @@ class Install {
       });
     }
   }
+  /**
+   * Create adapter instance
+   *
+   * @param adapter The adapter name
+   * @param options Additional instance creation options
+   */
   async createInstance(adapter, options) {
     let ignoreIfExists = false;
     options = options || {};
@@ -710,6 +737,14 @@ class Install {
       console.error(`host.${hostname} error: ${err2.message}`);
     }
   }
+  /**
+   * Enumerate all instances of an adapter
+   *
+   * @param knownObjIDs
+   * @param notDeleted
+   * @param adapter
+   * @param instance
+   */
   async _enumerateAdapterInstances(knownObjIDs, notDeleted, adapter, instance) {
     if (!notDeleted) {
       notDeleted = [];
@@ -737,6 +772,13 @@ class Install {
       err !== import_js_controller_common.tools.ERRORS.ERROR_NOT_FOUND && err.message !== import_js_controller_common.tools.ERRORS.ERROR_NOT_FOUND && console.error(`host.${hostname} error: ${err.message}`);
     }
   }
+  /**
+   * Enumerate all meta objects of an adapter
+   *
+   * @param knownObjIDs
+   * @param adapter
+   * @param metaFilesToDelete
+   */
   async _enumerateAdapterMeta(knownObjIDs, adapter, metaFilesToDelete) {
     try {
       const doc = await this.objects.getObjectViewAsync("system", "meta", {
@@ -776,6 +818,13 @@ class Install {
       console.error(`host.${hostname} Cannot enumerate adapters: ${err.message}`);
     }
   }
+  /**
+   * Enumerates the devices of an adapter (or instance)
+   *
+   * @param knownObjIDs The already known object ids
+   * @param adapter The adapter to enumerate the devices for
+   * @param instance The instance to enumerate the devices for (optional)
+   */
   async _enumerateAdapterDevices(knownObjIDs, adapter, instance) {
     const adapterRegex = new RegExp(`^${adapter}${instance !== void 0 ? `\\.${instance}` : ""}\\.`);
     try {
@@ -794,6 +843,13 @@ class Install {
       err !== import_js_controller_common.tools.ERRORS.ERROR_NOT_FOUND && err.message !== import_js_controller_common.tools.ERRORS.ERROR_NOT_FOUND && console.error(`host.${hostname} error: ${err.message}`);
     }
   }
+  /**
+   * Enumerates the channels of an adapter (or instance)
+   *
+   * @param knownObjIDs The already known object ids
+   * @param adapter The adapter to enumerate the channels for
+   * @param instance The instance to enumerate the channels for (optional)
+   */
   async _enumerateAdapterChannels(knownObjIDs, adapter, instance) {
     const adapterRegex = new RegExp(`^${adapter}${instance !== void 0 ? `\\.${instance}` : ""}\\.`);
     try {
@@ -812,6 +868,13 @@ class Install {
       err !== import_js_controller_common.tools.ERRORS.ERROR_NOT_FOUND && err.message !== import_js_controller_common.tools.ERRORS.ERROR_NOT_FOUND && console.error(`host.${hostname} error: ${err.message}`);
     }
   }
+  /**
+   * Enumerates the states of an adapter (or instance)
+   *
+   * @param knownObjIDs The already known object ids
+   * @param adapter The adapter to enumerate the states for
+   * @param instance The instance to enumerate the states for (optional)
+   */
   async _enumerateAdapterStateObjects(knownObjIDs, adapter, instance) {
     const adapterRegex = new RegExp(`^${adapter}${instance !== void 0 ? `\\.${instance}` : ""}\\.`);
     const sysAdapterRegex = new RegExp(`^system\\.adapter\\.${adapter}${instance !== void 0 ? `\\.${instance}` : ""}\\.`);
@@ -842,6 +905,13 @@ class Install {
       err !== import_js_controller_common.tools.ERRORS.ERROR_NOT_FOUND && err.message !== import_js_controller_common.tools.ERRORS.ERROR_NOT_FOUND && console.error(`host.${hostname} error: ${err.message}`);
     }
   }
+  /**
+   * Enumerates the docs of an adapter (or instance)
+   *
+   * @param knownObjIDs The already known object ids
+   * @param adapter The adapter to enumerate the states for
+   * @param instance The instance to enumerate the states for (optional)
+   */
   async _enumerateAdapterDocs(knownObjIDs, adapter, instance) {
     const adapterRegex = new RegExp(`^${adapter}${instance !== void 0 ? `\\.${instance}` : ""}\\.`);
     const sysAdapterRegex = new RegExp(`^system\\.adapter\\.${adapter}${instance !== void 0 ? `\\.${instance}` : ""}\\.`);
@@ -861,6 +931,13 @@ class Install {
       err !== import_js_controller_common.tools.ERRORS.ERROR_NOT_FOUND && err.message !== import_js_controller_common.tools.ERRORS.ERROR_NOT_FOUND && console.error(`host.${hostname} error: ${err.message}`);
     }
   }
+  /**
+   * Enumerate all state IDs of an adapter (or instance)
+   *
+   * @param knownStateIDs
+   * @param adapter
+   * @param instance
+   */
   async _enumerateAdapterStates(knownStateIDs, adapter, instance) {
     for (const pattern of [
       `io.${adapter}.${instance !== void 0 ? `${instance}.` : ""}*`,
@@ -883,6 +960,12 @@ class Install {
       }
     }
   }
+  /**
+   * delete WWW pages, objects and meta files
+   *
+   * @param adapter
+   * @param metaFilesToDelete
+   */
   async _deleteAdapterFiles(adapter, metaFilesToDelete) {
     const filesToDelete = [
       { id: "vis", name: `widgets/${adapter}` },
@@ -957,6 +1040,11 @@ class Install {
       }
     }
   }
+  /**
+   * Deletes given adapter from filesystem and removes all instances
+   *
+   * @param adapter adapter name
+   */
   async deleteAdapter(adapter) {
     const knownObjectIDs = [];
     const metaFilesToDelete = [];
@@ -1042,6 +1130,12 @@ class Install {
     }
     return resultCode;
   }
+  /**
+   * Deletes given instance of an adapter
+   *
+   * @param adapter adapter name like hm-rpc
+   * @param instance e.g. 1, if undefined deletes all instances
+   */
   async deleteInstance(adapter, instance) {
     const knownObjectIDs = [];
     const knownStateIDs = [];
@@ -1063,6 +1157,12 @@ class Install {
       await this._removeCustomFromObjects([`${adapter}.${instance}`]);
     }
   }
+  /**
+   * Remove all node modules that has been installed by this instance
+   *
+   * @param adapter adapter name like hm-rpc
+   * @param instance e.g. 1, if undefined deletes all instances
+   */
   async _removeInstancesInstalledNodeModules(adapter, instance) {
     const packJson = import_fs_extra.default.readJSONSync(import_node_path.default.join(import_js_controller_common.tools.getRootDir(), "package.json"));
     const regex = new RegExp(`^@${import_js_controller_common.tools.appNameLowerCase}-${adapter}.${instance !== void 0 ? instance : "\\d+"}\\/.*`, "g");
@@ -1073,6 +1173,11 @@ class Install {
       }
     }
   }
+  /**
+   * Removes the custom attribute of the provided adapter/instance
+   *
+   * @param ids - id of the adapter/instance to check for
+   */
   async _removeCustomFromObjects(ids) {
     const res = await this.objects.getObjectViewAsync("system", "custom", {
       startkey: "",
@@ -1097,6 +1202,12 @@ class Install {
       }
     }
   }
+  /**
+   * Installs an adapter from given url
+   *
+   * @param url url to install adapter from
+   * @param name package name
+   */
   async installAdapterFromUrl(url, name) {
     let parsedUrl;
     try {
@@ -1114,6 +1225,7 @@ class Install {
           const result = await (0, import_axios.default)(`http://api.github.com/repos/${user}/${repo}/commits`, {
             headers: {
               "User-Agent": "ioBroker Adapter install",
+              // @ts-expect-error should be okay...
               validateStatus: (status) => status === 200
             }
           });
@@ -1179,6 +1291,13 @@ class Install {
     await this.upload.upgradeAdapterObjects(name);
     await this.enableInstances(stoppedList, true);
   }
+  /**
+   * Checks if other adapters depend on this adapter
+   *
+   * @param adapter adapter name
+   * @param instance instance, like 1
+   * @returns if dependent exists, returns adapter name
+   */
   async _hasDependentInstances(adapter, instance) {
     try {
       const doc = await this.objects.getObjectViewAsync("system", "instance", {
@@ -1228,6 +1347,14 @@ class Install {
       console.error(`Could not check dependent instances for "${adapter}": ${e.message}`);
     }
   }
+  /**
+   * Checks if adapter can also be found on another host than this
+   *
+   * @param adapter adapter name
+   * @param instancesRows all instances objects view rows
+   * @param scopedHostname hostname which should be assumed as local
+   * @returns true if an instance is present on another host
+   */
   _checkDependencyFulfilledForeignHosts(adapter, instancesRows, scopedHostname) {
     for (const row of instancesRows) {
       if (row.value && row.value.common.name === adapter && row.value.common.host !== scopedHostname) {
@@ -1236,6 +1363,15 @@ class Install {
     }
     return false;
   }
+  /**
+   * Checks if another instance then the given is present on this host
+   *
+   * @param adapter adapter name
+   * @param instance instance number like 1
+   * @param instancesRows all instances objects view rows
+   * @param scopedHostname hostname which should be assumed as local
+   * @returns true if another instance is present on this host
+   */
   _checkDependencyFulfilledThisHost(adapter, instance, instancesRows, scopedHostname) {
     for (const row of instancesRows) {
       if (row.value && row.value.common.name === adapter && row.value.common.host === scopedHostname && parseInt(row.value._id.split(".").pop()) !== instance) {
@@ -1244,6 +1380,11 @@ class Install {
     }
     return false;
   }
+  /**
+   * Get all instances of an adapter which are on the current host
+   *
+   * @param adapter adapter name
+   */
   async _getInstancesOfAdapter(adapter) {
     const instances = [];
     const doc = await this.objects.getObjectListAsync({