mikroserve 0.0.4 → 0.0.5

package/README.md

@@ -13,7 +13,7 @@
 - Supports custom middlewares
 - Out-of-the-box CORS support
 - Built-in customizable rate limiter
-- Tiny (~3.2kb gzipped)
+- Tiny (~4.9kb gzipped)
 - Only a single dependency: [MikroConf](https://github.com/mikaelvesavuori/mikroconf)
 
 ## Installation
@@ -46,22 +46,23 @@ api.start();
 // The response should be "Hello world!"
 ```
 
-## Bigger example
+### Bigger example
 
 ```typescript
 import { MikroServe } from 'mikroserve';
 
-// Create a new api instance
+// Create a new API instance
 const api = new MikroServe({
+  // These are the default values
   port: 3000,
   host: '0.0.0.0',
   useHttps: false,
   sslCert: '',
   sslKey: '',
   sslCa: '',
-  debug: true,
+  debug: false,
   rateLimit: {
-    requestsPerMinute: 60,
+    requestsPerMinute: 100,
     enabled: true
   },
   allowedDomains: ['*']
@@ -165,6 +166,42 @@ api.get('/error', () => {
 api.start();
 ```
 
+## Configuration
+
+All of the settings already presented in the above examples can be provided in multiple ways.
+
+- They can be provided via the CLI, e.g. `node app.js --port 1234`.
+- Certain values can be provided via environment variables.
+  - Port: `process.env.PORT` - number
+  - Host: `process.env.HOST` - string
+  - Debug: `process.env.DEBUG` - boolean
+- Programmatically/directly via scripting, e.g. `new MikroServe({ port: 1234 })`.
+- They can be placed in a configuration file named `mikroserve.config.json` (plain JSON), which will be automatically applied on load.
+
+### Options
+
+| CLI argument | CLI value                   | JSON (config file) value    | Environment variable |
+|--------------|-----------------------------|-----------------------------|----------------------|
+| --port       | `<number>`                  | port                        | PORT                 |
+| --host       | `<string>`                  | host                        | HOST                 |
+| --https      | none (is flag)              | useHttps                    |                      |
+| --cert       | `<string>`                  | sslCert                     |                      |
+| --key        | `<string>`                  | sslKey                      |                      |
+| --ca         | `<string>`                  | sslCa                       |                      |
+| --debug      | none (is flag)              | debug                       | DEBUG                |
+| --ratelimit  | none (is flag)              | rateLimit.enabled           |                      |
+| --rps        | `<number>`                  | rateLimit.requestsPerMinute |                      |
+| --allowed    | `<comma-separated strings>` | allowedDomains              |                      |
+
+### Order of application
+
+As per [MikroConf](https://github.com/mikaelvesavuori/mikroconf) behavior, the configuration sources are applied in this order:
+
+1. Command line arguments (highest priority)
+2. Programmatically provided config
+3. Config file (JSON)
+4. Default values (lowest priority)
+
 ## Create self-signed HTTPS certificates
 
 On Mac and Linux, run:

package/lib/MikroServe.d.mts

@@ -6,9 +6,9 @@ import { MikroServeOptions, Middleware, RouteHandler } from './interfaces/index.
  * @description MikroServe manages HTTP server operations with routing.
  */
 declare class MikroServe {
+    private config;
     private rateLimiter;
     private router;
-    private config;
     /**
      * @description Creates a new MikroServe instance.
      */

package/lib/MikroServe.d.ts

@@ -6,9 +6,9 @@ import { MikroServeOptions, Middleware, RouteHandler } from './interfaces/index.
  * @description MikroServe manages HTTP server operations with routing.
  */
 declare class MikroServe {
+    private config;
     private rateLimiter;
     private router;
-    private config;
     /**
      * @description Creates a new MikroServe instance.
      */

package/lib/MikroServe.js

@@ -281,8 +281,8 @@ var Router = class {
   }
 };
 
-// src/utils/getTruthyEnvValue.ts
-function getTruthyEnvValue(value) {
+// src/utils/getTruthyValue.ts
+function getTruthyValue(value) {
   if (value === "true" || value === true) return true;
   return false;
 }
@@ -296,7 +296,7 @@ var configDefaults = () => {
     sslCert: "",
     sslKey: "",
     sslCa: "",
-    debug: getTruthyEnvValue(process.env.DEBUG) || false,
+    debug: getTruthyValue(process.env.DEBUG) || false,
     rateLimit: {
       enabled: true,
       requestsPerMinute: 100
@@ -307,9 +307,9 @@ var configDefaults = () => {
 
 // src/MikroServe.ts
 var MikroServe = class {
+  config;
   rateLimiter;
   router;
-  config;
   /**
    * @description Creates a new MikroServe instance.
    */

package/lib/MikroServe.mjs

@@ -1,10 +1,10 @@
 import {
   MikroServe
-} from "./chunk-6UXWR6LD.mjs";
+} from "./chunk-BUKLE4JV.mjs";
 import "./chunk-ZFBBESGU.mjs";
 import "./chunk-KJT4SET2.mjs";
-import "./chunk-RP67R3W4.mjs";
-import "./chunk-CQPU7577.mjs";
+import "./chunk-NSHBEU32.mjs";
+import "./chunk-6HESV5Q6.mjs";
 export {
   MikroServe
 };

package/lib/chunk-6HESV5Q6.mjs

@@ -0,0 +1,9 @@
+// src/utils/getTruthyValue.ts
+function getTruthyValue(value) {
+  if (value === "true" || value === true) return true;
+  return false;
+}
+
+export {
+  getTruthyValue
+};

package/lib/{chunk-6UXWR6LD.mjs → chunk-BUKLE4JV.mjs}

@@ -6,7 +6,7 @@ import {
 } from "./chunk-KJT4SET2.mjs";
 import {
   configDefaults
-} from "./chunk-RP67R3W4.mjs";
+} from "./chunk-NSHBEU32.mjs";
 
 // src/MikroServe.ts
 import { readFileSync } from "node:fs";
@@ -14,9 +14,9 @@ import http from "node:http";
 import https from "node:https";
 import { MikroConf, parsers } from "mikroconf";
 var MikroServe = class {
+  config;
   rateLimiter;
   router;
-  config;
   /**
    * @description Creates a new MikroServe instance.
    */

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

@@ -1,6 +1,6 @@
 import {
-  getTruthyEnvValue
-} from "./chunk-CQPU7577.mjs";
+  getTruthyValue
+} from "./chunk-6HESV5Q6.mjs";
 
 // src/utils/configDefaults.ts
 var configDefaults = () => {
@@ -11,7 +11,7 @@ var configDefaults = () => {
     sslCert: "",
     sslKey: "",
     sslCa: "",
-    debug: getTruthyEnvValue(process.env.DEBUG) || false,
+    debug: getTruthyValue(process.env.DEBUG) || false,
     rateLimit: {
       enabled: true,
       requestsPerMinute: 100

package/lib/index.d.mts

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 export { MikroServe } from './MikroServe.mjs';
 export { Context } from './interfaces/index.mjs';
 import 'node:http';

package/lib/index.d.ts

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 export { MikroServe } from './MikroServe.js';
 export { Context } from './interfaces/index.js';
 import 'node:http';

package/lib/index.js

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 "use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -284,8 +283,8 @@ var Router = class {
   }
 };
 
-// src/utils/getTruthyEnvValue.ts
-function getTruthyEnvValue(value) {
+// src/utils/getTruthyValue.ts
+function getTruthyValue(value) {
   if (value === "true" || value === true) return true;
   return false;
 }
@@ -299,7 +298,7 @@ var configDefaults = () => {
     sslCert: "",
     sslKey: "",
     sslCa: "",
-    debug: getTruthyEnvValue(process.env.DEBUG) || false,
+    debug: getTruthyValue(process.env.DEBUG) || false,
     rateLimit: {
       enabled: true,
       requestsPerMinute: 100
@@ -310,9 +309,9 @@ var configDefaults = () => {
 
 // src/MikroServe.ts
 var MikroServe = class {
+  config;
   rateLimiter;
   router;
-  config;
   /**
    * @description Creates a new MikroServe instance.
    */
@@ -642,21 +641,6 @@ var MikroServe = class {
     process.on("unhandledRejection", shutdown);
   }
 };
-
-// src/index.ts
-async function main() {
-  const isRunFromCommandLine = process.argv[1]?.includes("node_modules/.bin/mikroserve");
-  const force = process.argv[1]?.includes("mikroauth/src/index.ts") && (process.argv[2] || "") === "--force";
-  if (isRunFromCommandLine || force && isRunFromCommandLine) {
-    console.log("\u{1F680} Welcome to MikroServe! \u2728");
-    try {
-      new MikroServe();
-    } catch (error) {
-      console.error(error);
-    }
-  }
-}
-main();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   MikroServe

package/lib/index.mjs

@@ -1,26 +1,10 @@
-#!/usr/bin/env node
 import {
   MikroServe
-} from "./chunk-6UXWR6LD.mjs";
+} from "./chunk-BUKLE4JV.mjs";
 import "./chunk-ZFBBESGU.mjs";
 import "./chunk-KJT4SET2.mjs";
-import "./chunk-RP67R3W4.mjs";
-import "./chunk-CQPU7577.mjs";
-
-// src/index.ts
-async function main() {
-  const isRunFromCommandLine = process.argv[1]?.includes("node_modules/.bin/mikroserve");
-  const force = process.argv[1]?.includes("mikroauth/src/index.ts") && (process.argv[2] || "") === "--force";
-  if (isRunFromCommandLine || force && isRunFromCommandLine) {
-    console.log("\u{1F680} Welcome to MikroServe! \u2728");
-    try {
-      new MikroServe();
-    } catch (error) {
-      console.error(error);
-    }
-  }
-}
-main();
+import "./chunk-NSHBEU32.mjs";
+import "./chunk-6HESV5Q6.mjs";
 export {
   MikroServe
 };

package/lib/utils/configDefaults.js

@@ -25,8 +25,8 @@ __export(configDefaults_exports, {
 });
 module.exports = __toCommonJS(configDefaults_exports);
 
-// src/utils/getTruthyEnvValue.ts
-function getTruthyEnvValue(value) {
+// src/utils/getTruthyValue.ts
+function getTruthyValue(value) {
   if (value === "true" || value === true) return true;
   return false;
 }
@@ -40,7 +40,7 @@ var configDefaults = () => {
     sslCert: "",
     sslKey: "",
     sslCa: "",
-    debug: getTruthyEnvValue(process.env.DEBUG) || false,
+    debug: getTruthyValue(process.env.DEBUG) || false,
     rateLimit: {
       enabled: true,
       requestsPerMinute: 100

package/lib/utils/configDefaults.mjs

@@ -1,8 +1,8 @@
 import {
   configDefaults,
   getDefaultConfig
-} from "../chunk-RP67R3W4.mjs";
-import "../chunk-CQPU7577.mjs";
+} from "../chunk-NSHBEU32.mjs";
+import "../chunk-6HESV5Q6.mjs";
 export {
   configDefaults,
   getDefaultConfig

package/lib/utils/getTruthyValue.d.mts

@@ -0,0 +1,6 @@
+/**
+ * @description Check if a value is a boolean or stringly "true".
+ */
+declare function getTruthyValue(value: string | boolean | undefined): boolean;
+
+export { getTruthyValue };

package/lib/utils/getTruthyValue.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @description Check if a value is a boolean or stringly "true".
+ */
+declare function getTruthyValue(value: string | boolean | undefined): boolean;
+
+export { getTruthyValue };

package/lib/utils/{getTruthyEnvValue.js → getTruthyValue.js}

@@ -17,17 +17,17 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/utils/getTruthyEnvValue.ts
-var getTruthyEnvValue_exports = {};
-__export(getTruthyEnvValue_exports, {
-  getTruthyEnvValue: () => getTruthyEnvValue
+// src/utils/getTruthyValue.ts
+var getTruthyValue_exports = {};
+__export(getTruthyValue_exports, {
+  getTruthyValue: () => getTruthyValue
 });
-module.exports = __toCommonJS(getTruthyEnvValue_exports);
-function getTruthyEnvValue(value) {
+module.exports = __toCommonJS(getTruthyValue_exports);
+function getTruthyValue(value) {
   if (value === "true" || value === true) return true;
   return false;
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  getTruthyEnvValue
+  getTruthyValue
 });

package/lib/utils/getTruthyValue.mjs

@@ -0,0 +1,6 @@
+import {
+  getTruthyValue
+} from "../chunk-6HESV5Q6.mjs";
+export {
+  getTruthyValue
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mikroserve",
   "description": "Minimalistic, ready-to-use API, built on Node.js primitives.",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "author": "Mikael Vesavuori",
   "license": "MIT",
   "keywords": [],

package/lib/chunk-CQPU7577.mjs

@@ -1,9 +0,0 @@
-// src/utils/getTruthyEnvValue.ts
-function getTruthyEnvValue(value) {
-  if (value === "true" || value === true) return true;
-  return false;
-}
-
-export {
-  getTruthyEnvValue
-};

package/lib/utils/getTruthyEnvValue.d.mts

@@ -1,6 +0,0 @@
-/**
- * @description TODO
- */
-declare function getTruthyEnvValue(value: string | boolean | undefined): boolean;
-
-export { getTruthyEnvValue };

package/lib/utils/getTruthyEnvValue.d.ts

@@ -1,6 +0,0 @@
-/**
- * @description TODO
- */
-declare function getTruthyEnvValue(value: string | boolean | undefined): boolean;
-
-export { getTruthyEnvValue };

package/lib/utils/getTruthyEnvValue.mjs

@@ -1,6 +0,0 @@
-import {
-  getTruthyEnvValue
-} from "../chunk-CQPU7577.mjs";
-export {
-  getTruthyEnvValue
-};