@iobroker/adapter-react-v5 3.2.6 → 3.3.0

package/Connection.d.ts

@@ -1,3 +1,8 @@
+/** Converts ioB pattern into regex
+ * @param {string} pattern
+ * @returns {string}
+ */
+export function pattern2RegEx(pattern: string): string;
 export namespace PROGRESS {
     const CONNECTING: number;
     const CONNECTED: number;
@@ -47,6 +52,7 @@ declare class Connection {
         reg: RegExp;
         cbs: import('./types').ObjectChangeHandler[];
     }>;
+    filesSubscribes: {};
     onProgress: (progress: number) => void;
     onError: (err: any) => void;
     loaded: boolean;
@@ -143,6 +149,27 @@ declare class Connection {
      * @returns {Promise<void>}
      */
     unsubscribeObject(id: string, cb: import('./types').ObjectChangeHandler): Promise<void>;
+    /**
+     * Called internally.
+     * @param id
+     * @param fileName
+     * @param size
+     */
+    fileChange(id: any, fileName: any, size: any): void;
+    /**
+     * Subscribe to changes of the files.
+     * @param {string} id The ioBroker state ID for meat object. Could be a pattern
+     * @param {string} filePattern Pattern or file name, like 'main/*' or 'main/visViews.json`
+     * @param {function} cb The callback.
+     */
+    subscribeFiles(id: string, filePattern: string, cb: Function): Promise<void>;
+    /**
+     * Unsubscribes the given callback from changes of files.
+     * @param {string} id The ioBroker state ID.
+     * @param {string} filePattern Pattern or file name, like 'main/*' or 'main/visViews.json`
+     * @param {function} cb The callback.
+     */
+    unsubscribeFiles(id: string, filePattern: string, cb: Function): void;
     /**
      * Called internally.
      * @private

package/Connection.js

@@ -5,17 +5,16 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = exports.PROGRESS = exports.ERRORS = void 0;
+exports.pattern2RegEx = pattern2RegEx;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
-/**
- * Copyright 2020-2022, bluefox <dogafox@gmail.com>
- *
- * MIT License
- *
- **/
-
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
 /** Possible progress states. */
 var PROGRESS = {
   /** The socket is connecting. */
@@ -69,6 +68,19 @@ function fixAdminUI(obj) {
   }
   return obj;
 }
+
+/** Converts ioB pattern into regex
+ * @param {string} pattern
+ * @returns {string}
+ */
+
+function pattern2RegEx(pattern) {
+  pattern = (pattern || '').toString();
+  var startsWithWildcard = pattern[0] === '*';
+  var endsWithWildcard = pattern[pattern.length - 1] === '*';
+  pattern = pattern.replace(/[-/\\^$+?.()|[\]{}]/g, '\\$&').replace(/\*/g, '.*');
+  return (startsWithWildcard ? '' : '^') + pattern + (endsWithWildcard ? '' : '$');
+}
 var Connection = /*#__PURE__*/function () {
   /**
    * @param {import('./types').ConnectionProps} props
@@ -111,6 +123,7 @@ var Connection = /*#__PURE__*/function () {
 
     /** @type {Record<string, { reg: RegExp; cbs: import('./types').ObjectChangeHandler[]}>} */
     this.objectsSubscribes = {}; // subscribe for objects
+    this.filesSubscribes = {}; // subscribe for files
     this.onProgress = this.props.onProgress || function () {};
     this.onError = this.props.onError || function (err) {
       console.error(err);
@@ -326,6 +339,11 @@ var Connection = /*#__PURE__*/function () {
           return _this2.stateChange(id, state);
         }, 0);
       });
+      this._socket.on('fileChange', function (id, fileName, size) {
+        return setTimeout(function () {
+          return _this2.fileChange(id, fileName, size);
+        }, 0);
+      });
       this._socket.on('cmdStdout', function (id, text) {
         return _this2.onCmdStdoutHandler && _this2.onCmdStdoutHandler(id, text);
       });
@@ -637,6 +655,103 @@ var Connection = /*#__PURE__*/function () {
       return Promise.resolve();
     }
 
+    /**
+     * Called internally.
+     * @param id
+     * @param fileName
+     * @param size
+     */
+  }, {
+    key: "fileChange",
+    value: function fileChange(id, fileName, size) {
+      for (var _i = 0, _Object$values = Object.values(this.filesSubscribes); _i < _Object$values.length; _i++) {
+        var sub = _Object$values[_i];
+        if (sub.regId.test(id) && sub.regFilePattern.test(fileName)) {
+          var _iterator = _createForOfIteratorHelper(sub.cbs),
+            _step;
+          try {
+            for (_iterator.s(); !(_step = _iterator.n()).done;) {
+              var cb = _step.value;
+              cb(id, fileName, size);
+            }
+          } catch (err) {
+            _iterator.e(err);
+          } finally {
+            _iterator.f();
+          }
+        }
+      }
+    }
+
+    /**
+     * Subscribe to changes of the files.
+     * @param {string} id The ioBroker state ID for meat object. Could be a pattern
+     * @param {string} filePattern Pattern or file name, like 'main/*' or 'main/visViews.json`
+     * @param {function} cb The callback.
+     */
+  }, {
+    key: "subscribeFiles",
+    value: function () {
+      var _subscribeFiles = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(id, filePattern, cb) {
+        var key;
+        return _regenerator["default"].wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                if (!(typeof cb !== 'function')) {
+                  _context.next = 2;
+                  break;
+                }
+                throw new Error('The state change handler must be a function!');
+              case 2:
+                key = "".concat(id, "$%$").concat(filePattern);
+                if (!this.filesSubscribes[key]) {
+                  this.filesSubscribes[key] = {
+                    regId: new RegExp(pattern2RegEx(id)),
+                    regFilePattern: new RegExp(pattern2RegEx(filePattern)),
+                    cbs: [cb]
+                  };
+                  this.connected && this._socket.emit('subscribeFiles', id, filePattern);
+                } else {
+                  !this.filesSubscribes[key].cbs.includes(cb) && this.filesSubscribes[key].cbs.push(cb);
+                }
+              case 4:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee, this);
+      }));
+      function subscribeFiles(_x, _x2, _x3) {
+        return _subscribeFiles.apply(this, arguments);
+      }
+      return subscribeFiles;
+    }()
+    /**
+     * Unsubscribes the given callback from changes of files.
+     * @param {string} id The ioBroker state ID.
+     * @param {string} filePattern Pattern or file name, like 'main/*' or 'main/visViews.json`
+     * @param {function} cb The callback.
+     */
+  }, {
+    key: "unsubscribeFiles",
+    value: function unsubscribeFiles(id, filePattern, cb) {
+      var key = "".concat(id, "$%$").concat(filePattern);
+      if (this.filesSubscribes[key]) {
+        var sub = this.filesSubscribes[key];
+        if (cb) {
+          var pos = sub.cbs.indexOf(cb);
+          pos !== -1 && sub.cbs.splice(pos, 1);
+        } else {
+          sub.cbs = [];
+        }
+        if (!sub.cbs || !sub.cbs.length) {
+          delete this.filesSubscribes[key];
+          this.connected && this._socket.emit('unsubscribeFiles', id, filePattern);
+        }
+      }
+    }
+
     /**
      * Called internally.
      * @private