vrack2-core 1.0.3 → 1.0.5

package/README.md

@@ -9,10 +9,21 @@ VRack2 Core
 
 --------
 
-### Последнее обновленте 1.0.3
-
- - Теперь порты `DevicePort` имеют ссылки на устройство своего владельца `Device`
- - Добавлено свойство meta внутри контейнера для хранения дополнительной информации
+### Последнее обновление 1.0.5
+ - В Container добавлена ошибка `CTR_IGNORE_SERVICE_AUTORELOAD` её можно использовать, когда не хочется что бы после завершения работы сервиса - сервис автоматически перезапускался
+ - В класс `Device` добавлены
+   - Свойство `works: boolean = true` - если `false` - устройство перестает принимать и отправлять данные через порты
+   - Метод `beforeTerminate(){ return }` - может вызываться перед завершением сервиса (зависит от реализации)
+ - Теперь бинд входящего порта осуществляется по другому. Теперь вместо замены `DevicePort.push` ссылка на хендлер складывается в `DevicePort.bind` и уже после этого происходит вызов `DevicePort.bind()` внутри `DevicePort.push`
+  
+
+### Последнее обновление 1.0.4
+
+ - `BasicType` (класс `Rule`) `require()` deprecated - используем `required()`
+ - **ErrorManager** - Теперь не создаёт ошибку при повторной регистрации с одинаковыми параметрами
+ - Добавлены методы в **ErrorManager**
+   - isCode(error: any, code: string) - Проверяет является ли ошибка VRack2 Error и соответсвует ли код переданной ошибке (проверяет vShort и vCode)
+   - isError(error: any) - Проверяет - пренадлежит ли объект ошибки CoreError
 
 **Использовать эту документацию имеет смысл только для более глубокого изучения устройства VRack2 или для создания сервиса независимого от VRack2**
 

package/lib/Container.js

@@ -85,6 +85,7 @@ ErrorManager_1.default.register('Container', 'XR1K10R0OOUC', 'CTR_INCOMPATIBLE_P
 });
 ErrorManager_1.default.register('Container', 'MmVoDOQwaYkx', 'CTR_INCORRECT_BOOSTRAP', 'The required DeviceManager class is not specified correctly', {});
 ErrorManager_1.default.register('Container', 'e090R0MLyb7y', 'CTR_CONF_EXTENDS_PROBLEM', 'Problem with extending service configuration.', {});
+ErrorManager_1.default.register('Container', 'LYC0VA1AWYKU', 'CTR_IGNORE_SERVICE_AUTORELOAD', 'Error that ignores service restart flag', {});
 /**
  * Service Load Class. It loads all devices in the list,
  * establishes connections between them, and performs device startup.
@@ -373,8 +374,9 @@ class Container extends events_1.default {
                     // add structure device input ports
                     this.structure[dconf.id].inputs[subkey] = [];
                     this.structure[dconf.id].ports.push(Object.assign({ port: subkey, direct: 'input' }, pList[subkey]));
+                    // биндимся а не заменяем push для контроля внутри push
                     if (handler in dev)
-                        ndp.push = dev[handler].bind(dev);
+                        ndp.bind = dev[handler].bind(dev);
                 }
             }
             // make output ports

package/lib/errors/ErrorManager.d.ts

@@ -34,6 +34,18 @@ declare class ErrorManager {
      * @param error Ошибка для преобразования
     */
     convert(error: any): any;
+    /**
+     * Проверяет является ли ошибка VRack2 Error
+     * и соответсвует ли код переданной ошибке (проверяет vShort и vCode)
+    */
+    isCode(error: any, code: string): boolean;
+    /**
+     * Проверяет - пренадлежит объект ошибки VRack2 Error
+     *
+     * Это не обязательно должен быть класс CoreError но и
+     * любой сериализированный класс ошибки VRack2
+    */
+    isError(error: any): boolean;
     /**
      * Searches for an error by code or short
      *

package/lib/errors/ErrorManager.js

@@ -31,8 +31,15 @@ class ErrorManager {
     register(name, code, short, description, rules = {}) {
         const reg1 = this.getRegistered(code);
         const reg2 = this.getRegistered(short);
-        if (reg1 !== null || reg2 !== null)
-            throw this.make('EM_CODE_EXISTS', { code, short });
+        if (reg1 !== null || reg2 !== null) {
+            // Если уже есть идентичная запись - просто игнорим
+            if ((reg1 === null || reg1 === void 0 ? void 0 : reg1.code) === (reg2 === null || reg2 === void 0 ? void 0 : reg2.code) && (reg1 === null || reg1 === void 0 ? void 0 : reg1.short) === (reg2 === null || reg2 === void 0 ? void 0 : reg2.short)) {
+                return;
+            }
+            else {
+                throw this.make('EM_CODE_EXISTS', { code, short });
+            }
+        }
         const nr = { name, code, short, description, rules };
         this.registeredList.push(nr);
     }
@@ -66,6 +73,30 @@ class ErrorManager {
         ne.import(error);
         return ne;
     }
+    /**
+     * Проверяет является ли ошибка VRack2 Error
+     * и соответсвует ли код переданной ошибке (проверяет vShort и vCode)
+    */
+    isCode(error, code) {
+        if (!this.isError(error))
+            return false;
+        if (error.vShort === code || error.vCode === code)
+            return true;
+        return false;
+    }
+    /**
+     * Проверяет - пренадлежит объект ошибки VRack2 Error
+     *
+     * Это не обязательно должен быть класс CoreError но и
+     * любой сериализированный класс ошибки VRack2
+    */
+    isError(error) {
+        if (error instanceof CoreError_1.default)
+            return true;
+        if (error.vError && error.vCode !== undefined && error.vShort !== undefined)
+            return true;
+        return false;
+    }
     /**
      * Searches for an error by code or short
      *
@@ -79,7 +110,7 @@ class ErrorManager {
     }
 }
 const GlobalErrorManager = new ErrorManager();
-GlobalErrorManager.register('ErrorManager', 'NcZIb9QvQRcq', 'EM_CODE_EXISTS', 'This code already exists');
+GlobalErrorManager.register('ErrorManager', 'NcZIb9QvQRcq', 'EM_CODE_EXISTS', 'Has anyone else encountered this error code? Possible duplication of the error code and short word in different registrations.');
 GlobalErrorManager.register('ErrorManager', 'uLYv4mE1Yo50', 'EM_CODE_NOT_FOUND', 'No such error found');
 GlobalErrorManager.register('ErrorManager', 'RIl3BUrxWOzP', 'EM_ERROR_CONVERT', 'Converted error');
 exports.default = GlobalErrorManager;

package/lib/service/Device.d.ts

@@ -40,6 +40,12 @@ export default class Device {
      * @example 'vrack.KeyManager'
     */
     type: string;
+    /**
+     * Флаг общей работы
+     * Если флаг === false = все порты перестают принимать или отправлять данные/события
+     *
+    */
+    works: boolean;
     /**
      * Allows access to port management.
     */
@@ -136,6 +142,11 @@ export default class Device {
      * @param data  data for action
     */
     beforeAction(action: string, data: any): boolean;
+    /**
+     * Должен вызываться перед завершением сервиса
+     * Но может не вызываться (зависит от реализации)
+    */
+    beforeTerminate(): void;
     /**
      * Prepare options
      *

package/lib/service/Device.js

@@ -58,6 +58,7 @@ class Device {
         this.id = id;
         this.type = type;
         this.Container = Container;
+        this.works = true;
         this.ports = {
             input: {},
             output: {}
@@ -118,6 +119,11 @@ class Device {
      * @param data  data for action
     */
     beforeAction(action, data) { return true; }
+    /**
+     * Должен вызываться перед завершением сервиса
+     * Но может не вызываться (зависит от реализации)
+    */
+    beforeTerminate() { return; }
     /**
      * Prepare options
      *
@@ -268,7 +274,8 @@ class Device {
     */
     addInputHandler(name, action) {
         name = ImportManager_1.default.camelize('input.' + name);
-        this[name] = action;
+        const a = this;
+        a[name] = action;
     }
     /**
      * Adding a handle for the action
@@ -278,7 +285,8 @@ class Device {
     */
     addActionHandler(name, action) {
         name = ImportManager_1.default.camelize('action.' + name);
-        this[name] = action;
+        const a = this;
+        a[name] = action;
     }
     /**
      * Informs the rack that the unit cannot continue to operate.

package/lib/service/DevicePort.d.ts

@@ -18,6 +18,7 @@ export default class DevicePort {
     required: boolean;
     /**  Ссылка на устройсто владельца */
     Device: Device;
+    bind: ((data: any) => {}) | null;
     /**
      * Список слушателей порта
      * Используется для захвата порта. Если какие либо данные будут проброшены

package/lib/service/DevicePort.js

@@ -18,6 +18,7 @@ class DevicePort {
         this.connected = false;
         /** Port connection list. One port can have multiple connections */
         this.connections = [];
+        this.bind = null;
         /**
          * Список слушателей порта
          * Используется для захвата порта. Если какие либо данные будут проброшены
@@ -40,6 +41,10 @@ class DevicePort {
      * Calling the incoming port when calling a connection
     */
     push(data) {
+        if (!this.Device.works)
+            return;
+        if (this.bind !== null)
+            return this.bind(data);
         // Если у нас есть слушатели порта
         // Передаем им данные и пересоздаем Map
         if (this.listens.size) {

package/lib/validator/types/BasicType.d.ts

@@ -2,6 +2,12 @@ import IValidationRule from "../IValidationRule";
 export default class BasicType {
     protected rule: IValidationRule;
     constructor();
+    required(): this;
+    /**
+     * Вскоре будет удален
+     * @see required
+     * @deprecated use required()
+    */
     require(): this;
     /**
      * Example of a valid value for this rule

package/lib/validator/types/BasicType.js

@@ -20,6 +20,15 @@ class BasicType {
             message: '',
         };
     }
+    required() {
+        this.rule.require = true;
+        return this;
+    }
+    /**
+     * Вскоре будет удален
+     * @see required
+     * @deprecated use required()
+    */
     require() {
         this.rule.require = true;
         return this;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vrack2-core",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Фреймворк для создания событийно-ориентированных сервисов на JavaScript/TypeScript",
   "main": "./lib/index",
   "scripts": {},

package/src/Container.ts

@@ -107,6 +107,9 @@ ErrorManager.register('Container', 'XR1K10R0OOUC', 'CTR_INCOMPATIBLE_PORTS', 'In
 ErrorManager.register('Container', 'MmVoDOQwaYkx', 'CTR_INCORRECT_BOOSTRAP', 'The required DeviceManager class is not specified correctly', {})
 ErrorManager.register('Container', 'e090R0MLyb7y', 'CTR_CONF_EXTENDS_PROBLEM', 'Problem with extending service configuration.', {})
 
+ErrorManager.register('Container', 'LYC0VA1AWYKU', 'CTR_IGNORE_SERVICE_AUTORELOAD', 'Error that ignores service restart flag', {})
+
+
 
 /**
  * Contains the structure of the service
@@ -474,7 +477,9 @@ export default class Container extends EventEmitter {
                 this.structure[dconf.id].ports.push(
                     Object.assign({ port: subkey, direct: 'input' }, pList[subkey])
                 )
-                if (handler in dev) ndp.push = dev[handler].bind(dev)
+                
+                // биндимся а не заменяем push для контроля внутри push
+                if (handler in dev) ndp.bind = dev[handler].bind(dev)
             }
         }
 

package/src/errors/ErrorManager.ts

@@ -49,7 +49,14 @@ class ErrorManager {
     register(name: string, code: string, short: string, description: string, rules: { [key: string]: BasicType } = {}) {
         const reg1 = this.getRegistered(code)
         const reg2 = this.getRegistered(short)
-        if (reg1 !== null || reg2 !== null) throw this.make('EM_CODE_EXISTS', { code, short })
+        if (reg1 !== null || reg2 !== null) { 
+            // Если уже есть идентичная запись - просто игнорим
+            if (reg1?.code === reg2?.code && reg1?.short === reg2?.short){
+                return
+            }else {
+                throw this.make('EM_CODE_EXISTS', { code, short })
+            }
+        }
         const nr = { name, code, short, description, rules }
         this.registeredList.push(nr)
     }
@@ -74,6 +81,7 @@ class ErrorManager {
         return Object.assign(ne, additional)
     }
 
+    
     /**
      * Converts a normal error to a VRack error
      * 
@@ -86,6 +94,28 @@ class ErrorManager {
         return ne
     }
 
+    /**
+     * Проверяет является ли ошибка VRack2 Error 
+     * и соответсвует ли код переданной ошибке (проверяет vShort и vCode)
+    */
+    isCode(error: any, code: string){
+        if (!this.isError(error)) return false
+        if (error.vShort === code || error.vCode === code) return true
+        return false
+    }
+
+    /**
+     * Проверяет - пренадлежит объект ошибки VRack2 Error
+     * 
+     * Это не обязательно должен быть класс CoreError но и 
+     * любой сериализированный класс ошибки VRack2
+    */
+    isError(error: any){
+        if (error instanceof CoreError) return true
+        if (error.vError && error.vCode !== undefined && error.vShort !== undefined) return true
+        return false
+    }
+
     /**
      * Searches for an error by code or short
      * 
@@ -100,7 +130,7 @@ class ErrorManager {
 
 
 const GlobalErrorManager = new ErrorManager()
-GlobalErrorManager.register('ErrorManager', 'NcZIb9QvQRcq', 'EM_CODE_EXISTS', 'This code already exists')
+GlobalErrorManager.register('ErrorManager', 'NcZIb9QvQRcq', 'EM_CODE_EXISTS', 'Has anyone else encountered this error code? Possible duplication of the error code and short word in different registrations.')
 GlobalErrorManager.register('ErrorManager', 'uLYv4mE1Yo50', 'EM_CODE_NOT_FOUND', 'No such error found')
 GlobalErrorManager.register('ErrorManager', 'RIl3BUrxWOzP', 'EM_ERROR_CONVERT', 'Converted error')
 export default GlobalErrorManager

package/src/service/Device.ts

@@ -54,6 +54,13 @@ export default class Device {
     */
     type: string;
 
+    /**
+     * Флаг общей работы
+     * Если флаг === false = все порты перестают принимать или отправлять данные/события
+     * 
+    */
+    works: boolean
+
     /**
      * Allows access to port management. 
     */
@@ -83,6 +90,7 @@ export default class Device {
         this.id = id
         this.type = type
         this.Container = Container
+        this.works = true
         this.ports = {
             input: {},
             output: {}
@@ -165,6 +173,12 @@ export default class Device {
      * @param data  data for action
     */
     beforeAction(action: string, data: any) { return true }
+    
+    /**
+     * Должен вызываться перед завершением сервиса
+     * Но может не вызываться (зависит от реализации)
+    */
+    beforeTerminate(){ return }
 
     /**
      * Prepare options 
@@ -330,7 +344,8 @@ export default class Device {
     */
     addInputHandler(name: string, action: (data: any) => any) {
         name = ImportManager.camelize('input.' + name)
-        this[name as keyof Device] = action
+        const a = this as any
+        a[name] = action
     }
 
     /**
@@ -341,7 +356,8 @@ export default class Device {
     */
     addActionHandler(name: string, action: (data: any) => any) {
         name = ImportManager.camelize('action.' + name)
-        this[name as keyof Device] = action
+        const a = this as any
+        a[name] = action
     }
 
     /**
@@ -353,4 +369,5 @@ export default class Device {
     terminate(error: Error, action: string) {
         return this.makeEvent('device.terminate', action, error, [])
     }
+    
 }

package/src/service/DevicePort.ts

@@ -30,6 +30,8 @@ export default class DevicePort {
     /**  Ссылка на устройсто владельца */
     Device: Device
 
+    bind: ((data: any) => {}) | null = null;
+
     /**
      * Список слушателей порта
      * Используется для захвата порта. Если какие либо данные будут проброшены 
@@ -56,6 +58,9 @@ export default class DevicePort {
      * Calling the incoming port when calling a connection 
     */
     push(data: any): any { 
+        if (!this.Device.works) return
+        if (this.bind !== null) return this.bind(data)
+
         // Если у нас есть слушатели порта
         // Передаем им данные и пересоздаем Map
         if (this.listens.size) {

package/src/validator/types/BasicType.ts

@@ -21,6 +21,16 @@ export default class BasicType {
         }
     }
 
+    required(){
+        this.rule.require = true
+        return this
+    }
+    
+    /**
+     * Вскоре будет удален
+     * @see required
+     * @deprecated use required()
+    */
     require(){
         this.rule.require = true
         return this