@dataramen/cli 0.0.3 → 0.0.4

package/bin/run.js

@@ -11,6 +11,9 @@ const processName = "@dataramen/local-server";
 const homeDir = os.homedir();
 const filesPath = path.join(homeDir, ".dataramen", ".runtime", "server");
 
+const scriptPkg = fs.readJsonSync(path.join(__dirname, "..", "package.json"));
+const protocol = "dataramen://";
+
 yargs()
   .command("start", 'Default command, start/restart the server', () => {
     const hasPm2 = checkPm2();
@@ -30,7 +33,26 @@ yargs()
       stdio: "inherit",
     })
   })
-  .parse(yargsHelpers.hideBin(process.argv));
+  .command("unregister", "Unregister custom protocol handler", () => {
+    if (os.platform() === "win32") {
+      require(path.join(__dirname, "..", "dist", "code", "register.windows.js")).unregister();
+    }
+  })
+  .parse(isBrowserStart() ? getBrowserArgs() : yargsHelpers.hideBin(process.argv));
+
+function isInstallation () {
+  return scriptPkg.name === "@dataramen/cli";
+}
+
+function isBrowserStart () {
+  return !!process.argv[2]?.startsWith(protocol);
+}
+
+function getBrowserArgs () {
+  const str = (process.argv[2] || '').replace(protocol, ''); // remove protocol
+  console.log("Browser args", str.split("/"));
+  return str.split("/");
+}
 
 function checkPm2 () {
   try {
@@ -58,6 +80,18 @@ function stopExisting () {
   } catch (e) {}
 }
 
+function registerServer () {
+  try {
+    if (os.platform() === "win32") {
+      require(path.join(__dirname, "..", "dist", "code", "register.windows.js")).register();
+    }
+
+    console.log("Custom protocol handler registered");
+  } catch (e) {
+    console.log("Failed to register server", e);
+  }
+}
+
 function installServer () {
   console.log("Installing Server");
   // copy code
@@ -67,24 +101,32 @@ function installServer () {
   // copy package.json
   fs.copySync(path.join(__dirname, '..', 'dist', "package.json"), path.join(filesPath, "package.json"));
 
-  execSync(`npm i --omit=dev`, {
+  execSync(`npm i`, {
     stdio: "inherit",
     cwd: filesPath,
   });
   console.log("Server installed");
+
+  registerServer();
 }
 
 function start () {
   stopExisting();
 
   try {
-    installServer();
+    if (isInstallation()) {
+      // only install if script is running from @dataramen/cli package
+      // if not, it means it was already installed, and the script is running from within the server folder
+      installServer();
+    }
+
     console.log("Starting local server");
-    const pkg = fs.readJsonSync(path.join(filesPath, "package.json"));
-    execSync(`pm2 start "${pkg.main}" --name "${processName}" --no-autorestart`, {
+    const appPkg = fs.readJsonSync(path.join(filesPath, "package.json"));
+    execSync(`pm2 start "${appPkg.main}" --name "${processName}" --no-autorestart`, {
       stdio: "inherit",
       cwd: filesPath,
     });
+
     console.log(`Local server will be available in a couple of seconds`);
     console.log(`You can close this window`);
   } catch (e) {

package/dist/code/cli.js

@@ -0,0 +1,135 @@
+#!/usr/bin/env node
+const { execSync } = require("node:child_process");
+const path = require("node:path");
+const yargs = require("yargs");
+const yargsHelpers = require("yargs/helpers");
+const os = require('node:os');
+const fs = require("fs-extra");
+
+const processName = "@dataramen/local-server";
+
+const homeDir = os.homedir();
+const filesPath = path.join(homeDir, ".dataramen", ".runtime", "server");
+
+const scriptPkg = fs.readJsonSync(path.join(__dirname, "..", "package.json"));
+const protocol = "dataramen://";
+
+yargs()
+  .command("start", 'Default command, start/restart the server', () => {
+    const hasPm2 = checkPm2();
+    if (!hasPm2) {
+      installPm2();
+    }
+
+    start();
+  })
+  .command("logs", 'Listen for logs', () => {
+    execSync(`pm2 logs ${processName}`, {
+      stdio: "inherit",
+    });
+  })
+  .command("stop", 'Stop the server', () => {
+    execSync(`pm2 stop ${processName}`, {
+      stdio: "inherit",
+    })
+  })
+  .command("unregister", "Unregister custom protocol handler", () => {
+    if (os.platform() === "win32") {
+      require(path.join(__dirname, "..", "dist", "code", "register.windows.js")).unregister();
+    }
+  })
+  .parse(isBrowserStart() ? getBrowserArgs() : yargsHelpers.hideBin(process.argv));
+
+function isInstallation () {
+  return scriptPkg.name === "@dataramen/cli";
+}
+
+function isBrowserStart () {
+  return !!process.argv[2]?.startsWith(protocol);
+}
+
+function getBrowserArgs () {
+  const str = (process.argv[2] || '').replace(protocol, ''); // remove protocol
+  console.log("Browser args", str.split("/"));
+  return str.split("/");
+}
+
+function checkPm2 () {
+  try {
+    execSync(`pm2 -v`, {
+      stdio: "inherit"
+    });
+
+    return true;
+  } catch (e) {
+    console.error("Library does not exist");
+    return false;
+  }
+}
+
+function installPm2 () {
+  console.log("Install Pm2");
+  execSync(`npm i -g pm2`, {
+    stdio: "inherit"
+  });
+}
+
+function stopExisting () {
+  try {
+    execSync(`pm2 stop "${processName}"`);
+  } catch (e) {}
+}
+
+function registerServer () {
+  try {
+    if (os.platform() === "win32") {
+      require(path.join(__dirname, "..", "dist", "code", "register.windows.js")).register();
+    }
+
+    console.log("Custom protocol handler registered");
+  } catch (e) {
+    console.log("Failed to register server", e);
+  }
+}
+
+function installServer () {
+  console.log("Installing Server");
+  // copy code
+  fs.copySync(path.join(__dirname, '..', 'dist', "code"), path.join(filesPath, "code"));
+  // copy default env (do not override existing .env)
+  fs.copySync(path.join(__dirname, '..', 'dist', "env", ".env.default"), path.join(filesPath, "env", ".env.default"));
+  // copy package.json
+  fs.copySync(path.join(__dirname, '..', 'dist', "package.json"), path.join(filesPath, "package.json"));
+
+  execSync(`npm i`, {
+    stdio: "inherit",
+    cwd: filesPath,
+  });
+  console.log("Server installed");
+
+  registerServer();
+}
+
+function start () {
+  stopExisting();
+
+  try {
+    if (isInstallation()) {
+      // only install if script is running from @dataramen/cli package
+      // if not, it means it was already installed, and the script is running from within the server folder
+      installServer();
+    }
+
+    console.log("Starting local server");
+    const appPkg = fs.readJsonSync(path.join(filesPath, "package.json"));
+    execSync(`pm2 start "${appPkg.main}" --name "${processName}" --no-autorestart`, {
+      stdio: "inherit",
+      cwd: filesPath,
+    });
+
+    console.log(`Local server will be available in a couple of seconds`);
+    console.log(`You can close this window`);
+  } catch (e) {
+    console.error(`Failed to start local server`, e);
+  }
+}

package/dist/code/register.windows.js

@@ -0,0 +1,44 @@
+const os = require("node:os");
+const path = require("node:path");
+const { execSync } = require("node:child_process");
+
+const homeDir = os.homedir();
+const filesPath = path.join(homeDir, ".dataramen", ".runtime", "server");
+const scriptPath = path.join(filesPath, "code", "cli.js");
+
+const protocol = "dataramen";
+
+function register () {
+  // Registry command (uses reg.exe)
+  const regCommands = [
+    `reg add "HKCU\\Software\\Classes\\${protocol}" /ve /d "Data Ramen" /f`,
+    `reg add "HKCU\\Software\\Classes\\${protocol}" /v "URL Protocol" /d "" /f`,
+    `reg add "HKCU\\Software\\Classes\\${protocol}\\shell\\open\\command" /ve /d "\\"C:\\\\Windows\\\\System32\\\\cmd.exe\\" /c node \\"${scriptPath}\\" \\"%1\\"" /f`
+  ];
+
+  try {
+    for (const cmd of regCommands) {
+      execSync(cmd, { stdio: "inherit" });
+    }
+    console.log(`Custom protocol '${protocol}://' registered to run: node ${scriptPath}`);
+  } catch (err) {
+    console.error("Failed to register protocol. Try running this script as Administrator.");
+    console.error(err.message);
+  }
+}
+
+function unregister () {
+  try {
+    // Delete the custom protocol registry key
+    execSync(`reg delete "HKCU\\Software\\Classes\\${protocol}" /f`, { stdio: "inherit" });
+    console.log(`Protocol '${protocol}://' successfully unregistered.`);
+  } catch (err) {
+    console.error(`Failed to unregister protocol '${protocol}://'. Try running as Administrator if needed.`);
+    console.error(err.message);
+  }
+}
+
+module.exports = {
+  register,
+  unregister,
+};

package/dist/package.json

@@ -1 +1 @@
-{"name":"@odemian/sql-local-server-proxy","version":"0.0.30","license":"MIT","main":"code/proxy.js","dependencies":{"@fastify/cors":"^11.0.1","dotenv":"^16.5.0","fast-glob":"^3.3.3","fastify":"^5.3.2","mysql2":"^3.14.1","pg":"^8.15.6","sqlite3":"^5.1.7","typeorm":"^0.3.23"}}
+{"name":"@dataramen/local-server","version":"0.0.30","license":"MIT","main":"code/proxy.js","dependencies":{"@fastify/cors":"^11.0.1","dotenv":"^16.5.0","fast-glob":"^3.3.3","fastify":"^5.3.2","mysql2":"^3.14.1","pg":"^8.15.6","sqlite3":"^5.1.7","typeorm":"^0.3.23"},"devDependencies":{"yargs":"^18.0.0","fs-extra":"^11.3.0"}}

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@dataramen/cli",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "license": "MIT",
-  "main": "dist/index.js",
   "bin": {
     "dataramen-cli": "bin/run.js"
   },