@uns-kit/cli 2.0.67 → 2.0.69

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uns-kit/cli",
-  "version": "2.0.67",
+  "version": "2.0.69",
   "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.67"
+    "@uns-kit/core": "2.0.69"
   },
   "unsKitPackages": {
-    "@uns-kit/core": "2.0.67",
-    "@uns-kit/api": "2.0.67",
-    "@uns-kit/cron": "2.0.67",
-    "@uns-kit/database": "2.0.67"
+    "@uns-kit/core": "2.0.69",
+    "@uns-kit/api": "2.0.69",
+    "@uns-kit/cron": "2.0.69",
+    "@uns-kit/database": "2.0.69"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",

package/templates/default/README.md

@@ -55,6 +55,19 @@ shows how a producer publishes:
 These fields are retained in the produced-topics registry and stored by the
 UNS Datahub controller in `attribute_schema.schema_json`.
 
+## Sub-Asset Publishing
+
+The template includes `src/examples/subasset-example.ts`, which shows the V1
+sub-asset convention:
+
+- put the full parent asset path in `topic`
+- put only the leaf sub-asset name in `asset`
+
+For example, `topic: "enterprise/site/area/line-1/"` and `asset: "pump-1"`
+publish `enterprise/site/area/line-1/pump-1/equipment/main/temperature`.
+Downstream QuestDB storage keeps the existing columns: `topic` is the parent
+asset path and `asset` is the leaf sub-asset.
+
 ## Datahub client (last value)
 
 `UnsClient` provides a minimal REST client for the UNS Datahub API, including the batch last-value endpoint. Prefer a long-lived service token if available; you can pass it directly and skip username/password auth.

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

@@ -0,0 +1,76 @@
+/**
+ * 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();
+}