@uns-kit/cli 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Aljoša Vister
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,29 @@
+# @uns-kit/cli
+
+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.
+
+## Usage
+
+```bash
+pnpm dlx @uns-kit/cli create my-uns-app
+# or after installing globally
+yarn global add @uns-kit/cli
+uns-kit create my-uns-app
+```
+
+The command creates a new directory, copies the starter template, and pins `@uns-kit/core` to the currently published version. After the scaffold finishes:
+
+```bash
+cd my-uns-app
+pnpm install
+pnpm run dev
+```
+
+## Commands
+
+- `uns-kit create <name>` – create a new UNS project in the specified directory.
+- `uns-kit help` – display usage information.
+
+## License
+
+MIT © Aljoša Vister

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -0,0 +1,151 @@
+#!/usr/bin/env node
+import { access, cp, mkdir, readFile, readdir, stat, writeFile } from "node:fs/promises";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { createRequire } from "node:module";
+import process from "node:process";
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const require = createRequire(import.meta.url);
+const coreVersion = resolveCoreVersion();
+async function main() {
+    const args = process.argv.slice(2);
+    const command = args[0];
+    if (!command || command === "help" || command === "--help" || command === "-h") {
+        printHelp();
+        return;
+    }
+    if (command === "create") {
+        const projectName = args[1];
+        if (!projectName) {
+            console.error("Missing project name. Example: uns-kit create my-app");
+            process.exitCode = 1;
+            return;
+        }
+        try {
+            await createProject(projectName);
+        }
+        catch (error) {
+            console.error(error.message);
+            process.exitCode = 1;
+        }
+        return;
+    }
+    console.error(`Unknown command: ${command}`);
+    printHelp();
+    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`);
+}
+async function createProject(projectName) {
+    const targetDir = path.resolve(process.cwd(), projectName);
+    await ensureTargetDir(targetDir);
+    const templateDir = path.resolve(__dirname, "../templates/default");
+    await cp(templateDir, targetDir, { recursive: true, force: false });
+    const pkgName = normalizePackageName(projectName);
+    await patchPackageJson(targetDir, pkgName);
+    await patchConfigJson(targetDir, pkgName);
+    await replacePlaceholders(targetDir, pkgName);
+    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");
+}
+async function ensureTargetDir(dir) {
+    try {
+        const stats = await stat(dir);
+        if (!stats.isDirectory()) {
+            throw new Error(`Path ${dir} exists and is not a directory.`);
+        }
+        const entries = await readdir(dir);
+        if (entries.length > 0) {
+            throw new Error(`Directory ${dir} is not empty.`);
+        }
+    }
+    catch (error) {
+        if (error.code === "ENOENT") {
+            await mkdir(dir, { recursive: true });
+            return;
+        }
+        throw error;
+    }
+}
+async function patchPackageJson(targetDir, packageName) {
+    const pkgFile = path.join(targetDir, "package.json");
+    const raw = await readFile(pkgFile, "utf8");
+    const pkg = JSON.parse(raw);
+    pkg.name = packageName;
+    if (pkg.dependencies && pkg.dependencies["@uns-kit/core"]) {
+        pkg.dependencies["@uns-kit/core"] = `^${coreVersion}`;
+    }
+    await writeFile(pkgFile, JSON.stringify(pkg, null, 2) + "\n", "utf8");
+}
+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;
+    }
+    await writeFile(configFile, JSON.stringify(config, null, 2) + "\n", "utf8");
+}
+async function replacePlaceholders(targetDir, packageName) {
+    const replacements = {
+        __APP_NAME__: packageName
+    };
+    const filesToUpdate = [
+        path.join(targetDir, "README.md"),
+        path.join(targetDir, "src/index.ts")
+    ];
+    for (const file of filesToUpdate) {
+        try {
+            await access(file);
+            let content = await readFile(file, "utf8");
+            for (const [placeholder, value] of Object.entries(replacements)) {
+                content = content.replace(new RegExp(placeholder, "g"), value);
+            }
+            await writeFile(file, content, "utf8");
+        }
+        catch (error) {
+            if (error.code !== "ENOENT") {
+                throw error;
+            }
+        }
+    }
+}
+function normalizePackageName(input) {
+    const trimmed = input.trim();
+    if (trimmed.startsWith("@")) {
+        return trimmed;
+    }
+    return trimmed
+        .toLowerCase()
+        .replace(/[^a-z0-9-]+/g, "-")
+        .replace(/^-+|-+$/g, "")
+        || "uns-app";
+}
+function resolveCoreVersion() {
+    try {
+        const corePkg = require("@uns-kit/core/package.json");
+        if (corePkg?.version) {
+            return corePkg.version;
+        }
+    }
+    catch (error) {
+        // Ignore and try local path
+    }
+    try {
+        const localPath = path.resolve(__dirname, "../../uns-core/package.json");
+        const raw = require(localPath);
+        if (raw?.version) {
+            return raw.version;
+        }
+    }
+    catch (error) {
+        // Ignore
+    }
+    return "0.0.1";
+}
+void main();

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@uns-kit/cli",
+  "version": "0.0.1",
+  "description": "Command line scaffolding tool for UNS applications",
+  "type": "module",
+  "license": "MIT",
+  "author": "Aljoša Vister <aljosa.vister@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/uns-datahub/uns-kit.git",
+    "directory": "packages/uns-cli"
+  },
+  "bin": {
+    "uns-kit": "./dist/index.js",
+    "uns": "./dist/index.js"
+  },
+  "keywords": [
+    "uns",
+    "cli",
+    "scaffold",
+    "template",
+    "typescript"
+  ],
+  "files": [
+    "dist",
+    "templates"
+  ],
+  "dependencies": {
+    "@uns-kit/core": "^0.0.1"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}

package/templates/default/README.md

@@ -0,0 +1,21 @@
+# __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
+```
+
+## 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`.
+- Commit your new project and start building!

package/templates/default/config.json

@@ -0,0 +1,18 @@
+{
+  "uns": {
+    "graphql": "http://localhost:3200/graphql",
+    "rest": "http://localhost:3200/api",
+    "processName": "__APP_NAME__",
+    "instanceMode": "wait",
+    "handover": true
+  },
+  "infra": {
+    "host": "localhost:1883"
+  },
+  "output": {
+    "host": "localhost:1883"
+  },
+  "input": {
+    "host": "localhost:1883"
+  }
+}

package/templates/default/package.json

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

package/templates/default/src/index.ts

@@ -0,0 +1,15 @@
+import UnsProxyProcess from "@uns-kit/core/uns/uns-proxy-process";
+
+async function main(): Promise<void> {
+  const name = "__APP_NAME__";
+  const process = new UnsProxyProcess("localhost:1883", {
+    processName: name,
+  });
+
+  console.log(`UNS process '${name}' is ready. Edit src/index.ts to add your logic.`);
+
+  // Keep the process alive or add plugin logic here
+  void process;
+}
+
+void main();

package/templates/default/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2022"],
+    "module": "es2022",
+    "moduleResolution": "node",
+    "noEmit": false,
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*.ts"]
+}