@iobroker/db-objects-redis 7.0.2 → 7.0.3

package/build/cjs/index.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
 ));

package/build/cjs/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/index.ts"],
-  "sourcesContent": ["/**\n * Get the default port for the database\n *\n * @param host string of host(s)\n */\nexport function getDefaultPort(host: string): number {\n    return host.includes(',') ? 26379 : 6379;\n}\nexport const Server = null;\nexport { ObjectsInRedisClient as Client } from '@/lib/objects/objectsInRedisClient.js';\nexport { interview } from '@/lib/objects/interview.js';\nexport * as objectsUtils from '@/lib/objects/objectsUtils.js';\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;AASA,kCAA+C;AAC/C,uBAA0B;AAC1B,mBAA8B;AANxB,SAAU,eAAe,MAAY;AACvC,SAAO,KAAK,SAAS,GAAG,IAAI,QAAQ;AACxC;AACO,MAAM,SAAS;",
+  "sourcesContent": ["/// <reference types=\"@iobroker/types-dev\" />\n/**\n * Get the default port for the database\n *\n * @param host string of host(s)\n */\nexport function getDefaultPort(host: string): number {\n    return host.includes(',') ? 26379 : 6379;\n}\nexport const Server = null;\nexport { ObjectsInRedisClient as Client } from '@/lib/objects/objectsInRedisClient.js';\nexport { interview } from '@/lib/objects/interview.js';\nexport * as objectsUtils from '@/lib/objects/objectsUtils.js';\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;AAUA,kCAA+C;AAC/C,uBAA0B;AAC1B,mBAA8B;AANxB,SAAU,eAAe,MAAY;AACvC,SAAO,KAAK,SAAS,GAAG,IAAI,QAAQ;AACxC;AACO,MAAM,SAAS;",
   "names": []
 }

package/build/cjs/lib/objects/constants.js.map

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../../../../src/lib/objects/constants.ts"],
   "sourcesContent": ["export enum ERRORS {\n    ERROR_PERMISSION = 'permissionError',\n    ERROR_NOT_FOUND = 'Not exists',\n    ERROR_DB_CLOSED = 'DB closed',\n}\n\nexport const SYSTEM_ADMIN_USER = 'system.user.admin';\nexport const SYSTEM_ADMIN_GROUP = 'system.group.administrator';\n\nexport const ACCESS_EVERY_EXEC = 0x1;\nexport const ACCESS_EVERY_WRITE = 0x2;\nexport const ACCESS_EVERY_READ = 0x4;\nexport const ACCESS_EVERY_RW = ACCESS_EVERY_WRITE | ACCESS_EVERY_READ;\nexport const ACCESS_EVERY_ALL = ACCESS_EVERY_WRITE | ACCESS_EVERY_READ | ACCESS_EVERY_EXEC;\n\nexport const ACCESS_GROUP_EXEC = 0x10;\nexport const ACCESS_GROUP_WRITE = 0x20;\nexport const ACCESS_GROUP_READ = 0x40;\nexport const ACCESS_GROUP_RW = ACCESS_GROUP_WRITE | ACCESS_GROUP_READ;\nexport const ACCESS_GROUP_ALL = ACCESS_GROUP_WRITE | ACCESS_GROUP_READ | ACCESS_GROUP_EXEC;\n\nexport const ACCESS_USER_EXEC = 0x100;\nexport const ACCESS_USER_WRITE = 0x200;\nexport const ACCESS_USER_READ = 0x400;\nexport const ACCESS_USER_RW = ACCESS_USER_WRITE | ACCESS_USER_READ;\nexport const ACCESS_USER_ALL = ACCESS_USER_WRITE | ACCESS_USER_READ | ACCESS_USER_EXEC;\n\nexport const ACCESS_WRITE = 0x2;\nexport const ACCESS_READ = 0x4;\nexport const ACCESS_LIST = 'list';\nexport const ACCESS_DELETE = 'delete';\nexport const ACCESS_CREATE = 'create';\n\nexport type GenericAccessFlags =\n    | typeof ACCESS_WRITE\n    | typeof ACCESS_READ\n    | typeof ACCESS_LIST\n    | typeof ACCESS_DELETE\n    | typeof ACCESS_CREATE;\n\nexport const REG_CHECK_ID = /[*?[\\]]|\\$%\\$/;\n\nexport const USER_STARTS_WITH = 'system.user.';\nexport const GROUP_STARTS_WITH = 'system.group.';\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAY;CAAZ,SAAYA,SAAM;AACd,EAAAA,QAAA,sBAAA;AACA,EAAAA,QAAA,qBAAA;AACA,EAAAA,QAAA,qBAAA;AACJ,GAJY,WAAA,SAAM,CAAA,EAAA;AAMX,MAAM,oBAAoB;AAC1B,MAAM,qBAAqB;AAE3B,MAAM,oBAAoB;AAC1B,MAAM,qBAAqB;AAC3B,MAAM,oBAAoB;AAC1B,MAAM,kBAAkB,qBAAqB;AAC7C,MAAM,mBAAmB,qBAAqB,oBAAoB;AAElE,MAAM,oBAAoB;AAC1B,MAAM,qBAAqB;AAC3B,MAAM,oBAAoB;AAC1B,MAAM,kBAAkB,qBAAqB;AAC7C,MAAM,mBAAmB,qBAAqB,oBAAoB;AAElE,MAAM,mBAAmB;AACzB,MAAM,oBAAoB;AAC1B,MAAM,mBAAmB;AACzB,MAAM,iBAAiB,oBAAoB;AAC3C,MAAM,kBAAkB,oBAAoB,mBAAmB;AAE/D,MAAM,eAAe;AACrB,MAAM,cAAc;AACpB,MAAM,cAAc;AACpB,MAAM,gBAAgB;AACtB,MAAM,gBAAgB;AAStB,MAAM,eAAe;AAErB,MAAM,mBAAmB;AACzB,MAAM,oBAAoB;",
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAY;CAAZ,SAAYA,SAAM;AACd,EAAAA,QAAA,kBAAA,IAAA;AACA,EAAAA,QAAA,iBAAA,IAAA;AACA,EAAAA,QAAA,iBAAA,IAAA;AACJ,GAJY,WAAA,SAAM,CAAA,EAAA;AAMX,MAAM,oBAAoB;AAC1B,MAAM,qBAAqB;AAE3B,MAAM,oBAAoB;AAC1B,MAAM,qBAAqB;AAC3B,MAAM,oBAAoB;AAC1B,MAAM,kBAAkB,qBAAqB;AAC7C,MAAM,mBAAmB,qBAAqB,oBAAoB;AAElE,MAAM,oBAAoB;AAC1B,MAAM,qBAAqB;AAC3B,MAAM,oBAAoB;AAC1B,MAAM,kBAAkB,qBAAqB;AAC7C,MAAM,mBAAmB,qBAAqB,oBAAoB;AAElE,MAAM,mBAAmB;AACzB,MAAM,oBAAoB;AAC1B,MAAM,mBAAmB;AACzB,MAAM,iBAAiB,oBAAoB;AAC3C,MAAM,kBAAkB,oBAAoB,mBAAmB;AAE/D,MAAM,eAAe;AACrB,MAAM,cAAc;AACpB,MAAM,cAAc;AACpB,MAAM,gBAAgB;AACtB,MAAM,gBAAgB;AAStB,MAAM,eAAe;AAErB,MAAM,mBAAmB;AACzB,MAAM,oBAAoB;",
   "names": ["ERRORS"]
 }

package/build/cjs/lib/objects/interview.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@iobroker/types-dev" />
 /**
  * Custom interview during setup
  *

package/build/cjs/lib/objects/interview.js.map

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../../../../src/lib/objects/interview.ts"],
   "sourcesContent": ["import { defaultRedisInterview } from '@iobroker/js-controller-common-db';\n\n/**\n * Custom interview during setup\n *\n * @param config the prefilled database config\n * @returns the database options obtained by the answered questionnaire\n */\nexport function interview(config: ioBroker.ObjectsDatabaseOptions): Promise<ioBroker.ObjectsDatabaseOptions> {\n    return defaultRedisInterview<ioBroker.ObjectsDatabaseOptions>({ config, type: 'objects' });\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;;;;;qCAAsC;AAQhC,SAAU,UAAU,QAAuC;AAC7D,aAAO,sDAAuD,EAAE,QAAQ,MAAM,UAAS,CAAE;AAC7F;",
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;;;;;AAAA,qCAAsC;AAQhC,SAAU,UAAU,QAAuC;AAC7D,aAAO,sDAAuD,EAAE,QAAQ,MAAM,UAAS,CAAE;AAC7F;",
   "names": []
 }

package/build/cjs/lib/objects/objectsInRedisClient.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@iobroker/types-dev" />
 import type { ACLObject, CheckFileRightsCallback, GetUserGroupPromiseReturn } from '../../lib/objects/objectsUtils.js';
 import type { InternalLogger } from '@iobroker/js-controller-common-db/tools';
 import type { ConnectionOptions, DbStatus } from '@iobroker/db-base/inMemFileDB';

package/build/cjs/lib/objects/objectsInRedisClient.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(objectsInRedisClient_exports, {
   ObjectsInRedisClient: () => ObjectsInRedisClient
 });
 module.exports = __toCommonJS(objectsInRedisClient_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_node = __toESM(require("node.extend"), 1);
 var import_ioredis = __toESM(require("ioredis"), 1);
 var import_db_base = require("@iobroker/db-base");
@@ -39,8 +44,7 @@ var utils = __toESM(require("../../lib/objects/objectsUtils.js"), 1);
 var import_semver = __toESM(require("semver"), 1);
 var CONSTS = __toESM(require("../../lib/objects/constants.js"), 1);
 var url = __toESM(require("node:url"), 1);
-const import_meta = {};
-const thisDir = url.fileURLToPath(new URL(".", import_meta.url || `file://${__filename}`));
+const thisDir = url.fileURLToPath(new URL(".", __import_meta_url || `file://${__filename}`));
 const ERRORS = CONSTS.ERRORS;
 class ObjectsInRedisClient {
   client;
@@ -95,6 +99,9 @@ class ObjectsInRedisClient {
       this.connectDb();
     }
   }
+  /**
+   * Checks if we are allowed to start and sets the protocol version accordingly
+   */
   async _determineProtocolVersion() {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
@@ -158,6 +165,7 @@ class ObjectsInRedisClient {
       const defaultPort = Array.isArray(configuredPort) ? null : configuredPort;
       this.settings.connection.options.sentinels = this.settings.connection.host.map((redisNode, idx) => ({
         host: redisNode,
+        // @ts-expect-error ts does not get that if defPort is null we have an array
         port: defaultPort === null ? configuredPort[idx] : defaultPort
       }));
       this.settings.connection.options.name = this.settings.connection.sentinelName ? this.settings.connection.sentinelName : "mymaster";
@@ -486,6 +494,12 @@ class ObjectsInRedisClient {
   getStatus() {
     return { type: "redis", server: false };
   }
+  /**
+   * Checks if given ID is a meta-object, else throws error
+   *
+   * @param id to check
+   * @throws Error if id is invalid
+   */
   async validateMetaObject(id) {
     if (this.existingMetaObjects[id] === void 0) {
       const obj = await this.getObjectAsync(id);
@@ -502,6 +516,13 @@ class ObjectsInRedisClient {
   normalizeFilename(name) {
     return name ? name.replace(/[/\\]+/g, "/") : name;
   }
+  // -------------- FILE FUNCTIONS -------------------------------------------
+  /**
+   * Sets a buffer to the Redis DB
+   *
+   * @param id id of the file
+   * @param data content, if string is passed it will be converted to a Buffer
+   */
   async _setBinaryState(id, data) {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
@@ -512,12 +533,22 @@ class ObjectsInRedisClient {
     await this.client.set(id, data);
     await this.client.publish(id, data.byteLength.toString(10));
   }
+  /**
+   * get buffer of given id from redis
+   *
+   * @param id - id of the data with namespace prefix
+   */
   _getBinaryState(id) {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
     }
     return this.client.getBuffer(id);
   }
+  /**
+   * deletes binary state of given id from redis db
+   *
+   * @param id - id to delete, with namespace prefix
+   */
   async _delBinaryState(id) {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
@@ -752,6 +783,12 @@ class ObjectsInRedisClient {
       }
     });
   }
+  /**
+   * Check if given object exists
+   *
+   * @param id id of the object
+   * @param options optional user context
+   */
   async objectExists(id, options2) {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
@@ -776,6 +813,13 @@ class ObjectsInRedisClient {
       return Promise.reject(new Error(`Cannot check object existence of "${id}": ${e.message}`));
     }
   }
+  /**
+   * Check if given file exists
+   *
+   * @param id id of the namespace
+   * @param name name of the file
+   * @param options optional user context
+   */
   async fileExists(id, name, options2) {
     if (typeof name !== "string") {
       name = "";
@@ -1295,6 +1339,7 @@ class ObjectsInRedisClient {
   rmAsync(id, name, options2) {
     return new Promise((resolve, reject) => this.rm(id, name, options2, (err, files) => err ? reject(err) : resolve(files)));
   }
+  // simulate. redis has no dirs
   mkdir(id, dirName, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -1485,6 +1530,13 @@ class ObjectsInRedisClient {
   chownFileAsync(id, name, options2) {
     return new Promise((resolve, reject) => this.chownFile(id, name, options2, (err, processed) => err ? reject(err) : resolve(processed)));
   }
+  /**
+   *
+   * @param keys Key names to handle
+   * @param metas Objects for the keys to handle
+   * @param options options
+   * @param callback callback function
+   */
   async _chmodFileHelper(keys2, metas, options2, callback) {
     if (!keys2 || !keys2.length) {
       return import_db_base.tools.maybeCallback(callback);
@@ -1908,6 +1960,7 @@ class ObjectsInRedisClient {
             owner: this.defaultNewAcl && this.defaultNewAcl.owner || CONSTS.SYSTEM_ADMIN_USER,
             ownerGroup: this.defaultNewAcl && this.defaultNewAcl.ownerGroup || CONSTS.SYSTEM_ADMIN_GROUP,
             object: this.defaultNewAcl && this.defaultNewAcl.object || CONSTS.ACCESS_USER_RW | CONSTS.ACCESS_GROUP_READ | CONSTS.ACCESS_EVERY_READ
+            // '0644'
           };
           if (obj.type === "state") {
             obj.acl.state = this.defaultNewAcl && this.defaultNewAcl.state || CONSTS.ACCESS_USER_RW | CONSTS.ACCESS_GROUP_READ | CONSTS.ACCESS_EVERY_READ;
@@ -2005,6 +2058,7 @@ class ObjectsInRedisClient {
             owner: this.defaultNewAcl && this.defaultNewAcl.owner || CONSTS.SYSTEM_ADMIN_USER,
             ownerGroup: this.defaultNewAcl && this.defaultNewAcl.ownerGroup || CONSTS.SYSTEM_ADMIN_GROUP,
             object: this.defaultNewAcl && this.defaultNewAcl.object || CONSTS.ACCESS_USER_RW | CONSTS.ACCESS_GROUP_READ | CONSTS.ACCESS_EVERY_READ
+            // '0644'
           };
           if (obj.type === "state") {
             obj.acl.state = this.defaultNewAcl && this.defaultNewAcl.state || CONSTS.ACCESS_USER_RW | CONSTS.ACCESS_GROUP_READ | CONSTS.ACCESS_EVERY_READ;
@@ -2109,6 +2163,12 @@ class ObjectsInRedisClient {
       });
     }
   }
+  /**
+   *
+   * @param id
+   * @param options
+   * @deprecated use `getObject` without callback instead
+   */
   getObjectAsync(id, options2) {
     return new Promise((resolve, reject) => this.getObject(id, options2, (err, obj) => err ? reject(err) : resolve(obj)));
   }
@@ -2260,7 +2320,10 @@ class ObjectsInRedisClient {
       options2 = null;
     }
     if (!callback) {
-      return new Promise((resolve, reject) => this.getObjects(keys2, options2, (err, objs2) => err ? reject(err) : resolve(objs2), dontModify));
+      return new Promise((resolve, reject) => (
+        // @ts-expect-error need to clarify, that objs is not undefined if no error is provided
+        this.getObjects(keys2, options2, (err, objs2) => err ? reject(err) : resolve(objs2), dontModify)
+      ));
     }
     if (options2?.acl) {
       options2.acl = null;
@@ -2383,7 +2446,11 @@ class ObjectsInRedisClient {
           let objCommon = obj.common;
           if (objCommon && objCommon[commonSetting] === null) {
             delete objCommon[commonSetting];
-          } else if (oldObj.common[commonSetting] !== void 0 && (!objCommon || objCommon[commonSetting] === void 0)) {
+          } else if (
+            // if old setting present and new setting is absent
+            // @ts-expect-error https://github.com/ioBroker/adapter-core/issues/455
+            oldObj.common[commonSetting] !== void 0 && (!objCommon || objCommon[commonSetting] === void 0)
+          ) {
             objCommon = objCommon || {};
             objCommon[commonSetting] = oldObj.common[commonSetting];
           }
@@ -2454,6 +2521,16 @@ class ObjectsInRedisClient {
     await this.client.publish(this.objNamespace + id, message);
     return { id };
   }
+  /**
+   * set anew or update object
+   *
+   * This function writes the object into DB
+   *
+   * @param id ID of the object
+   * @param obj
+   * @param options options for access control are optional
+   * @param callback return function
+   */
   setObject(id, obj, options2, callback) {
     if (typeof options2 === "function") {
       callback = options2;
@@ -2477,8 +2554,18 @@ class ObjectsInRedisClient {
       }
     });
   }
+  /**
+   *
+   * @param id
+   * @param obj
+   * @param options
+   * @deprecated use `setObject` without callback instead
+   */
   setObjectAsync(id, obj, options2) {
-    return new Promise((resolve, reject) => this.setObject(id, obj, options2, (err, res) => err ? reject(err) : resolve(res)));
+    return new Promise((resolve, reject) => (
+      // @ts-expect-error TODO we are returning type Object for ease of use to devs, but formally these are AnyObjects, e.g. not guaranteed to have common
+      this.setObject(id, obj, options2, (err, res) => err ? reject(err) : resolve(res))
+    ));
   }
   async _delObject(id, options2) {
     if (!id || typeof id !== "string" || utils.REG_CHECK_ID.test(id)) {
@@ -2554,6 +2641,9 @@ class ObjectsInRedisClient {
   delObjectAsync(id, options2) {
     return this.delObject(id, options2);
   }
+  /**
+   * Function to checks if comparisons will work according to the configured Locale
+   */
   async isSystemLocaleSupported() {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
@@ -2566,6 +2656,7 @@ class ObjectsInRedisClient {
       return true;
     }
   }
+  // this function is very ineffective. Because reads all objects and then process them
   async _applyViewFunc(func, params, options = {}) {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
@@ -2676,7 +2767,10 @@ class ObjectsInRedisClient {
       }
       result.rows = filterEntries(result.rows, filterRequired);
       return result;
-    } else if (wildCardLastPos && func?.map && this.scripts.script && func.map.includes("doc.common.engineType")) {
+    } else if (
+      // filter by script
+      wildCardLastPos && func?.map && this.scripts.script && func.map.includes("doc.common.engineType")
+    ) {
       let cursor = "0";
       let filterRequired = true;
       do {
@@ -2722,7 +2816,10 @@ class ObjectsInRedisClient {
       } while (cursor !== "0");
       result.rows = filterEntries(result.rows, filterRequired);
       return result;
-    } else if (wildCardLastPos && func?.map && this.scripts.programs && func.map.includes("doc.native.TypeName === 'PROGRAM'")) {
+    } else if (
+      // filter by hm-rega programs
+      wildCardLastPos && func?.map && this.scripts.programs && func.map.includes("doc.native.TypeName === 'PROGRAM'")
+    ) {
       let cursor = "0";
       let filterRequired = true;
       do {
@@ -2766,7 +2863,10 @@ class ObjectsInRedisClient {
       } while (cursor !== "0");
       result.rows = filterEntries(result.rows, filterRequired);
       return result;
-    } else if (wildCardLastPos && func?.map && this.scripts.variables && func.map.includes("doc.native.TypeName === 'ALARMDP'")) {
+    } else if (
+      // filter by hm-rega variables
+      wildCardLastPos && func?.map && this.scripts.variables && func.map.includes("doc.native.TypeName === 'ALARMDP'")
+    ) {
       let cursor = "0";
       let filterRequired = true;
       do {
@@ -2810,7 +2910,10 @@ class ObjectsInRedisClient {
       } while (cursor !== "0");
       result.rows = filterEntries(result.rows, filterRequired);
       return result;
-    } else if (wildCardLastPos && func?.map && this.scripts.custom && func.map.includes("doc.common.custom")) {
+    } else if (
+      // filter by custom, redis also returns if common.custom is not present
+      wildCardLastPos && func?.map && this.scripts.custom && func.map.includes("doc.common.custom")
+    ) {
       let cursor = "0";
       let filterRequired = true;
       do {
@@ -3080,6 +3183,7 @@ class ObjectsInRedisClient {
   getObjectListAsync(params2, options2) {
     return this.getObjectList(params2, options2);
   }
+  // could be optimized, to read object only once. Now it will read 3 times
   async _extendObject(id, obj, options2, callback) {
     if (!id || typeof id !== "string" || utils.REG_CHECK_ID.test(id)) {
       return import_db_base.tools.maybeCallbackWithError(callback, `Invalid ID: ${id}`);
@@ -3212,6 +3316,14 @@ class ObjectsInRedisClient {
   extendObjectAsync(id, obj, options2) {
     return new Promise((resolve, reject) => this.extendObject(id, obj, options2 || null, (err, res) => err ? reject(err) : resolve(res)));
   }
+  /**
+   * Returns the object id if found
+   *
+   * @param idOrName
+   * @param type
+   * @param options
+   * @param callback
+   */
   _findObject(idOrName, type, options2, callback) {
     this._getObject(idOrName, options2, (err, obj) => {
       if (obj && utils.checkObject(obj, options2, CONSTS.ACCESS_READ) && (!type || obj.common && obj.common.type === type)) {
@@ -3273,6 +3385,7 @@ class ObjectsInRedisClient {
       });
     }
   }
+  // can be called only from js-controller
   addPreserveSettings(settings) {
     if (!Array.isArray(settings)) {
       settings = [settings];
@@ -3328,6 +3441,7 @@ class ObjectsInRedisClient {
   destroyDBAsync(options2) {
     return new Promise((resolve, reject) => this.destroyDB(options2, (err) => err ? reject(err) : resolve()));
   }
+  // Destructor of the class. Called by shutting down.
   async destroy() {
     this.stop = true;
     if (this.client) {
@@ -3407,6 +3521,12 @@ class ObjectsInRedisClient {
     this.scripts = {};
     scripts.forEach((e) => this.scripts[e.name] = e.hash);
   }
+  /**
+   * Get all keys matching a pattern using redis SCAN command, duplicates are filtered out
+   *
+   * @param pattern - pattern to match, e. g. io.hm-rpc.0*
+   * @param count - count argument used by redis SCAN, default is 250
+   */
   _getKeysViaScan(pattern, count = 250) {
     return new Promise((resolve, reject) => {
       if (!this.client) {
@@ -3426,6 +3546,11 @@ class ObjectsInRedisClient {
       });
     });
   }
+  /**
+   * Checks if a given set exists
+   *
+   * @param id - id of the set
+   */
   async setExists(id) {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
@@ -3433,6 +3558,11 @@ class ObjectsInRedisClient {
     const exists = await this.client.exists(this.setNamespace + id);
     return !!exists;
   }
+  /**
+   * Migrate all objects to sets
+   *
+   * @returns number of migrated sets
+   */
   async migrateToSets() {
     if (!this.useSets) {
       return 0;
@@ -3461,12 +3591,22 @@ class ObjectsInRedisClient {
     }
     return noMigrated;
   }
+  /**
+   * Returns the protocol version from DB
+   */
   getProtocolVersion() {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
     }
     return this.client.get(`${this.metaNamespace}objects.protocolVersion`);
   }
+  /**
+   * Extend the primary host lock time
+   * Value will expire after ms milliseconds
+   *
+   * @param ms - ms until value expires
+   * @returns 1 if extended else 0
+   */
   extendPrimaryHostLock(ms) {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
@@ -3482,6 +3622,13 @@ class ObjectsInRedisClient {
       ms
     ]);
   }
+  /**
+   * Sets current host as primary if no primary host active
+   * Value will expire after ms milliseconds
+   *
+   * @param ms - ms until value expires
+   * @returns 1 if lock acquired else 0
+   */
   setPrimaryHost(ms) {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
@@ -3497,6 +3644,9 @@ class ObjectsInRedisClient {
       ms
     ]);
   }
+  /**
+   * Get name of the primary host
+   */
   getPrimaryHost() {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
@@ -3506,6 +3656,9 @@ class ObjectsInRedisClient {
     }
     return this.client.get(`${this.metaNamespace}objects.primaryHost`);
   }
+  /**
+   * Ensure we are no longer the primary host
+   */
   releasePrimaryHost() {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
@@ -3522,6 +3675,11 @@ class ObjectsInRedisClient {
       `${this.metaNamespace}objects.primaryHost`
     ]);
   }
+  /**
+   * Sets the protocol version to the DB
+   *
+   * @param version - protocol version
+   */
   async setProtocolVersion(version) {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
@@ -3534,12 +3692,18 @@ class ObjectsInRedisClient {
       throw new Error("Cannot set an unsupported protocol version on the current host");
     }
   }
+  /**
+   * Subscribe to expired events to get expiration of primary host
+   */
   async subscribePrimaryHost() {
     if (this.subSystem) {
       await this.subSystem.subscribe(`__keyevent@${this.settings.connection.options.db}__:expired`);
       await this.subSystem.subscribe(`__keyevent@${this.settings.connection.options.db}__:evicted`);
     }
   }
+  /**
+   * Activates the usage of sets
+   */
   async activateSets() {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
@@ -3547,6 +3711,9 @@ class ObjectsInRedisClient {
     await this.client.set(`${this.metaNamespace}objects.features.useSets`, "1");
     this.useSets = true;
   }
+  /**
+   * Deactivates the usage of sets
+   */
   async deactivateSets() {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);
@@ -3554,6 +3721,11 @@ class ObjectsInRedisClient {
     await this.client.set(`${this.metaNamespace}objects.features.useSets`, "0");
     this.useSets = false;
   }
+  /**
+   * Get value from meta namespace
+   *
+   * @param id redis key
+   */
   getMeta(id) {
     if (!this.client) {
       throw new Error(ERRORS.ERROR_DB_CLOSED);