@uns-kit/cli 0.0.34 → 0.0.36

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

@@ -1,61 +1,62 @@
-/**
- * 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 { 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,
-        activeKidUrl: config.uns.kidWellKnownUrl,
-      },
-    }
-  : {
-      jwtSecret: "CHANGEME",
-    };
-const apiInput = await unsProxyProcess.createApiProxy("templateUnsApiInput", apiOptions);
-
-/**
- * Register an API endpoint and event handler
- */
-apiInput.get("example/", "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("example/", "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š" },
-  ]
-});
-
-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.js";
+import { IApiProxyOptions } from "@uns-kit/core.js";
+import type { UnsEvents } from "@uns-kit/core.js";
+import "@uns-kit/api";
+import { type UnsProxyProcessWithApi } from "@uns-kit/api.js";
+
+/**
+ * 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,
+        activeKidUrl: config.uns.kidWellKnownUrl,
+      },
+    }
+  : {
+      jwtSecret: "CHANGEME",
+    };
+const apiInput = await unsProxyProcess.createApiProxy("templateUnsApiInput", apiOptions);
+
+/**
+ * Register an API endpoint and event handler
+ */
+apiInput.get("example/", "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("example/", "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š" },
+  ]
+});
+
+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.js';
+
+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

@@ -0,0 +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"
+  }
+}

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

@@ -0,0 +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"
+  }
+}

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

@@ -1,45 +1,46 @@
-/**
- * Change this file according to your specifications and rename it to index.ts
- */
-import { UnsProxyProcess, ConfigFile, logger } from "@uns-kit/core";
-import type { IUnsMessage, UnsEvents } from "@uns-kit/core";
-import { type UnsProxyProcessWithCron } from "@uns-kit/cron";
-import { UnsTags } from "../uns/uns-tags.js";
-import { UnsTopics } from "../uns/uns-topics.js";
-import { PhysicalMeasurements } from "@uns-kit/core/uns/uns-measurements.js";
-import { UnsPacket } from "@uns-kit/core/uns/uns-packet.js";
-
-
-/**
- * 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 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 message: IUnsMessage = { data: { time, value: numberValue, uom: PhysicalMeasurements.MiliVolt } };
-    const topic: UnsTopics = "example/";
-    const tags: UnsTags[] = [];
-    const packet = await UnsPacket.unsPacketFromUnsMessage(message);
-    mqttOutput.publishMqttMessage({ topic, attribute: "data-number", packet, description: "Number value", tags });
-  } 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, logger } from "@uns-kit/core.js";
+import type { IUnsMessage, UnsEvents } from "@uns-kit/core.js";
+import "@uns-kit/cron";
+import { type UnsProxyProcessWithCron } from "@uns-kit/cron.js";
+import { UnsTags } from "../uns/uns-tags.js";
+import { UnsTopics } from "../uns/uns-topics.js";
+import { PhysicalMeasurements } from "@uns-kit/core/uns/uns-measurements.js";
+import { UnsPacket } from "@uns-kit/core/uns/uns-packet.js";
+
+
+/**
+ * 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 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 message: IUnsMessage = { data: { time, value: numberValue, uom: PhysicalMeasurements.MiliVolt } };
+    const topic: UnsTopics = "example/";
+    const tags: UnsTags[] = [];
+    const packet = await UnsPacket.unsPacketFromUnsMessage(message);
+    mqttOutput.publishMqttMessage({ topic, attribute: "data-number", packet, description: "Number value", tags });
+  } 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/README.md

@@ -1,30 +1,30 @@
-# __APP_NAME__
-
-Generated with `@uns-kit/cli`.
-
-## 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 codegen            # regenerate typed GraphQL operations (after configure-codegen)
-pnpm run refresh-uns        # rebuild UNS topics/tags from the live schema
-```
-
-## Configuration
-
-Update `config.json` with your broker, UNS URLs, and credentials. The generated file contains sensible defaults for local development.
-
-## Next Steps
-
-- Install additional plugins: `pnpm add @uns-kit/api` etc.
-- Create MQTT proxies or Temporal workflows 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 `uns-kit configure-api` / `configure-cron` / `configure-temporal` to pull in example stubs and install the matching UNS plugins.
-- Run `uns-kit configure-python` to copy the Python gateway client template (examples, scripts, proto).
-- Commit your new project and start building!
+# __APP_NAME__
+
+Generated with `@uns-kit/cli`.
+
+## 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 codegen            # regenerate typed GraphQL operations (after configure-codegen)
+pnpm run refresh-uns        # rebuild UNS topics/tags from the live schema
+```
+
+## Configuration
+
+Update `config.json` with your broker, UNS URLs, and credentials. The generated file contains sensible defaults for local development.
+
+## Next Steps
+
+- Install additional plugins: `pnpm add @uns-kit/api` etc.
+- Create MQTT proxies or Temporal workflows 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 `uns-kit configure-api` / `configure-cron` / `configure-temporal` to pull in example stubs and install the matching UNS plugins.
+- Run `uns-kit configure-python` to copy the Python gateway client template (examples, scripts, proto).
+- Commit your new project and start building!

package/templates/default/config.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/default/gitignore

@@ -1,48 +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
-
-# 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

package/templates/default/package.json

@@ -1,19 +1,19 @@
-{
-  "name": "__APP_NAME__",
-  "version": "0.0.0",
-  "type": "module",
-  "scripts": {
-    "typecheck": "tsc --noEmit",
-    "build": "tsc -p tsconfig.json",
-    "dev": "tsx watch src/index.ts",
-    "generate-config-schema": "node ./node_modules/@uns-kit/core/dist/tools/generate-config-schema.js"
-  },
-  "dependencies": {
-    "@uns-kit/core": "__UNS_KIT_CORE_VERSION__",
-    "zod": "^3.23.8"
-  },
-  "devDependencies": {
-    "tsx": "^4.20.5",
-    "typescript": "^5.9.2"
-  }
-}
+{
+  "name": "__APP_NAME__",
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "build": "tsc -p tsconfig.json",
+    "dev": "tsx watch src/index.ts",
+    "generate-config-schema": "node ./node_modules/@uns-kit/core/dist/tools/generate-config-schema.js"
+  },
+  "dependencies": {
+    "@uns-kit/core": "__UNS_KIT_CORE_VERSION__",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "tsx": "^4.20.5",
+    "typescript": "^5.9.2"
+  }
+}