@uns-kit/cli 2.0.24 → 2.0.26

package/templates/default/gitignore

@@ -1,51 +1,51 @@
-# Dependencies
-node_modules/
-.pnpm-store/
-.pnpm/
-.pnp.cjs
-.pnp.loader.mjs
-
-# Build outputs
-build/
-dist/
-tmp/
-temp/
-*.tsbuildinfo
-
-# Logs & diagnostics
-logs/
-*.log
-npm-debug.log*
-yarn-debug.log*
-pnpm-debug.log*
-lerna-debug.log*
-
-# Test & coverage artifacts
-coverage/
-.nyc_output/
-.vitest/
-
-# Runtime queues & sandboxes
-publisherQueue/
-sandbox-*
-tmp-rtt
-.tmp-rtt
-
-# Environment & secrets
-.env
-.env.*
-!.env.example
-!.env.sample
-
-# UNS configuration overrides
-config*.json
-
-# Editor files & OS cruft
-.idea/
-.DS_Store
-Thumbs.db
-*.swp
-*.swo
-
-# Package managers
-package-lock.json
+# Dependencies
+node_modules/
+.pnpm-store/
+.pnpm/
+.pnp.cjs
+.pnp.loader.mjs
+
+# Build outputs
+build/
+dist/
+tmp/
+temp/
+*.tsbuildinfo
+
+# Logs & diagnostics
+logs/
+*.log
+npm-debug.log*
+yarn-debug.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+# Test & coverage artifacts
+coverage/
+.nyc_output/
+.vitest/
+
+# Runtime queues & sandboxes
+publisherQueue/
+sandbox-*
+tmp-rtt
+.tmp-rtt
+
+# Environment & secrets
+.env
+.env.*
+!.env.example
+!.env.sample
+
+# UNS configuration overrides
+config*.json
+
+# Editor files & OS cruft
+.idea/
+.DS_Store
+Thumbs.db
+*.swp
+*.swo
+
+# Package managers
+package-lock.json

package/templates/default/package.json

@@ -1,46 +1,49 @@
-{
-  "name": "__APP_NAME__",
-  "version": "0.0.0",
-  "private": true,
-  "description": "UNS application generated by @uns-kit/cli",
-  "type": "module",
-  "engines": {
-    "node": ">=22"
-  },
-  "files": [
-    "dist"
-  ],
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
-    }
-  },
-  "scripts": {
-    "clean": "rimraf dist tsconfig.tsbuildinfo",
-    "typecheck": "tsc --noEmit",
-    "build": "pnpm run clean && tsc -p tsconfig.json",
-    "dev": "tsx watch src/index.ts",
-    "start": "node dist/index.js",
-    "lint": "eslint src --ext .ts",
-    "lint:fix": "eslint src --ext .ts --fix",
-    "format": "prettier --write .",
-    "format:check": "prettier --check .",
-    "generate-config-schema": "node ./node_modules/@uns-kit/core/dist/tools/generate-config-schema.js",
-    "generate-codegen": "graphql-code-generator --require dotenv/config --config codegen.ts",
-    "generate-uns-metadata": "node ./node_modules/@uns-kit/core/dist/tools/refresh-uns.js",
-    "generate-uns-measurements": "node ./node_modules/@uns-kit/core/dist/tools/generate-uns-measurements.js --input uns-measurements.json --output src/uns/uns-measurements.generated.ts"
-  },
-  "dependencies": {
-    "@uns-kit/core": "__UNS_KIT_CORE_VERSION__",
-    "zod": "^3.23.8"
-  },
-  "devDependencies": {
-    "@types/node": "^22.19.1",
-    "eslint": "^9.39.2",
-    "prettier": "^3.8.0",
-    "rimraf": "^6.1.2",
-    "tsx": "^4.20.6",
-    "typescript": "^5.9.3"
-  }
-}
+{
+  "name": "__APP_NAME__",
+  "version": "0.0.0",
+  "private": true,
+  "description": "UNS application generated by @uns-kit/cli",
+  "type": "module",
+  "engines": {
+    "node": ">=22"
+  },
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "clean": "rimraf dist tsconfig.tsbuildinfo",
+    "typecheck": "tsc --noEmit",
+    "build": "pnpm run clean && tsc -p tsconfig.json",
+    "dev": "tsx watch src/index.ts",
+    "start": "node dist/index.js",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "generate-config-schema": "node ./node_modules/@uns-kit/core/dist/tools/generate-config-schema.js",
+    "generate-codegen": "graphql-code-generator --require dotenv/config --config codegen.ts",
+    "generate-uns-metadata": "node ./node_modules/@uns-kit/core/dist/tools/refresh-uns.js",
+    "generate-uns-dictionary": "node ./node_modules/@uns-kit/core/dist/tools/generate-uns-dictionary.js --input uns-dictionary.json --output src/uns/uns-dictionary.generated.ts",
+    "generate-uns-measurements": "node ./node_modules/@uns-kit/core/dist/tools/generate-uns-measurements.js --input uns-measurements.json --output src/uns/uns-measurements.generated.ts",
+    "generate-uns-reference": "node ./node_modules/@uns-kit/core/dist/tools/generate-uns-reference.js --dictionary uns-dictionary.json --dictionary-output src/uns/uns-dictionary.generated.ts --measurements uns-measurements.json --measurements-output src/uns/uns-measurements.generated.ts",
+    "sync-uns-schema": "node ./node_modules/@uns-kit/core/dist/tools/sync-uns-schema.js"
+  },
+  "dependencies": {
+    "@uns-kit/core": "__UNS_KIT_CORE_VERSION__",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.1",
+    "eslint": "^9.39.2",
+    "prettier": "^3.8.0",
+    "rimraf": "^6.1.2",
+    "tsx": "^4.20.6",
+    "typescript": "^5.9.3"
+  }
+}

package/templates/default/src/config/project.config.extension.example

@@ -1,23 +1,23 @@
-import { z } from "zod";
-import { secretValueSchema } from "@uns-kit/core/uns-config/secret-placeholders.js";
-import { hostValueSchema } from "@uns-kit/core/uns-config/host-placeholders.js";
-
-// Extend this schema with project-specific configuration sections.
-export const projectExtrasSchema = z.object({
-  pg: z.object({
-    user: z.string().min(1, "pg.user is required"),
-    host: hostValueSchema,
-    port: z.number().int().positive().default(5432),
-    ssl: z.boolean().default(false),
-    database: z.string().min(1, "pg.database is required"),
-    isPoolConnection: z.boolean().default(false),
-    password: secretValueSchema.optional(),
-  }),
-
-  caddy: z.object({
-    adminUrl: z.string().url(),
-    proxyHost: z.string().url(),
-  }),
-});
-
-export type ProjectExtras = z.infer<typeof projectExtrasSchema>;
+import { z } from "zod";
+import { secretValueSchema } from "@uns-kit/core/uns-config/secret-placeholders.js";
+import { hostValueSchema } from "@uns-kit/core/uns-config/host-placeholders.js";
+
+// Extend this schema with project-specific configuration sections.
+export const projectExtrasSchema = z.object({
+  pg: z.object({
+    user: z.string().min(1, "pg.user is required"),
+    host: hostValueSchema,
+    port: z.number().int().positive().default(5432),
+    ssl: z.boolean().default(false),
+    database: z.string().min(1, "pg.database is required"),
+    isPoolConnection: z.boolean().default(false),
+    password: secretValueSchema.optional(),
+  }),
+
+  caddy: z.object({
+    adminUrl: z.string().url(),
+    proxyHost: z.string().url(),
+  }),
+});
+
+export type ProjectExtras = z.infer<typeof projectExtrasSchema>;

package/templates/default/src/config/project.config.extension.ts

@@ -1,6 +1,6 @@
-import { z } from "zod";
-
-// Extend this schema with project-specific configuration sections.
-export const projectExtrasSchema = z.object({});
-
-export type ProjectExtras = z.infer<typeof projectExtrasSchema>;
+import { z } from "zod";
+
+// Extend this schema with project-specific configuration sections.
+export const projectExtrasSchema = z.object({});
+
+export type ProjectExtras = z.infer<typeof projectExtrasSchema>;

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

@@ -1,86 +1,86 @@
-/**
- * Change this file according to your specifications and rename it to index.ts
- */
-import { UnsProxyProcess, ConfigFile, getLogger } from "@uns-kit/core";
-import { registerAttributeDescriptions, registerObjectTypeDescriptions } from "@uns-kit/core/uns/uns-dictionary-registry.js";
-import { GeneratedPhysicalMeasurements } from "../uns/uns-measurements.generated.js";
-import { UnsTopics } from "@uns-kit/core/uns/uns-topics.js";
-import {
-  GeneratedObjectTypes,
-  GeneratedAttributes,
-  GeneratedAttributesByType,
-  GeneratedObjectTypeDescriptions,
-} from "../uns/uns-dictionary.generated.js";
-import { GeneratedAssets, resolveGeneratedAsset } from "../uns/uns-assets.js";
-import type { ISO8601 } from "@uns-kit/core/uns/uns-interfaces.js";
-
-const logger = getLogger(import.meta.url);
-
-/**
- * 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();
-registerObjectTypeDescriptions(GeneratedObjectTypeDescriptions);
-
-/**
- * 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 values = event.message.split(",");
-      const [countRaw, timestampRaw, sensorRaw] = values;
-      if (!countRaw || !timestampRaw || !sensorRaw) {
-        logger.warn(`Skipping malformed raw/data payload: ${event.message}`);
-        return;
-      }
-      const numberValue = Number.parseFloat(countRaw);
-      const eventDate = new Date(Number.parseInt(timestampRaw, 10));
-      const sensorValue = Number.parseFloat(sensorRaw);
-      const time: ISO8601 = eventDate.toISOString() as ISO8601;
-      const intervalStart: ISO8601 = new Date(eventDate.getTime() - 1000).toISOString() as ISO8601;
-      const intervalEnd: ISO8601 = eventDate.toISOString() as ISO8601;
-
-      const dataGroup = "sensor";
-
-      const topic: UnsTopics = "enterprise/site/area/line/";
-      const asset = resolveGeneratedAsset("asset");
-      const assetDescription = ""; // customize manually
-
-      mqttOutput.publishMqttMessage({
-        topic,
-        asset,
-        assetDescription,
-        objectType: GeneratedObjectTypes["energy-resource"],
-        objectId: "main",
-        attributes: [
-          {
-            attribute: GeneratedAttributesByType["energy-resource"]["current"],
-            data: { dataGroup, time, value: numberValue, uom: GeneratedPhysicalMeasurements.Ampere, intervalStart, intervalEnd },
-          },
-          {
-            attribute: GeneratedAttributes["voltage"],
-            data: { dataGroup, time, value: sensorValue, uom: GeneratedPhysicalMeasurements.Volt, intervalStart, intervalEnd },
-          },
-        ],
-      });
-    }
-  } 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, getLogger } from "@uns-kit/core";
+import { registerAttributeDescriptions, registerObjectTypeDescriptions } from "@uns-kit/core/uns/uns-dictionary-registry.js";
+import { GeneratedPhysicalMeasurements } from "../uns/uns-measurements.generated.js";
+import { UnsTopics } from "@uns-kit/core/uns/uns-topics.js";
+import {
+  GeneratedObjectTypes,
+  GeneratedAttributes,
+  GeneratedAttributesByType,
+  GeneratedObjectTypeDescriptions,
+} from "../uns/uns-dictionary.generated.js";
+import { GeneratedAssets, resolveGeneratedAsset } from "../uns/uns-assets.js";
+import type { ISO8601 } from "@uns-kit/core/uns/uns-interfaces.js";
+
+const logger = getLogger(import.meta.url);
+
+/**
+ * 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();
+registerObjectTypeDescriptions(GeneratedObjectTypeDescriptions);
+
+/**
+ * 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 values = event.message.split(",");
+      const [countRaw, timestampRaw, sensorRaw] = values;
+      if (!countRaw || !timestampRaw || !sensorRaw) {
+        logger.warn(`Skipping malformed raw/data payload: ${event.message}`);
+        return;
+      }
+      const numberValue = Number.parseFloat(countRaw);
+      const eventDate = new Date(Number.parseInt(timestampRaw, 10));
+      const sensorValue = Number.parseFloat(sensorRaw);
+      const time: ISO8601 = eventDate.toISOString() as ISO8601;
+      const intervalStart: ISO8601 = new Date(eventDate.getTime() - 1000).toISOString() as ISO8601;
+      const intervalEnd: ISO8601 = eventDate.toISOString() as ISO8601;
+
+      const dataGroup = "sensor";
+
+      const topic: UnsTopics = "enterprise/site/area/line/";
+      const asset = resolveGeneratedAsset("asset");
+      const assetDescription = ""; // customize manually
+
+      mqttOutput.publishMqttMessage({
+        topic,
+        asset,
+        assetDescription,
+        objectType: GeneratedObjectTypes["energy-resource"],
+        objectId: "main",
+        attributes: [
+          {
+            attribute: GeneratedAttributesByType["energy-resource"]["current"],
+            data: { dataGroup, time, value: numberValue, uom: GeneratedPhysicalMeasurements.Ampere, intervalStart, intervalEnd },
+          },
+          {
+            attribute: GeneratedAttributes["voltage"],
+            data: { dataGroup, time, value: sensorValue, uom: GeneratedPhysicalMeasurements.Volt, intervalStart, intervalEnd },
+          },
+        ],
+      });
+    }
+  } 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/load-test-data.ts

@@ -1,110 +1,110 @@
-/**
- * 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, getLogger } from "@uns-kit/core";
-import UnsMqttProxy from "@uns-kit/core/uns-mqtt/uns-mqtt-proxy.js";
-
-const logger = getLogger(import.meta.url);
-
-/**
- * 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, getLogger } from "@uns-kit/core";
+import UnsMqttProxy from "@uns-kit/core/uns-mqtt/uns-mqtt-proxy.js";
+
+const logger = getLogger(import.meta.url);
+
+/**
+ * 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();