@modular-rest/server 1.11.9 → 1.11.12

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@modular-rest/server",
-  "version": "1.11.9",
+  "version": "1.11.12",
   "description": "a nodejs module based on KOAJS for developing Rest-APIs in a modular solution.",
   "main": "src/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "generate:types": "tsc"
   },
-  "types": "./types/src/index.d.ts",
+  "types": "./types/index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/modular-rest/modular-rest.git"
@@ -44,4 +44,4 @@
     "@types/koa__cors": "^5.0.0",
     "typescript": "^5.3.3"
   }
-}
+}

package/src/application.js

@@ -18,7 +18,10 @@ const defaultServiceRoot = __dirname + "/services";
  * @typedef {import('./class/cms_trigger.js')} CmsTrigger
  */
 
-const { config, setConfig } = require("./config");
+const {
+  config,
+  setConfig
+} = require("./config");
 
 /**
  * Create a modular REST instance with Koa and MongoDB support.
@@ -147,17 +150,10 @@ async function createRest(options) {
     mongoOption: config.mongo,
   });
 
-  // 3. Setting up default services
-  try {
-    await require("./helper/presetup_services").setup(options);
-  } catch (e) {
-    return Promise.reject(e);
-  }
-
   /**
    * User Services
    *
-   * Plug in routes and database
+   * 3. Plug in routes and database
    */
   if (config.modulesPath) {
     // Plug in user routes
@@ -202,6 +198,13 @@ async function createRest(options) {
     });
   }
 
+  // 4. Setting up default services
+  try {
+    await require("./helper/presetup_services").setup(options);
+  } catch (e) {
+    return Promise.reject(e);
+  }
+
   /**
    * Run the server
    *
@@ -233,4 +236,4 @@ async function createRest(options) {
   });
 }
 
-module.exports = createRest;
+module.exports = createRest;

package/src/class/database_trigger.js

@@ -8,7 +8,7 @@ class DatabaseTrigger {
    * Creates a new instance of `DatabaseTrigger`.
    *
    * @param {'find' | 'find-one' | 'count' | 'update-one' | 'insert-one' | 'remove-one' | 'aggregate'} operation - The operation to be triggered. Supported operations are: 'find', 'find-one', 'count', 'update-one', 'insert-one', 'remove-one', 'aggregate'.
-   * @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'.
+   * @param {function({query: Object.<string, any>, queryResult: any | 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) => {}) {

package/src/class/security.js

@@ -17,7 +17,7 @@ class AccessDefinition {
 }
 
 /**
- * @typedef {('user_access'|'upload_file_access'|'remove_file_access'|'anonymous_access'|'advanced_settings')} PermissionType
+ * @typedef {('god_access'|'user_access'|'upload_file_access'|'remove_file_access'|'anonymous_access'|'advanced_settings'|string)} PermissionType
  */
 
 /**

package/src/middlewares.js

@@ -13,6 +13,7 @@ const userManager = require("./services/user_manager/service");
 /**
  * Authentication middleware
  * It checks if incoming request has a valid token in header.authorization
+ * Then attaches the user object to ctx.state.user
  *
  * @param {Object} ctx - Koa context
  * @param {Function} next - Koa next function

package/src/services/data_provider/service.js

@@ -1,6 +1,9 @@
 let name = "dataProvider";
 const colog = require("colog");
-let { AccessTypes, AccessDefinition } = require("../../class/security");
+let {
+  AccessTypes,
+  AccessDefinition
+} = require("../../class/security");
 
 const Mongoose = require("mongoose");
 Mongoose.set("useCreateIndex", true);
@@ -11,7 +14,9 @@ let permissionDefinitions = {};
 
 let triggers = require("../../class/trigger_operator");
 let TypeCasters = require("./typeCasters");
-const { config } = require("../../config");
+const {
+  config
+} = require("../../config");
 
 /**
  *
@@ -30,13 +35,14 @@ function connectToDatabaseByCollectionDefinitionList(
     // Create db connection
     //
     const fullDbName = (mongoOption.dbPrefix || "") + dbName;
-    const connectionString = mongoOption.mongoBaseAddress + "/" + fullDbName;
+    const connectionString = mongoOption.mongoBaseAddress;
 
-    colog.info(`- Connecting to database ${connectionString}`);
+    colog.info(`- Connecting to database: ${fullDbName}`);
 
     let connection = Mongoose.createConnection(connectionString, {
       useUnifiedTopology: true,
       useNewUrlParser: true,
+      dbName: fullDbName,
     });
 
     // Store connection
@@ -94,7 +100,10 @@ function connectToDatabaseByCollectionDefinitionList(
  * @param {string} option.mongoOption.dbPrefix
  * @param {string} option.mongoOption.mongoBaseAddress
  */
-async function addCollectionDefinitionByList({ list, mongoOption }) {
+async function addCollectionDefinitionByList({
+  list,
+  mongoOption
+}) {
   let clusteredByDBName = {};
 
   // cluster list by their database name.
@@ -250,4 +259,4 @@ module.exports = {
   performAdditionalOptionsToQueryObject,
   triggers,
   TypeCasters,
-};
+};

package/types/{src/class → class}/database_trigger.d.ts

@@ -9,16 +9,20 @@ declare class DatabaseTrigger {
      * Creates a new instance of `DatabaseTrigger`.
      *
      * @param {'find' | 'find-one' | 'count' | 'update-one' | 'insert-one' | 'remove-one' | 'aggregate'} operation - The operation to be triggered. Supported operations are: 'find', 'find-one', 'count', 'update-one', 'insert-one', 'remove-one', 'aggregate'.
-     * @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'.
+     * @param {function({query: Object.<string, any>, queryResult: any | 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: 'find' | 'find-one' | 'count' | 'update-one' | 'insert-one' | 'remove-one' | 'aggregate', callback?: (arg0: {
-        query: any;
-        queryResult: any;
+        query: {
+            [x: string]: any;
+        };
+        queryResult: any | any[];
     }) => void);
     operation: "find" | "count" | "aggregate" | "find-one" | "update-one" | "insert-one" | "remove-one";
     callback: (arg0: {
-        query: any;
-        queryResult: any;
+        query: {
+            [x: string]: any;
+        };
+        queryResult: any | any[];
     }) => void;
 }

package/types/{src/class → class}/security.d.ts

@@ -1,4 +1,4 @@
-export type PermissionType = ('user_access' | 'upload_file_access' | 'remove_file_access' | 'anonymous_access' | 'advanced_settings');
+export type PermissionType = ('god_access' | 'user_access' | 'upload_file_access' | 'remove_file_access' | 'anonymous_access' | 'advanced_settings' | string);
 /**
  * Class representing an access definition.
  */
@@ -20,7 +20,7 @@ export class AccessDefinition {
     permissionList: Permission[];
 }
 /**
- * @typedef {('user_access'|'upload_file_access'|'remove_file_access'|'anonymous_access'|'advanced_settings')} PermissionType
+ * @typedef {('god_access'|'user_access'|'upload_file_access'|'remove_file_access'|'anonymous_access'|'advanced_settings'|string)} PermissionType
  */
 /**
  * Class representing a permission.
@@ -42,7 +42,7 @@ export class Permission {
         onlyOwnData?: boolean;
         ownerIdField?: string;
     });
-    type: PermissionType;
+    type: string;
     read: boolean;
     write: boolean;
     onlyOwnData: boolean;
@@ -98,7 +98,7 @@ export class PermissionGroup {
     title: string;
     isDefault: boolean;
     isAnonymous: boolean;
-    validPermissionTypes: PermissionType[];
+    validPermissionTypes: string[];
 }
 /**
  * Class representing access types.

package/types/{src/services → services}/functions/service.d.ts

@@ -16,7 +16,7 @@ export function defineFunction({ name, permissionTypes, callback }: {
     callback: Function;
 }): {
     name: string;
-    permissionTypes: [import("../../class/security.js").PermissionType];
+    permissionTypes: [string];
     callback: Function;
 };
 export function runFunction(name: any, args: any, user: any): Promise<any>;