@modular-rest/server 1.11.12 → 1.12.0

package/src/application.js

@@ -1,239 +0,0 @@
-const koa = require("koa");
-const cors = require("@koa/cors");
-const koaBody = require("koa-body");
-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");
-const UserService = require("./services/user_manager/service");
-
-const defaultServiceRoot = __dirname + "/services";
-
-/**
- * @typedef {import('koa')} Koa
- * @typedef {import('http').Server} server
- * @typedef {import('@koa/cors').Options} Cors
- * @typedef {import('./class/security.js').PermissionGroup} PermissionGroup
- * @typedef {import('./class/cms_trigger.js')} CmsTrigger
- */
-
-const {
-  config,
-  setConfig
-} = require("./config");
-
-/**
- * Create a modular REST instance with Koa and MongoDB support.
- * @param {{
- *   cors?: Cors; // CORS options.
- *   modulesPath?: string; // Root directory of your router.js/db.js files.
- *   uploadDirectory?: string; // Root directory of your uploaded 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?: 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}>}
- */
-async function createRest(options) {
-  setConfig({
-    port: 3000,
-    dontListen: false,
-    mongo: {
-      atlas: false,
-      mongoBaseAddress: "mongodb://localhost:27017",
-      dbPrefix: "mrest_",
-    },
-    adminUser: {
-      email: "admin@email.com",
-      password: "@dmin",
-    },
-
-    ...options,
-  });
-
-  const app = new koa();
-
-  /**
-   * Plug in Cors
-   */
-  app.use(cors(config.cors || {}));
-
-  /**
-   * Plug in BodyParser
-   */
-  const bodyParserOptions = {
-    multipart: true,
-    ...(config.koaBodyOptions || {}),
-  };
-  app.use(koaBody(bodyParserOptions));
-
-  /**
-   * Plug In KoaStatic
-   */
-  if (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)
-      )
-    );
-  }
-
-  /**
-   * Run before hook
-   */
-  if (config.onBeforeInit) config.onBeforeInit(app);
-
-  /**
-   * Setup default services
-   *
-   * - Collect and plug in router.js/db.js of default services
-   * - Setting up default services
-   */
-
-  // 1. Plug in default routes
-  await Combination.combineRoutesByFilePath(path.join(defaultServiceRoot), app);
-
-  // Collect default databaseDefinitions
-  const defaultDatabaseDefinitionList =
-    await Combination.combineModulesByFilePath({
-      rootDirectory: defaultServiceRoot,
-      filename: {
-        name: "db",
-        extension: ".js",
-      },
-      combineWithRoot: true,
-    });
-
-  // 2. Plug in default databaseDefinitions
-  await DataProvider.addCollectionDefinitionByList({
-    list: defaultDatabaseDefinitionList,
-    mongoOption: config.mongo,
-  });
-
-  /**
-   * User Services
-   *
-   * 3. Plug in routes and database
-   */
-  if (config.modulesPath) {
-    // Plug in user routes
-    await Combination.combineRoutesByFilePath(config.modulesPath, app);
-
-    // Collect user CollectionDefinitions (db.js files)
-    let userDatabaseDetail = [];
-    userDatabaseDetail = await Combination.combineModulesByFilePath({
-      rootDirectory: config.modulesPath,
-      filename: {
-        name: "db",
-        extension: ".js",
-      },
-      combineWithRoot: true,
-    });
-
-    // Combine additional CollectionDefinitions
-    if (config.collectionDefinitions) {
-      userDatabaseDetail.concat(config.collectionDefinitions);
-    }
-
-    // Plug in user CollectionDefinitions
-    await DataProvider.addCollectionDefinitionByList({
-      list: userDatabaseDetail || [],
-      mongoOption: config.mongo,
-    });
-
-    // Plug in Verification method
-    if (typeof config.verificationCodeGeneratorMethod == "function") {
-      UserService.main.setCustomVerificationCodeGeneratorMethod(
-        config.verificationCodeGeneratorMethod
-      );
-    }
-
-    // 4. plug in modular functions
-    await Combination.combineFunctionsByFilePath({
-      rootDirectory: config.modulesPath,
-      filename: {
-        name: "functions",
-        extension: ".js",
-      },
-    });
-  }
-
-  // 4. Setting up default services
-  try {
-    await require("./helper/presetup_services").setup(options);
-  } catch (e) {
-    return Promise.reject(e);
-  }
-
-  /**
-   * Run the server
-   *
-   * return KOA app object
-   */
-  return new Promise((done, reject) => {
-    try {
-      let server;
-
-      if (!config.dontListen) {
-        server = app.listen(config.port);
-
-        console.log(
-          "\x1b[35m",
-          `KOAS has been launched on: localhost:${config.port}`
-        );
-      }
-
-      // on after init
-      if (config.onAfterInit) config.onAfterInit(app);
-
-      done({
-        app,
-        server,
-      });
-    } catch (err) {
-      reject(err);
-    }
-  });
-}
-
-module.exports = createRest;

package/src/class/cms_trigger.js

@@ -1,20 +0,0 @@
-/**
- * `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/collection_definition.js

@@ -1,33 +0,0 @@
-/**
- * @typedef {import('./security.js').Permission} Permission
- * @typedef {import('./database_trigger.js')} DatabaseTrigger
- */
-
-class CollectionDefinition {
-  /**
-   * This class helps to create a mongoose collection
-   * associated with permissions and triggers.
-   *
-   * @class
-   * @param {Object} option
-   * @param {string} option.db - Database name
-   * @param {string} option.collection - Collection name
-   * @param {Object} option.schema - Mongoose schema
-   * @param {Array<Permission>} option.permissions - A list of permissions for this collection
-   * @param {Array<DatabaseTrigger>=} option.triggers - A database trigger
-   */
-  constructor({ db, collection, schema, permissions, triggers }) {
-    // string
-    this.database = db;
-    // string
-    this.collection = collection;
-    // schema object of mongoose
-    this.schema = schema;
-    // a list of Permission for this collection
-    this.permissions = permissions;
-
-    this.triggers = triggers;
-  }
-}
-
-module.exports = CollectionDefinition;

package/src/class/combinator.js

@@ -1,133 +0,0 @@
-const Router = require("koa-router");
-const directory = require("./directory.js");
-const { addFunction } = require("./../services/functions/service.js");
-
-class Combinator {
-  async combineRoutesByFilePath(rootDirectory, app) {
-    // find route paths
-    let option = { name: "router", filter: [".js"] };
-    let routerPaths = await directory
-      .find(rootDirectory, option)
-      .then()
-      .catch((e) => {
-        console.log(e);
-      });
-
-    // create and combine routes into the app
-    for (let i = 0; i < routerPaths.length; i++) {
-      let service = require(routerPaths[i]);
-      let name = service.name;
-
-      var serviceRouter = new Router();
-      serviceRouter.use(`/${name}`, service.main.routes());
-
-      app.use(serviceRouter.routes());
-    }
-  }
-
-  /**
-   *
-   * @param {object} option
-   * @param {string} option.rootDirectory root directory of files
-   * @param {object} option.filename an object of {name, extension}
-   * @param {string} option.filename.name name of file
-   * @param {string} option.filename.extension the extension of the file
-   * @param {boolean} option.combineWithRoot combine all file content and return theme as a object
-   * @param {boolean} option.convertToArray return file content as an array instead an object
-   */
-  async combineModulesByFilePath({
-    rootDirectory,
-    filename,
-    combineWithRoot,
-    convertToArray,
-  }) {
-    // find route paths
-    let rootObject_temp;
-    const option = { name: filename.name, filter: [filename.extension] };
-    const modulesPath = await directory
-      .find(rootDirectory, option)
-      .then()
-      .catch((e) => {
-        console.log(e);
-      });
-
-    // create and combine routes into the app
-    for (let i = 0; i < modulesPath.length; i++) {
-      const moduleObject = require(modulesPath[i]);
-
-      // act by otherOption
-      if (combineWithRoot) {
-        if (moduleObject.name) delete moduleObject.name;
-
-        if (moduleObject.length) {
-          if (!rootObject_temp) rootObject_temp = [];
-
-          rootObject_temp = [...rootObject_temp, ...moduleObject];
-        } else {
-          rootObject_temp = this.extendObj(rootObject_temp, moduleObject);
-        }
-        // else if (typeof)
-      }
-      // default act
-      else {
-        const name = moduleObject.name;
-        rootObject_temp[name] = moduleObject;
-      }
-    }
-
-    // options
-    // convertToArray
-    if (convertToArray) {
-      rootObject_temp = Object.values(rootObject_temp);
-    }
-
-    // set result to main rootObject
-    return rootObject_temp;
-  }
-
-  async combineFunctionsByFilePath({ rootDirectory, filename }) {
-    // find route paths
-    const option = { name: filename.name, filter: [filename.extension] };
-    const functionsPaths = await directory
-      .find(rootDirectory, option)
-      .then()
-      .catch((e) => {
-        console.log(e);
-      });
-
-    // create and combine routes into the app
-    for (let i = 0; i < functionsPaths.length; i++) {
-      const modularFunctions = require(functionsPaths[i]);
-
-      if (!modularFunctions.functions) {
-        throw new Error(
-          `Module file ${functionsPaths[i]} does not have functions property.`
-        );
-      }
-
-      // if array
-      if (modularFunctions.functions.length) {
-        for (const moduleFunction of modularFunctions.functions) {
-          addFunction(moduleFunction);
-        }
-      } else {
-        addFunction(modularFunctions.functions);
-      }
-    }
-  }
-
-  extendObj(obj, src) {
-    for (var key in src) {
-      if (src.hasOwnProperty(key)) obj[key] = src[key];
-    }
-    return obj;
-  }
-
-  static get instance() {
-    return instance;
-  }
-}
-
-const instance = new Combinator();
-
-module.exports = Combinator.instance;

package/src/class/database_trigger.js

@@ -1,20 +0,0 @@
-/**
- * `DatabaseTrigger` is a class that defines a callback to be called on a specific database transaction.
- *
- * @class
- */
-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: 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) => {}) {
-    this.operation = operation;
-    this.callback = callback;
-  }
-}
-
-module.exports = DatabaseTrigger;

package/src/class/db_schemas.js

@@ -1,18 +0,0 @@
-var mongoose = require("mongoose");
-var Schema = mongoose.Schema;
-
-module.exports = {
-  file: new Schema(
-    {
-      originalName: String,
-      fileName: String,
-      owner: String,
-      format: String,
-      // 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

@@ -1,31 +0,0 @@
-/**
- * Creates a pagination object based on the given parameters.
- * @param {number} count - The total number of items to paginate.
- * @param {number} perPage - The number of items to display per page.
- * @param {number} page - The current page number.
- * @returns {Object} - An object containing pagination information.
- */
-function create(count, perPage, page) {
-  const totalPages = Math.ceil(count / perPage);
-  
-  if (page > totalPages) page = 1;
-
-  let from = 0;
-  if (perPage == 1) from = page - 1;
-  else from = (perPage * page) - perPage;
-
-  if (page <= 1) from = 0;
-
-  let result = {
-    'pages': totalPages,
-    'page': page,
-    'from': from,
-    'to': perPage
-  };
-
-  return result;
-};
-
-module.exports = {
-  create,
-}

package/src/class/reply.js

@@ -1,37 +0,0 @@
-/**
- * Creates a response object with the given status and detail.
- *
- * @param {string} status - The status of the response. Can be "s" for success, "f" for fail, or "e" for error.
- * @param {Object} [detail={}] - The detail of the response. Can contain any additional information about the response.
- * @returns {Object} - The response object with the given status and detail.
- */
-function create(status, detail = {}) {
-
-    let result = detail || {};
-
-    // define status
-    switch (status) {
-        case 's':
-            result['status'] = 'success';
-            break;
-
-        case 'f':
-            result['status'] = 'fail';
-            break;
-
-        case 'e':
-            result['status'] = 'error';
-            break;
-
-        default:
-            result['status'] = 'success';
-            break;
-    }
-
-    // return
-    return result;
-}
-
-module.exports = {
-    create
-}

package/src/class/security.js

@@ -1,141 +0,0 @@
-/**
- * Class representing an access definition.
- */
-class AccessDefinition {
-  /**
-   * Create an access definition.
-   * @param {Object} options - The options for the access definition.
-   * @param {string} options.database - The name of the database.
-   * @param {string} options.collection - The name of the collection.
-   * @param {Array.<Permission>} options.permissionList - The list of permissions.
-   */
-  constructor({ database, collection, permissionList }) {
-    this.database = database;
-    this.collection = collection;
-    this.permissionList = permissionList;
-  }
-}
-
-/**
- * @typedef {('god_access'|'user_access'|'upload_file_access'|'remove_file_access'|'anonymous_access'|'advanced_settings'|string)} PermissionType
- */
-
-/**
- * Class representing a permission.
- */
-class Permission {
-  /**
-   * Create a permission.
-   * @param {Object} options - The options for the permission.
-   * @param {PermissionType} options.type - The type of the permission.
-   * @param {boolean} [options.read=false] - The read access of the permission.
-   * @param {boolean} [options.write=false] - The write access of the permission.
-   * @param {boolean} [options.onlyOwnData=false] - If true, users can perform CRUD on documents that they created already.
-   * @param {string} [options.ownerIdField='refId'] - The name of the field that contains the owner's id of the document.
-   */
-  constructor({
-    type,
-    read = false,
-    write = false,
-    onlyOwnData = false,
-    ownerIdField = "refId",
-  }) {
-    this.type = type;
-    this.read = read;
-    this.write = write;
-    this.onlyOwnData = onlyOwnData;
-    this.ownerIdField = ownerIdField;
-  }
-}
-
-/**
- * Class representing different types of permissions.
- * Each static getter returns a string that represents a specific type of permission.
- */
-class PermissionTypes {
-  /**
-   * Get the string representing god access permission type.
-   * @return {string} The god access permission type.
-   */
-  static get god_access() {
-    return "god_access";
-  }
-
-  /**
-   * Get the string representing advanced settings permission type.
-   * @return {string} The advanced settings permission type.
-   */
-  static get advanced_settings() {
-    return "advanced_settings";
-  }
-
-  /**
-   * Get the string representing user access permission type.
-   * @return {string} The user access permission type.
-   */
-  static get user_access() {
-    return "user_access";
-  }
-
-  /**
-   * Get the string representing upload file access permission type.
-   * @return {string} The upload file access permission type.
-   */
-  static get upload_file_access() {
-    return "upload_file_access";
-  }
-
-  /**
-   * Get the string representing remove file access permission type.
-   * @return {string} The remove file access permission type.
-   */
-  static get remove_file_access() {
-    return "remove_file_access";
-  }
-}
-
-class PermissionGroup {
-  /**
-   * Create a permission group.
-   * @param {Object} options - The options for the permission group.
-   * @param {string} options.title - The title of the permission group.
-   * @param {boolean} [options.isDefault=false] - If true, the permission group is the default permission group.
-   * @param {boolean} [options.isAnonymous=false] - If true, the permission group is the anonymous permission group.
-   * @param {Array.<PermissionType>} [options.validPermissionTypes=[]] - The valid permission types of the permission group.
-   * @return {PermissionGroup} The created permission group.
-   */
-  constructor({
-    title,
-    isDefault = false,
-    isAnonymous = false,
-    validPermissionTypes = [],
-  }) {
-    //
-    this.title = title;
-
-    this.isDefault = isDefault;
-    this.isAnonymous = isAnonymous;
-
-    this.validPermissionTypes = validPermissionTypes;
-  }
-}
-
-/**
- * Class representing access types.
- */
-class AccessTypes {
-  static get read() {
-    return "read";
-  }
-  static get write() {
-    return "write";
-  }
-}
-
-module.exports = {
-  AccessDefinition,
-  Permission,
-  PermissionTypes,
-  PermissionGroup,
-  AccessTypes,
-};