locadot 1.4.1 → 1.5.0

package/README.md

@@ -14,7 +14,7 @@
 ## 🚀 Usage
 
 ```bash
-npx locadot --host dev.localhost --port 3350
+npx locadot add --host dev.localhost --port 3350
 ```
 
 ---
@@ -26,7 +26,24 @@ npx locadot --host dev.localhost --port 3350
 ###### Starts a reverse proxy to the specified localhost port.
 
 ```bash
-npx locadot --host <custom.localhost> --port <localhost-port>
+npx locadot add --host <custom.localhost> --port <localhost-port>
+```
+
+##### 🧾 Update existing host
+
+###### Update domains currently registered with locadot.
+
+```bash
+npx locadot update --host <your.localhost> --port <localhost-port>
+```
+
+
+##### 🧾 Remove existing host
+
+###### Remove domains currently registered with locadot.
+
+```bash
+npx locadot remove --host <your.localhost>
 ```
 
 ##### 🧾 View Registered Hosts
@@ -42,7 +59,7 @@ npx locadot host
 ###### Continuously watches and outputs proxy logs in real time.
 
 ```bash
-npx locadot watch logs
+npx locadot watch:logs
 ```
 
 ##### 🧹 Clear Logs
@@ -50,15 +67,42 @@ npx locadot watch logs
 ###### Clears all saved logs.
 
 ```bash
-npx locadot clear logs
+npx locadot clear:logs
 ```
+
+##### 🧹 Clear Hosts
+
+###### Clears all existing hosts.
+
+```bash
+npx locadot clear:hosts
+```
+
+##### 🧹 Show Config Path
+
+###### Print the path of config files used.
+
+```bash
+npx locadot path
+```
+
 ##### 🧹 Show Logs Path
 
 ###### Print the path of logged files used.
 
 ```bash
-npx locadot path logs
+npx locadot path:logs
 ```
+
+
+##### 🧹 Show Hosts Path
+
+###### Print the path of hosts files used.
+
+```bash
+npx locadot path:hosts
+```
+
 ##### 🔄 Restart Proxy
 
 ###### Restarts the proxy server and reloads configuration.

package/dist/certs.js

@@ -9,18 +9,19 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const CERT_PATH = (0, appdata_path_1.default)("locadot");
 const mkcert_1 = require("mkcert");
+const logger_1 = __importDefault(require("./utils/logger"));
 async function createSSL(domain) {
-    console.log(`🔐 Preparing SSL cert for ${domain}`);
+    logger_1.default.info(`🔐 Preparing SSL cert for ${domain}`);
     const KEY_FILE = path_1.default.join(CERT_PATH, domain + ".key");
     const CERT_FILE = path_1.default.join(CERT_PATH, domain + ".pem");
     if (fs_1.default.existsSync(KEY_FILE) && fs_1.default.existsSync(CERT_FILE)) {
-        console.log(`🔄 Using existing certificate for ${domain}`);
+        logger_1.default.info(`🔄 Using existing certificate for ${domain}`);
         const key = fs_1.default.readFileSync(KEY_FILE, "utf-8");
         const cert = fs_1.default.readFileSync(CERT_FILE, "utf-8");
         return { key, cert };
     }
     // Otherwise, generate a new one
-    console.log(`🔐 Generating SSL cert for ${domain}`);
+    logger_1.default.info(`🔐 Generating SSL cert for ${domain}`);
     const ca = await (0, mkcert_1.createCA)({
         organization: "Locadot",
         countryCode: "IN",

package/dist/constants/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const appdata_path_1 = __importDefault(require("appdata-path"));
+const path_1 = __importDefault(require("path"));
+const PACKAGE_PATH = (0, appdata_path_1.default)("locadot");
+const LOGS = path_1.default.join(PACKAGE_PATH, ".locadot.log");
+const LOCK_FILE = path_1.default.join(PACKAGE_PATH, ".locadot.lock");
+const REGISTRY_FILE = path_1.default.join(PACKAGE_PATH, ".locadot-registry.json");
+class Constants {
+}
+Constants.paths = {
+    LOCK_FILE: LOCK_FILE,
+    REGISTRY_FILE: REGISTRY_FILE,
+    LOGS: LOGS,
+};
+Constants.proxyInfo = {
+    invalidHost: "❌ Invalid domain. Please use a valid localhost domain like dev.localhost, localhost, test.localhost, etc.",
+    hostExist: "❌ Domain already in use. Please choose another domain or stop the existing instance.",
+    hostNotFound: "❌ Domain not found. Please choose another domain or stop the existing instance.",
+    proxyClose: "☑️ Successfully stopped all locadot instances.",
+    softClose: "☑️ Successfully stopped central proxy..",
+};
+exports.default = Constants;

package/dist/constants/template.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.proxyNotFound = void 0;
+const proxyNotFound = (host) => `
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Proxy Error</title>
+  <style>
+    body {
+      background-color: #121212;
+      color: #f8d7da;
+      font-family: 'Segoe UI', sans-serif;
+      margin: 0;
+      padding: 20px;
+      display: flex;
+      align-items: center;
+      justify-content: center;
+      min-height: 90vh;
+    }
+
+    .error-box {
+      background-color: #1e1e1e;
+      border: 1px solid #d9534f;
+      padding: 24px;
+      border-radius: 8px;
+      max-width: 600px;
+      width: 100%;
+      box-shadow: 0 4px 15px rgba(0, 0, 0, 0.7);
+    }
+
+    .error-box code {
+      background: #2e2e2e;
+      color: #ffd5d5;
+      padding: 2px 6px;
+      border-radius: 4px;
+      font-family: monospace;
+    }
+
+    .error-box a {
+      color: #61dafb;
+      text-decoration: none;
+      font-weight: bold;
+    }
+
+    .error-box a:hover {
+      text-decoration: underline;
+    }
+  </style>
+</head>
+<body>
+  <div class="error-box">
+    <strong style="color: #ff6b6b;">Connection failed:</strong>
+    Proxy does not exist for 
+    <code>${host}</code>.<br/><br/>
+    Please use 
+    <code>npx locadot --host ${host} --port PORT</code><br/><br/>
+    <a href="https://github.com/avinashid/locadot#readme" target="_blank">
+      📘 View on GitHub
+    </a>
+  </div>
+</body>
+</html>
+`;
+exports.proxyNotFound = proxyNotFound;

package/dist/core.js

@@ -3,11 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const locadot_file_1 = __importDefault(require("./lib/locadot-file"));
-const server_1 = __importDefault(require("./server"));
+const proxy_1 = __importDefault(require("./proxy"));
+const logger_1 = __importDefault(require("./utils/logger"));
 async function run() {
-    locadot_file_1.default.updateLogs("🔄 Starting central proxy.");
-    await server_1.default.startCentralProxy();
-    locadot_file_1.default.updateLogs("☑️ Central proxy started.");
+    logger_1.default.info(`🔄 Starting central proxy.`);
+    await proxy_1.default.startCentralProxy();
+    logger_1.default.info("☑️ Central proxy started.");
 }
 run();

package/dist/index.js

@@ -4,56 +4,97 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const yargs_1 = __importDefault(require("yargs"));
-const helpers_1 = require("yargs/helpers");
+const commander_1 = require("commander");
 const commands_1 = __importDefault(require("./lib/commands"));
-const constants_1 = require("./utils/constants");
-async function run() {
-    await (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
-        .scriptName("locadot")
-        .usage("Usage: npx locadot --host local.dev --port 3350")
-        .command("$0", "Run the proxy with a domain and port", (yargs) => {
-        return yargs
-            .option("host", {
-            alias: "h",
-            describe: "Domain to map (must point to 127.0.0.1 in hosts file)",
-            demandOption: true,
-            type: "string",
-        })
-            .option("port", {
-            alias: "p",
-            describe: "Local port to forward to",
-            demandOption: true,
-            type: "number",
-        });
-    }, async (argv) => {
-        await commands_1.default.start(argv);
-    })
-        .command("host", "Show all hosts.", () => {
-        commands_1.default.getRegistry();
-    })
-        .command("watch logs", "Watch log files", () => { }, async (argv) => {
-        commands_1.default.watchLogs();
-    })
-        .command("clear logs", "Clear logs", () => { }, async (argv) => {
-        commands_1.default.clearLogs();
-    })
-        .command("path logs", "Show log path", () => { }, async (argv) => {
-        commands_1.default.logPath();
-    })
-        .command("restart", "Restart locadot", () => { }, async (argv) => {
-        commands_1.default.restart();
-    })
-        .command("stop", "Stop central proxy and logs.", () => { }, async (argv) => {
-        await commands_1.default.stop();
-        console.log(constants_1.errorConstants.proxyClose);
-        process.exit(0);
-    })
-        .command("kill", "Stop central proxy and clear all logs and also port mapping.", () => { }, async (argv) => {
-        await commands_1.default.kill();
-        console.log(constants_1.errorConstants.proxyClose);
-        process.exit(0);
-    })
-        .help().argv;
-}
-run();
+const logger_1 = __importDefault(require("./utils/logger"));
+const package_json_1 = require("../package.json");
+const constants_1 = __importDefault(require("./constants"));
+const program = new commander_1.Command();
+program
+    .name("locadot")
+    .description("Locadot CLI - Local domain proxy manager")
+    .version(package_json_1.version);
+program
+    .command("add")
+    .description("Add a new localhost domain and port")
+    .requiredOption("-h, --host <host>", "Domain to map must be ends with localhost. Example: dev.localhost, localhost, test.localhost, etc.")
+    .requiredOption("-p, --port <port>", "Local port to forward to")
+    .action(async (options) => {
+    await commands_1.default.add(options);
+});
+program
+    .command("update")
+    .requiredOption("-h, --host <host>", "Domain to map must be ends with localhost. Example: dev.localhost, localhost, test.localhost, etc.")
+    .requiredOption("-p, --port <port>", "Local port to forward to")
+    .description("Update a domain")
+    .action(async (options) => await commands_1.default.update(options));
+program
+    .command("remove")
+    .requiredOption("-h, --host <host>", "Host must ends with localhost. Example: dev.localhost, localhost, test.localhost, etc.")
+    .description("Remove a domain")
+    .action(async (options) => await commands_1.default.remove(options));
+program
+    .command("host")
+    .description("Show all hosts")
+    .action(() => {
+    commands_1.default.getRegistry();
+});
+program
+    .command("watch:logs")
+    .description("Watch log files")
+    .action(() => {
+    commands_1.default.watchLogs();
+});
+program
+    .command("clear:logs")
+    .description("Clear logs")
+    .action(() => {
+    commands_1.default.clearLogs();
+});
+program
+    .command("clear:hosts")
+    .description("Clear all host file.")
+    .action(() => {
+    commands_1.default.clearHosts();
+});
+program
+    .command("path")
+    .description("Show configuration paths.")
+    .action(() => {
+    commands_1.default.configPath();
+});
+program
+    .command("path:logs")
+    .description("Show logs path file.")
+    .action(() => {
+    commands_1.default.logPath();
+});
+program
+    .command("path:hosts")
+    .description("Show hosts path file.")
+    .action(() => {
+    commands_1.default.hostPath();
+});
+program
+    .command("restart")
+    .description("Restart locadot")
+    .action(() => {
+    commands_1.default.restart();
+});
+program
+    .command("stop")
+    .description("Stop central proxy and logs")
+    .action(async () => {
+    await commands_1.default.stop();
+    logger_1.default.info(constants_1.default.proxyInfo.softClose);
+    process.exit(0);
+});
+program
+    .command("kill")
+    .description("Stop proxy, clear logs, and hosts file.")
+    .action(async () => {
+    await commands_1.default.kill();
+    logger_1.default.info(constants_1.default.proxyInfo.softClose);
+    process.exit(0);
+});
+program.parse(process.argv);

package/dist/lib/cloudflared.js

@@ -1,95 +1,98 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CloudflaredTunnel = void 0;
-const child_process_1 = __importDefault(require("child_process"));
-const process_1 = __importDefault(require("process"));
-const command_exists_1 = require("command-exists");
-class CloudflaredTunnel {
-    constructor(cloudflaredPath = "cloudflared") {
-        this.childProcess = null;
-        this.running = false;
-        this.cloudflaredPath = cloudflaredPath;
-        this.url = "http://localhost:80";
-        this.hostname = "";
-    }
-    get token() {
-        return this._token;
-    }
-    set token(token) {
-        if (token && typeof token === "string") {
-            token = token.trim();
-            // try to strip out "cloudflared.exe service install"
-            const array = token.split(" ");
-            if (array.length > 1) {
-                for (let i = 0; i < array.length - 1; i++) {
-                    if (array[i] === "install") {
-                        token = array[i + 1];
-                    }
-                }
-            }
-        }
-        this._token = token;
-    }
-    checkInstalled() {
-        return (0, command_exists_1.sync)(this.cloudflaredPath);
-    }
-    emitChange(msg, code) {
-        if (this.change) {
-            this.change(this.running, msg, code);
-        }
-    }
-    emitError(msg) {
-        if (this.error) {
-            this.error(msg);
-        }
-    }
-    start() {
-        if (this.childProcess) {
-            this.emitError("Already started");
-            return;
-        }
-        if (!this.checkInstalled()) {
-            this.emitError(`Cloudflared error: ${this.cloudflaredPath} is not found`);
-            return;
-        }
-        if (!this.token) {
-            this.emitError("Cloudflared error: Token is not set");
-            return;
-        }
-        const args = ["tunnel", "--no-autoupdate", "run", "--token", this.token];
-        this.running = true;
-        this.emitChange("Starting cloudflared");
-        this.childProcess = child_process_1.default.spawn(this.cloudflaredPath, args);
-        this.childProcess.stdout.pipe(process_1.default.stdout);
-        this.childProcess.stderr.pipe(process_1.default.stderr);
-        this.childProcess.on("close", (code) => {
-            this.running = false;
-            this.childProcess = null;
-            this.emitChange("Stopped cloudflared", code);
-        });
-        this.childProcess.on("error", (err) => {
-            if (err.code === "ENOENT") {
-                this.emitError(`Cloudflared error: ${this.cloudflaredPath} is not found`);
-            }
-            else {
-                this.emitError(err);
-            }
-        });
-        this.childProcess.stderr.on("data", (data) => {
-            this.emitError(data.toString());
-        });
-    }
-    stop() {
-        this.emitChange("Stopping cloudflared");
-        if (this.childProcess) {
-            this.childProcess.kill("SIGINT");
-            this.childProcess = null;
-        }
-    }
-}
-exports.CloudflaredTunnel = CloudflaredTunnel;
-const cloudflared = new CloudflaredTunnel();
-exports.default = cloudflared;
+// import childProcess, { ChildProcessWithoutNullStreams } from "child_process";
+// import process from "process";
+// import { sync as commandExistsSync } from "command-exists";
+// type ChangeCallback = (running: boolean, msg: string, code?: number) => void;
+// type ErrorCallback = (msg: string | Error) => void;
+// export class CloudflaredTunnel {
+//   private cloudflaredPath: string;
+//   private _token?: string;
+//   private childProcess: ChildProcessWithoutNullStreams | null = null;
+//   private running = false;
+//   public url: string;
+//   public hostname: string;
+//   public change?: ChangeCallback;
+//   public error?: ErrorCallback;
+//   constructor(cloudflaredPath: string = "cloudflared") {
+//     this.cloudflaredPath = cloudflaredPath;
+//     this.url = "http://localhost:80";
+//     this.hostname = "";
+//   }
+//   get token(): string | undefined {
+//     return this._token;
+//   }
+//   set token(token: string | undefined) {
+//     if (token && typeof token === "string") {
+//       token = token.trim();
+//       // try to strip out "cloudflared.exe service install"
+//       const array = token.split(" ");
+//       if (array.length > 1) {
+//         for (let i = 0; i < array.length - 1; i++) {
+//           if (array[i] === "install") {
+//             token = array[i + 1];
+//           }
+//         }
+//       }
+//     }
+//     this._token = token;
+//   }
+//   checkInstalled(): boolean {
+//     return commandExistsSync(this.cloudflaredPath);
+//   }
+//   private emitChange(msg: string, code?: number): void {
+//     if (this.change) {
+//       this.change(this.running, msg, code);
+//     }
+//   }
+//   private emitError(msg: string | Error): void {
+//     if (this.error) {
+//       this.error(msg);
+//     }
+//   }
+//   start(): void {
+//     if (this.childProcess) {
+//       this.emitError("Already started");
+//       return;
+//     }
+//     if (!this.checkInstalled()) {
+//       this.emitError(`Cloudflared error: ${this.cloudflaredPath} is not found`);
+//       return;
+//     }
+//     if (!this.token) {
+//       this.emitError("Cloudflared error: Token is not set");
+//       return;
+//     }
+//     const args = ["tunnel", "--no-autoupdate", "run", "--token", this.token];
+//     this.running = true;
+//     this.emitChange("Starting cloudflared");
+//     this.childProcess = childProcess.spawn(this.cloudflaredPath, args);
+//     this.childProcess.stdout.pipe(process.stdout);
+//     this.childProcess.stderr.pipe(process.stderr);
+//     this.childProcess.on("close", (code: number) => {
+//       this.running = false;
+//       this.childProcess = null;
+//       this.emitChange("Stopped cloudflared", code);
+//     });
+//     this.childProcess.on("error", (err: NodeJS.ErrnoException) => {
+//       if (err.code === "ENOENT") {
+//         this.emitError(
+//           `Cloudflared error: ${this.cloudflaredPath} is not found`
+//         );
+//       } else {
+//         this.emitError(err);
+//       }
+//     });
+//     this.childProcess.stderr.on("data", (data: Buffer) => {
+//       this.emitError(data.toString());
+//     });
+//   }
+//   stop(): void {
+//     this.emitChange("Stopping cloudflared");
+//     if (this.childProcess) {
+//       this.childProcess.kill("SIGINT");
+//       this.childProcess = null;
+//     }
+//   }
+// }
+// const cloudflared = new CloudflaredTunnel();
+// export default cloudflared;