Added query filter using character name or anime

src/controllers/v4/images/waifu.js

@@ -1,3 +1,4 @@
+import createError from 'http-errors';
 import Waifus from '../../../models/schemas/Waifu.js';
 import Stats from '../../../models/schemas/Stat.js';
 
@@ -14,20 +15,49 @@ import Stats from '../../../models/schemas/Stat.js';
  * @returns {Object} JSON object containing the random waifu.
  * @example
  * // Example usage in Express route handler
- * getRandomWaifu(req, res, next);
+ * getWaifu(req, res, next);
  */
-const getRandomWaifu = async (req, res, next) => {
+const getWaifu = async (req, res, next) => {
   try {
+    /**
+     * Extracts character name and anime parameters from the request query.
+     * @type {Object}
+     */
+    const { name, anime } = req.query;
+
+    /**
+     * Holds the filter object based on the optional character name and anime name parameters.
+     * @type {Object}
+     */
+    const filter = {};
+
+    /**
+     * Add conditions to filter object based on request parameters
+     * @type {Object}
+     */
+
+    if (name) {
+      filter['names.en'] = { $regex: new RegExp(name, 'i') }; // Case-insensitive regex match for English name
+    }
+
+    if (anime) {
+      filter['from.name'] = { $regex: new RegExp(anime, 'i') }; // Case-insensitive regex match for anime name
+    }
+
     /**
      * Holds the result of the random waifu retrieval.
      * @type {Object}
      */
     const [result] = await Waifus.aggregate([
-      // Select a random document from the results
+      { $match: filter }, // Apply filter conditions (if any)
       { $sample: { size: 1 } },
       { $project: { __v: 0 } },
     ]);
 
+    // If no fact is found, return a 404 error
+    if (!result) {
+      return next(createError(404, 'Could not find any matching waifu'));
+    }
     /**
      * Responds with a JSON object containing the random waifu.
      * @type {Object}
@@ -61,4 +91,4 @@ const getRandomWaifu = async (req, res, next) => {
   }
 };
 
-export default getRandomWaifu;
+export default getWaifu;

src/routes/v4/images/waifu.js

@@ -1,5 +1,5 @@
 import { Router } from 'express';
-import getRandomWaifu from '../../../controllers/v4/images/waifu.js';
+import getWaifu from '../../../controllers/v4/images/waifu.js';
 import createRateLimiter from '../../../middlewares/rateLimit.js';
 import authorize from '../../../middlewares/authorize.js';
 import incrementData from '../../../middlewares/database/add.js';
@@ -13,7 +13,7 @@ router
   /**
    * @api {get} v4/waifu Get a Random Waifu
    * @apiDescription Retrieve a random Waifu.
-   * @apiName getRandomWaifu
+   * @apiName getWaifu
    * @apiGroup images
    * @apiPermission user
    *
@@ -31,7 +31,7 @@ router
    * @returns {function} Express middleware function that handles rate limiting.
    *
    */
-  .get(authorize(config.roles.USER), createRateLimiter(), getRandomWaifu)
+  .get(authorize(config.roles.USER), createRateLimiter(), getWaifu)
   /**
    * @api {post} v4/waifu Increment Waifu Data
    * @apiDescription Increment data related to Waifus (only accessible by database moderators).