vrack2-core 0.0.1 → 1.0.0

package/lib/ImportManager.js

@@ -79,6 +79,14 @@ class ImportManager {
             return ti;
         });
     }
+    /**
+     * Import class like a vrack2 device style
+     *
+     * Разделяюет переданную строку пути на 2 части.
+     * Первая честь является названием модуля, а вторая часть классом внутри него
+     *
+     * @example ImportManager.importClass('vrack2-core.Container')
+    */
     static importClass(cs) {
         return __awaiter(this, void 0, void 0, function* () {
             const acts = cs.split('.');
@@ -96,18 +104,100 @@ class ImportManager {
             return ret;
         });
     }
+    /**
+     * Attempts to open a file and use its contents as json
+     *
+     * Returns the result of parsing json
+     *
+     * @returns {any} json parsing result
+    */
     static importJSON(filePath) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!path_1.default.isAbsolute(filePath)) {
-                filePath = path_1.default.join(ImportManager.systemPath(), filePath);
-            }
-            if ((0, fs_1.existsSync)(filePath)) {
-                const jdata = (0, fs_1.readFileSync)(filePath).toString('utf-8');
-                return ImportManager.tryJsonParse(jdata);
-            }
-            throw ErrorManager_1.default.make('IM_FILE_NOT_FOUND', { filePath });
-        });
+        if (!path_1.default.isAbsolute(filePath)) {
+            filePath = path_1.default.join(ImportManager.systemPath(), filePath);
+        }
+        if ((0, fs_1.existsSync)(filePath)) {
+            const jdata = (0, fs_1.readFileSync)(filePath).toString('utf-8');
+            return ImportManager.tryJsonParse(jdata);
+        }
+        throw ErrorManager_1.default.make('IM_FILE_NOT_FOUND', { filePath });
+    }
+    /**
+     * Returns the class name in the style of import vrack
+     *
+     * return `Container` from 'vrack2-core.Container' string
+     *
+     * @param cs Import class string
+     *
+    */
+    static importClassName(cs) {
+        const acts = cs.split('.');
+        return acts.pop();
+    }
+    /**
+     * Returns the vendor name in the style of import vrack
+     *
+     * return `vrack2-core` from 'vrack2-core.Container' string
+     *
+     * @param cs Import class string
+    */
+    static importVendorName(cs) {
+        const acts = cs.split('.');
+        return acts.shift();
+    }
+    /**
+     * Returns a list of directories in the specified directory.
+     *
+     * @param dir path to directory
+     */
+    static dirList(dir) {
+        const files = (0, fs_1.readdirSync)(dir);
+        const result = [];
+        for (const i in files)
+            if ((0, fs_1.statSync)(path_1.default.join(dir, files[i])).isDirectory())
+                result.push(files[i]);
+        return result;
+    }
+    /**
+     * Returns a list of files in the specified directory.
+     *
+     * @param dir path to directory
+     */
+    static fileList(dir) {
+        const files = (0, fs_1.readdirSync)(dir);
+        const result = [];
+        for (const i in files)
+            if (!(0, fs_1.statSync)(path_1.default.join(dir, files[i])).isDirectory())
+                result.push(files[i]);
+        return result;
+    }
+    /**
+     * Checks if a path is a directory
+     *
+     * @param dir path to directory
+    */
+    static isDir(dir) {
+        if ((0, fs_1.existsSync)(dir) && (0, fs_1.lstatSync)(dir).isDirectory())
+            return true;
+        return false;
     }
+    /**
+     * Checks if a path is a directory
+     *
+     * @param f path to file
+    */
+    static isFile(f) {
+        if ((0, fs_1.existsSync)(f) && (0, fs_1.lstatSync)(f).isFile())
+            return true;
+        return false;
+    }
+    /**
+     * Try JSON parse
+     *
+     * Returns an CoreError[IM_JSON_INCORRECT] if there is a parsing error.
+     *
+     * @param jsonRaw JSON raw string
+     *
+    */
     static tryJsonParse(jsonRaw) {
         try {
             return JSON.parse(jsonRaw);
@@ -118,6 +208,25 @@ class ImportManager {
             });
         }
     }
+    /**
+     * Return directory where VRack was launched from
+    */
+    static systemPath() {
+        return process.cwd();
+    }
+    /**
+     * Camelize string for input & action handlers
+     *
+     * Splits a string with a dot and returns the string
+     * with capital letters starting from the second word
+     *
+     * @example
+     * ```ts
+     * ImportManager.camelize('input.device.port') // return inputDevicePort
+     * ```
+     *
+     * @param text Like a `input.device.port` string
+    */
     static camelize(text) {
         return text.replace(/^([A-Z])|[.]+(\w)/g, function (match, p1, p2, offset) {
             if (p2)
@@ -125,12 +234,9 @@ class ImportManager {
             return p1.toLowerCase();
         });
     }
-    static getSub(imp, get) {
-        return imp[get];
-    }
-    static systemPath() {
-        return process.cwd();
-    }
+    /**
+     * Try import method
+    */
     static tryImport(p) {
         return __awaiter(this, void 0, void 0, function* () {
             try {

package/lib/MainProcess.d.ts

@@ -1,9 +1,36 @@
+import Bootstrap, { IBootListConfig } from "./Bootstrap";
 import Container from "./Container";
-import DeviceManager from "./DeviceManager";
 import IServiceStructure from "./IServiceStructure";
+interface IMainProcessInternalOptions {
+    /** Container ID  */
+    id: string;
+    /** Service structure */
+    service: IServiceStructure;
+    /** Path to extends conf file */
+    confFile?: string;
+    /** Container class */
+    ContainerClass: typeof Container;
+    /** Bootstrap list config */
+    bootstrap: IBootListConfig;
+}
+export interface IMainProcessOptions {
+    /** Container ID  */
+    id: string;
+    /** Service structure */
+    service: IServiceStructure;
+    /** Path to extends conf file */
+    confFile?: string;
+    /** Container class */
+    ContainerClass?: typeof Container;
+    /** Bootstrap list config */
+    bootstrap?: IBootListConfig;
+}
 export default class MainProcess {
     Container: Container;
-    DeviceManager: DeviceManager;
-    constructor(ContainerClass: typeof Container, DeviceManagerClass: typeof DeviceManager, service: IServiceStructure);
+    options: IMainProcessInternalOptions;
+    Bootstrap: Bootstrap;
+    constructor(config: IMainProcessOptions);
     run(): Promise<void>;
+    check(): Promise<void>;
 }
+export {};

package/lib/MainProcess.js

@@ -12,16 +12,38 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const ImportManager_1 = __importDefault(require("./ImportManager"));
+const Bootstrap_1 = __importDefault(require("./Bootstrap"));
+const Container_1 = __importDefault(require("./Container"));
 class MainProcess {
-    constructor(ContainerClass, DeviceManagerClass, service) {
-        this.DeviceManager = new DeviceManagerClass(ImportManager_1.default.systemPath(), './devices');
-        this.DeviceManager.updateList();
-        this.Container = new ContainerClass(service, this.DeviceManager);
+    constructor(config) {
+        this.options = {
+            id: 'vrack2',
+            service: {
+                devices: [],
+                connections: [],
+            },
+            ContainerClass: Container_1.default,
+            bootstrap: {
+                DeviceManager: { path: 'vrack2-core.DeviceManager', options: { storageDir: './storage' } },
+                DeviceStorage: { path: 'vrack2-core.DeviceFileStorage', options: {} },
+                StructureStorage: { path: 'vrack2-core.StructureStorage', options: {} },
+                DeviceMetrics: { path: 'vrack2-core.DeviceMetrics', options: {} }
+            }
+        };
+        Object.assign(this.options, config);
+        this.Bootstrap = new Bootstrap_1.default(this.options.bootstrap);
+        this.Container = new this.options.ContainerClass(this.options.id, this.options.service, this.Bootstrap, this.options.confFile);
     }
     run() {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.Container.run();
+            yield this.check();
+            yield this.Container.runProcess();
+        });
+    }
+    check() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.Bootstrap.loadBootList(this.Container);
+            yield this.Container.init();
         });
     }
 }

package/lib/Utility.d.ts

@@ -1,21 +1,15 @@
-/**
- * Преобразует строку типа `aaa.bbb.ccc` в строку типа `aaaBbbCcc`
- * Обратите внимание на то, что первый символ первого актета не преобразуется,
- * если есть такая необходимость, можно добавить точку в самое начало строки `.aaa.bbb.ccc`
- * результат выполнения будет `AaaBbbCcc`
-*/
-declare function camelize(text: string): string;
-/**
- * Проверяет, является ли JSON строка валидным JSON
- * Обычно используется, когда неважно в чем конретно проблема в JSON
- * и нужно просто узнать валидный он или нет
- *
-*/
-declare function validJSON(text: string): any;
-/**
- * Преобразует строку в локальный путь VRack, на данный момент
- * это просто приведение строки в lowerCase
- *
-*/
-declare function toPath(text: string): string;
-export { camelize, validJSON, toPath };
+export default class Utility {
+    /**
+     * Check device name (device ID)
+     * */
+    static isDeviceName(name: string): Promise<boolean>;
+    /**
+     * Форматирует любое значение в красивую строку (с отступами, подсветкой и т. д.).
+     * Поддерживает: объекты, массивы, примитивы, Error, Map, Set, Buffer и др.
+     *
+     * @param {any} value - Значение для форматирования
+     * @param {object} [options] - Дополнительные опции (как в `util.inspect()`)
+     * @returns {string} Отформатированная строка
+     */
+    static prettyFormat(value: any, options?: {}): string | undefined;
+}

package/lib/Utility.js

@@ -1,48 +1,48 @@
 "use strict";
 /*
- * Copyright © 2022 Boris Bobylev. All rights reserved.
+ * Copyright © 2025 Boris Bobylev. All rights reserved.
  * Licensed under the Apache License, Version 2.0
 */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toPath = exports.validJSON = exports.camelize = void 0;
-/**
- * Преобразует строку типа `aaa.bbb.ccc` в строку типа `aaaBbbCcc`
- * Обратите внимание на то, что первый символ первого актета не преобразуется,
- * если есть такая необходимость, можно добавить точку в самое начало строки `.aaa.bbb.ccc`
- * результат выполнения будет `AaaBbbCcc`
-*/
-function camelize(text) {
-    return text.replace(/^([A-Z])|[.]+(\w)/g, function (match, p1, p2, offset) {
-        if (p2)
-            return p2.toUpperCase();
-        return p1.toLowerCase();
+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());
     });
-}
-exports.camelize = camelize;
-/**
- * Проверяет, является ли JSON строка валидным JSON
- * Обычно используется, когда неважно в чем конретно проблема в JSON
- * и нужно просто узнать валидный он или нет
- *
-*/
-function validJSON(text) {
-    try {
-        const cfg = JSON.parse(text);
-        if (!(cfg && typeof cfg === 'object'))
-            return false;
-        return cfg;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = __importDefault(require("util"));
+class Utility {
+    /**
+     * Check device name (device ID)
+     * */
+    static isDeviceName(name) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return /^[a-zA-Z0-9_*-:]+$/.test(name);
+        });
     }
-    catch (e) {
-        return false;
+    /**
+     * Форматирует любое значение в красивую строку (с отступами, подсветкой и т. д.).
+     * Поддерживает: объекты, массивы, примитивы, Error, Map, Set, Buffer и др.
+     *
+     * @param {any} value - Значение для форматирования
+     * @param {object} [options] - Дополнительные опции (как в `util.inspect()`)
+     * @returns {string} Отформатированная строка
+     */
+    static prettyFormat(value, options = {}) {
+        const defaultOptions = Object.assign({ depth: null, colors: true, compact: false, breakLength: 80, sorted: false, showHidden: false }, options // Переопределение дефолтных опций
+        );
+        // Особые случаи (если нужно обработать их по-особому)
+        if (value instanceof Error) {
+            return value.stack; // Стек ошибки
+        }
+        // Всё остальное форматируем через util.inspect()
+        return util_1.default.inspect(value, defaultOptions);
     }
 }
-exports.validJSON = validJSON;
-/**
- * Преобразует строку в локальный путь VRack, на данный момент
- * это просто приведение строки в lowerCase
- *
-*/
-function toPath(text) {
-    return text.toLowerCase();
-}
-exports.toPath = toPath;
+exports.default = Utility;

package/lib/actions/Action.d.ts

@@ -1,4 +1,14 @@
 import GlobalAction from "./GlobalAction";
+/**
+ * A class for defining new actions.
+ * It is not necessary to use `new Action`.
+ * You must use the static method `Action.global` to define a new action
+*/
 export default class Action {
+    /**
+     * The only type of action game at the moment. Does not have any special properties.
+     *
+     * @see BasicAction
+    */
     static global(): GlobalAction;
 }

package/lib/actions/Action.js

@@ -8,7 +8,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const GlobalAction_1 = __importDefault(require("./GlobalAction"));
+/**
+ * A class for defining new actions.
+ * It is not necessary to use `new Action`.
+ * You must use the static method `Action.global` to define a new action
+*/
 class Action {
+    /**
+     * The only type of action game at the moment. Does not have any special properties.
+     *
+     * @see BasicAction
+    */
     static global() {
         return new GlobalAction_1.default();
     }

package/lib/actions/BasicAction.d.ts

@@ -1,15 +1,75 @@
 import BasicType from "../validator/types/BasicType";
 import IAction from "./IAction";
 import ILocalAction from "./ILocalAction";
+/**
+ * Action base class.
+ * Forms settings for a new action in `fluent interface` style
+*/
 export default class BasicAction {
     protected action: ILocalAction;
     constructor();
+    /**
+     * Sets the requirements for incoming `Action` parameters
+     * These rules will be applied every time the user invokes this action
+     *
+     * The method necessarily accepts an object.
+     * An action method cannot accept anything other than an object
+     *
+     * @example
+     *
+     * ```ts
+     * Action.global().requirements({
+     *       id: Rule.number().require().default(0).description('Unique ID'),
+     * })
+     * ```
+     * @param req Object of BasicType rules
+    */
     requirements(req: {
         [key: string]: BasicType;
     }): this;
+    /**
+     * Sets the requirements for the return value.
+     * This method does not guarantee that this action will return this particular data type.
+     * In fact, the return value is not validated.
+     * It may help to read the documentation for the device
+     *
+     * @example
+     *
+     * ```ts
+     * Action.global().returns({
+     *       id: Rule.number().require().default(0).description('Unique ID'),
+     * })
+     * ```
+     *
+     * @param ret Object of BasicType rules
+    */
     returns(ret: {
         [key: string]: BasicType;
     }): this;
+    /**
+     * Set description of Action
+     *
+     * @example
+     * ```ts
+     * Action.global().description('Short action description')
+     * ```
+    */
     description(des: string): this;
+    /**
+     * Returns the internal Action object.
+     * This method is used inside VRack2 when processing an Action inside Container
+     *
+     * **Do not use this method if it is not necessary**
+    */
+    exportRaw(): ILocalAction;
+    /**
+     * Forms a new IAction object
+     * This method is used inside VRack2 when processing an Action inside Container
+     *
+     * **Do not use this method if it is not necessary**
+     *
+     * !hide for external users
+     * @private
+    */
     export(): IAction;
 }

package/lib/actions/BasicAction.js

@@ -4,6 +4,10 @@
  * Licensed under the Apache License, Version 2.0
 */
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Action base class.
+ * Forms settings for a new action in `fluent interface` style
+*/
 class BasicAction {
     constructor() {
         this.action = {
@@ -13,18 +17,76 @@ class BasicAction {
             description: ''
         };
     }
+    /**
+     * Sets the requirements for incoming `Action` parameters
+     * These rules will be applied every time the user invokes this action
+     *
+     * The method necessarily accepts an object.
+     * An action method cannot accept anything other than an object
+     *
+     * @example
+     *
+     * ```ts
+     * Action.global().requirements({
+     *       id: Rule.number().require().default(0).description('Unique ID'),
+     * })
+     * ```
+     * @param req Object of BasicType rules
+    */
     requirements(req) {
         this.action.requirements = req;
         return this;
     }
+    /**
+     * Sets the requirements for the return value.
+     * This method does not guarantee that this action will return this particular data type.
+     * In fact, the return value is not validated.
+     * It may help to read the documentation for the device
+     *
+     * @example
+     *
+     * ```ts
+     * Action.global().returns({
+     *       id: Rule.number().require().default(0).description('Unique ID'),
+     * })
+     * ```
+     *
+     * @param ret Object of BasicType rules
+    */
     returns(ret) {
         this.action.returns = ret;
         return this;
     }
+    /**
+     * Set description of Action
+     *
+     * @example
+     * ```ts
+     * Action.global().description('Short action description')
+     * ```
+    */
     description(des) {
         this.action.description = des;
         return this;
     }
+    /**
+     * Returns the internal Action object.
+     * This method is used inside VRack2 when processing an Action inside Container
+     *
+     * **Do not use this method if it is not necessary**
+    */
+    exportRaw() {
+        return this.action;
+    }
+    /**
+     * Forms a new IAction object
+     * This method is used inside VRack2 when processing an Action inside Container
+     *
+     * **Do not use this method if it is not necessary**
+     *
+     * !hide for external users
+     * @private
+    */
     export() {
         const nAction = {
             type: this.action.type,

package/lib/actions/GlobalAction.d.ts

@@ -1,4 +1,9 @@
 import BasicAction from "./BasicAction";
+/**
+ * Standart action class
+ *
+ * @see BasicAction
+*/
 export default class GlobalAction extends BasicAction {
     constructor();
 }

package/lib/actions/GlobalAction.js

@@ -8,6 +8,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const BasicAction_1 = __importDefault(require("./BasicAction"));
+/**
+ * Standart action class
+ *
+ * @see BasicAction
+*/
 class GlobalAction extends BasicAction_1.default {
     constructor() {
         super();

package/lib/actions/IAction.d.ts

@@ -1,11 +1,18 @@
 import IValidationRule from "../validator/IValidationRule";
+/**
+ * Internal (exported) Action interface
+*/
 export default interface IAction {
+    /** Type of action ('global' as default) */
     type: string;
+    /** Requirements for incoming data */
     requirements: {
         [key: string]: IValidationRule;
     };
+    /** Requirements to returned data  */
     returns: {
         [key: string]: IValidationRule;
     };
+    /** A short text description of the action */
     description: string;
 }

package/lib/actions/ILocalAction.d.ts

@@ -1,11 +1,18 @@
 import BasicType from "../validator/types/BasicType";
+/**
+ * Internal (raw exported) Action interface
+*/
 export default interface ILocalAction {
+    /** Type of action ('global' as default) */
     type: string;
+    /** Requirements for incoming data */
     requirements: {
         [key: string]: BasicType;
     };
+    /** Requirements to returned data  */
     returns: {
         [key: string]: BasicType;
     };
+    /** A short text description of the action */
     description: string;
 }