@iobroker/db-objects-jsonl 7.2.3 → 8.0.0-alpha.1-20260921-e5941ca8a

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

@@ -1,27 +1,45 @@
+/**
+ *      Objects DB in memory - Server with Redis protocol
+ *
+ *      Copyright 2013-2026 bluefox <dogafox@gmail.com>
+ *
+ *      MIT License
+ *
+ */
+import net from 'node:net';
+import { RedisHandler, type ConnectionOptions, type FileDbSettings } from '@iobroker/db-base';
+import { ObjectsInMemoryJsonlDB } from './objectsInMemJsonlDB.js';
+type RedisHandlerInternal = RedisHandler & {
+    _subscribe?: Record<string, {
+        pattern: string;
+        regex: RegExp;
+    }[]>;
+};
 /**
  * This class inherits statesInMemoryJsonlDB class and adds redis communication layer
  * to access the methods via redis protocol
  */
-export class ObjectsInMemoryServer extends ObjectsInMemoryJsonlDB {
+export declare class ObjectsInMemoryServer extends ObjectsInMemoryJsonlDB<RedisHandlerInternal> {
+    private readonly serverConnections;
+    private readonly namespaceObjects;
+    private readonly namespaceFile;
+    private readonly namespaceObj;
+    private readonly namespaceSet;
+    private readonly namespaceSetLen;
+    private readonly namespaceFileLen;
+    private readonly namespaceObjLen;
+    private readonly namespaceMeta;
+    private readonly namespaceMetaLen;
+    private readonly knownScripts;
+    private readonly normalizeFileRegex1;
+    private readonly normalizeFileRegex2;
+    private server;
     /**
      * Constructor
      *
      * @param settings State and InMem-DB settings
      */
-    constructor(settings: any);
-    serverConnections: {};
-    namespaceObjects: string;
-    namespaceFile: string;
-    namespaceObj: string;
-    namespaceSet: string;
-    namespaceSetLen: number;
-    namespaceFileLen: number;
-    namespaceObjLen: number;
-    namespaceMeta: string;
-    namespaceMetaLen: number;
-    knownScripts: {};
-    normalizeFileRegex1: RegExp;
-    normalizeFileRegex2: RegExp;
+    constructor(settings: FileDbSettings<ioBroker.AnyObject | ioBroker.DesignObject>);
     /**
      * Separate Namespace from ID and return both
      *
@@ -29,8 +47,8 @@ export class ObjectsInMemoryServer extends ObjectsInMemoryJsonlDB {
      * @returns Object with namespace and the
      *                                                      ID/Array of IDs without the namespace
      */
-    _normalizeId(idWithNamespace: any): {
-        id: string | any[] | null;
+    _normalizeId(idWithNamespace: string): {
+        id: string | null;
         namespace: string;
         name: string;
         isMeta: boolean | undefined;
@@ -44,7 +62,7 @@ export class ObjectsInMemoryServer extends ObjectsInMemoryJsonlDB {
      * @param obj Object to publish
      * @returns Publish counter 0 or 1 depending on if send out or not
      */
-    publishToClients(client: any, type: any, id: any, obj: any): 1 | 0;
+    publishToClients(client: RedisHandlerInternal, type: string, id: string, obj: ioBroker.AnyObject | ioBroker.DesignObject): number;
     /**
      * Generate ID for a File
      *
@@ -53,43 +71,45 @@ export class ObjectsInMemoryServer extends ObjectsInMemoryJsonlDB {
      * @param isMeta generate a META ID or a Data ID?
      * @returns File-ID
      */
-    getFileId(id: any, name: any, isMeta: any): string;
+    getFileId(id: string, name: string, isMeta?: boolean): string;
     /**
      * Register all event listeners for Handler and implement the relevant logic
      *
      * @param handler RedisHandler instance
      */
-    _socketEvents(handler: any): void;
+    _socketEvents(handler: RedisHandler): void;
     /**
      * Return connected RedisHandlers/Connections
      *
-     * @returns
+     * @returns the currently connected RedisHandlers/Connections
      */
-    getClients(): {};
+    getClients(): Record<string, RedisHandler>;
+    /**
+     * Destructor of the class. Called by shutting down.
+     */
+    destroy(): Promise<void>;
     /**
      * Get keys matching pattern and send it to given responseId, for "SCAN" and "KEYS" - Objects and files supported
      *
      * @param handler RedisHandler instance
      * @param pattern - pattern without namespace prefix
-     * @param responseId - Id where response will be sent to
+     * @param responseId - ID where response will be sent to
      * @param isScan - if used by "SCAN" this flag should be true
      */
-    _handleScanOrKeys(handler: any, pattern: any, responseId: any, isScan?: boolean): any;
+    _handleScanOrKeys(handler: RedisHandler, pattern: string, responseId: number, isScan?: boolean): void;
     /**
      * Initialize RedisHandler for a new network connection
      *
      * @param socket Network socket
      */
-    _initSocket(socket: any): void;
+    _initSocket(socket: net.Socket): void;
     /**
      * Initialize Redis Server
      *
      * @param settings Settings object
-     * @returns
+     * @returns a promise that resolves once the Redis server is listening
      */
-    _initRedisServer(settings: any): Promise<any>;
-    server: net.Server | undefined;
+    _initRedisServer(settings: ConnectionOptions): Promise<void>;
 }
-import { ObjectsInMemoryJsonlDB } from './objectsInMemJsonlDB.js';
-import net from 'node:net';
+export {};
 //# sourceMappingURL=objectsInMemServerRedis.d.ts.map

package/build/cjs/lib/objects/objectsInMemServerRedis.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 });
@@ -36,12 +37,28 @@ var import_fs_extra = __toESM(require("fs-extra"), 1);
 var import_node_path = __toESM(require("node:path"), 1);
 var import_node_crypto = __toESM(require("node:crypto"), 1);
 var import_db_objects_redis = require("@iobroker/db-objects-redis");
-var import_db_base = require("@iobroker/db-base");
 var import_tools = require("@iobroker/js-controller-common-db/tools");
-var import_db_base2 = require("@iobroker/db-base");
-var import_objectsInMemJsonlDB = require("./objectsInMemJsonlDB.js");
+var import_db_base = require("@iobroker/db-base");
 var import_js_controller_common_db = require("@iobroker/js-controller-common-db");
+var import_objectsInMemJsonlDB = require("./objectsInMemJsonlDB.js");
 class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJsonlDB {
+  static {
+    __name(this, "ObjectsInMemoryServer");
+  }
+  serverConnections = {};
+  namespaceObjects;
+  namespaceFile;
+  namespaceObj;
+  namespaceSet;
+  namespaceSetLen;
+  namespaceFileLen;
+  namespaceObjLen;
+  namespaceMeta;
+  namespaceMetaLen;
+  knownScripts = {};
+  normalizeFileRegex1;
+  normalizeFileRegex2;
+  server;
   /**
    * Constructor
    *
@@ -49,7 +66,6 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
    */
   constructor(settings) {
     super(settings);
-    this.serverConnections = {};
     this.namespaceObjects = `${this.settings.redisNamespace || settings.connection && settings.connection.redisNamespace || "cfg"}.`;
     this.namespaceFile = `${this.namespaceObjects}f.`;
     this.namespaceObj = `${this.namespaceObjects}o.`;
@@ -59,7 +75,6 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
     this.namespaceObjLen = this.namespaceObj.length;
     this.namespaceMeta = `${this.settings.namespaceMeta || "meta"}.`;
     this.namespaceMetaLen = this.namespaceMeta.length;
-    this.knownScripts = {};
     this.normalizeFileRegex1 = new RegExp("^(.*)\\$%\\$(.*)\\$%\\$(meta|data)$");
     this.normalizeFileRegex2 = new RegExp("^(.*)\\$%\\$(.*)\\/?\\*$");
     this.open().then(() => {
@@ -86,15 +101,7 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
     let id = null;
     let name = "";
     let isMeta;
-    if (Array.isArray(idWithNamespace)) {
-      const ids = [];
-      idWithNamespace.forEach((el) => {
-        const { id: id2, namespace } = this._normalizeId(el);
-        ids.push(id2);
-        ns = namespace;
-      });
-      id = ids;
-    } else if (typeof idWithNamespace === "string") {
+    if (typeof idWithNamespace === "string") {
       id = idWithNamespace;
       if (idWithNamespace.startsWith(this.namespaceObjects)) {
         let idx = -1;
@@ -147,14 +154,14 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
    * @returns Publish counter 0 or 1 depending on if send out or not
    */
   publishToClients(client, type, id, obj) {
-    if (!client._subscribe || !client._subscribe[type]) {
+    if (!client._subscribe?.[type]) {
       return 0;
     }
     const s = client._subscribe[type];
     const found = s.find((sub) => sub.regex.test(id));
     if (found) {
       if (type === "meta") {
-        this.log.silly(`${this.namespace} Redis Publish Meta ${id}=${obj}`);
+        this.log.silly(`${this.namespace} Redis Publish Meta ${id}=${JSON.stringify(obj)}`);
         const sendPattern = this.namespaceMeta + found.pattern;
         const sendId = this.namespaceMeta + id;
         client.sendArray(null, ["pmessage", sendPattern, sendId, obj]);
@@ -234,11 +241,11 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
         const scriptChecksum = shasum.digest("hex");
         const scriptDesign = data[1].match(/^-- design: ([a-z0-9A-Z-.]+)\s/m);
         const scriptFunc = data[1].match(/^-- func: (.+)$/m);
-        if (scriptDesign && scriptDesign[1]) {
+        if (scriptDesign?.[1]) {
           const design = scriptDesign[1];
           let search = null;
           const scriptSearch = data[1].match(/^-- search: ([a-z0-9A-Z-.]*)\s/m);
-          if (scriptSearch && scriptSearch[1]) {
+          if (scriptSearch?.[1]) {
             search = scriptSearch[1];
           }
           this.knownScripts[scriptChecksum] = { design, search };
@@ -246,7 +253,7 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
             this.log.silly(`${namespaceLog} Register View LUA Script: ${scriptChecksum} = ${JSON.stringify(this.knownScripts[scriptChecksum])}`);
           }
           handler.sendBulk(responseId, scriptChecksum);
-        } else if (scriptFunc && scriptFunc[1]) {
+        } else if (scriptFunc?.[1]) {
           this.knownScripts[scriptChecksum] = { func: scriptFunc[1] };
           if (this.settings.connection.enhancedLogging) {
             this.log.silly(`${namespaceLog} Register Func LUA Script: ${scriptChecksum} = ${JSON.stringify(this.knownScripts[scriptChecksum])}`);
@@ -315,14 +322,14 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
     });
     handler.on("publish", (data, responseId) => {
       const { id, namespace } = this._normalizeId(data[0]);
-      if (namespace === this.namespaceObj || namespace === this.namespaceMeta || namespace === this.namespaceFile) {
+      if (namespace === this.namespaceObj || namespace === this.namespaceMeta || namespace === this.namespaceFile || !id) {
         return void handler.sendInteger(responseId, 0);
       }
       const publishCount = this.publishAll(namespace.substr(0, namespace.length - 1), id, JSON.parse(data[1]));
       handler.sendInteger(responseId, publishCount);
     });
     handler.on("mget", (data, responseId) => {
-      if (!data || !data.length) {
+      if (!data?.length) {
         return void handler.sendArray(responseId, []);
       }
       const { namespace, isMeta } = this._normalizeId(data[0]);
@@ -343,20 +350,20 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
         } catch (err) {
           return void handler.sendError(responseId, new Error(`ERROR _getObjects: ${err.message}`));
         }
-        result = result.map((el) => el ? JSON.stringify(el) : null);
-        handler.sendArray(responseId, result);
+        const resultStr = result.map((el) => el ? JSON.stringify(el) : null);
+        handler.sendArray(responseId, resultStr);
       } else if (namespace === this.namespaceFile) {
         if (isMeta) {
           const response = [];
           data.forEach((dataId) => {
             const { id, namespace: namespace2, name } = this._normalizeId(dataId);
-            if (namespace2 !== this.namespaceFile) {
+            if (namespace2 !== this.namespaceFile || !id) {
               response.push(null);
               this.log.warn(`${namespaceLog} Got MGET request for non File ID in File-ID chunk for ${dataId}`);
               return;
             }
             this._loadFileSettings(id);
-            if (!this.fileOptions[id] || !this.fileOptions[id][name]) {
+            if (!this.fileOptions[id]?.[name]) {
               response.push(null);
               return;
             }
@@ -382,6 +389,10 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
     });
     handler.on("get", (data, responseId) => {
       const { id, namespace, name, isMeta } = this._normalizeId(data[0]);
+      if (!id) {
+        handler.sendNull(responseId);
+        return;
+      }
       if (namespace === this.namespaceObj) {
         const result = this._getObject(id);
         if (!result) {
@@ -405,7 +416,7 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
             }));
           }
           this._loadFileSettings(id);
-          if (!this.fileOptions[id] || !this.fileOptions[id][name]) {
+          if (!this.fileOptions[id]?.[name]) {
             return void handler.sendNull(responseId);
           }
           let obj = this._clone(this.fileOptions[id][name]);
@@ -413,9 +424,9 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
             obj = {
               mimeType: obj,
               acl: {
-                owner: this.defaultNewAcl && this.defaultNewAcl.owner || import_db_objects_redis.objectsUtils.CONSTS.SYSTEM_ADMIN_USER,
-                ownerGroup: this.defaultNewAcl && this.defaultNewAcl.ownerGroup || import_db_objects_redis.objectsUtils.CONSTS.SYSTEM_ADMIN_GROUP,
-                permissions: this.defaultNewAcl && this.defaultNewAcl.file.permissions || import_db_objects_redis.objectsUtils.CONSTS.ACCESS_USER_ALL | import_db_objects_redis.objectsUtils.CONSTS.ACCESS_GROUP_ALL | import_db_objects_redis.objectsUtils.CONSTS.ACCESS_EVERY_ALL
+                owner: this.defaultNewAcl?.owner || import_db_objects_redis.objectsUtils.CONSTS.SYSTEM_ADMIN_USER,
+                ownerGroup: this.defaultNewAcl?.ownerGroup || import_db_objects_redis.objectsUtils.CONSTS.SYSTEM_ADMIN_GROUP,
+                permissions: this.defaultNewAcl?.file || import_db_objects_redis.objectsUtils.CONSTS.ACCESS_USER_ALL | import_db_objects_redis.objectsUtils.CONSTS.ACCESS_GROUP_ALL | import_db_objects_redis.objectsUtils.CONSTS.ACCESS_EVERY_ALL
                 // 777
               }
             };
@@ -441,7 +452,7 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
         }
       } else if (namespace === this.namespaceMeta) {
         if (id === "objects.primaryHost") {
-          handler.sendString(this.settings.hostname);
+          handler.sendString(responseId, this.settings.hostname);
         } else {
           const result = this.getMeta(id);
           if (result === void 0 || result === null) {
@@ -456,6 +467,10 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
     });
     handler.on("set", (data, responseId) => {
       const { id, namespace, name, isMeta } = this._normalizeId(data[0]);
+      if (!id) {
+        handler.sendNull(responseId);
+        return;
+      }
       if (namespace === this.namespaceObj) {
         try {
           const obj = JSON.parse(data[1].toString("utf-8"));
@@ -499,6 +514,9 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
         if (oldDetails.id !== newDetails.id) {
           return void handler.sendError(responseId, new Error("ERROR renameObject: id needs to stay the same"));
         }
+        if (oldDetails.id === null) {
+          return void handler.sendError(responseId, new Error(`ERROR renameObject: invalid ID ${data[0]}`));
+        }
         if (oldDetails.isMeta) {
           handler.sendString(responseId, "OK");
         } else {
@@ -515,6 +533,9 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
     });
     handler.on("del", (data, responseId) => {
       const { id, namespace, name, isMeta } = this._normalizeId(data[0]);
+      if (!id) {
+        return void handler.sendError(responseId, new Error(`ID is null: ${data[0]}`));
+      }
       if (namespace === this.namespaceObj) {
         try {
           this._delObject(id);
@@ -542,6 +563,9 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
         return void handler.sendInteger(responseId, 0);
       }
       const { id, namespace, name } = this._normalizeId(data[0]);
+      if (!id) {
+        return void handler.sendError(responseId, new Error(`ID is null: ${data[0]}`));
+      }
       if (namespace === this.namespaceObj) {
         let exists;
         try {
@@ -593,6 +617,9 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
     });
     handler.on("psubscribe", (data, responseId) => {
       const { id, namespace, name } = this._normalizeId(data[0]);
+      if (!id) {
+        return void handler.sendError(responseId, new Error(`ID is null: ${data[0]}`));
+      }
       if (namespace === this.namespaceObj) {
         this._subscribeConfigForClient(handler, id);
         handler.sendArray(responseId, ["psubscribe", data[0], 1]);
@@ -608,6 +635,9 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
     });
     handler.on("punsubscribe", (data, responseId) => {
       const { id, namespace, name } = this._normalizeId(data[0]);
+      if (!id) {
+        return void handler.sendError(responseId, new Error(`ID is null: ${data[0]}`));
+      }
       if (namespace === this.namespaceObj) {
         this._unsubscribeConfigForClient(handler, id);
         handler.sendArray(responseId, ["punsubscribe", data[0], 1]);
@@ -650,6 +680,8 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
         } else {
           handler.sendNull(responseId);
         }
+      } else if (typeof data[0] === "string" && data[0].toLowerCase() === "setinfo") {
+        handler.sendString(responseId, "OK");
       } else {
         handler.sendError(responseId, new Error(`CLIENT-UNSUPPORTED for ${JSON.stringify(data)}`));
       }
@@ -659,7 +691,7 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
   /**
    * Return connected RedisHandlers/Connections
    *
-   * @returns
+   * @returns the currently connected RedisHandlers/Connections
    */
   getClients() {
     return this.serverConnections;
@@ -692,11 +724,14 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
    *
    * @param handler RedisHandler instance
    * @param pattern - pattern without namespace prefix
-   * @param responseId - Id where response will be sent to
+   * @param responseId - ID where response will be sent to
    * @param isScan - if used by "SCAN" this flag should be true
    */
   _handleScanOrKeys(handler, pattern, responseId, isScan = false) {
     const { id, namespace, name, isMeta } = this._normalizeId(pattern);
+    if (id === null) {
+      return void handler.sendError(responseId, new Error(`ID is null in ${pattern}`));
+    }
     let response = [];
     if (namespace === this.namespaceObj || namespace === this.namespaceObjects) {
       try {
@@ -771,7 +806,7 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
       handleAsBuffers: true,
       enhancedLogging: this.settings.connection.enhancedLogging
     };
-    const handler = new import_db_base2.RedisHandler(socket, options);
+    const handler = new import_db_base.RedisHandler(socket, options);
     this._socketEvents(handler);
     this.serverConnections[`${socket.remoteAddress}:${socket.remotePort}`] = handler;
     socket.on("close", () => {
@@ -784,7 +819,7 @@ class ObjectsInMemoryServer extends import_objectsInMemJsonlDB.ObjectsInMemoryJs
    * Initialize Redis Server
    *
    * @param settings Settings object
-   * @returns
+   * @returns a promise that resolves once the Redis server is listening
    */
   _initRedisServer(settings) {
     return new Promise((resolve, reject) => {