mikroserve 0.0.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025-present Mikael Vesavuori
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# MikroServe
+
+TODO

package/lib/MikroServe.d.mts

@@ -0,0 +1,106 @@
+import http from 'node:http';
+import https from 'node:https';
+import { MikroServeConfiguration, Middleware, RouteHandler } from './interfaces/index.mjs';
+
+/**
+ * MikroServe manages HTTP server operations with routing.
+ */
+declare class MikroServe {
+    private config;
+    private rateLimiter;
+    private router;
+    private useHttps;
+    private sslCert?;
+    private sslKey?;
+    private sslCa?;
+    private debug;
+    /**
+     * @description Creates a new MikroServe instance.
+     * @param config - Server configuration options
+     */
+    constructor(config: MikroServeConfiguration);
+    /**
+     * Register a global middleware
+     */
+    use(middleware: Middleware): this;
+    /**
+     * Register a GET route
+     */
+    get(path: string, ...handlers: (RouteHandler | Middleware)[]): this;
+    /**
+     * Register a POST route
+     */
+    post(path: string, ...handlers: (RouteHandler | Middleware)[]): this;
+    /**
+     * Register a PUT route
+     */
+    put(path: string, ...handlers: (RouteHandler | Middleware)[]): this;
+    /**
+     * Register a DELETE route
+     */
+    delete(path: string, ...handlers: (RouteHandler | Middleware)[]): this;
+    /**
+     * Register a PATCH route
+     */
+    patch(path: string, ...handlers: (RouteHandler | Middleware)[]): this;
+    /**
+     * Register an OPTIONS route
+     */
+    options(path: string, ...handlers: (RouteHandler | Middleware)[]): this;
+    /**
+     * Creates an HTTP/HTTPS server, sets up graceful shutdown, and starts listening.
+     * @returns Running HTTP/HTTPS server
+     */
+    start(): http.Server | https.Server;
+    /**
+     * Creates and configures a server instance without starting it.
+     * @returns Configured HTTP or HTTPS server instance
+     */
+    createServer(): http.Server | https.Server;
+    /**
+     * Rate limiting middleware
+     */
+    private rateLimitMiddleware;
+    /**
+     * Request handler for HTTP and HTTPS servers.
+     */
+    private requestHandler;
+    /**
+     * Writes out a clean log to represent the duration of the request.
+     */
+    private logDuration;
+    /**
+     * Parses the request body based on content type.
+     * @param req - HTTP request object
+     * @returns Promise resolving to the parsed body
+     * @throws Will throw if body cannot be parsed
+     */
+    /**
+     * Parses the request body based on content type.
+     * @param req - HTTP request object
+     * @returns Promise resolving to the parsed body
+     * @throws Will throw if body cannot be parsed
+     */
+    private parseBody;
+    /**
+     * CORS middleware
+     */
+    private setCorsHeaders;
+    /**
+     * Set security headers
+     */
+    private setSecurityHeaders;
+    /**
+     * Sends a response with appropriate headers.
+     * @param res - HTTP response object
+     * @param response - Response data and status code
+     */
+    private respond;
+    /**
+     * Sets up graceful shutdown handlers for a server.
+     * @param server - The HTTP/HTTPS server to add shutdown handlers to
+     */
+    setupGracefulShutdown(server: http.Server | https.Server): void;
+}
+
+export { MikroServe };

package/lib/MikroServe.d.ts

@@ -0,0 +1,106 @@
+import http from 'node:http';
+import https from 'node:https';
+import { MikroServeConfiguration, Middleware, RouteHandler } from './interfaces/index.js';
+
+/**
+ * MikroServe manages HTTP server operations with routing.
+ */
+declare class MikroServe {
+    private config;
+    private rateLimiter;
+    private router;
+    private useHttps;
+    private sslCert?;
+    private sslKey?;
+    private sslCa?;
+    private debug;
+    /**
+     * @description Creates a new MikroServe instance.
+     * @param config - Server configuration options
+     */
+    constructor(config: MikroServeConfiguration);
+    /**
+     * Register a global middleware
+     */
+    use(middleware: Middleware): this;
+    /**
+     * Register a GET route
+     */
+    get(path: string, ...handlers: (RouteHandler | Middleware)[]): this;
+    /**
+     * Register a POST route
+     */
+    post(path: string, ...handlers: (RouteHandler | Middleware)[]): this;
+    /**
+     * Register a PUT route
+     */
+    put(path: string, ...handlers: (RouteHandler | Middleware)[]): this;
+    /**
+     * Register a DELETE route
+     */
+    delete(path: string, ...handlers: (RouteHandler | Middleware)[]): this;
+    /**
+     * Register a PATCH route
+     */
+    patch(path: string, ...handlers: (RouteHandler | Middleware)[]): this;
+    /**
+     * Register an OPTIONS route
+     */
+    options(path: string, ...handlers: (RouteHandler | Middleware)[]): this;
+    /**
+     * Creates an HTTP/HTTPS server, sets up graceful shutdown, and starts listening.
+     * @returns Running HTTP/HTTPS server
+     */
+    start(): http.Server | https.Server;
+    /**
+     * Creates and configures a server instance without starting it.
+     * @returns Configured HTTP or HTTPS server instance
+     */
+    createServer(): http.Server | https.Server;
+    /**
+     * Rate limiting middleware
+     */
+    private rateLimitMiddleware;
+    /**
+     * Request handler for HTTP and HTTPS servers.
+     */
+    private requestHandler;
+    /**
+     * Writes out a clean log to represent the duration of the request.
+     */
+    private logDuration;
+    /**
+     * Parses the request body based on content type.
+     * @param req - HTTP request object
+     * @returns Promise resolving to the parsed body
+     * @throws Will throw if body cannot be parsed
+     */
+    /**
+     * Parses the request body based on content type.
+     * @param req - HTTP request object
+     * @returns Promise resolving to the parsed body
+     * @throws Will throw if body cannot be parsed
+     */
+    private parseBody;
+    /**
+     * CORS middleware
+     */
+    private setCorsHeaders;
+    /**
+     * Set security headers
+     */
+    private setSecurityHeaders;
+    /**
+     * Sends a response with appropriate headers.
+     * @param res - HTTP response object
+     * @param response - Response data and status code
+     */
+    private respond;
+    /**
+     * Sets up graceful shutdown handlers for a server.
+     * @param server - The HTTP/HTTPS server to add shutdown handlers to
+     */
+    setupGracefulShutdown(server: http.Server | https.Server): void;
+}
+
+export { MikroServe };