@iobroker/js-controller-common-db 4.0.0-alpha.8-20210909-001a711c → 4.0.3

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2021 bluefox<dogafox@gmail.com>,
+Copyright (c) 2014-2022 bluefox<dogafox@gmail.com>,
 Copyright (c) 2014      hobbyquaker
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

package/README.md

@@ -3,4 +3,4 @@ The Library contains the common utils of ioBroker which use the DB directly and
 
 ## License
 MIT
-Copyright 2018-2021 bluefox <dogafox@gmail.com>  
+Copyright 2018-2022 bluefox <dogafox@gmail.com>  

package/build/index.d.ts

@@ -0,0 +1,4 @@
+export * as tools from './lib/common/tools';
+export { getStatesConstructor } from './lib/common/states';
+export { getObjectsConstructor } from './lib/common/objects';
+//# sourceMappingURL=index.d.ts.map

package/build/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getObjectsConstructor = exports.getStatesConstructor = exports.tools = void 0;
+exports.tools = __importStar(require("./lib/common/tools"));
+var states_1 = require("./lib/common/states");
+Object.defineProperty(exports, "getStatesConstructor", { enumerable: true, get: function () { return states_1.getStatesConstructor; } });
+var objects_1 = require("./lib/common/objects");
+Object.defineProperty(exports, "getObjectsConstructor", { enumerable: true, get: function () { return objects_1.getObjectsConstructor; } });
+//# sourceMappingURL=index.js.map

package/build/lib/common/objects.d.ts

@@ -0,0 +1,2 @@
+export declare function getObjectsConstructor(): any;
+//# sourceMappingURL=objects.d.ts.map

package/build/lib/common/objects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.d.ts","sourceRoot":"","sources":["../../../src/lib/common/objects.ts"],"names":[],"mappings":"AAMA,wBAAgB,qBAAqB,IAAI,GAAG,CAa3C"}

package/build/lib/common/objects.js

@@ -0,0 +1,41 @@
+'use strict';
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getObjectsConstructor = void 0;
+const fs = __importStar(require("fs-extra"));
+// @ts-expect-error no typings yet
+const js_controller_common_1 = require("@iobroker/js-controller-common");
+function getObjectsConstructor() {
+    const config = fs.readJSONSync(js_controller_common_1.tools.getConfigFileName());
+    if (!config.objects) {
+        config.objects = { type: 'file' };
+    }
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        return require(`@iobroker/db-objects-${config.objects.type}`).Client;
+    }
+    catch {
+        console.error(`Installation broken or unknown objects type: ${config.objects.type} configured.`);
+        process.exit(101);
+    }
+}
+exports.getObjectsConstructor = getObjectsConstructor;
+//# sourceMappingURL=objects.js.map

package/build/lib/common/objects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.js","sourceRoot":"","sources":["../../../src/lib/common/objects.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;AAEb,6CAA+B;AAC/B,kCAAkC;AAClC,yEAAuD;AAEvD,SAAgB,qBAAqB;IACjC,MAAM,MAAM,GAAG,EAAE,CAAC,YAAY,CAAC,4BAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAC1D,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACjB,MAAM,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;KACrC;IAED,IAAI;QACA,8DAA8D;QAC9D,OAAO,OAAO,CAAC,wBAAwB,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;KACxE;IAAC,MAAM;QACJ,OAAO,CAAC,KAAK,CAAC,gDAAgD,MAAM,CAAC,OAAO,CAAC,IAAI,cAAc,CAAC,CAAC;QACjG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACrB;AACL,CAAC;AAbD,sDAaC"}

package/build/lib/common/states.d.ts

@@ -0,0 +1,2 @@
+export declare function getStatesConstructor(): any;
+//# sourceMappingURL=states.d.ts.map

package/build/lib/common/states.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"states.d.ts","sourceRoot":"","sources":["../../../src/lib/common/states.ts"],"names":[],"mappings":"AAMA,wBAAgB,oBAAoB,IAAI,GAAG,CAa1C"}

package/build/lib/common/states.js

@@ -0,0 +1,41 @@
+'use strict';
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStatesConstructor = void 0;
+const fs = __importStar(require("fs-extra"));
+// @ts-expect-error no typings yet
+const js_controller_common_1 = require("@iobroker/js-controller-common");
+function getStatesConstructor() {
+    const config = fs.readJSONSync(js_controller_common_1.tools.getConfigFileName());
+    if (!config.states) {
+        config.states = { type: 'file' };
+    }
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        return require(`@iobroker/db-states-${config.states.type}`).Client;
+    }
+    catch {
+        console.error(`Installation broken or unknown states type: ${config.states.type} configured.`);
+        process.exit(101);
+    }
+}
+exports.getStatesConstructor = getStatesConstructor;
+//# sourceMappingURL=states.js.map

package/build/lib/common/states.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"states.js","sourceRoot":"","sources":["../../../src/lib/common/states.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;AAEb,6CAA+B;AAC/B,kCAAkC;AAClC,yEAAuD;AAEvD,SAAgB,oBAAoB;IAChC,MAAM,MAAM,GAAG,EAAE,CAAC,YAAY,CAAC,4BAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAC1D,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;QAChB,MAAM,CAAC,MAAM,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;KACpC;IAED,IAAI;QACA,8DAA8D;QAC9D,OAAO,OAAO,CAAC,uBAAuB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;KACtE;IAAC,MAAM;QACJ,OAAO,CAAC,KAAK,CAAC,+CAA+C,MAAM,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,CAAC;QAC/F,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACrB;AACL,CAAC;AAbD,oDAaC"}

package/build/lib/common/tools.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Allows to find out if a given states dbType offers a server or not
+ * @param dbType database type
+ * @returns true if a server class is available
+ */
+export declare function statesDbHasServer(dbType: string): boolean;
+/**
+ * Allows to find out if a given objects dbType offers a server which runs on this host and listens (locally or globally/by IP)
+ * @param dbType database type
+ * @param host configured db host
+ * @param checkIfLocalOnly if true the method checks if the server listens to local connections only; else also external connection options are checked
+ * @returns true if a server listens on this host (locally or globally/by IP)
+ */
+export declare function isLocalObjectsDbServer(dbType: string, host: string, checkIfLocalOnly?: boolean): boolean;
+/**
+ * Allows to find out if a given states dbType offers a server which runs on this host and listens (locally or globally/by IP)
+ * @param dbType database type
+ * @param host configured db host
+ * @param checkIfLocalOnly if true the method checks if the server listens to local connections only; else also external connection options are checked
+ * @returns true if a server listens on this host (locally or globally/by IP)
+ */
+export declare function isLocalStatesDbServer(dbType: string, host: string, checkIfLocalOnly?: boolean): boolean;
+/**
+ * Allows to find out if a given objects dbType offers a server or not
+ * @param dbType database type
+ * @returns true if a server class is available
+ */
+export declare function objectsDbHasServer(dbType: string): boolean;
+//# sourceMappingURL=tools.d.ts.map

package/build/lib/common/tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["../../../src/lib/common/tools.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAOzD;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,GAAE,OAAe,GAAG,OAAO,CAU/G;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,UAAQ,GAAG,OAAO,CAUrG;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAO1D"}

package/build/lib/common/tools.js

@@ -0,0 +1,74 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectsDbHasServer = exports.isLocalStatesDbServer = exports.isLocalObjectsDbServer = exports.statesDbHasServer = void 0;
+// @ts-expect-error no typings yet
+const js_controller_common_1 = require("@iobroker/js-controller-common");
+/**
+ * Allows to find out if a given states dbType offers a server or not
+ * @param dbType database type
+ * @returns true if a server class is available
+ */
+function statesDbHasServer(dbType) {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        return !!require(`@iobroker/db-states-${dbType}`).Server;
+    }
+    catch {
+        throw new Error(`Installation error or unknown states database type: ${dbType}`);
+    }
+}
+exports.statesDbHasServer = statesDbHasServer;
+/**
+ * Allows to find out if a given objects dbType offers a server which runs on this host and listens (locally or globally/by IP)
+ * @param dbType database type
+ * @param host configured db host
+ * @param checkIfLocalOnly if true the method checks if the server listens to local connections only; else also external connection options are checked
+ * @returns true if a server listens on this host (locally or globally/by IP)
+ */
+function isLocalObjectsDbServer(dbType, host, checkIfLocalOnly = false) {
+    if (!objectsDbHasServer(dbType)) {
+        return false; // if no server it can not be a local server
+    }
+    let result = host === 'localhost' || host === '127.0.0.1'; // reachable locally only
+    if (!checkIfLocalOnly) {
+        const ownIps = js_controller_common_1.tools.findIPs();
+        result = result || host === '0.0.0.0' || ownIps.includes(host);
+    }
+    return result;
+}
+exports.isLocalObjectsDbServer = isLocalObjectsDbServer;
+/**
+ * Allows to find out if a given states dbType offers a server which runs on this host and listens (locally or globally/by IP)
+ * @param dbType database type
+ * @param host configured db host
+ * @param checkIfLocalOnly if true the method checks if the server listens to local connections only; else also external connection options are checked
+ * @returns true if a server listens on this host (locally or globally/by IP)
+ */
+function isLocalStatesDbServer(dbType, host, checkIfLocalOnly = false) {
+    if (!statesDbHasServer(dbType)) {
+        return false; // if no server it can not be a local server
+    }
+    let result = host === 'localhost' || host === '127.0.0.1'; // reachable locally only
+    if (!checkIfLocalOnly) {
+        const ownIps = js_controller_common_1.tools.findIPs();
+        result = result || host === '0.0.0.0' || ownIps.includes(host);
+    }
+    return result;
+}
+exports.isLocalStatesDbServer = isLocalStatesDbServer;
+/**
+ * Allows to find out if a given objects dbType offers a server or not
+ * @param dbType database type
+ * @returns true if a server class is available
+ */
+function objectsDbHasServer(dbType) {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        return !!require(`@iobroker/db-objects-${dbType}`).Server;
+    }
+    catch {
+        throw new Error(`Installation error or unknown objects database type: ${dbType}`);
+    }
+}
+exports.objectsDbHasServer = objectsDbHasServer;
+//# sourceMappingURL=tools.js.map

package/build/lib/common/tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.js","sourceRoot":"","sources":["../../../src/lib/common/tools.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;AACb,kCAAkC;AAClC,yEAAuD;AAEvD;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,MAAc;IAC5C,IAAI;QACA,8DAA8D;QAC9D,OAAO,CAAC,CAAC,OAAO,CAAC,uBAAuB,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;KAC5D;IAAC,MAAM;QACJ,MAAM,IAAI,KAAK,CAAC,uDAAuD,MAAM,EAAE,CAAC,CAAC;KACpF;AACL,CAAC;AAPD,8CAOC;AAED;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAAC,MAAc,EAAE,IAAY,EAAE,mBAA4B,KAAK;IAClG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE;QAC7B,OAAO,KAAK,CAAC,CAAC,4CAA4C;KAC7D;IACD,IAAI,MAAM,GAAG,IAAI,KAAK,WAAW,IAAI,IAAI,KAAK,WAAW,CAAC,CAAC,yBAAyB;IACpF,IAAI,CAAC,gBAAgB,EAAE;QACnB,MAAM,MAAM,GAAG,4BAAK,CAAC,OAAO,EAAE,CAAC;QAC/B,MAAM,GAAG,MAAM,IAAI,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;KAClE;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAVD,wDAUC;AAED;;;;;;GAMG;AACH,SAAgB,qBAAqB,CAAC,MAAc,EAAE,IAAY,EAAE,gBAAgB,GAAG,KAAK;IACxF,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE;QAC5B,OAAO,KAAK,CAAC,CAAC,4CAA4C;KAC7D;IACD,IAAI,MAAM,GAAG,IAAI,KAAK,WAAW,IAAI,IAAI,KAAK,WAAW,CAAC,CAAC,yBAAyB;IACpF,IAAI,CAAC,gBAAgB,EAAE;QACnB,MAAM,MAAM,GAAG,4BAAK,CAAC,OAAO,EAAE,CAAC;QAC/B,MAAM,GAAG,MAAM,IAAI,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;KAClE;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAVD,sDAUC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,MAAc;IAC7C,IAAI;QACA,8DAA8D;QAC9D,OAAO,CAAC,CAAC,OAAO,CAAC,wBAAwB,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;KAC7D;IAAC,MAAM;QACJ,MAAM,IAAI,KAAK,CAAC,wDAAwD,MAAM,EAAE,CAAC,CAAC;KACrF;AACL,CAAC;AAPD,gDAOC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/js-controller-common-db",
-  "version": "4.0.0-alpha.8-20210909-001a711c",
+  "version": "4.0.3",
   "engines": {
     "node": ">=12.0.0"
   },
@@ -9,13 +9,14 @@
     "winston-syslog": "^2.4.4"
   },
   "dependencies": {
-    "@iobroker/db-objects-file": "4.0.0-alpha.8-20210909-001a711c",
-    "@iobroker/db-objects-jsonl": "4.0.0-alpha.8-20210909-001a711c",
-    "@iobroker/db-objects-redis": "4.0.0-alpha.8-20210909-001a711c",
-    "@iobroker/db-states-file": "4.0.0-alpha.8-20210909-001a711c",
-    "@iobroker/db-states-jsonl": "4.0.0-alpha.8-20210909-001a711c",
-    "@iobroker/db-states-redis": "4.0.0-alpha.8-20210909-001a711c",
-    "@iobroker/js-controller-common": "4.0.0-alpha.8-20210909-001a711c"
+    "@iobroker/db-objects-file": "4.0.3",
+    "@iobroker/db-objects-jsonl": "4.0.3",
+    "@iobroker/db-objects-redis": "4.0.3",
+    "@iobroker/db-states-file": "4.0.3",
+    "@iobroker/db-states-jsonl": "4.0.3",
+    "@iobroker/db-states-redis": "4.0.3",
+    "@iobroker/js-controller-common": "4.0.3",
+    "fs-extra": "^10.0.0"
   },
   "keywords": [
     "ioBroker"
@@ -30,15 +31,19 @@
     "type": "git",
     "url": "https://github.com/ioBroker/ioBroker.js-controller/packages/common"
   },
-  "scripts": {},
-  "main": "index.js",
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json"
+  },
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
   },
   "files": [
-    "lib/",
-    "index.js"
+    "build/lib/",
+    "build/index.js",
+    "build/index.d.ts"
   ],
-  "gitHead": "4c022b8b6845fdd4792fc0003dbfc740fef4a942"
+  "gitHead": "79a76a082db91399d0e432ef02bf2981a6739107"
 }

package/index.js

@@ -1 +0,0 @@
-module.exports = require('./lib/common/tools');

package/lib/common/tools.js

@@ -1,76 +0,0 @@
-'use strict';
-
-const { tools } = require('@iobroker/js-controller-common');
-
-/**
- * Allows to find out if a given states dbType offers a server or not
- * @param dbType {string} database type
- * @returns {boolean} true if a server class is available
- */
-function statesDbHasServer(dbType) {
-    try {
-        const path = require.resolve(`@iobroker/db-states-${dbType}`);
-        return !!require(path).Server;
-    } catch {
-        throw new Error(`Installation error or unknown states database type: ${dbType}`);
-    }
-}
-
-/**
- * Allows to find out if a given objects dbType offers a server which runs on this host and listens (locally or globally/by IP)
- * @param dbType {string} database type
- * @param host {string} configured db host
- * @param [checkIfLocalOnly=false] {boolean} optional if try the method checks if the server listens to local connections only; else also external connection options are checked
- * @returns {boolean} true if a server listens on this host (locally or globally/by IP)
- */
-function isLocalObjectsDbServer(dbType, host, checkIfLocalOnly) {
-    const ownIps = tools.findIPs();
-    if (!objectsDbHasServer(dbType)) {
-        return false; // if no server it can not be a local server
-    }
-    let result = host === 'localhost' || host === '127.0.0.1'; // reachable locally only
-    if (!checkIfLocalOnly) {
-        result = result || host === '0.0.0.0' || ownIps.includes(host);
-    }
-    return result;
-}
-
-/**
- * Allows to find out if a given states dbType offers a server which runs on this host and listens (locally or globally/by IP)
- * @param dbType {string} database type
- * @param host {string} configured db host
- * @param [checkIfLocalOnly=false] {boolean} if try the method checks if the server listens to local connections only; else also external connection options are checked
- * @returns {boolean} true if a server listens on this host (locally or globally/by IP)
- */
-function isLocalStatesDbServer(dbType, host, checkIfLocalOnly) {
-    const ownIps = tools.findIPs();
-    if (!statesDbHasServer(dbType)) {
-        return false; // if no server it can not be a local server
-    }
-    let result = host === 'localhost' || host === '127.0.0.1'; // reachable locally only
-    if (!checkIfLocalOnly) {
-        result = result || host === '0.0.0.0' || ownIps.includes(host);
-    }
-    return result;
-}
-
-/**
- * Allows to find out if a given objects dbType offers a server or not
- * @param dbType {string} database type
- * @returns {boolean} true if a server class is available
- */
-function objectsDbHasServer(dbType) {
-    try {
-        const path = require.resolve(`@iobroker/db-objects-${dbType}`);
-        return !!require(path).Server;
-    } catch {
-        throw new Error(`Installation error or unknown objects database type: ${dbType}`);
-    }
-}
-
-module.exports = {
-    objectsDbHasServer,
-    isLocalObjectsDbServer,
-    isLocalStatesDbServer,
-    statesDbHasServer
-};