@uns-kit/cli 2.0.24 → 2.0.25

package/dist/index.js

@@ -374,6 +374,21 @@ async function initGitRepository(targetDir) {
         return false;
     }
 }
+function setPackageScript(scripts, name, command) {
+    if (scripts[name] === command) {
+        return false;
+    }
+    scripts[name] = command;
+    return true;
+}
+function ensureUnsReferenceScripts(scripts) {
+    let changed = false;
+    changed = setPackageScript(scripts, "generate-uns-dictionary", "node ./node_modules/@uns-kit/core/dist/tools/generate-uns-dictionary.js --input uns-dictionary.json --output src/uns/uns-dictionary.generated.ts") || changed;
+    changed = setPackageScript(scripts, "generate-uns-measurements", "node ./node_modules/@uns-kit/core/dist/tools/generate-uns-measurements.js --input uns-measurements.json --output src/uns/uns-measurements.generated.ts") || changed;
+    changed = setPackageScript(scripts, "generate-uns-reference", "node ./node_modules/@uns-kit/core/dist/tools/generate-uns-reference.js --dictionary uns-dictionary.json --dictionary-output src/uns/uns-dictionary.generated.ts --measurements uns-measurements.json --measurements-output src/uns/uns-measurements.generated.ts") || changed;
+    changed = setPackageScript(scripts, "sync-uns-schema", "node ./node_modules/@uns-kit/core/dist/tools/sync-uns-schema.js") || changed;
+    return changed;
+}
 async function configureDevops(targetPath, options) {
     const targetDir = path.resolve(process.cwd(), targetPath ?? ".");
     await ensureGitRepository(targetDir);
@@ -762,6 +777,7 @@ async function configurePython(targetPath, options = {}) {
     });
 }
 async function configureUnsReference(targetPath, options = {}) {
+    const targetDir = path.resolve(process.cwd(), targetPath ?? ".");
     await configurePlugin({
         targetPath,
         templateName: "uns-dictionary",
@@ -774,6 +790,27 @@ async function configureUnsReference(targetPath, options = {}) {
         label: "UNS measurements (units)",
         overwrite: options.overwrite,
     });
+    const packagePath = path.join(targetDir, "package.json");
+    let pkgRaw;
+    try {
+        pkgRaw = await readFile(packagePath, "utf8");
+    }
+    catch (error) {
+        if (error.code === "ENOENT") {
+            throw new Error(`Could not find package.json in ${targetDir}`);
+        }
+        throw error;
+    }
+    const pkg = JSON.parse(pkgRaw);
+    const scripts = (pkg.scripts ??= {});
+    const pkgChanged = ensureUnsReferenceScripts(scripts);
+    if (pkgChanged) {
+        await writeFile(packagePath, JSON.stringify(pkg, null, 2) + "\n", "utf8");
+        console.log("  Updated package.json schema scripts.");
+    }
+    else {
+        console.log("  Existing package.json already contained schema scripts.");
+    }
 }
 const configureFeatureHandlers = {
     devops: configureDevops,

package/package.json

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

package/templates/cron/AGENTS.md

@@ -19,5 +19,6 @@ Pointers for AI/code-assist tools when working in this generated project.
 - `pnpm run generate-uns-dictionary` -> updates `src/uns/uns-dictionary.generated.ts`
 - `pnpm run generate-uns-measurements` -> updates `src/uns/uns-measurements.generated.ts`
 - `pnpm run generate-uns-reference` -> runs both
-- `pnpm run generate-uns-topics-tags` -> refreshes topic/tag unions (requires GraphQL connectivity)
+- `pnpm run generate-uns-metadata` -> refreshes topic/tag unions (requires GraphQL connectivity)
 - `pnpm run generate-codegen` -> GraphQL codegen (after configure-codegen)
+- `pnpm run sync-uns-schema -- --controller-url ... --token ...` -> pulls `uns-dictionary.json` + `uns-measurements.json` from the controller and regenerates local TS helpers

package/templates/default/AGENTS.md

@@ -19,5 +19,6 @@ Pointers for AI/code-assist tools when working in this generated project.
 - `pnpm run generate-uns-dictionary` -> updates `src/uns/uns-dictionary.generated.ts`
 - `pnpm run generate-uns-measurements` -> updates `src/uns/uns-measurements.generated.ts`
 - `pnpm run generate-uns-reference` -> runs both
-- `pnpm run generate-uns-topics-tags` -> refreshes topic/tag unions (requires GraphQL connectivity)
+- `pnpm run generate-uns-metadata` -> refreshes topic/tag unions (requires GraphQL connectivity)
 - `pnpm run generate-codegen` -> GraphQL codegen (after configure-codegen)
+- `pnpm run sync-uns-schema -- --controller-url ... --token ...` -> pulls `uns-dictionary.json` + `uns-measurements.json` from the controller and regenerates local TS helpers

package/templates/default/README.md

@@ -12,10 +12,11 @@ pnpm run build  # emit dist/ output
 pnpm run start  # run the compiled entrypoint
 pnpm run generate-config-schema  # regenerate config.schema.json and AppConfig augmentations
 pnpm run generate-codegen            # regenerate typed GraphQL operations (after configure-codegen)
-pnpm run generate-uns-topics-tags  # rebuild UNS topics/tags from the live schema
+pnpm run generate-uns-metadata  # rebuild UNS topics/tags from the live schema
 pnpm run generate-uns-dictionary  # generate typed object/attribute dictionary from uns-dictionary.json
 pnpm run generate-uns-measurements  # generate typed measurement units from uns-measurements.json
 pnpm run generate-uns-reference    # run both dictionary + measurements generators
+pnpm run sync-uns-schema -- --controller-url http://localhost:3200 --token <admin-bearer-token>  # pull dictionary + measurements from the controller
 ```
 
 ## Configuration
@@ -30,7 +31,8 @@ Update `config.json` with your broker, UNS URLs, and credentials. The generated
 - Run `uns-kit configure-devops` to add the Azure DevOps pull-request tooling.
 - Run `uns-kit configure-vscode` to copy workspace/launch configuration for VS Code.
 - Run `uns-kit configure-codegen` to scaffold GraphQL code generation and UNS refresh scripts.
-- Edit `uns-dictionary.json` (object types/attributes + descriptions) and run `pnpm run generate-uns-dictionary` to emit `src/uns/uns-dictionary.generated.ts` for IDE hints/metadata; publish calls will automatically fall back to these descriptions when you omit them.
+- Run `pnpm run sync-uns-schema -- --controller-url ... --token ...` to pull `uns-dictionary.json` and `uns-measurements.json` from the controller export into this project, then regenerate the typed files automatically.
+- If you want to curate local files manually, edit `uns-dictionary.json` (object types/attributes + descriptions) and run `pnpm run generate-uns-dictionary` to emit `src/uns/uns-dictionary.generated.ts` for IDE hints/metadata; publish calls will automatically fall back to these descriptions when you omit them.
 - Edit `uns-measurements.json` (units + descriptions) and run `pnpm run generate-uns-measurements` to emit `src/uns/uns-measurements.generated.ts` and feed measurement unit IntelliSense.
 - Run `uns-kit configure-api` / `configure-cron` / `configure-temporal` to pull in example stubs and install the matching UNS plugins (add `--overwrite` to refresh templates).
 - Run `uns-kit configure-python` to copy the Python gateway client template (examples, scripts, proto).

package/templates/default/package.json

@@ -29,7 +29,10 @@
     "generate-config-schema": "node ./node_modules/@uns-kit/core/dist/tools/generate-config-schema.js",
     "generate-codegen": "graphql-code-generator --require dotenv/config --config codegen.ts",
     "generate-uns-metadata": "node ./node_modules/@uns-kit/core/dist/tools/refresh-uns.js",
-    "generate-uns-measurements": "node ./node_modules/@uns-kit/core/dist/tools/generate-uns-measurements.js --input uns-measurements.json --output src/uns/uns-measurements.generated.ts"
+    "generate-uns-dictionary": "node ./node_modules/@uns-kit/core/dist/tools/generate-uns-dictionary.js --input uns-dictionary.json --output src/uns/uns-dictionary.generated.ts",
+    "generate-uns-measurements": "node ./node_modules/@uns-kit/core/dist/tools/generate-uns-measurements.js --input uns-measurements.json --output src/uns/uns-measurements.generated.ts",
+    "generate-uns-reference": "node ./node_modules/@uns-kit/core/dist/tools/generate-uns-reference.js --dictionary uns-dictionary.json --dictionary-output src/uns/uns-dictionary.generated.ts --measurements uns-measurements.json --measurements-output src/uns/uns-measurements.generated.ts",
+    "sync-uns-schema": "node ./node_modules/@uns-kit/core/dist/tools/sync-uns-schema.js"
   },
   "dependencies": {
     "@uns-kit/core": "__UNS_KIT_CORE_VERSION__",