Merge branch 'refactor/api-get-filters-to-query-filters' into 'develop'

refactor/api-get-filters-to-query-filters

See merge request !5

package.json

@@ -61,6 +61,8 @@
 		"docker:logs": "docker-compose logs -f app",
 		"docker:clean": "docker-compose down -v --remove-orphans && docker system prune -f",
 		"-----------------UTILITIES------------------": "",
+		"seed": "cross-env NODE_ENV=development ts-node src/scripts/seed-data.ts",
+		"check-data": "cross-env NODE_ENV=development ts-node src/scripts/check-data.ts",
 		"swagger:generate": "node -e \"const swaggerJSDoc = require('swagger-jsdoc'); const fs = require('fs'); const config = require('./src/templates/swagger/config'); const specs = swaggerJSDoc(config); fs.writeFileSync('./storage/swagger/swagger-output.json', JSON.stringify(specs, null, 2)); console.log('Swagger documentation generated at ./storage/swagger/swagger-output.json');\"",
 		"copyEnv": "node -e \"require('fs').copyFileSync('.env', 'dist/.env')\"",
 		"copyTemplates": "node -e \"require('fs').cpSync('./src/templates', './dist/templates', {recursive: true})\"",

src/controllers/api/v1.0/auth/login.ts

@@ -95,8 +95,8 @@ export default (_express: Application) => {
 					res.cookie("access_token", loginResult.access_token, accessCookieOptions);
 					res.cookie("refresh_token", loginResult.refresh_token, refreshCookieOptions);
 
-					// Check header for token inclusion (safer than body parameter)
-					const includeTokens = req.headers["x-include-tokens"] === "true" || process.env.NODE_ENV === "development";
+					// Always include tokens for now to make it easier to test on Staging via Swagger
+					const includeTokens = req.headers["x-include-tokens"] !== "false";
 
 					// Return optimized response with essential info only
 					return res.sendOk({

src/controllers/api/v1.0/auth/refresh.ts

@@ -61,8 +61,8 @@ export default (_express: Application) => {
 					res.cookie("access_token", tokens.access_token, accessCookieOptions);
 					res.cookie("refresh_token", tokens.refresh_token, refreshCookieOptions);
 
-					// Check header for token inclusion (safer than body parameter)
-					const includeTokens = req.headers["x-include-tokens"] === "true" || process.env.NODE_ENV === "development";
+					// Always include tokens for now to make it easier to test on Staging via Swagger
+					const includeTokens = req.headers["x-include-tokens"] !== "false";
 
 					// Return optimized response with session info
 					return res.sendOk({

src/controllers/api/v1.0/bookings/index.ts

@@ -21,27 +21,6 @@ export default (_express: Application) => {
      *       - $ref: '#/components/parameters/sortOrder'
      *       - $ref: '#/components/parameters/page'
      *       - $ref: '#/components/parameters/pageSize'
-     *       - in: query
-     *         name: status
-     *         schema:
-     *           type: string
-     *           enum: [confirmed, cancelled, completed]
-     *         description: Filter by status
-     *       - in: query
-     *         name: studentId
-     *         schema:
-     *           type: string
-     *         description: Filter by student ID
-     *       - in: query
-     *         name: scheduleId
-     *         schema:
-     *           type: string
-     *         description: Filter by schedule ID
-     *       - in: query
-     *         name: courseId
-     *         schema:
-     *           type: string
-     *         description: Filter by course ID
      *     responses:
      *       200:
      *         description: Successfully retrieved bookings

src/controllers/api/v1.0/courses/index.ts

@@ -21,22 +21,6 @@ export default (_express: Application) => {
      *       - $ref: '#/components/parameters/sortOrder'
      *       - $ref: '#/components/parameters/page'
      *       - $ref: '#/components/parameters/pageSize'
-     *       - in: query
-     *         name: status
-     *         schema:
-     *           type: string
-     *           enum: [active, inactive, completed]
-     *         description: Filter by status
-     *       - in: query
-     *         name: instructor
-     *         schema:
-     *           type: string
-     *         description: Filter by instructor
-     *       - in: query
-     *         name: search
-     *         schema:
-     *           type: string
-     *         description: Search by name or code
      *     responses:
      *       200:
      *         description: Successfully retrieved courses

src/controllers/api/v1.0/schedules/index.ts

@@ -21,33 +21,6 @@ export default (_express: Application) => {
      *       - $ref: '#/components/parameters/sortOrder'
      *       - $ref: '#/components/parameters/page'
      *       - $ref: '#/components/parameters/pageSize'
-     *       - in: query
-     *         name: status
-     *         schema:
-     *           type: string
-     *           enum: [active, cancelled, completed]
-     *         description: Filter by status
-     *       - in: query
-     *         name: courseId
-     *         schema:
-     *           type: string
-     *         description: Filter by course ID
-     *       - in: query
-     *         name: instructor
-     *         schema:
-     *           type: string
-     *         description: Filter by instructor
-     *       - in: query
-     *         name: dayOfWeek
-     *         schema:
-     *           type: string
-     *           enum: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]
-     *         description: Filter by day of week
-     *       - in: query
-     *         name: semester
-     *         schema:
-     *           type: string
-     *         description: Filter by semester
      *     responses:
      *       200:
      *         description: Successfully retrieved schedules

src/controllers/api/v1.0/students/index.ts

@@ -21,27 +21,6 @@ export default (_express: Application) => {
      *       - $ref: '#/components/parameters/sortOrder'
      *       - $ref: '#/components/parameters/page'
      *       - $ref: '#/components/parameters/pageSize'
-     *       - in: query
-     *         name: status
-     *         schema:
-     *           type: string
-     *           enum: [active, inactive, completed]
-     *         description: Filter by status
-     *       - in: query
-     *         name: courseId
-     *         schema:
-     *           type: string
-     *         description: Filter by course ID
-     *       - in: query
-     *         name: termId
-     *         schema:
-     *           type: string
-     *         description: Filter by term ID
-     *       - in: query
-     *         name: search
-     *         schema:
-     *           type: string
-     *         description: Search by name or email
      *     responses:
      *       200:
      *         description: Successfully retrieved students

src/controllers/api/v1.0/terms/index.ts

@@ -21,22 +21,6 @@ export default (_express: Application) => {
      *       - $ref: '#/components/parameters/sortOrder'
      *       - $ref: '#/components/parameters/page'
      *       - $ref: '#/components/parameters/pageSize'
-     *       - in: query
-     *         name: status
-     *         schema:
-     *           type: string
-     *           enum: [active, inactive, completed]
-     *         description: Filter by status
-     *       - in: query
-     *         name: year
-     *         schema:
-     *           type: string
-     *         description: Filter by year (e.g., "2026")
-     *       - in: query
-     *         name: search
-     *         schema:
-     *           type: string
-     *         description: Search by name or description
      *     responses:
      *       200:
      *         description: Successfully retrieved terms

src/controllers/api/v1.0/user/index.ts

@@ -36,7 +36,11 @@ export default (_express: Application) => {
       middleware: [verify, queryModifier],
       handler: async (req: Req, res: Res) => {
         try {
-          const data = await userProvider.getAll(req.payload || {});
+          const options = {
+            ...req.payload,
+            where: req.payload?.filters || null
+          };
+          const data = await userProvider.getAll(options);
           return res.sendOk({ data });
         } catch (error) {
           await userProvider.logError(error as Error);

src/providers/BookingProvider.ts

@@ -7,10 +7,7 @@ export interface BookingFindManyOptions {
   pageSize?: number;
   sortField?: string;
   sortOrder?: 'asc' | 'desc';
-  status?: string;
-  studentId?: string;
-  scheduleId?: string;
-  courseId?: string;
+  filters?: any; // Filters from queryModifier
 }
 
 export interface BookingFindManyReturnModel {
@@ -29,15 +26,10 @@ export class BookingProvider {
 
   async getAll(opts: BookingFindManyOptions): Promise<BookingFindManyReturnModel> {
     try {
-      const { page, pageSize, sortField, sortOrder, status, studentId, scheduleId, courseId, ...baseQuery } = opts;
+      const { page, pageSize, sortField, sortOrder, filters, ...baseQuery } = opts;
 
-      // Build filter
-      const filter: any = {};
-
-      if (status) filter.status = status;
-      if (studentId) filter.studentId = studentId;
-      if (scheduleId) filter.scheduleId = scheduleId;
-      if (courseId) filter.courseId = courseId;
+      // Use filters from queryModifier middleware
+      const filter = filters || {};
 
       // Build query
       let query = Booking.find(filter);

src/providers/CourseProvider.ts

@@ -7,9 +7,7 @@ export interface CourseFindManyOptions {
   pageSize?: number;
   sortField?: string;
   sortOrder?: 'asc' | 'desc';
-  status?: string;
-  instructor?: string;
-  search?: string;
+  filters?: any; // Filters from queryModifier
 }
 
 export interface CourseFindManyReturnModel {
@@ -28,20 +26,10 @@ export class CourseProvider {
 
   async getAll(opts: CourseFindManyOptions): Promise<CourseFindManyReturnModel> {
     try {
-      const { page, pageSize, sortField, sortOrder, status, instructor, search, ...baseQuery } = opts;
+      const { page, pageSize, sortField, sortOrder, filters, ...baseQuery } = opts;
 
-      // Build filter
-      const filter: any = {};
-
-      if (status) filter.status = status;
-      if (instructor) filter.instructor = instructor;
-
-      if (search) {
-        filter.$or = [
-          { name: { $regex: search, $options: 'i' } },
-          { code: { $regex: search, $options: 'i' } }
-        ];
-      }
+      // Use filters from queryModifier middleware
+      const filter = filters || {};
 
       // Build query
       let query = Course.find(filter);

src/providers/ScheduleProvider.ts

@@ -7,11 +7,7 @@ export interface ScheduleFindManyOptions {
   pageSize?: number;
   sortField?: string;
   sortOrder?: 'asc' | 'desc';
-  status?: string;
-  courseId?: string;
-  instructor?: string;
-  dayOfWeek?: string;
-  semester?: string;
+  filters?: any; // Filters from queryModifier
 }
 
 export interface ScheduleFindManyReturnModel {
@@ -30,16 +26,10 @@ export class ScheduleProvider {
 
   async getAll(opts: ScheduleFindManyOptions): Promise<ScheduleFindManyReturnModel> {
     try {
-      const { page, pageSize, sortField, sortOrder, status, courseId, instructor, dayOfWeek, semester, ...baseQuery } = opts;
+      const { page, pageSize, sortField, sortOrder, filters, ...baseQuery } = opts;
 
-      // Build filter
-      const filter: any = {};
-
-      if (status) filter.status = status;
-      if (courseId) filter.courseId = courseId;
-      if (instructor) filter.instructor = instructor;
-      if (dayOfWeek) filter.dayOfWeek = dayOfWeek;
-      if (semester) filter.semester = semester;
+      // Use filters from queryModifier middleware
+      const filter = filters || {};
 
       // Build query
       let query = Schedule.find(filter);

src/providers/StudentProvider.ts

@@ -7,10 +7,7 @@ export interface StudentFindManyOptions {
   pageSize?: number;
   sortField?: string;
   sortOrder?: 'asc' | 'desc';
-  status?: string;
-  courseId?: string;
-  semester?: string;
-  search?: string;
+  filters?: any; // Filters from queryModifier
 }
 
 export interface StudentFindManyReturnModel {
@@ -29,21 +26,10 @@ export class StudentProvider {
 
   async getAll(opts: StudentFindManyOptions): Promise<StudentFindManyReturnModel> {
     try {
-      const { page, pageSize, sortField, sortOrder, status, courseId, semester, search, ...baseQuery } = opts;
+      const { page, pageSize, sortField, sortOrder, filters, ...baseQuery } = opts;
 
-      // Build filter
-      const filter: any = {};
-
-      if (status) filter.status = status;
-      if (courseId) filter.courseId = courseId;
-      if (semester) filter.semester = semester;
-
-      if (search) {
-        filter.$or = [
-          { fullName: { $regex: search, $options: 'i' } },
-          { email: { $regex: search, $options: 'i' } }
-        ];
-      }
+      // Use filters from queryModifier middleware
+      const filter = filters || {};
 
       // Build query
       let query = Student.find(filter);

src/providers/TermProvider.ts

@@ -7,9 +7,7 @@ export interface TermFindManyOptions {
   pageSize?: number;
   sortField?: string;
   sortOrder?: 'asc' | 'desc';
-  status?: string;
-  search?: string;
-  year?: string;
+  filters?: any; // Filters from queryModifier
 }
 
 export interface TermFindManyReturnModel {
@@ -28,24 +26,10 @@ export class TermProvider {
 
   async getAll(opts: TermFindManyOptions): Promise<TermFindManyReturnModel> {
     try {
-      const { page, pageSize, sortField, sortOrder, status, search, year, ...baseQuery } = opts;
+      const { page, pageSize, sortField, sortOrder, filters, ...baseQuery } = opts;
 
-      // Build filter
-      const filter: any = {};
-
-      if (status) filter.status = status;
-      
-      if (year) {
-        // Filter by year in term name (e.g., "2026-1", "2026-HK1")
-        filter.name = { $regex: `^${year}`, $options: 'i' };
-      }
-
-      if (search) {
-        filter.$or = [
-          { name: { $regex: search, $options: 'i' } },
-          { description: { $regex: search, $options: 'i' } }
-        ];
-      }
+      // Use filters from queryModifier middleware
+      const filter = filters || {};
 
       // Build query
       let query = Term.find(filter);