vrack2-core 0.0.1 → 1.0.1

package/src/validator/types/StringType.ts

@@ -4,9 +4,7 @@
 */
 
 import BasicType from "./BasicType"
-import IValidationRule  from "../IValidationRule"
 import ErrorManager from "../../errors/ErrorManager"
-import Rule from "../Rule"
 import IValidationSubrule from "../IValidationSubrule"
 
 export default class StringType  extends BasicType {
@@ -15,48 +13,74 @@ export default class StringType  extends BasicType {
         this.rule.type = 'string'
     }
 
+    /**
+     * Example of a valid value for this rule
+     * 
+     * @param ex Example valid value 
+    */
     example(ex: string): this {
         this.rule.example = ex
         return this
     }
-
+    
+    /**
+     * Setting the default value
+    */
     default(def: string) {
         this.rule.default = def
         return this
     }
 
+    /**
+     * Sets the maximum length of the string
+    */
     maxLength(max: number) {
         this.rule.rules.push({ name: 'maxLength', args: max })
         return this
     }
 
+    /**
+     * Sets the minimum length of the string
+    */
     minLength(min: number) {
         this.rule.rules.push({ name: 'minLength', args: min })
         return this
     }
 
-    static validate(obj: {[key:string]: any}, key: string, rule: IValidationRule){
-        BasicType.validate(obj, key, rule)
+    /**
+     * Method of validation of this type
+     * 
+     * @param obj Validation object
+     * @param key Key for getting value from object
+    */
+    validate(obj: {[key:string]: any}, key: string){
+        this.basicValidate(obj, key)
         if (typeof obj[key] !== 'string') throw ErrorManager.make('VR_IS_NOT_STRING', { key })
-        for (const subrule of rule.rules){
+        for (const subrule of this.rule.rules){
             switch (subrule.name){
                 case 'maxLength':
-                    StringType.checkMaxLength(obj, key, subrule)
+                    this.checkMaxLength(obj, key, subrule)
                     break
                 case 'minLength':
-                    StringType.checkMinLength(obj, key, subrule)
+                    this.checkMinLength(obj, key, subrule)
                     break
             }
         }
         return true
     }
 
-    protected static checkMaxLength(obj: {[key:string]: any}, key: string, sub: IValidationSubrule){
+    /**
+     * Checking the maximum string length
+    */
+    protected checkMaxLength(obj: {[key:string]: any}, key: string, sub: IValidationSubrule){
         const val = obj[key]
         if (val.length >= sub.args) throw ErrorManager.make('VR_STRING_MAX_LENGTH', { limit: sub.args, key })
     }
 
-    protected static checkMinLength(obj: {[key:string]: any}, key: string, sub: IValidationSubrule){
+    /**
+     * Checking the minimum string length
+    */
+    protected checkMinLength(obj: {[key:string]: any}, key: string, sub: IValidationSubrule){
         const val = obj[key]
         if (val.length <= sub.args) throw ErrorManager.make('VR_STRING_MIN_LENGTH', { limit: sub.args, key })
     }

package/docs/RU-README.md

@@ -1,6 +0,0 @@
-VRack2 core
------------
-
-Основной набор компонентов для работы vrack2. На данный момент находится в начальном состоянии и дорабатывает по мере необходимости. 
-
-На данный момент непригодно для публичного использования.

package/lib/DeviceManager.d.ts

@@ -1,32 +0,0 @@
-interface IDeviceGroup {
-    name: string;
-    dir: string;
-    devices: Array<any>;
-    deviceList: Array<string>;
-    errors: Array<string>;
-    description: string;
-}
-export default class DeviceManager {
-    dir: string;
-    systemDir: string;
-    devices: Map<string, string>;
-    deviceList: Array<IDeviceGroup>;
-    constructor(systemDir: string, dir: string);
-    updateList(): IDeviceGroup[];
-    devicesList(): IDeviceGroup[];
-    /**
-     * Return class of device
-     *
-     * Requires special device string of path
-     * example "vrack.System" where "vrack" is vendor and "System" is device class
-     * @param {string} device Device path string
-    */
-    get(device: string): Promise<any>;
-    /**
-     *
-     *
-     *
-    */
-    private getOnlyDirs;
-}
-export {};

package/lib/DeviceManager.js

@@ -1,143 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (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;
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
-const ErrorManager_1 = __importDefault(require("./errors/ErrorManager"));
-const Rule_1 = __importDefault(require("./validator/Rule"));
-ErrorManager_1.default.register('DeviceManager', 'S5dBTBKTnVbF', 'DM_DEVICE_NOT_FOUND', 'Device not found', {
-    device: Rule_1.default.string().require().description('Device request name')
-});
-class DeviceManager {
-    constructor(systemDir, dir) {
-        this.dir = './devices';
-        this.devices = new Map();
-        this.deviceList = [];
-        this.systemDir = systemDir;
-        this.dir = dir;
-    }
-    updateList() {
-        this.deviceList = this.devicesList();
-        for (const dgroup of this.deviceList) {
-            dgroup.devices = [];
-            for (const device of dgroup.deviceList) {
-                const ndevice = { name: device, errors: [] };
-                dgroup.devices.push(ndevice);
-                const devicePath = path_1.default.join(this.systemDir, this.dir, dgroup.name, device + '.js');
-                if (!fs_1.default.existsSync(devicePath)) {
-                    ndevice.errors.push('File of device not found');
-                    continue;
-                }
-            }
-        }
-        return this.deviceList;
-    }
-    devicesList() {
-        const result = [];
-        const files = fs_1.default.readdirSync(path_1.default.join(this.systemDir, this.dir));
-        const dirs = this.getOnlyDirs(files);
-        dirs.sort();
-        for (const ddir of dirs) {
-            const group = {
-                name: ddir,
-                dir: this.dir,
-                devices: [],
-                deviceList: [],
-                errors: [],
-                description: ''
-            };
-            result.push(group);
-            const listPath = path_1.default.join(this.systemDir, this.dir, ddir, 'list.json');
-            if (!fs_1.default.existsSync(listPath)) {
-                group.errors.push(listPath + ' ignored - list.json not found');
-                continue;
-            }
-            // @todo Исправить на SAFE
-            const list = JSON.parse(fs_1.default.readFileSync(listPath).toString('utf-8'));
-            if (!list || !Array.isArray(list)) {
-                group.errors.push(listPath + ' ignored - list.json incorrect');
-                continue;
-            }
-            for (const listKey in list) {
-                const reqPath = path_1.default.join(this.systemDir, this.dir, ddir, list[listKey]);
-                const devicePath = reqPath + '.js';
-                if (fs_1.default.existsSync(devicePath)) {
-                    if (!this.devices.has(ddir + '.' + list[listKey]))
-                        this.devices.set(ddir + '.' + list[listKey], reqPath);
-                    else
-                        console.log(devicePath + ' ignored - device not found');
-                }
-            }
-            list.sort();
-            group.deviceList = list;
-        }
-        return result;
-    }
-    /**
-     * Return class of device
-     *
-     * Requires special device string of path
-     * example "vrack.System" where "vrack" is vendor and "System" is device class
-     * @param {string} device Device path string
-    */
-    get(device) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const p = this.devices.get(device);
-            if (typeof p === 'string') {
-                const deviceClass = yield Promise.resolve(`${p}`).then(s => __importStar(require(s)));
-                if (deviceClass.default)
-                    return deviceClass.default;
-            }
-            throw ErrorManager_1.default.make('DM_DEVICE_NOT_FOUND', { device });
-        });
-    }
-    /**
-     *
-     *
-     *
-    */
-    getOnlyDirs(files) {
-        const result = [];
-        for (const i in files) {
-            if (fs_1.default.statSync(path_1.default.join(this.systemDir, this.dir, files[i])).isDirectory())
-                result.push(files[i]);
-        }
-        result.sort();
-        return result;
-    }
-}
-exports.default = DeviceManager;

package/lib/test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/test.js

@@ -1,58 +0,0 @@
-"use strict";
-// import Action from "./rack/Action";
-// import Port from "./rack/Port";
-// import Rule from "./validator/Rule";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const Rule_1 = __importDefault(require("./validator/Rule"));
-const Validator_1 = __importDefault(require("./validator/Validator"));
-Rule_1.default.array().require();
-// class Device {
-//     options (){
-//         return {
-//             test: Rule.string().default('Default string').description('Test string'),
-//             list: Rule.Array().objects({
-//                 name: Rule.string(),
-//                 value: Rule.number()
-//             })
-//         }
-//     }
-//     outputs(){
-//         return {
-//             'test.output%d': Port.standart().dynamic(5),
-//         }
-//     }
-//     inputs(){
-//         return {
-//             'test.output%d': Port.return().dynamic(5),
-//         }
-//     }
-//     actions(){
-//         return {
-//             'test.action': Action.global().rules({
-//                 test: Rule.string().default('Default string').description('Test string'),
-//             }).description('Test action for call global')
-//         }
-//     }
-//     init(){
-//     }
-//     process(){
-//     }
-//     async processPromise(){
-//     }
-// }
-const rules = {
-    obj: Rule_1.default.object().require().description('Test validation object'),
-    str: Rule_1.default.string().require().minLength(5),
-    arr: Rule_1.default.array().require(),
-    num: Rule_1.default.number().require().integer().description('integer test')
-};
-const data = {
-    obj: {},
-    str: 'qwe4',
-    arr: [],
-    num: 1.23
-};
-Validator_1.default.validate(rules, data);

package/src/DeviceManager.ts

@@ -1,124 +0,0 @@
-import path from 'path'
-import fs from 'fs'
-import ErrorManager from './errors/ErrorManager'
-import Rule from './validator/Rule'
-
-interface IDeviceGroup {
-    name: string,
-    dir: string,
-    devices: Array<any>,
-    deviceList: Array<string>,
-    errors: Array<string>,
-    description: string
-}
-
-interface IDeviceInGroup{
-    name: string,
-    errors: Array<string>
-}
-
-ErrorManager.register('DeviceManager', 'S5dBTBKTnVbF', 'DM_DEVICE_NOT_FOUND','Device not found', {
-    device: Rule.string().require().description('Device request name')
-})
-
-export default class DeviceManager {
-
-    dir = './devices'
-    systemDir: string
-
-    devices = new Map<string, string>()
-    deviceList: Array<IDeviceGroup> = []
-    constructor(systemDir: string, dir: string) {
-        this.systemDir = systemDir
-        this.dir = dir
-    }
-
-
-    updateList() {
-        this.deviceList = this.devicesList()
-        for (const dgroup of this.deviceList) {
-            dgroup.devices = []
-            for (const device of dgroup.deviceList) {
-                const ndevice : IDeviceInGroup = { name: device, errors: [] }
-                dgroup.devices.push(ndevice)
-                const devicePath = path.join(this.systemDir, this.dir, dgroup.name, device + '.js')
-                if (!fs.existsSync(devicePath)) { ndevice.errors.push('File of device not found'); continue }
-            }
-        }
-        return this.deviceList
-    }
-
-    devicesList() {
-        const result: Array<IDeviceGroup> = []
-        const files = fs.readdirSync(path.join(this.systemDir, this.dir))
-        const dirs = this.getOnlyDirs(files)
-        dirs.sort()
-        for (const ddir of dirs) {
-            const group: IDeviceGroup = {
-                name: ddir,
-                dir: this.dir,
-                devices: [],
-                deviceList: [],
-                errors: [],
-                description: ''
-            }
-            result.push(group)
-            const listPath = path.join(this.systemDir, this.dir, ddir, 'list.json')
-
-            if (!fs.existsSync(listPath)) {
-                group.errors.push(listPath + ' ignored - list.json not found');
-                continue
-            }
-
-            // @todo Исправить на SAFE
-            const list: Array<string> = JSON.parse(fs.readFileSync(listPath).toString('utf-8'))
-            if (!list || !Array.isArray(list)) {
-                group.errors.push(listPath + ' ignored - list.json incorrect');
-                continue
-            }
-            
-            for (const listKey in list) {
-                const reqPath = path.join(this.systemDir, this.dir, ddir, list[listKey])
-                const devicePath = reqPath + '.js'
-                if (fs.existsSync(devicePath)) {
-                  if (!this.devices.has(ddir + '.' + list[listKey])) this.devices.set(ddir + '.' + list[listKey], reqPath)
-                  else console.log(devicePath + ' ignored - device not found')
-                }
-              }
-            list.sort()
-
-            group.deviceList = list
-        }
-        return result
-    }
-
-    /**
-     * Return class of device 
-     * 
-     * Requires special device string of path 
-     * example "vrack.System" where "vrack" is vendor and "System" is device class
-     * @param {string} device Device path string
-    */
-    async get(device:string){
-        const p: string | undefined = this.devices.get(device)
-        if (typeof p ==='string') { 
-            const deviceClass = await import(p)
-            if (deviceClass.default) return deviceClass.default
-        }
-        throw ErrorManager.make('DM_DEVICE_NOT_FOUND', { device })
-    }
-
-    /**
-     * 
-     * 
-     * 
-    */
-    private getOnlyDirs(files: Array<string>) {
-        const result: Array<string> = []
-        for (const i in files) {
-            if (fs.statSync(path.join(this.systemDir, this.dir, files[i])).isDirectory()) result.push(files[i])
-        }
-        result.sort()
-        return result
-    }
-}

package/src/test.ts

@@ -1,82 +0,0 @@
-// import Action from "./rack/Action";
-// import Port from "./rack/Port";
-// import Rule from "./validator/Rule";
-
-import Rule from "./validator/Rule";
-import Validator from "./validator/Validator";
-
-Rule.array().require()
-
-
-// class Device {
-    
-//     options (){
-//         return {
-//             test: Rule.string().default('Default string').description('Test string'),
-//             list: Rule.Array().objects({
-//                 name: Rule.string(),
-//                 value: Rule.number()
-//             })
-//         }
-//     }
-
-//     outputs(){
-//         return {
-//             'test.output%d': Port.standart().dynamic(5),
-//         }
-//     }
-
-//     inputs(){
-//         return {
-//             'test.output%d': Port.return().dynamic(5),
-//         }
-//     }
-
-//     actions(){
-//         return {
-//             'test.action': Action.global().rules({
-//                 test: Rule.string().default('Default string').description('Test string'),
-//             }).description('Test action for call global')
-//         }
-//     }
-
-//     init(){
-
-//     }
-
-
-//     process(){
-
-//     }
-
-//     async processPromise(){
-
-//     }
-
-
-// }
-
-
-
-
-
-
-const rules = {
-    obj: Rule.object().require().description('Test validation object'),
-    str: Rule.string().require().minLength(5),
-    arr: Rule.array().require(),
-    num: Rule.number().require().integer().description('integer test')
-}
-
-
-const data = {
-    obj: {},
-    str: 'qwe4',
-    arr: [],
-    num: 1.23
-}
-
-
-Validator.validate(rules,data)
-
-