feat: expose sanctioned regions endpoint.

add endpoint to expose sanctioned regions for client to consume on demand.

Author: amt-fredrick-amoako

src/controllers/sanctionedRegionsController.ts

@@ -0,0 +1,38 @@
+import {Request, Response} from "express";
+import logger from "../config/loggingConfig";
+import SanctionedRegion from "../models/misc/SanctionedRegion";
+
+export async function checkIfPointInRegion(req: Request, res: Response) {
+	const { latitude, longitude } = req.body;
+
+	if (typeof latitude !== 'number' || typeof longitude !== 'number') {
+		return res.status(400).json({ error: 'Invalid coordinates provided.' });
+	}
+
+	try {
+		// Build a GeoJSON Point for the query (lon/lat order!).
+		const point = {
+			type: 'Point' as const,
+			coordinates: [longitude, latitude],
+		};
+
+		// Ask MongoDB if any `boundary` polygon intersects this point.
+		const matchingRegion = await SanctionedRegion.findOne({
+			boundary: {
+				$geoIntersects: {
+					$geometry: point
+				}
+			}
+		}).exec();
+
+		const isRestricted = !!matchingRegion;
+		logger.info(`User at [${latitude},${longitude}] is ${isRestricted ? '' : 'not '}in a restricted zone.`);
+		return res.status(200).json({
+			message: `Sell center is set within a ${isRestricted ? 'restricted' : 'clear' } zone`,
+			isRestricted
+		});
+	} catch (error) {
+		logger.error('Error checking sanctioned location:', error);
+		return res.status(500).json({ error: 'Internal server error.' });
+	}
+}

src/routes/sanctionedRegions.routes.ts

@@ -0,0 +1,52 @@
+import {Router} from "express";
+import { verifyAdminToken } from "../middlewares/verifyToken";
+import * as sanctionedRegionsController from "../controllers/sanctionedRegionsController"
+
+const sanctionedRegionsRoutes = Router();
+
+/**
+ * @swagger
+ * /api/v1/reports/check-in-sanctioned-region:
+ *   post:
+ *     tags:
+ *       - Report
+ *     summary: Check if a point is within a sanctioned region
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             required:
+ *               - latitude
+ *               - longitude
+ *             properties:
+ *               latitude:
+ *                 type: number
+ *                 example: -1.94995
+ *               longitude:
+ *                 type: number
+ *                 example: 30.0588
+ *     responses:
+ *       200:
+ *         description: Indicates whether the point is in a sanctioned region
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 isRestricted:
+ *                   type: boolean
+ *                   example: true
+ *       400:
+ *         description: Invalid coordinates provided
+ *       500:
+ *         description: Internal server error
+ */
+sanctionedRegionsRoutes.post(
+  "/check-in-sanctioned-region",
+  // verifyAdminToken,
+  sanctionedRegionsController.checkIfPointInRegion
+);
+
+export default sanctionedRegionsRoutes;

src/utils/app.ts

@@ -16,6 +16,7 @@ import reviewFeedbackRoutes from "../routes/reviewFeedback.routes";
 import mapCenterRoutes from "../routes/mapCenter.routes";
 import reportRoutes from "../routes/report.routes";
 import toggleRoutes from "../routes/toggle.routes";
+import sanctionedRegionsRoutes from "../routes/sanctionedRegions.routes";
 
 dotenv.config();
 
@@ -45,6 +46,7 @@ app.use("/api/v1/review-feedback", reviewFeedbackRoutes);
 app.use("/api/v1/map-center", mapCenterRoutes);
 app.use("/api/v1/reports", reportRoutes);
 app.use("/api/v1/toggles", toggleRoutes);
+app.use("/api/v1/sanctioned-regions", sanctionedRegionsRoutes);
 
 app.use("/", homeRoutes);