@uns-kit/cli 2.0.69 → 2.0.70

package/dist/index.js

@@ -369,8 +369,8 @@ async function main(): Promise<void> {
 
   const time = new Date().toISOString() as ISO8601;
 
-  for (const output of outputContracts) {
-    await mqttOutput.publishMqttMessage({
+  for (const output of outputContracts) {
+    await mqttOutput.publishMqttMessage({
       topic: topicPrefixForPublish(output.topicPrefix),
       asset: output.asset,
       objectType: output.objectType,
@@ -386,11 +386,15 @@ async function main(): Promise<void> {
         validityMode: "interval",
         expectedIntervalMs: output.expectedIntervalMs,
       },
-    });
-  }
-
-  console.log(\`UNS process '\${processName}' published \${outputContracts.length} interval example output(s).\`);
-}
+    });
+  }
+
+  await mqttOutput.flush();
+  await mqttOutput.stop();
+  await unsProcess.shutdown();
+
+  console.log(\`UNS process '\${processName}' published \${outputContracts.length} interval example output(s).\`);
+}
 
 void main();
 `;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uns-kit/cli",
-  "version": "2.0.69",
+  "version": "2.0.70",
   "description": "Command line scaffolding tool for UNS applications",
   "type": "module",
   "license": "MIT",
@@ -26,13 +26,13 @@
   ],
   "dependencies": {
     "azure-devops-node-api": "^15.1.1",
-    "@uns-kit/core": "2.0.69"
+    "@uns-kit/core": "2.0.70"
   },
   "unsKitPackages": {
-    "@uns-kit/core": "2.0.69",
-    "@uns-kit/api": "2.0.69",
-    "@uns-kit/cron": "2.0.69",
-    "@uns-kit/database": "2.0.69"
+    "@uns-kit/core": "2.0.70",
+    "@uns-kit/api": "2.0.70",
+    "@uns-kit/cron": "2.0.70",
+    "@uns-kit/database": "2.0.70"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",

package/templates/default/README.md

@@ -27,22 +27,25 @@ UNS attributes can declare how the controller decides whether they are live or s
 - `interval`: continuously refreshed values (stale after ~2× `expectedIntervalMs`)
 - `lifecycle`: event-driven activity that stays active until a defined end value (`lifecycleEndValue`)
 
-Example:
+Example:
 
 ```ts
-await proxy.publishMqttMessage({
-  topic: "raw/data/",
-  asset: "line-1",
+await proxy.publishMqttMessage({
+  topic: "raw/data/",
+  asset: "line-1",
   objectType: "motor",
   objectId: "main",
   attributes: {
     attribute: "status",
     data: { time: new Date().toISOString(), value: "RUNNING" },
     validityMode: "lifecycle",
-    lifecycleEndValue: "STOPPED",
-  },
-});
-```
+    lifecycleEndValue: "STOPPED",
+  },
+});
+await proxy.flush();
+```
+
+`publishMqttMessage()` resolves when the message is accepted into the local bounded publisher queue, not when the broker confirms it. Queue-full is reported immediately to the caller. Broker publish failures are emitted later on the proxy `error` event, so use `await proxy.flush()` before shutdown or before assuming all accepted messages were published.
 
 ## Schema System Metadata
 

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

@@ -27,15 +27,15 @@ 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.
+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) => {
@@ -60,12 +60,13 @@ mqttInput.event.on("input", async (event) => {
       const asset = resolveGeneratedAsset("asset");
       const assetDescription = ""; // customize manually
 
-      mqttOutput.publishMqttMessage({
-        topic,
-        asset,
-        assetDescription,
+      await mqttOutput.publishMqttMessage({
+        topic,
+        asset,
+        assetDescription,
         objectType: GeneratedObjectTypes["energy-resource"],
         objectId: "main",
+        virtualGroup: "metering",
         attributes: [
           {
             attribute: GeneratedAttributesByType["energy-resource"]["current"],
@@ -85,11 +86,11 @@ mqttInput.event.on("input", async (event) => {
             data: { dataGroup, time, value: numberValue, uom: GeneratedPhysicalMeasurements.KiloWattHour, intervalStart, intervalEnd },
           },
         ],
-      });
-    }
-  } catch (error) {
+      });
+    }
+  } 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

@@ -80,11 +80,11 @@ async function main() {
               }
             }
 
-            logger.info(`Sleeping for 50ms.`);
-            await new Promise((resolve) => setTimeout(resolve, 50));
-
-            const endTime = Date.now();
-            const duration = (endTime - startTime) / 1000;
+            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.`);

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

@@ -119,7 +119,8 @@ try {
   });
 
   logger.info(`Published schema-system metadata example for material ${currentMaterialId}.`);
-} finally {
-  await mqttOutput.stop();
-  unsProxyProcess.shutdown();
-}
+} finally {
+  await mqttOutput.flush();
+  await mqttOutput.stop();
+  await unsProxyProcess.shutdown();
+}

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

@@ -70,7 +70,8 @@ try {
     "Published sub-asset example to " +
       `${parentAssetTopic}${subAsset}/equipment/main/temperature`,
   );
-} finally {
-  await mqttOutput.stop();
-  unsProxyProcess.shutdown();
-}
+} finally {
+  await mqttOutput.flush();
+  await mqttOutput.stop();
+  await unsProxyProcess.shutdown();
+}

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

@@ -33,12 +33,12 @@ const unsProxyProcess = new UnsProxyProcess(config.infra.host!, {processName: co
 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.
+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.
  */
@@ -77,12 +77,13 @@ mqttInput.event.on("input", async (event) => {
       const topic: UnsTopics = "enterprise/site/area/line/";
       const asset = resolveGeneratedAsset("asset");
       const assetDescription = ""; // customize manually
-      mqttOutput.publishMqttMessage({
-        topic,
-        asset,
-        assetDescription,
+      await mqttOutput.publishMqttMessage({
+        topic,
+        asset,
+        assetDescription,
         objectType: GeneratedObjectTypes["energy-resource"],
         objectId: "main",
+        virtualGroup: "metering",
         attributes: [
           {
             attribute: "measurements",
@@ -97,9 +98,9 @@ mqttInput.event.on("input", async (event) => {
             },
           },
         ],
-      });
-    }
-  } catch (error) {
+      });
+    }
+  } 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/table-window-load-test.ts

@@ -431,12 +431,11 @@ async function main() {
       }
     }
 
-    // Give the worker queue a moment to publish before exiting.
-    await sleep(500);
-  } finally {
-    rl.close();
-    await mqttOutput?.stop();
-  }
+    await mqttOutput?.flush();
+  } finally {
+    rl.close();
+    await mqttOutput?.stop();
+  }
 }
 
 main().catch((error) => {

package/templates/default/src/index.ts

@@ -17,7 +17,7 @@ async function main(): Promise<void> {
 
   const time = new Date().toISOString() as ISO8601;
 
-  await mqttOutput.publishMqttMessage({
+  await mqttOutput.publishMqttMessage({
     topic: "example/site/area/line/",
     asset: "demo-asset",
     objectType: "utility-resource",
@@ -33,9 +33,13 @@ async function main(): Promise<void> {
       validityMode: "lifecycle",
       lifecycleEndValue: "stopped",
     },
-  });
-
-  console.log(`UNS process '${processName}' is ready. Edit src/index.ts to add your logic.`);
-}
+  });
+
+  await mqttOutput.flush();
+  await mqttOutput.stop();
+  await unsProcess.shutdown();
+
+  console.log(`UNS process '${processName}' is ready. Edit src/index.ts to add your logic.`);
+}
 
 void main();