feat(api): added rewards route to get and post rewards

Author: a3ryk

src/controllers/v4/internal/rewards.js

@@ -0,0 +1,105 @@
+import System from '../../../models/schemas/System.js';
+
+/**
+ * Fetches rewards/rewards from the system.
+ * Supports:
+ * - All rewards
+ * - Filtering by type (coupon, giftcard, voucher)
+ * - Fetching a specific reward by its ID/code
+ */
+export const getRewards = async (req, res) => {
+  try {
+    const key = req.headers.key;
+    const { id } = req.params;
+    const { type } = req.query;
+
+    // Authorization check
+    // if (!key || key !== process.env.ACCESS_KEY) {
+    //   return res.status(401).json({ message: 'Unauthorized' });
+    // }
+
+    // Fetch only the rewards field
+    const system = await System.findById('system').select('rewards');
+
+    if (!system || !Array.isArray(system.rewards)) {
+      return res.status(404).json({ message: 'No rewards found' });
+    }
+
+    // If an ID is provided, return that specific reward
+    if (id) {
+      const reward = system.rewards.find(r => r._id === id);
+      if (!reward) {
+        return res.status(404).json({ message: 'Reward not found' });
+      }
+      return res.status(200).json(reward);
+    }
+
+    // Otherwise, return all (optionally filtered by type)
+    let rewards = system.rewards.filter(r => r.isActive);
+    if (type) {
+      rewards = rewards.filter(r => r.type === type);
+    }
+
+    return res.status(200).json({
+      count: rewards.length,
+      rewards,
+    });
+  } catch (error) {
+    console.error('Error fetching rewards:', error);
+    return res.status(500).json({ message: 'Internal Server Error' });
+  }
+};
+
+/**
+ * Creates a new reward (giftcard, coupon, voucher) and adds it to the system.
+ */
+export const createReward = async (req, res) => {
+  try {
+    const key = req.headers.key;
+
+    // Authorization check
+    if (!key || key !== process.env.ACCESS_KEY) {
+      return res.status(401).json({ message: 'Unauthorized' });
+    }
+
+    const { id, type, description, discount, appliesTo, usage, validFrom, validUntil, isActive = true } = req.body;
+
+    if (!id || !type || !discount || !discount.type || discount.value === undefined) {
+      return res.status(400).json({ message: 'Missing required reward fields' });
+    }
+
+    const system = await System.findById('system');
+    if (!system) {
+      return res.status(404).json({ message: 'System not found' });
+    }
+
+    // Check for existing reward with same ID
+    const exists = system.rewards.find(r => r._id === id);
+    if (exists) {
+      return res.status(409).json({ message: 'Reward with this ID already exists' });
+    }
+
+    const newReward = {
+      _id: id,
+      type,
+      description,
+      discount,
+      appliesTo: appliesTo || {},
+      usage: usage || {},
+      validFrom,
+      validUntil,
+      isActive,
+    };
+
+    system.rewards.push(newReward);
+    await system.save();
+
+    return res.status(201).json({
+      message: 'Reward created successfully',
+      reward: newReward,
+    });
+  } catch (error) {
+    console.error('Error creating reward:', error);
+    return res.status(500).json({ message: 'Internal Server Error' });
+  }
+};

src/routes/v4/index.js

@@ -1256,6 +1256,21 @@ import pageRoutes from './internal/pages.js';
  */
 router.use('/pages', pageRoutes);
 
+import rewardsRoutes from './internal/rewards.js';
+/**
+ * @api {use} Mount Rewards Routes
+ * @apiDescription Mount the rewards-related routes for handling interactions.
+ * @apiName UseRewardsRoutes
+ * @apiGroup Routes
+ *
+ * @apiSuccess {Object} routes Rewards-related routes mounted on the parent router.
+ *
+ * @function createRewardsRoutes
+ * @description Creates and returns a set of routes for handling interactions related to rewards.
+ * @returns {Object} Rewards-related routes.
+ */
+router.use('/rewards', rewardsRoutes);
+
 /**
  * Exporting the router for use in other parts of the application.
  * @exports {Router} router - Express Router instance with mounted routes.

src/routes/v4/internal/rewards.js

@@ -0,0 +1,69 @@
+import { Router } from 'express';
+import { createReward, getRewards } from '../../../controllers/v4/internal/rewards.js';
+import createRateLimiter from '../../../middlewares/rateLimit.js';
+
+const router = Router();
+
+router
+  .route('/')
+  /**
+   * @api {get} v4/rewards Get All Rewards
+   * @apiDescription Fetch all available rewards (coupons, vouchers, giftcards).
+   * @apiName getRewards
+   * @apiGroup Rewards
+   * @apiPermission internal
+   *
+   * @apiHeader {String} Key Internal access token
+   *
+   * @apiSuccess {Array} rewards List of available rewards.
+   * @apiError (Unauthorized 401) Unauthorized Invalid or missing access key.
+   * @apiError (Internal Server Error 500) InternalServerError An error occurred while fetching rewards.
+   */
+  .get(createRateLimiter(), getRewards)
+  /**
+   * @api {post} v4/rewards Create a New Reward
+   * @apiDescription Create a new reward entry for use as a giftcard, coupon, or voucher.
+   * @apiName createReward
+   * @apiGroup Rewards
+   * @apiPermission admin
+   *
+   * @apiHeader {String} Key Internal access token
+   *
+   * @apiBody {String} _id Unique ID of the reward.
+   * @apiBody {String} type Reward type (coupon, giftcard, voucher).
+   * @apiBody {Object} discount Discount details.
+   * @apiBody {Object} appliesTo (optional) Role/plan filters.
+   * @apiBody {Object} usage (optional) Max usage/conditions.
+   * @apiBody {Date} validFrom (optional) Validity start.
+   * @apiBody {Date} validUntil (optional) Validity end.
+   * @apiBody {Boolean} isActive Whether reward is currently active.
+   *
+   * @apiSuccess {Object} reward Created reward object.
+   * @apiError (Bad Request 400) BadRequest Missing or invalid fields.
+   * @apiError (Conflict 409) Conflict Reward with this ID already exists.
+   * @apiError (Unauthorized 401) Unauthorized Invalid or missing access key.
+   * @apiError (Internal Server Error 500) InternalServerError An error occurred while creating reward.
+   */
+  .post(createRateLimiter(), createReward);
+
+router
+  .route('/:id')
+  /**
+   * @api {get} v4/rewards/:id Get Specific Reward
+   * @apiDescription Fetch a specific reward by its unique ID.
+   * @apiName getSingleReward
+   * @apiGroup Rewards
+   * @apiPermission internal
+   *
+   * @apiHeader {String} Key Internal access token
+   *
+   * @apiParam {String} id Reward's unique identifier.
+   *
+   * @apiSuccess {Object} reward Reward details.
+   * @apiError (Not Found 404) NotFound Reward with the given ID does not exist.
+   * @apiError (Unauthorized 401) Unauthorized Invalid or missing access key.
+   * @apiError (Internal Server Error 500) InternalServerError An error occurred while fetching reward.
+   */
+  .get(createRateLimiter(), getRewards);
+
+export default router;