@uns-kit/api 2.0.0 → 2.0.3

package/dist/uns-api-plugin.js

@@ -1,5 +1,6 @@
 import UnsProxyProcess from "@uns-kit/core/uns/uns-proxy-process.js";
 import UnsApiProxy from "./uns-api-proxy.js";
+import { UnsPacket } from "@uns-kit/core/uns/uns-packet.js";
 const apiProxyRegistry = new WeakMap();
 const getApiProxies = (instance) => {
     let proxies = apiProxyRegistry.get(instance);
@@ -33,6 +34,13 @@ const unsApiPlugin = ({ define }) => {
                     properties: { messageExpiryInterval: 120000 },
                 });
             });
+            unsApiProxy.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) => {
+                    internals.processMqttProxy.publish(event.statusTopic, JSON.stringify(packet));
+                });
+            });
             internals.unsApiProxies.push(unsApiProxy);
             getApiProxies(this).push(unsApiProxy);
             return unsApiProxy;

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

@@ -13,6 +13,9 @@ export default class UnsApiProxy extends UnsProxy {
     private options;
     private jwksCache?;
     private catchAllRouteRegistered;
+    private startedAt;
+    private statusInterval;
+    private readonly statusIntervalMs;
     constructor(processName: string, instanceName: string, options: IApiProxyOptions);
     /**
      * Unregister endpoint
@@ -43,8 +46,11 @@ export default class UnsApiProxy extends UnsProxy {
         queryParams?: IGetEndpointOptions["queryParams"];
     }): Promise<void>;
     post(..._args: any[]): any;
+    private emitStatusMetrics;
+    private registerHealthEndpoint;
     private extractBearerToken;
     private getPublicKeyFromJwks;
     private fetchJwksKeys;
     private certFromX5c;
+    stop(): Promise<void>;
 }

package/dist/uns-api-proxy.js

@@ -9,6 +9,7 @@ import { MqttTopicBuilder } from "@uns-kit/core/uns-mqtt/mqtt-topic-builder.js";
 import { UnsPacket } from "@uns-kit/core/uns/uns-packet.js";
 import UnsProxy from "@uns-kit/core/uns/uns-proxy.js";
 import { UnsTopicMatcher } from "@uns-kit/core/uns/uns-topic-matcher.js";
+import { DataSizeMeasurements, PhysicalMeasurements } from "@uns-kit/core/uns/uns-measurements.js";
 import App from "./app.js";
 const packageJsonPath = path.join(basePath, "package.json");
 const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf8"));
@@ -21,11 +22,15 @@ export default class UnsApiProxy extends UnsProxy {
     options;
     jwksCache;
     catchAllRouteRegistered = false;
+    startedAt;
+    statusInterval = null;
+    statusIntervalMs = 10_000;
     constructor(processName, instanceName, options) {
         super();
         this.options = options;
         this.app = new App(0, processName, instanceName);
         this.app.start();
+        this.startedAt = Date.now();
         this.instanceName = instanceName;
         this.processName = processName;
         // Create the topic builder using packageJson values and the processName.
@@ -36,6 +41,10 @@ export default class UnsApiProxy extends UnsProxy {
         this.instanceStatusTopic = this.processStatusTopic + instanceName + "/";
         // Concatenate processName with instanceName for the worker identification.
         this.instanceNameWithSuffix = `${processName}-${instanceName}`;
+        this.registerHealthEndpoint();
+        // Emit once after listeners are attached in the plugin, then on the regular cadence.
+        setTimeout(() => this.emitStatusMetrics(), 0);
+        this.statusInterval = setInterval(() => this.emitStatusMetrics(), this.statusIntervalMs);
     }
     /**
      * Unregister endpoint
@@ -312,6 +321,61 @@ export default class UnsApiProxy extends UnsProxy {
         // Implement POST logic or route binding here
         return "POST called";
     }
+    emitStatusMetrics() {
+        const uptimeMinutes = Math.round((Date.now() - this.startedAt) / 60000);
+        // Process-level status
+        this.event.emit("mqttProxyStatus", {
+            event: "uptime",
+            value: uptimeMinutes,
+            uom: PhysicalMeasurements.Minute,
+            statusTopic: this.processStatusTopic + "uptime",
+        });
+        this.event.emit("mqttProxyStatus", {
+            event: "alive",
+            value: 1,
+            uom: DataSizeMeasurements.Bit,
+            statusTopic: this.processStatusTopic + "alive",
+        });
+        // Instance-level status
+        this.event.emit("mqttProxyStatus", {
+            event: "uptime",
+            value: uptimeMinutes,
+            uom: PhysicalMeasurements.Minute,
+            statusTopic: this.instanceStatusTopic + "uptime",
+        });
+        this.event.emit("mqttProxyStatus", {
+            event: "alive",
+            value: 1,
+            uom: DataSizeMeasurements.Bit,
+            statusTopic: this.instanceStatusTopic + "alive",
+        });
+    }
+    registerHealthEndpoint() {
+        const fullPath = "/status";
+        this.app.router.get(fullPath, (_req, res) => {
+            res.json({
+                alive: true,
+                processName: this.processName,
+                instanceName: this.instanceName,
+                package: packageJson.name,
+                version: packageJson.version,
+                startedAt: new Date(this.startedAt).toISOString(),
+                uptimeMs: Date.now() - this.startedAt,
+                timestamp: new Date().toISOString(),
+            });
+        });
+        if (this.app.swaggerSpec) {
+            this.app.swaggerSpec.paths = this.app.swaggerSpec.paths || {};
+            this.app.swaggerSpec.paths[`/api${fullPath}`] = {
+                get: {
+                    summary: "Health status",
+                    responses: {
+                        "200": { description: "OK" },
+                    },
+                },
+            };
+        }
+    }
     extractBearerToken(req, res) {
         const authHeader = req.headers["authorization"];
         if (!authHeader || !authHeader.startsWith("Bearer ")) {
@@ -377,4 +441,11 @@ export default class UnsApiProxy extends UnsProxy {
         const pemBody = x5cFirst.match(/.{1,64}/g)?.join("\n") ?? x5cFirst;
         return `-----BEGIN CERTIFICATE-----\n${pemBody}\n-----END CERTIFICATE-----\n`;
     }
+    async stop() {
+        if (this.statusInterval) {
+            clearInterval(this.statusInterval);
+            this.statusInterval = null;
+        }
+        await super.stop();
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uns-kit/api",
-  "version": "2.0.0",
+  "version": "2.0.3",
   "description": "Express-powered API gateway plugin for UnsProxyProcess with JWT/JWKS support.",
   "type": "module",
   "license": "MIT",
@@ -35,7 +35,7 @@
     "cookie-parser": "^1.4.7",
     "express": "^5.1.0",
     "multer": "^2.0.2",
-    "@uns-kit/core": "2.0.0"
+    "@uns-kit/core": "2.0.3"
   },
   "devDependencies": {
     "@types/jsonwebtoken": "^9.0.10",