@modular-rest/server 1.11.12 → 1.12.0

package/src/class/trigger_operator.js

@@ -1,39 +0,0 @@
-class TriggerOperator {
-  constructor() {
-    this.triggers = [];
-  }
-
-  /**
-   * add a collection trigger
-   * @param {object} trigger DatabaseTrigger object
-   */
-  addTrigger(trigger) {
-    this.triggers.push(trigger);
-  }
-
-  /**
-   * Call a trigger
-   * @param {'find' | 'find-one' | 'count' | 'update-one' | 'insert-one' | 'remove-one' | 'aggregate'} operation operation name
-   * @param {string} database database name
-   * @param {string} collection collection name
-   * @param {string} data
-   */
-  call(operation, database, collection, data) {
-    this.triggers.forEach((trigger) => {
-      if (
-        operation == trigger.operation &&
-        database == trigger.database &&
-        collection == trigger.collection &&
-        trigger.callback
-      )
-        trigger.callback(data);
-    });
-  }
-
-  static get instance() {
-    return instance;
-  }
-}
-
-const instance = new TriggerOperator();
-module.exports = TriggerOperator.instance;

package/src/class/user.js

@@ -1,112 +0,0 @@
-const { config } = require("../config");
-let validateObject = require("./validator");
-
-module.exports = class User {
-  constructor(id, permissionGroup, phone, email, password, type, model) {
-    this.id = id;
-    this.permissionGroup = permissionGroup;
-    this.email = email;
-    this.phone = phone;
-    this.password = password;
-    this.type = type;
-    this.dbModel = model;
-  }
-
-  getBrief() {
-    const permissionGroup = config.permissionGroups.find(
-      (group) => group.title == this.permissionGroup
-    );
-
-    const brief = {
-      id: this.id,
-      permissionGroup: permissionGroup,
-      phone: this.phone,
-      email: this.email,
-      type: this.type,
-    };
-
-    return brief;
-  }
-
-  setNewDetail(detail) {
-    if (detail.phone) this.phone = detail.phone;
-    if (detail.email) this.email = detail.email;
-    if (detail.password) this.password = detail.password;
-  }
-
-  hasPermission(permissionField) {
-    const permissionGroup = config.permissionGroups.find(
-      (group) => group.title == this.permissionGroup
-    );
-
-    if (permissionGroup == null) return false;
-
-    let key = false;
-
-    for (let i = 0; i < permissionGroup.validPermissionTypes.length; i++) {
-      const userPermissionType = permissionGroup.validPermissionTypes[i];
-
-      if (userPermissionType == permissionField) {
-        key = true;
-        break;
-      }
-    }
-
-    return key;
-  }
-
-  async save() {
-    this.mode["permissionGroup"] = this.permissionGroup;
-    this.mode["phone"] = this.phone;
-    this.mode["email"] = this.email;
-    this.mode["password"] = this.password;
-
-    await mode.save();
-  }
-
-  static loadFromModel(model) {
-    return new Promise((done, reject) => {
-      // check required fields
-      let isValidData = validateObject(
-        model,
-        "fullname email password permission"
-      );
-      if (!isValidData) reject(User.notValid(detail));
-
-      let id = model.id;
-      let permissionGroup = model.permissionGroup;
-      let phone = model.phone;
-      let email = model.email;
-      let password = model.password;
-      let type = model.type;
-
-      //create user
-      let newUser = new User(
-        id,
-        permissionGroup,
-        phone,
-        email,
-        password,
-        type,
-        model
-      );
-      done(newUser);
-    });
-  }
-
-  static createFromModel(model, detail) {
-    return new Promise(async (done, reject) => {
-      //create user
-      await new model(detail)
-        .save()
-        .then((newUser) => done(User.loadFromModel(newUser)))
-        .catch(reject);
-    });
-  }
-
-  static notValid(object) {
-    let error = `user detail are not valid ${object}`;
-    console.error(error);
-    return error;
-  }
-};

package/src/class/validator.js

@@ -1,91 +0,0 @@
-/**
- * Validates an object by checking if it contains all the required fields.
- * @param {Object} obj - The object to be validated.
- * @param {string|Object} requiredFields - The list of required fields. If it's a string, it should contain keys separated by spaces. If it's an object, it should contain key-value pairs where the key is the field name and the value is a boolean indicating whether the field is required or not.
- * @returns {boolean} - Returns true if the object contains all the required fields, otherwise returns false.
- * @throws {string} - Throws an error if the requiredFields parameter is not a string or an object.
- */
-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 spared by " ".
-    */
-    let type = typeof requiredFields;
-    let result;
-
-    if (type == 'string')
-        result = checkSimple(obj, requiredFields);
-    else if (type == 'object')
-        result = checkComplex(obj, requiredFields);
-
-    else throw ('requiredFields has wrong form, it must be string or object');
-
-    return result;
-}
-
-module.exports = validate;
-
-function checkSimple(obj, requiredFields = '') {
-    let isValide = false;
-    let requires = requiredFields.split(' ');
-
-    let validMembers = 0;
-    let notValidKeys = [];
-
-    // return if obj is null
-    if (obj == null) return _returnResult(isValide, requires);
-
-    requires.forEach(key => {
-        if (obj[key])
-            validMembers++;
-        else notValidKeys.push(key);
-    });
-
-    // check validation
-    isValide = (requires.length == validMembers) ? true : false;
-    return _returnResult(isValide, notValidKeys);
-}
-
-function checkComplex(obj, requiredFields = {}) {
-    let isValide = false;
-    let requireKeys = Object.keys(requiredFields);
-
-    let validMembers = 0;
-    let notValidKeys = [];
-
-    // return if obj is null
-    if (obj == null) return _returnResult(isValide, requireKeys);
-
-    for (let i = 0; i < requireKeys.length; i++) {
-        const key = requireKeys[i];
-        let isValidField = false;
-
-        // if field has specific values
-        if (requiredFields[key].length > 0) {
-            let expectedValues = requiredFields[key].split(' ');
-
-            if (typeof expectedValues != 'object')
-                throw (`${key} must be array of strings`);
-
-            expectedValues.forEach(value => {
-                if (obj[key] == value) isValidField = true;
-            })
-        }
-        // else does not has specific value
-        else if (obj[key] != null) isValidField = true;
-
-        if (isValidField) validMembers++;
-        else notValidKeys.push(key);
-    }
-
-    // check validation
-    isValide = (requireKeys.length == validMembers) ? true : false;
-    return _returnResult(isValide, notValidKeys);
-}
-
-function _returnResult(isValide, notValidKeys) {
-    return {
-        'isValid': isValide,
-        'requires': notValidKeys
-    };
-}

package/src/config.js

@@ -1,67 +0,0 @@
-/**
- * @typedef {import('koa')} Koa
- * @typedef {import('@koa/cors').Options} Cors
- * @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.
- *   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.
- *   dontListen?: boolean; // If true, the server will not run and will only return the Koa app object.
- *   mongo?: {
- *     dbPrefix: string; // A prefix for your database name.
- *     mongoBaseAddress: string; // The address of your MongoDB server without any database specification.
- *     addressMap?: string; // Specific addresses for each database.
- *   };
- *   keypair?: {
- *     private: string; // Private key for RSA authentication.
- *     public: string; // Public key for RSA authentication.
- *   };
- *   adminUser?: {
- *     email: string; // Admin user email.
- *     password: string; // Admin user password.
- *   };
- *   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.
- *   fileTriggers?: CmsTrigger[]; // An array of additional database triggers for the auth collection.
- * }} Config
- * @exports Config
- */
-
-/**
- * @type {Config}
- */
-const config = {};
-
-/**
- * @param {Config} options
- */
-function setConfig(options) {
-  Object.assign(config, options);
-}
-
-module.exports = {
-  setConfig,
-  config,
-};

package/src/events.js

@@ -1,15 +0,0 @@
-const eventCallbacks = [];
-/**
- * onBeforeInit: (koaApp:Koa) => void; // A callback called before initializing the Koa server.
- * onAfterInit: (koaApp:Koa) => void; // A callback called after server initialization.
- * onNewUser:
- */
-
-function registerEventCallback(event, callback) {
-  if (typeof event !== "string") throw new Error("Event must be a string");
-
-  if (typeof callback !== "function")
-    throw new Error("Callback must be a function");
-
-  eventCallbacks.push({ event, callback });
-}

package/src/helper/data_insertion.js

@@ -1,64 +0,0 @@
-const DataProvider = require("../services/data_provider/service");
-const {
-  getDefaultAnonymousPermissionGroup,
-  getDefaultAdministratorPermissionGroup,
-} = require("../services/user_manager/permissionManager");
-
-const userManager = require("../services/user_manager/service");
-
-async function createAdminUser({ email, password }) {
-  let authModel = DataProvider.getCollection("cms", "auth");
-
-  try {
-    const isAnonymousExisted = await authModel
-      .countDocuments({ type: "anonymous" })
-      .exec();
-
-    const isAdministratorExisted = await authModel
-      .countDocuments({ type: "user", email: email })
-      .exec();
-
-    if (isAnonymousExisted == 0) {
-      await userManager.main.registerUser({
-        permissionGroup: getDefaultAnonymousPermissionGroup().title,
-        email: "",
-        phone: "",
-        password: "",
-        type: "anonymous",
-      });
-      // await new authModel({
-      //   permission: getDefaultAnonymousPermissionGroup().title,
-      //   email: "",
-      //   phone: "",
-      //   password: "",
-      //   type: "anonymous",
-      // }).save();
-    }
-
-    if (isAdministratorExisted == 0) {
-      if (!email || !password) {
-        return Promise.reject("Invalid email or password for admin user.");
-      }
-
-      await userManager.main.registerUser({
-        permissionGroup: getDefaultAdministratorPermissionGroup().title,
-        email: email,
-        password: password,
-        type: "user",
-      });
-
-      // await new authModel({
-      //   permission: getDefaultAdministratorPermissionGroup().title,
-      //   email: email,
-      //   password: password,
-      //   type: "user",
-      // }).save();
-    }
-  } catch (e) {
-    return Promise.reject(e);
-  }
-}
-
-module.exports = {
-  createAdminUser,
-};

package/src/helper/presetup_services.js

@@ -1,31 +0,0 @@
-let DataInsertion = require("./data_insertion");
-let JWT = require("../services/jwt/service");
-let FileService = require("../services/file/service");
-
-module.exports.setup = async ({ keypair, adminUser, uploadDirectory }) => {
-  /**
-   * Json web Token
-   *
-   * Setup private and public keys for JWT module
-   */
-  if (!keypair) {
-    // generate new keypair
-    const generateKeypair = require("keypair");
-    keypair = generateKeypair();
-  }
-
-  JWT.main.setKies(keypair.private, keypair.public);
-
-  /**
-   * Data Insertion
-   *
-   * Insert admin user
-   * for the first time
-   */
-  await DataInsertion.createAdminUser(adminUser);
-
-  /**
-   * File Service
-   */
-  FileService.setUploadDirectory(uploadDirectory);
-};

package/src/index.js

@@ -1,66 +0,0 @@
-// Application
-const createRest = require("./application");
-const Schema = require("mongoose").Schema;
-
-// Utilities
-const paginator = require("./class/paginator");
-const reply = require("./class/reply");
-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");
-
-module.exports = {
-  createRest,
-
-  // Database
-  CollectionDefinition,
-  Schemas,
-  Schema,
-  DatabaseTrigger,
-  CmsTrigger,
-  ...SecurityClass,
-
-  // 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/middlewares.js

@@ -1,44 +0,0 @@
-/**
- * Validator module
- * @module class/validator
- */
-let validateObject = require("./class/validator");
-
-/**
- * User manager service
- * @module services/user_manager/service
- */
-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
- * @returns {Promise<void>}
- */
-async function auth(ctx, next) {
-  let headers = ctx.header;
-  let headersValidated = validateObject(headers, "authorization");
-
-  if (!headersValidated.isValid) ctx.throw(401, "authentication is required");
-
-  let token = headers.authorization;
-
-  await userManager.main
-    .getUserByToken(token)
-    .then(async (user) => {
-      ctx.state.user = user;
-      await next();
-    })
-    .catch((err) => {
-      console.log(err);
-      ctx.throw(err.status || 412, err.message);
-    });
-}
-
-module.exports = {
-  auth,
-};