kempo-server 1.0.0 → 1.2.0

package/README.md

@@ -288,6 +288,7 @@ An array of regex patterns for paths that should not trigger a file system resca
 
 An object mapping custom route paths to file paths. Useful for aliasing or serving files from outside the document root.
 
+**Basic Routes:**
 ```json
 {
   "customRoutes": {
@@ -297,6 +298,26 @@ An object mapping custom route paths to file paths. Useful for aliasing or servi
 }
 ```
 
+**Wildcard Routes:**
+Wildcard routes allow you to map entire directory structures using the `*` wildcard:
+
+```json
+{
+  "customRoutes": {
+    "kempo/*": "./node_modules/kempo/dust/*",
+    "assets/*": "./static-files/*",
+    "docs/*": "./documentation/*"
+  }
+}
+```
+
+With wildcard routes:
+- `kempo/styles.css` would serve `./node_modules/kempo/dust/styles.css`
+- `assets/logo.png` would serve `./static-files/logo.png`  
+- `docs/readme.md` would serve `./documentation/readme.md`
+
+The `*` wildcard matches any single path segment (anything between `/` characters). Multiple wildcards can be used in a single route pattern.
+
 ### maxRescanAttempts
 
 The maximum number of times to attempt rescanning the file system when a file is not found. Defaults to 3.

package/defaultConfig.js

@@ -89,5 +89,6 @@ export default {
   maxRescanAttempts: 3,
   customRoutes: {
     // Example: "/vendor/bootstrap.css": "./node_modules/bootstrap/dist/css/bootstrap.min.css"
+    // Wildcard example: "kempo/*": "./node_modules/kempo/dust/*"
   }
 }

package/docs/index.html

@@ -152,8 +152,22 @@
 
     <h4 id="customRoutes">customRoutes</h4>
     <p>An object mapping custom route paths to file paths. Useful for aliasing or serving files from outside the document root.</p>
+    
+    <p><strong>Basic Routes:</strong></p>
     <pre><code class="hljs json">{<br />  <span class="hljs-attr">"customRoutes"</span>: {<br />    <span class="hljs-attr">"/vendor/bootstrap.css"</span>: <span class="hljs-string">"./node_modules/bootstrap/dist/css/bootstrap.min.css"</span>,<br />    <span class="hljs-attr">"/api/status"</span>: <span class="hljs-string">"./status.js"</span><br />  }<br />}</code></pre>
 
+    <p><strong>Wildcard Routes:</strong></p>
+    <p>Wildcard routes allow you to map entire directory structures using the <code>*</code> wildcard:</p>
+    <pre><code class="hljs json">{<br />  <span class="hljs-attr">"customRoutes"</span>: {<br />    <span class="hljs-attr">"kempo/*"</span>: <span class="hljs-string">"./node_modules/kempo/dust/*"</span>,<br />    <span class="hljs-attr">"assets/*"</span>: <span class="hljs-string">"./static-files/*"</span>,<br />    <span class="hljs-attr">"docs/*"</span>: <span class="hljs-string">"./documentation/*"</span><br />  }<br />}</code></pre>
+
+    <p>With wildcard routes:</p>
+    <ul>
+      <li><code>kempo/styles.css</code> would serve <code>./node_modules/kempo/dust/styles.css</code></li>
+      <li><code>assets/logo.png</code> would serve <code>./static-files/logo.png</code></li>
+      <li><code>docs/readme.md</code> would serve <code>./documentation/readme.md</code></li>
+    </ul>
+    <p>The <code>*</code> wildcard matches any single path segment (anything between <code>/</code> characters). Multiple wildcards can be used in a single route pattern.</p>
+
     <h4 id="maxRescanAttempts">maxRescanAttempts</h4>
     <p>The maximum number of times to attempt rescanning the file system when a file is not found. Defaults to 3.</p>
     <pre><code class="hljs json">{<br />  <span class="hljs-attr">"maxRescanAttempts"</span>: <span class="hljs-number">3</span><br />}</code></pre>
@@ -163,6 +177,7 @@
       <li><strong>Zero Dependencies</strong> - No external dependencies required</li>
       <li><strong>File-based Routing</strong> - Routes are defined by your directory structure</li>
       <li><strong>Dynamic Routes</strong> - Support for parameterized routes with square bracket syntax</li>
+      <li><strong>Wildcard Routes</strong> - Map entire directory structures with wildcard patterns</li>
       <li><strong>Multiple HTTP Methods</strong> - Support for GET, POST, PUT, DELETE, and more</li>
       <li><strong>Static File Serving</strong> - Automatically serves static files with proper MIME types</li>
       <li><strong>HTML Routes</strong> - Support for both JavaScript and HTML route handlers</li>

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "kempo-server",
   "type": "module",
-  "version": "1.0.0",
-  "description": "",
+  "version": "1.2.0",
+  "description": "A lightweight, zero-dependency, file based routing server.",
   "main": "index.js",
+  "bin": {
+    "kempo-server": "./index.js"
+  },
   "scripts": {
-    "start": "node index.js -r docs"
+    "start": "node index.js -r ./docs"
   },
   "author": "",
   "license": "ISC",

package/router.js

@@ -41,26 +41,69 @@ export default async (flags, log) => {
   
   // Process custom routes - resolve paths and validate files exist
   const customRoutes = new Map();
+  const wildcardRoutes = new Map();
+  
   if (config.customRoutes && Object.keys(config.customRoutes).length > 0) {
     log(`Processing ${Object.keys(config.customRoutes).length} custom routes`, 2);
     
     for (const [urlPath, filePath] of Object.entries(config.customRoutes)) {
       try {
-        // Resolve the file path relative to the current working directory
-        const resolvedPath = path.resolve(filePath);
-        
-        // Check if the file exists (we'll do this async)
-        const { stat } = await import('fs/promises');
-        await stat(resolvedPath);
-        
-        customRoutes.set(urlPath, resolvedPath);
-        log(`Custom route mapped: ${urlPath} -> ${resolvedPath}`, 2);
+        // Check if this is a wildcard route
+        if (urlPath.includes('*')) {
+          // Store wildcard routes separately for pattern matching
+          wildcardRoutes.set(urlPath, filePath);
+          log(`Wildcard route mapped: ${urlPath} -> ${filePath}`, 2);
+        } else {
+          // Resolve the file path relative to the current working directory
+          const resolvedPath = path.resolve(filePath);
+          
+          // Check if the file exists (we'll do this async)
+          const { stat } = await import('fs/promises');
+          await stat(resolvedPath);
+          
+          customRoutes.set(urlPath, resolvedPath);
+          log(`Custom route mapped: ${urlPath} -> ${resolvedPath}`, 2);
+        }
       } catch (error) {
         log(`Custom route error for ${urlPath} -> ${filePath}: ${error.message}`, 1);
       }
     }
   }
   
+  // Helper function to match wildcard patterns
+  const matchWildcardRoute = (requestPath, pattern) => {
+    // Convert wildcard pattern to regex
+    const regexPattern = pattern
+      .replace(/\*/g, '([^/]+)')  // Replace * with capture group for single segment
+      .replace(/\*\*/g, '(.+)');  // Replace ** with capture group for multiple segments
+    
+    const regex = new RegExp(`^${regexPattern}$`);
+    return regex.exec(requestPath);
+  };
+  
+  // Helper function to resolve wildcard file paths
+  const resolveWildcardPath = (filePath, matches) => {
+    let resolvedPath = filePath;
+    
+    // Replace wildcards with captured values
+    for (let i = 1; i < matches.length; i++) {
+      resolvedPath = resolvedPath.replace('*', matches[i]);
+    }
+    
+    return path.resolve(resolvedPath);
+  };
+  
+  // Helper function to find matching wildcard route
+  const findWildcardRoute = (requestPath) => {
+    for (const [pattern, filePath] of wildcardRoutes) {
+      const matches = matchWildcardRoute(requestPath, pattern);
+      if (matches) {
+        return { filePath, matches };
+      }
+    }
+    return null;
+  };
+
   // Track 404 attempts to avoid unnecessary rescans
   const rescanAttempts = new Map(); // path -> attempt count
   const dynamicNoRescanPaths = new Set(); // paths that have exceeded max attempts
@@ -128,6 +171,29 @@ export default async (flags, log) => {
       }
     }
     
+    // Check wildcard routes
+    const wildcardMatch = findWildcardRoute(requestPath);
+    if (wildcardMatch) {
+      const resolvedFilePath = resolveWildcardPath(wildcardMatch.filePath, wildcardMatch.matches);
+      log(`Serving wildcard route: ${requestPath} -> ${resolvedFilePath}`, 2);
+      
+      try {
+        const fileContent = await readFile(resolvedFilePath);
+        const fileExtension = path.extname(resolvedFilePath).toLowerCase().slice(1);
+        const mimeType = config.allowedMimes[fileExtension] || 'application/octet-stream';
+        
+        log(`Serving wildcard file as ${mimeType} (${fileContent.length} bytes)`, 2);
+        res.writeHead(200, { 'Content-Type': mimeType });
+        res.end(fileContent);
+        return; // Successfully served wildcard route
+      } catch (error) {
+        log(`Error serving wildcard route ${requestPath}: ${error.message}`, 0);
+        res.writeHead(500, { 'Content-Type': 'text/plain' });
+        res.end('Internal Server Error');
+        return;
+      }
+    }
+    
     // Try to serve the file normally
     const served = await serveFile(files, rootPath, requestPath, req.method, config, req, res, log);