@modular-rest/server 1.11.13 → 1.12.1

package/src/services/user_manager/service.js

@@ -1,377 +0,0 @@
-const User = require("../../class/user");
-const DataProvider = require("../data_provider/service");
-const JWT = require("../jwt/service");
-const { getDefaultPermissionGroups } = require("./permissionManager");
-
-/**
- * import user type
- * @typedef {import('../../class/user')} User
- */
-
-class UserManager {
-  constructor() {
-    this.tempIds = {};
-  }
-
-  /**
-   * Sets a custom method for generating verification codes.
-   *
-   * @param {Function} generatorMethod - A function that returns a random verification code.
-   * @returns {void}
-   */
-  setCustomVerificationCodeGeneratorMethod(generatorMethod) {
-    this.verificationCodeGeneratorMethod = generatorMethod;
-  }
-
-  /**
-   * Get a user by their ID.
-   *
-   * @param {string} id - The ID of the user.
-   * @returns {Promise<User>} A promise that resolves to the user.
-   * @throws {Error} If the user is not found.
-   */
-  generateVerificationCode(id, idType) {
-    if (this.verificationCodeGeneratorMethod)
-      return this.verificationCodeGeneratorMethod(id, idType);
-
-    // this is default code
-    return "123";
-  }
-
-  /**
-   * Get a user by their ID.
-   *
-   * @param {string} id - The ID of the user.
-   * @returns {Promise<User>} A promise that resolves to the user.
-   * @throws {string} If the user is not found.
-   */
-  getUserById(id) {
-    return new Promise(async (done, reject) => {
-      let userModel = DataProvider.getCollection("cms", "auth");
-
-      let userDoc = await userModel
-        .findOne({ _id: id })
-        .select({ password: 0 })
-        .exec()
-        .catch(reject);
-
-      if (!userDoc) {
-        reject("user not found");
-        return;
-      }
-
-      let user = User.loadFromModel(userDoc);
-      done(user);
-    });
-  }
-
-  /**
-   * Get a user by their identity.
-   *
-   * @param {string} id - The identity of the user.
-   * @param {string} idType - The type of the identity (phone or email).
-   * @returns {Promise<User>} A promise that resolves to the user.
-   * @throws {string} If the user is not found.
-   */
-  getUserByIdentity(id, idType) {
-    return new Promise(async (done, reject) => {
-      let userModel = DataProvider.getCollection("cms", "auth");
-
-      let query = {};
-
-      if (idType == "phone") query["phone"] = id;
-      else if (idType == "email") query["email"] = id;
-
-      let userDoc = await userModel
-        .findOne(query)
-        .select({ password: 0 })
-        .exec()
-        .catch(reject);
-
-      if (!userDoc) {
-        reject("user not found");
-        return;
-      }
-
-      let user = User.loadFromModel(userDoc);
-      done(user);
-    });
-  }
-
-  /**
-   * Get a user by their token.
-   *
-   * @param {string} token - The token of the user.
-   * @returns {Promise<User>} A promise that resolves to the user.
-   */
-  async getUserByToken(token) {
-    const { id } = await JWT.main.verify(token);
-    return this.getUserById(id);
-  }
-
-  /**
-   * Check if a verification code is valid.
-   *
-   * @param {string} id - The ID of the user.
-   * @param {string} code - The verification code.
-   * @returns {boolean} Whether the verification code is valid.
-   */
-  isCodeValid(id, code) {
-    let key = false;
-
-    if (
-      this.tempIds.hasOwnProperty(id) &&
-      this.tempIds[id].code.toString() === code.toString()
-    )
-      key = true;
-
-    return key;
-  }
-
-  /**
-   * Login a user and return their token.
-   *
-   * @param {string} id - The ID of the user.
-   * @param {string} idType - The type of the ID (phone or email).
-   * @param {string} password - The password of the user.
-   * @returns {Promise<string>} A promise that resolves to the token of the user.
-   * @throws {string} If the user is not found.
-   */
-  loginUser(id = "", idType = "", password = "") {
-    let token;
-
-    return new Promise(async (done, reject) => {
-      // Get user model
-      const userModel = DataProvider.getCollection("cms", "auth");
-
-      /**
-       * Setup query to find by phone or email
-       */
-      const query = {
-        password: Buffer.from(password).toString("base64"),
-        type: "user",
-      };
-
-      if (idType == "phone") query["phone"] = id;
-      else if (idType == "email") query["email"] = id;
-
-      // Get from database
-      const gottenFromDB = await userModel.findOne(query).exec().catch(reject);
-
-      if (!gottenFromDB) reject("user not found");
-      // Token
-      else {
-        // Load user
-        const user = await User.loadFromModel(gottenFromDB)
-          .then()
-          .catch(reject);
-
-        // Get token payload
-        // This is some information about the user.
-        const payload = user.getBrief();
-
-        // Generate json web token
-        token = await JWT.main.sign(payload).then().catch(reject);
-
-        done(token);
-      }
-    });
-  }
-
-  /**
-   * Issue a token for a user.
-   *
-   * @param {string} email - The email of the user.
-   * @returns {Promise<string>} A promise that resolves to the token of the user.
-   * @throws {string} If the user is not found.
-   */
-  issueTokenForUser(email) {
-    return new Promise(async (done, reject) => {
-      const userModel = DataProvider.getCollection("cms", "auth");
-      const query = { email: email };
-
-      // Get from database
-      const gottenFromDB = await userModel.findOne(query).exec().catch(reject);
-
-      if (!gottenFromDB) reject("user not found");
-
-      const user = await User.loadFromModel(gottenFromDB).then().catch(reject);
-
-      // Get token payload
-      // This is some information about the user.
-      const payload = user.getBrief();
-
-      // Generate json web token
-      await JWT.main.sign(payload).then(done).catch(reject);
-    });
-  }
-
-  /**
-   * Login as an anonymous user.
-   *
-   * @returns {Promise<string>} A promise that resolves to the token of the anonymous user.
-   * @throws {string} If the anonymous user is not found.
-   */
-  loginAnonymous() {
-    let token;
-
-    return new Promise(async (done, reject) => {
-      // Get user model
-      let userModel = DataProvider.getCollection("cms", "auth");
-
-      // Setup query
-      let query = { type: "anonymous" };
-
-      // Get from database
-      let gottenFromDB = await userModel
-        .findOne(query)
-        .exec()
-        .then()
-        .catch(reject);
-
-      // Create a new anonymous user if it doesn't exist.
-      // There are only one anonymous user in the database
-      // and every guest token being generated from it.
-      if (!gottenFromDB) {
-        let newUserId = await this.registerUser({ type: "anonymous" }).catch(
-          reject
-        );
-        gottenFromDB = await this.getUserById(newUserId).catch(reject);
-      }
-
-      // load User
-      let user = await User.loadFromModel(gottenFromDB).then().catch(reject);
-
-      // Get token payload
-      // This is some information about the user.
-      let payload = user.getBrief();
-
-      // Generate json web token
-      token = await JWT.main.sign(payload).then().catch(reject);
-
-      done(token);
-    });
-  }
-
-  /**
-   * Register a temporary ID.
-   *
-   * @param {string} id - The ID to register.
-   * @param {string} type - The type of the ID.
-   * @param {string} code - The verification code.
-   */
-  registerTemporaryID(id, type, code) {
-    this.tempIds[id] = { id: id, type: type, code: code };
-  }
-
-  /**
-   * Submit a password for a temporary ID.
-   *
-   * @param {string} id - The ID.
-   * @param {string} password - The password.
-   * @param {string} code - The verification code.
-   * @returns {Promise<boolean>} A promise that resolves to whether the operation was successful.
-   */
-  async submitPasswordForTemporaryID(id, password, code) {
-    let key = false;
-
-    // If user email|phone has already stored
-    // a new user being created
-    if (
-      this.tempIds.hasOwnProperty(id) &&
-      this.tempIds[id].code.toString() == code.toString()
-    ) {
-      let authDetail = { password: password };
-
-      if (this.tempIds[id].type == "phone") authDetail["phone"] = id;
-      else if (this.tempIds[id].type == "email") authDetail["email"] = id;
-
-      await this.registerUser(authDetail)
-        .then(() => (key = true))
-        .catch((e) => console.log(e));
-    }
-
-    delete this.tempIds[id];
-    return key;
-  }
-
-  /**
-   * Change the password for a temporary ID.
-   *
-   * @param {string} id - The ID.
-   * @param {string} password - The new password.
-   * @param {string} code - The verification code.
-   * @returns {Promise<boolean>} A promise that resolves to whether the operation was successful.
-   */
-  async changePasswordForTemporaryID(id, password, code) {
-    let key = false;
-
-    if (this.tempIds.hasOwnProperty(id) && this.tempIds[id].code == code) {
-      let query = {};
-
-      if (this.tempIds[id].type == "phone") query["phone"] = id;
-      else if (this.tempIds[id].type == "email") query["email"] = id;
-
-      await this.changePassword(query, password)
-        .then(() => (key = true))
-        .catch((e) => console.log(e));
-    }
-
-    delete this.tempIds[id];
-    return key;
-  }
-
-  /**
-   * Register a user.
-   *
-   * @param {Object} detail - The details of the user.
-   * @returns {Promise<string>} A promise that resolves to the ID of the new user.
-   * @throws {string} If the user could not be registered.
-   */
-  registerUser(detail) {
-    return new Promise(async (done, reject) => {
-      // get default permission
-      if (!detail.permissionGroup) {
-        detail.permissionGroup = getDefaultPermissionGroups().title;
-      }
-
-      if (!detail.permissionGroup) {
-        reject("default permission group not found");
-        return;
-      }
-
-      let authM = DataProvider.getCollection("cms", "auth");
-      return User.createFromModel(authM, detail)
-        .then((newUser) => {
-          DataProvider.triggers.call("insertOne", "cms", "auth", {
-            input: detail,
-            output: newUser.dbModel,
-          });
-
-          done(newUser.id);
-        })
-        .catch(reject);
-    });
-  }
-
-  /**
-   * Change the password of a user.
-   *
-   * @param {Object} query - The query to find the user.
-   * @param {string} newPass - The new password.
-   * @returns {Promise<void>} A promise that resolves when the operation is complete.
-   */
-  changePassword(query, newPass) {
-    let update = { $set: { password: newPass } };
-    let authM = DataProvider.getCollection("cms", "auth");
-    return authM.updateOne(query, update).exec().then();
-  }
-
-  static get instance() {
-    return instance;
-  }
-}
-
-const instance = new UserManager();
-module.exports.name = "userManager";
-module.exports.main = UserManager.instance;

package/types/application.d.ts

@@ -1,97 +0,0 @@
-export = createRest;
-/**
- * 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}>}
- */
-declare function createRest(options: {
-    cors?: Cors;
-    modulesPath?: string;
-    uploadDirectory?: string;
-    koaBodyOptions?: object;
-    staticPath?: {
-        rootDir: string;
-        rootPath: string;
-        maxage?: number;
-        hidden?: boolean;
-        index?: string;
-        defer?: boolean;
-        gzip?: boolean;
-        br?: boolean;
-        setHeaders?: Function;
-        extensions?: boolean | any[];
-    };
-    onBeforeInit?: (koaApp: Koa) => void;
-    onAfterInit?: (koaApp: Koa) => void;
-    port?: number;
-    dontListen?: boolean;
-    mongo?: {
-        dbPrefix: string;
-        mongoBaseAddress: string;
-        addressMap?: string;
-    };
-    keypair?: {
-        private: string;
-        public: string;
-    };
-    adminUser?: {
-        email: string;
-        password: string;
-    };
-    verificationCodeGeneratorMethod: () => string;
-    collectionDefinitions?: CollectionDefinition[];
-    permissionGroups?: PermissionGroup[];
-    authTriggers?: CmsTrigger[];
-    fileTriggers?: CmsTrigger[];
-}): Promise<{
-    app: Koa;
-    server: Server;
-}>;
-declare namespace createRest {
-    export { Koa, server, Cors, PermissionGroup, CmsTrigger };
-}
-import cors = require("@koa/cors");
-type Cors = import('@koa/cors').Options;
-type Koa = import('koa');
-type PermissionGroup = import('./class/security.js').PermissionGroup;
-type CmsTrigger = import('./class/cms_trigger.js');
-type server = import('http').Server;

package/types/class/cms_trigger.d.ts

@@ -1,24 +0,0 @@
-export = CmsTrigger;
-/**
- * `CmsTrigger` is a class that defines a callback to be called on a specific database transaction.
- *
- * @class
- */
-declare 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: 'update-one' | 'insert-one' | 'remove-one', callback?: (arg0: {
-        query: any;
-        queryResult: any;
-    }) => void);
-    operation: "update-one" | "insert-one" | "remove-one";
-    callback: (arg0: {
-        query: any;
-        queryResult: any;
-    }) => void;
-}

package/types/class/collection_definition.d.ts

@@ -1,36 +0,0 @@
-export = CollectionDefinition;
-/**
- * @typedef {import('./security.js').Permission} Permission
- * @typedef {import('./database_trigger.js')} DatabaseTrigger
- */
-declare 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 }: {
-        db: string;
-        collection: string;
-        schema: any;
-        permissions: Array<Permission>;
-        triggers?: Array<DatabaseTrigger> | undefined;
-    });
-    database: string;
-    collection: string;
-    schema: any;
-    permissions: import("./security.js").Permission[];
-    triggers: import("./database_trigger.js")[];
-}
-declare namespace CollectionDefinition {
-    export { Permission, DatabaseTrigger };
-}
-type Permission = import('./security.js').Permission;
-type DatabaseTrigger = import('./database_trigger.js');

package/types/class/combinator.d.ts

@@ -1,30 +0,0 @@
-export = Combinator.instance;
-declare var instance: Combinator;
-declare class Combinator {
-    static get instance(): Combinator;
-    combineRoutesByFilePath(rootDirectory: any, app: any): Promise<void>;
-    /**
-     *
-     * @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
-     */
-    combineModulesByFilePath({ rootDirectory, filename, combineWithRoot, convertToArray, }: {
-        rootDirectory: string;
-        filename: {
-            name: string;
-            extension: string;
-        };
-        combineWithRoot: boolean;
-        convertToArray: boolean;
-    }): Promise<any>;
-    combineFunctionsByFilePath({ rootDirectory, filename }: {
-        rootDirectory: any;
-        filename: any;
-    }): Promise<void>;
-    extendObj(obj: any, src: any): any;
-}

package/types/class/database_trigger.d.ts

@@ -1,28 +0,0 @@
-export = DatabaseTrigger;
-/**
- * `DatabaseTrigger` is a class that defines a callback to be called on a specific database transaction.
- *
- * @class
- */
-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: 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: {
-            [x: string]: any;
-        };
-        queryResult: any | any[];
-    }) => void);
-    operation: "find" | "count" | "aggregate" | "find-one" | "update-one" | "insert-one" | "remove-one";
-    callback: (arg0: {
-        query: {
-            [x: string]: any;
-        };
-        queryResult: any | any[];
-    }) => void;
-}

package/types/class/db_schemas.d.ts

@@ -1,2 +0,0 @@
-import mongoose = require("mongoose");
-export let file: mongoose.Schema<mongoose.Document<any, any, any>, mongoose.Model<mongoose.Document<any, any, any>, any, any>, undefined, {}>;

package/types/class/directory.d.ts

@@ -1,2 +0,0 @@
-export function walk(dir: any, settings: any, done: any): void;
-export function find(dir: any, settings: any): Promise<any>;

package/types/class/paginator.d.ts

@@ -1,8 +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.
- */
-export function create(count: number, perPage: number, page: number): any;

package/types/class/reply.d.ts

@@ -1,8 +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.
- */
-export function create(status: string, detail?: any): any;