@stacksjs/rpx 0.1.1 → 0.2.0

package/README.md

@@ -46,18 +46,14 @@ import { startProxy } from '@stacksjs/rpx'
 export interface ReverseProxyConfig {
   from: string // domain to proxy from, defaults to localhost:3000
   to: string // domain to proxy to, defaults to stacks.localhost
-  https: TlsConfig // use https, defaults to true, also redirects http to https
+  https: boolean | TlsConfig // automatically uses https, defaults to true, also redirects http to https
   verbose: boolean // log verbose output, defaults to false
 }
 
 const config: ReverseProxyOptions = {
   from: 'localhost:3000',
   to: 'my-project.localhost',
-  https: {
-    keyPath: './key.pem',
-    certPath: './cert.pem',
-    caCertPath: './ca.pem',
-  },
+  https: true,
 }
 
 startProxy(config)

package/dist/cli.js

@@ -17,7 +17,7 @@ var __toESM = (mod, isNodeMode, target) => {
 };
 
 // bin/cli.ts
-import os7 from "os";
+import os9 from "os";
 
 // node_modules/@stacksjs/cli/dist/index.js
 import { formatWithOptions } from "util";
@@ -217845,7 +217845,7 @@ var export_mkdirSync = import_fs_extra.mkdirSync;
 var export_fsWatch = import_fs_extra.watch;
 var export_existsSync = import_fs_extra.pathExists;
 // package.json
-var version = "0.1.1";
+var version = "0.2.0";
 
 // src/config.ts
 import os4 from "os";
@@ -217917,8 +217917,14 @@ import * as fs6 from "fs";
 import * as http from "http";
 import * as https from "https";
 import * as net from "net";
+import os8 from "os";
+import path9 from "path";
 import process23 from "process";
 
+// src/https.ts
+import os7 from "os";
+import path8 from "path";
+
 // node_modules/@stacksjs/tlsx/dist/index.js
 import fs22 from "fs";
 import os42 from "os";
@@ -254328,7 +254334,27 @@ var export_pki = import_node_forge2.pki;
 var export_forge = import_node_forge2.default;
 
 // src/https.ts
+var defaultHttpsConfig = {
+  domain: "stacks.localhost",
+  hostCertCN: "stacks.localhost",
+  caCertPath: path8.join(os7.homedir(), ".stacks", "ssl", `stacks.localhost.ca.crt`),
+  certPath: path8.join(os7.homedir(), ".stacks", "ssl", `stacks.localhost.crt`),
+  keyPath: path8.join(os7.homedir(), ".stacks", "ssl", `stacks.localhost.crt.key`),
+  altNameIPs: ["127.0.0.1"],
+  altNameURIs: ["localhost"],
+  organizationName: "stacksjs.org",
+  countryName: "US",
+  stateName: "California",
+  localityName: "Playa Vista",
+  commonName: "stacks.localhost",
+  validityDays: 180,
+  verbose: false
+};
 async function generateCertificate(domain) {
+  if (config6.https === true)
+    config6.https = defaultHttpsConfig;
+  else if (config6.https === false)
+    return;
   domain = domain ?? config6.https.altNameURIs[0];
   log.info(`Generating a self-signed SSL certificate for: ${domain}`);
   const caCert = await createRootCA(config6.https);
@@ -254390,6 +254416,26 @@ process23.on("uncaughtException", (err4) => {
 });
 async function loadSSLConfig(options4) {
   debugLog2("ssl", "Loading SSL configuration", options4.verbose);
+  if (options4.https === true) {
+    options4.https = {
+      domain: "stacks.localhost",
+      hostCertCN: "stacks.localhost",
+      caCertPath: path9.join(os8.homedir(), ".stacks", "ssl", `stacks.localhost.ca.crt`),
+      certPath: path9.join(os8.homedir(), ".stacks", "ssl", `stacks.localhost.crt`),
+      keyPath: path9.join(os8.homedir(), ".stacks", "ssl", `stacks.localhost.crt.key`),
+      altNameIPs: ["127.0.0.1"],
+      altNameURIs: ["localhost"],
+      organizationName: "stacksjs.org",
+      countryName: "US",
+      stateName: "California",
+      localityName: "Playa Vista",
+      commonName: "stacks.localhost",
+      validityDays: 180,
+      verbose: false
+    };
+  } else if (options4.https === false) {
+    return null;
+  }
   if (!options4.https?.keyPath && !options4.https?.certPath) {
     debugLog2("ssl", "No SSL configuration provided", options4.verbose);
     return null;
@@ -254489,10 +254535,14 @@ async function startServer(options4) {
   if (!options4.to)
     options4.to = config6.to;
   if (config6.https) {
+    if (config6.https === true)
+      config6.https = defaultHttpsConfig;
     const domain = config6.https.altNameURIs?.[0] || new URL(options4.to).hostname;
-    options4.keyPath = config6.https.keyPath || `/Users/${process23.env.USER}/.stacks/ssl/${domain}.crt.key`;
-    options4.certPath = config6.https.certPath || `/Users/${process23.env.USER}/.stacks/ssl/${domain}.crt`;
-    debugLog2("server", `HTTPS enabled, using cert paths: ${options4.keyPath}, ${options4.certPath}`, options4.verbose);
+    if (typeof options4.https !== "boolean" && options4.https) {
+      options4.https.keyPath = config6.https.keyPath || path9.join(os8.homedir(), ".stacks", "ssl", `${domain}.crt.key`);
+      options4.https.certPath = config6.https.certPath || path9.join(os8.homedir(), ".stacks", "ssl", `${domain}.crt`);
+      debugLog2("server", `HTTPS enabled, using cert paths: ${options4.https.keyPath}, ${options4.https.certPath}`, options4.verbose);
+    }
   }
   const fromUrl = new URL(options4.from.startsWith("http") ? options4.from : `http://${options4.from}`);
   const toUrl = new URL(options4.to.startsWith("http") ? options4.to : `http://${options4.to}`);
@@ -254673,8 +254723,7 @@ function startProxy(options4) {
   debugLog2("proxy", `Starting proxy with options: ${JSON.stringify({
     from: finalOptions.from,
     to: finalOptions.to,
-    keyPath: finalOptions.https.keyPath,
-    certPath: finalOptions.https.certPath
+    https: finalOptions.https
   })}`, finalOptions.verbose);
   startServer(finalOptions).catch((err4) => {
     debugLog2("proxy", `Failed to start proxy: ${err4}`, finalOptions.verbose);
@@ -254713,7 +254762,7 @@ cli.command("start", "Start the Reverse Proxy Server").option("--from <from>", "
 });
 cli.command("update:etc-hosts", "Update the /etc/hosts file with the proxy domains. Please note, this command requires sudo/admin permissions.").alias("update-etc-hosts").example("sudo reverse-proxy update:etc-hosts").example("sudo reverse-proxy update-etc-hosts").action(async () => {
   log.info("Ensuring /etc/hosts file covers the proxy domain/s...");
-  const hostsFilePath = os7.platform() === "win32" ? "C:\\Windows\\System32\\drivers\\etc\\hosts" : "/etc/hosts";
+  const hostsFilePath = os9.platform() === "win32" ? "C:\\Windows\\System32\\drivers\\etc\\hosts" : "/etc/hosts";
   if (config6 && typeof config6 === "object") {
     const entriesToAdd = Object.entries(config6).map(([from, to]) => `127.0.0.1 ${to} # reverse-proxy mapping for ${from}`);
     entriesToAdd.push("127.0.0.1 localhost # essential localhost mapping");

package/dist/https.d.ts

@@ -1 +1,4 @@
+import type { TlsConfig } from '@stacksjs/tlsx';
+
+export declare const defaultHttpsConfig: TlsConfig;
 export declare function generateCertificate(domain?: string): Promise<void>;

package/dist/index.js

@@ -85,6 +85,8 @@ import * as fs3 from "fs";
 import * as http from "http";
 import * as https from "https";
 import * as net from "net";
+import os7 from "os";
+import path6 from "path";
 import process3 from "process";
 
 // node_modules/@stacksjs/cli/dist/index.js
@@ -20396,7 +20398,11 @@ var quotes = collect([
 ]);
 var export_prompts = import_prompts.default;
 // package.json
-var version = "0.1.1";
+var version = "0.2.0";
+
+// src/https.ts
+import os5 from "os";
+import path4 from "path";
 
 // node_modules/@stacksjs/tlsx/dist/index.js
 import fs2 from "fs";
@@ -56807,7 +56813,27 @@ var export_pki = import_node_forge2.pki;
 var export_forge = import_node_forge2.default;
 
 // src/https.ts
+var defaultHttpsConfig = {
+  domain: "stacks.localhost",
+  hostCertCN: "stacks.localhost",
+  caCertPath: path4.join(os5.homedir(), ".stacks", "ssl", `stacks.localhost.ca.crt`),
+  certPath: path4.join(os5.homedir(), ".stacks", "ssl", `stacks.localhost.crt`),
+  keyPath: path4.join(os5.homedir(), ".stacks", "ssl", `stacks.localhost.crt.key`),
+  altNameIPs: ["127.0.0.1"],
+  altNameURIs: ["localhost"],
+  organizationName: "stacksjs.org",
+  countryName: "US",
+  stateName: "California",
+  localityName: "Playa Vista",
+  commonName: "stacks.localhost",
+  validityDays: 180,
+  verbose: false
+};
 async function generateCertificate(domain) {
+  if (config.https === true)
+    config.https = defaultHttpsConfig;
+  else if (config.https === false)
+    return;
   domain = domain ?? config.https.altNameURIs[0];
   log.info(`Generating a self-signed SSL certificate for: ${domain}`);
   const caCert = await createRootCA(config.https);
@@ -56869,6 +56895,26 @@ process3.on("uncaughtException", (err3) => {
 });
 async function loadSSLConfig(options3) {
   debugLog2("ssl", "Loading SSL configuration", options3.verbose);
+  if (options3.https === true) {
+    options3.https = {
+      domain: "stacks.localhost",
+      hostCertCN: "stacks.localhost",
+      caCertPath: path6.join(os7.homedir(), ".stacks", "ssl", `stacks.localhost.ca.crt`),
+      certPath: path6.join(os7.homedir(), ".stacks", "ssl", `stacks.localhost.crt`),
+      keyPath: path6.join(os7.homedir(), ".stacks", "ssl", `stacks.localhost.crt.key`),
+      altNameIPs: ["127.0.0.1"],
+      altNameURIs: ["localhost"],
+      organizationName: "stacksjs.org",
+      countryName: "US",
+      stateName: "California",
+      localityName: "Playa Vista",
+      commonName: "stacks.localhost",
+      validityDays: 180,
+      verbose: false
+    };
+  } else if (options3.https === false) {
+    return null;
+  }
   if (!options3.https?.keyPath && !options3.https?.certPath) {
     debugLog2("ssl", "No SSL configuration provided", options3.verbose);
     return null;
@@ -56968,10 +57014,14 @@ async function startServer(options3) {
   if (!options3.to)
     options3.to = config.to;
   if (config.https) {
+    if (config.https === true)
+      config.https = defaultHttpsConfig;
     const domain = config.https.altNameURIs?.[0] || new URL(options3.to).hostname;
-    options3.keyPath = config.https.keyPath || `/Users/${process3.env.USER}/.stacks/ssl/${domain}.crt.key`;
-    options3.certPath = config.https.certPath || `/Users/${process3.env.USER}/.stacks/ssl/${domain}.crt`;
-    debugLog2("server", `HTTPS enabled, using cert paths: ${options3.keyPath}, ${options3.certPath}`, options3.verbose);
+    if (typeof options3.https !== "boolean" && options3.https) {
+      options3.https.keyPath = config.https.keyPath || path6.join(os7.homedir(), ".stacks", "ssl", `${domain}.crt.key`);
+      options3.https.certPath = config.https.certPath || path6.join(os7.homedir(), ".stacks", "ssl", `${domain}.crt`);
+      debugLog2("server", `HTTPS enabled, using cert paths: ${options3.https.keyPath}, ${options3.https.certPath}`, options3.verbose);
+    }
   }
   const fromUrl = new URL(options3.from.startsWith("http") ? options3.from : `http://${options3.from}`);
   const toUrl = new URL(options3.to.startsWith("http") ? options3.to : `http://${options3.to}`);
@@ -57152,8 +57202,7 @@ function startProxy(options3) {
   debugLog2("proxy", `Starting proxy with options: ${JSON.stringify({
     from: finalOptions.from,
     to: finalOptions.to,
-    keyPath: finalOptions.https.keyPath,
-    certPath: finalOptions.https.certPath
+    https: finalOptions.https
   })}`, finalOptions.verbose);
   startServer(finalOptions).catch((err3) => {
     debugLog2("proxy", `Failed to start proxy: ${err3}`, finalOptions.verbose);
@@ -57184,5 +57233,6 @@ export {
   startProxies,
   startHttpRedirectServer,
   setupReverseProxy,
-  config
+  config,
+  cleanup
 };

package/dist/start.d.ts

@@ -1,7 +1,7 @@
 import type { ProxySetupOptions, ReverseProxyOption, ReverseProxyOptions, SSLConfig } from './types';
 
 declare const activeServers: Set<http.Server | https.Server>;
-declare function cleanup(): void;
+export declare function cleanup(): void;
 declare function loadSSLConfig(options: ReverseProxyOption): Promise<SSLConfig | null>;
 declare function isPortInUse(port: number, hostname: string, verbose?: boolean): Promise<boolean>;
 declare function findAvailablePort(startPort: number, hostname: string, verbose?: boolean): Promise<number>;

package/dist/types.d.ts

@@ -4,7 +4,7 @@ export type { TlsConfig };
 export declare interface ReverseProxyConfig {
   from: string 
   to: string 
-  https: TlsConfig
+  https: boolean | TlsConfig
   verbose: boolean
 }
 export declare type ReverseProxyOption = Partial<ReverseProxyConfig>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/rpx",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "A modern reverse proxy.",
   "author": "Chris Breuer <chris@stacksjs.org>",
   "license": "MIT",