@uns-kit/cli 0.0.36 → 0.0.37

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

@@ -1,108 +1,108 @@
-/**
- * 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, logger } from "@uns-kit/core.js";
-import UnsMqttProxy from "@uns-kit/core/uns-mqtt/uns-mqtt-proxy.js";
-
-/**
- * Produces a smooth oscillating value to mimic a real-world sensor signal.
- * Combines fast and slow sine waves plus tiny ripple so that subsequent values
- * rise and fall without appearing purely random.
- */
-function simulateSensorValue(step: number): number {
-  const baseValue = 42; // arbitrary midpoint for the simulated signal
-  const fastCycle = Math.sin(step / 5) * 3;
-  const slowCycle = Math.sin(step / 25) * 6;
-  const ripple = Math.sin(step / 2 + Math.PI / 4) * 0.5;
-  const value = baseValue + fastCycle + slowCycle + ripple;
-
-  return Number(value.toFixed(2));
-}
-
-/**
- * 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 outputHost = (config.output?.host)!;
-
-    const mqttOutput = new UnsMqttProxy(
-      outputHost,
-      "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 ${outputHost}? (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 sensorValue = simulateSensorValue(count);
-                const rawData = `${count},${currentDate.getTime()},${sensorValue}`;
-                await mqttOutput.publishMessage("raw/data", rawData);
-              } catch (error) {
-                const reason = error instanceof Error ? error : new Error(String(error));
-                logger.error("Error publishing message:", reason.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) {
-    const reason = error instanceof Error ? error : new Error(String(error));
-    logger.error("Error initializing load test:", reason.message);
-    process.exit(1);
-  }
-}
-
-main();
+/**
+ * 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, logger } from "@uns-kit/core";
+import UnsMqttProxy from "@uns-kit/core/uns-mqtt/uns-mqtt-proxy.js";
+
+/**
+ * Produces a smooth oscillating value to mimic a real-world sensor signal.
+ * Combines fast and slow sine waves plus tiny ripple so that subsequent values
+ * rise and fall without appearing purely random.
+ */
+function simulateSensorValue(step: number): number {
+  const baseValue = 42; // arbitrary midpoint for the simulated signal
+  const fastCycle = Math.sin(step / 5) * 3;
+  const slowCycle = Math.sin(step / 25) * 6;
+  const ripple = Math.sin(step / 2 + Math.PI / 4) * 0.5;
+  const value = baseValue + fastCycle + slowCycle + ripple;
+
+  return Number(value.toFixed(2));
+}
+
+/**
+ * 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 outputHost = (config.output?.host)!;
+
+    const mqttOutput = new UnsMqttProxy(
+      outputHost,
+      "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 ${outputHost}? (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 sensorValue = simulateSensorValue(count);
+                const rawData = `${count},${currentDate.getTime()},${sensorValue}`;
+                await mqttOutput.publishMessage("raw/data", rawData);
+              } catch (error) {
+                const reason = error instanceof Error ? error : new Error(String(error));
+                logger.error("Error publishing message:", reason.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) {
+    const reason = error instanceof Error ? error : new Error(String(error));
+    logger.error("Error initializing load test:", reason.message);
+    process.exit(1);
+  }
+}
+
+main();

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

@@ -1,66 +1,66 @@
-/**
- * Change this file according to your specifications and rename it to index.ts
- */
-
-import { UnsProxyProcess, ConfigFile, logger, type IUnsMessage } from "@uns-kit/core.js";
-import { UnsPacket } from "@uns-kit/core/uns/uns-packet.js";
-import { UnsTags } from "@uns-kit/core/uns/uns-tags.js";
-import { UnsTopics } from "@uns-kit/core/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
- */
-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: ["integration/raw-table"],
-  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 upstream 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 === "integration/raw-table") {
-      const x = 10;
-      const a = `{
-        "kolona_a": "${x}",
-        "kolona_b": "1",
-        "kolona_c"; "${x}",
-        "kolona_d": 3
-      }`;
-      type questDbCoulmnTypes = "number" | "float" | "string";
-      const columnTypes:questDbCoulmnTypes[]  = ['number', 'float', 'string', 'number', 'number'];
-
-      const jsonObject = JSON.parse(a);
-      const timestamp = jsonObject.Timestamp;
-      // delete(jsonObject.Timestamp);
-
-      const time = UnsPacket.formatToISO8601(new Date(timestamp));
-      // const message: IUnsMessage = { table: {dataGroup:"demo_table", values:jsonObject, columnTypes, time}};
-      const message: IUnsMessage = { table: {dataGroup:"demo_table", values:jsonObject, time}};
-      const topic: UnsTopics = "example/factory-a/line-1/";
-      const tags: UnsTags[] = [];
-      const packet = await UnsPacket.unsPacketFromUnsMessage(message);
-      mqttOutput.publishMqttMessage({ topic, attribute: "table-sample", packet, description: "Table", tags });
-    }
-  } catch (error) {
-    const reason = error instanceof Error ? error : new Error(String(error));
-    logger.error(`Error publishing message to MQTT: ${reason.message}`);
-    throw reason;
-  }
-});
+/**
+ * Change this file according to your specifications and rename it to index.ts
+ */
+
+import { UnsProxyProcess, ConfigFile, logger, type IUnsMessage } from "@uns-kit/core";
+import { UnsPacket } from "@uns-kit/core/uns/uns-packet.js";
+import { UnsTags } from "@uns-kit/core/uns/uns-tags.js";
+import { UnsTopics } from "@uns-kit/core/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
+ */
+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: ["integration/raw-table"],
+  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 upstream 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 === "integration/raw-table") {
+      const x = 10;
+      const a = `{
+        "kolona_a": "${x}",
+        "kolona_b": "1",
+        "kolona_c"; "${x}",
+        "kolona_d": 3
+      }`;
+      type questDbCoulmnTypes = "number" | "float" | "string";
+      const columnTypes:questDbCoulmnTypes[]  = ['number', 'float', 'string', 'number', 'number'];
+
+      const jsonObject = JSON.parse(a);
+      const timestamp = jsonObject.Timestamp;
+      // delete(jsonObject.Timestamp);
+
+      const time = UnsPacket.formatToISO8601(new Date(timestamp));
+      // const message: IUnsMessage = { table: {dataGroup:"demo_table", values:jsonObject, columnTypes, time}};
+      const message: IUnsMessage = { table: {dataGroup:"demo_table", values:jsonObject, time}};
+      const topic: UnsTopics = "example/factory-a/line-1/";
+      const tags: UnsTags[] = [];
+      const packet = await UnsPacket.unsPacketFromUnsMessage(message);
+      mqttOutput.publishMqttMessage({ topic, attribute: "table-sample", packet, description: "Table", tags });
+    }
+  } catch (error) {
+    const reason = error instanceof Error ? error : new Error(String(error));
+    logger.error(`Error publishing message to MQTT: ${reason.message}`);
+    throw reason;
+  }
+});

package/templates/default/src/examples/uns-gateway-cli.ts

@@ -1,7 +1,7 @@
-import { startUnsGateway } from "@uns-kit/core/uns-grpc/uns-gateway-server.js";
-
-const addr = await startUnsGateway();
-console.log(`UNS Gateway listening on ${addr.address} (UDS=${addr.isUDS})`);
-// Keep alive
-setInterval(() => {}, 1 << 30);
-
+import { startUnsGateway } from "@uns-kit/core/uns-grpc/uns-gateway-server.js";
+
+const addr = await startUnsGateway();
+console.log(`UNS Gateway listening on ${addr.address} (UDS=${addr.isUDS})`);
+// Keep alive
+setInterval(() => {}, 1 << 30);
+

package/templates/default/src/index.ts

@@ -1,15 +1,15 @@
-import { UnsProxyProcess } from "@uns-kit/core.js";
-
-async function main(): Promise<void> {
-  const name = "__APP_NAME__";
-  const process = new UnsProxyProcess("localhost:1883", {
-    processName: name,
-  });
-
-  console.log(`UNS process '${name}' is ready. Edit src/index.ts to add your logic.`);
-
-  // Keep the process alive or add plugin logic here
-  void process;
-}
-
-void main();
+import { UnsProxyProcess } from "@uns-kit/core";
+
+async function main(): Promise<void> {
+  const name = "__APP_NAME__";
+  const process = new UnsProxyProcess("localhost:1883", {
+    processName: name,
+  });
+
+  console.log(`UNS process '${name}' is ready. Edit src/index.ts to add your logic.`);
+
+  // Keep the process alive or add plugin logic here
+  void process;
+}
+
+void main();

package/templates/default/src/uns/uns-tags.ts

@@ -1,2 +1,2 @@
-// Generated UNS tag union. Run `pnpm refresh-uns` to update.
-export type UnsTags = string & {};
+// Generated UNS tag union. Run `pnpm refresh-uns` to update.
+export type UnsTags = string & {};

package/templates/default/src/uns/uns-topics.ts

@@ -1,2 +1,2 @@
-// Generated UNS topic union. Run `pnpm refresh-uns` to update.
-export type UnsTopics = string & {};
+// Generated UNS topic union. Run `pnpm refresh-uns` to update.
+export type UnsTopics = string & {};

package/templates/default/tsconfig.json

@@ -1,16 +1,29 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "lib": ["ES2022"],
-    "module": "es2022",
-    "moduleResolution": "bundler",
-    "noEmit": false,
-    "outDir": "dist",
-    "rootDir": "src",
-    "strict": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "resolveJsonModule": true
-  },
-  "include": ["src/**/*.ts"]
-}
+{
+  "compilerOptions": {
+    "target": "ES2023",
+    "lib": ["ES2023"],
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "moduleDetection": "force",
+    "noEmit": false,
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "exactOptionalPropertyTypes": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "useDefineForClassFields": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "incremental": true,
+    "isolatedModules": true,
+    "sourceMap": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"]
+}

package/templates/python/app/README.md

@@ -1,8 +1,8 @@
-This folder is reserved for your project-specific Python code.
-
-The update tools will NOT overwrite `python/app/**` (and also preserve legacy `python/rtt/**`, `python/venv`, `python/.venv`, and `python/__pycache__`).
-
-Suggested layout:
-- `python/app/` your packages, modules, or CLI scripts
-- Reference the gateway client in `python/gateway_client.py` if you interact with the UNS gateway from Python
-
+This folder is reserved for your project-specific Python code.
+
+The update tools will NOT overwrite `python/app/**` (and also preserve legacy `python/rtt/**`, `python/venv`, `python/.venv`, and `python/__pycache__`).
+
+Suggested layout:
+- `python/app/` your packages, modules, or CLI scripts
+- Reference the gateway client in `python/gateway_client.py` if you interact with the UNS gateway from Python
+