@iobroker/db-states-file 7.2.3 → 8.0.0-alpha.1-20260921-e5941ca8a

package/build/cjs/index.js

@@ -3,6 +3,7 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 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 });
@@ -16,20 +17,21 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var esm_exports = {};
-__export(esm_exports, {
+var index_exports = {};
+__export(index_exports, {
   Client: () => import_db_states_redis.Client,
   Server: () => import_statesInMemServerClass.StatesInMemoryServerClass,
   StatesInMemoryFileDB: () => import_statesInMemFileDB.StatesInMemoryFileDB,
   getDefaultPort: () => getDefaultPort
 });
-module.exports = __toCommonJS(esm_exports);
+module.exports = __toCommonJS(index_exports);
 var import_statesInMemFileDB = require("./lib/states/statesInMemFileDB.js");
 var import_db_states_redis = require("@iobroker/db-states-redis");
 var import_statesInMemServerClass = require("./lib/states/statesInMemServerClass.js");
 function getDefaultPort() {
   return 9e3;
 }
+__name(getDefaultPort, "getDefaultPort");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Client,

package/build/cjs/index.js.map

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../../src/index.ts"],
   "sourcesContent": ["export { StatesInMemoryFileDB } from './lib/states/statesInMemFileDB.js';\nexport { Client } from '@iobroker/db-states-redis';\nexport { StatesInMemoryServerClass as Server } from './lib/states/statesInMemServerClass.js';\n\n/**\n * Get the default port of the objects db\n */\nexport function getDefaultPort(): number {\n    return 9000;\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;;;;;;;;AAAA,+BAAqC;AACrC,6BAAuB;AACvB,oCAAoD;AAK9C,SAAU,iBAAc;AAC1B,SAAO;AACX;",
+  "mappings": ";;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;AAAA,+BAAqC;AACrC,6BAAuB;AACvB,oCAAoD;AAK9C,SAAU,iBAAc;AAC1B,SAAO;AACX;AAFgB;",
   "names": []
 }

package/build/cjs/lib/states/statesInMemFileDB.d.ts

@@ -1,52 +1,181 @@
+/**
+ *      States DB in memory - Server
+ *
+ *      Copyright 2013-2026 bluefox <dogafox@gmail.com>
+ *
+ *      MIT License
+ *
+ */
+import { InMemoryFileDB, type FileDbSettings } from '@iobroker/db-base';
 /**
  * This class inherits InMemoryFileDB class and adds all relevant logic for states
  * including the available methods for use by js-controller directly
  */
-export class StatesInMemoryFileDB extends InMemoryFileDB {
-    constructor(settings: any);
-    META_ID: string;
-    logs: {};
-    session: {};
-    globalMessageId: number;
-    globalLogId: number;
-    stateExpires: {};
-    sessionExpires: {};
-    ONE_DAY_IN_SECS: number;
-    writeFileInterval: number;
+export declare class StatesInMemoryFileDB<THandler extends {
+    _subscribe?: Record<string, {
+        pattern: string;
+        regex: RegExp;
+    }[]>;
+}> extends InMemoryFileDB<ioBroker.State | ioBroker.Session, THandler> {
+    private readonly META_ID;
+    private session;
+    protected stateExpires: Record<string, NodeJS.Timeout>;
+    protected sessionExpires: Record<string, {
+        sessionEnd: number;
+        timeout: NodeJS.Timeout | null;
+    }>;
+    private readonly ONE_DAY_IN_SECS;
+    private readonly writeFileInterval;
+    /**
+     * @param settings Settings for the states database
+     */
+    constructor(settings: FileDbSettings<ioBroker.State | ioBroker.Session>);
+    /**
+     * Expire all states that have an expiration set and (re)start the save timer
+     */
     _expireAll(): void;
-    _expireState(id: any, dontPublish: any): void;
-    _expireSession(id: any): void;
-    _getStates(keys: any): any[];
-    _getState(id: any): any;
-    _ensureMetaDict(): any;
+    /**
+     * Remove an expired state and optionally publish the deletion
+     *
+     * @param id The ID of the state to expire
+     * @param dontPublish If true, do not publish the deletion to subscribers
+     */
+    _expireState(id: string, dontPublish?: boolean): void;
+    /**
+     * Remove an expired session and clear its timeout
+     *
+     * @param id The ID of the session to expire
+     */
+    _expireSession(id: string): void;
+    /**
+     * Destructor of the class. Called when shutting down to expire states and clear the save timer.
+     */
+    destroy(): Promise<void>;
+    /**
+     * Get the values of the given state IDs (used by the server)
+     *
+     * @param keys The state IDs to read
+     */
+    _getStates(keys: string[]): (ioBroker.State | ioBroker.Session | null)[];
+    /**
+     * Get the value of a single state (used by the server)
+     *
+     * @param id The state ID to read
+     */
+    _getState(id: string): ioBroker.State;
+    /**
+     * Get the meta dictionary, creating it if it does not exist yet
+     */
+    _ensureMetaDict(): Record<string, string>;
     /**
      * Get value of given meta id
      *
-     * @param id
-     * @returns
-     */
-    getMeta(id: any): any;
-    /**
-     * Sets given value to id in metaNamespace
-     *
-     * @param id
-     * @param value
-     */
-    setMeta(id: any, value: any): void;
-    _setStateDirect(id: any, obj: any, expire: any): void;
-    _delState(id: any): void;
-    _getKeys(pattern: any): string[];
-    _subscribeForClient(client: any, pattern: any): void;
-    _subscribeMeta(client: any, pattern: any): void;
-    _unsubscribeForClient(client: any, pattern: any): void;
-    _subscribeMessageForClient(client: any, id: any): void;
-    _unsubscribeMessageForClient(client: any, id: any): void;
-    _subscribeLogForClient(client: any, id: any): void;
-    _unsubscribeLogForClient(client: any, id: any): void;
-    _getSession(id: any): any;
-    _handleSessionExpire(id: any, expireDate: any): void;
-    _setSession(id: any, expire: any, obj: any): void;
-    _destroySession(id: any): void;
+     * @param id The meta ID to read
+     * @returns the stored meta value
+     */
+    getMeta(id: string): string;
+    /**
+     * Sets given value to ID in metaNamespace
+     *
+     * @param id The meta ID to write
+     * @param value The value to store
+     */
+    setMeta(id: string, value: string): void;
+    /**
+     * Directly set a state value and optionally schedule its expiration (used by the server)
+     *
+     * @param id The state ID to set
+     * @param obj The state object to store
+     * @param expire Optional expiration time in seconds
+     */
+    _setStateDirect(id: string, obj: ioBroker.State, expire?: number): void;
+    /**
+     * Delete a state and publish the deletion (used by the server)
+     *
+     * @param id The state ID to delete
+     */
+    _delState(id: string): void;
+    /**
+     * Get all state IDs matching the given pattern (used by the server)
+     *
+     * @param pattern The pattern to match state IDs against
+     */
+    _getKeys(pattern: string): string[];
+    /**
+     * Subscribe a client to state changes (used by the server)
+     *
+     * @param client The client to subscribe
+     * @param pattern The pattern of state IDs to subscribe to
+     */
+    _subscribeForClient(client: THandler, pattern: string): void;
+    /**
+     * Subscribe a client to meta changes
+     *
+     * @param client The client to subscribe
+     * @param pattern The pattern of meta IDs to subscribe to
+     */
+    _subscribeMeta(client: THandler, pattern: string): void;
+    /**
+     * Unsubscribe a client from state changes (used by the server)
+     *
+     * @param client The client to unsubscribe
+     * @param pattern The pattern of state IDs to unsubscribe from
+     */
+    _unsubscribeForClient(client: THandler, pattern: string): void;
+    /**
+     * Subscribe a client to its message box (used by the server)
+     *
+     * @param client The client to subscribe
+     * @param id The ID of the message box owner
+     */
+    _subscribeMessageForClient(client: THandler, id: string): void;
+    /**
+     * Unsubscribe a client from its message box (used by the server)
+     *
+     * @param client The client to unsubscribe
+     * @param id The ID of the message box owner
+     */
+    _unsubscribeMessageForClient(client: THandler, id: string): void;
+    /**
+     * Subscribe a client to log messages (used by the server)
+     *
+     * @param client The client to subscribe
+     * @param id The ID of the log owner
+     */
+    _subscribeLogForClient(client: THandler, id: string): void;
+    /**
+     * Unsubscribe a client from log messages (used by the server)
+     *
+     * @param client The client to unsubscribe
+     * @param id The ID of the log owner
+     */
+    _unsubscribeLogForClient(client: THandler, id: string): void;
+    /**
+     * Get a session by its ID (used by the server)
+     *
+     * @param id The session ID to read
+     */
+    _getSession(id: string): ioBroker.Session;
+    /**
+     * Schedule the expiration of a session, splitting long delays into daily chunks
+     *
+     * @param id The session ID
+     * @param expireDate Timestamp in milliseconds when the session should expire
+     */
+    _handleSessionExpire(id: string, expireDate: number): void;
+    /**
+     * Create or update a session and schedule its expiration (used by the server)
+     *
+     * @param id The session ID
+     * @param expire Expiration time in seconds from now
+     * @param sessionData The session data to store
+     */
+    _setSession(id: string, expire: number, sessionData: ioBroker.Session): void;
+    /**
+     * Destroy a session immediately (used by the server)
+     *
+     * @param id The session ID to destroy
+     */
+    _destroySession(id: string): void;
 }
-import { InMemoryFileDB } from '@iobroker/db-base';
 //# sourceMappingURL=statesInMemFileDB.d.ts.map

package/build/cjs/lib/states/statesInMemFileDB.js

@@ -3,6 +3,7 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 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 });
@@ -22,45 +23,52 @@ __export(statesInMemFileDB_exports, {
 });
 module.exports = __toCommonJS(statesInMemFileDB_exports);
 var import_db_base = require("@iobroker/db-base");
-var import_db_base2 = require("@iobroker/db-base");
 class StatesInMemoryFileDB extends import_db_base.InMemoryFileDB {
+  static {
+    __name(this, "StatesInMemoryFileDB");
+  }
+  META_ID = "**META**";
+  session = {};
+  stateExpires = {};
+  sessionExpires = {};
+  ONE_DAY_IN_SECS = 24 * 60 * 60 * 1e3;
+  writeFileInterval;
+  /**
+   * @param settings Settings for the states database
+   */
   constructor(settings) {
-    settings = settings || {};
-    settings.fileDB = settings.fileDB || {
+    settings.fileDB ??= {
       fileName: "states.json",
       backupDirName: "backup-objects"
     };
     super(settings);
-    this.META_ID = "**META**";
-    this.logs = {};
-    this.session = {};
-    this.globalMessageId = Math.round(Math.random() * 1e8);
-    this.globalLogId = Math.round(Math.random() * 1e8);
-    this.stateExpires = {};
-    this.sessionExpires = {};
-    this.ONE_DAY_IN_SECS = 24 * 60 * 60 * 1e3;
-    this.writeFileInterval = this.settings.connection && typeof this.settings.connection.writeFileInterval === "number" ? parseInt(this.settings.connection.writeFileInterval) : 3e4;
+    this.writeFileInterval = this.settings.connection && typeof this.settings.connection.writeFileInterval === "number" ? this.settings.connection.writeFileInterval : 3e4;
     if (settings.jsonlDB) {
       this.log.silly(`${this.namespace} States DB uses file write interval of ${this.writeFileInterval} ms`);
     }
     this._expireAll();
   }
-  // internal functionality
+  /**
+   * Expire all states that have an expiration set and (re)start the save timer
+   */
   _expireAll() {
     Object.keys(this.stateExpires).forEach((id) => {
       clearTimeout(this.stateExpires[id]);
       this._expireState(id);
     });
     Object.entries(this.dataset).forEach(([id, obj]) => {
-      if (obj && obj.expire) {
+      if (obj?.expire) {
         this._expireState(id, true);
       }
     });
-    if (!this.stateTimer) {
-      this.stateTimer = setTimeout(() => this.saveState(), this.writeFileInterval);
-    }
+    this.stateTimer ||= setTimeout(() => this.saveState(), this.writeFileInterval);
   }
-  // internal functionality
+  /**
+   * Remove an expired state and optionally publish the deletion
+   *
+   * @param id The ID of the state to expire
+   * @param dontPublish If true, do not publish the deletion to subscribers
+   */
   _expireState(id, dontPublish) {
     if (this.stateExpires[id] !== void 0) {
       delete this.stateExpires[id];
@@ -73,9 +81,13 @@ class StatesInMemoryFileDB extends import_db_base.InMemoryFileDB {
       this.stateTimer = setTimeout(() => this.saveState(), this.writeFileInterval);
     }
   }
-  // internal functionality
+  /**
+   * Remove an expired session and clear its timeout
+   *
+   * @param id The ID of the session to expire
+   */
   _expireSession(id) {
-    if (this.sessionExpires[id] && this.sessionExpires[id].timeout) {
+    if (this.sessionExpires[id]?.timeout) {
       clearTimeout(this.sessionExpires[id].timeout);
       delete this.sessionExpires[id];
     }
@@ -83,8 +95,9 @@ class StatesInMemoryFileDB extends import_db_base.InMemoryFileDB {
       delete this.session[id];
     }
   }
-  // Destructor of the class. Called by shutting down.
-  // internal functionality
+  /**
+   * Destructor of the class. Called when shutting down to expire states and clear the save timer.
+   */
   async destroy() {
     this._expireAll();
     await super.destroy();
@@ -93,7 +106,11 @@ class StatesInMemoryFileDB extends import_db_base.InMemoryFileDB {
       this.stateTimer = null;
     }
   }
-  // needed by Server
+  /**
+   * Get the values of the given state IDs (used by the server)
+   *
+   * @param keys The state IDs to read
+   */
   _getStates(keys) {
     if (!keys || !Array.isArray(keys)) {
       throw new Error("no keys");
@@ -103,10 +120,17 @@ class StatesInMemoryFileDB extends import_db_base.InMemoryFileDB {
       return obj !== void 0 ? obj : null;
     });
   }
-  // needed by Server
+  /**
+   * Get the value of a single state (used by the server)
+   *
+   * @param id The state ID to read
+   */
   _getState(id) {
     return this.dataset[id];
   }
+  /**
+   * Get the meta dictionary, creating it if it does not exist yet
+   */
   _ensureMetaDict() {
     let meta = this.dataset[this.META_ID];
     if (!meta) {
@@ -118,18 +142,18 @@ class StatesInMemoryFileDB extends import_db_base.InMemoryFileDB {
   /**
    * Get value of given meta id
    *
-   * @param id
-   * @returns
+   * @param id The meta ID to read
+   * @returns the stored meta value
    */
   getMeta(id) {
     const meta = this._ensureMetaDict();
     return meta[id];
   }
   /**
-   * Sets given value to id in metaNamespace
+   * Sets given value to ID in metaNamespace
    *
-   * @param id
-   * @param value
+   * @param id The meta ID to write
+   * @param value The value to store
    */
   setMeta(id, value) {
     const meta = this._ensureMetaDict();
@@ -139,21 +163,25 @@ class StatesInMemoryFileDB extends import_db_base.InMemoryFileDB {
       this.log.silly(`${this.namespace} memory publish meta ${id} ${value}`);
       this.publishAll("meta", id, value);
     });
-    if (!this.stateTimer) {
-      this.stateTimer = setTimeout(() => this.saveState(), this.writeFileInterval);
-    }
+    this.stateTimer ||= setTimeout(() => this.saveState(), this.writeFileInterval);
   }
-  // needed by Server
+  /**
+   * Directly set a state value and optionally schedule its expiration (used by the server)
+   *
+   * @param id The state ID to set
+   * @param obj The state object to store
+   * @param expire Optional expiration time in seconds
+   */
   _setStateDirect(id, obj, expire) {
     if (this.stateExpires[id]) {
       clearTimeout(this.stateExpires[id]);
       delete this.stateExpires[id];
     }
+    this.dataset[id] = obj;
     if (expire) {
       this.stateExpires[id] = setTimeout(() => this._expireState(id), expire * 1e3);
-      obj.expire = true;
+      this.dataset[id].expire = 1;
     }
-    this.dataset[id] = obj;
     if (obj.val !== void 0) {
       setImmediate(() => {
         this.log.silly(`${this.namespace} memory publish ${id} ${JSON.stringify(obj)}`);
@@ -164,7 +192,11 @@ class StatesInMemoryFileDB extends import_db_base.InMemoryFileDB {
       this.stateTimer = setTimeout(() => this.saveState(), this.writeFileInterval);
     }
   }
-  // needed by Server
+  /**
+   * Delete a state and publish the deletion (used by the server)
+   *
+   * @param id The state ID to delete
+   */
   _delState(id) {
     if (this.stateExpires[id]) {
       clearTimeout(this.stateExpires[id]);
@@ -179,43 +211,92 @@ class StatesInMemoryFileDB extends import_db_base.InMemoryFileDB {
       this.stateTimer = setTimeout(() => this.saveState(), this.writeFileInterval);
     }
   }
-  // needed by Server
+  /**
+   * Get all state IDs matching the given pattern (used by the server)
+   *
+   * @param pattern The pattern to match state IDs against
+   */
   _getKeys(pattern) {
-    const r = new RegExp(import_db_base2.tools.pattern2RegEx(pattern));
+    const r = new RegExp(import_db_base.tools.pattern2RegEx(pattern));
     return Object.keys(this.dataset).filter((id) => r.test(id) && id !== this.META_ID);
   }
-  // needed by Server
+  /**
+   * Subscribe a client to state changes (used by the server)
+   *
+   * @param client The client to subscribe
+   * @param pattern The pattern of state IDs to subscribe to
+   */
   _subscribeForClient(client, pattern) {
     this.handleSubscribe(client, "state", pattern);
   }
+  /**
+   * Subscribe a client to meta changes
+   *
+   * @param client The client to subscribe
+   * @param pattern The pattern of meta IDs to subscribe to
+   */
   _subscribeMeta(client, pattern) {
     this.handleSubscribe(client, "meta", pattern);
   }
-  // needed by Server
+  /**
+   * Unsubscribe a client from state changes (used by the server)
+   *
+   * @param client The client to unsubscribe
+   * @param pattern The pattern of state IDs to unsubscribe from
+   */
   _unsubscribeForClient(client, pattern) {
-    this.handleUnsubscribe(client, "state", pattern);
+    this.handleUnsubscribe(client, "state", pattern).catch((e) => this.log.error(`${this.namespace} Cannot unsubscribe client from states: ${e.message}`));
   }
-  // needed by Server
+  /**
+   * Subscribe a client to its message box (used by the server)
+   *
+   * @param client The client to subscribe
+   * @param id The ID of the message box owner
+   */
   _subscribeMessageForClient(client, id) {
     this.handleSubscribe(client, "messagebox", `messagebox.${id}`);
   }
-  // needed by Server
+  /**
+   * Unsubscribe a client from its message box (used by the server)
+   *
+   * @param client The client to unsubscribe
+   * @param id The ID of the message box owner
+   */
   _unsubscribeMessageForClient(client, id) {
-    this.handleUnsubscribe(client, "messagebox", `messagebox.${id}`);
+    this.handleUnsubscribe(client, "messagebox", `messagebox.${id}`).catch((e) => this.log.error(`${this.namespace} Cannot unsubscribe client from messagebox: ${e.message}`));
   }
-  // needed by Server
+  /**
+   * Subscribe a client to log messages (used by the server)
+   *
+   * @param client The client to subscribe
+   * @param id The ID of the log owner
+   */
   _subscribeLogForClient(client, id) {
     this.handleSubscribe(client, "log", `log.${id}`);
   }
-  // needed by Server
+  /**
+   * Unsubscribe a client from log messages (used by the server)
+   *
+   * @param client The client to unsubscribe
+   * @param id The ID of the log owner
+   */
   _unsubscribeLogForClient(client, id) {
-    this.handleUnsubscribe(client, "log", `log.${id}`);
+    this.handleUnsubscribe(client, "log", `log.${id}`).catch((e) => this.log.error(`${this.namespace} Cannot unsubscribe client from log: ${e.message}`));
   }
-  // needed by Server
+  /**
+   * Get a session by its ID (used by the server)
+   *
+   * @param id The session ID to read
+   */
   _getSession(id) {
     return this.session[id];
   }
-  // internal functionality
+  /**
+   * Schedule the expiration of a session, splitting long delays into daily chunks
+   *
+   * @param id The session ID
+   * @param expireDate Timestamp in milliseconds when the session should expire
+   */
   _handleSessionExpire(id, expireDate) {
     if (this.sessionExpires[id] && this.sessionExpires[id].timeout) {
       clearTimeout(this.sessionExpires[id].timeout);
@@ -242,9 +323,15 @@ class StatesInMemoryFileDB extends import_db_base.InMemoryFileDB {
       };
     }
   }
-  // needed by Server
-  _setSession(id, expire, obj) {
-    this.session[id] = obj || {};
+  /**
+   * Create or update a session and schedule its expiration (used by the server)
+   *
+   * @param id The session ID
+   * @param expire Expiration time in seconds from now
+   * @param sessionData The session data to store
+   */
+  _setSession(id, expire, sessionData) {
+    this.session[id] = sessionData || {};
     if (this.sessionExpires[id] && this.sessionExpires[id].timeout) {
       clearTimeout(this.sessionExpires[id].timeout);
       delete this.sessionExpires[id];
@@ -252,7 +339,11 @@ class StatesInMemoryFileDB extends import_db_base.InMemoryFileDB {
     this._handleSessionExpire(id, Date.now() + expire * 1e3);
     this.session[id]._expire = true;
   }
-  // needed by Server
+  /**
+   * Destroy a session immediately (used by the server)
+   *
+   * @param id The session ID to destroy
+   */
   _destroySession(id) {
     if (this.session[id]) {
       delete this.session[id];