mikroserve 0.0.6 → 0.0.8

package/README.md

@@ -2,18 +2,23 @@
 
 **Minimalistic, ready-to-use API, built on Node.js primitives**.
 
+[![npm version](https://img.shields.io/npm/v/mikroserve.svg)](https://www.npmjs.com/package/mikroserve)
+
+[![bundle size](https://img.shields.io/bundlephobia/minzip/mikroserve)](https://bundlephobia.com/package/mikroserve)
+
 ![Build Status](https://github.com/mikaelvesavuori/mikroserve/workflows/main/badge.svg)
-[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
 ---
 
 - Native Node.js [http](https://nodejs.org/api/http.html)/[https](https://nodejs.org/api/https.html) implementation, meaning maximum performance
 - [Hono](https://hono.dev)-style API semantics for GET, POST, PATCH, PUT, DELETE operations
-- Supports being exposed over both HTTP and HTTPS
+- Supports being exposed over HTTP, HTTPS, and HTTP2
 - Supports custom middlewares
 - Out-of-the-box CORS support
 - Built-in customizable rate limiter
-- Tiny (~4.8kb gzipped)
+- Tiny (5kb gzipped)
 - Only a single dependency: [MikroConf](https://github.com/mikaelvesavuori/mikroconf)
 
 ## Installation
@@ -42,7 +47,8 @@ api.get('/', (c: Context) => c.text('Hello world!'));
 api.start();
 
 // The API is ready – go ahead and curl it in your command line of choice
-// curl 0.0.0.0:3000
+// HTTP: curl 0.0.0.0:3000
+// HTTPS or HTTP2: curl -k 0.0.0.0:3000
 // The response should be "Hello world!"
 ```
 
@@ -57,6 +63,7 @@ const api = new MikroServe({
   port: 3000,
   host: '0.0.0.0',
   useHttps: false,
+  useHttp2: false,
   sslCert: '',
   sslKey: '',
   sslCa: '',

package/lib/MikroServe.d.mts

@@ -1,6 +1,7 @@
-import http from 'node:http';
-import https from 'node:https';
-import { MikroServeOptions, Middleware, RouteHandler } from './interfaces/index.mjs';
+import { MikroServeOptions, Middleware, RouteHandler, ServerType } from './interfaces/index.mjs';
+import 'node:http';
+import 'node:http2';
+import 'node:https';
 
 /**
  * @description MikroServe manages HTTP server operations with routing.
@@ -44,11 +45,11 @@ declare class MikroServe {
     /**
      * @description Creates an HTTP/HTTPS server, sets up graceful shutdown, and starts listening.
      */
-    start(): http.Server | https.Server;
+    start(): ServerType;
     /**
      * @description Creates and configures a server instance without starting it.
      */
-    createServer(): http.Server | https.Server;
+    createServer(): ServerType;
     /**
      * @description Rate limiting middleware.
      */
@@ -80,7 +81,7 @@ declare class MikroServe {
     /**
      * @description Sets up graceful shutdown handlers for a server.
      */
-    setupGracefulShutdown(server: http.Server | https.Server): void;
+    setupGracefulShutdown(server: ServerType): void;
 }
 
 export { MikroServe };

package/lib/MikroServe.d.ts

@@ -1,6 +1,7 @@
-import http from 'node:http';
-import https from 'node:https';
-import { MikroServeOptions, Middleware, RouteHandler } from './interfaces/index.js';
+import { MikroServeOptions, Middleware, RouteHandler, ServerType } from './interfaces/index.js';
+import 'node:http';
+import 'node:http2';
+import 'node:https';
 
 /**
  * @description MikroServe manages HTTP server operations with routing.
@@ -44,11 +45,11 @@ declare class MikroServe {
     /**
      * @description Creates an HTTP/HTTPS server, sets up graceful shutdown, and starts listening.
      */
-    start(): http.Server | https.Server;
+    start(): ServerType;
     /**
      * @description Creates and configures a server instance without starting it.
      */
-    createServer(): http.Server | https.Server;
+    createServer(): ServerType;
     /**
      * @description Rate limiting middleware.
      */
@@ -80,7 +81,7 @@ declare class MikroServe {
     /**
      * @description Sets up graceful shutdown handlers for a server.
      */
-    setupGracefulShutdown(server: http.Server | https.Server): void;
+    setupGracefulShutdown(server: ServerType): void;
 }
 
 export { MikroServe };

package/lib/MikroServe.js

@@ -35,8 +35,9 @@ __export(MikroServe_exports, {
 module.exports = __toCommonJS(MikroServe_exports);
 var import_node_fs = require("fs");
 var import_node_http = __toESM(require("http"));
+var import_node_http2 = __toESM(require("http2"));
 var import_node_https = __toESM(require("https"));
-var import_mikroconf = require("mikroconf");
+var import_mikroconf2 = require("mikroconf");
 
 // src/RateLimiter.ts
 var RateLimiter = class {
@@ -205,6 +206,16 @@ var Router = class {
       path,
       state: {},
       // Add the missing state property
+      raw: () => res,
+      binary: (content, contentType = "application/octet-stream", status = 200) => ({
+        statusCode: status,
+        body: content,
+        headers: {
+          "Content-Type": contentType,
+          "Content-Length": content.length.toString()
+        },
+        isRaw: true
+      }),
       text: (content, status = 200) => ({
         statusCode: status,
         body: content,
@@ -232,6 +243,16 @@ var Router = class {
       }),
       status: function(code) {
         return {
+          raw: () => res,
+          binary: (content, contentType = "application/octet-stream") => ({
+            statusCode: code,
+            body: content,
+            headers: {
+              "Content-Type": contentType,
+              "Content-Length": content.length.toString()
+            },
+            isRaw: true
+          }),
           text: (content) => ({
             statusCode: code,
             body: content,
@@ -281,11 +302,8 @@ var Router = class {
   }
 };
 
-// src/utils/getTruthyValue.ts
-function getTruthyValue(value) {
-  if (value === "true" || value === true) return true;
-  return false;
-}
+// src/config.ts
+var import_mikroconf = require("mikroconf");
 
 // src/utils/configDefaults.ts
 var configDefaults = () => {
@@ -293,6 +311,7 @@ var configDefaults = () => {
     port: Number(process.env.PORT) || 3e3,
     host: process.env.HOST || "0.0.0.0",
     useHttps: false,
+    useHttp2: false,
     sslCert: "",
     sslKey: "",
     sslCa: "",
@@ -304,6 +323,45 @@ var configDefaults = () => {
     allowedDomains: ["*"]
   };
 };
+function getTruthyValue(value) {
+  if (value === "true" || value === true) return true;
+  return false;
+}
+
+// src/config.ts
+var defaults = configDefaults();
+var baseConfig = (options) => ({
+  configFilePath: "mikroserve.config.json",
+  args: process.argv,
+  options: [
+    { flag: "--port", path: "port", defaultValue: defaults.port },
+    { flag: "--host", path: "host", defaultValue: defaults.host },
+    { flag: "--https", path: "useHttps", defaultValue: defaults.useHttps, isFlag: true },
+    { flag: "--http2", path: "useHttp2", defaultValue: defaults.useHttp2, isFlag: true },
+    { flag: "--cert", path: "sslCert", defaultValue: defaults.sslCert },
+    { flag: "--key", path: "sslKey", defaultValue: defaults.sslKey },
+    { flag: "--ca", path: "sslCa", defaultValue: defaults.sslCa },
+    {
+      flag: "--ratelimit",
+      path: "rateLimit.enabled",
+      defaultValue: defaults.rateLimit.enabled,
+      isFlag: true
+    },
+    {
+      flag: "--rps",
+      path: "rateLimit.requestsPerMinute",
+      defaultValue: defaults.rateLimit.requestsPerMinute
+    },
+    {
+      flag: "--allowed",
+      path: "allowedDomains",
+      defaultValue: defaults.allowedDomains,
+      parser: import_mikroconf.parsers.array
+    },
+    { flag: "--debug", path: "debug", defaultValue: defaults.debug, isFlag: true }
+  ],
+  config: options
+});
 
 // src/MikroServe.ts
 var MikroServe = class {
@@ -314,42 +372,11 @@ var MikroServe = class {
    * @description Creates a new MikroServe instance.
    */
   constructor(options) {
-    const defaults = configDefaults();
-    const config = new import_mikroconf.MikroConf({
-      configFilePath: "mikroserve.config.json",
-      args: process.argv,
-      options: [
-        { flag: "--port", path: "port", defaultValue: defaults.port },
-        { flag: "--host", path: "host", defaultValue: defaults.host },
-        { flag: "--https", path: "useHttps", defaultValue: defaults.useHttps, isFlag: true },
-        { flag: "--cert", path: "sslCert", defaultValue: defaults.sslCert },
-        { flag: "--key", path: "sslKey", defaultValue: defaults.sslKey },
-        { flag: "--ca", path: "sslCa", defaultValue: defaults.sslCa },
-        {
-          flag: "--ratelimit",
-          path: "rateLimit.enabled",
-          defaultValue: defaults.rateLimit.enabled,
-          isFlag: true
-        },
-        {
-          flag: "--rps",
-          path: "rateLimit.requestsPerMinute",
-          defaultValue: defaults.rateLimit.requestsPerMinute
-        },
-        {
-          flag: "--allowed",
-          path: "allowedDomains",
-          defaultValue: defaults.allowedDomains,
-          parser: import_mikroconf.parsers.array
-        },
-        { flag: "--debug", path: "debug", defaultValue: defaults.debug, isFlag: true }
-      ],
-      config: options
-    }).get();
+    const config = new import_mikroconf2.MikroConf(baseConfig(options || {})).get();
     if (config.debug) console.log("Using configuration:", config);
     this.config = config;
     this.router = new Router();
-    const requestsPerMinute = config.rateLimit.requestsPerMinute || defaults.rateLimit.requestsPerMinute;
+    const requestsPerMinute = config.rateLimit.requestsPerMinute || configDefaults().rateLimit.requestsPerMinute;
     this.rateLimiter = new RateLimiter(requestsPerMinute, 60);
     if (config.rateLimit.enabled === true) this.use(this.rateLimitMiddleware.bind(this));
   }
@@ -423,7 +450,22 @@ var MikroServe = class {
    */
   createServer() {
     const boundRequestHandler = this.requestHandler.bind(this);
-    if (this.config.useHttps) {
+    if (this.config.useHttp2) {
+      if (!this.config.sslCert || !this.config.sslKey)
+        throw new Error("SSL certificate and key paths are required when useHttp2 is true");
+      try {
+        const httpsOptions = {
+          key: (0, import_node_fs.readFileSync)(this.config.sslKey),
+          cert: (0, import_node_fs.readFileSync)(this.config.sslCert),
+          ...this.config.sslCa ? { ca: (0, import_node_fs.readFileSync)(this.config.sslCa) } : {}
+        };
+        return import_node_http2.default.createSecureServer(httpsOptions, boundRequestHandler);
+      } catch (error) {
+        if (error.message.includes("key values mismatch"))
+          throw new Error(`SSL certificate and key do not match: ${error.message}`);
+        throw error;
+      }
+    } else if (this.config.useHttps) {
       if (!this.config.sslCert || !this.config.sslKey)
         throw new Error("SSL certificate and key paths are required when useHttps is true");
       try {
@@ -477,8 +519,14 @@ var MikroServe = class {
       this.setSecurityHeaders(res, this.config.useHttps);
       if (isDebug) console.log(`${method} ${url}`);
       if (req.method === "OPTIONS") {
-        res.statusCode = 204;
-        res.end();
+        if (res instanceof import_node_http.default.ServerResponse) {
+          res.statusCode = 204;
+          res.end();
+        } else {
+          const h2Res = res;
+          h2Res.writeHead(204);
+          h2Res.end();
+        }
         return;
       }
       try {
@@ -603,14 +651,24 @@ var MikroServe = class {
    * @description Set security headers.
    */
   setSecurityHeaders(res, isHttps = false) {
-    res.setHeader("X-Content-Type-Options", "nosniff");
-    res.setHeader("X-Frame-Options", "DENY");
-    res.setHeader(
-      "Content-Security-Policy",
-      "default-src 'self'; script-src 'self'; object-src 'none'"
-    );
-    if (isHttps) res.setHeader("Strict-Transport-Security", "max-age=31536000; includeSubDomains");
-    res.setHeader("X-XSS-Protection", "1; mode=block");
+    const securityHeaders = {
+      "X-Content-Type-Options": "nosniff",
+      "X-Frame-Options": "DENY",
+      "Content-Security-Policy": "default-src 'self'; script-src 'self'; object-src 'none'",
+      "X-XSS-Protection": "1; mode=block"
+    };
+    if (isHttps || this.config.useHttp2)
+      securityHeaders["Strict-Transport-Security"] = "max-age=31536000; includeSubDomains";
+    if (res instanceof import_node_http.default.ServerResponse) {
+      Object.entries(securityHeaders).forEach(([name, value]) => {
+        res.setHeader(name, value);
+      });
+    } else {
+      const h2Res = res;
+      Object.entries(securityHeaders).forEach(([name, value]) => {
+        h2Res.setHeader(name, value);
+      });
+    }
   }
   /**
    * @description Sends a response with appropriate headers.
@@ -619,10 +677,23 @@ var MikroServe = class {
     const headers = {
       ...response.headers || {}
     };
-    res.writeHead(response.statusCode, headers);
-    if (response.body === null || response.body === void 0) res.end();
-    else if (typeof response.body === "string") res.end(response.body);
-    else res.end(JSON.stringify(response.body));
+    const hasWriteHead = (res2) => {
+      return typeof res2.writeHead === "function" && typeof res2.end === "function";
+    };
+    if (hasWriteHead(res)) {
+      res.writeHead(response.statusCode, headers);
+      if (response.body === null || response.body === void 0) res.end();
+      else if (response.isRaw) res.end(response.body);
+      else if (typeof response.body === "string") res.end(response.body);
+      else res.end(JSON.stringify(response.body));
+    } else {
+      console.warn("Unexpected response object type without writeHead/end methods");
+      res.writeHead?.(response.statusCode, headers);
+      if (response.body === null || response.body === void 0) res.end?.();
+      else if (response.isRaw) res.end?.(response.body);
+      else if (typeof response.body === "string") res.end?.(response.body);
+      else res.end?.(JSON.stringify(response.body));
+    }
   }
   /**
    * @description Sets up graceful shutdown handlers for a server.

package/lib/MikroServe.mjs

@@ -1,10 +1,10 @@
 import {
   MikroServe
-} from "./chunk-E3RGQ7QF.mjs";
+} from "./chunk-SLBFEKEH.mjs";
 import "./chunk-ZFBBESGU.mjs";
-import "./chunk-KJT4SET2.mjs";
-import "./chunk-NSHBEU32.mjs";
-import "./chunk-6HESV5Q6.mjs";
+import "./chunk-GUYBTPZH.mjs";
+import "./chunk-YOHL3T54.mjs";
+import "./chunk-JJX5XRNB.mjs";
 export {
   MikroServe
 };

package/lib/Router.d.mts

@@ -1,5 +1,7 @@
-import http from 'node:http';
-import { Middleware, RouteHandler, Route, HandlerResponse } from './interfaces/index.mjs';
+import { Middleware, RouteHandler, Route, RequestType, ResponseType, HandlerResponse } from './interfaces/index.mjs';
+import 'node:http';
+import 'node:http2';
+import 'node:https';
 
 /**
  * Router class to manage routes and middleware
@@ -54,7 +56,7 @@ declare class Router {
     /**
      * Handle a request and find the matching route
      */
-    handle(req: http.IncomingMessage, res: http.ServerResponse): Promise<HandlerResponse | null>;
+    handle(req: RequestType, res: ResponseType): Promise<HandlerResponse | null>;
     /**
      * Execute middleware chain and final handler
      */

package/lib/Router.d.ts

@@ -1,5 +1,7 @@
-import http from 'node:http';
-import { Middleware, RouteHandler, Route, HandlerResponse } from './interfaces/index.js';
+import { Middleware, RouteHandler, Route, RequestType, ResponseType, HandlerResponse } from './interfaces/index.js';
+import 'node:http';
+import 'node:http2';
+import 'node:https';
 
 /**
  * Router class to manage routes and middleware
@@ -54,7 +56,7 @@ declare class Router {
     /**
      * Handle a request and find the matching route
      */
-    handle(req: http.IncomingMessage, res: http.ServerResponse): Promise<HandlerResponse | null>;
+    handle(req: RequestType, res: ResponseType): Promise<HandlerResponse | null>;
     /**
      * Execute middleware chain and final handler
      */

package/lib/Router.js

@@ -143,6 +143,16 @@ var Router = class {
       path,
       state: {},
       // Add the missing state property
+      raw: () => res,
+      binary: (content, contentType = "application/octet-stream", status = 200) => ({
+        statusCode: status,
+        body: content,
+        headers: {
+          "Content-Type": contentType,
+          "Content-Length": content.length.toString()
+        },
+        isRaw: true
+      }),
       text: (content, status = 200) => ({
         statusCode: status,
         body: content,
@@ -170,6 +180,16 @@ var Router = class {
       }),
       status: function(code) {
         return {
+          raw: () => res,
+          binary: (content, contentType = "application/octet-stream") => ({
+            statusCode: code,
+            body: content,
+            headers: {
+              "Content-Type": contentType,
+              "Content-Length": content.length.toString()
+            },
+            isRaw: true
+          }),
           text: (content) => ({
             statusCode: code,
             body: content,

package/lib/Router.mjs

@@ -1,6 +1,6 @@
 import {
   Router
-} from "./chunk-KJT4SET2.mjs";
+} from "./chunk-GUYBTPZH.mjs";
 export {
   Router
 };

package/lib/{chunk-KJT4SET2.mjs → chunk-GUYBTPZH.mjs}

@@ -119,6 +119,16 @@ var Router = class {
       path,
       state: {},
       // Add the missing state property
+      raw: () => res,
+      binary: (content, contentType = "application/octet-stream", status = 200) => ({
+        statusCode: status,
+        body: content,
+        headers: {
+          "Content-Type": contentType,
+          "Content-Length": content.length.toString()
+        },
+        isRaw: true
+      }),
       text: (content, status = 200) => ({
         statusCode: status,
         body: content,
@@ -146,6 +156,16 @@ var Router = class {
       }),
       status: function(code) {
         return {
+          raw: () => res,
+          binary: (content, contentType = "application/octet-stream") => ({
+            statusCode: code,
+            body: content,
+            headers: {
+              "Content-Type": contentType,
+              "Content-Length": content.length.toString()
+            },
+            isRaw: true
+          }),
           text: (content) => ({
             statusCode: code,
             body: content,

package/lib/{chunk-NSHBEU32.mjs → chunk-JJX5XRNB.mjs}

@@ -1,13 +1,10 @@
-import {
-  getTruthyValue
-} from "./chunk-6HESV5Q6.mjs";
-
 // src/utils/configDefaults.ts
 var configDefaults = () => {
   return {
     port: Number(process.env.PORT) || 3e3,
     host: process.env.HOST || "0.0.0.0",
     useHttps: false,
+    useHttp2: false,
     sslCert: "",
     sslKey: "",
     sslCa: "",
@@ -25,6 +22,7 @@ var getDefaultConfig = () => {
     port: defaults.port,
     host: defaults.host,
     useHttps: defaults.useHttps,
+    useHttp2: defaults.useHttp2,
     sslCert: defaults.sslCert,
     sslKey: defaults.sslKey,
     sslCa: defaults.sslCa,
@@ -36,6 +34,10 @@ var getDefaultConfig = () => {
     allowedDomains: defaults.allowedDomains
   };
 };
+function getTruthyValue(value) {
+  if (value === "true" || value === true) return true;
+  return false;
+}
 
 export {
   configDefaults,