@uns-kit/core 2.0.38 → 2.0.40

package/dist/uns/uns-proxy-process.js

@@ -1,204 +1,204 @@
-import logger from "../logger.js";
-import { randomBytes } from "crypto";
-import MqttProxy from "../uns-mqtt/mqtt-proxy.js";
-import UnsMqttProxy from "../uns-mqtt/uns-mqtt-proxy.js";
-import { HandoverManager } from "./handover-manager.js";
-// Import configuration and initialization modules.
-import { PACKAGE_INFO, MQTT_UPDATE_INTERVAL } from "./process-config.js";
-import { MqttTopicBuilder } from "../uns-mqtt/mqtt-topic-builder.js";
-import { StatusMonitor } from "./status-monitor.js";
-import { UnsPacket } from "./uns-packet.js";
-class UnsProxyProcess {
-    active = false;
-    processStatusTopic;
-    processName;
-    processId;
-    unsMqttProxies;
-    unsApiProxies;
-    unsTemporalProxies;
-    processMqttProxy;
-    handoverManager;
-    statusMonitor;
-    // Plugin
-    static pluginApiVersion = 1;
-    static registered = new Set();
-    static registeredMethodNames = new Set();
-    static applied = false;
-    static use(plugin) {
-        if (this.registered.has(plugin))
-            return this;
-        this.registered.add(plugin);
-        if (this.applied)
-            this.applyPlugin(plugin);
-        return this;
-    }
-    static applyPlugin(plugin) {
-        const define = (methods) => {
-            for (const [name, fn] of Object.entries(methods)) {
-                if (typeof fn !== "function") {
-                    throw new TypeError(`UnsProxyProcess plugin attempted to register non-function member \"${name}\".`);
-                }
-                if (this.registeredMethodNames.has(name) || Reflect.has(this.prototype, name)) {
-                    throw new Error(`UnsProxyProcess plugin attempted to overwrite existing member \"${name}\".`);
-                }
-                Object.defineProperty(this.prototype, name, {
-                    value: fn,
-                    writable: true,
-                    configurable: true,
-                    enumerable: false,
-                });
-                this.registeredMethodNames.add(name);
-            }
-        };
-        plugin({
-            define,
-            version: this.pluginApiVersion,
-            UnsProxyProcess: this,
-        });
-    }
-    static applyAll() {
-        if (this.applied)
-            return;
-        this.applied = true;
-        for (const p of this.registered)
-            this.applyPlugin(p);
-    }
-    // References for cleanup.
-    mqttInputHandler;
-    constructor(mqttHost, unsProxyProcessParameters) {
-        this.constructor.applyAll(); // Activate all the plugins
-        this.unsMqttProxies = [];
-        this.unsApiProxies = [];
-        this.unsTemporalProxies = [];
-        if (!unsProxyProcessParameters?.processName) {
-            throw new Error("UnsProxyProcess requires a processName in configuration.");
-        }
-        this.processName = unsProxyProcessParameters.processName;
-        this.processId = randomBytes(16).toString("hex");
-        const { name: packageName, version } = PACKAGE_INFO;
-        // Instantiate the topic builder.
-        const topicBuilder = new MqttTopicBuilder(`uns-infra/${MqttTopicBuilder.sanitizeTopicPart(packageName)}/${MqttTopicBuilder.sanitizeTopicPart(version)}/${MqttTopicBuilder.sanitizeTopicPart(this.processName)}/`);
-        // Generate topics.
-        const processStatusTopic = topicBuilder.getProcessStatusTopic();
-        const handoverTopic = topicBuilder.getHandoverTopic();
-        const wildcardActiveTopic = topicBuilder.getWildcardActiveTopic();
-        this.processStatusTopic = processStatusTopic;
-        // Configure MQTT topics for subscription.
-        const mqttSubToTopics = unsProxyProcessParameters?.mqttSubToTopics ?? [
-            wildcardActiveTopic,
-            handoverTopic,
-        ];
-        const mqttParameters = {
-            mqttSubToTopics,
-            username: unsProxyProcessParameters?.username ?? "",
-            password: unsProxyProcessParameters?.password ?? "",
-            mqttSSL: unsProxyProcessParameters?.mqttSSL ?? false,
-            statusTopic: this.processStatusTopic,
-            clientId: unsProxyProcessParameters?.clientId ?? `${this.processName}-${this.processId}`,
-            hosts: unsProxyProcessParameters?.hosts,
-            servers: unsProxyProcessParameters?.servers,
-            port: unsProxyProcessParameters?.port,
-            protocol: unsProxyProcessParameters?.protocol,
-            keepalive: unsProxyProcessParameters?.keepalive,
-            clean: unsProxyProcessParameters?.clean,
-            connectTimeout: unsProxyProcessParameters?.connectTimeout,
-            reconnectPeriod: unsProxyProcessParameters?.reconnectPeriod,
-            reconnectOnConnackError: unsProxyProcessParameters?.reconnectOnConnackError,
-            resubscribe: unsProxyProcessParameters?.resubscribe,
-            queueQoSZero: unsProxyProcessParameters?.queueQoSZero,
-            rejectUnauthorized: unsProxyProcessParameters?.rejectUnauthorized ?? false,
-            properties: unsProxyProcessParameters?.properties,
-            ca: unsProxyProcessParameters?.ca,
-            cert: unsProxyProcessParameters?.cert,
-            key: unsProxyProcessParameters?.key,
-            servername: unsProxyProcessParameters?.servername,
-        };
-        // Initialize MQTT proxy and start connection.
-        this.processMqttProxy = new MqttProxy(mqttHost, this.processName, mqttParameters);
-        this.processMqttProxy.start();
-        // Instantiate and start the StatusMonitor for memory and status updates.
-        this.statusMonitor = new StatusMonitor(this.processMqttProxy, this.processStatusTopic, () => this.active, MQTT_UPDATE_INTERVAL, MQTT_UPDATE_INTERVAL, { processName: this.processName, processId: this.processId });
-        this.statusMonitor.start();
-    }
-    /**
-     * Initializes the HandoverManager instance and sets up event listeners for handover and MQTT input events.
-     * Determines handover and force start modes based on process arguments.
-     */
-    initHandoverManager(instanceMode, handover) {
-        const handoverRequestEnabled = instanceMode == "handover" ? true : false;
-        const forceStartEnabled = instanceMode == "force" ? true : false;
-        this.handoverManager = new HandoverManager(this.processName, this.processId, this.processMqttProxy, this.unsMqttProxies, handoverRequestEnabled, handover ?? true, forceStartEnabled);
-        // Listen for handover events.
-        this.handoverManager.event.on("handoverManager", (event) => {
-            this.active = event.active;
-        });
-        // Delegate MQTT events to the HandoverManager.
-        this.mqttInputHandler = async (event) => {
-            await this.handoverManager.handleMqttMessage(event);
-        };
-        this.processMqttProxy.event.on("input", this.mqttInputHandler);
-    }
-    /**
-     * Creates a new UNS proxy instance and stores it for future management.
-     */
-    async createUnsMqttProxy(mqttHost, instanceName, instanceMode, handover, unsParameters) {
-        // Wait until the MQTT connection is established before proceeding.
-        await this.waitForProcessConnection();
-        // Currently handover manager can handle only mqtt events
-        if (!this.handoverManager) {
-            this.initHandoverManager(instanceMode, handover);
-        }
-        const resolvedUnsParameters = {
-            ...(unsParameters ?? {}),
-            clientId: unsParameters?.clientId ?? `${this.processName}-${instanceName}-${this.processId}`,
-        };
-        const unsMqttProxy = new UnsMqttProxy(mqttHost, this.processName, instanceName, resolvedUnsParameters);
-        // Listen for UNS proxy producing topics and publish them via MQTT.
-        unsMqttProxy.event.on("unsProxyProducedTopics", (event) => {
-            this.processMqttProxy.publish(event.statusTopic, JSON.stringify(event.producedTopics));
-        });
-        // Listen for UNS proxy status events and publish them via MQTT.
-        unsMqttProxy.event.on("mqttProxyStatus", (event) => {
-            const time = UnsPacket.formatToISO8601(new Date());
-            const unsMessage = { data: { time, value: event.value, uom: event.uom } };
-            UnsPacket.unsPacketFromUnsMessage(unsMessage).then((packet) => {
-                this.processMqttProxy.publish(event.statusTopic, JSON.stringify(packet));
-            });
-        });
-        this.unsMqttProxies.push(unsMqttProxy);
-        return unsMqttProxy;
-    }
-    async waitForProcessConnection() {
-        while (!this.processMqttProxy?.isConnected) {
-            await new Promise((resolve) => setTimeout(resolve, 100));
-        }
-    }
-    /**
-     * Shuts down the process by clearing intervals, timeouts, and removing
-     * MQTT event listeners, and stopping the StatusMonitor.
-     */
-    shutdown() {
-        logger.info(`${this.processName} - Shutting down UnsProxyProcess...`);
-        try {
-            this.statusMonitor.stop();
-        }
-        catch (e) {
-            logger.error(`${this.processName} - Error stopping StatusMonitor: ${e.message}`);
-        }
-        if (this.mqttInputHandler) {
-            this.processMqttProxy.event.off("input", this.mqttInputHandler);
-        }
-        try {
-            if (typeof this.processMqttProxy.stop === "function") {
-                this.processMqttProxy.stop();
-            }
-        }
-        catch (e) {
-            logger.error(`${this.processName} - Error stopping MQTT proxy: ${e.message}`);
-        }
-        logger.info(`${this.processName} - Shutdown complete.`);
-    }
-}
-export default UnsProxyProcess;
-export { UnsProxyProcess };
+import logger from "../logger.js";
+import { randomBytes } from "crypto";
+import MqttProxy from "../uns-mqtt/mqtt-proxy.js";
+import UnsMqttProxy from "../uns-mqtt/uns-mqtt-proxy.js";
+import { HandoverManager } from "./handover-manager.js";
+// Import configuration and initialization modules.
+import { PACKAGE_INFO, MQTT_UPDATE_INTERVAL } from "./process-config.js";
+import { MqttTopicBuilder } from "../uns-mqtt/mqtt-topic-builder.js";
+import { StatusMonitor } from "./status-monitor.js";
+import { UnsPacket } from "./uns-packet.js";
+class UnsProxyProcess {
+    active = false;
+    processStatusTopic;
+    processName;
+    processId;
+    unsMqttProxies;
+    unsApiProxies;
+    unsTemporalProxies;
+    processMqttProxy;
+    handoverManager;
+    statusMonitor;
+    // Plugin
+    static pluginApiVersion = 1;
+    static registered = new Set();
+    static registeredMethodNames = new Set();
+    static applied = false;
+    static use(plugin) {
+        if (this.registered.has(plugin))
+            return this;
+        this.registered.add(plugin);
+        if (this.applied)
+            this.applyPlugin(plugin);
+        return this;
+    }
+    static applyPlugin(plugin) {
+        const define = (methods) => {
+            for (const [name, fn] of Object.entries(methods)) {
+                if (typeof fn !== "function") {
+                    throw new TypeError(`UnsProxyProcess plugin attempted to register non-function member \"${name}\".`);
+                }
+                if (this.registeredMethodNames.has(name) || Reflect.has(this.prototype, name)) {
+                    throw new Error(`UnsProxyProcess plugin attempted to overwrite existing member \"${name}\".`);
+                }
+                Object.defineProperty(this.prototype, name, {
+                    value: fn,
+                    writable: true,
+                    configurable: true,
+                    enumerable: false,
+                });
+                this.registeredMethodNames.add(name);
+            }
+        };
+        plugin({
+            define,
+            version: this.pluginApiVersion,
+            UnsProxyProcess: this,
+        });
+    }
+    static applyAll() {
+        if (this.applied)
+            return;
+        this.applied = true;
+        for (const p of this.registered)
+            this.applyPlugin(p);
+    }
+    // References for cleanup.
+    mqttInputHandler;
+    constructor(mqttHost, unsProxyProcessParameters) {
+        this.constructor.applyAll(); // Activate all the plugins
+        this.unsMqttProxies = [];
+        this.unsApiProxies = [];
+        this.unsTemporalProxies = [];
+        if (!unsProxyProcessParameters?.processName) {
+            throw new Error("UnsProxyProcess requires a processName in configuration.");
+        }
+        this.processName = unsProxyProcessParameters.processName;
+        this.processId = randomBytes(16).toString("hex");
+        const { name: packageName, version } = PACKAGE_INFO;
+        // Instantiate the topic builder.
+        const topicBuilder = new MqttTopicBuilder(`uns-infra/${MqttTopicBuilder.sanitizeTopicPart(packageName)}/${MqttTopicBuilder.sanitizeTopicPart(version)}/${MqttTopicBuilder.sanitizeTopicPart(this.processName)}/`);
+        // Generate topics.
+        const processStatusTopic = topicBuilder.getProcessStatusTopic();
+        const handoverTopic = topicBuilder.getHandoverTopic();
+        const wildcardActiveTopic = topicBuilder.getWildcardActiveTopic();
+        this.processStatusTopic = processStatusTopic;
+        // Configure MQTT topics for subscription.
+        const mqttSubToTopics = unsProxyProcessParameters?.mqttSubToTopics ?? [
+            wildcardActiveTopic,
+            handoverTopic,
+        ];
+        const mqttParameters = {
+            mqttSubToTopics,
+            username: unsProxyProcessParameters?.username ?? "",
+            password: unsProxyProcessParameters?.password ?? "",
+            mqttSSL: unsProxyProcessParameters?.mqttSSL ?? false,
+            statusTopic: this.processStatusTopic,
+            clientId: unsProxyProcessParameters?.clientId ?? `${this.processName}-${this.processId}`,
+            hosts: unsProxyProcessParameters?.hosts,
+            servers: unsProxyProcessParameters?.servers,
+            port: unsProxyProcessParameters?.port,
+            protocol: unsProxyProcessParameters?.protocol,
+            keepalive: unsProxyProcessParameters?.keepalive,
+            clean: unsProxyProcessParameters?.clean,
+            connectTimeout: unsProxyProcessParameters?.connectTimeout,
+            reconnectPeriod: unsProxyProcessParameters?.reconnectPeriod,
+            reconnectOnConnackError: unsProxyProcessParameters?.reconnectOnConnackError,
+            resubscribe: unsProxyProcessParameters?.resubscribe,
+            queueQoSZero: unsProxyProcessParameters?.queueQoSZero,
+            rejectUnauthorized: unsProxyProcessParameters?.rejectUnauthorized ?? false,
+            properties: unsProxyProcessParameters?.properties,
+            ca: unsProxyProcessParameters?.ca,
+            cert: unsProxyProcessParameters?.cert,
+            key: unsProxyProcessParameters?.key,
+            servername: unsProxyProcessParameters?.servername,
+        };
+        // Initialize MQTT proxy and start connection.
+        this.processMqttProxy = new MqttProxy(mqttHost, this.processName, mqttParameters);
+        this.processMqttProxy.start();
+        // Instantiate and start the StatusMonitor for memory and status updates.
+        this.statusMonitor = new StatusMonitor(this.processMqttProxy, this.processStatusTopic, () => this.active, MQTT_UPDATE_INTERVAL, MQTT_UPDATE_INTERVAL, { processName: this.processName, processId: this.processId });
+        this.statusMonitor.start();
+    }
+    /**
+     * Initializes the HandoverManager instance and sets up event listeners for handover and MQTT input events.
+     * Determines handover and force start modes based on process arguments.
+     */
+    initHandoverManager(instanceMode, handover) {
+        const handoverRequestEnabled = instanceMode == "handover" ? true : false;
+        const forceStartEnabled = instanceMode == "force" ? true : false;
+        this.handoverManager = new HandoverManager(this.processName, this.processId, this.processMqttProxy, this.unsMqttProxies, handoverRequestEnabled, handover ?? true, forceStartEnabled);
+        // Listen for handover events.
+        this.handoverManager.event.on("handoverManager", (event) => {
+            this.active = event.active;
+        });
+        // Delegate MQTT events to the HandoverManager.
+        this.mqttInputHandler = async (event) => {
+            await this.handoverManager.handleMqttMessage(event);
+        };
+        this.processMqttProxy.event.on("input", this.mqttInputHandler);
+    }
+    /**
+     * Creates a new UNS proxy instance and stores it for future management.
+     */
+    async createUnsMqttProxy(mqttHost, instanceName, instanceMode, handover, unsParameters) {
+        // Wait until the MQTT connection is established before proceeding.
+        await this.waitForProcessConnection();
+        // Currently handover manager can handle only mqtt events
+        if (!this.handoverManager) {
+            this.initHandoverManager(instanceMode, handover);
+        }
+        const resolvedUnsParameters = {
+            ...(unsParameters ?? {}),
+            clientId: unsParameters?.clientId ?? `${this.processName}-${instanceName}-${this.processId}`,
+        };
+        const unsMqttProxy = new UnsMqttProxy(mqttHost, this.processName, instanceName, resolvedUnsParameters);
+        // Listen for UNS proxy producing topics and publish them via MQTT.
+        unsMqttProxy.event.on("unsProxyProducedTopics", (event) => {
+            this.processMqttProxy.publish(event.statusTopic, JSON.stringify(event.producedTopics));
+        });
+        // Listen for UNS proxy status events and publish them via MQTT.
+        unsMqttProxy.event.on("mqttProxyStatus", (event) => {
+            const time = UnsPacket.formatToISO8601(new Date());
+            const unsMessage = { data: { time, value: event.value, uom: event.uom } };
+            UnsPacket.unsPacketFromUnsMessage(unsMessage).then((packet) => {
+                this.processMqttProxy.publish(event.statusTopic, JSON.stringify(packet));
+            });
+        });
+        this.unsMqttProxies.push(unsMqttProxy);
+        return unsMqttProxy;
+    }
+    async waitForProcessConnection() {
+        while (!this.processMqttProxy?.isConnected) {
+            await new Promise((resolve) => setTimeout(resolve, 100));
+        }
+    }
+    /**
+     * Shuts down the process by clearing intervals, timeouts, and removing
+     * MQTT event listeners, and stopping the StatusMonitor.
+     */
+    shutdown() {
+        logger.info(`${this.processName} - Shutting down UnsProxyProcess...`);
+        try {
+            this.statusMonitor.stop();
+        }
+        catch (e) {
+            logger.error(`${this.processName} - Error stopping StatusMonitor: ${e.message}`);
+        }
+        if (this.mqttInputHandler) {
+            this.processMqttProxy.event.off("input", this.mqttInputHandler);
+        }
+        try {
+            if (typeof this.processMqttProxy.stop === "function") {
+                this.processMqttProxy.stop();
+            }
+        }
+        catch (e) {
+            logger.error(`${this.processName} - Error stopping MQTT proxy: ${e.message}`);
+        }
+        logger.info(`${this.processName} - Shutdown complete.`);
+    }
+}
+export default UnsProxyProcess;
+export { UnsProxyProcess };
 //# sourceMappingURL=uns-proxy-process.js.map

package/dist/uns/uns-proxy.d.ts

@@ -1,52 +1,52 @@
-import { IApiObject, ITopicObject, UnsEvents } from "./uns-interfaces.js";
-import { UnsEventEmitter } from "./uns-event-emitter.js";
-import { UnsAsset } from "./uns-asset.js";
-import { UnsObjectId, UnsObjectType } from "./uns-object.js";
-import { IApiCatchallMapping } from "./uns-interfaces.js";
-export default class UnsProxy {
-    private publishInterval;
-    event: UnsEventEmitter<UnsEvents>;
-    protected instanceStatusTopic: string;
-    protected instanceNameWithSuffix: string;
-    private producedTopics;
-    private producedApiEndpoints;
-    private producedApiCatchall;
-    private readonly controllerNameEnv;
-    private readonly controllerHostEnv;
-    private readonly controllerPortEnv;
-    private readonly controllerPublicBaseEnv;
-    constructor();
-    /**
-     * Publishes the list of produced topics to the MQTT broker.
-     */
-    private emitProducedTopics;
-    /**
-     * Publishes the list of produced API endpoints to the MQTT broker.
-     */
-    private emitProducedApiEndpoints;
-    /**
-     * Publishes the list of catch-all API mappings to the MQTT broker.
-     */
-    private emitProducedApiCatchall;
-    /**
-     * Registers a unique topic and keeps its timestamp current.
-     *
-     * On first call the full entry is created and immediately emitted so the
-     * controller can persist the new schema node.  On subsequent calls only the
-     * timestamp is updated in-place; the 60-second heartbeat interval will carry
-     * the updated value to the controller, making the timestamp reflect the time
-     * of the most recent data publication rather than the one-off registration
-     * moment.
-     *
-     * @param topicObject - The object containing topic details.
-     */
-    protected registerUniqueTopic(topicObject: ITopicObject): void;
-    /**
-     * Registers an API endpoint to handle requests for a specific topic and attribute.
-     */
-    protected registerApiEndpoint(apiObject: IApiObject): void;
-    protected registerApiCatchAll(mapping: IApiCatchallMapping): void;
-    protected unregisterApiEndpoint(topic: string, asset: UnsAsset, objectType: UnsObjectType, objectId: UnsObjectId, attribute: string): void;
-    stop(): Promise<void>;
-}
+import { IApiObject, ITopicObject, UnsEvents } from "./uns-interfaces.js";
+import { UnsEventEmitter } from "./uns-event-emitter.js";
+import { UnsAsset } from "./uns-asset.js";
+import { UnsObjectId, UnsObjectType } from "./uns-object.js";
+import { IApiCatchallMapping } from "./uns-interfaces.js";
+export default class UnsProxy {
+    private publishInterval;
+    event: UnsEventEmitter<UnsEvents>;
+    protected instanceStatusTopic: string;
+    protected instanceNameWithSuffix: string;
+    private producedTopics;
+    private producedApiEndpoints;
+    private producedApiCatchall;
+    private readonly controllerNameEnv;
+    private readonly controllerHostEnv;
+    private readonly controllerPortEnv;
+    private readonly controllerPublicBaseEnv;
+    constructor();
+    /**
+     * Publishes the list of produced topics to the MQTT broker.
+     */
+    private emitProducedTopics;
+    /**
+     * Publishes the list of produced API endpoints to the MQTT broker.
+     */
+    private emitProducedApiEndpoints;
+    /**
+     * Publishes the list of catch-all API mappings to the MQTT broker.
+     */
+    private emitProducedApiCatchall;
+    /**
+     * Registers a unique topic and keeps its timestamp current.
+     *
+     * On first call the full entry is created and immediately emitted so the
+     * controller can persist the new schema node.  On subsequent calls only the
+     * timestamp is updated in-place; the 60-second heartbeat interval will carry
+     * the updated value to the controller, making the timestamp reflect the time
+     * of the most recent data publication rather than the one-off registration
+     * moment.
+     *
+     * @param topicObject - The object containing topic details.
+     */
+    protected registerUniqueTopic(topicObject: ITopicObject): void;
+    /**
+     * Registers an API endpoint to handle requests for a specific topic and attribute.
+     */
+    protected registerApiEndpoint(apiObject: IApiObject): void;
+    protected registerApiCatchAll(mapping: IApiCatchallMapping): void;
+    protected unregisterApiEndpoint(topic: string, asset: UnsAsset, objectType: UnsObjectType, objectId: UnsObjectId, attribute: string): void;
+    stop(): Promise<void>;
+}
 //# sourceMappingURL=uns-proxy.d.ts.map