@uns-kit/cli 2.0.55 → 2.0.57

package/templates/cron/src/examples/cron-example.ts

@@ -1,71 +1,71 @@
-/**
- * Change this file according to your specifications and rename it to index.ts
- */
-import { UnsProxyProcess, ConfigFile, UnsEvents, getLogger } from "@uns-kit/core";
-import { registerAttributeDescriptions, registerObjectTypeDescriptions } from "@uns-kit/core/uns/uns-dictionary-registry.js";
-import "@uns-kit/cron";
-import { type UnsProxyProcessWithCron } from "@uns-kit/cron";
-import { UnsTopics } from "@uns-kit/core/uns/uns-topics.js";
-import { UnsPacket } from "@uns-kit/core/uns/uns-packet.js";
-import {
-  GeneratedObjectTypes,
-  GeneratedAttributes,
-  GeneratedAttributesByType,
-  GeneratedAttributeDescriptions,
-  GeneratedObjectTypeDescriptions,
-} from "../uns/uns-dictionary.generated.js";
-import { GeneratedPhysicalMeasurements } from "../uns/uns-measurements.generated.js";
-import { GeneratedAssets, resolveGeneratedAsset } from "../uns/uns-assets.js";
-
-const logger = getLogger(import.meta.url);
-
-
-/**
- * Load the configuration from a file.
- * On the server, this file is provided by the `uns-datahub-controller`.
- * In the development environment, you are responsible for creating and maintaining this file and its contents.
- */
-const config = await ConfigFile.loadConfig();
-registerObjectTypeDescriptions(GeneratedObjectTypeDescriptions);
-registerAttributeDescriptions(GeneratedAttributeDescriptions);
-
-/**
- * Connect to the output broker and create a crontab proxy
- */
-const unsProxyProcess = new UnsProxyProcess(config.infra.host!, {processName:config.uns.processName}) as UnsProxyProcessWithCron;;
-const mqttOutput = await unsProxyProcess.createUnsMqttProxy((config.output?.host)!, "templateUnsRttOutput", config.uns.instanceMode!, config.uns.handover!, { publishThrottlingDelay: 1000});
-const cronInput = await unsProxyProcess.createCrontabProxy("* * * * * *");
-
-/**
- * Event listener for cron events.
- * On each cron event, publish a message to the MQTT output broker.
- */
-cronInput.event.on("cronEvent", async (event: UnsEvents["cronEvent"]) => {
-  try {
-    const time = UnsPacket.formatToISO8601(new Date());
-    const numberValue: number = 42;
-    const topic: UnsTopics = "example/";
-    const asset = resolveGeneratedAsset("asset");
-    const assetDescription = "Sample asset";
-
-    const dataGroup = "sensor";
-
-    mqttOutput.publishMqttMessage({
-      topic,
-      asset,
-      assetDescription,
-      objectType: GeneratedObjectTypes.equipment,
-      objectId: "main",
-      attributes: [
-        {
-          attribute: GeneratedAttributesByType["energy-resource"]["current"],
-          data: { dataGroup, time, value: numberValue, uom: GeneratedPhysicalMeasurements.Ampere }
-        }
-      ],
-    });
-  } catch (error) {
-    const reason = error instanceof Error ? error : new Error(String(error));
-    logger.error(`Error publishing message to MQTT: ${reason.message}`);
-    throw error;
-  }
-});
+/**
+ * Change this file according to your specifications and rename it to index.ts
+ */
+import { UnsProxyProcess, ConfigFile, UnsEvents, getLogger } from "@uns-kit/core";
+import { registerAttributeDescriptions, registerObjectTypeDescriptions } from "@uns-kit/core/uns/uns-dictionary-registry.js";
+import "@uns-kit/cron";
+import { type UnsProxyProcessWithCron } from "@uns-kit/cron";
+import { UnsTopics } from "@uns-kit/core/uns/uns-topics.js";
+import { UnsPacket } from "@uns-kit/core/uns/uns-packet.js";
+import {
+  GeneratedObjectTypes,
+  GeneratedAttributes,
+  GeneratedAttributesByType,
+  GeneratedAttributeDescriptions,
+  GeneratedObjectTypeDescriptions,
+} from "../uns/uns-dictionary.generated.js";
+import { GeneratedPhysicalMeasurements } from "../uns/uns-measurements.generated.js";
+import { GeneratedAssets, resolveGeneratedAsset } from "../uns/uns-assets.js";
+
+const logger = getLogger(import.meta.url);
+
+
+/**
+ * Load the configuration from a file.
+ * On the server, this file is provided by the `uns-datahub-controller`.
+ * In the development environment, you are responsible for creating and maintaining this file and its contents.
+ */
+const config = await ConfigFile.loadConfig();
+registerObjectTypeDescriptions(GeneratedObjectTypeDescriptions);
+registerAttributeDescriptions(GeneratedAttributeDescriptions);
+
+/**
+ * Connect to the output broker and create a crontab proxy
+ */
+const unsProxyProcess = new UnsProxyProcess(config.infra.host!, {processName:config.uns.processName}) as UnsProxyProcessWithCron;;
+const mqttOutput = await unsProxyProcess.createUnsMqttProxy((config.output?.host)!, "templateUnsRttOutput", config.uns.instanceMode!, config.uns.handover!, { publishThrottlingDelay: 1000});
+const cronInput = await unsProxyProcess.createCrontabProxy("* * * * * *");
+
+/**
+ * Event listener for cron events.
+ * On each cron event, publish a message to the MQTT output broker.
+ */
+cronInput.event.on("cronEvent", async (event: UnsEvents["cronEvent"]) => {
+  try {
+    const time = UnsPacket.formatToISO8601(new Date());
+    const numberValue: number = 42;
+    const topic: UnsTopics = "example/";
+    const asset = resolveGeneratedAsset("asset");
+    const assetDescription = "Sample asset";
+
+    const dataGroup = "sensor";
+
+    mqttOutput.publishMqttMessage({
+      topic,
+      asset,
+      assetDescription,
+      objectType: GeneratedObjectTypes.equipment,
+      objectId: "main",
+      attributes: [
+        {
+          attribute: GeneratedAttributesByType["energy-resource"]["current"],
+          data: { dataGroup, time, value: numberValue, uom: GeneratedPhysicalMeasurements.Ampere }
+        }
+      ],
+    });
+  } catch (error) {
+    const reason = error instanceof Error ? error : new Error(String(error));
+    logger.error(`Error publishing message to MQTT: ${reason.message}`);
+    throw error;
+  }
+});

package/templates/default/.prettierignore

@@ -1,2 +1,2 @@
-dist
+dist
 node_modules

package/templates/default/.prettierrc

@@ -1,7 +1,7 @@
-{
-  "semi": true,
-  "singleQuote": true,
-  "tabWidth": 2,
-  "trailingComma": "all",
-  "printWidth": 140
-}
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "printWidth": 140
+}

package/templates/default/AGENTS.md

@@ -1,20 +1,20 @@
-# Agent Onboarding (template)
-
-Pointers for AI/code-assist tools when working in this generated project.
-
-## What to read locally
-
-- `package.json` for scripts (`sync-uns-*`, `generate-codegen`, etc.).
-- `config.schema.json` for the app config shape; `processName` is required.
-- `src/examples/*.ts` for idiomatic publishing (multi-attribute) and description registration.
-- Installed docs (under `node_modules`):
-  - `@uns-kit/core/README.md`
-  - `@uns-kit/api/README.md` (if installed)
-  - `@uns-kit/cron/README.md` (if installed)
-  - `@uns-kit/cli/README.md` (if installed)
-
-## Generators in this project
-
-- `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
-- `pnpm run sync-uns-metadata -- --controller-url ... --token ...` -> pulls topics/tags/assets from the controller and regenerates local TS helpers
+# Agent Onboarding (template)
+
+Pointers for AI/code-assist tools when working in this generated project.
+
+## What to read locally
+
+- `package.json` for scripts (`sync-uns-*`, `generate-codegen`, etc.).
+- `config.schema.json` for the app config shape; `processName` is required.
+- `src/examples/*.ts` for idiomatic publishing (multi-attribute) and description registration.
+- Installed docs (under `node_modules`):
+  - `@uns-kit/core/README.md`
+  - `@uns-kit/api/README.md` (if installed)
+  - `@uns-kit/cron/README.md` (if installed)
+  - `@uns-kit/cli/README.md` (if installed)
+
+## Generators in this project
+
+- `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
+- `pnpm run sync-uns-metadata -- --controller-url ... --token ...` -> pulls topics/tags/assets from the controller and regenerates local TS helpers

package/templates/default/README.md

@@ -1,81 +1,83 @@
-# __APP_NAME__
-
-Generated with `@uns-kit/cli`.
-
-Requires Node.js 22+ and pnpm (see `packageManager` in package.json).
-
-## Scripts
-
-```bash
-pnpm run dev    # start the local development loop
-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 sync-uns-schema -- --controller-url http://localhost:3200 --token <admin-bearer-token>  # pull dictionary + measurements from the controller
-pnpm run sync-uns-metadata -- --controller-url http://localhost:3200 --token <metadata-export-token>  # refresh topics/tags/assets for IntelliSense
-```
-
-## Configuration
-
-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; in most apps this is primarily used to drive UI liveliness/activity indicators. In app-level modeling we use two modes only:
-
-- `interval`: continuously refreshed values (stale after ~2× `expectedIntervalMs`)
-- `lifecycle`: event-driven activity that stays active until a defined end value (`lifecycleEndValue`)
-
-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.
-- Create MQTT proxies inside `src/index.ts`.
-- Extend `src/config/project.config.extension.ts` with project-specific sections and run `pnpm run generate-config-schema` (reload your editor's TS server afterward if completions lag).
-- 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.
-- 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.
-- Run `pnpm run sync-uns-metadata -- --controller-url ... --token ...` to regenerate topic, tag, and asset IntelliSense from the controller metadata export. The token must be admin or include `export:uns-reference`.
-- Run `uns-kit configure-api` / `configure-cron` 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).
-- Commit your new project and start building!
-
-## Agent Onboarding (for AI/code-assist tools)
-
-For agent guidance, see the local [`AGENTS.md`](./AGENTS.md).
+# __APP_NAME__
+
+Generated with `@uns-kit/cli`.
+
+Requires Node.js 22+ and pnpm (see `packageManager` in package.json).
+
+## Scripts
+
+```bash
+pnpm run dev    # start the local development loop
+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 sync-uns-schema -- --controller-url http://localhost:3200 --token <admin-bearer-token>  # pull dictionary + measurements from the controller
+pnpm run sync-uns-metadata -- --controller-url http://localhost:3200 --token <metadata-export-token>  # refresh topics/tags/assets for IntelliSense
+```
+
+## Configuration
+
+Update `config.json` with your broker, UNS URLs, and credentials. The generated file contains sensible defaults for local development. If you use a service token, add `uns.token` and pass it to `UnsClient`.
+
+## Validity / Liveliness
+
+UNS attributes can declare how the controller decides whether they are live or stale; in most apps this is primarily used to drive UI liveliness/activity indicators. In app-level modeling we use two modes only:
+
+- `interval`: continuously refreshed values (stale after ~2× `expectedIntervalMs`)
+- `lifecycle`: event-driven activity that stays active until a defined end value (`lifecycleEndValue`)
+
+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 { ConfigFile, UnsClient } from "@uns-kit/core";
+
+const config = await ConfigFile.loadConfig();
+
+const client = new UnsClient("https://datahub.example.com", {
+  token: process.env.UNS_SERVICE_TOKEN ?? config.uns.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.
+- Create MQTT proxies inside `src/index.ts`.
+- Extend `src/config/project.config.extension.ts` with project-specific sections and run `pnpm run generate-config-schema` (reload your editor's TS server afterward if completions lag).
+- 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.
+- 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.
+- Run `pnpm run sync-uns-metadata -- --controller-url ... --token ...` to regenerate topic, tag, and asset IntelliSense from the controller metadata export. The token must be admin or include `export:uns-reference`.
+- Run `uns-kit configure-api` / `configure-cron` 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).
+- Commit your new project and start building!
+
+## Agent Onboarding (for AI/code-assist tools)
+
+For agent guidance, see the local [`AGENTS.md`](./AGENTS.md).

package/templates/default/config.json

@@ -1,35 +1,35 @@
-{
-  "uns": {
-    "graphql": "http://localhost:3200/graphql",
-    "rest": "http://localhost:3200/api",
-    "processName": "__APP_NAME__",
-    "supervisor": {
-      "enabled": false,
-      "restartOnExit": false,
-      "maxMemoryMb": 512,
-      "restartOnUnhealthy": false,
-      "unhealthyAfterMs": 60000,
-      "restartCooldownMs": 300000
-    },
-    "instanceMode": "wait",
-    "handover": true,
-    "jwksWellKnownUrl": "http://localhost:3200/api/.well-known/jwks.json",
-    "kidWellKnownUrl": "http://localhost:3200/api/.well-known/kid",
-    "email": "user@example.com",
-    "password": "123"
-  },
-  "infra": {
-    "host": "localhost"
-  },
-  "output": {
-    "host": "localhost"
-  },
-  "input": {
-    "host": "localhost"
-  },
-  "devops": {
-    "provider": "azure-devops",
-    "organization": "example-org",
-    "project": "example-project"
-  }
-}
+{
+  "uns": {
+    "graphql": "http://localhost:3200/graphql",
+    "rest": "http://localhost:3200/api",
+    "processName": "__APP_NAME__",
+    "supervisor": {
+      "enabled": false,
+      "restartOnExit": false,
+      "maxMemoryMb": 512,
+      "restartOnUnhealthy": false,
+      "unhealthyAfterMs": 60000,
+      "restartCooldownMs": 300000
+    },
+    "instanceMode": "wait",
+    "handover": true,
+    "jwksWellKnownUrl": "http://localhost:3200/api/.well-known/jwks.json",
+    "kidWellKnownUrl": "http://localhost:3200/api/.well-known/kid",
+    "email": "user@example.com",
+    "password": "123"
+  },
+  "infra": {
+    "host": "localhost"
+  },
+  "output": {
+    "host": "localhost"
+  },
+  "input": {
+    "host": "localhost"
+  },
+  "devops": {
+    "provider": "azure-devops",
+    "organization": "example-org",
+    "project": "example-project"
+  }
+}

package/templates/default/eslint.config.js

@@ -1,30 +1,30 @@
-// eslint.config.js
-
-import { defineConfig } from 'eslint/config';
-
-export default defineConfig([
-  // Apply to all source and test files
-  {
-    files: ['src/**/*', 'test/**/*'],
-    ignores: ['dist/', 'node_modules/'], // Folders to ignore
-    languageOptions: {
-      parserOptions: {
-        ecmaVersion: 'latest', // Use latest ECMAScript version
-        sourceType: 'module', // Enable ES modules
-      },
-    },
-    rules: {
-      semi: ['warn', 'always'],
-    },
-  },
-
-  // Override specifically for test files
-  {
-    files: ['test/**/*'],
-    rules: {
-      'no-console': 'off',
-    },
-  },
-
-  // Additional configurations can go here
-]);
+// eslint.config.js
+
+import { defineConfig } from 'eslint/config';
+
+export default defineConfig([
+  // Apply to all source and test files
+  {
+    files: ['src/**/*', 'test/**/*'],
+    ignores: ['dist/', 'node_modules/'], // Folders to ignore
+    languageOptions: {
+      parserOptions: {
+        ecmaVersion: 'latest', // Use latest ECMAScript version
+        sourceType: 'module', // Enable ES modules
+      },
+    },
+    rules: {
+      semi: ['warn', 'always'],
+    },
+  },
+
+  // Override specifically for test files
+  {
+    files: ['test/**/*'],
+    rules: {
+      'no-console': 'off',
+    },
+  },
+
+  // Additional configurations can go here
+]);

package/templates/default/gitignore

@@ -1,51 +1,51 @@
-# Dependencies
-node_modules/
-.pnpm-store/
-.pnpm/
-.pnp.cjs
-.pnp.loader.mjs
-
-# Build outputs
-build/
-dist/
-tmp/
-temp/
-*.tsbuildinfo
-
-# Logs & diagnostics
-logs/
-*.log
-npm-debug.log*
-yarn-debug.log*
-pnpm-debug.log*
-lerna-debug.log*
-
-# Test & coverage artifacts
-coverage/
-.nyc_output/
-.vitest/
-
-# Runtime queues & sandboxes
-publisherQueue/
-sandbox-*
-tmp-rtt
-.tmp-rtt
-
-# Environment & secrets
-.env
-.env.*
-!.env.example
-!.env.sample
-
-# UNS configuration overrides
-config*.json
-
-# Editor files & OS cruft
-.idea/
-.DS_Store
-Thumbs.db
-*.swp
-*.swo
-
-# Package managers
-package-lock.json
+# Dependencies
+node_modules/
+.pnpm-store/
+.pnpm/
+.pnp.cjs
+.pnp.loader.mjs
+
+# Build outputs
+build/
+dist/
+tmp/
+temp/
+*.tsbuildinfo
+
+# Logs & diagnostics
+logs/
+*.log
+npm-debug.log*
+yarn-debug.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+# Test & coverage artifacts
+coverage/
+.nyc_output/
+.vitest/
+
+# Runtime queues & sandboxes
+publisherQueue/
+sandbox-*
+tmp-rtt
+.tmp-rtt
+
+# Environment & secrets
+.env
+.env.*
+!.env.example
+!.env.sample
+
+# UNS configuration overrides
+config*.json
+
+# Editor files & OS cruft
+.idea/
+.DS_Store
+Thumbs.db
+*.swp
+*.swo
+
+# Package managers
+package-lock.json