@iobroker/db-base 4.0.20 → 4.1.0-alpha.0-20220804-d8f17893

package/build/index.d.ts

@@ -0,0 +1,4 @@
+export { InMemoryFileDB } from './lib/inMemFileDB';
+export { RedisHandler } from './lib/redisHandler';
+export { tools } from '@iobroker/js-controller-common';
+//# sourceMappingURL=index.d.ts.map

package/build/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tools = exports.RedisHandler = exports.InMemoryFileDB = void 0;
+var inMemFileDB_1 = require("./lib/inMemFileDB");
+Object.defineProperty(exports, "InMemoryFileDB", { enumerable: true, get: function () { return inMemFileDB_1.InMemoryFileDB; } });
+var redisHandler_1 = require("./lib/redisHandler");
+Object.defineProperty(exports, "RedisHandler", { enumerable: true, get: function () { return redisHandler_1.RedisHandler; } });
+var js_controller_common_1 = require("@iobroker/js-controller-common");
+Object.defineProperty(exports, "tools", { enumerable: true, get: function () { return js_controller_common_1.tools; } });
+//# sourceMappingURL=index.js.map

package/build/lib/constants.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+export declare const QUEUED_STR_BUF: Buffer;
+export declare const OK_STR_BUF: Buffer;
+//# sourceMappingURL=constants.d.ts.map

package/build/lib/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/lib/constants.ts"],"names":[],"mappings":";AAGA,eAAO,MAAM,cAAc,EAAE,MAAoC,CAAC;AAClE,eAAO,MAAM,UAAU,EAAE,MAAgC,CAAC"}

package/build/lib/constants.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OK_STR_BUF = exports.QUEUED_STR_BUF = void 0;
+// @ts-expect-error types missing
+const respjs_1 = __importDefault(require("respjs"));
+exports.QUEUED_STR_BUF = respjs_1.default.encodeString('QUEUED');
+exports.OK_STR_BUF = respjs_1.default.encodeString('OK');
+//# sourceMappingURL=constants.js.map

package/build/lib/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/lib/constants.ts"],"names":[],"mappings":";;;;;;AAAA,iCAAiC;AACjC,oDAA0B;AAEb,QAAA,cAAc,GAAW,gBAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;AACrD,QAAA,UAAU,GAAW,gBAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC"}

package/build/lib/inMemFileDB.d.ts

@@ -0,0 +1,130 @@
+/**
+ *      States DB in memory - Server
+ *
+ *      Copyright 2013-2022 bluefox <dogafox@gmail.com>
+ *
+ *      MIT License
+ *
+ */
+import type { InternalLogger } from '@iobroker/js-controller-common/tools';
+export interface ConnectionOptions {
+    pass?: string;
+    sentinelName?: string;
+    /** array on sentinel */
+    host: string | string[];
+    /** array on sentinel */
+    port: number | number[];
+    options: Record<string, any>;
+    maxQueue?: number;
+    enhancedLogging?: boolean;
+    backup?: BackupOptions;
+    /** relative path to the data dir */
+    dataDir: string;
+}
+declare type ChangeFunction = (id: string, state: any) => void;
+export interface DbStatus {
+    type: string;
+    server: boolean;
+}
+interface BackupOptions {
+    /** deactivates backup if true */
+    disabled: boolean;
+    /** minimum number of files */
+    files: number;
+    hours: number;
+    /** minutes */
+    period: number;
+    path: string;
+}
+export interface DbOptions {
+    backupDirName: string;
+    fileName: string;
+}
+interface FileDbSettings {
+    fileDB: DbOptions;
+    jsonlDB: DbOptions;
+    backup: BackupOptions;
+    change?: ChangeFunction;
+    connected: (nameOfServer: string) => void;
+    logger: InternalLogger;
+    connection: ConnectionOptions;
+    /** unused */
+    auth?: null;
+    secure: boolean;
+    /** as required by createServer TODO: if createServer is typed, add type */
+    certificates: any;
+    port: number;
+    host: string;
+    /** logging namespace */
+    namespace?: string;
+}
+interface Subscription {
+    pattern: string;
+    regex: RegExp;
+    options: any;
+}
+interface SubscriptionClient {
+    _subscribe?: Record<string, Subscription[]>;
+}
+/**
+ * The parent of the class structure, which provides basic JSON storage
+ * and general subscription and publish functionality
+ **/
+export declare class InMemoryFileDB {
+    private settings;
+    private readonly change;
+    private dataset;
+    private readonly namespace;
+    private lastSave;
+    private stateTimer;
+    private callbackSubscriptionClient;
+    private readonly dataDir;
+    private readonly datasetName;
+    private log;
+    private readonly backupDir;
+    constructor(settings: FileDbSettings);
+    open(): Promise<void>;
+    /**
+     * Loads a dataset file
+     *
+     * @param datasetName Filename of the file to load
+     * @returns obj read data, normally as object
+     */
+    loadDatasetFile(datasetName: string): Promise<Record<string, any>>;
+    /**
+     * Loads the dataset including pot. Fallback handling
+     *
+     * @param datasetName Filename of the file to load
+     * @returns obj dataset read as object
+     */
+    loadDataset(datasetName: string): Promise<Record<string, any>>;
+    initBackupDir(): void;
+    handleSubscribe(client: SubscriptionClient, type: string, pattern: string | string[], cb?: () => void): void;
+    handleSubscribe(client: SubscriptionClient, type: string, pattern: string | string[], options: any, cb?: () => void): void;
+    handleUnsubscribe(client: SubscriptionClient, type: string, pattern: string | string[], cb?: () => void): void | Promise<void>;
+    publishToClients(_client: SubscriptionClient, _type: string, _id: string, _obj: any): number;
+    deleteOldBackupFiles(baseFilename: string): void;
+    getTimeStr(date: number): string;
+    /**
+     * Handle saving the dataset incl. backups
+     */
+    saveState(): Promise<void>;
+    /**
+     * Saves the dataset into File incl. handling of a fallback backup file
+     *
+     * @returns dataset JSON string of the complete dataset to also be stored into a compressed backup file
+     */
+    saveDataset(): Promise<string>;
+    /**
+     * Stores a compressed backup of the DB in definable intervals
+     *
+     * @param jsonString JSON string of the complete dataset to also be stored into a compressed backup file
+     */
+    saveBackup(jsonString: string): void;
+    getStatus(): DbStatus;
+    getClients(): Record<string, any>;
+    publishAll(type: string, id: string, obj: any): number;
+    destroy(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=inMemFileDB.d.ts.map

package/build/lib/inMemFileDB.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inMemFileDB.d.ts","sourceRoot":"","sources":["../../src/lib/inMemFileDB.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAKH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAwB3E,MAAM,WAAW,iBAAiB;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACxB,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,oCAAoC;IACpC,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,aAAK,cAAc,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;AAEvD,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;CACnB;AAED,UAAU,aAAa;IACnB,iCAAiC;IACjC,QAAQ,EAAE,OAAO,CAAC;IAClB,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,cAAc;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,SAAS;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,UAAU,cAAc;IACpB,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,SAAS,CAAC;IACnB,MAAM,EAAE,aAAa,CAAC;IACtB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,SAAS,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1C,MAAM,EAAE,cAAc,CAAC;IACvB,UAAU,EAAE,iBAAiB,CAAC;IAC9B,aAAa;IACb,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,MAAM,EAAE,OAAO,CAAC;IAChB,2EAA2E;IAC3E,YAAY,EAAE,GAAG,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,UAAU,YAAY;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,GAAG,CAAC;CAChB;AAED,UAAU,kBAAkB;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;CAC/C;AAED;;;IAGI;AACJ,qBAAa,cAAc;IACvB,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA6B;IACpD,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,UAAU,CAAwB;IAC1C,OAAO,CAAC,0BAA0B,CAAqB;IACvD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,GAAG,CAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;gBAEvB,QAAQ,EAAE,cAAc;IA2C9B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAK3B;;;;;OAKG;IACG,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAOxE;;;;;OAKG;IACG,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IA0DpE,aAAa,IAAI,IAAI;IAiCrB,eAAe,CAAC,MAAM,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,MAAM,IAAI,GAAG,IAAI;IAC5G,eAAe,CACX,MAAM,EAAE,kBAAkB,EAC1B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAC1B,OAAO,EAAE,GAAG,EACZ,EAAE,CAAC,EAAE,MAAM,IAAI,GAChB,IAAI;IAmCP,iBAAiB,CACb,MAAM,EAAE,kBAAkB,EAC1B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,EAC1B,EAAE,CAAC,EAAE,MAAM,IAAI,GAChB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBvB,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,MAAM;IAI5F,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IA2BhD,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IA+BhC;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAehC;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;IAqDpC;;;;OAIG;IACH,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAoCpC,SAAS,IAAI,QAAQ;IAIrB,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAIjC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,MAAM;IAkChD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAMjC"}