instaserve 1.1.1 → 1.1.3

package/README.md

@@ -1,12 +1,25 @@
 <div align="center">
   <h1 style="color: #3b82f6; margin: 10px 0 5px;">Instaserve</h1>
   <p style="color: #6b7280; margin: 0;">Instant web stack for Node.js</p>
+  
+  <p>
+    <img src="https://img.shields.io/npm/v/instaserve" alt="npm version" />
+    <img src="https://img.shields.io/bundlephobia/minzip/instaserve" alt="bundle size" />
+  </p>
 </div>
 
 ## Usage
 
 <div style="background: white; padding: 15px; border-radius: 6px; box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1); margin: 15px 0;">
-  <pre style="margin: 0;"><code>npx instaserve [options]</code></pre>
+  <pre style="margin: 0;"><code>npx instaserve [options]
+npx instaserve generate-routes</code></pre>
+</div>
+
+## Commands
+
+<div style="display: flex; gap: 8px; margin: 8px 0;">
+  <code style="background: #f3f4f6; padding: 2px 4px; border-radius: 4px; color: #2563eb;">generate-routes</code>
+  <span>Create a sample routes.js file in the current directory</span>
 </div>
 
 ## Options
@@ -65,6 +78,24 @@ The certificate generation script:
 
 The routes file (`routes.js` by default) defines your API endpoints. Each route is a function that handles requests to a specific URL path.
 
+### Generating a Routes File
+
+To create a sample `routes.js` file with example routes and middleware:
+
+```bash
+npx instaserve generate-routes
+```
+
+This creates a `routes.js` file in the current directory with example code. If the file already exists, the command will fail to prevent overwriting.
+
+### Routes File Validation
+
+Instaserve validates routes files on startup:
+- If `-api` is specified and the file doesn't exist, the server will fail to start
+- The routes file must export a default object
+- All route handlers must be functions
+- Invalid routes files will cause the server to exit with an error message
+
 ### Basic Route Example
 
 ```javascript

package/instaserve

@@ -2,10 +2,15 @@
 
 import chalk from 'chalk'
 import fs from 'node:fs'
+import path from 'node:path'
+import { pathToFileURL } from 'node:url'
 
 console.log(chalk.cyan('\nInstaserve - Instant Web Stack\n'))
 console.log(chalk.yellow('Usage:'))
-console.log(chalk.green('  npx instaserve [options]\n'))
+console.log(chalk.green('  npx instaserve [options]'))
+console.log(chalk.green('  npx instaserve generate-routes\n'))
+console.log(chalk.yellow('Commands:'))
+console.log(chalk.green('  generate-routes') + '   Create a sample routes.js file in the current directory\n')
 console.log(chalk.yellow('Options:'))
 console.log(chalk.green('  -port <number>') + '    Port to listen on (default: 3000)')
 console.log(chalk.green('  -ip <address>') + '     IP address to bind to (default: 127.0.0.1)')
@@ -18,9 +23,53 @@ if (process.argv.includes('-help')) {
     process.exit(0)
 }
 
+const args = process.argv.slice(2)
+
+// Handle generate-routes command
+if (args[0] === 'generate-routes') {
+    const routesFile = './routes.js'
+    if (fs.existsSync(routesFile)) {
+        console.error(chalk.red(`Error: ${routesFile} already exists`))
+        process.exit(1)
+    }
+    
+    const sampleRoutes = `export default {
+    // Middleware functions (prefixed with _) run on every request
+    // Return false to continue processing, or a value to use as response
+    
+    // Example: Log all requests
+    _log: (req, res, data) => {
+        console.log(\`\${req.method} \${req.url}\`)
+        return false // Continue to next middleware or route
+    },
+
+    // Example: Basic authentication (commented out)
+    // _auth: (req, res, data) => {
+    //     if (!data.token) {
+    //         res.writeHead(401)
+    //         return 'Unauthorized'
+    //     }
+    //     return false // Continue if authorized
+    // },
+
+    // Regular route handlers
+    hello: (req, res, data) => {
+        return { message: 'Hello World' }
+    },
+
+    api: (req, res, data) => {
+        return { message: 'API endpoint', data }
+    }
+}
+`
+    
+    fs.writeFileSync(routesFile, sampleRoutes)
+    console.log(chalk.green(`✓ Created ${routesFile}`))
+    process.exit(0)
+}
+
 import server from './module.mjs'
 
-const args = process.argv.slice(2)
 const params = {}
 for (let i = 0; i < args.length; i++) {
     const arg = args[i]
@@ -38,13 +87,39 @@ for (let i = 0; i < args.length; i++) {
 
 // Load routes file
 let routes = {}
-const routesFile = params.api || './routes.js'
+const routesFileParam = params.api || './routes.js'
+const routesFileSpecified = !!params.api
+
+// Resolve to absolute path from current working directory
+const routesFile = path.isAbsolute(routesFileParam) 
+    ? routesFileParam 
+    : path.resolve(process.cwd(), routesFileParam)
+
+if (routesFileSpecified && !fs.existsSync(routesFile)) {
+    console.error(chalk.red(`Error: Routes file "${routesFileParam}" does not exist`))
+    process.exit(1)
+}
+
 if (fs.existsSync(routesFile)) {
     try {
-        const imported = await import(routesFile)
+        const routesFileURL = pathToFileURL(routesFile).href
+        const imported = await import(routesFileURL)
         routes = imported.default || imported
+        
+        if (!routes || typeof routes !== 'object' || Array.isArray(routes)) {
+            console.error(chalk.red(`Error: Routes file "${routesFileParam}" must export a default object`))
+            process.exit(1)
+        }
+        
+        for (const [key, handler] of Object.entries(routes)) {
+            if (typeof handler !== 'function') {
+                console.error(chalk.red(`Error: Route "${key}" in "${routesFileParam}" must be a function`))
+                process.exit(1)
+            }
+        }
     } catch (e) {
-        console.log(chalk.yellow(`Warning: Could not load routes file ${routesFile}: ${e.message}`))
+        console.error(chalk.red(`Error: Could not load routes file "${routesFileParam}": ${e.message}`))
+        process.exit(1)
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "instaserve",
-    "version": "1.1.1",
+    "version": "1.1.3",
     "description": "Instant web stack",
     "main": "module.mjs",
     "bin": "./instaserve",
@@ -9,6 +9,6 @@
     },
     "type": "module",
     "dependencies": {
-        "chalk": "^5.4.1"
+        "chalk": "^5.6.2"
     }
 }

package/public/index.html

@@ -1,209 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-    <title>Instaserve</title>
-    <style>
-        :root {
-            --primary: #3b82f6;
-            --primary-dark: #2563eb;
-            --text: #1f2937;
-            --text-light: #6b7280;
-            --bg: #f9fafb;
-        }
-        body {
-            font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
-            line-height: 1.5;
-            max-width: 800px;
-            margin: 0 auto;
-            padding: 20px 15px;
-            color: var(--text);
-            background: var(--bg);
-        }
-        .header {
-            text-align: center;
-            margin-bottom: 20px;
-        }
-        .orb {
-            width: 60px;
-            height: 60px;
-            background: radial-gradient(circle at 30% 30%, #60a5fa, var(--primary));
-            border-radius: 50%;
-            margin: 0 auto 10px;
-            box-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.1), 0 2px 4px -1px rgba(0, 0, 0, 0.06);
-        }
-        h1 { 
-            color: var(--primary);
-            font-size: 2rem;
-            margin: 0;
-        }
-        .subtitle {
-            color: var(--text-light);
-            font-size: 1rem;
-            margin: 5px 0;
-        }
-        h2 { 
-            color: var(--text);
-            font-size: 1.3rem;
-            margin: 20px 0 10px;
-            padding-bottom: 5px;
-            border-bottom: 2px solid var(--primary);
-        }
-        h3 {
-            color: var(--text);
-            font-size: 1.1rem;
-            margin: 15px 0 8px;
-        }
-        code {
-            background: #f3f4f6;
-            padding: 2px 4px;
-            border-radius: 4px;
-            font-family: 'SF Mono', Menlo, monospace;
-            color: var(--primary-dark);
-        }
-        pre {
-            background: #f3f4f6;
-            padding: 10px;
-            border-radius: 6px;
-            overflow-x: auto;
-            border: 1px solid #e5e7eb;
-            margin: 10px 0;
-            font-size: 0.9rem;
-        }
-        .option {
-            margin: 8px 0;
-            padding-left: 0;
-            position: relative;
-            display: flex;
-            gap: 8px;
-        }
-        .option:before {
-            display: none;
-        }
-        .option code {
-            flex-shrink: 0;
-        }
-        ul {
-            padding-left: 15px;
-            margin: 8px 0;
-        }
-        li {
-            margin: 5px 0;
-        }
-        .usage {
-            background: white;
-            padding: 15px;
-            border-radius: 6px;
-            box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
-            margin: 15px 0;
-        }
-        p {
-            margin: 8px 0;
-        }
-    </style>
-</head>
-<body>
-    <div class="header">
-        <div class="orb"></div>
-        <h1>Instaserve</h1>
-        <p class="subtitle">Instant web stack for Node.js</p>
-    </div>
-
-    <div class="usage">
-        <h2>Usage</h2>
-        <pre><code>npx instaserve [options]</code></pre>
-    </div>
-
-    <h2>Options</h2>
-    <div class="option"><code>-port &lt;number&gt;</code> - Port to listen on (default: 3000)</div>
-    <div class="option"><code>-ip &lt;address&gt;</code> - IP address to bind to (default: 127.0.0.1)</div>
-    <div class="option"><code>-public &lt;path&gt;</code> - Public directory path (default: ./public)</div>
-    <div class="option"><code>-api &lt;file&gt;</code> - Path to routes file (default: ./routes.js)</div>
-    <div class="option"><code>-secure</code> - Enable HTTPS (requires cert.pem and key.pem - run ./generate-certs.sh)</div>
-    <div class="option"><code>-help</code> - Show help message</div>
-
-    <h2>HTTPS Support</h2>
-    <p>Instaserve supports HTTPS with self-signed certificates. To enable HTTPS:</p>
-    <ol>
-        <li><strong>Generate certificates:</strong> <code>./generate-certs.sh</code></li>
-        <li><strong>Run with HTTPS:</strong> <code>npx instaserve -secure</code></li>
-    </ol>
-    <p>The certificate generation script creates trusted certificates that won't show browser warnings.</p>
-
-    <h2>Routes</h2>
-    <p>The routes file (<code>routes.js</code> by default) defines your API endpoints. Each route is a function that handles requests to a specific URL path.</p>
-
-    <h3>Basic Route Example</h3>
-    <pre><code>export default {
-    // Handle GET /hello
-    hello: (req, res, data) => {
-        return { message: 'Hello World' }
-    }
-}</code></pre>
-
-    <h3>Special Routes (Middleware)</h3>
-    <p>Routes starting with <code>_</code> are middleware functions that run on <strong>every request</strong> before the main route handler. They are useful for:</p>
-    <ul>
-        <li>Logging requests</li>
-        <li>Authentication</li>
-        <li>Request modification</li>
-        <li>Response headers</li>
-    </ul>
-    <p>Middleware functions can:</p>
-    <ul>
-        <li>Return <code>false</code> to continue to the next middleware or main route</li>
-        <li>Return a truthy value to stop processing and use that as the response</li>
-        <li>Modify the request or response objects</li>
-    </ul>
-
-    <h4>Middleware Example</h4>
-    <pre><code>export default {
-    // Log every request
-    _log: (req, res, data) => {
-        console.log(`${req.method} ${req.url}`)
-        return false // Continue processing
-    },
-
-    // Block unauthorized requests
-    _auth: (req, res, data) => {
-        if (!data.token) {
-            res.writeHead(401)
-            return 'Unauthorized'
-        }
-        return false // Continue if authorized
-    }
-}</code></pre>
-
-    <h3>Route Parameters</h3>
-    <p>Each route function receives:</p>
-    <ul>
-        <li><code>req</code> - The HTTP request object</li>
-        <li><code>res</code> - The HTTP response object</li>
-        <li><code>data</code> - Combined data from:
-            <ul>
-                <li>POST body (if JSON)</li>
-                <li>URL query parameters</li>
-                <li>Form data</li>
-            </ul>
-        </li>
-    </ul>
-
-    <h3>Example Routes File</h3>
-    <pre><code>export default {
-    // Middleware example
-    _debug: (req, res, data) => {
-        console.log('Request:', req.url)
-        return false // Continue to next route
-    },
-
-    // API endpoint
-    api: (req, res, data) => {
-        return { status: 'ok', data }
-    },
-
-    // Error handling
-    testerror: () => {
-        throw new Error('Test error')
-    }
-}</code></pre>
-</body>
-</html>