@uns-kit/cli 2.0.69 → 2.0.71

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));
+              }
+            }
+
+            await mqttOutput.flush();
+            await mqttOutput.stop();
+
+            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/schema-system-metadata-example.ts

@@ -1,125 +1,124 @@
-/**
- * Example: publish schema-system metadata for object relationships and lifecycle timing.
- *
- * This is producer metadata. The controller stores these fields in
- * attribute_schema.schema_json and can later materialize relationship evidence
- * into object_id_relationship edges.
- */
-import { ConfigFile, UnsProxyProcess, getLogger } from "@uns-kit/core";
-import { registerAttributeDescriptions, registerObjectTypeDescriptions } from "@uns-kit/core/uns/uns-dictionary-registry.js";
-import type { ISO8601 } from "@uns-kit/core/uns/uns-interfaces.js";
-import { UnsTopics } from "@uns-kit/core/uns/uns-topics.js";
-import {
-  GeneratedAttributeDescriptions,
-  GeneratedObjectTypeDescriptions,
-  GeneratedObjectTypes,
-} from "../uns/uns-dictionary.generated.js";
-import { resolveGeneratedAsset } from "../uns/uns-assets.js";
-
-const logger = getLogger(import.meta.url);
-
-const config = await ConfigFile.loadConfig();
-registerObjectTypeDescriptions(GeneratedObjectTypeDescriptions);
-registerAttributeDescriptions(GeneratedAttributeDescriptions);
-
-const unsProxyProcess = new UnsProxyProcess(config.infra.host!, {
-  processName: config.uns.processName!,
-});
-
-const mqttOutput = await unsProxyProcess.createUnsMqttProxy(
-  config.output?.host!,
-  "templateSchemaMetadataOutput",
-  config.uns.instanceMode!,
-  config.uns.handover!,
-  { publishThrottlingDelay: 1000 },
-);
-
-const now = new Date();
-const time = now.toISOString() as ISO8601;
-const topic: UnsTopics = "enterprise/site/area/line/";
-const asset = resolveGeneratedAsset("asset");
-const materialObjectType = GeneratedObjectTypes["material"];
-const currentMaterialId = "1124";
-const previousMaterialId = "112";
-const mergedParentMaterialIds = ["1122", "1123"];
-
-try {
-  await mqttOutput.publishMqttMessage({
-    topic,
-    asset,
-    assetDescription: "Example production line",
-    objectType: materialObjectType,
-    objectId: currentMaterialId,
-    attributes: [
-      {
-        attribute: "previous-material",
-        description: "Previous material ObjectId before this process stage.",
-        valueType: "string",
-        systemRole: "relationship-evidence",
-        relationshipEvidence: {
-          relationshipKey: "material-renumbering",
-          ownerEndpoint: "target",
-          valueEndpoint: "source",
-          sourceObjectType: materialObjectType,
-          targetObjectType: materialObjectType,
-          sourceObjectIdFrom: "value",
-          targetObjectIdFrom: "ownerObjectId",
-          observedAtFrom: "packetTimestamp",
-          defaultStatus: "suggested",
-        },
-        data: {
-          dataGroup: "material-lineage",
-          time,
-          value: previousMaterialId,
-        },
-      },
-      {
-        attribute: "previous-materials",
-        description: "Previous material ObjectIds that were joined into this material.",
-        valueType: "array<string>",
-        systemRole: "relationship-evidence",
-        relationshipEvidence: {
-          relationshipKey: "material-merge",
-          ownerEndpoint: "target",
-          valueEndpoint: "source",
-          sourceObjectType: materialObjectType,
-          targetObjectType: materialObjectType,
-          sourceObjectIdFrom: "value[]",
-          targetObjectIdFrom: "ownerObjectId",
-          observedAtFrom: "packetTimestamp",
-          defaultStatus: "suggested",
-        },
-        data: {
-          dataGroup: "material-lineage",
-          time,
-          currentMaterialObjectId: currentMaterialId,
-          operationId: "weld-1122-1123",
-          value: mergedParentMaterialIds,
-        },
-      },
-      {
-        attribute: "process-state",
-        description: "Material lifecycle state in this process stage.",
-        valueType: "string",
-        systemRole: "lifecycle-time-source",
-        lifecycle: {
-          timestampFrom: "packetTimestamp",
-          startValues: ["entered", "processing"],
-          endValues: ["done", "exited"],
-        },
-        validityMode: "lifecycle",
-        lifecycleEndValue: "done",
-        data: {
-          dataGroup: "material-lifecycle",
-          time,
-          value: "processing",
-        },
-      },
-    ],
-  });
-
-  logger.info(`Published schema-system metadata example for material ${currentMaterialId}.`);
-} finally {
-  await mqttOutput.stop();
-  unsProxyProcess.shutdown();
-}
+/**
+ * Example: publish schema-system metadata for object relationships and lifecycle timing.
+ *
+ * This is producer metadata. The controller stores these fields in
+ * attribute_schema.schema_json and can later materialize relationship evidence
+ * into object_id_relationship edges.
+ */
+import { ConfigFile, UnsProxyProcess, getLogger } from "@uns-kit/core";
+import { registerAttributeDescriptions, registerObjectTypeDescriptions } from "@uns-kit/core/uns/uns-dictionary-registry.js";
+import type { ISO8601 } from "@uns-kit/core/uns/uns-interfaces.js";
+import { UnsTopics } from "@uns-kit/core/uns/uns-topics.js";
+import {
+  GeneratedAttributeDescriptions,
+  GeneratedObjectTypeDescriptions,
+  GeneratedObjectTypes,
+} from "../uns/uns-dictionary.generated.js";
+import { resolveGeneratedAsset } from "../uns/uns-assets.js";
+
+const logger = getLogger(import.meta.url);
+
+const config = await ConfigFile.loadConfig();
+registerObjectTypeDescriptions(GeneratedObjectTypeDescriptions);
+registerAttributeDescriptions(GeneratedAttributeDescriptions);
+
+const unsProxyProcess = new UnsProxyProcess(config.infra.host!, {
+  processName: config.uns.processName!,
+});
+
+const mqttOutput = await unsProxyProcess.createUnsMqttProxy(
+  config.output?.host!,
+  "templateSchemaMetadataOutput",
+  config.uns.instanceMode!,
+  config.uns.handover!,
+  { publishThrottlingDelay: 1000 },
+);
+
+const now = new Date();
+const time = now.toISOString() as ISO8601;
+const topic: UnsTopics = "enterprise/site/area/line/";
+const asset = resolveGeneratedAsset("asset");
+const materialObjectType = GeneratedObjectTypes["material"];
+const currentMaterialId = "1124";
+const previousMaterialId = "112";
+const mergedParentMaterialIds = ["1122", "1123"];
+
+try {
+  await mqttOutput.publishMqttMessage({
+    topic,
+    asset,
+    assetDescription: "Example production line",
+    objectType: materialObjectType,
+    objectId: currentMaterialId,
+    attributes: [
+      {
+        attribute: "previous-material",
+        description: "Previous material ObjectId before this process stage.",
+        valueType: "string",
+        systemRole: "relationship-evidence",
+        relationshipEvidence: {
+          relationshipKey: "material-renumbering",
+          ownerEndpoint: "target",
+          valueEndpoint: "source",
+          sourceObjectType: materialObjectType,
+          targetObjectType: materialObjectType,
+          sourceObjectIdFrom: "value",
+          targetObjectIdFrom: "ownerObjectId",
+          observedAtFrom: "packetTimestamp",
+          defaultStatus: "suggested",
+        },
+        data: {
+          dataGroup: "material-lineage",
+          time,
+          value: previousMaterialId,
+        },
+      },
+      {
+        attribute: "previous-materials",
+        description: "Previous material ObjectIds that were joined into this material.",
+        valueType: "array<string>",
+        systemRole: "relationship-evidence",
+        relationshipEvidence: {
+          relationshipKey: "material-merge",
+          ownerEndpoint: "target",
+          valueEndpoint: "source",
+          sourceObjectType: materialObjectType,
+          targetObjectType: materialObjectType,
+          sourceObjectIdFrom: "value[]",
+          targetObjectIdFrom: "ownerObjectId",
+          observedAtFrom: "packetTimestamp",
+          defaultStatus: "suggested",
+        },
+        data: {
+          dataGroup: "material-lineage",
+          time,
+          currentMaterialObjectId: currentMaterialId,
+          operationId: "weld-1122-1123",
+          value: mergedParentMaterialIds,
+        },
+      },
+      {
+        attribute: "process-state",
+        description: "Material lifecycle state in this process stage.",
+        valueType: "string",
+        systemRole: "lifecycle-time-source",
+        lifecycle: {
+          timestampFrom: "packetTimestamp",
+          startValues: ["entered", "processing"],
+          endValues: ["done", "exited"],
+        },
+        validityMode: "lifecycle",
+        lifecycleEndValue: "done",
+        data: {
+          dataGroup: "material-lifecycle",
+          time,
+          value: "processing",
+        },
+      },
+    ],
+  });
+
+  logger.info(`Published schema-system metadata example for material ${currentMaterialId}.`);
+} finally {
+  await unsProxyProcess.shutdown();
+}

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

@@ -1,76 +1,75 @@
-/**
- * Example: publish a sub-asset under an existing parent asset.
- *
- * V1 sub-assets use the normal UNS publish fields:
- * - topic is the full parent asset path
- * - asset is only the leaf sub-asset name
- */
-import { ConfigFile, UnsProxyProcess, getLogger } from "@uns-kit/core";
-import { registerAttributeDescriptions, registerObjectTypeDescriptions } from "@uns-kit/core/uns/uns-dictionary-registry.js";
-import type { ISO8601 } from "@uns-kit/core/uns/uns-interfaces.js";
-import { UnsTopics } from "@uns-kit/core/uns/uns-topics.js";
-import { GeneratedPhysicalMeasurements } from "../uns/uns-measurements.generated.js";
-import {
-  GeneratedAttributeDescriptions,
-  GeneratedAttributesByType,
-  GeneratedObjectTypeDescriptions,
-  GeneratedObjectTypes,
-} from "../uns/uns-dictionary.generated.js";
-import { resolveGeneratedAsset } from "../uns/uns-assets.js";
-
-const logger = getLogger(import.meta.url);
-
-const config = await ConfigFile.loadConfig();
-registerObjectTypeDescriptions(GeneratedObjectTypeDescriptions);
-registerAttributeDescriptions(GeneratedAttributeDescriptions);
-
-const unsProxyProcess = new UnsProxyProcess(config.infra.host!, {
-  processName: config.uns.processName!,
-});
-
-const mqttOutput = await unsProxyProcess.createUnsMqttProxy(
-  config.output?.host!,
-  "templateSubassetExampleOutput",
-  config.uns.instanceMode!,
-  config.uns.handover!,
-  { publishThrottlingDelay: 1000 },
-);
-
-try {
-  const parentAssetTopic: UnsTopics = "enterprise/site/area/line-1/";
-  const subAsset = resolveGeneratedAsset("pump-1");
-  const now = new Date();
-  const time = now.toISOString() as ISO8601;
-  const intervalStart = new Date(now.getTime() - 1000).toISOString() as ISO8601;
-  const intervalEnd = time;
-
-  await mqttOutput.publishMqttMessage({
-    topic: parentAssetTopic,
-    asset: subAsset,
-    assetDescription: "Example pump owned by a separate microservice",
-    objectType: GeneratedObjectTypes["equipment"],
-    objectId: "main",
-    attributes: {
-      attribute: GeneratedAttributesByType["equipment"]["temperature"],
-      description: "Example sub-asset temperature",
-      valueType: "number",
-      presentationKind: "chart",
-      defaultAggregation: "last",
-      data: {
-        time,
-        value: 42,
-        uom: GeneratedPhysicalMeasurements.Celsius,
-        intervalStart,
-        intervalEnd,
-      },
-    },
-  });
-
-  logger.info(
-    "Published sub-asset example to " +
-      `${parentAssetTopic}${subAsset}/equipment/main/temperature`,
-  );
-} finally {
-  await mqttOutput.stop();
-  unsProxyProcess.shutdown();
-}
+/**
+ * Example: publish a sub-asset under an existing parent asset.
+ *
+ * V1 sub-assets use the normal UNS publish fields:
+ * - topic is the full parent asset path
+ * - asset is only the leaf sub-asset name
+ */
+import { ConfigFile, UnsProxyProcess, getLogger } from "@uns-kit/core";
+import { registerAttributeDescriptions, registerObjectTypeDescriptions } from "@uns-kit/core/uns/uns-dictionary-registry.js";
+import type { ISO8601 } from "@uns-kit/core/uns/uns-interfaces.js";
+import { UnsTopics } from "@uns-kit/core/uns/uns-topics.js";
+import { GeneratedPhysicalMeasurements } from "../uns/uns-measurements.generated.js";
+import {
+  GeneratedAttributeDescriptions,
+  GeneratedAttributesByType,
+  GeneratedObjectTypeDescriptions,
+  GeneratedObjectTypes,
+} from "../uns/uns-dictionary.generated.js";
+import { resolveGeneratedAsset } from "../uns/uns-assets.js";
+
+const logger = getLogger(import.meta.url);
+
+const config = await ConfigFile.loadConfig();
+registerObjectTypeDescriptions(GeneratedObjectTypeDescriptions);
+registerAttributeDescriptions(GeneratedAttributeDescriptions);
+
+const unsProxyProcess = new UnsProxyProcess(config.infra.host!, {
+  processName: config.uns.processName!,
+});
+
+const mqttOutput = await unsProxyProcess.createUnsMqttProxy(
+  config.output?.host!,
+  "templateSubassetExampleOutput",
+  config.uns.instanceMode!,
+  config.uns.handover!,
+  { publishThrottlingDelay: 1000 },
+);
+
+try {
+  const parentAssetTopic: UnsTopics = "enterprise/site/area/line-1/";
+  const subAsset = resolveGeneratedAsset("pump-1");
+  const now = new Date();
+  const time = now.toISOString() as ISO8601;
+  const intervalStart = new Date(now.getTime() - 1000).toISOString() as ISO8601;
+  const intervalEnd = time;
+
+  await mqttOutput.publishMqttMessage({
+    topic: parentAssetTopic,
+    asset: subAsset,
+    assetDescription: "Example pump owned by a separate microservice",
+    objectType: GeneratedObjectTypes["equipment"],
+    objectId: "main",
+    attributes: {
+      attribute: GeneratedAttributesByType["equipment"]["temperature"],
+      description: "Example sub-asset temperature",
+      valueType: "number",
+      presentationKind: "chart",
+      defaultAggregation: "last",
+      data: {
+        time,
+        value: 42,
+        uom: GeneratedPhysicalMeasurements.Celsius,
+        intervalStart,
+        intervalEnd,
+      },
+    },
+  });
+
+  logger.info(
+    "Published sub-asset example to " +
+      `${parentAssetTopic}${subAsset}/equipment/main/temperature`,
+  );
+} finally {
+  await unsProxyProcess.shutdown();
+}