npm - kempo-server - Versions diffs - 1.4.3 → 1.4.5 - Mend

kempo-server 1.4.3 → 1.4.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (47) hide show

package/.github/copilot-instructions.md +96 -96
package/.github/workflows/publish-npm.yml +41 -0
package/README.md +650 -650
package/builtinMiddleware.js +136 -136
package/defaultConfig.js +129 -129
package/docs/.config.json +5 -5
package/docs/.config.json.example +19 -19
package/docs/api/user/[id]/GET.js +15 -15
package/docs/api/user/[id]/[info]/DELETE.js +12 -12
package/docs/api/user/[id]/[info]/GET.js +17 -17
package/docs/api/user/[id]/[info]/POST.js +18 -18
package/docs/api/user/[id]/[info]/PUT.js +19 -19
package/docs/configuration.html +119 -119
package/docs/examples.html +201 -201
package/docs/getting-started.html +72 -72
package/docs/index.html +81 -81
package/docs/manifest.json +87 -87
package/docs/middleware.html +147 -147
package/docs/request-response.html +95 -95
package/docs/routing.html +77 -77
package/example-middleware.js +23 -23
package/example.config.json +50 -50
package/findFile.js +138 -138
package/getFiles.js +72 -72
package/getFlags.js +34 -34
package/index.js +47 -47
package/middlewareRunner.js +25 -25
package/package.json +10 -6
package/requestWrapper.js +87 -87
package/responseWrapper.js +204 -204
package/router.js +285 -285
package/serveFile.js +71 -71
package/tests/builtinMiddleware-cors.node-test.js +17 -17
package/tests/builtinMiddleware.node-test.js +74 -74
package/tests/defaultConfig.node-test.js +13 -13
package/tests/example-middleware.node-test.js +31 -31
package/tests/findFile.node-test.js +46 -46
package/tests/getFiles.node-test.js +25 -25
package/tests/getFlags.node-test.js +30 -30
package/tests/index.node-test.js +23 -23
package/tests/middlewareRunner.node-test.js +18 -18
package/tests/requestWrapper.node-test.js +51 -51
package/tests/responseWrapper.node-test.js +74 -74
package/tests/router-middleware.node-test.js +46 -46
package/tests/router.node-test.js +88 -88
package/tests/serveFile.node-test.js +52 -52
package/tests/test-utils.js +106 -106

package/docs/getting-started.html CHANGED Viewed

@@ -1,72 +1,72 @@
-<html lang="en" theme="auto">
-<head>
-  <meta charset='utf-8'>
-  <meta http-equiv='X-UA-Compatible' content='IE=edge'>
-  <title>Getting Started - Kempo Server</title>
-  <meta name='viewport' content='width=device-width, initial-scale=1'>
-  <link rel="icon" type="image/png" sizes="48x48" href="media/icon48.png">
-  <link rel="manifest" href="manifest.json">
-  <link rel="stylesheet" href="essential.css" />
-</head>
-<body>
-  <main>
-    <a href="./" class="btn">Home</a>
-    <h1>Getting Started</h1>
-    <p>Get up and running with Kempo Server in just a few steps.</p>
-    <h2>Installation</h2>
-    <p>1. Install the npm package.</p>
-    <pre><code>npm install kempo-server</code></pre>
-    <p>2. Add it to your <code>package.json</code> scripts, use the <code>--root</code> flag to tell it where the root of your site is.</p>
-    <pre><code class="hljs json">{<br />  ...<br />  <span class="hljs-attr">"scripts"</span>: {<br />    <span class="hljs-attr">"start"</span>: <span class="hljs-string">"kempo-server --root public"</span><br />  }<br />  ...<br />}</code></pre>
-    <p>3. Run it in your terminal.</p>
-    <pre><code>npm run start</code></pre>
-    <h2>Basic Project Structure</h2>
-    <p>Once installed, create a basic project structure:</p>
-    <pre><code class="hljs markdown">my-project/<br />├─ public/             # Your web root<br />│  ├─ index.html       # Homepage<br />│  ├─ styles.css       # CSS files<br />│  ├─ api/             # API routes<br />│  │  ├─ hello/<br />│  │  │  ├─ GET.js     # GET /api/hello/<br />│  │  ├─ users/<br />│  │  │  ├─ GET.js     # GET /api/users/<br />│  │  │  ├─ POST.js    # POST /api/users/<br />├─ package.json<br />├─ .config.json        # Optional configuration<br /></code></pre>
-    <h2>Your First Route</h2>
-    <p>Create a simple API endpoint:</p>
-    <h3>1. Create the directory structure</h3>
-    <pre><code>mkdir -p public/api/hello</code></pre>
-    <h3>2. Create your first route file</h3>
-    <p>Create <code>public/api/hello/GET.js</code>:</p>
-    <pre><code class="hljs javascript"><span class="hljs-comment">// public/api/hello/GET.js</span><br /><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">request, response</span>) </span>{<br />  <span class="hljs-keyword">const</span> { name } = request.query;<br />  <span class="hljs-keyword">const</span> message = name ? <span class="hljs-string">`Hello ${name}!`</span> : <span class="hljs-string">'Hello World!'</span>;<br />  <br />  response.json({ message, timestamp: <span class="hljs-keyword">new</span> <span class="hljs-built_in">Date</span>().toISOString() });<br />}</code></pre>
-    <h3>3. Test your route</h3>
-    <p>Start your server and visit:</p>
-    <ul>
-      <li><code>http://localhost:3000/api/hello/</code></li>
-      <li><code>http://localhost:3000/api/hello/?name=World</code></li>
-    </ul>
-    <h2>Command Line Options</h2>
-    <p>Kempo Server supports several command line options:</p>
-    <ul>
-      <li><code>--root &lt;path&gt;</code> - Set the document root directory (required)</li>
-      <li><code>--port &lt;number&gt;</code> - Set the port number (default: 3000)</li>
-      <li><code>--host &lt;address&gt;</code> - Set the host address (default: localhost)</li>
-      <li><code>--verbose</code> - Enable verbose logging</li>
-    </ul>
-    <p>Example:</p>
-    <pre><code>kempo-server --root public --port 8080 --host 0.0.0.0 --verbose</code></pre>
-    <h2>What's Next?</h2>
-    <p>Now that you have Kempo Server running, explore these topics:</p>
-    <ul>
-      <li><a href="routing.html">Learn about Routes & Routing</a> - File-based routing, dynamic routes, and HTML routes</li>
-      <li><a href="request-response.html">Request & Response Objects</a> - Working with HTTP requests and responses</li>
-      <li><a href="configuration.html">Configuration</a> - Customize server behavior</li>
-      <li><a href="middleware.html">Middleware</a> - Add authentication, logging, CORS, and more</li>
-      <li><a href="examples.html">Examples & Demos</a> - See real-world examples in action</li>
-    </ul>
-  </main>
-  <div style="height:25vh"></div>
-</body>
-</html>
+<html lang="en" theme="auto">
+<head>
+  <meta charset='utf-8'>
+  <meta http-equiv='X-UA-Compatible' content='IE=edge'>
+  <title>Getting Started - Kempo Server</title>
+  <meta name='viewport' content='width=device-width, initial-scale=1'>
+  <link rel="icon" type="image/png" sizes="48x48" href="media/icon48.png">
+  <link rel="manifest" href="manifest.json">
+  <link rel="stylesheet" href="essential.css" />
+</head>
+<body>
+  <main>
+    <a href="./" class="btn">Home</a>
+    <h1>Getting Started</h1>
+    <p>Get up and running with Kempo Server in just a few steps.</p>
+    <h2>Installation</h2>
+    <p>1. Install the npm package.</p>
+    <pre><code>npm install kempo-server</code></pre>
+    <p>2. Add it to your <code>package.json</code> scripts, use the <code>--root</code> flag to tell it where the root of your site is.</p>
+    <pre><code class="hljs json">{<br />  ...<br />  <span class="hljs-attr">"scripts"</span>: {<br />    <span class="hljs-attr">"start"</span>: <span class="hljs-string">"kempo-server --root public"</span><br />  }<br />  ...<br />}</code></pre>
+    <p>3. Run it in your terminal.</p>
+    <pre><code>npm run start</code></pre>
+    <h2>Basic Project Structure</h2>
+    <p>Once installed, create a basic project structure:</p>
+    <pre><code class="hljs markdown">my-project/<br />├─ public/             # Your web root<br />│  ├─ index.html       # Homepage<br />│  ├─ styles.css       # CSS files<br />│  ├─ api/             # API routes<br />│  │  ├─ hello/<br />│  │  │  ├─ GET.js     # GET /api/hello/<br />│  │  ├─ users/<br />│  │  │  ├─ GET.js     # GET /api/users/<br />│  │  │  ├─ POST.js    # POST /api/users/<br />├─ package.json<br />├─ .config.json        # Optional configuration<br /></code></pre>
+    <h2>Your First Route</h2>
+    <p>Create a simple API endpoint:</p>
+    <h3>1. Create the directory structure</h3>
+    <pre><code>mkdir -p public/api/hello</code></pre>
+    <h3>2. Create your first route file</h3>
+    <p>Create <code>public/api/hello/GET.js</code>:</p>
+    <pre><code class="hljs javascript"><span class="hljs-comment">// public/api/hello/GET.js</span><br /><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> <span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">request, response</span>) </span>{<br />  <span class="hljs-keyword">const</span> { name } = request.query;<br />  <span class="hljs-keyword">const</span> message = name ? <span class="hljs-string">`Hello ${name}!`</span> : <span class="hljs-string">'Hello World!'</span>;<br />  <br />  response.json({ message, timestamp: <span class="hljs-keyword">new</span> <span class="hljs-built_in">Date</span>().toISOString() });<br />}</code></pre>
+    <h3>3. Test your route</h3>
+    <p>Start your server and visit:</p>
+    <ul>
+      <li><code>http://localhost:3000/api/hello/</code></li>
+      <li><code>http://localhost:3000/api/hello/?name=World</code></li>
+    </ul>
+    <h2>Command Line Options</h2>
+    <p>Kempo Server supports several command line options:</p>
+    <ul>
+      <li><code>--root &lt;path&gt;</code> - Set the document root directory (required)</li>
+      <li><code>--port &lt;number&gt;</code> - Set the port number (default: 3000)</li>
+      <li><code>--host &lt;address&gt;</code> - Set the host address (default: localhost)</li>
+      <li><code>--verbose</code> - Enable verbose logging</li>
+    </ul>
+    <p>Example:</p>
+    <pre><code>kempo-server --root public --port 8080 --host 0.0.0.0 --verbose</code></pre>
+    <h2>What's Next?</h2>
+    <p>Now that you have Kempo Server running, explore these topics:</p>
+    <ul>
+      <li><a href="routing.html">Learn about Routes & Routing</a> - File-based routing, dynamic routes, and HTML routes</li>
+      <li><a href="request-response.html">Request & Response Objects</a> - Working with HTTP requests and responses</li>
+      <li><a href="configuration.html">Configuration</a> - Customize server behavior</li>
+      <li><a href="middleware.html">Middleware</a> - Add authentication, logging, CORS, and more</li>
+      <li><a href="examples.html">Examples & Demos</a> - See real-world examples in action</li>
+    </ul>
+  </main>
+  <div style="height:25vh"></div>
+</body>
+</html>

package/docs/index.html CHANGED Viewed

@@ -1,81 +1,81 @@
-<html lang="en" theme="auto">
-<head>
-  <meta charset='utf-8'>
-  <meta http-equiv='X-UA-Compatible' content='IE=edge'>
-  <title>Kempo Server - Documentation</title>
-  <meta name='viewport' content='width=device-width, initial-scale=1'>
-  <link rel="icon" type="image/png" sizes="48x48" href="media/icon48.png">
-  <link rel="manifest" href="manifest.json">
-  <link rel="stylesheet" href="essential.css" />
-</head>
-<body>
-  <main>
-    <h1 class="ta-center">Kempo Server</h1>
-    <div class="ta-center">
-      <p class="mb0">
-        <a href="https://github.com/dustinpoissant/kempo-server" class="btn primary mr" target="_blank">GitHub</a>
-        <a href="https://www.npmjs.com/package/kempo-server" class="btn" target="_blank">NPM</a>
-      </p>
-    </div>
-    <p>A lightweight, zero-dependency, file based routing server.</p>
-    <nav class="b r mb p">
-      <div class="row -mx">
-        <div class="col m-span-12 d-span-6 px">
-          <h4 class="mt0">Getting Started</h4>
-          <ul>
-            <li><a href="getting-started.html">Getting Started</a></li>
-            <li><a href="routing.html">Routes & Routing</a></li>
-            <li><a href="request-response.html">Request & Response</a></li>
-          </ul>
-        </div>
-        <div class="col m-span-12 d-span-6 px">
-          <h4 class="mt0">Advanced Features</h4>
-          <ul>
-            <li><a href="configuration.html">Configuration</a></li>
-            <li><a href="middleware.html">Middleware</a></li>
-            <li><a href="examples.html">Examples & Demos</a></li>
-          </ul>
-        </div>
-      </div>
-    </nav>
-    <div class="b r mb p">
-      <h3 class="mt0">Quick Start</h3>
-      <p>Install and run Kempo Server in seconds:</p>
-      <pre><code>npm install kempo-server
-npx kempo-server --root public</code></pre>
-    </div>
-    <div class="row -mx mb">
-      <div class="col m-span-12 d-span-6 px">
-        <div class="b r p">
-          <h4 class="mt0">Features</h4>
-          <ul>
-            <li><strong>Zero Dependencies</strong> - No external dependencies</li>
-            <li><strong>File-based Routing</strong> - Directory structure defines routes</li>
-            <li><strong>Dynamic Routes</strong> - Parameterized routes with [brackets]</li>
-            <li><strong>Wildcard Routes</strong> - Map directories with * patterns</li>
-            <li><strong>Middleware System</strong> - Authentication, CORS, logging, and more</li>
-            <li><strong>Request/Response Objects</strong> - Enhanced request handling</li>
-          </ul>
-        </div>
-      </div>
-      <div class="col m-span-12 d-span-6 px">
-        <div class="b r p">
-          <h4 class="mt0">Built-in Middleware</h4>
-          <ul>
-            <li><strong>CORS</strong> - Cross-origin resource sharing</li>
-            <li><strong>Compression</strong> - Automatic gzip compression</li>
-            <li><strong>Rate Limiting</strong> - Request throttling</li>
-            <li><strong>Security Headers</strong> - Security best practices</li>
-            <li><strong>Request Logging</strong> - Configurable logging</li>
-            <li><strong>Custom Middleware</strong> - Load your own middleware</li>
-          </ul>
-        </div>
-      </div>
-    </div>
-  </main>
-  <div style="height:25vh"></div>
-</body>
-</html>
+<html lang="en" theme="auto">
+<head>
+  <meta charset='utf-8'>
+  <meta http-equiv='X-UA-Compatible' content='IE=edge'>
+  <title>Kempo Server - Documentation</title>
+  <meta name='viewport' content='width=device-width, initial-scale=1'>
+  <link rel="icon" type="image/png" sizes="48x48" href="media/icon48.png">
+  <link rel="manifest" href="manifest.json">
+  <link rel="stylesheet" href="essential.css" />
+</head>
+<body>
+  <main>
+    <h1 class="ta-center">Kempo Server</h1>
+    <div class="ta-center">
+      <p class="mb0">
+        <a href="https://github.com/dustinpoissant/kempo-server" class="btn primary mr" target="_blank">GitHub</a>
+        <a href="https://www.npmjs.com/package/kempo-server" class="btn" target="_blank">NPM</a>
+      </p>
+    </div>
+    <p>A lightweight, zero-dependency, file based routing server.</p>
+    <nav class="b r mb p">
+      <div class="row -mx">
+        <div class="col m-span-12 d-span-6 px">
+          <h4 class="mt0">Getting Started</h4>
+          <ul>
+            <li><a href="getting-started.html">Getting Started</a></li>
+            <li><a href="routing.html">Routes & Routing</a></li>
+            <li><a href="request-response.html">Request & Response</a></li>
+          </ul>
+        </div>
+        <div class="col m-span-12 d-span-6 px">
+          <h4 class="mt0">Advanced Features</h4>
+          <ul>
+            <li><a href="configuration.html">Configuration</a></li>
+            <li><a href="middleware.html">Middleware</a></li>
+            <li><a href="examples.html">Examples & Demos</a></li>
+          </ul>
+        </div>
+      </div>
+    </nav>
+    <div class="b r mb p">
+      <h3 class="mt0">Quick Start</h3>
+      <p>Install and run Kempo Server in seconds:</p>
+      <pre><code>npm install kempo-server
+npx kempo-server --root public</code></pre>
+    </div>
+    <div class="row -mx mb">
+      <div class="col m-span-12 d-span-6 px">
+        <div class="b r p">
+          <h4 class="mt0">Features</h4>
+          <ul>
+            <li><strong>Zero Dependencies</strong> - No external dependencies</li>
+            <li><strong>File-based Routing</strong> - Directory structure defines routes</li>
+            <li><strong>Dynamic Routes</strong> - Parameterized routes with [brackets]</li>
+            <li><strong>Wildcard Routes</strong> - Map directories with * patterns</li>
+            <li><strong>Middleware System</strong> - Authentication, CORS, logging, and more</li>
+            <li><strong>Request/Response Objects</strong> - Enhanced request handling</li>
+          </ul>
+        </div>
+      </div>
+      <div class="col m-span-12 d-span-6 px">
+        <div class="b r p">
+          <h4 class="mt0">Built-in Middleware</h4>
+          <ul>
+            <li><strong>CORS</strong> - Cross-origin resource sharing</li>
+            <li><strong>Compression</strong> - Automatic gzip compression</li>
+            <li><strong>Rate Limiting</strong> - Request throttling</li>
+            <li><strong>Security Headers</strong> - Security best practices</li>
+            <li><strong>Request Logging</strong> - Configurable logging</li>
+            <li><strong>Custom Middleware</strong> - Load your own middleware</li>
+          </ul>
+        </div>
+      </div>
+    </div>
+  </main>
+  <div style="height:25vh"></div>
+</body>
+</html>

package/docs/manifest.json CHANGED Viewed

@@ -1,87 +1,87 @@
-{
-  "name": "Kempo Server",
-  "short_name": "Kempo Server",
-  "description": "A lightweight, zero-dependency, file based routing server",
-  "start_url": "/",
-  "display": "standalone",
-  "background_color": "#ffffff",
-  "theme_color": "#000000",
-  "orientation": "portrait-primary",
-  "scope": "/",
-  "lang": "en",
-  "categories": ["developer", "utilities"],
-  "icons": [
-    {
-      "src": "media/icon16.png",
-      "sizes": "16x16",
-      "type": "image/png"
-    },
-    {
-      "src": "media/icon32.png",
-      "sizes": "32x32",
-      "type": "image/png"
-    },
-    {
-      "src": "media/icon48.png",
-      "sizes": "48x48",
-      "type": "image/png"
-    },
-    {
-      "src": "media/icon64.png",
-      "sizes": "64x64",
-      "type": "image/png"
-    },
-    {
-      "src": "media/icon72.png",
-      "sizes": "72x72",
-      "type": "image/png"
-    },
-    {
-      "src": "media/icon96.png",
-      "sizes": "96x96",
-      "type": "image/png"
-    },
-    {
-      "src": "media/icon128.png",
-      "sizes": "128x128",
-      "type": "image/png"
-    },
-    {
-      "src": "media/icon144.png",
-      "sizes": "144x144",
-      "type": "image/png"
-    },
-    {
-      "src": "media/icon152.png",
-      "sizes": "152x152",
-      "type": "image/png"
-    },
-    {
-      "src": "media/icon192.png",
-      "sizes": "192x192",
-      "type": "image/png",
-      "purpose": "maskable"
-    },
-    {
-      "src": "media/icon256.png",
-      "sizes": "256x256",
-      "type": "image/png"
-    },
-    {
-      "src": "media/icon384.png",
-      "sizes": "384x384",
-      "type": "image/png"
-    },
-    {
-      "src": "media/icon-maskable.png",
-      "sizes": "512x512",
-      "type": "image/png",
-      "purpose": "maskable"
-    },
-    {
-      "src": "media/icon.svg",
-      "sizes": "any",
-      "type": "image/svg+xml"
-    }
-  ]
-}
+{
+  "name": "Kempo Server",
+  "short_name": "Kempo Server",
+  "description": "A lightweight, zero-dependency, file based routing server",
+  "start_url": "/",
+  "display": "standalone",
+  "background_color": "#ffffff",
+  "theme_color": "#000000",
+  "orientation": "portrait-primary",
+  "scope": "/",
+  "lang": "en",
+  "categories": ["developer", "utilities"],
+  "icons": [
+    {
+      "src": "media/icon16.png",
+      "sizes": "16x16",
+      "type": "image/png"
+    },
+    {
+      "src": "media/icon32.png",
+      "sizes": "32x32",
+      "type": "image/png"
+    },
+    {
+      "src": "media/icon48.png",
+      "sizes": "48x48",
+      "type": "image/png"
+    },
+    {
+      "src": "media/icon64.png",
+      "sizes": "64x64",
+      "type": "image/png"
+    },
+    {
+      "src": "media/icon72.png",
+      "sizes": "72x72",
+      "type": "image/png"
+    },
+    {
+      "src": "media/icon96.png",
+      "sizes": "96x96",
+      "type": "image/png"
+    },
+    {
+      "src": "media/icon128.png",
+      "sizes": "128x128",
+      "type": "image/png"
+    },
+    {
+      "src": "media/icon144.png",
+      "sizes": "144x144",
+      "type": "image/png"
+    },
+    {
+      "src": "media/icon152.png",
+      "sizes": "152x152",
+      "type": "image/png"
+    },
+    {
+      "src": "media/icon192.png",
+      "sizes": "192x192",
+      "type": "image/png",
+      "purpose": "maskable"
+    },
+    {
+      "src": "media/icon256.png",
+      "sizes": "256x256",
+      "type": "image/png"
+    },
+    {
+      "src": "media/icon384.png",
+      "sizes": "384x384",
+      "type": "image/png"
+    },
+    {
+      "src": "media/icon-maskable.png",
+      "sizes": "512x512",
+      "type": "image/png",
+      "purpose": "maskable"
+    },
+    {
+      "src": "media/icon.svg",
+      "sizes": "any",
+      "type": "image/svg+xml"
+    }
+  ]
+}