vrack2-core 1.0.2 → 1.0.4

package/README.md

@@ -9,10 +9,18 @@ VRack2 Core
 
 --------
 
+### Последнее обновление 1.0.4
 
-### Последнее обновление 1.0.2
+ - `BasicType` (класс `Rule`) `require()` deprecated - используем `required()`
+ - **ErrorManager** - Теперь не создаёт ошибку при повторной регистрации с одинаковыми параметрами
+ - Добавлены методы в **ErrorManager**
+   - isCode(error: any, code: string) - Проверяет является ли ошибка VRack2 Error и соответсвует ли код переданной ошибке (проверяет vShort и vCode)
+   - isError(error: any) - Проверяет - пренадлежит ли объект ошибки CoreError
 
- - Откат от валидации в `DeviceManager.getDeviceInfo()`
+### Обновление 1.0.3
+
+ - Теперь порты `DevicePort` имеют ссылки на устройство своего владельца `Device`
+ - Добавлено свойство meta внутри контейнера для хранения дополнительной информации
 
 **Использовать эту документацию имеет смысл только для более глубокого изучения устройства VRack2 или для создания сервиса независимого от VRack2**
 

package/lib/Container.d.ts

@@ -86,6 +86,12 @@ export default class Container extends EventEmitter {
      * @see fillConfFile()
      * */
     confFile?: string;
+    /**
+     * Дополнительные метаданные
+    */
+    meta?: {
+        [key: string]: any;
+    };
     /**
      * Container bootstrap class
      *

package/lib/Container.js

@@ -368,7 +368,7 @@ class Container extends events_1.default {
                     this.checkPortName(subkey);
                     const handler = ImportManager_1.default.camelize('input.' + subkey);
                     this.checkInputHandler(subkey, handler, dev);
-                    const ndp = new DevicePort_1.default(subkey, pList[subkey]);
+                    const ndp = new DevicePort_1.default(subkey, pList[subkey], dev);
                     dev.ports.input[subkey] = ndp;
                     // add structure device input ports
                     this.structure[dconf.id].inputs[subkey] = [];
@@ -384,7 +384,7 @@ class Container extends events_1.default {
                 const pList = this.getPortList(key, exp);
                 for (const subkey in pList) {
                     this.checkPortName(subkey);
-                    const ndp = new DevicePort_1.default(subkey, pList[subkey]);
+                    const ndp = new DevicePort_1.default(subkey, pList[subkey], dev);
                     dev.ports.output[subkey] = ndp;
                     // add structure device output ports
                     this.structure[dconf.id].outputs[subkey] = [];

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/DevicePort.d.ts

@@ -1,5 +1,6 @@
 import IPort from "../ports/IPort";
 import DeviceConnect from "./DeviceConnect";
+import Device from "./Device";
 /**
  * A class to implement a device port.
  * The port can be either incoming or outgoing
@@ -15,13 +16,15 @@ export default class DevicePort {
     type: string;
     /** Flag determines whether the port should be connected */
     required: boolean;
+    /**  Ссылка на устройсто владельца */
+    Device: Device;
     /**
      * Список слушателей порта
      * Используется для захвата порта. Если какие либо данные будут проброшены
      * в порт, они будут переданы для каждого вызнванного слушателя
     */
     listens: Map<number, (data: any) => void>;
-    constructor(id: string, port: IPort);
+    constructor(id: string, port: IPort, device: Device);
     /**
      * Adding communication to a port
     */

package/lib/service/DevicePort.js

@@ -13,7 +13,7 @@ const Utility_1 = __importDefault(require("../Utility"));
  * The port can be either incoming or outgoing
 */
 class DevicePort {
-    constructor(id, port) {
+    constructor(id, port, device) {
         /** Flag to determine if the port is connected */
         this.connected = false;
         /** Port connection list. One port can have multiple connections */
@@ -27,6 +27,7 @@ class DevicePort {
         this.id = id;
         this.type = port.type;
         this.required = port.required;
+        this.Device = device;
     }
     /**
      * Adding communication to a port

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.2",
+  "version": "1.0.4",
   "description": "Фреймворк для создания событийно-ориентированных сервисов на JavaScript/TypeScript",
   "main": "./lib/index",
   "scripts": {},

package/src/Container.ts

@@ -173,6 +173,11 @@ export default class Container extends EventEmitter {
      * */
     confFile?: string
 
+    /**
+     * Дополнительные метаданные
+    */
+    meta?: {[key: string]: any}
+
     /**
      * Container bootstrap class
      * 
@@ -462,7 +467,7 @@ export default class Container extends EventEmitter {
                 this.checkPortName(subkey)
                 const handler = ImportManager.camelize('input.' + subkey) as keyof Device
                 this.checkInputHandler(subkey, handler, dev)
-                const ndp = new DevicePort(subkey, pList[subkey])
+                const ndp = new DevicePort(subkey, pList[subkey], dev)
                 dev.ports.input[subkey] = ndp
                 // add structure device input ports
                 this.structure[dconf.id].inputs[subkey] = []
@@ -480,7 +485,7 @@ export default class Container extends EventEmitter {
             const pList = this.getPortList(key, exp)
             for (const subkey in pList) {
                 this.checkPortName(subkey)
-                const ndp = new DevicePort(subkey, pList[subkey])
+                const ndp = new DevicePort(subkey, pList[subkey], dev)
                 dev.ports.output[subkey] = ndp
                 // add structure device output ports
                 this.structure[dconf.id].outputs[subkey] = []

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/DevicePort.ts

@@ -6,6 +6,7 @@
 import IPort from "../ports/IPort"
 import DeviceConnect from "./DeviceConnect"
 import Utility from "../Utility"
+import Device from "./Device"
 
 /**
  * A class to implement a device port. 
@@ -26,6 +27,9 @@ export default class DevicePort {
     /** Flag determines whether the port should be connected */
     required: boolean
 
+    /**  Ссылка на устройсто владельца */
+    Device: Device
+
     /**
      * Список слушателей порта
      * Используется для захвата порта. Если какие либо данные будут проброшены 
@@ -33,10 +37,11 @@ export default class DevicePort {
     */
     listens = new Map<number, (data:any) => void>()
 
-    constructor(id: string, port: IPort) {
+    constructor(id: string, port: IPort, device: Device) {
         this.id = id
         this.type = port.type
         this.required = port.required
+        this.Device = device
     }
 
     /**

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