axiodb 22.9.7 → 22.11.0

package/README.md

@@ -55,11 +55,54 @@ console.log(data.documents);
 
 ## Installation
 
+### npm (Library)
+
 ```bash
 npm install axiodb
 # Node.js ≥20 (also verified on Bun v1.4.0)
 ```
 
+### CLI & Desktop GUI (System-wide)
+
+AxioDB ships a CLI tool and a native Desktop GUI (Electron). The installer
+presents a menu — **1) CLI**, **2) GUI**, **3) Both** — when run interactively,
+and defaults to CLI when piped (`curl | bash`).
+
+#### Quick Install (interactive)
+
+```bash
+# Linux / macOS
+curl -fsSL https://raw.githubusercontent.com/nexoral/AxioDB/main/cli/Scripts/install.sh | bash
+
+# Windows (PowerShell)
+irm https://raw.githubusercontent.com/nexoral/AxioDB/main/cli/Scripts/install.ps1 | iex
+```
+
+#### Non-Interactive (choose what you want)
+
+Set `CHOICE` before piping to select without the menu:
+
+| `CHOICE` | Installs |
+|----------|----------|
+| `1` | CLI only |
+| `2` | GUI (Desktop) only |
+| `3` | CLI + GUI |
+
+```bash
+# GUI (Desktop app) — Linux
+curl -fsSL https://raw.githubusercontent.com/nexoral/AxioDB/main/cli/Scripts/install.sh | CHOICE=2 bash
+
+# GUI (Desktop app) — Windows
+irm https://raw.githubusercontent.com/nexoral/AxioDB/main/cli/Scripts/install.ps1 | CHOICE=2 iex
+
+# Both CLI + GUI
+curl -fsSL https://raw.githubusercontent.com/nexoral/AxioDB/main/cli/Scripts/install.sh | CHOICE=3 bash
+```
+
+You can also download installers directly from
+[GitHub Releases](https://github.com/nexoral/AxioDB/releases).
+
+
 ## Basic CRUD
 
 CRUD means **Create, Read, Update, and Delete**. The following example creates a database and

package/lib/engine/cli/worker_process.d.ts

@@ -0,0 +1,19 @@
+export default class WorkerProcess {
+    /**
+     * Executes a binary with explicit arguments without a shell, capturing stdout.
+     *
+     * No shell string is ever constructed, so filenames or paths containing shell
+     * metacharacters cannot inject extra commands. Always prefer this over building
+     * a shell command when arguments derive from user-controlled paths.
+     *
+     * @param command - The executable to run (e.g. "du", "wc", "powershell").
+     * @param args - Arguments passed verbatim; no quoting or interpolation is applied.
+     * @returns The command's captured stdout.
+     * @example
+     * const size = await worker.execCommandSafely("wc", ["-c", "--", targetPath]);
+     */
+    execCommandSafely(command: string, args?: string[]): Promise<string>;
+    /** Inherits stdio; rejects if the process exits with a non-zero code. */
+    spawnCommand(command: string, args?: string[]): Promise<void>;
+    static getOS(): string;
+}

package/lib/engine/cli/worker_process.js

@@ -0,0 +1,92 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
+class WorkerProcess {
+    /**
+     * Executes a binary with explicit arguments without a shell, capturing stdout.
+     *
+     * No shell string is ever constructed, so filenames or paths containing shell
+     * metacharacters cannot inject extra commands. Always prefer this over building
+     * a shell command when arguments derive from user-controlled paths.
+     *
+     * @param command - The executable to run (e.g. "du", "wc", "powershell").
+     * @param args - Arguments passed verbatim; no quoting or interpolation is applied.
+     * @returns The command's captured stdout.
+     * @example
+     * const size = await worker.execCommandSafely("wc", ["-c", "--", targetPath]);
+     */
+    execCommandSafely(command_1) {
+        return __awaiter(this, arguments, void 0, function* (command, args = []) {
+            try {
+                const stdout = yield new Promise((resolve, reject) => {
+                    const child = (0, child_process_1.spawn)(command, args, { shell: false });
+                    let out = "";
+                    let err = "";
+                    child.stdout.on("data", (chunk) => {
+                        out += chunk.toString();
+                    });
+                    child.stderr.on("data", (chunk) => {
+                        err += chunk.toString();
+                    });
+                    child.on("error", reject);
+                    child.on("close", (code) => {
+                        if (code === 0) {
+                            resolve(out);
+                        }
+                        else {
+                            reject(new Error(`Command failed with exit code ${code}${err ? `: ${err.trim()}` : ""}`));
+                        }
+                    });
+                });
+                return stdout;
+            }
+            catch (error) {
+                throw new Error(`Failed to execute command: ${error}`);
+            }
+        });
+    }
+    /** Inherits stdio; rejects if the process exits with a non-zero code. */
+    spawnCommand(command_1) {
+        return __awaiter(this, arguments, void 0, function* (command, args = []) {
+            try {
+                const child = (0, child_process_1.spawn)(command, args, { stdio: "inherit" });
+                return new Promise((resolve, reject) => {
+                    child.on("close", (code) => {
+                        if (code !== 0) {
+                            reject(new Error(`Command failed with exit code ${code}`));
+                        }
+                        else {
+                            resolve();
+                        }
+                    });
+                });
+            }
+            catch (error) {
+                throw new Error(`Failed to spawn command: ${error}`);
+            }
+        });
+    }
+    static getOS() {
+        const platform = process.platform;
+        if (platform === "win32") {
+            return "windows";
+        }
+        if (platform === "darwin") {
+            return "macos";
+        }
+        if (platform === "linux") {
+            return "linux";
+        }
+        throw new Error(`Unsupported platform: ${platform}`);
+    }
+}
+exports.default = WorkerProcess;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axiodb",
-  "version": "22.9.7",
+  "version": "22.11.0",
   "description": "The embedded database for Node.js. Replaces SQLite, LowDB, NeDB & raw JSON files with MongoDB-style queries, ACID transactions, zero native dependencies, and built-in InMemoryCache. No compilation, no platform issues. Perfect for desktop apps, CLI tools, and embedded systems.",
   "main": "./lib/config/DB.js",
   "types": "./lib/config/DB.d.ts",

package/electron/electron-builder.json

@@ -1,54 +0,0 @@
-{
-  "appId": "com.axiodb.control",
-  "productName": "AxioDB Control",
-  "copyright": "Copyright © 2026 Ankan Saha",
-  "directories": {
-    "output": "release",
-    "buildResources": "resources"
-  },
-  "files": [
-    "dist/**/*",
-    "dist-electron/**/*",
-    "resources/**/*",
-    "package.json"
-  ],
-  "extraResources": [
-    {
-      "from": "resources/icon.png",
-      "to": "icon.png"
-    }
-  ],
-  "linux": {
-    "target": [
-      { "target": "deb", "arch": ["x64", "arm64"] },
-      { "target": "AppImage", "arch": ["x64", "arm64"] }
-    ],
-    "maintainer": "Ankan Saha <dev@axiodb.in>",
-    "category": "Development",
-    "icon": "resources/icons",
-    "synopsis": "Desktop GUI management client for AxioDB",
-    "description": "Next-generation desktop interface for managing AxioDB databases, collections, documents, queries, and monitoring.",
-    "desktop": {
-      "StartupWMClass": "AxioDB Control"
-    }
-  },
-  "win": {
-    "target": [
-      { "target": "nsis", "arch": ["x64"] }
-    ],
-    "icon": "resources/icon.png"
-  },
-  "mac": {
-    "target": [
-      { "target": "zip", "arch": ["x64", "arm64"] }
-    ],
-    "category": "public.app-category.developer-tools",
-    "icon": "resources/icon.png"
-  },
-  "nsis": {
-    "oneClick": false,
-    "allowToChangeInstallationDirectory": true,
-    "createDesktopShortcut": true,
-    "createStartMenuShortcut": true
-  }
-}