@modular-rest/server 1.11.4 → 1.11.6

package/src/services/file/service.js

@@ -1,9 +1,10 @@
-const fs = require('file-system');
-const pathModule = require('path');
-const DataProvider = require('./../data_provider/service')
+const fs = require("file-system");
+const pathModule = require("path");
+const DataProvider = require("./../data_provider/service");
+const triggerService = require("./../../class/trigger_operator");
+const { config } = require("./../../config");
 
 class FileService {
-
   constructor() {
     this.directory = null;
   }
@@ -13,9 +14,10 @@ class FileService {
   }
 
   /**
-   * 
-   * @param {string} fileType 
-   * 
+   *
+   * @param {string} fileType
+   * @param {string} tag
+   *
    * @returns storedFile
    * @returns storedFile.fileName
    * @returns storedFile.directory
@@ -23,119 +25,207 @@ class FileService {
    * @returns storedFile.fileFormat
    */
   createStoredDetail(fileType, tag) {
+    const typeParts = fileType.split("/");
+    const fileFormat = typeParts[1] || typeParts[0] || "unknown";
+
+    const time = new Date().getTime();
+    const fileName = `${time}.${fileFormat}`;
 
-    let time = new Date().getTime();
-    let fileFormat = fileType.split('/')[1];
-    let fileName = `${time}.${fileFormat}`;
-    let fullPath = pathModule.join(this.directory, fileFormat, tag, fileName);
+    const fullPath = pathModule.join(
+      FileService.instance.directory,
+      fileFormat,
+      tag,
+      fileName
+    );
 
     return { fileName, fullPath, fileFormat };
   }
 
-
   /**
-   * 
-   * @param args
-   * @param {file} args.file file object
-   * @param {string} args.ownerId file object
+   * Stores a file, removes the given temporary file, and submits file details into the database.
+   *
+   * @param {Object} options - The options for storing the file.
+   * @param {Object} options.file - The file to be stored.
+   * @param {string} options.file.path - The path of the file.
+   * @param {string} options.file.type - The type of the file.
+   * @param {string} options.file.name - The original name of the file.
+   * @param {number} options.file.size - The size of the file.
+   * @param {string} options.ownerId - The ID of the owner of the file.
+   * @param {string} options.tag - The tag associated with the file.
+   * @param {boolean} [options.removeFileAfterStore=true] - Whether to remove the file after storing it.
+   *
+   * @returns {Promise} A promise that resolves with the document of the stored file.
+   *
+   * @throws {string} If the upload directory has not been set.
    */
-  storeFile({ file, ownerId, tag }) {
-
-    if (!this.directory)
-      throw 'upload directory has not been set.'
+  storeFile({ file, ownerId, tag, removeFileAfterStore = true }) {
+    if (!FileService.instance.directory)
+      throw "upload directory has not been set.";
 
     let storedFile;
 
-    return new Promise(async (done, reject) =>
-  /**
-   * Store file and remove temp file
-   */ {
-
-      storedFile = this.createStoredDetail(file.type, tag);
+    return (
+      new Promise(async (done, reject) => /**
+       * Store file and remove temp file
+       */ {
+        storedFile = FileService.instance.createStoredDetail(file.type, tag);
 
-      fs.copyFile(file.path, storedFile.fullPath, {
-        done: (err) => {
-          if (err) reject(err);
-          else done();
+        fs.copyFile(file.path, storedFile.fullPath, {
+          done: (err) => {
+            if (err) reject(err);
+            else done();
 
-          // remove temp file
-          fs.fs.unlinkSync(file.path);
-        }
-      });
-    })
-      /**
-       * Submit file detail into database
-       */
-      .then(() => {
-
-        // Get collection model for access to relative collection
-        let CollectionModel = DataProvider.getCollection('cms', 'file');
-
-        // Create new document
-        let doc = new CollectionModel({
-          owner: ownerId,
-          fileName: storedFile.fileName,
-          originalName: file.name,
-          format: storedFile.fileFormat,
-          tag,
+            // remove temp file
+            if (removeFileAfterStore) fs.fs.unlinkSync(file.path);
+          },
         });
-
-        return doc.save().then(() => doc);
-
-      }).catch(err => {
-
-        // remove stored file 
-        fs.fs.unlinkSync(storedFile.fullPath);
-
-        throw err;
       })
+        /**
+         * Submit file detail into database
+         */
+        .then(() => {
+          // Get collection model for access to relative collection
+          const CollectionModel = DataProvider.getCollection("cms", "file");
+
+          const data = {
+            owner: ownerId,
+            fileName: storedFile.fileName,
+            originalName: file.name,
+            format: storedFile.fileFormat,
+            tag,
+            size: file.size,
+          };
+
+          // Create new document
+          const doc = new CollectionModel(data);
+
+          return doc.save().then((savedDoc) => {
+            triggerService.call("insert-one", "cms", "file", {
+              query: null,
+              queryResult: savedDoc,
+            });
+
+            return savedDoc;
+          });
+        })
+        .catch((err) => {
+          // remove stored file
+          fs.fs.unlinkSync(storedFile.fullPath);
+
+          throw err;
+        })
+    );
   }
 
+  /**
+   * Removes a file from the disk.
+   *
+   * @param {string} path - The path of the file to be removed.
+   * @returns {Promise} A promise that resolves if the file is successfully removed, and rejects if an error occurs.
+   */
   removeFromDisc(path) {
     return new Promise((done, reject) => {
       fs.fs.unlink(path, (err) => {
-        if (err) reject()
-        else done()
+        if (err) reject();
+        else done();
       });
-    })
+    });
   }
 
+  /**
+   * Removes a file from the database and the disk.
+   *
+   * @param {string} fileId - The ID of the file to be removed.
+   * @returns {Promise} A promise that resolves if the file is successfully removed, and rejects if an error occurs.
+   * @throws Will throw an error if upload directory has not been set.
+   */
   removeFile(fileId) {
-
-    if (!this.directory)
-      throw 'upload directory has not been set.'
+    if (!FileService.instance.directory)
+      throw "upload directory has not been set.";
 
     return new Promise(async (done, reject) => {
-      let CollectionModel = DataProvider.getCollection('cms', 'file');
+      let CollectionModel = DataProvider.getCollection("cms", "file");
       let fileDoc = await CollectionModel.findOne({ _id: fileId }).exec();
 
       if (!fileDoc) {
-        reject('file not found');
+        reject("file not found");
         return;
       }
 
-      await CollectionModel.deleteOne({ _id: fileId }).exec()
+      await CollectionModel.deleteOne({ _id: fileId })
+        .exec()
         .then(() => {
-
           // create file path
-          let filePath = pathModule.join(this.directory, fileDoc.format, fileDoc.tag, fileDoc.fileName);
+          const filePath = pathModule.join(
+            FileService.instance.directory,
+            fileDoc.format,
+            fileDoc.tag,
+            fileDoc.fileName
+          );
 
           // Remove file from disc
-          return this.removeFromDisc(filePath)
+          return FileService.instance
+            .removeFromDisc(filePath)
             .catch(async (err) => {
-
-              // Recreate fileDoc if removing file operation has error 
+              // Recreate fileDoc if removing file operation has error
               await new CollectionModel(fileDoc).save();
 
               throw err;
-            })
-
+            });
+        })
+        .then(() => {
+          triggerService.call("remove-one", "cms", "file", {
+            query: { _id: fileId },
+            queryResult: null,
+          });
         })
         .then(done)
-        .catch(reject)
-    })
+        .catch(reject);
+    });
+  }
+
+  /**
+   * Retrieves a file from the database.
+   *
+   * @param {string} fileId - The ID of the file to be retrieved.
+   * @returns {Promise} A promise that resolves with the file document, or rejects if an error occurs.
+   */
+  getFile(fileId) {
+    const CollectionModel = DataProvider.getCollection("cms", "file");
+
+    return CollectionModel.findOne({ _id: fileId }).exec();
+  }
+
+  /**
+   * Retrieves the link of a file.
+   *
+   * @param {string} fileId - The ID of the file to get the link for.
+   * @returns {Promise} A promise that resolves with the file link, or rejects if an error occurs.
+   */
+  async getFileLink(fileId) {
+    const fileDoc = await FileService.instance.getFile(fileId);
+
+    const link =
+      config.staticPath.rootPath +
+      `/${fileDoc.format}/${fileDoc.tag}/` +
+      fileDoc.fileName;
+
+    return link;
+  }
+
+  async getFilePath(fileId) {
+    const { fileName, format, tag } = await FileService.instance.getFile(
+      fileId
+    );
+    const fullPath = pathModule.join(
+      FileService.instance.directory,
+      format,
+      tag,
+      fileName
+    );
+    return fullPath;
   }
 }
 
-FileService.instance = new FileService()
-module.exports = FileService.instance;
+FileService.instance = new FileService();
+module.exports = FileService.instance;

package/src/services/functions/router.js

@@ -13,7 +13,10 @@ functionRouter.use("/", middleware.auth, async (ctx, next) => {
 
   // fields validation
   if (!bodyValidated.isValid) {
-    ctx.throw(412, JSON.stringify(reply("e", { e: bodyValidated.requires })));
+    ctx.throw(
+      412,
+      JSON.stringify(reply("e", { error: bodyValidated.requires }))
+    );
   }
 
   await next();
@@ -26,7 +29,7 @@ functionRouter.post(`/run`, middleware.auth, async (ctx) => {
     const result = await service.runFunction(name, args, ctx.state.user);
     ctx.body = JSON.stringify(reply("s", { data: result }));
   } catch (e) {
-    ctx.throw(400, JSON.stringify(reply("e", { e: e.message })));
+    ctx.throw(400, JSON.stringify(reply("e", { error: e.message })));
   }
 });
 

package/src/services/user_manager/service.js

@@ -14,18 +14,21 @@ class UserManager {
   }
 
   /**
-   * Set a custom method for generating verification codes.
-   * @param {function} method - A method that returns a random verification code.
+   * Sets a custom method for generating verification codes.
+   *
+   * @param {Function} generatorMethod - A function that returns a random verification code.
+   * @returns {void}
    */
-  setCustomVerificationCodeGeneratorMethod(method) {
-    this.verificationCodeGeneratorMethod = method;
+  setCustomVerificationCodeGeneratorMethod(generatorMethod) {
+    this.verificationCodeGeneratorMethod = generatorMethod;
   }
 
   /**
-   * Generate a verification code.
-   * @param {string} id - The ID for which to generate the verification code.
-   * @param {string} idType - The type of the ID.
-   * @returns {string} The generated verification code.
+   * 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)
@@ -37,6 +40,7 @@ class UserManager {
 
   /**
    * 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.
@@ -63,6 +67,7 @@ class UserManager {
 
   /**
    * 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.
@@ -95,6 +100,7 @@ class UserManager {
 
   /**
    * Get a user by their token.
+   *
    * @param {string} token - The token of the user.
    * @returns {Promise<User>} A promise that resolves to the user.
    */
@@ -105,6 +111,7 @@ class UserManager {
 
   /**
    * 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.
@@ -123,6 +130,7 @@ class UserManager {
 
   /**
    * 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.
@@ -172,6 +180,7 @@ class UserManager {
 
   /**
    * 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.
@@ -199,6 +208,7 @@ class UserManager {
 
   /**
    * 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.
    */
@@ -245,6 +255,7 @@ class UserManager {
 
   /**
    * 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.
@@ -255,6 +266,7 @@ class UserManager {
 
   /**
    * Submit a password for a temporary ID.
+   *
    * @param {string} id - The ID.
    * @param {string} password - The password.
    * @param {string} code - The verification code.
@@ -285,6 +297,7 @@ class UserManager {
 
   /**
    * Change the password for a temporary ID.
+   *
    * @param {string} id - The ID.
    * @param {string} password - The new password.
    * @param {string} code - The verification code.
@@ -310,6 +323,7 @@ class UserManager {
 
   /**
    * 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.
@@ -342,6 +356,7 @@ class UserManager {
 
   /**
    * 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.