@modular-rest/server 1.7.0 → 1.10.0

package/src/config.js

@@ -0,0 +1,63 @@
+/**
+ * @typedef {import('koa')} Koa
+ * @typedef {import('@koa/cors').Options} Cors
+ * @typedef {import('./class/collection_definition')} CollectionDefinition
+ * @typedef {import('./class/security').PermissionGroup} PermissionGroup
+ */
+
+/**
+ * @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.
+ *   };
+ *   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.
+ * }} Config
+ * @exports Config
+ */
+
+/**
+ * @param {Config} options
+ */
+function setConfig(options) {
+  Object.assign(config, options);
+}
+
+/**
+ * @type {Config}
+ */
+const config = {};
+
+module.exports = {
+  setConfig,
+  config,
+};

package/src/helper/data_insertion.js

@@ -1,87 +1,24 @@
 const DataProvider = require("../services/data_provider/service");
-
-function createPermissions() {
-  let model = DataProvider.getCollection("cms", "permission");
-
-  return new Promise(async (done, reject) => {
-    // create customer permission
-    let isAnonymousExisted = await model
-      .countDocuments({ title: "anonymous" })
-      .exec()
-      .catch(reject);
-    let isCoustomerExisted = await model
-      .countDocuments({ title: "customer" })
-      .exec()
-      .catch(reject);
-    let isAdministratorExisted = await model
-      .countDocuments({ title: "administrator" })
-      .exec()
-      .catch(reject);
-
-    if (!isAnonymousExisted) {
-      await new model({
-        anonymous_access: true,
-        isAnonymous: true,
-        title: "anonymous",
-      })
-        .save()
-        .catch(reject);
-    }
-
-    if (!isCoustomerExisted) {
-      await new model({
-        customer_access: true,
-        anonymous_access: true,
-        upload_file_access: true,
-        remove_file_access: true,
-        isDefault: true,
-        title: "customer",
-      })
-        .save()
-        .catch(reject);
-    }
-
-    if (!isAdministratorExisted) {
-      await new model({
-        god_access: true,
-        customer_access: true,
-        anonymous_access: true,
-        upload_file_access: true,
-        remove_file_access: true,
-        title: "administrator",
-      })
-        .save()
-        .catch(reject);
-    }
-
-    done();
-  });
-}
+const {
+  getDefaultAnonymousPermissionGroup,
+  getDefaultAdministratorPermissionGroup,
+} = require("../services/user_manager/permissionManager");
 
 async function createAdminUser({ email, password }) {
-  let permissionModel = DataProvider.getCollection("cms", "permission");
   let authModel = DataProvider.getCollection("cms", "auth");
 
   try {
-    let isAnonymousExisted = await authModel
+    const isAnonymousExisted = await authModel
       .countDocuments({ type: "anonymous" })
       .exec();
 
-    let isAdministratorExisted = await authModel
+    const isAdministratorExisted = await authModel
       .countDocuments({ type: "user", email: email })
       .exec();
 
-    let anonymousPermission = await permissionModel
-      .findOne({ title: "anonymous" })
-      .exec();
-
-    let administratorPermission = await permissionModel
-      .findOne({ title: "administrator" })
-      .exec();
-
     if (isAnonymousExisted == 0) {
       await new authModel({
-        permission: anonymousPermission._id,
+        permission: getDefaultAnonymousPermissionGroup().title,
         email: "",
         phone: "",
         password: "",
@@ -90,8 +27,12 @@ async function createAdminUser({ email, password }) {
     }
 
     if (isAdministratorExisted == 0) {
+      if (!email || !password) {
+        return Promise.reject("Invalid email or password for admin user.");
+      }
+
       await new authModel({
-        permission: administratorPermission._id,
+        permission: getDefaultAdministratorPermissionGroup().title,
         email: email,
         password: password,
         type: "user",
@@ -103,6 +44,5 @@ async function createAdminUser({ email, password }) {
 }
 
 module.exports = {
-  createPermissions,
   createAdminUser,
 };

package/src/helper/presetup_services.js

@@ -19,22 +19,10 @@ module.exports.setup = async ({ keypair, adminUser, uploadDirectory }) => {
   /**
    * Data Insertion
    *
-   * Insert permissions and admin user
+   * Insert admin user
    * for the first time
    */
-  await DataInsertion.createPermissions().catch((err) => {
-    console.log(
-      "Error while creating permissions, it seems data is already inserted.",
-      err
-    );
-  });
-
-  await DataInsertion.createAdminUser(adminUser).catch((err) => {
-    console.log(
-      "Error while creating admin user, it seems data is already inserted.",
-      err
-    );
-  });
+  await DataInsertion.createAdminUser(adminUser);
 
   /**
    * File Service

package/src/index.js

@@ -19,16 +19,24 @@ const userManager = require("./services/user_manager/service");
 
 module.exports = {
   createRest,
+
+  // Route utilities
   reply,
   TypeCasters,
   paginator,
   validator,
+
+  // Service utilities
   getCollection,
+
+  // Database
   CollectionDefinition,
   Schemas,
   Schema,
   DatabaseTrigger,
   ...SecurityClass,
+
+  // Middlewares
   middleware,
   userManager: userManager.main,
 };