@uns-kit/cli 2.0.37 → 2.0.38

package/README.md

@@ -37,6 +37,8 @@ pnpm run dev
 
 The scaffold creates a project directory from the default TypeScript template, pins `@uns-kit/core` to the current version, and initialises a git repository if `git` is available.
 
+The default template includes a Datahub REST client example (`UnsClient`) for last-value lookups, using a token-first pattern suitable for long-lived service tokens.
+
 ### Create from a service bundle
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uns-kit/cli",
-  "version": "2.0.37",
+  "version": "2.0.38",
   "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.37"
+    "@uns-kit/core": "2.0.38"
   },
   "unsKitPackages": {
-    "@uns-kit/core": "2.0.37",
-    "@uns-kit/api": "2.0.36",
-    "@uns-kit/cron": "2.0.36",
-    "@uns-kit/temporal": "2.0.37"
+    "@uns-kit/core": "2.0.38",
+    "@uns-kit/api": "2.0.38",
+    "@uns-kit/cron": "2.0.38",
+    "@uns-kit/temporal": "2.0.38"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",

package/templates/default/README.md

@@ -23,6 +23,49 @@ pnpm run sync-uns-schema -- --controller-url http://localhost:3200 --token <admi
 
 Update `config.json` with your broker, UNS URLs, and credentials. The generated file contains sensible defaults for local development.
 
+## Validity / Liveliness
+
+UNS attributes can declare how the controller decides whether they are live or stale. These fields are optional and default to `"interval"` with the controller default (~120s) if omitted.
+
+- `validityMode`: `"interval" | "lifecycle" | "static"`
+- `expectedIntervalMs`: required for `"interval"` mode (controller marks stale after ~2x this interval)
+- `lifecycleEndValue`: required for `"lifecycle"` mode (end-state marker, e.g. `"EXITED"`)
+
+Example:
+
+```ts
+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",
+  },
+});
+```
+
+## 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.
+
+```ts
+import { UnsClient } from "@uns-kit/core";
+
+const client = new UnsClient("https://datahub.example.com", {
+  token: process.env.UNS_SERVICE_TOKEN,
+});
+
+const values = await client.lastValue([
+  "raw/data/line-1/motor/main/temperature",
+  "raw/data/line-1/motor/main/status",
+]);
+console.log(values);
+```
+
 ## Next Steps
 
 - Install additional plugins: `pnpm add @uns-kit/api` etc.

package/templates/default/src/index.ts

@@ -6,10 +6,28 @@ async function main(): Promise<void> {
     processName: name,
   });
 
-  console.log(`UNS process '${name}' is ready. Edit src/index.ts to add your logic.`);
+  const proxy = await process.createMqttProxy("ts-output");
+
+  await proxy.publishMqttMessage({
+    topic: "example/site/area/line/",
+    asset: "demo-asset",
+    objectType: "utility-resource",
+    objectId: "main",
+    attributes: {
+      attribute: "status",
+      description: "Service startup marker",
+      data: {
+        time: new Date().toISOString(),
+        value: "started",
+        uom: "state",
+        dataGroup: "runtime",
+      },
+      validityMode: "lifecycle",
+      lifecycleEndValue: "stopped",
+    },
+  });
 
-  // Keep the process alive or add plugin logic here
-  void process;
+  console.log(`UNS process '${name}' is ready. Edit src/index.ts to add your logic.`);
 }
 
 void main();