@uns-kit/cli 2.0.27 → 2.0.28

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

@@ -1,91 +1,91 @@
-/**
- * Change this file according to your specifications and rename it to index.ts
- */
-import { UnsProxyProcess, ConfigFile } from "@uns-kit/core";
-import { IApiProxyOptions } from "@uns-kit/core";
-import type { UnsEvents } from "@uns-kit/core";
-import "@uns-kit/api";
-import { type UnsProxyProcessWithApi } from "@uns-kit/api";
-
-/**
- * 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();
-
-/**
- * Connect to the API proxy process
- */
-const unsProxyProcess = new UnsProxyProcess(config.infra.host!, {processName: config.uns.processName}) as UnsProxyProcessWithApi;
-const apiOptions: IApiProxyOptions = config.uns?.jwksWellKnownUrl
-  ? {
-      jwks: {
-        wellKnownJwksUrl: config.uns.jwksWellKnownUrl,
-        ...(config.uns.kidWellKnownUrl !== undefined
-          ? { activeKidUrl: config.uns.kidWellKnownUrl }
-          : {}),
-      },
-    }
-  : {
-      jwtSecret: "CHANGEME",
-    };
-const apiInput = await unsProxyProcess.createApiProxy("templateUnsApiInput", apiOptions);
-
-/**
- * Register an API endpoint and event handler
- */
-apiInput.get(
-  "enterprise/site/area/line/",
-  "line-3-furnace",
-  "energy-resource",
-  "main-bus",
-  "summary-1",
-  {
-    tags: ["Tag1"],
-    apiDescription: "Test API endpoint 1",
-    queryParams: [
-      { name: "filter", type: "string", required: true, description: "Filter za podatke" },
-      { name: "limit", type: "number", required: false, description: "Koliko podatkov želiš" },
-    ],
-  }
-);
-
-apiInput.get(
-  "enterprise/site/area/line/",
-  "line-3-compressor",
-  "utility-resource",
-  "air-loop-1",
-  "summary-2",
-  {
-    tags: ["Tag2"],
-    apiDescription: "Test API endpoint 2",
-    queryParams: [
-      { name: "filter", type: "string", required: true, description: "Filter za podatke" },
-      { name: "limit", type: "number", required: false, description: "Koliko podatkov želiš" },
-    ],
-  }
-);
-
-/**
- * Optional: register a catch-all API mapping for a topic prefix.
- * This does not create per-attribute API nodes; the controller treats it as a fallback handler.
- * You can provide a separate Swagger doc for catch-all so it stays distinct from normal APIs (optional).
- */
-await apiInput.registerCatchAll("sij/acroni/#", {
-  apiDescription: "Catch-all handler for sij/acroni/*",
-  tags: ["CatchAll"],
-  queryParams: [
-    { name: "filter", type: "string", required: false, description: "Filter parameter" },
-  ]
-});
-
-apiInput.event.on("apiGetEvent", (event: UnsEvents["apiGetEvent"]) => {
-  try {
-    const appContext = event.req.appContext;
-    // Add SQL query or any other code here
-    event.res.send("OK");
-  } catch (error) {
-    event.res.status(400).send("Error");
-  }    
-});
+/**
+ * Change this file according to your specifications and rename it to index.ts
+ */
+import { UnsProxyProcess, ConfigFile } from "@uns-kit/core";
+import { IApiProxyOptions } from "@uns-kit/core";
+import type { UnsEvents } from "@uns-kit/core";
+import "@uns-kit/api";
+import { type UnsProxyProcessWithApi } from "@uns-kit/api";
+
+/**
+ * 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();
+
+/**
+ * Connect to the API proxy process
+ */
+const unsProxyProcess = new UnsProxyProcess(config.infra.host!, {processName: config.uns.processName}) as UnsProxyProcessWithApi;
+const apiOptions: IApiProxyOptions = config.uns?.jwksWellKnownUrl
+  ? {
+      jwks: {
+        wellKnownJwksUrl: config.uns.jwksWellKnownUrl,
+        ...(config.uns.kidWellKnownUrl !== undefined
+          ? { activeKidUrl: config.uns.kidWellKnownUrl }
+          : {}),
+      },
+    }
+  : {
+      jwtSecret: "CHANGEME",
+    };
+const apiInput = await unsProxyProcess.createApiProxy("templateUnsApiInput", apiOptions);
+
+/**
+ * Register an API endpoint and event handler
+ */
+apiInput.get(
+  "enterprise/site/area/line/",
+  "line-3-furnace",
+  "energy-resource",
+  "main-bus",
+  "summary-1",
+  {
+    tags: ["Tag1"],
+    apiDescription: "Test API endpoint 1",
+    queryParams: [
+      { name: "filter", type: "string", required: true, description: "Filter za podatke" },
+      { name: "limit", type: "number", required: false, description: "Koliko podatkov želiš" },
+    ],
+  }
+);
+
+apiInput.get(
+  "enterprise/site/area/line/",
+  "line-3-compressor",
+  "utility-resource",
+  "air-loop-1",
+  "summary-2",
+  {
+    tags: ["Tag2"],
+    apiDescription: "Test API endpoint 2",
+    queryParams: [
+      { name: "filter", type: "string", required: true, description: "Filter za podatke" },
+      { name: "limit", type: "number", required: false, description: "Koliko podatkov želiš" },
+    ],
+  }
+);
+
+/**
+ * Optional: register a catch-all API mapping for a topic prefix.
+ * This does not create per-attribute API nodes; the controller treats it as a fallback handler.
+ * You can provide a separate Swagger doc for catch-all so it stays distinct from normal APIs (optional).
+ */
+await apiInput.registerCatchAll("sij/acroni/#", {
+  apiDescription: "Catch-all handler for sij/acroni/*",
+  tags: ["CatchAll"],
+  queryParams: [
+    { name: "filter", type: "string", required: false, description: "Filter parameter" },
+  ]
+});
+
+apiInput.event.on("apiGetEvent", (event: UnsEvents["apiGetEvent"]) => {
+  try {
+    const appContext = event.req.appContext;
+    // Add SQL query or any other code here
+    event.res.send("OK");
+  } catch (error) {
+    event.res.status(400).send("Error");
+  }    
+});

package/templates/azure-pipelines.yml

@@ -1,21 +1,21 @@
-variables:
-  privatePool: 'Azure private pool'
-
-trigger:
-- master
-
-stages:
-- stage: version_tag
-  displayName: Add Version Tag
-  pool: $(privatePool)
-  jobs:
-  - job: add_tags
-    steps:
-    - checkout: self
-      persistCredentials: true
-      clean: true
-    - script: |
-        tag=$(node -pe "require('./package.json').version")
-        git tag $tag
-        git push origin $tag
-      displayName: "Add version tag from package.json"
+variables:
+  privatePool: 'Azure private pool'
+
+trigger:
+- master
+
+stages:
+- stage: version_tag
+  displayName: Add Version Tag
+  pool: $(privatePool)
+  jobs:
+  - job: add_tags
+    steps:
+    - checkout: self
+      persistCredentials: true
+      clean: true
+    - script: |
+        tag=$(node -pe "require('./package.json').version")
+        git tag $tag
+        git push origin $tag
+      displayName: "Add version tag from package.json"

package/templates/codegen/codegen.ts

@@ -1,15 +1,15 @@
-import type { CodegenConfig } from '@graphql-codegen/cli';
-import { ConfigFile } from '@uns-kit/core';
-
-const appConfig = await ConfigFile.loadConfig();
-
-const config: CodegenConfig = {
-  schema: appConfig.uns.graphql,
-  generates: {
-    'src/graphql/schema.ts': {
-      plugins: ['typescript', 'typescript-operations', 'typescript-resolvers'],
-    },
-  },
-};
-
-export default config;
+import type { CodegenConfig } from '@graphql-codegen/cli';
+import { ConfigFile } from '@uns-kit/core';
+
+const appConfig = await ConfigFile.loadConfig();
+
+const config: CodegenConfig = {
+  schema: appConfig.uns.graphql,
+  generates: {
+    'src/graphql/schema.ts': {
+      plugins: ['typescript', 'typescript-operations', 'typescript-resolvers'],
+    },
+  },
+};
+
+export default config;

package/templates/codegen/src/uns/uns-tags.ts

@@ -1 +1 @@
-export type UnsTags = string & {};
+export type UnsTags = string & {};

package/templates/codegen/src/uns/uns-topics.ts

@@ -1 +1 @@
-export type UnsTopics = string & {};
+export type UnsTopics = string & {};

package/templates/config-files/config-docker.json

@@ -1,27 +1,27 @@
-{
-  "uns": {
-    "graphql": "http://uns-datahub-controller:3200/graphql",
-    "rest": "http://uns-datahub-controller:3200/api",
-    "processName": "__APP_NAME__",
-    "instanceMode": "wait",
-    "handover": true,
-    "jwksWellKnownUrl": "http://uns-datahub-controller:3200/api/.well-known/jwks.json",
-    "kidWellKnownUrl": "http://uns-datahub-controller:3200/api/.well-known/kid",
-    "email": "user@example-org.com",
-    "password": "secret"
-  },
-  "infra": {
-    "host": "mosquitto:1883"
-  },
-  "output": {
-    "host": "mosquitto:1883"
-  },
-  "input": {
-    "host": "mosquitto:1883"
-  },
-  "devops": {
-    "provider": "azure-devops",
-    "organization": "example-org",
-    "project": "example-project"
-  }
+{
+  "uns": {
+    "graphql": "http://uns-datahub-controller:3200/graphql",
+    "rest": "http://uns-datahub-controller:3200/api",
+    "processName": "__APP_NAME__",
+    "instanceMode": "wait",
+    "handover": true,
+    "jwksWellKnownUrl": "http://uns-datahub-controller:3200/api/.well-known/jwks.json",
+    "kidWellKnownUrl": "http://uns-datahub-controller:3200/api/.well-known/kid",
+    "email": "user@example-org.com",
+    "password": "secret"
+  },
+  "infra": {
+    "host": "mosquitto:1883"
+  },
+  "output": {
+    "host": "mosquitto:1883"
+  },
+  "input": {
+    "host": "mosquitto:1883"
+  },
+  "devops": {
+    "provider": "azure-devops",
+    "organization": "example-org",
+    "project": "example-project"
+  }
 }

package/templates/config-files/config-localhost.json

@@ -1,27 +1,27 @@
-{
-  "uns": {
-    "graphql": "http://localhost:3200/graphql",
-    "rest": "http://localhost:3200/api",
-    "processName": "__APP_NAME__",
-    "instanceMode": "wait",
-    "handover": true,
-    "jwksWellKnownUrl": "http://localhost:3200/api/.well-known/jwks.json",
-    "kidWellKnownUrl": "http://localhost:3200/api/.well-known/kid",
-    "email": "user@example-org.com",
-    "password": "secret"
-  },
-  "infra": {
-    "host": "localhost:1883"
-  },
-  "output": {
-    "host": "localhost:1883"
-  },
-  "input": {
-    "host": "localhost:1883"
-  },
-  "devops": {
-    "provider": "azure-devops",
-    "organization": "example-org",
-    "project": "example-project"
-  }
+{
+  "uns": {
+    "graphql": "http://localhost:3200/graphql",
+    "rest": "http://localhost:3200/api",
+    "processName": "__APP_NAME__",
+    "instanceMode": "wait",
+    "handover": true,
+    "jwksWellKnownUrl": "http://localhost:3200/api/.well-known/jwks.json",
+    "kidWellKnownUrl": "http://localhost:3200/api/.well-known/kid",
+    "email": "user@example-org.com",
+    "password": "secret"
+  },
+  "infra": {
+    "host": "localhost:1883"
+  },
+  "output": {
+    "host": "localhost:1883"
+  },
+  "input": {
+    "host": "localhost:1883"
+  },
+  "devops": {
+    "provider": "azure-devops",
+    "organization": "example-org",
+    "project": "example-project"
+  }
 }

package/templates/cron/AGENTS.md

@@ -1,24 +1,24 @@
-# Agent Onboarding (template)
-
-Pointers for AI/code-assist tools when working in this generated project.
-
-## What to read locally
-
-- `package.json` for scripts (`generate-uns-*`, `generate-codegen`, etc.).
-- `config.schema.json` for the app config shape; `processName` is required.
-- `src/examples/*.ts` for cron-driven publish patterns 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/temporal/README.md` (if installed)
-  - `@uns-kit/cli/README.md` (if installed)
-
-## Generators in this 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-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
+# Agent Onboarding (template)
+
+Pointers for AI/code-assist tools when working in this generated project.
+
+## What to read locally
+
+- `package.json` for scripts (`generate-uns-*`, `generate-codegen`, etc.).
+- `config.schema.json` for the app config shape; `processName` is required.
+- `src/examples/*.ts` for cron-driven publish patterns 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/temporal/README.md` (if installed)
+  - `@uns-kit/cli/README.md` (if installed)
+
+## Generators in this 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-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/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,24 +1,24 @@
-# Agent Onboarding (template)
-
-Pointers for AI/code-assist tools when working in this generated project.
-
-## What to read locally
-
-- `package.json` for scripts (`generate-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/temporal/README.md` (if installed)
-  - `@uns-kit/cli/README.md` (if installed)
-
-## Generators in this 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-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
+# Agent Onboarding (template)
+
+Pointers for AI/code-assist tools when working in this generated project.
+
+## What to read locally
+
+- `package.json` for scripts (`generate-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/temporal/README.md` (if installed)
+  - `@uns-kit/cli/README.md` (if installed)
+
+## Generators in this 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-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