@uns-kit/cli 2.0.56 → 2.0.57

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Aljoša Vister
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 Aljoša Vister
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,169 +1,169 @@
-# @uns-kit/cli
-
-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**.
-
-## 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. |
-
-## Prerequisites
-
-- Node.js 22 or newer
-- `pnpm`, `npm`, or `yarn`
-- `git` on PATH (used to initialise new projects and for `configure-devops`)
-
-## Create a new project
-
-```bash
-pnpm --package=@uns-kit/cli dlx uns-kit create my-uns-app
-# or with npx
-npx @uns-kit/cli create my-uns-app
-```
-
-After scaffolding:
-
-```bash
-cd my-uns-app
-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.
-
+# @uns-kit/cli
+
+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**.
+
+## 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. |
+
+## Prerequisites
+
+- Node.js 22 or newer
+- `pnpm`, `npm`, or `yarn`
+- `git` on PATH (used to initialise new projects and for `configure-devops`)
+
+## Create a new project
+
+```bash
+pnpm --package=@uns-kit/cli dlx uns-kit create my-uns-app
+# or with npx
+npx @uns-kit/cli create my-uns-app
+```
+
+After scaffolding:
+
+```bash
+cd my-uns-app
+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 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
-uns-kit create --bundle ./service.bundle.json
-uns-kit create --bundle ./service.bundle.json --dest ./my-dir
-uns-kit create --bundle ./service.bundle.json --dest . --allow-existing
-```
-
-Bundle-driven create uses `service.bundle.json` as the source of truth. The CLI scaffolds the base app, copies the bundle into the project root, generates `SERVICE_SPEC.md` and `AGENTS.md`, and applies supported bundle features (`vscode`, `devops`, etc.). Only bundles with `scaffold.stack = "ts"` are accepted by this CLI; use `uns-kit-py` for Python bundles.
-
-## Commands
-
-### `uns-kit create <name>`
-Scaffold a new project from the default TypeScript template.
-
-### `uns-kit create --bundle <path> [--dest <dir>] [--allow-existing]`
-Scaffold from a `service.bundle.json` descriptor.
-
-### `uns-kit configure [dir] [features...]`
-Apply one or more feature templates to an existing project in one go.
-
-```bash
-uns-kit configure                        # prompts for features
-uns-kit configure --all                  # apply all available features
-uns-kit configure ./my-app api cron      # add API and cron scaffolding
-uns-kit configure ./my-app --overwrite   # refresh existing files from latest templates
-```
-
-Available feature names: `devops`, `vscode`, `codegen`, `api`, `cron`, `python`, `uns-reference`.
-
-### `uns-kit configure-templates [dir] [templates...]`
-Copy any template directory by name.
-
-```bash
-uns-kit configure-templates --all
-uns-kit configure-templates uns-dictionary uns-measurements --overwrite
-```
-
-### `uns-kit configure-devops [dir]`
-Add Azure DevOps pull-request tooling. Requires a git repository.
-
-```bash
-uns-kit configure-devops
-pnpm install
-pnpm run pull-request
-```
-
-### `uns-kit configure-vscode [dir]`
-Copy `.vscode/launch.json` and a workspace file. Skips existing files unless `--overwrite` is passed.
-
-### `uns-kit configure-codegen [dir]`
-Scaffold GraphQL code generation (`codegen.ts`, placeholder types in `src/uns/`).
-
-```bash
-uns-kit configure-codegen
-pnpm install
-pnpm run generate-codegen   # regenerate strongly-typed GraphQL operations
-```
-
-### `uns-kit configure-api [dir]`
-Copy API example stubs (`src/examples/api-example.ts`) and add `@uns-kit/api`.
-
-```bash
-uns-kit configure-api
-pnpm install
-```
-
-The example shows both GET and POST endpoint registration with JWT auth, query params, request body schemas, and event handlers. Rename and adapt `api-example.ts` to `index.ts` as your starting point.
-
-### `uns-kit configure-cron [dir]`
-Copy cron example stubs and add `@uns-kit/cron`.
-
-```bash
-uns-kit configure-cron
-pnpm install
-```
-
-### `uns-kit configure-python [dir]`
-Copy Python gRPC gateway client scaffolding (no npm dependency required).
-
-```bash
-uns-kit configure-python
-```
-
-### `uns-kit configure-uns-reference [dir]`
-Copy UNS dictionary and measurements JSON files into the project and add the `sync-uns-schema` script to `package.json`.
-
-```bash
-uns-kit configure-uns-reference
-pnpm run sync-uns-schema   # pull latest schema from the controller
-```
-
-### `uns-kit upgrade [dir]`
-Remove obsolete scripts from `package.json` and migrate to current conventions.
-
-```bash
-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`) and ensures `sync-uns-schema` is present.
-
-### `uns-kit help`
-Display usage information.
-
-## Extend the config schema
-
-Edit `src/config/project.config.extension.ts` inside your project and run:
-
-```bash
-pnpm run generate-config-schema
-```
-
-This regenerates `config.schema.json` and `src/config/app-config.ts` so editors and runtime types stay in sync with your extensions.
-
-## Sync the UNS schema
-
-After scaffolding (or at any time) pull the latest UNS dictionary and measurements from the controller:
-
-```bash
-pnpm run sync-uns-schema
-```
-
-The controller URL is read from `config.json` (`uns.rest`) automatically. You will be prompted for the bearer token if `UNS_CONTROLLER_TOKEN` is not set.
-
-## License
-
-MIT © Aljoša Vister
+
+### Create from a service bundle
+
+```bash
+uns-kit create --bundle ./service.bundle.json
+uns-kit create --bundle ./service.bundle.json --dest ./my-dir
+uns-kit create --bundle ./service.bundle.json --dest . --allow-existing
+```
+
+Bundle-driven create uses `service.bundle.json` as the source of truth. The CLI scaffolds the base app, copies the bundle into the project root, generates `SERVICE_SPEC.md` and `AGENTS.md`, and applies supported bundle features (`vscode`, `devops`, etc.). Only bundles with `scaffold.stack = "ts"` are accepted by this CLI; use `uns-kit-py` for Python bundles.
+
+## Commands
+
+### `uns-kit create <name>`
+Scaffold a new project from the default TypeScript template.
+
+### `uns-kit create --bundle <path> [--dest <dir>] [--allow-existing]`
+Scaffold from a `service.bundle.json` descriptor.
+
+### `uns-kit configure [dir] [features...]`
+Apply one or more feature templates to an existing project in one go.
+
+```bash
+uns-kit configure                        # prompts for features
+uns-kit configure --all                  # apply all available features
+uns-kit configure ./my-app api cron      # add API and cron scaffolding
+uns-kit configure ./my-app --overwrite   # refresh existing files from latest templates
+```
+
+Available feature names: `devops`, `vscode`, `codegen`, `api`, `cron`, `python`, `uns-reference`.
+
+### `uns-kit configure-templates [dir] [templates...]`
+Copy any template directory by name.
+
+```bash
+uns-kit configure-templates --all
+uns-kit configure-templates uns-dictionary uns-measurements --overwrite
+```
+
+### `uns-kit configure-devops [dir]`
+Add Azure DevOps pull-request tooling. Requires a git repository.
+
+```bash
+uns-kit configure-devops
+pnpm install
+pnpm run pull-request
+```
+
+### `uns-kit configure-vscode [dir]`
+Copy `.vscode/launch.json` and a workspace file. Skips existing files unless `--overwrite` is passed.
+
+### `uns-kit configure-codegen [dir]`
+Scaffold GraphQL code generation (`codegen.ts`, placeholder types in `src/uns/`).
+
+```bash
+uns-kit configure-codegen
+pnpm install
+pnpm run generate-codegen   # regenerate strongly-typed GraphQL operations
+```
+
+### `uns-kit configure-api [dir]`
+Copy API example stubs (`src/examples/api-example.ts`) and add `@uns-kit/api`.
+
+```bash
+uns-kit configure-api
+pnpm install
+```
+
+The example shows both GET and POST endpoint registration with JWT auth, query params, request body schemas, and event handlers. Rename and adapt `api-example.ts` to `index.ts` as your starting point.
+
+### `uns-kit configure-cron [dir]`
+Copy cron example stubs and add `@uns-kit/cron`.
+
+```bash
+uns-kit configure-cron
+pnpm install
+```
+
+### `uns-kit configure-python [dir]`
+Copy Python gRPC gateway client scaffolding (no npm dependency required).
+
+```bash
+uns-kit configure-python
+```
+
+### `uns-kit configure-uns-reference [dir]`
+Copy UNS dictionary and measurements JSON files into the project and add the `sync-uns-schema` script to `package.json`.
+
+```bash
+uns-kit configure-uns-reference
+pnpm run sync-uns-schema   # pull latest schema from the controller
+```
+
+### `uns-kit upgrade [dir]`
+Remove obsolete scripts from `package.json` and migrate to current conventions.
+
+```bash
+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`) and ensures `sync-uns-schema` is present.
+
+### `uns-kit help`
+Display usage information.
+
+## Extend the config schema
+
+Edit `src/config/project.config.extension.ts` inside your project and run:
+
+```bash
+pnpm run generate-config-schema
+```
+
+This regenerates `config.schema.json` and `src/config/app-config.ts` so editors and runtime types stay in sync with your extensions.
+
+## Sync the UNS schema
+
+After scaffolding (or at any time) pull the latest UNS dictionary and measurements from the controller:
+
+```bash
+pnpm run sync-uns-schema
+```
+
+The controller URL is read from `config.json` (`uns.rest`) automatically. You will be prompted for the bearer token if `UNS_CONTROLLER_TOKEN` is not set.
+
+## License
+
+MIT © Aljoša Vister

package/dist/index.js

@@ -334,65 +334,65 @@ function renderBundlePublisherExample(bundle, contracts) {
         .map((line) => `  ${line}`)
         .join("\n")
         .trimStart();
-    return `import { ConfigFile, UnsProxyProcess } from "@uns-kit/core";
-import type { ISO8601 } from "@uns-kit/core/uns/uns-interfaces.js";
-
-type OutputContract = {
-  fullPath: string;
-  topicPrefix: string;
-  asset: string;
-  objectType: string;
-  objectId: string;
-  attribute: string;
-  expectedIntervalMs: number;
-};
-
-const outputContracts = ${contractJson} satisfies readonly OutputContract[];
-
-function topicPrefixForPublish(topicPrefix: string): string {
-  return topicPrefix.endsWith("/") ? topicPrefix : \`\${topicPrefix}/\`;
-}
-
-async function main(): Promise<void> {
-  const config = await ConfigFile.loadConfig();
-  const processName = config.uns.processName ?? ${processName};
-  const unsProcess = new UnsProxyProcess(config.infra.host ?? "localhost", {
-    processName,
-  });
-
-  const mqttOutput = await unsProcess.createUnsMqttProxy(
-    config.output?.host ?? "localhost",
-    "defaultOutput",
-    config.uns.instanceMode ?? "wait",
-    config.uns.handover ?? true,
-  );
-
-  const time = new Date().toISOString() as ISO8601;
-
-  for (const output of outputContracts) {
-    await mqttOutput.publishMqttMessage({
-      topic: topicPrefixForPublish(output.topicPrefix),
-      asset: output.asset,
-      objectType: output.objectType,
-      objectId: output.objectId,
-      attributes: {
-        attribute: output.attribute,
-        description: \`Generated example publisher for \${output.fullPath}\`,
-        data: {
-          time,
-          value: 0,
-          dataGroup: "service-bundle-output",
-        },
-        validityMode: "interval",
-        expectedIntervalMs: output.expectedIntervalMs,
-      },
-    });
-  }
-
-  console.log(\`UNS process '\${processName}' published \${outputContracts.length} interval example output(s).\`);
-}
-
-void main();
+    return `import { ConfigFile, UnsProxyProcess } from "@uns-kit/core";
+import type { ISO8601 } from "@uns-kit/core/uns/uns-interfaces.js";
+
+type OutputContract = {
+  fullPath: string;
+  topicPrefix: string;
+  asset: string;
+  objectType: string;
+  objectId: string;
+  attribute: string;
+  expectedIntervalMs: number;
+};
+
+const outputContracts = ${contractJson} satisfies readonly OutputContract[];
+
+function topicPrefixForPublish(topicPrefix: string): string {
+  return topicPrefix.endsWith("/") ? topicPrefix : \`\${topicPrefix}/\`;
+}
+
+async function main(): Promise<void> {
+  const config = await ConfigFile.loadConfig();
+  const processName = config.uns.processName ?? ${processName};
+  const unsProcess = new UnsProxyProcess(config.infra.host ?? "localhost", {
+    processName,
+  });
+
+  const mqttOutput = await unsProcess.createUnsMqttProxy(
+    config.output?.host ?? "localhost",
+    "defaultOutput",
+    config.uns.instanceMode ?? "wait",
+    config.uns.handover ?? true,
+  );
+
+  const time = new Date().toISOString() as ISO8601;
+
+  for (const output of outputContracts) {
+    await mqttOutput.publishMqttMessage({
+      topic: topicPrefixForPublish(output.topicPrefix),
+      asset: output.asset,
+      objectType: output.objectType,
+      objectId: output.objectId,
+      attributes: {
+        attribute: output.attribute,
+        description: \`Generated example publisher for \${output.fullPath}\`,
+        data: {
+          time,
+          value: 0,
+          dataGroup: "service-bundle-output",
+        },
+        validityMode: "interval",
+        expectedIntervalMs: output.expectedIntervalMs,
+      },
+    });
+  }
+
+  console.log(\`UNS process '\${processName}' published \${outputContracts.length} interval example output(s).\`);
+}
+
+void main();
 `;
 }
 async function writeServiceBundleArtifacts(targetDir, bundle, rawBundle) {

package/package.json

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