feat: allow disable cache (maxCacheSize = 0)

Author: Jacek Piętal

README.md

@@ -69,7 +69,7 @@ const config = {
   // ssl = undefined | { key, cert }
   ssl: process.argv.includes("--ssl") ? ssl : undefined,
   // max cache size
-  maxCacheSize: 128
+  maxCacheSize: 128,
 };
 ```
 

dist/index.d.ts

@@ -1,13 +1,3 @@
-import { Cache } from "latermom";
-import { WSConfig, WSRequest, WSServer } from "./types.js";
-export default function startServer(
-  userConfig: Partial<WSConfig>,
-  {
-    createServer,
-    requestHandler,
-  }: {
-    createServer: (config: WSConfig) => Promise<WSServer>;
-    requestHandler: (fileReaderCache: Cache) => WSRequest;
-  }
-): Promise<WSServer>;
+export * from "./types";
+export * from "./server";
 //# sourceMappingURL=index.d.ts.map

dist/index.d.ts.map

@@ -1,27 +1,34 @@
 "use strict";
-var __importDefault =
-  (this && this.__importDefault) ||
-  function (mod) {
-    return mod && mod.__esModule ? mod : { default: mod };
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (
+          !desc ||
+          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
+        ) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __exportStar =
+  (this && this.__exportStar) ||
+  function (m, exports) {
+    for (var p in m)
+      if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p))
+        __createBinding(exports, m, p);
   };
 Object.defineProperty(exports, "__esModule", { value: true });
-const config_js_1 = __importDefault(require("./config.js"));
-const server_1 = __importDefault(require("./server"));
-// dynamically start server
-async function startServer(userConfig, { createServer, requestHandler }) {
-  // merge configurations
-  const config = { ...config_js_1.default, ...userConfig };
-  // dynamically create wrapped compatible express or uws server
-  const server = await (0, server_1.default)(config, {
-    createServer,
-    requestHandler,
-  });
-  // mandatory started message
-  console.info(`Started ${config.type} app on port`, config.port);
-  if (Object.keys(config.plugins).length) {
-    console.info("with plugin(s)", Object.keys(config.plugins).join(", "));
-  }
-  // resolve with server
-  return server;
-}
-exports.default = startServer;
+__exportStar(require("./types"), exports);
+__exportStar(require("./server"), exports);

dist/index.js

@@ -1,48 +1,4 @@
 "use strict";
-var __createBinding =
-  (this && this.__createBinding) ||
-  (Object.create
-    ? function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        var desc = Object.getOwnPropertyDescriptor(m, k);
-        if (
-          !desc ||
-          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
-        ) {
-          desc = {
-            enumerable: true,
-            get: function () {
-              return m[k];
-            },
-          };
-        }
-        Object.defineProperty(o, k2, desc);
-      }
-    : function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        o[k2] = m[k];
-      });
-var __setModuleDefault =
-  (this && this.__setModuleDefault) ||
-  (Object.create
-    ? function (o, v) {
-        Object.defineProperty(o, "default", { enumerable: true, value: v });
-      }
-    : function (o, v) {
-        o["default"] = v;
-      });
-var __importStar =
-  (this && this.__importStar) ||
-  function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null)
-      for (var k in mod)
-        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
-          __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-  };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPlugin = exports.populatePlugins = void 0;
 const path_1 = require("path");
@@ -52,12 +8,8 @@ async function populatePlugins(config) {
   if (matches) {
     // we need to get our promises in order
     const syncMap = matches.map((path) => {
-      var _a;
       const [_, plugin] = path.split(" ");
-      return (
-        (_a = (0, path_1.resolve)(plugin)),
-        Promise.resolve().then(() => __importStar(require(_a)))
-      );
+      return import((0, path_1.resolve)(plugin));
     });
     // so the main function awaits properly
     const plugins = await Promise.all(syncMap);

dist/plugins.js

@@ -1,19 +1,12 @@
-import { Cache } from "latermom";
-import { WSConfig, WSRequest, WSServer } from "../types.js";
+import { WSConfig, WSServer, WSCoreConsumer } from "../types.js";
 /**
  * this is either
- * @param {object} config
- * @param {object} core_consumer
+ * @param {WSConfig} config
+ * @param {WSCoreConsumer} coreConsumer
  * @returns {WSServer}
  */
-export default function startServer(
+export declare function chef(
   config: WSConfig,
-  {
-    createServer,
-    requestHandler,
-  }: {
-    createServer(config: WSConfig): Promise<WSServer>;
-    requestHandler(fileReaderCache: Cache): WSRequest;
-  }
+  { createServer, requestHandler }: WSCoreConsumer
 ): Promise<WSServer>;
 //# sourceMappingURL=index.d.ts.map

dist/server/index.d.ts

@@ -5,34 +5,46 @@ var __importDefault =
     return mod && mod.__esModule ? mod : { default: mod };
   };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.chef = void 0;
 const latermom_1 = require("latermom");
+const config_js_1 = __importDefault(require("../config.js"));
 const static_files_js_1 = __importDefault(require("./static-files.js"));
 const plugins_1 = require("../plugins");
 /**
  * this is either
- * @param {object} config
- * @param {object} core_consumer
+ * @param {WSConfig} config
+ * @param {WSCoreConsumer} coreConsumer
  * @returns {WSServer}
  */
-async function startServer(config, { createServer, requestHandler }) {
+async function chef(config, { createServer, requestHandler }) {
+  const mergedConfig = { ...config_js_1.default, ...config };
   // polulate config.plugins by requiring optional files
-  await (0, plugins_1.populatePlugins)(config);
+  await (0, plugins_1.populatePlugins)(mergedConfig);
   // create the express or uws server inside a wrapper
-  const server = await createServer(config);
+  const server = await createServer(mergedConfig);
   // extend with resulting config
-  server.config = config;
+  server.config = mergedConfig;
+  // spread
+  const { folder, maxCacheSize, type, port, plugins } = server.config;
   // create the static files reader based on folder
-  const fileReader = (0, static_files_js_1.default)(config.folder);
+  const fileReader = (0, static_files_js_1.default)(folder);
   // and create a cache for above
-  const fileReaderCache = new latermom_1.Cache(fileReader, config.maxCacheSize);
+  const fileReaderCache = maxCacheSize
+    ? new latermom_1.Cache(fileReader, maxCacheSize)
+    : { get: fileReader };
   // give library consumer one frame to setup his own routes
   setTimeout(() => {
     // everything goes to the reader
     server.get("/*", requestHandler(fileReaderCache));
   });
   // make server listen on process.env.PORT || 4200
-  await server.start(config.port);
+  await server.start(port);
+  // mandatory started message
+  console.info(`Started ${type} app on port`, port);
+  if (Object.keys(plugins).length) {
+    console.info("with plugin(s)", Object.keys(plugins).join(", "));
+  }
   // finally
   return server;
 }
-exports.default = startServer;
+exports.chef = chef;

dist/server/index.d.ts.map

@@ -1,30 +1,34 @@
 /// <reference types="node" />
-type WSProp = ((...args: any[]) => any) | any | any[];
-type uWS_WebSocket = {
-  [prop: string]: WSProp;
+export type WSProp = ((...args: any[]) => any) | any | any[];
+export type uWS_WebSocket = {
+  [property: string]: WSProp;
 };
 export type WSEvent = {
   id: string;
   event: string;
   data?: any;
 };
 export type WSSocket = WebSocket | uWS_WebSocket;
-export type WSPlugin = (ws: WSSocket, event: WSEvent) => void;
+export type WSPlugin = (websocket: WSSocket, event: WSEvent) => void;
 export type WSServer = {
   start: (port: number) => Promise<WSServer>;
   config: WSConfig;
-  [prop: string]: WSProp;
+  [property: string]: WSProp;
 };
 export type WSRequest = (
-  resOrReq: object | any,
-  reqOrRes: object | any,
+  responseOnRequest: object | any,
+  requestOrResponse: object | any,
   next?: () => void
 ) => void;
 export type WSFileReaderResponse = {
   mime: string;
   body: string | Buffer;
   status: number;
 };
+export type WSFileReader = (url: string) => WSFileReaderResponse;
+export type WSFileReaderCache = {
+  get: (url: string) => WSFileReaderResponse;
+};
 export type WSConfig = {
   port: number;
   folder: string;
@@ -41,5 +45,8 @@ export type WSConfig = {
   };
   maxCacheSize: number;
 };
-export {};
+export type WSCoreConsumer = {
+  createServer(config: WSConfig): Promise<WSServer>;
+  requestHandler(fileReaderCache: WSFileReaderCache): WSRequest;
+};
 //# sourceMappingURL=types.d.ts.map

dist/server/index.js

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

dist/types.d.ts

@@ -0,0 +1,40 @@
+@import url("https://fonts.googleapis.com/css2?family=Source+Sans+Pro&family=Source+Code+Pro&display=swap");
+
+body,
+p {
+  font-family: "Source Sans Pro", Arial, Helvetica, sans-serif;
+  font-size: 18px;
+}
+
+h4 {
+  margin: 1rem 0;
+}
+
+pre,
+code,
+.tsd-signature {
+  font-family: "Source Code Pro", "Courier New", Courier, monospace;
+  padding: 0 0.5em;
+  line-height: 1.75;
+  margin: 1px;
+  border: none !important;
+  background: var(--code-background);
+}
+
+pre,
+.tsd-signature {
+  display: block;
+  padding: 0.75em 1em;
+  margin: 1em 0;
+  border-radius: 6px;
+}
+
+pre code {
+  padding: 0;
+  border: none;
+}
+
+code {
+  display: inline-block;
+  border-radius: 4px;
+}