javascript-solid-server 0.0.164 → 0.0.166

package/jsserve/README.md

@@ -1,194 +0,0 @@
-# servejss
-
-> Static file server with REST write support. A drop-in `npx serve` alternative.
-
-[![npm version](https://img.shields.io/npm/v/servejss.svg)](https://www.npmjs.com/package/servejss)
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
-
-## Why?
-
-`npx serve` is great for quickly serving static files, but it's **read-only**. Sometimes you need to:
-
-- Upload files during development
-- Test REST APIs locally
-- Sync files between devices on your LAN
-- Have a simple WebDAV-like server
-
-**servejss** is `serve` with superpowers: same simple interface, but you can write too.
-
-## Install
-
-```bash
-npm install -g servejss
-```
-
-Or use directly with npx:
-
-```bash
-npx servejss
-```
-
-## Usage
-
-```bash
-# Serve current directory (read + write enabled)
-servejss
-
-# Serve specific directory
-servejss ./public
-
-# Custom port
-servejss -p 8080
-
-# Specify port and directory
-servejss -l 3000 ./dist
-
-# Read-only mode (exactly like npx serve)
-servejss --read-only
-```
-
-## Output
-
-```
- servejss
-
-  Directory:  /home/user/project
-
-  Local:      http://localhost:3000
-  Network:    http://192.168.1.5:3000
-
-  Mode:       GET/PUT/DELETE enabled
-
-  Press Ctrl+C to stop
-```
-
-## REST API
-
-```bash
-# Read a file
-curl http://localhost:3000/file.txt
-
-# Create or update a file
-curl -X PUT -d "Hello, World!" http://localhost:3000/file.txt
-
-# Delete a file
-curl -X DELETE http://localhost:3000/file.txt
-
-# Conditional update (only if ETag matches)
-curl -X PUT -H 'If-Match: "abc123"' -d "Updated" http://localhost:3000/file.txt
-
-# Create only if doesn't exist
-curl -X PUT -H 'If-None-Match: *' -d "New file" http://localhost:3000/new.txt
-```
-
-## Options
-
-```
-Usage: servejss [options] [directory]
-
-Options:
-  -v, --version            Output version number
-  -l, --listen <uri>       Specify a URI endpoint on which to listen
-  -p, --port <port>        Specify custom port (default: 3000)
-  -H, --host <host>        Host to bind to (default: 0.0.0.0)
-  -s, --single             Rewrite all not-found requests to index.html (SPA mode)
-  -d, --debug              Show debugging information
-  -C, --cors               Enable CORS (enabled by default)
-  -L, --no-request-logging Do not log any request information
-  --no-etag                Disable ETag generation
-  -S, --symlinks           Resolve symlinks instead of showing 404
-  --ssl-cert <path>        Path to SSL certificate
-  --ssl-key <path>         Path to SSL private key
-  --no-port-switching      Do not open a different port if specified one is taken
-  -r, --read-only          Disable PUT/DELETE methods (like npx serve)
-  --auth <credentials>     Enable basic auth (user:pass)
-  --solid                  Enable full Solid protocol features
-  -q, --quiet              Suppress all output
-  -h, --help               Display help
-```
-
-## Comparison with serve
-
-| Feature | serve | servejss |
-|---------|-------|---------|
-| Static file serving | ✅ | ✅ |
-| Directory listings | ✅ | ✅ |
-| CORS | ✅ | ✅ |
-| SPA mode | ✅ | ✅ |
-| Custom port | ✅ | ✅ |
-| Auto port switching | ✅ | ✅ |
-| SSL/TLS | ✅ | ✅ |
-| **PUT (create/update)** | ❌ | ✅ |
-| **DELETE** | ❌ | ✅ |
-| **ETags** | ❌ | ✅ |
-| **Conditional requests** | ❌ | ✅ |
-| **Upgrade to Solid** | ❌ | ✅ |
-
-## Advanced Features
-
-### Conditional Requests
-
-servejss supports ETags for efficient caching and safe concurrent updates:
-
-```bash
-# Get a file with its ETag
-curl -i http://localhost:3000/file.txt
-# Returns: ETag: "a1b2c3"
-
-# Only fetch if changed
-curl -H 'If-None-Match: "a1b2c3"' http://localhost:3000/file.txt
-# Returns: 304 Not Modified (if unchanged)
-
-# Safe update (fails if file changed since you read it)
-curl -X PUT -H 'If-Match: "a1b2c3"' -d "new content" http://localhost:3000/file.txt
-```
-
-### Upgrade to Solid
-
-servejss is powered by [JSS (JavaScript Solid Server)](https://github.com/JavaScriptSolidServer/JavaScriptSolidServer). Enable full Solid protocol support:
-
-```bash
-servejss --solid
-```
-
-This enables:
-- Solid-OIDC authentication
-- Web Access Control (WAC)
-- Linked Data support (Turtle, JSON-LD)
-- WebID profiles
-
-## Use Cases
-
-### Local Development Server
-```bash
-# Serve your project with write support for uploads
-cd my-project
-servejss
-```
-
-### Quick File Sharing on LAN
-```bash
-# Share files with devices on your network
-servejss --read-only ~/shared-files
-```
-
-### REST API Testing
-```bash
-# Mock a simple REST backend
-servejss ./mock-data
-```
-
-### WebDAV Alternative
-```bash
-# Lightweight file sync server
-servejss --auth user:pass ~/sync
-```
-
-## License
-
-MIT
-
-## Related Projects
-
-- [JSS](https://github.com/JavaScriptSolidServer/JavaScriptSolidServer) - Full Solid server
-- [serve](https://github.com/vercel/serve) - Static file serving (read-only)

package/jsserve/bin/jsserve.js

@@ -1,329 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * servejss - Static file server with REST write support
- * A drop-in replacement for `npx serve` with PUT/DELETE capabilities
- */
-
-import { program } from 'commander';
-import { resolve } from 'path';
-import { spawn } from 'child_process';
-import { createServer } from 'net';
-import { networkInterfaces } from 'os';
-import { fileURLToPath } from 'url';
-import { dirname, join } from 'path';
-import chalk from 'chalk';
-import fs from 'fs';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-const pkg = JSON.parse(fs.readFileSync(join(__dirname, '..', 'package.json'), 'utf8'));
-
-/**
- * Check if a port is available
- * @param {number} port
- * @returns {Promise<boolean>}
- */
-function isPortAvailable(port) {
-  return new Promise((resolve) => {
-    const server = createServer();
-    server.once('error', () => resolve(false));
-    server.once('listening', () => {
-      server.close();
-      resolve(true);
-    });
-    server.listen(port, '0.0.0.0');
-  });
-}
-
-/**
- * Find an available port starting from the given port
- * @param {number} startPort
- * @param {number} maxAttempts
- * @returns {Promise<number>}
- */
-async function findAvailablePort(startPort, maxAttempts = 100) {
-  for (let i = 0; i < maxAttempts; i++) {
-    const port = startPort + i;
-    if (await isPortAvailable(port)) {
-      return port;
-    }
-  }
-  throw new Error(`Could not find available port after ${maxAttempts} attempts`);
-}
-
-/**
- * Get local network IP address
- * @returns {string|null}
- */
-function getNetworkAddress() {
-  const nets = networkInterfaces();
-  for (const name of Object.keys(nets)) {
-    for (const net of nets[name]) {
-      if (net.family === 'IPv4' && !net.internal) {
-        return net.address;
-      }
-    }
-  }
-  return null;
-}
-
-/**
- * Print the startup banner
- */
-function printBanner(options) {
-  const { port, host, directory, readOnly, live, networkAddress } = options;
-
-  const local = `http://${host === '0.0.0.0' ? 'localhost' : host}:${port}`;
-  const network = networkAddress ? `http://${networkAddress}:${port}` : null;
-
-  const mode = readOnly ? 'GET only (read-only)' : 'GET/PUT/DELETE enabled';
-
-  console.log();
-  console.log(chalk.bgCyan.black(' servejss '));
-  console.log();
-  console.log(`  ${chalk.gray('Directory:')}  ${directory}`);
-  console.log();
-  console.log(`  ${chalk.gray('Local:')}      ${chalk.cyan(local)}`);
-  if (network) {
-    console.log(`  ${chalk.gray('Network:')}    ${chalk.cyan(network)}`);
-  }
-  console.log();
-  console.log(`  ${chalk.gray('Mode:')}       ${chalk.yellow(mode)}`);
-  if (live) {
-    console.log(`  ${chalk.gray('Live:')}       ${chalk.green('Watching for changes')}`);
-  }
-  console.log();
-  console.log(chalk.gray('  Press Ctrl+C to stop'));
-  console.log();
-}
-
-/**
- * Print an error message
- */
-function printError(message) {
-  console.error();
-  console.error(chalk.red('  ERROR:'), message);
-  console.error();
-}
-
-// CLI definition - matching `serve` interface
-program
-  .name('servejss')
-  .description('Static file server with REST write support')
-  .version(pkg.version, '-v, --version')
-  .argument('[directory]', 'Directory to serve', '.')
-  .option('-l, --listen <uri>', 'Specify a URI endpoint on which to listen')
-  .option('-p, --port <port>', 'Specify custom port', '3000')
-  .option('-H, --host <host>', 'Host to bind to', '0.0.0.0')
-  .option('-s, --single', 'Rewrite all not-found requests to index.html (SPA mode)')
-  .option('-d, --debug', 'Show debugging information')
-  .option('-C, --cors', 'Enable CORS (enabled by default)')
-  .option('-L, --no-request-logging', 'Do not log any request information')
-  .option('--no-etag', 'Disable ETag generation')
-  .option('-S, --symlinks', 'Resolve symlinks instead of showing 404')
-  .option('--ssl-cert <path>', 'Path to SSL certificate')
-  .option('--ssl-key <path>', 'Path to SSL private key')
-  .option('--no-port-switching', 'Do not open a different port if specified one is taken')
-  // servejss-specific options
-  .option('-r, --read-only', 'Disable PUT/DELETE methods (like npx serve)')
-  .option('--write', 'Enable PUT/DELETE methods (default)')
-  .option('--auth <credentials>', 'Enable basic auth (user:pass)')
-  .option('--solid', 'Enable full Solid protocol features')
-  .option('--live', 'Enable live reload (default: true)')
-  .option('--no-live', 'Disable live reload')
-  .option('--git', 'Enable git HTTP backend (default: true)')
-  .option('--no-git', 'Disable git HTTP backend')
-  .option('-q, --quiet', 'Suppress all output')
-  .addHelpText('after', `
-Examples:
-  $ servejss                     Serve current directory with read/write
-  $ servejss ./public            Serve specific directory
-  $ servejss -p 8080             Use custom port
-  $ servejss --read-only         Read-only mode (like npx serve)
-  $ servejss -l 3000 ./dist      Listen on port 3000, serve ./dist
-
-REST API:
-  GET    /file.txt              Read file
-  PUT    /file.txt              Create/update file
-  DELETE /file.txt              Delete file
-  HEAD   /file.txt              Get file metadata
-
-Differences from 'serve':
-  - PUT and DELETE enabled by default (use --read-only to disable)
-  - ETag support for caching and conditional requests
-  - Optional upgrade to full Solid protocol with --solid
-`)
-  .action(async (directory, options) => {
-    try {
-      await run(directory, options);
-    } catch (err) {
-      printError(err.message);
-      process.exit(1);
-    }
-  });
-
-program.parse();
-
-/**
- * Main run function
- */
-async function run(directory, options) {
-  // Resolve directory
-  const dir = resolve(directory || '.');
-
-  // Check directory exists
-  if (!fs.existsSync(dir)) {
-    throw new Error(`Directory not found: ${dir}`);
-  }
-
-  if (!fs.statSync(dir).isDirectory()) {
-    throw new Error(`Not a directory: ${dir}`);
-  }
-
-  // Parse port from --listen or --port
-  let port = parseInt(options.port, 10);
-  if (options.listen) {
-    // Parse listen URI (e.g., "3000", "tcp://localhost:3000")
-    const listenMatch = options.listen.match(/:?(\d+)$/);
-    if (listenMatch) {
-      port = parseInt(listenMatch[1], 10);
-    }
-  }
-
-  // Find available port if needed
-  const originalPort = port;
-  if (options.portSwitching !== false) {
-    const available = await isPortAvailable(port);
-    if (!available) {
-      port = await findAvailablePort(port + 1);
-      if (!options.quiet) {
-        console.log(chalk.yellow(`  Port ${originalPort} is in use, using ${port} instead`));
-      }
-    }
-  } else {
-    const available = await isPortAvailable(port);
-    if (!available) {
-      throw new Error(`Port ${port} is already in use`);
-    }
-  }
-
-  // Build JSS arguments
-  const jssArgs = [
-    'start',
-    '--root', dir,
-    '--port', String(port),
-    '--host', options.host,
-    '--public',  // Enable open access (requires #107)
-  ];
-
-  // Read-only mode
-  if (options.readOnly) {
-    jssArgs.push('--read-only');
-  }
-
-  // Quiet mode
-  if (options.quiet || !options.requestLogging) {
-    jssArgs.push('--quiet');
-  }
-
-  // SSL
-  if (options.sslCert && options.sslKey) {
-    jssArgs.push('--ssl-cert', options.sslCert);
-    jssArgs.push('--ssl-key', options.sslKey);
-  }
-
-  // Solid mode (full features)
-  if (options.solid) {
-    // Remove --public, use full Solid auth
-    const publicIndex = jssArgs.indexOf('--public');
-    if (publicIndex > -1) {
-      jssArgs.splice(publicIndex, 1);
-    }
-    jssArgs.push('--idp');
-    jssArgs.push('--conneg');
-  }
-
-  // Live reload mode (default: enabled)
-  if (options.live !== false) {
-    jssArgs.push('--live-reload');
-  }
-
-  // Git HTTP backend (default: enabled)
-  if (options.git !== false) {
-    jssArgs.push('--git');
-  }
-
-  // Debug mode
-  if (options.debug) {
-    console.log(chalk.gray('  JSS args:'), jssArgs.join(' '));
-  }
-
-  // Print banner
-  if (!options.quiet) {
-    printBanner({
-      port,
-      host: options.host,
-      directory: dir,
-      readOnly: options.readOnly,
-      live: options.live !== false,
-      networkAddress: getNetworkAddress(),
-    });
-  }
-
-  // Find jss binary
-  let jssPath;
-  try {
-    // Try to find jss in node_modules
-    const jssModule = await import.meta.resolve('javascript-solid-server/bin/jss.js');
-    jssPath = fileURLToPath(jssModule);
-  } catch {
-    // Fallback to global jss
-    jssPath = 'jss';
-  }
-
-  // Spawn JSS
-  const child = spawn('node', [jssPath, ...jssArgs], {
-    stdio: options.quiet ? 'ignore' : ['inherit', 'pipe', 'inherit'],
-    env: { ...process.env, FORCE_COLOR: '1' },
-  });
-
-  // Filter JSS output to remove its banner (we have our own)
-  if (!options.quiet && child.stdout) {
-    let skipBanner = true;
-    child.stdout.on('data', (data) => {
-      const str = data.toString();
-      // Skip JSS startup banner, show rest
-      if (skipBanner && (str.includes('Listening') || str.includes('Server'))) {
-        skipBanner = false;
-        return;
-      }
-      if (!skipBanner || options.debug) {
-        process.stdout.write(data);
-      }
-    });
-  }
-
-  // Handle child process errors
-  child.on('error', (err) => {
-    printError(`Failed to start server: ${err.message}`);
-    process.exit(1);
-  });
-
-  child.on('exit', (code) => {
-    if (code !== 0 && code !== null) {
-      process.exit(code);
-    }
-  });
-
-  // Handle graceful shutdown
-  const shutdown = () => {
-    if (!options.quiet) {
-      console.log(chalk.gray('\n  Shutting down...'));
-    }
-    child.kill('SIGTERM');
-  };
-
-  process.on('SIGINT', shutdown);
-  process.on('SIGTERM', shutdown);
-}