vrack2-core 0.0.1 → 1.0.1

package/lib/metrics/BasicMetric.js

@@ -0,0 +1,79 @@
+"use strict";
+/*
+ * Copyright © 2025 Boris Bobylev. All rights reserved.
+ * Licensed under the Apache License, Version 2.0
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+const vrack_db_1 = require("vrack-db");
+/**
+ * Metric base class. Used internally to define device metrics.
+*/
+class BasicMetric {
+    constructor() {
+        /**
+         * Default metric setting
+        */
+        this.metric = {
+            retentions: '5s:10m, 1m:2h, 15m:1d, 1h:1w, 6h:1mon, 1d:1y',
+            interval: 's',
+            vType: vrack_db_1.StorageTypes.Float,
+            tType: vrack_db_1.StorageTypes.Uint64
+        };
+    }
+    /**
+     * Defines the type of time storage
+     *
+     * @param type StorageTypes type like a StorageTypes.Uint64 (default)
+    */
+    timeStorage(type) {
+        this.metric.tType = type;
+        return this;
+    }
+    /**
+     *  Defines the type of value storage
+     *
+     * @param type StorageTypes type like a StorageTypes.Uint64 (default)
+    */
+    valueStorage(type) {
+        this.metric.vType = type;
+        return 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) {
+        this.metric.retentions = req;
+        return this;
+    }
+    /**
+     * Metric Description
+     *
+     * @param des Short text description of the metric
+    */
+    description(des) {
+        this.metric.description = des;
+        return 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) {
+        this.metric.additional = add;
+        return this;
+    }
+    /**
+     * Returns the internal metric settings object. Used inside Container
+     * @private
+    */
+    export() {
+        return this.metric;
+    }
+}
+exports.default = BasicMetric;

package/lib/metrics/IMetricSettings.d.ts

@@ -0,0 +1,32 @@
+import { StorageTypes } from "vrack-db";
+export default interface IMetricSettings {
+    /**
+     *  Specifies the accuracy and storage period size of Graphite-style metrics
+     *  @see SingleDB.metric
+    */
+    retentions: string;
+    /**
+     * Interval that defines the minimal time unit
+     *
+     * s - second
+     * ms - millisecond
+     * us - microsecond
+    */
+    interval: 's' | 'ms' | 'us';
+    /**
+     * Defines the type of value storage
+     * StorageTypes type like a StorageTypes.Uint64 (default)
+    */
+    vType: StorageTypes;
+    /**
+     * Defines the type of time storage
+     * StorageTypes type like a StorageTypes.Uint64 (default)
+    */
+    tType: StorageTypes;
+    /** Metric Description */
+    description?: string;
+    /**
+     * Additional information for the metric
+    */
+    additional?: any;
+}

package/lib/metrics/IMetricSettings.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/metrics/IvMs.d.ts

@@ -0,0 +1,9 @@
+import BasicMetric from "./BasicMetric";
+/**
+ * Creating a new metric with minimum time unit in milliseconds
+ *
+ * @see BasicMetric
+*/
+export default class IvMS extends BasicMetric {
+    constructor();
+}

package/lib/metrics/IvMs.js

@@ -0,0 +1,22 @@
+"use strict";
+/*
+ * Copyright © 2025 Boris Bobylev. All rights reserved.
+ * Licensed under the Apache License, Version 2.0
+*/
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BasicMetric_1 = __importDefault(require("./BasicMetric"));
+/**
+ * Creating a new metric with minimum time unit in milliseconds
+ *
+ * @see BasicMetric
+*/
+class IvMS extends BasicMetric_1.default {
+    constructor() {
+        super();
+        this.metric.interval = 'ms';
+    }
+}
+exports.default = IvMS;

package/lib/metrics/IvS.d.ts

@@ -0,0 +1,9 @@
+import BasicInterval from "./BasicMetric";
+/**
+ * Creating a new metric with minimum time unit in Seconds
+ *
+ * @see BasicMetric
+*/
+export default class IvS extends BasicInterval {
+    constructor();
+}

package/lib/metrics/IvS.js

@@ -0,0 +1,22 @@
+"use strict";
+/*
+ * Copyright © 2025 Boris Bobylev. All rights reserved.
+ * Licensed under the Apache License, Version 2.0
+*/
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BasicMetric_1 = __importDefault(require("./BasicMetric"));
+/**
+ * Creating a new metric with minimum time unit in Seconds
+ *
+ * @see BasicMetric
+*/
+class IvS extends BasicMetric_1.default {
+    constructor() {
+        super();
+        this.metric.interval = 's';
+    }
+}
+exports.default = IvS;

package/lib/metrics/IvUs.d.ts

@@ -0,0 +1,9 @@
+import BasicInterval from "./BasicMetric";
+/**
+ * Creating a new metric with minimum time unit in Microseconds
+ *
+ * @see BasicMetric
+*/
+export default class IvUs extends BasicInterval {
+    constructor();
+}

package/lib/metrics/IvUs.js

@@ -0,0 +1,22 @@
+"use strict";
+/*
+ * Copyright © 2025 Boris Bobylev. All rights reserved.
+ * Licensed under the Apache License, Version 2.0
+*/
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BasicMetric_1 = __importDefault(require("./BasicMetric"));
+/**
+ * Creating a new metric with minimum time unit in Microseconds
+ *
+ * @see BasicMetric
+*/
+class IvUs extends BasicMetric_1.default {
+    constructor() {
+        super();
+        this.metric.interval = 'us';
+    }
+}
+exports.default = IvUs;

package/lib/metrics/Metric.d.ts

@@ -0,0 +1,17 @@
+import IvMS from "./IvMs";
+import IvS from "./IvS";
+import IvUs from "./IvUs";
+export default class Metric {
+    /**
+     * Creating a new metric with minimum time unit in Seconds
+    */
+    static inS(): IvS;
+    /**
+     * Creating a new metric with minimum time unit in Milliseconds
+    */
+    static inMs(): IvMS;
+    /**
+     * Creating a new metric with minimum time unit in Microsecond
+    */
+    static inUs(): IvUs;
+}

package/lib/metrics/Metric.js

@@ -0,0 +1,27 @@
+"use strict";
+/*
+ * Copyright © 2025 Boris Bobylev. All rights reserved.
+ * Licensed under the Apache License, Version 2.0
+*/
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const IvMs_1 = __importDefault(require("./IvMs"));
+const IvS_1 = __importDefault(require("./IvS"));
+const IvUs_1 = __importDefault(require("./IvUs"));
+class Metric {
+    /**
+     * Creating a new metric with minimum time unit in Seconds
+    */
+    static inS() { return new IvS_1.default(); }
+    /**
+     * Creating a new metric with minimum time unit in Milliseconds
+    */
+    static inMs() { return new IvMs_1.default(); }
+    /**
+     * Creating a new metric with minimum time unit in Microsecond
+    */
+    static inUs() { return new IvUs_1.default(); }
+}
+exports.default = Metric;

package/lib/ports/BasicPort.d.ts

@@ -1,11 +1,50 @@
 import BasicType from "../validator/types/BasicType";
 import ILocalPort from "./ILocalPort";
 import IPort from "./IPort";
+/**
+ * Port basic class.  Used internally to define device ports.
+*/
 export default class BasicPort {
     protected port: ILocalPort;
     constructor();
+    /**
+     * Sets this port to dynamic
+     *
+     * If you specify a port to be dynamic, you must specify the number of those ports.
+     * Also if you specify a port as dynamic, you must specify `%d` in the name,
+     * which will be replaced by the port number.
+     *
+     * @example
+     * ```ts
+     * {
+     *   'command%d': Port.return().dynamic(this.options.inputs)
+     * }
+     * ```
+     *
+     * @param count Count of ports
+    */
     dynamic(count: number): this;
+    /**
+     * Specifies a recommendation to the data passing through the port.
+     * This data is not actually validated by these rules,
+     * but these rules can be used in the documentation to clarify perception.
+     *
+     * @param req BasicType type
+    */
     requirement(req: BasicType): this;
+    /**
+     * Port descriptions
+    */
     description(des: string): this;
+    /**
+     * Exports the port data.
+     * Collects all data into an IPort object.
+     * Internal types of type BasicType are also exported to the corresponding properties
+     *
+     * @see IPort
+     *
+     * !hide for external users
+     * @private
+    */
     export(): IPort;
 }

package/lib/ports/BasicPort.js

@@ -8,6 +8,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const BasicType_1 = __importDefault(require("../validator/types/BasicType"));
+/**
+ * Port basic class.  Used internally to define device ports.
+*/
 class BasicPort {
     constructor() {
         this.port = {
@@ -18,19 +21,55 @@ class BasicPort {
             count: 0
         };
     }
+    /**
+     * Sets this port to dynamic
+     *
+     * If you specify a port to be dynamic, you must specify the number of those ports.
+     * Also if you specify a port as dynamic, you must specify `%d` in the name,
+     * which will be replaced by the port number.
+     *
+     * @example
+     * ```ts
+     * {
+     *   'command%d': Port.return().dynamic(this.options.inputs)
+     * }
+     * ```
+     *
+     * @param count Count of ports
+    */
     dynamic(count) {
         this.port.count = count;
         this.port.dynamic = true;
         return this;
     }
+    /**
+     * Specifies a recommendation to the data passing through the port.
+     * This data is not actually validated by these rules,
+     * but these rules can be used in the documentation to clarify perception.
+     *
+     * @param req BasicType type
+    */
     requirement(req) {
         this.port.requirement = req;
         return this;
     }
+    /**
+     * Port descriptions
+    */
     description(des) {
         this.port.description = des;
         return this;
     }
+    /**
+     * Exports the port data.
+     * Collects all data into an IPort object.
+     * Internal types of type BasicType are also exported to the corresponding properties
+     *
+     * @see IPort
+     *
+     * !hide for external users
+     * @private
+    */
     export() {
         const nPort = {
             type: this.port.type,

package/lib/ports/ILocalPort.d.ts

@@ -1,10 +1,17 @@
 import BasicType from "../validator/types/BasicType";
 export default interface ILocalPort {
+    /** Port Type - Returned or Standard */
     type: string;
+    /** Specifies a recommendation to the data passing through the port.  */
     requirement?: BasicType;
+    /** Specifies a recommendation for the data returned by the port */
     return?: BasicType;
+    /** Port description */
     description: string;
+    /** Is the connection of this port mandatory */
     required: boolean;
+    /** Whether the port is dynamic */
     dynamic: boolean;
+    /** Count of dynamic ports */
     count: number;
 }

package/lib/ports/IPort.d.ts

@@ -1,10 +1,17 @@
 import IValidationRule from "../validator/IValidationRule";
 export default interface IPort {
+    /** Port Type - Returned or Standard */
     type: string;
+    /** Specifies a recommendation to the data passing through the port.  */
     requirement?: IValidationRule;
+    /** Specifies a recommendation for the data returned by the port */
     return?: IValidationRule;
+    /** Port description */
     description: string;
+    /** Is the connection of this port mandatory */
     required: boolean;
+    /** Whether the port is dynamic */
     dynamic: boolean;
+    /** Count of dynamic ports */
     count: number;
 }

package/lib/ports/Port.d.ts

@@ -1,6 +1,16 @@
 import ReturnPort from "./ReturnPort";
 import StandartPort from "./StandartPort";
+/**
+ * Creating a new port. Used internally to create a port
+*/
 export default class Port {
+    /**
+     * Standard Port.
+     * Used to cast a value to another port or to signal a value to another port
+    */
     static standart(): StandartPort;
+    /**
+     * Return Port. Used to get the value over connections
+    */
     static return(): ReturnPort;
 }

package/lib/ports/Port.js

@@ -9,10 +9,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const ReturnPort_1 = __importDefault(require("./ReturnPort"));
 const StandartPort_1 = __importDefault(require("./StandartPort"));
+/**
+ * Creating a new port. Used internally to create a port
+*/
 class Port {
+    /**
+     * Standard Port.
+     * Used to cast a value to another port or to signal a value to another port
+    */
     static standart() {
         return new StandartPort_1.default();
     }
+    /**
+     * Return Port. Used to get the value over connections
+    */
     static return() {
         return new ReturnPort_1.default();
     }

package/lib/ports/ReturnPort.d.ts

@@ -2,5 +2,10 @@ import BasicType from "../validator/types/BasicType";
 import BasicPort from "./BasicPort";
 export default class ReturnPort extends BasicPort {
     constructor();
+    /**
+     * Specifies a recommendation to the data return from the port.
+     *
+     * @param req BasicType type
+    */
     return(req: BasicType): this;
 }

package/lib/ports/ReturnPort.js

@@ -13,6 +13,11 @@ class ReturnPort extends BasicPort_1.default {
         super();
         this.port.type = 'return';
     }
+    /**
+     * Specifies a recommendation to the data return from the port.
+     *
+     * @param req BasicType type
+    */
     return(req) {
         this.port.return = req;
         return this;