Update existing model for Waifu entity with additional fields and documentation

Author: a3ryk

src/controllers/v4/images/waifu.js

@@ -39,12 +39,12 @@ const getWaifu = async (req, res, next) => {
 
     if (name) {
       const sanitizedName = _.escapeRegExp(name.trim());
-      filter['names.en'] = { $regex: new RegExp(sanitizedName, 'i') }; // Case-insensitive regex match for English name
+      filter['name.full'] = { $regex: new RegExp(sanitizedName, 'i') }; // Case-insensitive regex match for English name
     }
 
     if (anime) {
       const sanitizedAnime = _.escapeRegExp(anime.trim());
-      filter['from.name'] = { $regex: new RegExp(sanitizedAnime, 'i') }; // Case-insensitive regex match for anime name
+      filter['media.nodes[0].title.userPreferred'] = { $regex: new RegExp(sanitizedAnime, 'i') }; // Case-insensitive regex match for anime name
     }
 
     /**

src/models/schemas/Waifu.js

@@ -8,75 +8,219 @@ const { Schema, model } = mongoose;
  * @class WaifuSchema
  */
 const WaifuSchema = new Schema({
+  /**
+   * The unique identifier for the Waifu.
+   * @type {Number}
+   */
   _id: { type: Number, required: true },
-  names: {
+
+  /**
+   * The name details of the Waifu.
+   * @type {Object}
+   */
+  name: {
     /**
-     * The English name of the waifu.
+     * The first name of the Waifu.
      * @type {String}
      */
-    en: { type: String, required: true },
+    first: { type: String, required: true },
 
     /**
-     * The Japanese name of the waifu.
+     * The middle name of the Waifu.
      * @type {String}
      */
-    jp: { type: String },
+    middle: String,
 
     /**
-     * Alternative name or alias of the waifu.
+     * The last name of the Waifu.
      * @type {String}
      */
-    alt: { type: String },
-  },
-  from: {
+    last: { type: String, required: true },
+
     /**
-     * The name of the source or origin of the waifu.
+     * The full name of the Waifu.
      * @type {String}
      */
-    name: { type: String },
+    full: { type: String, required: true },
 
     /**
-     * The type or category of the source from which the waifu originates.
+     * The native name of the Waifu.
      * @type {String}
      */
-    type: { type: String },
+    native: String,
+
+    /**
+     * The user-preferred name of the Waifu.
+     * @type {String}
+     */
+    userPreferred: { type: String, required: true },
   },
+
   /**
-   * Array of image URLs associated with the waifu.
-   * @type {Array}
+   * The image URL associated with the Waifu.
+   * @type {Object}
    */
-  images: [String],
-
-  statistics: {
+  image: {
     /**
-     * The number of favorites received by the waifu.
-     * @type {Number}
+     * The URL for the large image.
+     * @type {String}
      */
-    fav: { type: Number },
+    large: String,
+    medium: String,
+  },
 
+  /**
+   * The number of favorites for the Waifu.
+   * @type {Number}
+   */
+  favourites: { type: Number, required: true },
+
+  /**
+   * The URL of the Waifu's profile.
+   * @type {String}
+   */
+  siteUrl: { type: String, required: true },
+
+  /**
+   * The description of the Waifu.
+   * @type {String}
+   */
+  description: { type: String, required: true },
+
+  /**
+   * The age range of the Waifu.
+   * @type {String}
+   */
+  age: String,
+
+  /**
+   * The gender of the Waifu.
+   * @type {String}
+   */
+  gender: { type: String, required: true },
+
+  /**
+   * The blood type of the Waifu.
+   * @type {String}
+   */
+  bloodType: String,
+
+  /**
+   * The date of birth of the Waifu.
+   * @type {Object}
+   */
+  dateOfBirth: {
     /**
-     * The number of times the waifu is loved.
+     * The year of birth.
      * @type {Number}
      */
-    love: { type: Number },
+    year: Number,
 
     /**
-     * The number of times the waifu is disliked or hated.
+     * The month of birth.
      * @type {Number}
      */
-    hate: { type: Number },
+    month: Number,
 
     /**
-     * The number of upvotes received by the waifu.
+     * The day of birth.
      * @type {Number}
      */
-    upvote: { type: Number },
+    day: Number,
+  },
 
+  /**
+   * The media information associated with the Waifu.
+   * @type {Object}
+   */
+  media: {
     /**
-     * The number of downvotes received by the waifu.
-     * @type {Number}
+     * The list of media nodes.
+     * @type {Array}
      */
-    downvote: { type: Number },
+    nodes: [
+      {
+        /**
+         * The unique identifier for the media.
+         * @type {Number}
+         */
+        id: { type: Number, required: true },
+
+        /**
+         * The unique identifier for the media on MyAnimeList.
+         * @type {Number}
+         */
+        idMal: { type: Number, required: true },
+
+        /**
+         * The cover image URL for the media (medium size).
+         * @type {Object}
+         */
+        coverImage: {
+          medium: { type: String, required: true },
+        },
+
+        /**
+         * The banner image URL for the media.
+         * @type {String}
+         */
+        bannerImage: String,
+
+        /**
+         * The title information for the media.
+         * @type {Object}
+         */
+        title: {
+          /**
+           * The romaji title of the media.
+           * @type {String}
+           */
+          romaji: { type: String, required: true },
+
+          /**
+           * The English title of the media.
+           * @type {String}
+           */
+          english: { type: String, required: true },
+
+          /**
+           * The native title of the media.
+           * @type {String}
+           */
+          native: { type: String, required: true },
+
+          /**
+           * The user-preferred title of the media.
+           * @type {String}
+           */
+          userPreferred: { type: String, required: true },
+        },
+
+        /**
+         * The list of synonyms for the media title.
+         * @type {Array}
+         */
+        synonyms: [String],
+
+        /**
+         * The popularity rank of the media.
+         * @type {Number}
+         */
+        popularity: Number,
+
+        /**
+         * The type of the media (e.g., ANIME, MANGA).
+         * @type {String}
+         */
+        type: { type: String, required: true },
+
+        /**
+         * The format of the media (e.g., TV, MOVIE).
+         * @type {String}
+         */
+        format: { type: String, required: true },
+      },
+    ],
   },
 });