@mirta/globals 0.2.5 → 0.2.8

package/eslint/index.d.ts

@@ -17,6 +17,7 @@ declare interface GlobalsMirta {
   readonly 'readConfig': false
   readonly 'trackMqtt': false
   readonly 'publish': false
+  readonly 'StorableObject': false
   readonly 'PersistentStorage': false
   readonly 'Notify': false
 }

package/eslint/index.js

@@ -17,6 +17,7 @@ export default {
   'readConfig': 'readonly',
   'trackMqtt': 'readonly',
   'publish': 'readonly',
+  'StorableObject': 'readonly',
   'PersistentStorage': 'readonly',
   'Notify': 'readonly',
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mirta/globals",
   "description": "Complete set of types for wb-rule development in TypeScript",
-  "version": "0.2.5",
+  "version": "0.2.8",
   "license": "Unlicense",
   "keywords": [
     "mirta",
@@ -31,8 +31,5 @@
   },
   "bugs": {
     "url": "https://github.com/wb-mirta/core/issues"
-  },
-  "publishConfig": {
-    "access": "public"
   }
 }

package/types/wb-rules.d.ts

@@ -197,7 +197,18 @@ declare namespace WbRules {
 
     setMin(min: number): void
 
-    setError(order: number): void
+    setPrecision(precision: number): void
+
+    /**
+     * Позволяет указать на наличие ошибки уровня контрола.
+     * Применимо только к виртуальным устройствам.
+     *
+     * @param message Текст ошибки.
+     *
+     **/
+    setError(message: string): void
+
+    setOrder(order: number): void
 
     setValue(value: MqttValue | ControlValueOptions): void
 
@@ -221,6 +232,13 @@ declare namespace WbRules {
 
     getMin(): number
 
+    getPrecision(): number
+
+    /**
+     * Возвращает текст ошибки,
+     * а при её отсутствии - пустую строку.
+     *
+     **/
     getError(): string
 
     getOrder(): number
@@ -385,6 +403,22 @@ declare namespace WbRules {
     controlsList(): Control[]
 
     isVirtual(): boolean
+
+    /**
+     * Позволяет указать на наличие ошибки уровня устройства.
+     * Применимо только к виртуальным устройствам.
+     *
+     * @param message Текст ошибки.
+     *
+     **/
+    setError(message: string): void
+
+    /**
+     * Возвращает текст ошибки,
+     * а при её отсутствии - пустую строку.
+     *
+     **/
+    getError(): string
   }
 
   type ControlOptionsTree = Record<string, ControlOptions>
@@ -645,6 +679,52 @@ declare function publish(
   retain?: boolean
 ): void
 
+/**
+ * Проксирует исходный объект, обеспечивая автоматическую синхронизацию
+ * изменений в его свойствах со связанным хранилищем {@link PersistentStorage}.
+ *
+ * Важно: отслеживание изменений поддерживается только для возвращаемого функцией объекта.
+ * Исходный объект не получит никакой дополнительной функциональности.
+ *
+ * @template TObject Тип исходного объекта. Обычно выводится автоматически (type inference), но при необходимости его можно задать явно.
+ *
+ * @param source Исходный объект, который будет проксирован.
+ *
+ * @example
+ *
+ * ```ts
+ * // Оборачивание объекта в прокси.
+ * const user = StorableObject({ id: 1, name: 'Alice' })
+ *
+ * // Подключение к энергонезависимому хранилищу.
+ * const storage = new PersistentStorage('users', { global: true })
+ * storage['user'] = user
+ *
+ * // Объект автоматически отслеживает изменения и передаёт их в хранилище.
+ * user.name = 'Bob'
+ *
+ * ```
+ * @example
+ *
+ * ```ts
+ * interface User {
+ *   id: number,
+ *   name: string
+ * }
+ *
+ * // Подключение к энергонезависимому хранилищу.
+ * const storage = new PersistentStorage('users', { global: true })
+ *
+ * // Извлечение объекта.
+ * const retrievedUser = storage['user'] as User
+ *
+ * // Изменения опять будут автоматически передаваться в хранилище.
+ * retrievedUser.name = 'Charlie'
+ *
+ * ```
+ */
+declare function StorableObject<TObject>(source: TObject): TObject
+
 declare class PersistentStorage {
   constructor(name: string, options: WbRules.StorageOptions)
 }