mikroserve 0.0.8 → 0.0.10

package/README.md

@@ -18,7 +18,7 @@
 - Supports custom middlewares
 - Out-of-the-box CORS support
 - Built-in customizable rate limiter
-- Tiny (5kb gzipped)
+- Tiny (~5kb gzipped)
 - Only a single dependency: [MikroConf](https://github.com/mikaelvesavuori/mikroconf)
 
 ## Installation
@@ -40,8 +40,24 @@ import { MikroServe, type Context } from 'mikroserve';
 const api = new MikroServe();
 
 // Add any routes that should be exposed
+
 // This will expose a GET route on the root of the API, responding with plain text
-api.get('/', (c: Context) => c.text('Hello world!'));
+api.get('/', async (c: Context) => c.text('Hello world!'));
+
+// JSON responses are as easy as...
+api.get('/users/:userId', async (c: Context) => c.json({ name: 'Sam Person', id: 'abc123', createdAt: 1743323168 }));
+
+// Example POST request with JSON response and custom status code
+api.post('/users/:userId', async (c: Context) => {
+  const { name } = c.body; // Body is ready to use, no need for parsing
+  const userId = c.params.userId;
+
+  // Do your things...
+
+  return c.json({ success: true }, 201);
+});
+
+// MikroServe supports raw, binary, text, form, json, html, redirect response types
 
 // Start the server
 api.start();
@@ -76,8 +92,8 @@ const api = new MikroServe({
 });
 
 // Define a global middleware for logging
-api.use(async (ctx, next) => {
-  console.log(`Request received: ${ctx.req.method} ${ctx.path}`);
+api.use(async (c, next) => {
+  console.log(`Request received: ${c.req.method} ${c.path}`);
   const start = Date.now();
   const response = await next();
   const duration = Date.now() - start;
@@ -86,11 +102,11 @@ api.use(async (ctx, next) => {
 });
 
 // Define a auth middleware
-const requireAuth = async (ctx, next) => {
-  const token = ctx.headers.authorization?.replace('Bearer ', '');
+const requireAuth = async (c, next) => {
+  const token = c.headers.authorization?.replace('Bearer ', '');
 
   if (!token) {
-    return ctx.status(401).json({
+    return c.status(401).json({
       error: 'Unauthorized',
       message: 'Authentication required'
     });
@@ -99,14 +115,14 @@ const requireAuth = async (ctx, next) => {
   // Validate token logic would go here
   // For this example, we'll just check if it's "valid-token"
   if (token !== 'valid-token') {
-    return ctx.status(401).json({
+    return c.status(401).json({
       error: 'Unauthorized',
       message: 'Invalid authentication token'
     });
   }
 
   // Set user on context for downstream handlers
-  ctx.user = { id: '123', name: 'Example User' };
+  c.user = { id: '123', name: 'Example User' };
 
   return next();
 };
@@ -192,6 +208,7 @@ All of the settings already presented in the above examples can be provided in m
 | --port       | `<number>`                  | port                        | PORT                 |
 | --host       | `<string>`                  | host                        | HOST                 |
 | --https      | none (is flag)              | useHttps                    |                      |
+| --http2      | none (is flag)              | useHttp2                    |                      |
 | --cert       | `<string>`                  | sslCert                     |                      |
 | --key        | `<string>`                  | sslKey                      |                      |
 | --ca         | `<string>`                  | sslCa                       |                      |

package/lib/MikroServe.js

@@ -438,7 +438,7 @@ var MikroServe = class {
     this.setupGracefulShutdown(server);
     server.listen(port, host, () => {
       const address = server.address();
-      const protocol = this.config.useHttps ? "https" : "http";
+      const protocol = this.config.useHttps || this.config.useHttp2 ? "https" : "http";
       console.log(
         `MikroServe running at ${protocol}://${address.address !== "::" ? address.address : "localhost"}:${address.port}`
       );

package/lib/MikroServe.mjs

@@ -1,6 +1,6 @@
 import {
   MikroServe
-} from "./chunk-SLBFEKEH.mjs";
+} from "./chunk-TQN6BEGA.mjs";
 import "./chunk-ZFBBESGU.mjs";
 import "./chunk-GUYBTPZH.mjs";
 import "./chunk-YOHL3T54.mjs";

package/lib/{chunk-SLBFEKEH.mjs → chunk-TQN6BEGA.mjs}

@@ -91,7 +91,7 @@ var MikroServe = class {
     this.setupGracefulShutdown(server);
     server.listen(port, host, () => {
       const address = server.address();
-      const protocol = this.config.useHttps ? "https" : "http";
+      const protocol = this.config.useHttps || this.config.useHttp2 ? "https" : "http";
       console.log(
         `MikroServe running at ${protocol}://${address.address !== "::" ? address.address : "localhost"}:${address.port}`
       );

package/lib/index.js

@@ -440,7 +440,7 @@ var MikroServe = class {
     this.setupGracefulShutdown(server);
     server.listen(port, host, () => {
       const address = server.address();
-      const protocol = this.config.useHttps ? "https" : "http";
+      const protocol = this.config.useHttps || this.config.useHttp2 ? "https" : "http";
       console.log(
         `MikroServe running at ${protocol}://${address.address !== "::" ? address.address : "localhost"}:${address.port}`
       );

package/lib/index.mjs

@@ -1,6 +1,6 @@
 import {
   MikroServe
-} from "./chunk-SLBFEKEH.mjs";
+} from "./chunk-TQN6BEGA.mjs";
 import "./chunk-ZFBBESGU.mjs";
 import "./chunk-GUYBTPZH.mjs";
 import "./chunk-YOHL3T54.mjs";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mikroserve",
   "description": "Minimalistic, ready-to-use API, built on Node.js primitives.",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "author": "Mikael Vesavuori",
   "license": "MIT",
   "keywords": [
@@ -35,7 +35,6 @@
     "mikroserve": "lib/index.js"
   },
   "scripts": {
-    "start": "npx tsx src/index.ts",
     "test": "npm run test:licenses && npm run test:types && npm run lint && npm run test:unit",
     "test:types": "npx type-coverage --at-least 85 --strict --ignore-files \"tests/**/*.ts\" --ignore-files \"*.ts\" --ignore-files \"src/application/errors/*.ts\" --ignore-files \"testdata/*.ts\"",
     "test:licenses": "npx license-compliance --direct --allow 'MIT;ISC;0BSD;BSD-2-Clause;BSD-3-Clause;Apache-2.0;Unlicense;CC0-1.0'",