@modular-rest/server 1.11.4 → 1.11.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modular-rest/server",
-  "version": "1.11.4",
+  "version": "1.11.6",
   "description": "a nodejs module based on KOAJS for developing Rest-APIs in a modular solution.",
   "main": "src/index.js",
   "scripts": {
@@ -32,8 +32,9 @@
     "keypair": "^1.0.4",
     "koa": "^2.5.3",
     "koa-body": "^4.2.0",
+    "koa-mount": "^4.0.0",
     "koa-router": "^7.4.0",
-    "koa-static-server": "^1.5.2",
+    "koa-static": "^5.0.0",
     "mongoose": "^5.10.9",
     "nested-property": "^4.0.0"
   },
@@ -43,4 +44,4 @@
     "@types/koa__cors": "^5.0.0",
     "typescript": "^5.3.3"
   }
-}
+}

package/src/application.js

@@ -1,7 +1,8 @@
 const koa = require("koa");
 const cors = require("@koa/cors");
 const koaBody = require("koa-body");
-const koaStatic = require("koa-static-server");
+const koaStatic = require("koa-static");
+const mount = require("koa-mount");
 const path = require("path");
 const Combination = require("./class/combinator");
 const DataProvider = require("./services/data_provider/service");
@@ -13,8 +14,8 @@ const defaultServiceRoot = __dirname + "/services";
  * @typedef {import('koa')} Koa
  * @typedef {import('http').Server} server
  * @typedef {import('@koa/cors').Options} Cors
- * @typedef {import('./class/security').PermissionGroup} PermissionGroup
- * @typedef {import('./class/database_trigger.js')} DatabaseTrigger
+ * @typedef {import('./class/security.js').PermissionGroup} PermissionGroup
+ * @typedef {import('./class/cms_trigger.js')} CmsTrigger
  */
 
 const { config, setConfig } = require("./config");
@@ -25,18 +26,19 @@ const { config, setConfig } = require("./config");
  *   cors?: Cors; // CORS options.
  *   modulesPath?: string; // Root directory of your router.js/db.js files.
  *   uploadDirectory?: string; // Root directory of your uploaded files.
- *   staticPath?: {
- *      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 file exists.
- *      brotli?: boolean; // Try to serve the brotli version of a file automatically when brotli is supported by a client and if the requested file exists.
- *      index?: string; // Index file.
- *   };
+ *   koaBodyOptions?: object; // Options for koa-body.
+ *    staticPath?: {
+ *        rootDir: string; // Root directory of your static files.
+ *        rootPath: string; // Root path of your static files, defaults to '/assets'.
+ *        maxage?: number; // Browser cache max-age in milliseconds. Defaults to 0.
+ *        hidden?: boolean; // Allow transfer of hidden files. Defaults to false.
+ *        index?: string; // Default file name. Defaults to 'index.html'.
+ *        defer?: boolean; // If true, serves after return next(), allowing any downstream middleware to respond first. Defaults to false.
+ *        gzip?: boolean; // Try to serve the gzipped version of a file automatically when gzip is supported by a client and if the requested file with .gz extension exists. Defaults to true.
+ *        br?: boolean; // Try to serve the brotli version of a file automatically when brotli is supported by a client and if the requested file with .br extension exists. Note that brotli is only accepted over https. Defaults to false.
+ *        setHeaders?: Function; // Function to set custom headers on response.
+ *        extensions?: boolean|Array; // Try to match extensions from passed array to search for file when no extension is suffixed in URL. First found is served. Defaults to false.
+ *    };
  *   onBeforeInit?: (koaApp:Koa) => void; // A callback called before initializing the Koa server.
  *   onAfterInit?: (koaApp:Koa) => void; // A callback called after server initialization.
  *   port?: number; // Server port.
@@ -57,7 +59,8 @@ const { config, setConfig } = require("./config");
  *   verificationCodeGeneratorMethod: () => string; // A method to return a verification code when registering a new user.
  *   collectionDefinitions?: CollectionDefinition[]; // An array of additional collection definitions.
  *   permissionGroups?: PermissionGroup[]; // An array of additional permission groups.
- *   authTriggers?: DatabaseTrigger[]; // An array of additional database triggers for the auth collection.
+ *   authTriggers?: CmsTrigger[]; // An array of additional database triggers for the auth collection.
+ *   fileTriggers?: CmsTrigger[]; // An array of additional database triggers for the auth collection.
  * }} options
  * @returns {Promise<{app: Koa, server: Server}>}
  */
@@ -90,6 +93,7 @@ async function createRest(options) {
    */
   const bodyParserOptions = {
     multipart: true,
+    ...(config.koaBodyOptions || {}),
   };
   app.use(koaBody(bodyParserOptions));
 
@@ -97,7 +101,18 @@ async function createRest(options) {
    * Plug In KoaStatic
    */
   if (config.staticPath) {
-    app.use(koaStatic(config.staticPath));
+    const defaultStaticPath = config.staticPath.rootDir;
+    const defaultStaticRootPath = config.staticPath.rootPath || "/assets";
+
+    delete config.staticPath.rootDir;
+    delete config.staticPath.rootPath;
+
+    app.use(
+      mount(
+        defaultStaticRootPath,
+        koaStatic(defaultStaticPath, config.staticPath)
+      )
+    );
   }
 
   /**

package/src/class/cms_trigger.js

@@ -0,0 +1,20 @@
+/**
+ * `CmsTrigger` is a class that defines a callback to be called on a specific database transaction.
+ *
+ * @class
+ */
+class CmsTrigger {
+  /**
+   * Creates a new instance of `CmsTrigger`.
+   *
+   * @param {'update-one' | 'insert-one' | 'remove-one' } operation - The operation to be triggered.
+   * @param {function({query: any, queryResult: any}): void} [callback=(context) => {}] - The callback to be called when the operation is executed. The callback function takes an object as parameter with two properties: 'query' and 'queryResult'.
+   * @constructor
+   */
+  constructor(operation, callback = (context) => {}) {
+    this.operation = operation;
+    this.callback = callback;
+  }
+}
+
+module.exports = CmsTrigger;

package/src/class/db_schemas.js

@@ -11,6 +11,7 @@ module.exports = {
       // Tag being used as the parent dir for files
       // uploadDir/$format/$tag/timestamp.format
       tag: String,
+      size: Number,
     },
     { timestamps: true }
   ),

package/src/class/paginator.js

@@ -6,8 +6,9 @@
  * @returns {Object} - An object containing pagination information.
  */
 function create(count, perPage, page) {
-  let totalPgaes = Math.ceil(count / perPage);
-  if (page > totalPgaes) page = 1;
+  const totalPages = Math.ceil(count / perPage);
+  
+  if (page > totalPages) page = 1;
 
   let from = 0;
   if (perPage == 1) from = page - 1;
@@ -16,7 +17,7 @@ function create(count, perPage, page) {
   if (page <= 1) from = 0;
 
   let result = {
-    'pages': totalPgaes,
+    'pages': totalPages,
     'page': page,
     'from': from,
     'to': perPage

package/src/class/reply.js

@@ -9,7 +9,7 @@ function create(status, detail = {}) {
 
     let result = detail || {};
 
-    // defin status
+    // define status
     switch (status) {
         case 's':
             result['status'] = 'success';

package/src/class/validator.js

@@ -8,13 +8,13 @@
 function validate(obj, requiredFields) {
     /*
         this method could validate an Object by given field's name list and return bool.
-        - requiredFields: is a string that contains keys being spareted by " ".
+        - requiredFields: is a string that contains keys being spared by " ".
     */
     let type = typeof requiredFields;
     let result;
 
     if (type == 'string')
-        result = ckeckSimple(obj, requiredFields);
+        result = checkSimple(obj, requiredFields);
     else if (type == 'object')
         result = checkComplex(obj, requiredFields);
 
@@ -25,7 +25,7 @@ function validate(obj, requiredFields) {
 
 module.exports = validate;
 
-function ckeckSimple(obj, requiredFields = '') {
+function checkSimple(obj, requiredFields = '') {
     let isValide = false;
     let requires = requiredFields.split(' ');
 

package/src/config.js

@@ -1,27 +1,28 @@
 /**
  * @typedef {import('koa')} Koa
  * @typedef {import('@koa/cors').Options} Cors
- * @typedef {import('./class/collection_definition')} CollectionDefinition
- * @typedef {import('./class/security').PermissionGroup} PermissionGroup
- * @typedef {import('./class/database_trigger.js')} DatabaseTrigger
+ * @typedef {import('./class/collection_definition.js')} CollectionDefinition
+ * @typedef {import('./class/security.js').PermissionGroup} PermissionGroup
+ * @typedef {import('./class/cms_trigger.js')} CmsTrigger
  */
 
 /**
  * @typedef {{
  *   cors?: Cors; // CORS options.
  *   modulesPath?: string; // Root directory of your router.js/db.js files.
- *   staticPath?: {
- *      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 file exists.
- *      brotli?: boolean; // Try to serve the brotli version of a file automatically when brotli is supported by a client and if the requested file exists.
- *      index?: string; // Index file.
- *   };
+ *   koaBodyOptions?: object; // Options for koa-body.
+ *    staticPath?: {
+ *        rootDir: string; // Root directory of your static files.
+ *        rootPath: string; // Root path of your static files, defaults to '/assets'.
+ *        maxage?: number; // Browser cache max-age in milliseconds. Defaults to 0.
+ *        hidden?: boolean; // Allow transfer of hidden files. Defaults to false.
+ *        index?: string; // Default file name. Defaults to 'index.html'.
+ *        defer?: boolean; // If true, serves after return next(), allowing any downstream middleware to respond first. Defaults to false.
+ *        gzip?: boolean; // Try to serve the gzipped version of a file automatically when gzip is supported by a client and if the requested file with .gz extension exists. Defaults to true.
+ *        br?: boolean; // Try to serve the brotli version of a file automatically when brotli is supported by a client and if the requested file with .br extension exists. Note that brotli is only accepted over https. Defaults to false.
+ *        setHeaders?: Function; // Function to set custom headers on response.
+ *        extensions?: boolean|Array; // Try to match extensions from passed array to search for file when no extension is suffixed in URL. First found is served. Defaults to false.
+ *    };
  *   onBeforeInit?: (koaApp:Koa) => void; // A callback called before initializing the Koa server.
  *   onAfterInit?: (koaApp:Koa) => void; // A callback called after server initialization.
  *   port?: number; // Server port.
@@ -43,6 +44,7 @@
  *   collectionDefinitions?: CollectionDefinition[]; // An array of additional collection definitions.
  *   permissionGroups?: PermissionGroup[]; // An array of additional permission groups.
  *   authTriggers?: DatabaseTrigger[]; // An array of additional database triggers for the auth collection.
+ *   fileTriggers?: CmsTrigger[]; // An array of additional database triggers for the auth collection.
  * }} Config
  * @exports Config
  */

package/src/index.js

@@ -9,36 +9,58 @@ const validator = require("./class/validator");
 const { getCollection } = require("./services/data_provider/service");
 const { defineFunction } = require("./services/functions/service");
 const TypeCasters = require("./services/data_provider/typeCasters");
+const userManager = require("./services/user_manager/service");
+const {
+  getFile,
+  getFileLink,
+  getFilePath,
+  removeFile,
+  storeFile,
+} = require("./services/file/service");
 
 // Base class
 const CollectionDefinition = require("./class/collection_definition");
 const Schemas = require("./class/db_schemas");
 const DatabaseTrigger = require("./class/database_trigger");
+const CmsTrigger = require("./class/cms_trigger");
 const SecurityClass = require("./class/security");
 const middleware = require("./middlewares");
-const userManager = require("./services/user_manager/service");
 
 module.exports = {
   createRest,
 
-  // Route utilities
-  reply,
-  TypeCasters,
-  paginator,
-  validator,
-
-  // Service utilities
-  getCollection,
-  defineFunction,
-
   // Database
   CollectionDefinition,
   Schemas,
   Schema,
   DatabaseTrigger,
+  CmsTrigger,
   ...SecurityClass,
 
-  // Middlewares
+  // Function
+  defineFunction,
+
+  // Private utilities
+  TypeCasters,
+  validator,
+
+  // Route utilities
+  reply,
+  paginator,
+
+  // Database utilities
+  getCollection,
+
+  // File Utilities
+  getFile,
+  getFileLink,
+  getFilePath,
+  removeFile,
+  storeFile,
+
+  // Middleware utilities
   middleware,
+
+  // User utilities
   userManager: userManager.main,
 };

package/src/services/data_provider/router.js

@@ -19,7 +19,10 @@ dataProvider.use("/", middleware.auth, async (ctx, next) => {
 
   // fields validation
   if (!bodyValidated.isValid) {
-    ctx.throw(412, JSON.stringify(reply("e", { e: bodyValidated.requires })));
+    ctx.throw(
+      412,
+      JSON.stringify(reply("e", { error: bodyValidated.requires }))
+    );
   }
 
   // type caster
@@ -57,7 +60,10 @@ dataProvider.post("/find", async (ctx) => {
 
   // fields validation
   if (!bodyValidate.isValid) {
-    ctx.throw(412, JSON.stringify(reply("e", { e: bodyValidate.requires })));
+    ctx.throw(
+      412,
+      JSON.stringify(reply("e", { error: bodyValidate.requires }))
+    );
   }
 
   // access validation
@@ -79,7 +85,7 @@ dataProvider.post("/find", async (ctx) => {
   if (collection == null) {
     ctx.throw(
       412,
-      JSON.stringify(reply("e", { e: "wrong database or collection" }))
+      JSON.stringify(reply("e", { error: "wrong database or collection" }))
     );
   }
 
@@ -125,7 +131,10 @@ dataProvider.post("/find-one", async (ctx) => {
 
   // fields validation
   if (!bodyValidate.isValid) {
-    ctx.throw(JSON.stringify(reply("e", { e: bodyValidate.requires })), 412);
+    ctx.throw(
+      JSON.stringify(reply("e", { error: bodyValidate.requires })),
+      412
+    );
   }
 
   // access validation
@@ -142,7 +151,7 @@ dataProvider.post("/find-one", async (ctx) => {
   let collection = service.getCollection(body.database, body.collection);
   if (collection == null) {
     ctx.throw(
-      JSON.stringify(reply("e", { e: "wrong database or collection" })),
+      JSON.stringify(reply("e", { error: "wrong database or collection" })),
       412
     );
   }
@@ -194,7 +203,10 @@ dataProvider.post("/count", async (ctx) => {
 
   // fields validation
   if (!bodyValidate.isValid) {
-    ctx.throw(JSON.stringify(reply("e", { e: bodyValidate.requires })), 412);
+    ctx.throw(
+      JSON.stringify(reply("e", { error: bodyValidate.requires })),
+      412
+    );
   }
 
   // access validation
@@ -211,7 +223,7 @@ dataProvider.post("/count", async (ctx) => {
   let collection = service.getCollection(body.database, body.collection);
   if (collection == null) {
     ctx.throw(
-      JSON.stringify(reply("e", { e: "wrong database or collection" })),
+      JSON.stringify(reply("e", { error: "wrong database or collection" })),
       412
     );
   }
@@ -241,7 +253,10 @@ dataProvider.post("/update-one", async (ctx) => {
 
   // fields validation
   if (!bodyValidate.isValid) {
-    ctx.throw(JSON.stringify(reply("e", { e: bodyValidate.requires })), 412);
+    ctx.throw(
+      JSON.stringify(reply("e", { error: bodyValidate.requires })),
+      412
+    );
   }
 
   // access validation
@@ -258,7 +273,7 @@ dataProvider.post("/update-one", async (ctx) => {
   let collection = service.getCollection(body.database, body.collection);
   if (collection == null) {
     ctx.throw(
-      JSON.stringify(reply("e", { e: "wrong database or collection" })),
+      JSON.stringify(reply("e", { error: "wrong database or collection" })),
       412
     );
   }
@@ -291,7 +306,10 @@ dataProvider.post("/insert-one", async (ctx) => {
 
   // fields validation
   if (!bodyValidate.isValid) {
-    ctx.throw(JSON.stringify(reply("e", { e: bodyValidate.requires })), 412);
+    ctx.throw(
+      JSON.stringify(reply("e", { error: bodyValidate.requires })),
+      412
+    );
   }
 
   // access validation
@@ -312,7 +330,7 @@ dataProvider.post("/insert-one", async (ctx) => {
   let collection = service.getCollection(body.database, body.collection);
   if (collection == null) {
     ctx.throw(
-      JSON.stringify(reply("e", { e: "wrong database or collection" })),
+      JSON.stringify(reply("e", { error: "wrong database or collection" })),
       412
     );
   }
@@ -341,7 +359,10 @@ dataProvider.post("/remove-one", async (ctx) => {
 
   // fields validation
   if (!bodyValidate.isValid) {
-    ctx.throw(JSON.stringify(reply("e", { e: bodyValidate.requires })), 412);
+    ctx.throw(
+      JSON.stringify(reply("e", { error: bodyValidate.requires })),
+      412
+    );
   }
 
   // access validation
@@ -358,7 +379,7 @@ dataProvider.post("/remove-one", async (ctx) => {
   let collection = service.getCollection(body.database, body.collection);
   if (collection == null) {
     ctx.throw(
-      JSON.stringify(reply("e", { e: "wrong database or collection" })),
+      JSON.stringify(reply("e", { error: "wrong database or collection" })),
       412
     );
   }
@@ -391,7 +412,10 @@ dataProvider.post("/aggregate", async (ctx) => {
 
   // fields validation
   if (!bodyValidate.isValid) {
-    ctx.throw(JSON.stringify(reply("e", { e: bodyValidate.requires })), 412);
+    ctx.throw(
+      JSON.stringify(reply("e", { error: bodyValidate.requires })),
+      412
+    );
   }
 
   // access validation
@@ -408,7 +432,7 @@ dataProvider.post("/aggregate", async (ctx) => {
   let collection = service.getCollection(body.database, body.collection);
   if (collection == null) {
     ctx.throw(
-      JSON.stringify(reply("e", { e: "wrong database or collection" })),
+      JSON.stringify(reply("e", { error: "wrong database or collection" })),
       412
     );
   }
@@ -438,7 +462,10 @@ dataProvider.post("/findByIds", async (ctx, next) => {
 
   // fields validation
   if (!bodyValidate.isValid) {
-    ctx.throw(JSON.stringify(reply("e", { e: bodyValidate.requires })), 412);
+    ctx.throw(
+      JSON.stringify(reply("e", { error: bodyValidate.requires })),
+      412
+    );
   }
 
   // access validation
@@ -455,7 +482,7 @@ dataProvider.post("/findByIds", async (ctx, next) => {
   let collection = service.getCollection(body.database, body.collection);
   if (collection == null) {
     ctx.throw(
-      JSON.stringify(reply("e", { e: "wrong database or collection" })),
+      JSON.stringify(reply("e", { error: "wrong database or collection" })),
       412
     );
   }

package/src/services/data_provider/typeCasters.js

@@ -1,9 +1,10 @@
-let Mongoose = require('mongoose');
+const Mongoose = require('mongoose');
+
 module.exports = {
   'ObjectId': Mongoose.Types.ObjectId,
   'Date': (dateValue) => {
-      let strDate = dateValue.toString();
-      let mongoDateFormateInString = new Date(strDate).toISOString().split('T')[0];
+      const strDate = dateValue.toString();
+      const mongoDateFormateInString = new Date(strDate).toISOString().split('T')[0];
       return new Date(mongoDateFormateInString);
   }
 }

package/src/services/file/db.js

@@ -1,27 +1,29 @@
-var mongoose = require('mongoose');
-var Schemas = require('../../class/db_schemas');
+var mongoose = require("mongoose");
+var Schemas = require("../../class/db_schemas");
 
-let CollectionDefinition = require('../../class/collection_definition');
-let { Permission, PermissionTypes } = require('../../class/security');
+let CollectionDefinition = require("../../class/collection_definition");
+let { Permission, PermissionTypes } = require("../../class/security");
+const { config } = require("../../config");
 
 module.exports = [
-    new CollectionDefinition({
-        db: 'cms',
-        collection: 'file',
-        schema: Schemas.file,
-        permissions: [
-            new Permission({
-                type: PermissionTypes.upload_file_access,
-                read: true,
-                write: true,
-                onlyOwnData: false,
-            }),
-            new Permission({
-                type: PermissionTypes.remove_file_access,
-                read: true,
-                write: true,
-                onlyOwnData: false,
-            }),
-        ],
-    }),
-]
+  new CollectionDefinition({
+    db: "cms",
+    collection: "file",
+    schema: Schemas.file,
+    permissions: [
+      new Permission({
+        type: PermissionTypes.upload_file_access,
+        read: true,
+        write: true,
+        onlyOwnData: false,
+      }),
+      new Permission({
+        type: PermissionTypes.remove_file_access,
+        read: true,
+        write: true,
+        onlyOwnData: false,
+      }),
+    ],
+    triggers: config.fileTriggers || [],
+  }),
+];