@uns-kit/cli 2.0.68 → 2.0.70

package/templates/default/src/examples/schema-system-metadata-example.ts

@@ -1,125 +1,126 @@
-/**
- * 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}.`);
+/**
+ * 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.flush();
   await mqttOutput.stop();
-  unsProxyProcess.shutdown();
+  await unsProxyProcess.shutdown();
 }

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

@@ -1,76 +1,77 @@
-/**
- * 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`,
-  );
+/**
+ * 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.flush();
   await mqttOutput.stop();
-  unsProxyProcess.shutdown();
+  await unsProxyProcess.shutdown();
 }

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

@@ -1,107 +1,108 @@
-/**
- * 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 { UnsTopics } from "@uns-kit/core/uns/uns-topics.js";
-import {
-  GeneratedObjectTypes,
-  GeneratedAttributeDescriptions,
-  GeneratedObjectTypeDescriptions,
-} from "../uns/uns-dictionary.generated.js";
-import { GeneratedAssets, resolveGeneratedAsset } from "../uns/uns-assets.js";
-import type { IUnsTableColumn, IUnsTableColumnMetadata } from "@uns-kit/core/uns/uns-interfaces.js";
-import type { ISO8601 } from "@uns-kit/core/uns/uns-interfaces.js";
-import { GeneratedPhysicalMeasurements } from "../uns/uns-measurements.generated.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);
-registerAttributeDescriptions(GeneratedAttributeDescriptions);
-
-/**
- * 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: ["raw/#"],
-});
+/**
+ * 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 { UnsTopics } from "@uns-kit/core/uns/uns-topics.js";
+import {
+  GeneratedObjectTypes,
+  GeneratedAttributeDescriptions,
+  GeneratedObjectTypeDescriptions,
+} from "../uns/uns-dictionary.generated.js";
+import { GeneratedAssets, resolveGeneratedAsset } from "../uns/uns-assets.js";
+import type { IUnsTableColumn, IUnsTableColumnMetadata } from "@uns-kit/core/uns/uns-interfaces.js";
+import type { ISO8601 } from "@uns-kit/core/uns/uns-interfaces.js";
+import { GeneratedPhysicalMeasurements } from "../uns/uns-measurements.generated.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);
+registerAttributeDescriptions(GeneratedAttributeDescriptions);
+
+/**
+ * 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: ["raw/#"],
+});
 const mqttOutput = await unsProxyProcess.createUnsMqttProxy((config.output?.host)!, "templateUnsRttOutput", config.uns.instanceMode!, config.uns.handover!, {
   publishThrottlingDelay: 1000,
 });
 
 /**
  * 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 === "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 currentValue = 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_table";
-      const columns: IUnsTableColumn[] = [
-        { name: "current", type: "double", value: currentValue, uom: GeneratedPhysicalMeasurements.Ampere },
-        { name: "voltage", type: "double", value: sensorValue },
-        { name: "active_energy_total", type: "double", value: currentValue, uom: GeneratedPhysicalMeasurements.KiloWattHour },
-      ];
-      const tableColumns: IUnsTableColumnMetadata[] = [
-        {
-          name: "active_energy_total",
-          valueType: "number",
-          presentationKind: "counter",
-          defaultAggregation: "last",
-          counterResetPolicy: "new-value",
-        },
-      ];
-      const topic: UnsTopics = "enterprise/site/area/line/";
-      const asset = resolveGeneratedAsset("asset");
-      const assetDescription = ""; // customize manually
-      mqttOutput.publishMqttMessage({
+ * 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 === "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 currentValue = 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_table";
+      const columns: IUnsTableColumn[] = [
+        { name: "current", type: "double", value: currentValue, uom: GeneratedPhysicalMeasurements.Ampere },
+        { name: "voltage", type: "double", value: sensorValue },
+        { name: "active_energy_total", type: "double", value: currentValue, uom: GeneratedPhysicalMeasurements.KiloWattHour },
+      ];
+      const tableColumns: IUnsTableColumnMetadata[] = [
+        {
+          name: "active_energy_total",
+          valueType: "number",
+          presentationKind: "counter",
+          defaultAggregation: "last",
+          counterResetPolicy: "new-value",
+        },
+      ];
+      const topic: UnsTopics = "enterprise/site/area/line/";
+      const asset = resolveGeneratedAsset("asset");
+      const assetDescription = ""; // customize manually
+      await mqttOutput.publishMqttMessage({
         topic,
         asset,
         assetDescription,
-        objectType: GeneratedObjectTypes["energy-resource"],
-        objectId: "main",
-        attributes: [
-          {
-            attribute: "measurements",
-            description: GeneratedAttributeDescriptions["status"] ?? "Table measurements with a counter column",
-            tableColumns,
-            table: {
-              dataGroup,
-              time,
-              intervalStart,
-              intervalEnd,
-              columns,
-            },
-          },
-        ],
+        objectType: GeneratedObjectTypes["energy-resource"],
+        objectId: "main",
+        virtualGroup: "metering",
+        attributes: [
+          {
+            attribute: "measurements",
+            description: GeneratedAttributeDescriptions["status"] ?? "Table measurements with a counter column",
+            tableColumns,
+            table: {
+              dataGroup,
+              time,
+              intervalStart,
+              intervalEnd,
+              columns,
+            },
+          },
+        ],
       });
     }
   } catch (error) {
-    const reason = error instanceof Error ? error : new Error(String(error));
-    logger.error(`Error publishing message to MQTT: ${reason.message}`);
-    throw reason;
-  }
-});
+    const reason = error instanceof Error ? error : new Error(String(error));
+    logger.error(`Error publishing message to MQTT: ${reason.message}`);
+    throw reason;
+  }
+});