@uns-kit/cli 0.0.2 → 0.0.4

package/README.md

@@ -6,13 +6,13 @@ Command line scaffolding tool for the UNS toolkit. It bootstraps a new project w
 
 ```bash
 pnpm --package=@uns-kit/cli dlx uns-kit create my-uns-app
+# or with npx
+npx @uns-kit/cli create my-uns-app
 # or after installing globally
 npm install -g @uns-kit/cli
 uns-kit create my-uns-app
 ```
 
-> The package exposes both `uns-kit` and `uns` binaries. When using `pnpm dlx`, specify which one to run (`uns-kit` above). If you install globally you can use the shorter `uns create …` alias.
-
 The command creates a new directory, copies the starter template, and pins `@uns-kit/core` to the currently published version. After the scaffold finishes:
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uns-kit/cli",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Command line scaffolding tool for UNS applications",
   "type": "module",
   "license": "MIT",
@@ -11,8 +11,7 @@
     "directory": "packages/uns-cli"
   },
   "bin": {
-    "uns-kit": "./dist/index.js",
-    "uns": "./dist/index.js"
+    "uns-kit": "./dist/index.js"
   },
   "keywords": [
     "uns",

package/templates/default/config.json

@@ -4,7 +4,9 @@
     "rest": "http://localhost:3200/api",
     "processName": "__APP_NAME__",
     "instanceMode": "wait",
-    "handover": true
+    "handover": true,
+    "jwksWellKnownUrl": "http://localhost:3200/api/.well-known/jwks.json",
+    "kidWellKnownUrl": "http://localhost:3200/api/.well-known/kid"
   },
   "infra": {
     "host": "localhost:1883"

package/templates/default/package.json

@@ -6,7 +6,8 @@
     "typecheck": "tsc --noEmit",
     "build": "tsc -p tsconfig.json",
     "start": "node ./dist/index.js",
-    "dev": "tsx watch src/index.ts"
+    "dev": "tsx watch src/index.ts",
+    "generate-config-schema": "node ./node_modules/@uns-kit/core/dist/tools/generate-config-schema.js"
   },
   "dependencies": {
     "@uns-kit/core": "__UNS_KIT_CORE_VERSION__"

package/templates/default/src/examples/data-example.ts

@@ -0,0 +1,50 @@
+/**
+ * Change this file according to your specifications and rename it to index.ts
+ */
+import UnsProxyProcess from "../uns/uns-proxy-process.js";
+import { ConfigFile } from "../config-file.js";
+import logger from "../logger.js";
+import { IUnsMessage } from "../uns/uns-interfaces.js";
+import { PhysicalMeasurements } from "../uns/uns-measurements.js";
+import { UnsPacket } from "../uns/uns-packet.js";
+import { UnsTags } from "../uns/uns-tags.js";
+import { UnsTopics } from "../uns/uns-topics.js";
+
+/**
+ * Load the configuration from a file.
+ * On the server, this file is provided by the `uns-datahub-controller`.
+ * In the development environment, you are responsible for creating and maintaining this file and its contents.
+ */
+const config = await ConfigFile.loadConfig();
+
+/**
+ * Connect to input and output brokers
+ */
+const unsProxyProcess = new UnsProxyProcess(config.infra.host, {processName: config.uns.processName});
+const mqttInput = await unsProxyProcess.createUnsMqttProxy(config.input.host, "templateUnsRttInput", config.uns.instanceMode, config.uns.handover, {
+  mqttSubToTopics: ["raw/#"],
+});
+const mqttOutput = await unsProxyProcess.createUnsMqttProxy(config.output.host, "templateUnsRttOutput", config.uns.instanceMode, config.uns.handover, { publishThrottlingDelay: 1000});
+
+
+/**
+ * Event listener for input events.
+ * Transform an input message and publish it with publishMqttMessage function.
+ */
+mqttInput.event.on("input", async (event) => {
+  try {
+    if (event.topic === "raw/data") {
+      const time = UnsPacket.formatToISO8601(new Date());
+      const values = event.message.split(",");
+      const numberValue: number = parseFloat(values[0]);
+      const message: IUnsMessage = { data: { dataGroup:"electricity", time, value: numberValue, uom: PhysicalMeasurements.MiliVolt } };
+      const topic: UnsTopics = "sij/";
+      const tags: UnsTags[] = [];
+      const packet = await UnsPacket.unsPacketFromUnsMessage(message);
+      mqttOutput.publishMqttMessage({ topic, attribute: "data-number", packet, description: "Number value", tags });
+    }
+  } catch (error) {
+    logger.error(`Error publishing message to MQTT: ${error.message}`);
+    throw error;
+  }
+});

package/templates/default/src/examples/load-test-data.ts

@@ -0,0 +1,90 @@
+/**
+ * Load the configuration from a file.
+ * On the server, this file is provided by the `uns-datahub-controller`.
+ * In the development environment, you are responsible for creating and maintaining this file and its contents.
+ */
+import readline from "readline";
+import { ConfigFile } from "../config-file.js";
+import UnsMqttProxy from "../uns-mqtt/uns-mqtt-proxy.js";
+import logger from "../logger.js";
+
+
+/**
+ * This script initializes an MQTT output proxy for load testing purposes.
+ * It sets up a connection to the specified MQTT broker and configures
+ * a proxy instance. The load test is designed to evaluate the performance
+ * and reliability of the MQTT broker under simulated load conditions.
+ */
+async function main() {
+  try {
+    const config = await ConfigFile.loadConfig();
+    const mqttOutput = new UnsMqttProxy(
+      config.output.host,
+      "loadTest",
+      "templateUnsRttLoadTest",
+      { publishThrottlingDelay: 0 },
+      true
+    );
+
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout,
+    });
+
+    await new Promise((resolve) => setTimeout(resolve, 1000));
+
+    rl.question(`Would you like to continue with load-test on ${config.output.host}? (Y/n) `, async (answer) => {
+      if (answer.toLowerCase() === "y" || answer.trim() === "") {
+        rl.question("How many iterations should be run? (default is 100) ", async (iterations) => {
+          const maxIntervals = parseInt(iterations) || 100;
+
+          rl.question("What should be the delay between intervals in milliseconds? (default is 0 ms) ", async (intervalDelay) => {
+            const delay = parseInt(intervalDelay) || 0;
+
+            logger.info(`Starting load test with ${maxIntervals} messages and ${delay} ms delay...`);
+
+            let count = 0;
+            const startTime = Date.now();
+
+            while (count < maxIntervals) {
+              try {
+                const currentDate = new Date();
+                const rawData = `${count},${currentDate.getTime()}`;
+                await mqttOutput.publishMessage("raw/data", rawData);
+              } catch (error) {
+                logger.error("Error publishing message:", error.message);
+              }
+
+              count++;
+              if (delay > 0) {
+                await new Promise((resolve) => setTimeout(resolve, delay));
+              }
+            }
+
+            logger.info(`Sleeping for 50ms.`);
+            await new Promise((resolve) => setTimeout(resolve, 50));
+
+            const endTime = Date.now();
+            const duration = (endTime - startTime) / 1000;
+            const messagesPerSecond = maxIntervals / duration;
+
+            logger.info(`Load test completed in ${duration.toFixed(2)} seconds.`);
+            logger.info(`Message rate: ${messagesPerSecond.toFixed(2)} msg/s.`);
+
+            rl.close();
+            process.exit(0);
+          });
+        });
+      } else {
+        logger.info("Load test aborted.");
+        rl.close();
+        process.exit(0);
+      }
+    });
+  } catch (error) {
+    logger.error("Error initializing load test:", error.message);
+    process.exit(1);
+  }
+}
+
+main();

package/templates/default/src/examples/table-example.ts

@@ -0,0 +1,59 @@
+/**
+ * Change this file according to your specifications and rename it to index.ts
+ */
+
+import UnsProxyProcess from "../uns/uns-proxy-process.js";
+import { ConfigFile } from "../config-file.js";
+import logger from "../logger.js";
+import { IUnsMessage } from "../uns/uns-interfaces.js";
+import { UnsPacket } from "../uns/uns-packet.js";
+import { UnsTags } from "../uns/uns-tags.js";
+import { UnsTopics } from "../uns/uns-topics.js";
+
+/**
+ * Load the configuration from a file.
+ * On the server, this file is provided by the `uns-datahub-controller`.
+ * In the development environment, you are responsible for creating and maintaining this file and its contents.
+ */
+const config = await ConfigFile.loadConfig();
+
+/**
+ * Load and configure input and output brokers from config.json
+ */
+if (!config.infra?.host || !config.input?.host || !config.output?.host) {
+  throw new Error("Missing required configuration in config.json");
+}
+const unsProxyProcess = new UnsProxyProcess(config.infra.host, {processName: config.uns.processName});
+const mqttInput = await unsProxyProcess.createUnsMqttProxy(config.input.host, "templateUnsRttInput", config.uns.instanceMode, config.uns.handover, {
+  mqttSubToTopics: ["iba/zrm"],
+  publishThrottlingDelay:0,
+  subscribeThrottlingDelay:0
+});
+const mqttOutput = await unsProxyProcess.createUnsMqttProxy(config.output.host, "templateUnsRttOutput", config.uns.instanceMode, config.uns.handover, {
+  publishThrottlingDelay:0,
+  subscribeThrottlingDelay:0  
+});
+
+/**
+ * The input worker connects to the IBA broker and listens for incoming messages.
+ * It processes the messages and transforms them into a table-type IUnsMessage.
+ * The resulting message is published to the output broker.
+ */
+mqttInput.event.on("input", async (event) => {
+  try {
+    if (event.topic === "iba/zrm") {
+      const jsonObject = JSON.parse(event.message);
+      const timestamp = jsonObject.Timestamp;
+      delete(jsonObject.Timestamp);
+
+      const time = UnsPacket.formatToISO8601(new Date(timestamp));
+      const message: IUnsMessage = { table: {dataGroup:"iba_test", values:jsonObject, time}};
+      const topic: UnsTopics = "sij/acroni/hv/";
+      const tags: UnsTags[] = [];
+      const packet = await UnsPacket.unsPacketFromUnsMessage(message);
+      mqttOutput.publishMqttMessage({ topic, attribute: "zrm", packet, description: "Table", tags });
+    }
+  } catch (error) {
+    logger.error(`Error publishing message to MQTT: ${error.message}`);
+  }
+});