@uns-kit/cli 0.0.24 → 0.0.26

package/README.md

@@ -2,6 +2,12 @@
 
 Command line scaffolding tool for the UNS toolkit. It bootstraps a new project with `@uns-kit/core` preconfigured and ready to extend with additional plugins.
 
+## Prerequisites
+
+- Node.js 18 or newer (ES2022 runtime features)
+- A package manager such as `pnpm`, `npm`, or `yarn`
+- `git` available on PATH (required for `configure-devops`, used to initialize new projects automatically)
+
 ## Usage
 
 ```bash
@@ -21,6 +27,8 @@ pnpm install
 pnpm run dev
 ```
 
+When `git` is available on your PATH the scaffold also initializes a fresh repository so you can commit immediately.
+
 ## Commands
 
 - `uns-kit create <name>` – create a new UNS project in the specified directory.

package/dist/index.js

@@ -155,11 +155,61 @@ async function createProject(projectName) {
     await patchPackageJson(targetDir, pkgName);
     await patchConfigJson(targetDir, pkgName);
     await replacePlaceholders(targetDir, pkgName);
+    const initializedGit = await initGitRepository(targetDir);
     console.log(`\nCreated ${pkgName} in ${path.relative(process.cwd(), targetDir)}`);
     console.log("Next steps:");
     console.log(`  cd ${projectName}`);
     console.log("  pnpm install");
     console.log("  pnpm run dev");
+    if (initializedGit) {
+        console.log("  git status  # verify the new repository");
+    }
+}
+async function initGitRepository(targetDir) {
+    try {
+        const { stdout } = await execFileAsync("git", ["rev-parse", "--is-inside-work-tree"], {
+            cwd: targetDir,
+            encoding: "utf8",
+        });
+        if (stdout.trim() === "true") {
+            return false;
+        }
+    }
+    catch (error) {
+        if (isGitCommandNotFoundError(error)) {
+            console.log("Git not found on PATH. Skipping repository initialization.");
+            return false;
+        }
+        const execError = error;
+        const stderr = typeof execError.stderr === "string" ? execError.stderr : "";
+        if (stderr && !stderr.includes("not a git repository")) {
+            console.warn("Unable to determine git repository status:", stderr.trim());
+            return false;
+        }
+    }
+    try {
+        await execFileAsync("git", ["init"], {
+            cwd: targetDir,
+            encoding: "utf8",
+        });
+        console.log("Initialized empty Git repository.");
+        return true;
+    }
+    catch (error) {
+        if (isGitCommandNotFoundError(error)) {
+            console.log("Git not found on PATH. Skipping repository initialization.");
+            return false;
+        }
+        const execError = error;
+        const stderr = typeof execError.stderr === "string" ? execError.stderr.trim() : "";
+        if (stderr) {
+            console.warn(`Failed to initialize git repository: ${stderr}`);
+        }
+        else {
+            console.warn(`Failed to initialize git repository: ${error.message}`);
+        }
+        return false;
+    }
 }
 async function configureDevops(targetPath) {
     const targetDir = path.resolve(process.cwd(), targetPath ?? ".");
@@ -191,7 +241,7 @@ async function configureDevops(targetPath) {
     const remoteUrl = await getGitRemoteUrl(targetDir, "origin");
     const remoteInfo = remoteUrl ? parseAzureRemote(remoteUrl) : undefined;
     const repositoryName = inferRepositoryNameFromPackage(pkg.name) || inferRepositoryNameFromPackage(path.basename(targetDir));
-    const defaultOrganization = config.devops?.organization?.trim() || remoteInfo?.organization || "sijit";
+    const defaultOrganization = config.devops?.organization?.trim() || remoteInfo?.organization || "example-org";
     const organization = await promptWithDefault(defaultOrganization ? `Azure DevOps organization [${defaultOrganization}]: ` : "Azure DevOps organization: ", defaultOrganization, "Azure DevOps organization is required.");
     const defaultProject = config.devops?.project?.trim() || remoteInfo?.project || "";
     const project = await promptWithDefault(defaultProject ? `Azure DevOps project [${defaultProject}]: ` : "Azure DevOps project: ", defaultProject, "Azure DevOps project is required.");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uns-kit/cli",
-  "version": "0.0.24",
+  "version": "0.0.26",
   "description": "Command line scaffolding tool for UNS applications",
   "type": "module",
   "license": "MIT",
@@ -26,7 +26,7 @@
   ],
   "dependencies": {
     "azure-devops-node-api": "^15.1.1",
-    "@uns-kit/core": "0.0.25"
+    "@uns-kit/core": "0.0.26"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",

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

@@ -32,7 +32,7 @@ const apiInput = await unsProxyProcess.createApiProxy("templateUnsApiInput", api
 /**
  * Register an API endpoint and event handler
  */
-apiInput.get("sij/", "summary-1",{
+apiInput.get("example/", "summary-1",{
   tags: ["Tag1"],
   apiDescription: "Test API endpoint 1",
   queryParams: [
@@ -41,7 +41,7 @@ apiInput.get("sij/", "summary-1",{
   ]
 }); 
 
-apiInput.get("sij/", "summary-2",{
+apiInput.get("example/", "summary-2",{
   tags: ["Tag2"],
   apiDescription: "Test API endpoint 2",
   queryParams: [

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

@@ -33,7 +33,7 @@ cronInput.event.on("cronEvent", async (event: UnsEvents["cronEvent"]) => {
     const time = UnsPacket.formatToISO8601(new Date());
     const numberValue: number = 42;
     const message: IUnsMessage = { data: { time, value: numberValue, uom: PhysicalMeasurements.MiliVolt } };
-    const topic: UnsTopics = "sij/";
+    const topic: UnsTopics = "example/";
     const tags: UnsTags[] = [];
     const packet = await UnsPacket.unsPacketFromUnsMessage(message);
     mqttOutput.publishMqttMessage({ topic, attribute: "data-number", packet, description: "Number value", tags });

package/templates/default/config.json

@@ -19,7 +19,7 @@
   },
   "devops": {
     "provider": "azure-devops",
-    "organization": "sijit",
-    "project": "industry40"
+    "organization": "example-org",
+    "project": "example-project"
   }
 }

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

@@ -35,7 +35,7 @@ mqttInput.event.on("input", async (event) => {
       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 topic: UnsTopics = "example/";
       const tags: UnsTags[] = [];
       const packet = await UnsPacket.unsPacketFromUnsMessage(message);
       mqttOutput.publishMqttMessage({ topic, attribute: "data-number", packet, description: "Number value", tags });

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

@@ -19,7 +19,7 @@ const config = await ConfigFile.loadConfig();
  */
 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"],
+  mqttSubToTopics: ["integration/raw-table"],
   publishThrottlingDelay:0,
   subscribeThrottlingDelay:0
 });
@@ -29,23 +29,23 @@ const mqttOutput = await unsProxyProcess.createUnsMqttProxy((config.output?.host
 });
 
 /**
- * The input worker connects to the IBA broker and listens for incoming messages.
+ * The input worker connects to the upstream 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") {
+    if (event.topic === "integration/raw-table") {
       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 message: IUnsMessage = { table: {dataGroup:"demo_table", values:jsonObject, time}};
+      const topic: UnsTopics = "example/factory-a/line-1/";
       const tags: UnsTags[] = [];
       const packet = await UnsPacket.unsPacketFromUnsMessage(message);
-      mqttOutput.publishMqttMessage({ topic, attribute: "zrm", packet, description: "Table", tags });
+      mqttOutput.publishMqttMessage({ topic, attribute: "table-sample", packet, description: "Table", tags });
     }
   } catch (error) {
     const reason = error instanceof Error ? error : new Error(String(error));

package/templates/python/examples/README.md

@@ -31,28 +31,28 @@ Readiness: Examples call the gateway’s `Ready()` RPC to wait for the requested
 ## Scripts
 
 - `data_transformer.py`
-  - Subscribes to input topics (default `raw/#`) and publishes UNS data packets (`sij/` + `data-number`).
+  - Subscribes to input topics (default `raw/#`) and publishes UNS data packets (`example/` + `data-number`).
   - Examples:
-    - Unix/macOS: `python python/examples/data_transformer.py --addr unix:/tmp/uns-gateway.sock --auto --in raw/# --out-topic sij/ --attribute data-number --uom mV --group electricity`
-    - Windows: `python python/examples/data_transformer.py --addr 127.0.0.1:50051 --auto --in raw/# --out-topic sij/ --attribute data-number --uom mV --group electricity`
+    - Unix/macOS: `python python/examples/data_transformer.py --addr unix:/tmp/uns-gateway.sock --auto --in raw/# --out-topic example/ --attribute data-number --uom mV --group electricity`
+    - Windows: `python python/examples/data_transformer.py --addr 127.0.0.1:50051 --auto --in raw/# --out-topic example/ --attribute data-number --uom mV --group electricity`
 
 - `table_transformer.py`
-  - Subscribes to `iba/zrm` JSON and publishes a UNS table packet (`sij/acroni/hv/` + `zrm`).
+  - Subscribes to `integration/raw-table` JSON and publishes a UNS table packet (`example/factory-a/line-1/` + `table-sample`).
   - Examples:
-    - Unix/macOS: `python python/examples/table_transformer.py --addr unix:/tmp/uns-gateway.sock --auto --in-topic iba/zrm --out-topic sij/acroni/hv/ --attribute zrm`
-    - Windows: `python python/examples/table_transformer.py --addr 127.0.0.1:50051 --auto --in-topic iba/zrm --out-topic sij/acroni/hv/ --attribute zrm`
+    - Unix/macOS: `python python/examples/table_transformer.py --addr unix:/tmp/uns-gateway.sock --auto --in-topic integration/raw-table --out-topic example/factory-a/line-1/ --attribute table-sample`
+    - Windows: `python python/examples/table_transformer.py --addr 127.0.0.1:50051 --auto --in-topic integration/raw-table --out-topic example/factory-a/line-1/ --attribute table-sample`
 
 - `data_publisher_loop.py`
   - Cron-like loop that publishes a data value periodically (default 1000 ms).
   - Examples:
-    - Unix/macOS: `python python/examples/data_publisher_loop.py --addr unix:/tmp/uns-gateway.sock --auto --out-topic sij/ --attribute data-number --uom mV --period-ms 1000`
-    - Windows: `python python/examples/data_publisher_loop.py --addr 127.0.0.1:50051 --auto --out-topic sij/ --attribute data-number --uom mV --period-ms 1000`
+    - Unix/macOS: `python python/examples/data_publisher_loop.py --addr unix:/tmp/uns-gateway.sock --auto --out-topic example/ --attribute data-number --uom mV --period-ms 1000`
+    - Windows: `python python/examples/data_publisher_loop.py --addr 127.0.0.1:50051 --auto --out-topic example/ --attribute data-number --uom mV --period-ms 1000`
 
 - `data_publish_once.py`
   - Sends a single UNS data packet.
   - Examples:
-    - Unix/macOS: `python python/examples/data_publish_once.py --addr unix:/tmp/uns-gateway.sock --auto --out-topic sij/ --attribute data-number --value 42 --uom mV --group electricity`
-    - Windows: `python python/examples/data_publish_once.py --addr 127.0.0.1:50051 --auto --out-topic sij/ --attribute data-number --value 42 --uom mV --group electricity`
+    - Unix/macOS: `python python/examples/data_publish_once.py --addr unix:/tmp/uns-gateway.sock --auto --out-topic example/ --attribute data-number --value 42 --uom mV --group electricity`
+    - Windows: `python python/examples/data_publish_once.py --addr 127.0.0.1:50051 --auto --out-topic example/ --attribute data-number --value 42 --uom mV --group electricity`
 
 - `data_subscribe.py`
   - Subscribes to topics via the gateway and prints messages.
@@ -61,11 +61,11 @@ Readiness: Examples call the gateway’s `Ready()` RPC to wait for the requested
     - Windows: `python python/examples/data_subscribe.py --addr 127.0.0.1:50051 --auto raw/# some/other/topic`
 
 - `api_register_and_serve.py`
-  - Registers `/api/sij/summary-1` and `/api/sij/summary-2` endpoints and serves requests over a bidirectional stream.
+  - Registers `/api/example/summary-1` and `/api/example/summary-2` endpoints and serves requests over a bidirectional stream.
   - Examples:
     - Unix/macOS: `python python/examples/api_register_and_serve.py --addr unix:/tmp/uns-gateway.sock --auto`
     - Windows: `python python/examples/api_register_and_serve.py --addr 127.0.0.1:50051 --auto`
-    - Then call: `http://<gateway-host>:<gateway-port>/api/sij/summary-1?filter=foo&limit=10`
+    - Then call: `http://<gateway-host>:<gateway-port>/api/example/summary-1?filter=foo&limit=10`
 
 - `api_handler.py`
   - Another API handler demo that returns structured JSON responses. Similar to `api_register_and_serve.py`.

package/templates/python/examples/api_handler.py

@@ -22,7 +22,7 @@ def make_channel(addr: str) -> grpc.Channel:
 
 
 def register_endpoints(stub: gw.UnsGatewayStub) -> None:
-    # Mirror TS api-example.ts for two GET endpoints under /api/sij/summary-1 and -2
+    # Mirror TS api-example.ts for two GET endpoints under /api/example/summary-1 and -2
     qp = [
         pb2.ApiQueryParam(name="filter", type="string", required=True, description="Filter za podatke"),
         pb2.ApiQueryParam(name="limit", type="number", required=False, description="Koliko podatkov želiš"),
@@ -30,7 +30,7 @@ def register_endpoints(stub: gw.UnsGatewayStub) -> None:
 
     for idx, tag in [(1, "Tag1"), (2, "Tag2")]:
         req = pb2.RegisterApiGetRequest(
-            topic="sij/",
+            topic="example/",
             attribute=f"summary-{idx}",
             api_description=f"Test API endpoint {idx}",
             tags=[tag],
@@ -54,7 +54,7 @@ def serve_requests(stub: gw.UnsGatewayStub, echo: bool = False) -> None:
     stream = stub.ApiEventStream(req_iter())
     try:
         for ev in stream:
-            # ev.path e.g. /sij/summary-1; ev.query is a map<string,string>
+            # ev.path e.g. /example/summary-1; ev.query is a map<string,string>
             path = ev.path
             query: Dict[str, str] = dict(ev.query)
             filt = query.get("filter", "")

package/templates/python/examples/api_register_and_serve.py

@@ -102,7 +102,7 @@ def register(stub: gw.UnsGatewayStub) -> None:
     ]
     for idx, tag in [(1, "Tag1"), (2, "Tag2")]:
         res = stub.RegisterApiGet(pb2.RegisterApiGetRequest(
-            topic="sij/",
+            topic="example/",
             attribute=f"summary-{idx}",
             api_description=f"Test API endpoint {idx}",
             tags=[tag],

package/templates/python/examples/data_publish_once.py

@@ -126,7 +126,7 @@ def main():
     parser = argparse.ArgumentParser(description="Publish one UNS data packet")
     parser.add_argument("--addr", default=None)
     parser.add_argument("--auto", action="store_true")
-    parser.add_argument("--out-topic", default="sij/")
+    parser.add_argument("--out-topic", default="example/")
     parser.add_argument("--attribute", default="data-number")
     parser.add_argument("--value", type=float, default=42.0)
     parser.add_argument("--uom", default="mV")

package/templates/python/examples/data_publisher_loop.py

@@ -129,7 +129,7 @@ def main():
     parser = argparse.ArgumentParser(description="Publish UNS data packets periodically (cron-like)")
     parser.add_argument("--addr", default=None)
     parser.add_argument("--auto", action="store_true")
-    parser.add_argument("--out-topic", default="sij/")
+    parser.add_argument("--out-topic", default="example/")
     parser.add_argument("--attribute", default="data-number")
     parser.add_argument("--uom", default="mV")
     parser.add_argument("--period-ms", type=int, default=1000)

package/templates/python/examples/data_transformer.py

@@ -134,7 +134,7 @@ def main():
     parser.add_argument("--addr", default=None, help="Gateway address (unix:/path.sock or host:port); defaults to unique per-script")
     parser.add_argument("--auto", action="store_true", help="auto-start gateway if not running")
     parser.add_argument("--in", dest="in_topics", nargs="+", default=["raw/#"], help="input topics to subscribe")
-    parser.add_argument("--out-topic", default="sij/", help="output UNS base topic")
+    parser.add_argument("--out-topic", default="example/", help="output UNS base topic")
     parser.add_argument("--attribute", default="data-number", help="output attribute")
     parser.add_argument("--uom", default="mV", help="unit of measure")
     parser.add_argument("--group", default="electricity", help="dataGroup")

package/templates/python/examples/table_transformer.py

@@ -140,7 +140,7 @@ def transform(addr: str | None, in_topic: str, out_topic: str, out_attribute: st
             req = pb2.PublishRequest(
                 topic=out_topic,
                 attribute=out_attribute,
-                table=pb2.Table(time=time_iso, values=tv_list, data_group="iba_test"),
+                table=pb2.Table(time=time_iso, values=tv_list, data_group="demo_table"),
             )
             res = stub.Publish(req)
             if not res.ok:
@@ -148,12 +148,12 @@ def transform(addr: str | None, in_topic: str, out_topic: str, out_attribute: st
 
 
 def main():
-    parser = argparse.ArgumentParser(description="Subscribe to IBA topic and publish UNS table packets")
+    parser = argparse.ArgumentParser(description="Subscribe to an upstream topic and publish UNS table packets")
     parser.add_argument("--addr", default=None, help="Gateway address (unix:/path.sock or host:port); defaults to unique per-script")
     parser.add_argument("--auto", action="store_true", help="auto-start gateway if not running")
-    parser.add_argument("--in-topic", default="iba/zrm")
-    parser.add_argument("--out-topic", default="sij/acroni/hv/")
-    parser.add_argument("--attribute", default="zrm")
+    parser.add_argument("--in-topic", default="integration/raw-table")
+    parser.add_argument("--out-topic", default="example/factory-a/line-1/")
+    parser.add_argument("--attribute", default="table-sample")
     args = parser.parse_args()
 
     transform(args.addr, args.in_topic, args.out_topic, args.attribute, args.auto)

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

@@ -19,16 +19,16 @@ const config = await ConfigFile.loadConfig();
 const unsProxyProcess = new UnsProxyProcess(config.infra.host!, {processName:config.uns.processName}) as UnsProxyProcessWithTemporal;
 const temporalTopic: ITemporalTopic = {
   attribute: "temporal-data",
-  topic: "sij/",
+  topic: "example/",
   attributeType: UnsAttributeType.Data,
   attributeNeedsPersistence: true,
   dataGroup: "temporal",
   description: "Temporal data example",
   tags: ["temporal"],
 }
-const temporalProxy = await unsProxyProcess.createTemporalProxy("templateUnsTemporal", "temporal-1.sij.digital:7233", "hv");
+const temporalProxy = await unsProxyProcess.createTemporalProxy("templateUnsTemporal", "temporal.example.local:7233", "line-namespace");
 await temporalProxy.initializeTemporalProxy(temporalTopic);
 
 // Start temporal workflow
-const result = await temporalProxy.startWorkflow("TransformHvSclData", {'coil_id': "42"}, "ETL_HV_SCL_TASK_QUEUE");
-logger.info(`Workflow result: ${JSON.stringify(result)}`);
+const result = await temporalProxy.startWorkflow("TransformLineData", {'coil_id': "42"}, "ETL_LINE_TASK_QUEUE");
+logger.info(`Workflow result: ${JSON.stringify(result)}`);