Feature/membership system

src/config/docs/UserPreferencesSchema.yml

@@ -26,7 +26,7 @@ components:
         trust_meter_rating:
           $ref: '/api/docs/enum/TrustMeterScale.yml#/components/schemas/TrustMeterScale'
         search_map_center:
-          type: object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   
+          type: object
           properties:
             type:
               type: string
@@ -39,6 +39,16 @@ components:
           required:
             - type
             - coordinates
+        membership_class:
+          type: string
+          example: Gold
+        mappi_balance:
+          type: number
+          example: 100
+        membership_expiration:
+          type: string
+          format: date-time
+          example: 2025-02-12T19:24:20.206+00:00
         _id:
           type: string
           example: 6673a08503852cb0c9b618d9
@@ -85,6 +95,16 @@ components:
           required:
             - type
             - coordinates
+        membership_class:
+          type: string
+          example: Gold
+        mappi_balance:
+          type: number
+          example: 100
+        membership_expiration:
+          type: string
+          format: date-time
+          example: 2025-02-12T19:24:20.206+00:00
       required:
         - user_settings_id
 
@@ -127,6 +147,16 @@ components:
           required:
             - type
             - coordinates
+        membership_class:
+          type: string
+          example: Gold
+        mappi_balance:
+          type: number
+          example: 100
+        membership_expiration:
+          type: string
+          format: date-time
+          example: 2025-02-12T19:24:20.206+00:00
         _id:
           type: string
           example: 66741c62b175e7d059a2639e
@@ -151,6 +181,16 @@ components:
             user_name:
               type: string
               example: Test User
+            membership_class:
+              type: string
+              example: Gold
+            mappi_balance:
+              type: number
+              example: 100
+            membership_expiration:
+              type: string
+              format: date-time
+              example: 2025-02-12T19:24:20.206+00:00
             email:
               type: string
               nullable: true
@@ -191,7 +231,7 @@ components:
     GetUserLocationRs:
       type: object
       properties:
-        origin: 
+        origin:
           type: object
           properties:
             lat:
@@ -208,4 +248,4 @@ components:
           example: 10
       required:
         - origin
-        - zoom
+        - zoom

src/controllers/tierController.ts

@@ -0,0 +1,29 @@
+import { Request, Response } from "express";
+import { fetchAllTiers, fetchTierByClass } from "../services/tier.service";
+
+export const getAllTiers = async (req: Request, res: Response) => {
+  try {
+    const tiers = await fetchAllTiers();
+    res.status(200).json(tiers);
+  } catch (error) {
+    console.error("Error fetching tiers:", error);
+    res.status(500).json({ message: "Failed to fetch tiers, please try again later." });
+  }
+};
+
+export const getTierByClass = async (req: Request, res: Response) => {
+
+  const { membershipClass } = req.params;
+  console.log("Received membershipClass:", membershipClass);
+  try {
+    const tier = await fetchTierByClass(membershipClass);
+    console.log("Fetched tier from database:", tier);
+    if (!tier) {
+      return res.status(404).json({ message: "Membership tier not found" });
+    }
+    res.status(200).json(tier);
+  } catch (error) {
+    console.error("Error fetching tier:", error);
+    res.status(500).json({ message: "Failed to fetch tier, please try again later." });
+  }
+};

src/controllers/userPreferencesController.ts

@@ -96,4 +96,85 @@ export const getUserLocation = async (req: Request, res: Response) => {
     logger.error(`Failed to get user location for piUID ${ req.currentUser?.pi_uid }:`, error);
     return res.status(500).json({ message: 'An error occurred while getting user location; please try again later' });
   }
-};
+};
+
+export const getMembershipStatus = async (req: Request, res: Response) => {
+  const { user_settings_id } = req.params;
+
+  try {
+    const userPreferences = await userSettingsService.getUserSettingsById(user_settings_id);
+    if (!userPreferences) {
+      logger.warn(`Membership status not found for ID: ${user_settings_id}`);
+      return res.status(404).json({ message: "Membership status not found" });
+    }
+
+    logger.info(`Fetched membership status for ID: ${user_settings_id}`);
+    res.status(200).json({
+      membership_class: userPreferences.membership_class,
+      mappi_balance: userPreferences.mappi_balance,
+      membership_expiration: userPreferences.membership_expiration,
+    });
+  } catch (error) {
+    logger.error(`Failed to fetch membership status for ID ${user_settings_id}:`, error);
+    return res.status(500).json({ message: "An error occurred while getting membership status; please try again later" });
+  }
+};
+
+export const upgradeMembership = async (req: Request, res: Response) => {
+  // Extract user_settings_id from the authenticated user
+  const user_settings_id = req.currentUser?.pi_uid;
+
+  if (!user_settings_id) {
+    return res.status(401).json({ message: "Unauthorized: No user information found" });
+  }
+
+  logger.info(`Authenticated user ID: ${user_settings_id}`);
+
+  try {
+    const updatedUserSettings = await userSettingsService.upgradeMembership(
+      user_settings_id,
+      req.body.newMembershipClass,
+      req.body.mappiAllowance,
+      req.body.durationWeeks
+    );
+
+    if (!updatedUserSettings) {
+      return res.status(404).json({ message: "User not found" });
+    }
+
+    res.status(200).json({
+      membership_class: updatedUserSettings.membership_class,
+      mappi_balance: updatedUserSettings.mappi_balance,
+      membership_expiration: updatedUserSettings.membership_expiration,
+    });
+  } catch (error) {
+    logger.error("Failed to upgrade membership:", error);
+    res.status(500).json({ message: "Failed to upgrade membership; please try again later" });
+  }
+};
+
+export const useMappi = async (req: Request, res: Response) => {
+  const { user_settings_id } = req.body;
+
+  try {
+    const userPreferences = await userSettingsService.getUserSettingsById(user_settings_id);
+    if (!userPreferences) {
+      logger.warn(`User not found for ID: ${user_settings_id}`);
+      return res.status(404).json({ message: "User not found" });
+    }
+
+    if (userPreferences.mappi_balance <= 0) {
+      logger.warn(`Insufficient mappi balance for user ID: ${user_settings_id}`);
+      return res.status(400).json({ message: "Insufficient mappi balance" });
+    }
+
+    userPreferences.mappi_balance -= 1;
+    await userPreferences.save();
+
+    logger.info(`Mappi deducted for ID: ${user_settings_id}`);
+    res.status(200).json({ mappi_balance: userPreferences.mappi_balance });
+  } catch (error) {
+    logger.error(`Failed to deduct mappi for ID ${user_settings_id}:`, error);
+    return res.status(500).json({ message: "An error occurred while using mappi; please try again later" });
+  }
+};

src/models/Tiers.ts

@@ -0,0 +1,27 @@
+import mongoose, { Schema, Document } from "mongoose";
+import { MembershipType } from "../models/enums/membershipTypes";
+
+export interface ITier extends Document {
+  class: MembershipType; // Use the MembershipType enum here
+  mappiAllowance: number;
+  durationWeeks: number;
+  cost: number;
+  badge: string;
+  priorityLevel: number;
+}
+
+const tierSchema: Schema = new Schema(
+  {
+    class: { type: String, enum: Object.values(MembershipType), required: true, unique: true },
+    mappiAllowance: { type: Number, required: true },
+    durationWeeks: { type: Number, required: true },
+    cost: { type: Number, required: true },
+    badge: { type: String, required: true },
+    priorityLevel: { type: Number, required: true },
+  },
+  { timestamps: true }
+);
+
+const Tier = mongoose.model<ITier>("Tier", tierSchema);
+
+export default Tier;

src/models/UserSettings.ts

@@ -54,8 +54,26 @@ const userSettingsSchema = new Schema<IUserSettings>(
         required: false,
         default: [0, 0]
       },
+    },
+    // Membership fields
+    membership_class: {
+      type: String,
+      required: true,
+      default: "Casual",
+      enum: ["Triple Gold", "Double Gold", "Gold", "Green", "Member", "Casual"]
+    },
+    mappi_balance: {
+      type: Number,
+      required: true,
+      default: 0
+    },
+    membership_expiration: {
+      type: Date,
+      required: false, // Optional for casual users
+      default: null
     }
-  }
+  },
+  { timestamps: true }
 );
 
 // use GeoJSON format to store geographical data i.e., points using '2dsphere' index.

src/models/enums/membershipTypes.ts

@@ -0,0 +1,8 @@
+export enum MembershipType {
+    CASUAL = "Casual",
+    MEMBER = "Member",
+    GREEN = "Green",
+    GOLD = "Gold",
+    DOUBLE_GOLD = "Double Gold",
+    TRIPLE_GOLD = "Triple Gold",
+  }  

src/routes/tier.routes.ts

@@ -0,0 +1,57 @@
+import { Router } from "express";
+import { getAllTiers, getTierByClass } from "../controllers/tierController";
+import { verifyToken } from "../middlewares/verifyToken";
+
+/**
+ * @swagger
+ * /api/v1/tiers:
+ *   get:
+ *     tags:
+ *       - Tiers
+ *     summary: Get all membership tiers
+ *     responses:
+ *       200:
+ *         description: Successful response
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: array
+ *               items:
+ *                 $ref: '#/components/schemas/Tier'
+ *       500:
+ *         description: Internal server error
+ */
+const tierRoutes = Router();
+
+// Endpoint to get all tiers
+tierRoutes.get("/tiers", verifyToken, getAllTiers);
+
+/**
+ * @swagger
+ * /api/v1/tiers/{membershipClass}:
+ *   get:
+ *     tags:
+ *       - Tiers
+ *     summary: Get a tier by membership class
+ *     parameters:
+ *       - name: membershipClass
+ *         in: path
+ *         required: true
+ *         schema:
+ *           type: string
+ *         description: Membership class to fetch details for
+ *     responses:
+ *       200:
+ *         description: Successful response
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/Tier'
+ *       404:
+ *         description: Tier not found
+ *       500:
+ *         description: Internal server error
+ */
+tierRoutes.get("/tiers/:membershipClass", verifyToken, getTierByClass);
+
+export default tierRoutes;