locadot 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Avinash Kumar
+
+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,20 @@
+# 🔐 locadot
+
+Secure your local development environment with **HTTPS** and **custom domains** like `https://dev.localhost`, powered by `mkcert`.
+
+---
+
+## ✨ Features
+
+- ✅ Automatically generates **trusted local SSL certificates**
+- 🔁 Reverse proxies `https://your.custom.domain` → `app.localhost`
+- 🖥️ Works on **Windows**, **macOS**, and **Linux**
+- 🛠️ OS-specific guidance for host setup
+- ⚠️ Warns and exits if domain isn’t correctly mapped to a local IP
+
+---
+
+## 🚀 Usage
+
+```bash
+npx locadot --host dev.localhost --port 3350

package/dist/certs.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSSL = createSSL;
+const appdata_path_1 = __importDefault(require("appdata-path"));
+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");
+async function createSSL(domain) {
+    console.log(`🔐 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}`);
+        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}`);
+    const ca = await (0, mkcert_1.createCA)({
+        organization: "Locadot",
+        countryCode: "IN",
+        state: "DevState",
+        locality: "DevTown",
+        validity: 365,
+    });
+    const cert = await (0, mkcert_1.createCert)({
+        domains: [domain],
+        ca: ca,
+        validity: 365,
+        organization: "Locadot",
+    });
+    if (!fs_1.default.existsSync(CERT_PATH))
+        fs_1.default.mkdirSync(CERT_PATH, { recursive: true });
+    fs_1.default.writeFileSync(KEY_FILE, cert.key);
+    fs_1.default.writeFileSync(CERT_FILE, cert.cert);
+    return { key: cert.key, cert: cert.cert };
+}

package/dist/index.js

@@ -0,0 +1,88 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidLocalhostDomain = isValidLocalhostDomain;
+exports.isDomainRunning = isDomainRunning;
+const https_1 = __importDefault(require("https"));
+const http_proxy_1 = __importDefault(require("http-proxy"));
+const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
+const certs_1 = require("./certs");
+const utils_1 = require("./utils");
+function isValidLocalhostDomain(domain) {
+    const localhostPattern = /^(?:[a-zA-Z0-9-]+\.)*localhost$/;
+    return localhostPattern.test(domain);
+}
+async function createReverseProxy(targetPort, domain) {
+    const proxy = http_proxy_1.default.createProxyServer({});
+    const { key, cert } = await (0, certs_1.createSSL)(domain);
+    const options = { key, cert };
+    const server = https_1.default.createServer(options, (req, res) => {
+        const host = req.headers.host;
+        if (host !== domain && host !== `${domain}:443`) {
+            res.writeHead(502, { "Content-Type": "text/html" });
+            res.end((0, utils_1.proxyNotFound)(host));
+            return;
+        }
+        proxy.web(req, res, { target: `http://localhost:${targetPort}` }, (err) => {
+            console.error("Proxy error:", err);
+            res.writeHead(502);
+            res.end("Connection failed. Host not found.");
+        });
+    });
+    server.listen(443, () => {
+        console.log(`✅ HTTPS available at https://${domain}`);
+    });
+}
+function isDomainRunning(domain, port = 443) {
+    return new Promise((resolve) => {
+        const req = https_1.default.request({
+            hostname: domain,
+            port,
+            method: "HEAD",
+            rejectUnauthorized: false, // ignore self-signed certs
+            timeout: 1000,
+        }, (res) => {
+            resolve(true);
+            res.destroy();
+        });
+        req.on("error", () => resolve(false));
+        req.on("timeout", () => {
+            req.destroy();
+            resolve(false);
+        });
+        req.end();
+    });
+}
+async function run() {
+    const argv = await (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+        .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",
+    })
+        .usage("Usage: npx local-ssl --host local.dev --port 3350")
+        .help().argv;
+    if (!isValidLocalhostDomain(argv.host)) {
+        console.error("❌ Invalid domain. Please use a valid localhost domain like dev.localhost, localhost, test.localhost, etc.");
+        process.exit(1);
+    }
+    const isRunning = await isDomainRunning(argv.host);
+    if (isRunning) {
+        console.error("❌ Domain already in use. Please choose another domain or stop the existing instance.");
+        process.exit(1);
+    }
+    const domain = argv.host;
+    const port = argv.port;
+    createReverseProxy(port, domain);
+}
+run();

package/dist/utils.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/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "locadot",
+  "version": "1.0.0",
+  "description": "Secure your local development environment with HTTPS and custom domains like https://dev.localhost, powered by mkcert.",
+  "main": "dist/index.js",
+  "bin": {
+    "local-ssl": "./dist/index.js"
+  },
+  "scripts": {
+    "dev": "tsx --watch src/index.ts",
+    "build": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/avinashid/locadot.git"
+  },
+  "keywords": [
+    "locadot",
+    "https",
+    "ssl",
+    "https-proxy",
+    "localhost",
+    "https"
+  ],
+  "author": "avinashid",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/avinashid/locadot/issues"
+  },
+  "homepage": "https://github.com/avinashid/locadot#readme",
+  "dependencies": {
+    "@types/http-proxy": "^1.17.16",
+    "@types/yargs": "^17.0.33",
+    "appdata-path": "^1.0.0",
+    "http-proxy": "^1.18.1",
+    "https": "^1.0.0",
+    "mkcert": "^3.2.0",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.3"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "esModuleInterop": true
+  },
+  "include": ["src"]
+}