supatypes 1.0.2 → 1.0.3

package/README.md

@@ -40,6 +40,7 @@ Running `init` creates a `.supatypes.json` file:
 ```json
 {
   "server": "root@1.2.3.4",
+  "sshPort": 2222,
   "sshKey": "~/.ssh/id_rsa",
   "dbContainer": "supabase-db-abc123",
   "output": "./database.types.ts"
@@ -51,6 +52,7 @@ Running `init` creates a `.supatypes.json` file:
 | Field | Required | Description |
 |-------|----------|-------------|
 | `server` | Yes | SSH connection string (e.g. `root@1.2.3.4`) |
+| `sshPort` | No | SSH port (default: `22`) |
 | `sshKey` | One of these | Path to SSH private key |
 | `sshPassword` | One of these | SSH password (uses `sshpass`) |
 | `dbContainer` | Yes | Docker container name for the Supabase PostgreSQL instance |

package/bin/cli.js

@@ -20,6 +20,7 @@ Options (generate):
 Config file (.supatypes.json):
   {
     "server": "root@1.2.3.4",
+    "sshPort": 2222,
     "sshKey": "~/.ssh/id_rsa",
     "dbContainer": "supabase-db-abc123",
     "output": "./database.types.ts"
@@ -28,6 +29,7 @@ Config file (.supatypes.json):
   You can also use a password instead of an SSH key:
   {
     "server": "root@1.2.3.4",
+    "sshPort": 2222,
     "sshPassword": "your-password",
     "dbContainer": "supabase-db-abc123",
     "output": "./database.types.ts"

package/lib/generate.js

@@ -1,167 +1,169 @@
-import fs from "node:fs";
-import path from "node:path";
-import { execFileSync } from "node:child_process";
-import { fileURLToPath } from "node:url";
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const REMOTE_SCRIPT = path.join(__dirname, "remote-generator.js");
-const REMOTE_DIR = "/tmp/supatypes";
-const REMOTE_SCRIPT_PATH = `${REMOTE_DIR}/generator.js`;
-const REMOTE_OUTPUT_PATH = `${REMOTE_DIR}/output.ts`;
-
-export async function generate({ configPath, outputOverride, dryRun }) {
-  // Load config
-  const resolvedConfig = path.resolve(configPath);
-  if (!fs.existsSync(resolvedConfig)) {
-    console.error(`Config file not found: ${resolvedConfig}`);
-    console.error('Run "npx supatypes init" to create one.');
-    process.exit(1);
-  }
-
-  const config = JSON.parse(fs.readFileSync(resolvedConfig, "utf8"));
-  const { server, dbContainer } = config;
-  const sshKey = config.sshKey ? expandHome(config.sshKey) : null;
-  const sshPassword = config.sshPassword || null;
-  const output = path.resolve(outputOverride || config.output || "./database.types.ts");
-
-  // Validate
-  if (!server) { console.error("Missing 'server' in config"); process.exit(1); }
-  if (!dbContainer) { console.error("Missing 'dbContainer' in config"); process.exit(1); }
-
-  if (sshKey && !fs.existsSync(sshKey)) {
-    console.error(`SSH key not found: ${sshKey}`);
-    process.exit(1);
-  }
-
-  const sshBase = buildSshBase(server, sshKey, sshPassword);
-  const scpBase = buildScpBase(server, sshKey, sshPassword);
-
-  if (dryRun) {
-    console.log("Dry run — would execute:");
-    console.log(`  1. Create ${REMOTE_DIR} on ${server}`);
-    console.log(`  2. Upload generator script to ${REMOTE_SCRIPT_PATH}`);
-    console.log(`  3. Run: node ${REMOTE_SCRIPT_PATH} ${dbContainer} ${REMOTE_OUTPUT_PATH}`);
-    console.log(`  4. Download ${REMOTE_OUTPUT_PATH} to ${output}`);
-    console.log(`  5. Clean up ${REMOTE_DIR} on server`);
-    return;
-  }
-
-  console.log("supatypes\n");
-  console.log(`  Server:    ${server}`);
-  console.log(`  Container: ${dbContainer}`);
-  console.log(`  Output:    ${output}`);
-  console.log(`  Auth:      ${sshKey ? "SSH key" : "password"}\n`);
-
-  try {
-    // Step 1: Create remote directory
-    process.stdout.write("Creating remote workspace...");
-    ssh(sshBase, `mkdir -p ${REMOTE_DIR}`);
-    console.log(" done");
-
-    // Step 2: Upload generator script
-    process.stdout.write("Uploading generator...");
-    scp(scpBase, REMOTE_SCRIPT, `${server}:${REMOTE_SCRIPT_PATH}`);
-    console.log(" done");
-
-    // Step 3: Run generator on server
-    process.stdout.write("Generating types...");
-    const remoteOutput = ssh(
-      sshBase,
-      `cd ${REMOTE_DIR} && node generator.js ${dbContainer} ${REMOTE_OUTPUT_PATH}`
-    );
-    console.log(" done");
-
-    // Parse stats from output
-    const statsMatch = remoteOutput.match(/__STATS__(.+)/);
-    if (statsMatch) {
-      const stats = JSON.parse(statsMatch[1]);
-      console.log(`\n  Tables:    ${stats.tables}`);
-      console.log(`  Views:     ${stats.views}`);
-      console.log(`  Functions: ${stats.functions}`);
-    }
-
-    // Step 4: Download result
-    process.stdout.write("\nDownloading types...");
-    const outputDir = path.dirname(output);
-    if (!fs.existsSync(outputDir)) {
-      fs.mkdirSync(outputDir, { recursive: true });
-    }
-    scp(scpBase, `${server}:${REMOTE_OUTPUT_PATH}`, output);
-    console.log(" done");
-
-    // Step 5: Clean up
-    process.stdout.write("Cleaning up remote files...");
-    ssh(sshBase, `rm -rf ${REMOTE_DIR}`);
-    console.log(" done");
-
-    const fileSize = fs.statSync(output).size;
-    console.log(`\nTypes saved to ${output} (${formatBytes(fileSize)})`);
-  } catch (err) {
-    console.error(`\n\nFailed: ${err.message}`);
-
-    // Try to clean up even on failure
-    try {
-      ssh(sshBase, `rm -rf ${REMOTE_DIR}`);
-    } catch {
-      // ignore cleanup errors
-    }
-
-    process.exit(1);
-  }
-}
-
-function expandHome(p) {
-  if (p.startsWith("~/")) {
-    return path.join(process.env.HOME || process.env.USERPROFILE || "", p.slice(2));
-  }
-  return p;
-}
-
-function buildSshBase(server, sshKey, sshPassword) {
-  const opts = ["-o", "StrictHostKeyChecking=accept-new", "-o", "ConnectTimeout=10"];
-
-  if (sshPassword) {
-    // Use sshpass for password-based auth
-    return ["sshpass", "-p", sshPassword, "ssh", ...opts, server];
-  }
-
-  if (sshKey) {
-    return ["ssh", "-i", sshKey, ...opts, server];
-  }
-
-  // Default: let SSH use its default key
-  return ["ssh", ...opts, server];
-}
-
-function buildScpBase(server, sshKey, sshPassword) {
-  const opts = ["-o", "StrictHostKeyChecking=accept-new", "-o", "ConnectTimeout=10"];
-
-  if (sshPassword) {
-    return ["sshpass", "-p", sshPassword, "scp", ...opts];
-  }
-
-  if (sshKey) {
-    return ["scp", "-i", sshKey, ...opts];
-  }
-
-  return ["scp", ...opts];
-}
-
-function ssh(base, command) {
-  const [bin, ...args] = base;
-  return execFileSync(bin, [...args, command], {
-    encoding: "utf8",
-    maxBuffer: 50 * 1024 * 1024,
-  });
-}
-
-function scp(base, src, dest) {
-  const [bin, ...args] = base;
-  execFileSync(bin, [...args, src, dest], { encoding: "utf8" });
-}
-
-function formatBytes(bytes) {
-  if (bytes < 1024) return `${bytes} B`;
-  if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
-  return `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
-}
+import fs from "node:fs";
+import path from "node:path";
+import { execFileSync } from "node:child_process";
+import { fileURLToPath } from "node:url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const REMOTE_SCRIPT = path.join(__dirname, "remote-generator.js");
+const REMOTE_DIR = "/tmp/supatypes";
+const REMOTE_SCRIPT_PATH = `${REMOTE_DIR}/generator.js`;
+const REMOTE_OUTPUT_PATH = `${REMOTE_DIR}/output.ts`;
+
+export async function generate({ configPath, outputOverride, dryRun }) {
+  // Load config
+  const resolvedConfig = path.resolve(configPath);
+  if (!fs.existsSync(resolvedConfig)) {
+    console.error(`Config file not found: ${resolvedConfig}`);
+    console.error('Run "npx supatypes init" to create one.');
+    process.exit(1);
+  }
+
+  const config = JSON.parse(fs.readFileSync(resolvedConfig, "utf8"));
+  const { server, dbContainer } = config;
+  const sshPort = config.sshPort || 22;
+  const sshKey = config.sshKey ? expandHome(config.sshKey) : null;
+  const sshPassword = config.sshPassword || null;
+  const output = path.resolve(outputOverride || config.output || "./database.types.ts");
+
+  // Validate
+  if (!server) { console.error("Missing 'server' in config"); process.exit(1); }
+  if (!dbContainer) { console.error("Missing 'dbContainer' in config"); process.exit(1); }
+
+  if (sshKey && !fs.existsSync(sshKey)) {
+    console.error(`SSH key not found: ${sshKey}`);
+    process.exit(1);
+  }
+
+  const sshBase = buildSshBase(server, sshPort, sshKey, sshPassword);
+  const scpBase = buildScpBase(server, sshPort, sshKey, sshPassword);
+
+  if (dryRun) {
+    console.log("Dry run — would execute:");
+    console.log(`  1. Create ${REMOTE_DIR} on ${server}`);
+    console.log(`  2. Upload generator script to ${REMOTE_SCRIPT_PATH}`);
+    console.log(`  3. Run: node ${REMOTE_SCRIPT_PATH} ${dbContainer} ${REMOTE_OUTPUT_PATH}`);
+    console.log(`  4. Download ${REMOTE_OUTPUT_PATH} to ${output}`);
+    console.log(`  5. Clean up ${REMOTE_DIR} on server`);
+    return;
+  }
+
+  console.log("supatypes\n");
+  console.log(`  Server:    ${server}`);
+  console.log(`  Port:      ${sshPort}`);
+  console.log(`  Container: ${dbContainer}`);
+  console.log(`  Output:    ${output}`);
+  console.log(`  Auth:      ${sshKey ? "SSH key" : "password"}\n`);
+
+  try {
+    // Step 1: Create remote directory
+    process.stdout.write("Creating remote workspace...");
+    ssh(sshBase, `mkdir -p ${REMOTE_DIR}`);
+    console.log(" done");
+
+    // Step 2: Upload generator script
+    process.stdout.write("Uploading generator...");
+    scp(scpBase, REMOTE_SCRIPT, `${server}:${REMOTE_SCRIPT_PATH}`);
+    console.log(" done");
+
+    // Step 3: Run generator on server
+    process.stdout.write("Generating types...");
+    const remoteOutput = ssh(
+      sshBase,
+      `cd ${REMOTE_DIR} && node generator.js ${dbContainer} ${REMOTE_OUTPUT_PATH}`
+    );
+    console.log(" done");
+
+    // Parse stats from output
+    const statsMatch = remoteOutput.match(/__STATS__(.+)/);
+    if (statsMatch) {
+      const stats = JSON.parse(statsMatch[1]);
+      console.log(`\n  Tables:    ${stats.tables}`);
+      console.log(`  Views:     ${stats.views}`);
+      console.log(`  Functions: ${stats.functions}`);
+    }
+
+    // Step 4: Download result
+    process.stdout.write("\nDownloading types...");
+    const outputDir = path.dirname(output);
+    if (!fs.existsSync(outputDir)) {
+      fs.mkdirSync(outputDir, { recursive: true });
+    }
+    scp(scpBase, `${server}:${REMOTE_OUTPUT_PATH}`, output);
+    console.log(" done");
+
+    // Step 5: Clean up
+    process.stdout.write("Cleaning up remote files...");
+    ssh(sshBase, `rm -rf ${REMOTE_DIR}`);
+    console.log(" done");
+
+    const fileSize = fs.statSync(output).size;
+    console.log(`\nTypes saved to ${output} (${formatBytes(fileSize)})`);
+  } catch (err) {
+    console.error(`\n\nFailed: ${err.message}`);
+
+    // Try to clean up even on failure
+    try {
+      ssh(sshBase, `rm -rf ${REMOTE_DIR}`);
+    } catch {
+      // ignore cleanup errors
+    }
+
+    process.exit(1);
+  }
+}
+
+function expandHome(p) {
+  if (p.startsWith("~/")) {
+    return path.join(process.env.HOME || process.env.USERPROFILE || "", p.slice(2));
+  }
+  return p;
+}
+
+function buildSshBase(server, port, sshKey, sshPassword) {
+  const opts = ["-p", String(port), "-o", "StrictHostKeyChecking=accept-new", "-o", "ConnectTimeout=10"];
+
+  if (sshPassword) {
+    // Use sshpass for password-based auth
+    return ["sshpass", "-p", sshPassword, "ssh", ...opts, server];
+  }
+
+  if (sshKey) {
+    return ["ssh", "-i", sshKey, ...opts, server];
+  }
+
+  // Default: let SSH use its default key
+  return ["ssh", ...opts, server];
+}
+
+function buildScpBase(server, port, sshKey, sshPassword) {
+  const opts = ["-P", String(port), "-o", "StrictHostKeyChecking=accept-new", "-o", "ConnectTimeout=10"];
+
+  if (sshPassword) {
+    return ["sshpass", "-p", sshPassword, "scp", ...opts];
+  }
+
+  if (sshKey) {
+    return ["scp", "-i", sshKey, ...opts];
+  }
+
+  return ["scp", ...opts];
+}
+
+function ssh(base, command) {
+  const [bin, ...args] = base;
+  return execFileSync(bin, [...args, command], {
+    encoding: "utf8",
+    maxBuffer: 50 * 1024 * 1024,
+  });
+}
+
+function scp(base, src, dest) {
+  const [bin, ...args] = base;
+  execFileSync(bin, [...args, src, dest], { encoding: "utf8" });
+}
+
+function formatBytes(bytes) {
+  if (bytes < 1024) return `${bytes} B`;
+  if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
+  return `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
+}

package/lib/init.js

@@ -33,6 +33,7 @@ export async function init() {
 
   const sshUser = await ask(rl, "SSH username", "root");
   const sshHost = await ask(rl, "SSH server host (e.g. 1.2.3.4)", "");
+  const sshPort = await ask(rl, "SSH port", "22");
   const server = `${sshUser}@${sshHost}`;
   const authMethod = await ask(rl, "Auth method: key or password?", "key");
 
@@ -52,6 +53,8 @@ export async function init() {
 
   const config = { server, dbContainer, output };
 
+  const parsedPort = parseInt(sshPort, 10);
+  if (parsedPort !== 22) config.sshPort = parsedPort;
   if (sshKey) config.sshKey = sshKey;
   if (sshPassword) config.sshPassword = sshPassword;
 

package/package.json

@@ -1,27 +1,27 @@
-{
-  "name": "supatypes",
-  "version": "1.0.2",
-  "description": "Generate TypeScript types from a remote Supabase PostgreSQL database via SSH",
-  "license": "MIT",
-  "author": "MadStoneDev",
-  "type": "module",
-  "bin": {
-    "supatypes": "bin/cli.js"
-  },
-  "files": [
-    "bin/",
-    "lib/",
-    "README.md"
-  ],
-  "keywords": [
-    "supabase",
-    "typescript",
-    "types",
-    "codegen",
-    "postgresql",
-    "database"
-  ],
-  "engines": {
-    "node": ">=18"
-  }
-}
+{
+  "name": "supatypes",
+  "version": "1.0.3",
+  "description": "Generate TypeScript types from a remote Supabase PostgreSQL database via SSH",
+  "license": "MIT",
+  "author": "MadStoneDev",
+  "type": "module",
+  "bin": {
+    "supatypes": "bin/cli.js"
+  },
+  "files": [
+    "bin/",
+    "lib/",
+    "README.md"
+  ],
+  "keywords": [
+    "supabase",
+    "typescript",
+    "types",
+    "codegen",
+    "postgresql",
+    "database"
+  ],
+  "engines": {
+    "node": ">=18"
+  }
+}