@uns-kit/cli 3.0.4 → 3.0.6

package/README.md

@@ -2,16 +2,16 @@
 
 Command line scaffolding tool for the UNS toolkit. Bootstraps new projects with `@uns-kit/core` preconfigured and ready to extend with plugins. Also provides configure and upgrade commands for existing projects.
 
-Note: Apps built with uns-kit are intended to be managed by the **UNS Datahub controller**.
+Note: Apps built with uns-kit are intended to be managed by the **UNS OpenHub controller**.
 
 ## uns-kit in context
 
 | Package | Description |
 | --- | --- |
-| [`@uns-kit/core`](https://github.com/uns-datahub/uns-kit/tree/main/packages/uns-core) | Base runtime (UnsProxyProcess, MQTT helpers, config tooling, gRPC gateway). |
-| [`@uns-kit/api`](https://github.com/uns-datahub/uns-kit/tree/main/packages/uns-api) | Express plugin — HTTP endpoints, JWT/JWKS auth, Swagger, UNS metadata. |
-| [`@uns-kit/cron`](https://github.com/uns-datahub/uns-kit/tree/main/packages/uns-cron) | Cron-driven scheduler that emits UNS events on a fixed cadence. |
-| [`@uns-kit/cli`](https://github.com/uns-datahub/uns-kit/tree/main/packages/uns-cli) | CLI for scaffolding new UNS applications. |
+| [`@uns-kit/core`](https://github.com/uns-openhub/uns-kit/tree/main/packages/uns-core) | Base runtime (UnsProxyProcess, MQTT helpers, config tooling, gRPC gateway). |
+| [`@uns-kit/api`](https://github.com/uns-openhub/uns-kit/tree/main/packages/uns-api) | Express plugin — HTTP endpoints, JWT/JWKS auth, Swagger, UNS metadata. |
+| [`@uns-kit/cron`](https://github.com/uns-openhub/uns-kit/tree/main/packages/uns-cron) | Cron-driven scheduler that emits UNS events on a fixed cadence. |
+| [`@uns-kit/cli`](https://github.com/uns-openhub/uns-kit/tree/main/packages/uns-cli) | CLI for scaffolding new UNS applications. |
 
 ## Prerequisites
 
@@ -35,7 +35,7 @@ pnpm install
 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 scaffold creates a project directory from the default TypeScript template, pins `@uns-kit/core` to the current version, initialises a git repository if `git` is available, and marks the package as a controller-installable UNS OpenHub add-on in `package.json`.
 
 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.
 
@@ -139,7 +139,7 @@ uns-kit upgrade           # upgrade current directory
 uns-kit upgrade ./my-app  # upgrade a specific project
 ```
 
-Removes scripts that have been superseded (`generate-uns-dictionary`, `generate-uns-measurements`, `generate-uns-reference`, `generate-uns-metadata`), ensures the `sync-uns-*` scripts are present, and adds an idempotent managed section to `AGENTS.md` that directs agents to version-bounded `@uns-kit/core` migrations. Existing project-specific agent instructions are preserved.
+Removes scripts that have been superseded (`generate-uns-dictionary`, `generate-uns-measurements`, `generate-uns-reference`, `generate-uns-metadata`), ensures the `sync-uns-*` scripts and `package.json` UNS OpenHub add-on metadata are present, and adds an idempotent managed section to `AGENTS.md` that directs agents to version-bounded `@uns-kit/core` migrations. Existing package metadata and project-specific agent instructions are preserved.
 
 The installed migration guide is `node_modules/@uns-kit/core/MIGRATIONS.md`.
 For example, an upgrade crossing `<2.0.71` to `>=2.0.71` must review MQTT

package/dist/index.js

@@ -489,6 +489,18 @@ async function initGitRepository(targetDir) {
         return false;
     }
 }
+const DEFAULT_UNS_DATAHUB_ADDON_METADATA = {
+    schemaVersion: 1,
+    kind: "addon",
+    controllerCompatibility: ">=7.1 <8",
+};
+function ensureUnsDatahubAddonMetadata(pkg) {
+    if (pkg.unsDatahub !== undefined) {
+        return false;
+    }
+    pkg.unsDatahub = { ...DEFAULT_UNS_DATAHUB_ADDON_METADATA };
+    return true;
+}
 function setPackageScript(scripts, name, command) {
     if (scripts[name] === command) {
         return false;
@@ -981,6 +993,8 @@ async function upgradeProject(targetPath) {
     const pkg = JSON.parse(pkgRaw);
     const scripts = (pkg.scripts ??= {});
     let changed = false;
+    const addonMetadataChanged = ensureUnsDatahubAddonMetadata(pkg);
+    changed = addonMetadataChanged || changed;
     const removed = [];
     for (const name of OBSOLETE_SCRIPTS) {
         if (scripts[name] !== undefined) {
@@ -993,7 +1007,7 @@ async function upgradeProject(targetPath) {
     changed = syncScriptsChanged || changed;
     const agentGuidanceResult = await ensureAgentMigrationGuidance(targetDir);
     changed = agentGuidanceResult !== "unchanged" || changed;
-    if (removed.length > 0 || syncScriptsChanged) {
+    if (removed.length > 0 || syncScriptsChanged || addonMetadataChanged) {
         await writeFile(packagePath, JSON.stringify(pkg, null, 2) + "\n", "utf8");
     }
     console.log(`\nUpgrade complete for ${targetDir}`);
@@ -1009,6 +1023,12 @@ async function upgradeProject(targetPath) {
     else {
         console.log("  Ensured: sync-uns-schema, sync-uns-metadata");
     }
+    if (addonMetadataChanged) {
+        console.log("  Added: package.json unsDatahub add-on metadata");
+    }
+    else {
+        console.log("  Preserved: existing package.json unsDatahub metadata");
+    }
     if (agentGuidanceResult === "created") {
         console.log("  Created AGENTS.md with version-bounded migration guidance.");
     }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@uns-kit/cli",
-  "version": "3.0.4",
+  "version": "3.0.6",
   "description": "Command line scaffolding tool for UNS applications",
   "type": "module",
   "license": "MIT",
   "author": "Aljoša Vister <aljosa.vister@gmail.com>",
   "repository": {
     "type": "git",
-    "url": "https://github.com/uns-datahub/uns-kit.git",
+    "url": "https://github.com/uns-openhub/uns-kit.git",
     "directory": "packages/uns-cli"
   },
   "bin": {
@@ -25,15 +25,15 @@
     "templates"
   ],
   "dependencies": {
-    "azure-devops-node-api": "^15.1.1",
-    "@uns-kit/core": "3.0.4"
+    "azure-devops-node-api": "^15.1.2",
+    "@uns-kit/core": "3.0.6"
   },
   "unsKitPackages": {
-    "@uns-kit/core": "3.0.4",
-    "@uns-kit/api": "3.0.4",
-    "@uns-kit/cron": "3.0.4",
-    "@uns-kit/database": "3.0.4",
-    "@uns-kit/assistant-workflow": "3.0.4"
+    "@uns-kit/core": "3.0.6",
+    "@uns-kit/api": "3.0.6",
+    "@uns-kit/cron": "3.0.6",
+    "@uns-kit/database": "3.0.6",
+    "@uns-kit/assistant-workflow": "3.0.6"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",

package/templates/default/README.md

@@ -69,7 +69,7 @@ shows how a producer publishes:
 - `systemRole: "lifecycle-time-source"` with `lifecycle`
 
 These fields are retained in the produced-topics registry and stored by the
-UNS Datahub controller in `attribute_schema.schema_json`.
+UNS OpenHub controller in `attribute_schema.schema_json`.
 
 ## Sub-Asset Publishing
 
@@ -86,7 +86,7 @@ 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.
+`UnsClient` provides a minimal REST client for the UNS OpenHub 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 { ConfigFile, UnsClient } from "@uns-kit/core";

package/templates/default/package.json

@@ -3,6 +3,11 @@
   "version": "0.0.0",
   "private": true,
   "description": "UNS application generated by @uns-kit/cli",
+  "unsDatahub": {
+    "schemaVersion": 1,
+    "kind": "addon",
+    "controllerCompatibility": ">=7.1 <8"
+  },
   "type": "module",
   "engines": {
     "node": ">=22"