@infodb/revx 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 tamuto
+
+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,376 @@
+# @infodb/revx
+
+Reverse proxy CLI tool with YAML configuration. Built with Express and http-proxy-middleware.
+
+## Features
+
+- YAML-based configuration
+- Simple reverse proxy setup
+- **Automatic route sorting** - Routes are automatically sorted by specificity (longest paths first)
+- Load balancing (Round-robin, Random, IP-hash)
+- WebSocket support
+- Request/Response header transformation
+- CORS configuration
+- SSL/TLS support
+- Health checks
+- Request ID tracking
+- Environment variable expansion
+
+## Installation
+
+```bash
+npm install -g @infodb/revx
+# or
+pnpm add -g @infodb/revx
+# or
+npx @infodb/revx
+```
+
+## Quick Start
+
+1. Create a configuration file:
+
+```bash
+revx init
+```
+
+This creates a `revx.yaml` file with example configuration.
+
+2. Edit `revx.yaml` to configure your routes:
+
+```yaml
+server:
+  port: 3000
+
+routes:
+  - path: "/api/*"
+    target: "http://localhost:4000"
+    pathRewrite:
+      "^/api": ""
+```
+
+3. Start the proxy server:
+
+```bash
+revx start
+```
+
+## Commands
+
+### `revx start [config-file]`
+
+Start the reverse proxy server.
+
+```bash
+# Use default config file (revx.yaml)
+revx start
+
+# Use custom config file
+revx start my-proxy.yaml
+
+# Verbose output
+revx start --verbose
+```
+
+### `revx validate <config-file>`
+
+Validate configuration file.
+
+```bash
+revx validate revx.yaml
+
+# Show detailed validation info
+revx validate revx.yaml --verbose
+```
+
+### `revx init`
+
+Create a sample configuration file.
+
+```bash
+# Create default configuration
+revx init
+
+# Create simple configuration
+revx init --simple
+
+# Specify output file
+revx init --output my-config.yaml
+```
+
+## Configuration
+
+### Basic Configuration
+
+```yaml
+server:
+  port: 3000
+  host: 0.0.0.0
+  name: "My Reverse Proxy"
+
+routes:
+  - path: "/api/*"
+    target: "http://localhost:4000"
+    pathRewrite:
+      "^/api": ""
+```
+
+### Global Settings
+
+```yaml
+global:
+  timeout: 30000
+
+  cors:
+    enabled: true
+    origin: "*"
+    methods: ["GET", "POST", "PUT", "DELETE", "OPTIONS"]
+    credentials: true
+
+  logging:
+    enabled: true
+    format: "combined"  # combined | dev | common | short | tiny
+    level: "info"       # error | warn | info | debug
+```
+
+### Route Configuration
+
+**Important:** Routes are automatically sorted by specificity when loaded. You don't need to worry about the order in your YAML file - the most specific routes (longest paths) will always be matched first.
+
+For example:
+```yaml
+routes:
+  # These will be automatically reordered
+  - path: "/"                    # Will match last
+    target: "http://static"
+
+  - path: "/api/v1/users/*"      # Will match first (most specific)
+    target: "http://users-api"
+
+  - path: "/api/*"               # Will match after /api/v1/users/*
+    target: "http://api"
+```
+
+The automatic sorting order:
+1. Longest paths first
+2. Paths with fewer wildcards (more specific)
+3. Alphabetical order for equal paths
+
+#### Simple Proxy
+
+```yaml
+routes:
+  - path: "/api/*"
+    target: "http://api.example.com"
+    changeOrigin: true
+    pathRewrite:
+      "^/api": ""
+```
+
+#### Load Balancing
+
+```yaml
+routes:
+  - path: "/balanced/*"
+    targets:
+      - "http://server1.example.com"
+      - "http://server2.example.com"
+      - "http://server3.example.com"
+    strategy: "round-robin"  # round-robin | random | ip-hash
+    pathRewrite:
+      "^/balanced": ""
+```
+
+#### WebSocket Proxy
+
+```yaml
+routes:
+  - path: "/ws"
+    target: "ws://websocket.example.com"
+    ws: true
+    changeOrigin: true
+```
+
+#### Header Transformation
+
+```yaml
+routes:
+  - path: "/transform/*"
+    target: "http://backend.example.com"
+    transform:
+      request:
+        headers:
+          add:
+            X-API-Version: "v2"
+            X-Custom-Header: "value"
+          remove:
+            - "Cookie"
+      response:
+        headers:
+          add:
+            X-Proxy-Server: "revx"
+          remove:
+            - "Server"
+```
+
+#### Custom Options
+
+```yaml
+routes:
+  - path: "/api/*"
+    target: "http://api.example.com"
+    options:
+      timeout: 5000
+      followRedirects: true
+      headers:
+        X-Forwarded-Host: "${HOST}"
+```
+
+### Middleware
+
+```yaml
+middleware:
+  - type: "requestId"
+    enabled: true
+    headerName: "X-Request-ID"
+
+  - type: "compression"
+    enabled: true
+    threshold: 1024
+```
+
+### SSL/TLS
+
+```yaml
+ssl:
+  enabled: true
+  key: "/path/to/private.key"
+  cert: "/path/to/certificate.crt"
+  ca: "/path/to/ca.crt"  # Optional
+```
+
+### Environment Variables
+
+Use `${VARIABLE_NAME}` syntax to reference environment variables:
+
+```yaml
+server:
+  port: ${PORT}
+
+routes:
+  - path: "/api/*"
+    target: "${API_URL}"
+    options:
+      headers:
+        Authorization: "Bearer ${API_TOKEN}"
+```
+
+Then run:
+
+```bash
+PORT=3000 API_URL=http://api.example.com API_TOKEN=secret revx start
+```
+
+## Examples
+
+### Microservices Gateway
+
+```yaml
+server:
+  port: 8080
+  name: "Microservices Gateway"
+
+routes:
+  - path: "/users/*"
+    target: "http://user-service:3001"
+    pathRewrite:
+      "^/users": ""
+
+  - path: "/products/*"
+    target: "http://product-service:3002"
+    pathRewrite:
+      "^/products": ""
+
+  - path: "/orders/*"
+    target: "http://order-service:3003"
+    pathRewrite:
+      "^/orders": ""
+```
+
+### Development Proxy
+
+```yaml
+server:
+  port: 3000
+
+global:
+  cors:
+    enabled: true
+    origin: "http://localhost:5173"
+
+routes:
+  - path: "/api/*"
+    target: "http://localhost:4000"
+    pathRewrite:
+      "^/api": ""
+
+  - path: "/ws"
+    target: "ws://localhost:4000"
+    ws: true
+```
+
+### Production Load Balancer
+
+```yaml
+server:
+  port: 443
+  name: "Production Load Balancer"
+
+ssl:
+  enabled: true
+  key: "/etc/ssl/private/server.key"
+  cert: "/etc/ssl/certs/server.crt"
+
+routes:
+  - path: "/*"
+    targets:
+      - "http://app-server-1:8080"
+      - "http://app-server-2:8080"
+      - "http://app-server-3:8080"
+    strategy: "round-robin"
+    healthCheck:
+      enabled: true
+      interval: 30000
+      path: "/health"
+      timeout: 3000
+```
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/tamuto/infodb-cli
+cd infodb-cli/revx
+
+# Install dependencies
+pnpm install
+
+# Build
+pnpm build
+
+# Development mode
+pnpm dev
+```
+
+## License
+
+MIT
+
+## Author
+
+tamuto <tamuto@infodb.jp>
+
+## Links
+
+- [GitHub Repository](https://github.com/tamuto/infodb-cli)
+- [Report Issues](https://github.com/tamuto/infodb-cli/issues)

package/bin/cli.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../dist/index.js';

package/dist/commands/init.d.ts

@@ -0,0 +1,6 @@
+export declare function initCommand(options: {
+    simple?: boolean;
+    output?: string;
+    verbose?: boolean;
+}): Promise<void>;
+//# sourceMappingURL=init.d.ts.map

package/dist/commands/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAsHA,wBAAsB,WAAW,CAAC,OAAO,EAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,iBAwBlG"}

package/dist/commands/init.js

@@ -0,0 +1,139 @@
+import { writeFileSync, existsSync } from 'fs';
+import { resolve } from 'path';
+import { Logger } from '../utils/logger.js';
+const SAMPLE_CONFIG = `# revx.yaml - Reverse Proxy Configuration
+
+# Server settings
+server:
+  port: 3000
+  host: 0.0.0.0
+  name: "My Reverse Proxy"
+
+# Global configuration
+global:
+  # Request timeout in milliseconds
+  timeout: 30000
+
+  # CORS settings
+  cors:
+    enabled: true
+    origin: "*"
+    methods: ["GET", "POST", "PUT", "DELETE", "OPTIONS"]
+    credentials: true
+
+  # Logging settings
+  logging:
+    enabled: true
+    format: "combined"  # combined | dev | common | short | tiny
+    level: "info"       # error | warn | info | debug
+
+# Route definitions
+routes:
+  # Example 1: Simple proxy to API server
+  - path: "/api/*"
+    target: "http://localhost:4000"
+    changeOrigin: true
+    pathRewrite:
+      "^/api": ""
+    options:
+      timeout: 5000
+      headers:
+        X-Forwarded-Host: "\${HOST}"
+
+  # Example 2: WebSocket proxy
+  - path: "/ws"
+    target: "ws://localhost:5000"
+    ws: true
+    changeOrigin: true
+
+  # Example 3: Load balancing with multiple targets
+  - path: "/balanced/*"
+    targets:
+      - "http://localhost:8001"
+      - "http://localhost:8002"
+      - "http://localhost:8003"
+    strategy: "round-robin"  # round-robin | random | ip-hash
+    pathRewrite:
+      "^/balanced": ""
+    healthCheck:
+      enabled: true
+      interval: 30000
+      path: "/health"
+      timeout: 3000
+
+  # Example 4: Request/Response transformation
+  - path: "/transform/*"
+    target: "http://localhost:6000"
+    changeOrigin: true
+    transform:
+      request:
+        headers:
+          add:
+            X-API-Version: "v2"
+          remove:
+            - "Cookie"
+      response:
+        headers:
+          add:
+            X-Proxy-Server: "revx"
+          remove:
+            - "Server"
+
+# Middleware configuration
+middleware:
+  # Request ID middleware
+  - type: "requestId"
+    enabled: true
+    headerName: "X-Request-ID"
+
+  # Compression middleware
+  - type: "compression"
+    enabled: true
+    threshold: 1024
+
+# SSL/TLS settings (optional)
+# ssl:
+#   enabled: false
+#   key: "/path/to/private.key"
+#   cert: "/path/to/certificate.crt"
+`;
+const SIMPLE_CONFIG = `# revx.yaml - Simple Reverse Proxy Configuration
+
+server:
+  port: 3000
+
+routes:
+  - path: "/api/*"
+    target: "http://localhost:4000"
+    pathRewrite:
+      "^/api": ""
+
+  - path: "/auth/*"
+    target: "http://localhost:5000"
+    pathRewrite:
+      "^/auth": ""
+`;
+export async function initCommand(options) {
+    const logger = new Logger(options.verbose);
+    const outputPath = options.output || 'revx.yaml';
+    const fullPath = resolve(process.cwd(), outputPath);
+    try {
+        if (existsSync(fullPath)) {
+            logger.error(`Configuration file already exists: ${fullPath}`);
+            logger.info('Use --output to specify a different file name');
+            process.exit(1);
+        }
+        const content = options.simple ? SIMPLE_CONFIG : SAMPLE_CONFIG;
+        writeFileSync(fullPath, content, 'utf-8');
+        logger.success(`Configuration file created: ${fullPath}`);
+        logger.info('Edit the file to configure your reverse proxy settings');
+        logger.info(`Start the proxy with: revx start ${outputPath}`);
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            logger.error(`Failed to create configuration file: ${error.message}`);
+        }
+        process.exit(1);
+    }
+}
+//# sourceMappingURL=init.js.map

package/dist/commands/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,MAAM,aAAa,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+FrB,CAAC;AAEF,MAAM,aAAa,GAAG;;;;;;;;;;;;;;;CAerB,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAiE;IACjG,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3C,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,IAAI,WAAW,CAAC;IACjD,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,UAAU,CAAC,CAAC;IAEpD,IAAI,CAAC;QACH,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,KAAK,CAAC,sCAAsC,QAAQ,EAAE,CAAC,CAAC;YAC/D,MAAM,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;YAC7D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC;QAC/D,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAE1C,MAAM,CAAC,OAAO,CAAC,+BAA+B,QAAQ,EAAE,CAAC,CAAC;QAC1D,MAAM,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;QACtE,MAAM,CAAC,IAAI,CAAC,oCAAoC,UAAU,EAAE,CAAC,CAAC;IAChE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,MAAM,CAAC,KAAK,CAAC,wCAAwC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACxE,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC"}

package/dist/commands/start.d.ts

@@ -0,0 +1,4 @@
+export declare function startCommand(configFile: string | undefined, options: {
+    verbose?: boolean;
+}): Promise<void>;
+//# sourceMappingURL=start.d.ts.map

package/dist/commands/start.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"start.d.ts","sourceRoot":"","sources":["../../src/commands/start.ts"],"names":[],"mappings":"AAWA,wBAAsB,YAAY,CAAC,UAAU,EAAE,MAAM,YAAc,EAAE,OAAO,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,iBAoBlG"}