@uns-kit/cli 0.0.3 → 0.0.5

package/README.md

@@ -7,7 +7,7 @@ Command line scaffolding tool for the UNS toolkit. It bootstraps a new project w
 ```bash
 pnpm --package=@uns-kit/cli dlx uns-kit create my-uns-app
 # or with npx
-npx -p @uns-kit/cli@latest uns-kit create my-uns-app
+npx @uns-kit/cli create my-uns-app
 # or after installing globally
 npm install -g @uns-kit/cli
 uns-kit create my-uns-app
@@ -24,8 +24,25 @@ pnpm run dev
 ## Commands
 
 - `uns-kit create <name>` – create a new UNS project in the specified directory.
+- `uns-kit configure-devops [path]` – add Azure DevOps tooling (dependencies, script, config) to an existing project.
 - `uns-kit help` – display usage information.
 
+### Configure Azure DevOps
+
+Run inside a scaffolded project to add the Azure DevOps pull-request tooling:
+
+```bash
+uns-kit configure-devops
+pnpm install
+pnpm run pull-request
+```
+
+The command prompts for your Azure DevOps organization and updates `config.json` along with the necessary dev dependencies.
+
+### Extend the Config Schema
+
+Edit `src/config/project.config.extension.ts` inside your generated project and run `pnpm run generate-config-schema`. This regenerates `config.schema.json` and `src/config/app-config.ts` so editors and runtime types stay in sync.
+
 ## License
 
 MIT © Aljoša Vister

package/dist/index.js

@@ -4,6 +4,7 @@ import path from "node:path";
 import { fileURLToPath } from "node:url";
 import { createRequire } from "node:module";
 import process from "node:process";
+import readline from "node:readline/promises";
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 const require = createRequire(import.meta.url);
@@ -15,6 +16,17 @@ async function main() {
         printHelp();
         return;
     }
+    if (command === "configure-devops") {
+        const targetPath = args[1];
+        try {
+            await configureDevops(targetPath);
+        }
+        catch (error) {
+            console.error(error.message);
+            process.exitCode = 1;
+        }
+        return;
+    }
     if (command === "create") {
         const projectName = args[1];
         if (!projectName) {
@@ -36,7 +48,7 @@ async function main() {
     process.exitCode = 1;
 }
 function printHelp() {
-    console.log(`\nUsage: uns-kit <command> [options]\n\nCommands:\n  create <name>   Scaffold a new UNS application\n  help            Show this message\n`);
+    console.log(`\nUsage: uns-kit <command> [options]\n\nCommands:\n  create <name>           Scaffold a new UNS application\n  configure-devops [dir]  Configure Azure DevOps tooling in an existing project\n  help                    Show this message\n`);
 }
 async function createProject(projectName) {
     const targetDir = path.resolve(process.cwd(), projectName);
@@ -53,6 +65,81 @@ async function createProject(projectName) {
     console.log("  pnpm install");
     console.log("  pnpm run dev");
 }
+async function configureDevops(targetPath) {
+    const targetDir = path.resolve(process.cwd(), targetPath ?? ".");
+    const packagePath = path.join(targetDir, "package.json");
+    const configPath = path.join(targetDir, "config.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;
+    }
+    let configRaw;
+    try {
+        configRaw = await readFile(configPath, "utf8");
+    }
+    catch (error) {
+        if (error.code === "ENOENT") {
+            throw new Error(`Could not find config.json in ${targetDir}`);
+        }
+        throw error;
+    }
+    const pkg = JSON.parse(pkgRaw);
+    const config = JSON.parse(configRaw);
+    const defaultOrg = config.devops?.organization ?? "sijit";
+    const answer = (await promptQuestion(`Azure DevOps organization [${defaultOrg}]: `)).trim();
+    const organization = answer || defaultOrg;
+    if (!config.devops || typeof config.devops !== "object") {
+        config.devops = {};
+    }
+    config.devops.organization = organization;
+    const requiredDevDeps = {
+        "azure-devops-node-api": "^15.1.0",
+        "simple-git": "^3.27.0",
+        "chalk": "^5.4.1",
+        "prettier": "^3.5.3"
+    };
+    let pkgChanged = false;
+    const devDeps = (pkg.devDependencies ??= {});
+    const deps = pkg.dependencies ?? {};
+    for (const [name, version] of Object.entries(requiredDevDeps)) {
+        if (!devDeps[name] && !deps[name]) {
+            devDeps[name] = version;
+            pkgChanged = true;
+        }
+    }
+    const scripts = (pkg.scripts ??= {});
+    if (!scripts["pull-request"]) {
+        scripts["pull-request"] = "node ./node_modules/@uns-kit/core/dist/tools/pull-request.js";
+        pkgChanged = true;
+    }
+    await writeFile(configPath, JSON.stringify(config, null, 2) + "\n", "utf8");
+    if (pkgChanged) {
+        await writeFile(packagePath, JSON.stringify(pkg, null, 2) + "\n", "utf8");
+    }
+    console.log(`\nDevOps tooling configured.`);
+    console.log(`  Azure organization: ${organization}`);
+    if (pkgChanged) {
+        console.log("  Updated package.json scripts/devDependencies. Run pnpm install to fetch new packages.");
+    }
+    else {
+        console.log("  Existing package.json already contained required entries.");
+    }
+}
+async function promptQuestion(message) {
+    const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+    try {
+        return await rl.question(message);
+    }
+    finally {
+        rl.close();
+    }
+}
 async function ensureTargetDir(dir) {
     try {
         const stats = await stat(dir);
@@ -84,12 +171,20 @@ async function patchPackageJson(targetDir, packageName) {
 }
 async function patchConfigJson(targetDir, packageName) {
     const configFile = path.join(targetDir, "config.json");
-    const raw = await readFile(configFile, "utf8");
-    const config = JSON.parse(raw);
-    if (config.uns && typeof config.uns === "object") {
-        config.uns.processName = packageName;
+    try {
+        const raw = await readFile(configFile, "utf8");
+        const config = JSON.parse(raw);
+        if (config.uns && typeof config.uns === "object") {
+            config.uns.processName = packageName;
+        }
+        await writeFile(configFile, JSON.stringify(config, null, 2) + "\n", "utf8");
+    }
+    catch (error) {
+        if (error.code === "ENOENT") {
+            return;
+        }
+        throw error;
     }
-    await writeFile(configFile, JSON.stringify(config, null, 2) + "\n", "utf8");
 }
 async function replacePlaceholders(targetDir, packageName) {
     const replacements = {
@@ -97,7 +192,8 @@ async function replacePlaceholders(targetDir, packageName) {
     };
     const filesToUpdate = [
         path.join(targetDir, "README.md"),
-        path.join(targetDir, "src/index.ts")
+        path.join(targetDir, "src/index.ts"),
+        path.join(targetDir, "config.json")
     ];
     for (const file of filesToUpdate) {
         try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uns-kit/cli",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Command line scaffolding tool for UNS applications",
   "type": "module",
   "license": "MIT",

package/templates/default/README.md

@@ -8,6 +8,7 @@ Generated with `@uns-kit/cli`.
 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 types
 ```
 
 ## Configuration
@@ -18,4 +19,6 @@ Update `config.json` with your broker, UNS URLs, and credentials. The generated
 
 - 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`.
+- Run `uns-kit configure-devops` to add the Azure DevOps pull-request tooling.
 - Commit your new project and start building!

package/templates/default/config.json

@@ -0,0 +1,23 @@
+{
+  "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"
+  },
+  "infra": {
+    "host": "localhost:1883"
+  },
+  "output": {
+    "host": "localhost:1883"
+  },
+  "input": {
+    "host": "localhost:1883"
+  },
+  "devops": {
+    "organization": "sijit"
+  }
+}

package/templates/default/package.json

@@ -6,10 +6,12 @@
     "typecheck": "tsc --noEmit",
     "build": "tsc -p tsconfig.json",
     "start": "node ./dist/index.js",
-    "dev": "tsx watch src/index.ts"
+    "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__"
+    "@uns-kit/core": "__UNS_KIT_CORE_VERSION__",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "tsx": "^4.20.5",

package/templates/default/src/config/project.config.extension.example

@@ -0,0 +1,23 @@
+import { z } from "zod";
+import { secretValueSchema } from "@uns-kit/core/dist/uns-config/secret-placeholders";
+import { hostValueSchema } from "@uns-kit/core/dist/uns-config/host-placeholders";
+
+// Extend this schema with project-specific configuration sections.
+export const projectExtrasSchema = z.object({
+  pg: z.object({
+    user: z.string().min(1, "pg.user is required"),
+    host: hostValueSchema,
+    port: z.number().int().positive().default(5432),
+    ssl: z.boolean().default(false),
+    database: z.string().min(1, "pg.database is required"),
+    isPoolConnection: z.boolean().default(false),
+    password: secretValueSchema.optional(),
+  }),
+
+  caddy: z.object({
+    adminUrl: z.string().url(),
+    proxyHost: z.string().url(),
+  }),
+});
+
+export type ProjectExtras = z.infer<typeof projectExtrasSchema>;

package/templates/default/src/config/project.config.extension.ts

@@ -0,0 +1,6 @@
+import { z } from "zod";
+
+// Extend this schema with project-specific configuration sections.
+export const projectExtrasSchema = z.object({});
+
+export type ProjectExtras = z.infer<typeof projectExtrasSchema>;

package/templates/default/src/examples/data-example.ts

@@ -0,0 +1,50 @@
+/**
+ * Change this file according to your specifications and rename it to index.ts
+ */
+import UnsProxyProcess from "../uns/uns-proxy-process.js";
+import { ConfigFile } from "../config-file.js";
+import logger from "../logger.js";
+import { IUnsMessage } from "../uns/uns-interfaces.js";
+import { PhysicalMeasurements } from "../uns/uns-measurements.js";
+import { UnsPacket } from "../uns/uns-packet.js";
+import { UnsTags } from "../uns/uns-tags.js";
+import { UnsTopics } from "../uns/uns-topics.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 input and output brokers
+ */
+const unsProxyProcess = new UnsProxyProcess(config.infra.host, {processName: config.uns.processName});
+const mqttInput = await unsProxyProcess.createUnsMqttProxy(config.input.host, "templateUnsRttInput", config.uns.instanceMode, config.uns.handover, {
+  mqttSubToTopics: ["raw/#"],
+});
+const mqttOutput = await unsProxyProcess.createUnsMqttProxy(config.output.host, "templateUnsRttOutput", config.uns.instanceMode, config.uns.handover, { publishThrottlingDelay: 1000});
+
+
+/**
+ * Event listener for input events.
+ * Transform an input message and publish it with publishMqttMessage function.
+ */
+mqttInput.event.on("input", async (event) => {
+  try {
+    if (event.topic === "raw/data") {
+      const time = UnsPacket.formatToISO8601(new Date());
+      const values = event.message.split(",");
+      const numberValue: number = parseFloat(values[0]);
+      const message: IUnsMessage = { data: { dataGroup:"electricity", time, value: numberValue, uom: PhysicalMeasurements.MiliVolt } };
+      const topic: UnsTopics = "sij/";
+      const tags: UnsTags[] = [];
+      const packet = await UnsPacket.unsPacketFromUnsMessage(message);
+      mqttOutput.publishMqttMessage({ topic, attribute: "data-number", packet, description: "Number value", tags });
+    }
+  } catch (error) {
+    logger.error(`Error publishing message to MQTT: ${error.message}`);
+    throw error;
+  }
+});

package/templates/default/src/examples/load-test-data.ts

@@ -0,0 +1,90 @@
+/**
+ * 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.
+ */
+import readline from "readline";
+import { ConfigFile } from "../config-file.js";
+import UnsMqttProxy from "../uns-mqtt/uns-mqtt-proxy.js";
+import logger from "../logger.js";
+
+
+/**
+ * This script initializes an MQTT output proxy for load testing purposes.
+ * It sets up a connection to the specified MQTT broker and configures
+ * a proxy instance. The load test is designed to evaluate the performance
+ * and reliability of the MQTT broker under simulated load conditions.
+ */
+async function main() {
+  try {
+    const config = await ConfigFile.loadConfig();
+    const mqttOutput = new UnsMqttProxy(
+      config.output.host,
+      "loadTest",
+      "templateUnsRttLoadTest",
+      { publishThrottlingDelay: 0 },
+      true
+    );
+
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout,
+    });
+
+    await new Promise((resolve) => setTimeout(resolve, 1000));
+
+    rl.question(`Would you like to continue with load-test on ${config.output.host}? (Y/n) `, async (answer) => {
+      if (answer.toLowerCase() === "y" || answer.trim() === "") {
+        rl.question("How many iterations should be run? (default is 100) ", async (iterations) => {
+          const maxIntervals = parseInt(iterations) || 100;
+
+          rl.question("What should be the delay between intervals in milliseconds? (default is 0 ms) ", async (intervalDelay) => {
+            const delay = parseInt(intervalDelay) || 0;
+
+            logger.info(`Starting load test with ${maxIntervals} messages and ${delay} ms delay...`);
+
+            let count = 0;
+            const startTime = Date.now();
+
+            while (count < maxIntervals) {
+              try {
+                const currentDate = new Date();
+                const rawData = `${count},${currentDate.getTime()}`;
+                await mqttOutput.publishMessage("raw/data", rawData);
+              } catch (error) {
+                logger.error("Error publishing message:", error.message);
+              }
+
+              count++;
+              if (delay > 0) {
+                await new Promise((resolve) => setTimeout(resolve, delay));
+              }
+            }
+
+            logger.info(`Sleeping for 50ms.`);
+            await new Promise((resolve) => setTimeout(resolve, 50));
+
+            const endTime = Date.now();
+            const duration = (endTime - startTime) / 1000;
+            const messagesPerSecond = maxIntervals / duration;
+
+            logger.info(`Load test completed in ${duration.toFixed(2)} seconds.`);
+            logger.info(`Message rate: ${messagesPerSecond.toFixed(2)} msg/s.`);
+
+            rl.close();
+            process.exit(0);
+          });
+        });
+      } else {
+        logger.info("Load test aborted.");
+        rl.close();
+        process.exit(0);
+      }
+    });
+  } catch (error) {
+    logger.error("Error initializing load test:", error.message);
+    process.exit(1);
+  }
+}
+
+main();

package/templates/default/src/examples/table-example.ts

@@ -0,0 +1,59 @@
+/**
+ * Change this file according to your specifications and rename it to index.ts
+ */
+
+import UnsProxyProcess from "../uns/uns-proxy-process.js";
+import { ConfigFile } from "../config-file.js";
+import logger from "../logger.js";
+import { IUnsMessage } from "../uns/uns-interfaces.js";
+import { UnsPacket } from "../uns/uns-packet.js";
+import { UnsTags } from "../uns/uns-tags.js";
+import { UnsTopics } from "../uns/uns-topics.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();
+
+/**
+ * Load and configure input and output brokers from config.json
+ */
+if (!config.infra?.host || !config.input?.host || !config.output?.host) {
+  throw new Error("Missing required configuration in config.json");
+}
+const unsProxyProcess = new UnsProxyProcess(config.infra.host, {processName: config.uns.processName});
+const mqttInput = await unsProxyProcess.createUnsMqttProxy(config.input.host, "templateUnsRttInput", config.uns.instanceMode, config.uns.handover, {
+  mqttSubToTopics: ["iba/zrm"],
+  publishThrottlingDelay:0,
+  subscribeThrottlingDelay:0
+});
+const mqttOutput = await unsProxyProcess.createUnsMqttProxy(config.output.host, "templateUnsRttOutput", config.uns.instanceMode, config.uns.handover, {
+  publishThrottlingDelay:0,
+  subscribeThrottlingDelay:0  
+});
+
+/**
+ * The input worker connects to the IBA broker and listens for incoming messages.
+ * It processes the messages and transforms them into a table-type IUnsMessage.
+ * The resulting message is published to the output broker.
+ */
+mqttInput.event.on("input", async (event) => {
+  try {
+    if (event.topic === "iba/zrm") {
+      const jsonObject = JSON.parse(event.message);
+      const timestamp = jsonObject.Timestamp;
+      delete(jsonObject.Timestamp);
+
+      const time = UnsPacket.formatToISO8601(new Date(timestamp));
+      const message: IUnsMessage = { table: {dataGroup:"iba_test", values:jsonObject, time}};
+      const topic: UnsTopics = "sij/acroni/hv/";
+      const tags: UnsTags[] = [];
+      const packet = await UnsPacket.unsPacketFromUnsMessage(message);
+      mqttOutput.publishMqttMessage({ topic, attribute: "zrm", packet, description: "Table", tags });
+    }
+  } catch (error) {
+    logger.error(`Error publishing message to MQTT: ${error.message}`);
+  }
+});