Added membership endpoint

Author: a3ryk

src/controllers/v4/internal/membership.js

@@ -0,0 +1,56 @@
+import createError from 'http-errors';
+import System from '../../../models/schemas/System.js';
+
+// Get membership details
+const getMembership = async (req, res, next) => {
+  const key = req.headers.key;
+
+  // Check for valid access key in headers
+  if (!key || key !== process.env.ACCESS_KEY) {
+    return res.status(401).json({
+      message: 'Unauthorized',
+    });
+  }
+
+  try {
+    // Check if any data exists
+    let membershipData = await System.findOne({}, { membership: 1, _id: 0 });
+
+    // If no data exists, insert sample data (only runs once)
+    if (!membershipData) {
+      membershipData = await System.findOne({}, { membership: 1, _id: 0 });
+    }
+
+    // Get valid keys dynamically from schema data
+    const validFields = Object.keys(membershipData.membership);
+    // Parse query parameters correctly
+    const queryParams = req.query.q ? req.query.q.split(',').map(param => param.trim()) : [];
+    // If no query params, return full membership object
+    if (queryParams.length === 0) {
+      return res.status(200).json(membershipData);
+    }
+
+    // Validate query parameters
+    const selectedFields = queryParams.filter(field => validFields.includes(field));
+
+    if (selectedFields.length === 0) {
+      return res.status(400).json({ message: 'Invalid query parameter(s)' });
+    }
+
+    // Construct projection object dynamically
+    const projection = selectedFields.reduce((acc, field) => ({ ...acc, [`membership.${field}`]: 1 }), { _id: 0 });
+
+    // Fetch only the requested fields
+    const result = await System.findOne({}, projection);
+
+    if (!result) {
+      return next(createError(404, 'No membership data found'));
+    }
+
+    res.status(200).json(result);
+  } catch (error) {
+    return next(error);
+  }
+};
+
+export { getMembership };

src/routes/v4/index.js

@@ -1208,6 +1208,22 @@ import statsRoutes from './internal/stats.js';
  */
 router.use('/stats', statsRoutes);
 
+import membershipRoutes from './internal/membership.js';
+
+/**
+ * @api {use} Mount Membership Routes
+ * @apiDescription Mount the membership-related routes for handling interactions.
+ * @apiName UseMembershipRoutes
+ * @apiGroup Routes
+ *
+ * @apiSuccess {Object} routes Membership-related routes mounted on the parent router.
+ *
+ * @function createMembershipRoutes
+ * @description Creates and returns a set of routes for handling interactions related to Membership.
+ * @returns {Object} Membership-related routes.
+ */
+router.use('/membership', membershipRoutes);
+
 /**
  * Exporting the router for use in other parts of the application.
  * @exports {Router} router - Express Router instance with mounted routes.

src/routes/v4/internal/membership.js

@@ -0,0 +1,40 @@
+import { Router } from 'express';
+import { getMembership } from '../../../controllers/v4/internal/membership.js';
+import createRateLimiter from '../../../middlewares/rateLimit.js';
+
+const router = Router();
+
+router
+  .route('/')
+  /**
+   * @api {get} v4/membership Get Membership Details
+   * @apiDescription Retrieve membership details, including plans and features.
+   * @apiName getMembership
+   * @apiGroup Membership
+   * @apiPermission user
+   *
+   * @apiHeader {String} Authorization System access token.
+   *
+   * @apiParam {String} [q] Optional query parameter to filter results.
+   * @apiParamExample {json} Request Example:
+   *    GET /membership?q=plans&features
+   *
+   * @apiSuccess {Object} membership Membership object.
+   * @apiSuccessExample {json} Success Response:
+   *    {
+   *      "membership": {
+   *        "plans": [...],
+   *        "features": [...]
+   *      }
+   *    }
+   *
+   * @apiError (Unauthorized 401) Unauthorized Only authenticated users can access the data.
+   * @apiError (Forbidden 403) Forbidden Only authorized users can access the data.
+   * @apiError (Too Many Requests 429) TooManyRequests The client has exceeded the allowed number of requests within the time window.
+   * @apiError (Bad Request 400) BadRequest Invalid query parameter(s) provided.
+   * @apiError (Internal Server Error 500) InternalServerError An error occurred while processing the request.
+   */
+  .get(createRateLimiter(), getMembership);
+
+// Export the router
+export default router;