vrack2-core 0.0.1 → 1.0.1

package/lib/boot/StructureStorage.js

@@ -0,0 +1,125 @@
+"use strict";
+/*
+ * Copyright © 2024 Boris Bobylev. All rights reserved.
+ * Licensed under the Apache License, Version 2.0
+*/
+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 BootClass_1 = __importDefault(require("./BootClass"));
+const Rule_1 = __importDefault(require("../validator/Rule"));
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const ImportManager_1 = __importDefault(require("../ImportManager"));
+const ErrorManager_1 = __importDefault(require("../errors/ErrorManager"));
+ErrorManager_1.default.register('StructureStorage', 'FKb5raEUDFgU', 'SS_STRUCT_NOT_FOUND', 'Structure ID not found', {
+    id: Rule_1.default.string().require().example('vrack').description('Structure id')
+});
+/**
+ * A boot class for storing the structure of a container.
+ *
+ * When a container is created, it is assigned a unique identifier.
+ * This identifier is used as parameters of methods.
+ *
+ * @see getById
+ * @see updateById
+ *
+ * When the container is loaded it calls “beforeLoaded”.
+ * At this point it updates the structure from disk to the structure
+ * of the container itself and writes the changes
+ *
+ * @see beforeLoadedUpdate
+ *
+ * */
+class StructureStorage extends BootClass_1.default {
+    checkOptions() {
+        return {
+            structureDir: Rule_1.default.string().require().default('./structure')
+        };
+    }
+    process() {
+        if (!(0, fs_1.existsSync)(this.options.structureDir))
+            (0, fs_1.mkdirSync)(this.options.structureDir, { recursive: true });
+        this.Container.on('beforeLoaded', this.beforeLoadedUpdate.bind(this));
+    }
+    /**
+     * Updates the structure on disk using the structure of
+     * the container itself when it is loaded
+     *
+     *
+     * @see StructureStorage.process
+    */
+    beforeLoadedUpdate() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const fp = this.makeFilePath(this.Container.id);
+            let structure = {};
+            try {
+                if ((0, fs_1.existsSync)(fp))
+                    structure = ImportManager_1.default.importJSON(fp);
+                const cStruct = yield this.Container.getStructure();
+                this.updateStructure(cStruct, structure, this.Container.id);
+            }
+            catch (error) {
+                this.error(error);
+            }
+        });
+    }
+    /**
+     * Returns structure by container identifier
+     *
+     * @param id Container ID
+    */
+    getById(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const fp = this.makeFilePath(id);
+            if (!(0, fs_1.existsSync)(fp))
+                throw ErrorManager_1.default.make('SS_STRUCT_NOT_FOUND', { id });
+            return ImportManager_1.default.importJSON(fp);
+        });
+    }
+    /**
+     * Updating the container structure
+     *
+     * @param id Container ID
+     * @param structure updated container structure object
+    */
+    updateById(id, structure) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cStruct = yield this.getById(id);
+            this.updateStructure(cStruct, structure, id);
+        });
+    }
+    /**
+     * Updates the display structure parameter from the file structure
+     *
+     * @param cStruct now container structure
+     * @param structure new structure
+    */
+    updateStructure(cStruct, structure, id) {
+        for (const dID in cStruct) {
+            if (structure[dID] && structure[dID].display)
+                cStruct[dID].display = structure[dID].display;
+        }
+        const fp = this.makeFilePath(id);
+        (0, fs_1.writeFileSync)(fp, JSON.stringify(cStruct));
+    }
+    /**
+     * Forms the path to the structure file by its identifier
+     *
+     * @param id Container ID
+    */
+    makeFilePath(id) {
+        return path_1.default.join(this.options.structureDir, id + '.json');
+    }
+}
+exports.default = StructureStorage;

package/lib/errors/CoreError.d.ts

@@ -1,52 +1,69 @@
 /**
- * Базовый класс для реализаиции ошибок с возможностью
- * импортирования и экспортирования классов ошибок для
- * клиент-серверных операций.
+ * Base class for error realization with the ability to
+ * import and export error classes for client-server operations.
  *
- * В VRack очень много передается по сети в виде JSON.  Поскольку
- * в чистом виде ошибки не преобрзауются в JSON, были сделаны методы
- * для экспортирования и импортирования с сохранения основных важных свойств.
+ * In VRack, a lot of things are transmitted over the network as JSON.
+ * Since pure errors are not converted to JSON, methods were made to export and
+ * import them while preserving the main important properties.
  *
- * Если импортируемая ошибка имеет свойства которых нет в базовом классе, буду добавлены.
- * Для получения неизвестных свойств можно воспользоватся функцией (для typescript) getUnknownProperty
- *
- * Для работы с ошибками VRack рекомендуется использовать ErrorManager
+ * If the imported error has properties that are not in the base class,
+ * they will be added. To get unknown properties you can use the function
+ * (for typescript) getUnknownProperty.
  *
 */
 declare class CoreError extends Error {
-    /** Флаг того что ошибка пренадлежит VRack */
+    /** Flag that the error belongs to VRack */
     vError: boolean;
-    /** Код ошибки VRack */
+    /** Error code */
     vCode: string;
-    /** Кородкий код VRack */
+    /** Short code */
     vShort: string;
-    /** Список дополнительных параметров */
+    /** List of additional parameters */
     vAdd: Array<string>;
-    /**  */
-    vAddErrors: Array<CoreError>;
+    /** Nested errors */
+    vAddErrors: Array<Error>;
     constructor(name: string, message: string, code: string, short: string);
     /**
-     * Импортирует ошибку пришедшую по сети в виде JSON объекта
-     * На всякий случай использует objectify для приходящего объекта
+     * Sets the stacktrace of the error above
+     * It is necessary for the stacktrace to refer to the
+     * required file and not to ErrorManager
+     *
+     * @param err Error
+     * @example Example of assigning a more correct path to the file where the error occurred
+     * ```
+     *     ErrorManager.make('EM_CODE_NOT_FOUND').setTrace(new Error())
+     * ```
+    */
+    setTrace(err: Error): this;
+    /**
+     * Imports an error that came over the network as a JSON object
+     * Uses objectify for the incoming object just in case
      *
      * @returns {CoreError} this после модификации
     */
     import(error: any): this;
     /**
-     * Возвращает объект для передачи его по сети с предварительным
-     * преобразованием в JSON
+     * Returns an object to be transmitted over the network
+     * with preliminary conversion to JSON
+     *
+     * @see objectify
     */
     export(): any;
-    add(err: CoreError): this;
     /**
-     * Для Typescript используется для получения неизвестного
-     * свойства экземпляра после импорта пришедшей ошибки
+     * Add nested error
+     *
+     * @param err Nested error
+    */
+    add(err: Error): this;
+    /**
+     * For Typescript it is used to retrieve an unknown
+     * instance property after importing an incoming error
     */
     getUnknownProperty(field: string): any | undefined;
     /**
-     *  Возвращает объект для передачи его по сети
+     *  Returns an object to be transmitted over the network
      *
-     * @param {any} error Ошибка для преобразования в объект
+     * @param {any} error Error for conversion to an object
      * */
     static objectify(error: any): any;
 }

package/lib/errors/CoreError.js

@@ -1,44 +1,57 @@
 "use strict";
 /*
- * Copyright © 2022 Boris Bobylev. All rights reserved.
+ * Copyright © 2024 Boris Bobylev. All rights reserved.
  * Licensed under the Apache License, Version 2.0
 */
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
- * Базовый класс для реализаиции ошибок с возможностью
- * импортирования и экспортирования классов ошибок для
- * клиент-серверных операций.
+ * Base class for error realization with the ability to
+ * import and export error classes for client-server operations.
  *
- * В VRack очень много передается по сети в виде JSON.  Поскольку
- * в чистом виде ошибки не преобрзауются в JSON, были сделаны методы
- * для экспортирования и импортирования с сохранения основных важных свойств.
+ * In VRack, a lot of things are transmitted over the network as JSON.
+ * Since pure errors are not converted to JSON, methods were made to export and
+ * import them while preserving the main important properties.
  *
- * Если импортируемая ошибка имеет свойства которых нет в базовом классе, буду добавлены.
- * Для получения неизвестных свойств можно воспользоватся функцией (для typescript) getUnknownProperty
- *
- * Для работы с ошибками VRack рекомендуется использовать ErrorManager
+ * If the imported error has properties that are not in the base class,
+ * they will be added. To get unknown properties you can use the function
+ * (for typescript) getUnknownProperty.
  *
 */
 class CoreError extends Error {
     constructor(name, message, code, short) {
         super(message);
-        /** Флаг того что ошибка пренадлежит VRack */
+        /** Flag that the error belongs to VRack */
         this.vError = true;
-        /** Код ошибки VRack */
+        /** Error code */
         this.vCode = "";
-        /** Кородкий код VRack */
+        /** Short code */
         this.vShort = "";
-        /** Список дополнительных параметров */
+        /** List of additional parameters */
         this.vAdd = [];
-        /**  */
+        /** Nested errors */
         this.vAddErrors = [];
         this.name = name;
         this.vCode = code;
         this.vShort = short;
     }
     /**
-     * Импортирует ошибку пришедшую по сети в виде JSON объекта
-     * На всякий случай использует objectify для приходящего объекта
+     * Sets the stacktrace of the error above
+     * It is necessary for the stacktrace to refer to the
+     * required file and not to ErrorManager
+     *
+     * @param err Error
+     * @example Example of assigning a more correct path to the file where the error occurred
+     * ```
+     *     ErrorManager.make('EM_CODE_NOT_FOUND').setTrace(new Error())
+     * ```
+    */
+    setTrace(err) {
+        this.stack = err.stack;
+        return this;
+    }
+    /**
+     * Imports an error that came over the network as a JSON object
+     * Uses objectify for the incoming object just in case
      *
      * @returns {CoreError} this после модификации
     */
@@ -48,28 +61,35 @@ class CoreError extends Error {
         return this;
     }
     /**
-     * Возвращает объект для передачи его по сети с предварительным
-     * преобразованием в JSON
+     * Returns an object to be transmitted over the network
+     * with preliminary conversion to JSON
+     *
+     * @see objectify
     */
     export() {
         return CoreError.objectify(this);
     }
+    /**
+     * Add nested error
+     *
+     * @param err Nested error
+    */
     add(err) {
         this.vAddErrors.push(CoreError.objectify(err));
         return this;
     }
     /**
-     * Для Typescript используется для получения неизвестного
-     * свойства экземпляра после импорта пришедшей ошибки
+     * For Typescript it is used to retrieve an unknown
+     * instance property after importing an incoming error
     */
     getUnknownProperty(field) {
         const dynamicKey = field;
         return this[dynamicKey];
     }
     /**
-     *  Возвращает объект для передачи его по сети
+     *  Returns an object to be transmitted over the network
      *
-     * @param {any} error Ошибка для преобразования в объект
+     * @param {any} error Error for conversion to an object
      * */
     static objectify(error) {
         const result = {};

package/lib/errors/ErrorManager.d.ts

@@ -1,45 +1,43 @@
 import BasicType from "../validator/types/BasicType";
 import CoreError from "./CoreError";
 /**
- * Класс является точкой входа для инициализации исключений
- *
- * Было принято решение вместо кучи мелких однотипных файлов сделать один класс
- * со стандартным функционалом
+ * A simple class for creating errors.
+ * This centralized class is useful because you can find out t
+ * he list of all registered errors and which group/component they belong to.
  */
 declare class ErrorManager {
+    /**
+     * List of registered errors
+    */
     private registeredList;
     /**
-     * Регистрирует тип ошибки компонента
-     *
-     * Перед тем как менеджер ошибок может создать ошибки, необходимо зарегистрировать ее тип.
-     *
-     * @param {string} name Название компонента
-     * @param {string} code Код ошибки
-     * @param {string} short Короткий код ошибки
-     * @param {string} description Описание ошибки
+     * Error registration. An error must be registered before creating it
      *
+     * @param name Property for error grouping
+     * @param code Unique random string code ID
+     * @param short Readable unique identifier
+     * @param description Error string (description)
     */
     register(name: string, code: string, short: string, description: string, rules?: {
         [key: string]: BasicType;
     }): void;
     /**
-     * Создание ошибки
-     *
-     *
+     * Creating an instance of an error
      *
-     * @param {string} short
+     * @param short
+     * @param additional
     */
     make(short: string, additional?: {}): CoreError;
     /**
-     * Преобразует обычную ошибку в ошибку VRack
+     * Converts a normal error to a VRack error
      *
-     * @param {Error} error Ошибка для преобразования
+     * @param error Ошибка для преобразования
     */
     convert(error: any): any;
     /**
-     * Возвращает тип ошибки или null
+     * Searches for an error by code or short
      *
-     * @param {string} short Короткий код ошибки или код ошибки поиска
+     * @param short Short error code or search error code
     */
     private getRegistered;
 }

package/lib/errors/ErrorManager.js

@@ -9,25 +9,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const CoreError_1 = __importDefault(require("./CoreError"));
 /**
- * Класс является точкой входа для инициализации исключений
- *
- * Было принято решение вместо кучи мелких однотипных файлов сделать один класс
- * со стандартным функционалом
+ * A simple class for creating errors.
+ * This centralized class is useful because you can find out t
+ * he list of all registered errors and which group/component they belong to.
  */
 class ErrorManager {
     constructor() {
+        /**
+         * List of registered errors
+        */
         this.registeredList = [];
     }
     /**
-     * Регистрирует тип ошибки компонента
-     *
-     * Перед тем как менеджер ошибок может создать ошибки, необходимо зарегистрировать ее тип.
-     *
-     * @param {string} name Название компонента
-     * @param {string} code Код ошибки
-     * @param {string} short Короткий код ошибки
-     * @param {string} description Описание ошибки
+     * Error registration. An error must be registered before creating it
      *
+     * @param name Property for error grouping
+     * @param code Unique random string code ID
+     * @param short Readable unique identifier
+     * @param description Error string (description)
     */
     register(name, code, short, description, rules = {}) {
         const reg1 = this.getRegistered(code);
@@ -38,24 +37,27 @@ class ErrorManager {
         this.registeredList.push(nr);
     }
     /**
-     * Создание ошибки
-     *
+     * Creating an instance of an error
      *
-     *
-     * @param {string} short
+     * @param short
+     * @param additional
     */
     make(short, additional = {}) {
         const reg = this.getRegistered(short);
         if (reg === null)
             throw this.make('EM_CODE_NOT_FOUND');
         const ne = new CoreError_1.default(reg.name, reg.description, reg.code, reg.short);
+        // Убираем из стека вызовы ErrorManager.make()
+        if (typeof Error.captureStackTrace === 'function') {
+            Error.captureStackTrace(ne, this.make);
+        }
         ne.vAdd = Object.keys(additional);
         return Object.assign(ne, additional);
     }
     /**
-     * Преобразует обычную ошибку в ошибку VRack
+     * Converts a normal error to a VRack error
      *
-     * @param {Error} error Ошибка для преобразования
+     * @param error Ошибка для преобразования
     */
     convert(error) {
         if (error.vError)
@@ -65,15 +67,14 @@ class ErrorManager {
         return ne;
     }
     /**
-     * Возвращает тип ошибки или null
+     * Searches for an error by code or short
      *
-     * @param {string} short Короткий код ошибки или код ошибки поиска
+     * @param short Short error code or search error code
     */
     getRegistered(short) {
-        for (const registered of this.registeredList) {
+        for (const registered of this.registeredList)
             if (registered.code === short || registered.short === short)
                 return registered;
-        }
         return null;
     }
 }

package/lib/index.d.ts

@@ -2,18 +2,34 @@ export { default as ErrorManager } from './errors/ErrorManager';
 export { default as CoreError } from './errors/CoreError';
 export { default as Rule } from './validator/Rule';
 export { default as Validator } from './validator/Validator';
-export { default as IValidationProblem } from './validator/IValidationProblem';
-export { default as IValidationRule } from './validator/IValidationRule';
-export { default as IValidationSubrule } from './validator/IValidationSubrule';
 export { default as ImportManager } from './ImportManager';
-export { default as DeviceManager } from './DeviceManager';
 export { default as Container } from './Container';
 export { default as MainProcess } from './MainProcess';
+export { default as Bootstrap } from './Bootstrap';
+export { default as BootClass } from './boot/BootClass';
+export { default as DeviceFileStorage } from './boot/DeviceFileStorage';
+export { default as DeviceManager } from './boot/DeviceManager';
+export { default as StructureStorage } from './boot/StructureStorage';
+export { default as DeviceMetrics } from './boot/DeviceMetrics';
 export { default as Action } from './actions/Action';
 export { default as Device } from './service/Device';
 export { default as DeviceConnect } from './service/DeviceConnect';
 export { default as DevicePort } from './service/DevicePort';
 export { default as Port } from './ports/Port';
+export { default as Metric } from './metrics/Metric';
+export { default as BasicPort } from './ports/BasicPort';
+export { default as BasicType } from './validator/types/BasicType';
+export { default as BasicMetric } from './metrics/BasicMetric';
+export { default as BasicAction } from './actions/BasicAction';
+export { default as IMetricSettings } from './metrics/IMetricSettings';
+export { default as IPort } from './ports/IPort';
+export { default as IDeviceEvent } from './service/IDeviceEvent';
+export { default as IValidationProblem } from './validator/IValidationProblem';
+export { default as IValidationRule } from './validator/IValidationRule';
+export { default as IValidationSubrule } from './validator/IValidationSubrule';
+export { default as IServiceStructure } from './IServiceStructure';
+export { default as IStructureDevice } from './IStructureDevice';
+export { StorageTypes } from 'vrack-db';
 export * from './service/Device';
 export * from './service/DeviceConnect';
 export * from './service/DevicePort';

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright © 2022 Boris Bobylev. All rights reserved.
+ * Copyright © 2024 Boris Bobylev. All rights reserved.
  * Licensed under the Apache License, Version 2.0
 */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
@@ -21,7 +21,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Port = exports.DevicePort = exports.DeviceConnect = exports.Device = exports.Action = exports.MainProcess = exports.Container = exports.DeviceManager = exports.ImportManager = exports.Validator = exports.Rule = exports.CoreError = exports.ErrorManager = void 0;
+exports.StorageTypes = exports.BasicAction = exports.BasicMetric = exports.BasicType = exports.BasicPort = exports.Metric = exports.Port = exports.DevicePort = exports.DeviceConnect = exports.Device = exports.Action = exports.DeviceMetrics = exports.StructureStorage = exports.DeviceManager = exports.DeviceFileStorage = exports.BootClass = exports.Bootstrap = exports.MainProcess = exports.Container = exports.ImportManager = exports.Validator = exports.Rule = exports.CoreError = exports.ErrorManager = void 0;
 /* ---------------- VALIDATOR EXPORT ------------------- */
 var ErrorManager_1 = require("./errors/ErrorManager");
 Object.defineProperty(exports, "ErrorManager", { enumerable: true, get: function () { return __importDefault(ErrorManager_1).default; } });
@@ -34,12 +34,24 @@ Object.defineProperty(exports, "Validator", { enumerable: true, get: function ()
 /* ---------------- BASE OF VRACK ------------------- */
 var ImportManager_1 = require("./ImportManager");
 Object.defineProperty(exports, "ImportManager", { enumerable: true, get: function () { return __importDefault(ImportManager_1).default; } });
-var DeviceManager_1 = require("./DeviceManager");
-Object.defineProperty(exports, "DeviceManager", { enumerable: true, get: function () { return __importDefault(DeviceManager_1).default; } });
 var Container_1 = require("./Container");
 Object.defineProperty(exports, "Container", { enumerable: true, get: function () { return __importDefault(Container_1).default; } });
 var MainProcess_1 = require("./MainProcess");
 Object.defineProperty(exports, "MainProcess", { enumerable: true, get: function () { return __importDefault(MainProcess_1).default; } });
+/* ---------------- BOOTSTRAP ------------------- */
+var Bootstrap_1 = require("./Bootstrap");
+Object.defineProperty(exports, "Bootstrap", { enumerable: true, get: function () { return __importDefault(Bootstrap_1).default; } });
+var BootClass_1 = require("./boot/BootClass");
+Object.defineProperty(exports, "BootClass", { enumerable: true, get: function () { return __importDefault(BootClass_1).default; } });
+var DeviceFileStorage_1 = require("./boot/DeviceFileStorage");
+Object.defineProperty(exports, "DeviceFileStorage", { enumerable: true, get: function () { return __importDefault(DeviceFileStorage_1).default; } });
+var DeviceManager_1 = require("./boot/DeviceManager");
+Object.defineProperty(exports, "DeviceManager", { enumerable: true, get: function () { return __importDefault(DeviceManager_1).default; } });
+var StructureStorage_1 = require("./boot/StructureStorage");
+Object.defineProperty(exports, "StructureStorage", { enumerable: true, get: function () { return __importDefault(StructureStorage_1).default; } });
+var DeviceMetrics_1 = require("./boot/DeviceMetrics");
+Object.defineProperty(exports, "DeviceMetrics", { enumerable: true, get: function () { return __importDefault(DeviceMetrics_1).default; } });
+/* ---------------- INTERNAL SERVICE ------------------- */
 var Action_1 = require("./actions/Action");
 Object.defineProperty(exports, "Action", { enumerable: true, get: function () { return __importDefault(Action_1).default; } });
 var Device_1 = require("./service/Device");
@@ -50,6 +62,18 @@ var DevicePort_1 = require("./service/DevicePort");
 Object.defineProperty(exports, "DevicePort", { enumerable: true, get: function () { return __importDefault(DevicePort_1).default; } });
 var Port_1 = require("./ports/Port");
 Object.defineProperty(exports, "Port", { enumerable: true, get: function () { return __importDefault(Port_1).default; } });
+var Metric_1 = require("./metrics/Metric");
+Object.defineProperty(exports, "Metric", { enumerable: true, get: function () { return __importDefault(Metric_1).default; } });
+var BasicPort_1 = require("./ports/BasicPort");
+Object.defineProperty(exports, "BasicPort", { enumerable: true, get: function () { return __importDefault(BasicPort_1).default; } });
+var BasicType_1 = require("./validator/types/BasicType");
+Object.defineProperty(exports, "BasicType", { enumerable: true, get: function () { return __importDefault(BasicType_1).default; } });
+var BasicMetric_1 = require("./metrics/BasicMetric");
+Object.defineProperty(exports, "BasicMetric", { enumerable: true, get: function () { return __importDefault(BasicMetric_1).default; } });
+var BasicAction_1 = require("./actions/BasicAction");
+Object.defineProperty(exports, "BasicAction", { enumerable: true, get: function () { return __importDefault(BasicAction_1).default; } });
+var vrack_db_1 = require("vrack-db");
+Object.defineProperty(exports, "StorageTypes", { enumerable: true, get: function () { return vrack_db_1.StorageTypes; } });
 __exportStar(require("./service/Device"), exports);
 __exportStar(require("./service/DeviceConnect"), exports);
 __exportStar(require("./service/DevicePort"), exports);

package/lib/metrics/BasicMetric.d.ts

@@ -0,0 +1,49 @@
+import { StorageTypes } from "vrack-db";
+import IMetricSettings from "./IMetricSettings";
+/**
+ * Metric base class. Used internally to define device metrics.
+*/
+export default class BasicMetric {
+    /**
+     * Default metric setting
+    */
+    protected metric: IMetricSettings;
+    /**
+     * Defines the type of time storage
+     *
+     * @param type StorageTypes type like a StorageTypes.Uint64 (default)
+    */
+    timeStorage(type: StorageTypes): this;
+    /**
+     *  Defines the type of value storage
+     *
+     * @param type StorageTypes type like a StorageTypes.Uint64 (default)
+    */
+    valueStorage(type: StorageTypes): this;
+    /**
+     * Specifies the accuracy and storage period size of Graphite-style metrics
+     *
+     *
+     * @see SingleDB.metric
+     * @param req retentions Graphite-style `5s:10m, 1m:2h, 15m:1d, 1h:1w, 6h:1mon, 1d:1y`
+    */
+    retentions(req: string): this;
+    /**
+     * Metric Description
+     *
+     * @param des Short text description of the metric
+    */
+    description(des: string): this;
+    /**
+     * To add additional data to the metric, you can specify
+     * any object describing the metric in this method.
+     *
+     * @param add Additional information for the metric
+    */
+    additional(add: any): this;
+    /**
+     * Returns the internal metric settings object. Used inside Container
+     * @private
+    */
+    export(): IMetricSettings;
+}