@modular-rest/server 1.5.0 → 1.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modular-rest/server",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "a nodejs module based on KOAJS for developing Rest-APIs in a modular solution.",
   "main": "src/index.js",
   "scripts": {

package/src/application.js

@@ -9,13 +9,61 @@ let UserService = require("./services/user_manager/service");
 
 let defaultServiceRoot = __dirname + "/services";
 
+// staticOptions = {
+//     /**
+//          * directory that is to be served
+//          */
+// rootDir?: string | undefined;
+// /**
+//  * optional rewrite path
+//  */
+// rootPath?: string | undefined;
+// /**
+//  * optional default file to serve if requested static is missing
+//  */
+// notFoundFile?: string | undefined;
+// /**
+//  * request access log to console
+//  */
+// log?: boolean | undefined;
+// /**
+//  * don't execute any downstream middleware. defaults to true
+//  */
+// last?: boolean | undefined;
+// /**
+//  * Browser cache max-age in milliseconds. defaults to 0
+//  */
+// maxage?: number | undefined;
+// /**
+//  * Allow transfer of hidden files. defaults to false
+//  */
+// hidden?: boolean | undefined;
+// /**
+//  * Try to serve the gzipped version of a file automatically when gzip is supported by a client and if the requested
+//  */
+// gzip?: boolean | undefined;
+// /**
+//  * Try to serve the brotli version of a file automatically when brotli is supported by a client and in the requested
+//  */
+// brotli?: boolean | undefined;
+// index?: string | undefined;
+// }
+
 /**
  * @param {{
  *   cors: any; // Options for @koa/cors middleware.
  *   modulesPath: string; // Root directory of your router.js/db.js files.
  *   static: {
- *      dir: string; // Root directory for uploaded files.
- *      rootPath: string; // Root path for uploaded files.
+ *      rootDir: string; // Root directory of your static files.
+ *      rootPath: string; // Root path of your static files.
+ *      notFoundFile: string; // Not found file.
+ *      log: boolean; // Log requests to console.
+ *      last: boolean; // Don't execute any downstream middleware.
+ *      maxage: number; // Browser cache max-age in milliseconds.
+ *      hidden: boolean; // Allow transfer of hidden files.
+ *      gzip: boolean; // Try to serve the gzipped version of a file automatically when gzip is supported by a client and if the requested
+ *      brotli: boolean; // Try to serve the brotli version of a file automatically when brotli is supported by a client and in the requested
+ *      index: string; // Index file.
  *   };
  *   onBeforeInit: (koaApp) => void; // A callback called before initializing the Koa server.
  *   onAfterInit: (koaApp) => void; // A callback called after server initialization.
@@ -73,13 +121,8 @@ module.exports = async function createRest(options) {
   /**
    * Plug In KoaStatic
    */
-  if (options.staticPath) {
-    app.use(
-      koaStatic({
-        rootDir: options.static.dir,
-        rootPath: options.static.rootPath || "/assets/",
-      })
-    );
+  if (options.static) {
+    app.use(koaStatic(static));
   }
 
   /**