feat(sort): implement sort by and sort direction to each endpoint

Author: leonurium

README.md

@@ -94,10 +94,32 @@ All list endpoints support:
 - `limit` - Items per page (default: 10)
 - `name` - Search by name (partial match)
 - `code` - Filter by code (returns entity directly)
+- `sortBy` - Field to sort by (optional, defaults to `code`)
+- `sortDirection` - Sort direction: `ASC` or `DESC` (default: `ASC`)
 - `provinceCode` - Filter by parent province
 - `regencyCode` - Filter by parent regency
 - `districtCode` - Filter by parent district
 
+#### Sorting Options
+
+Each endpoint supports different sort fields:
+- **Provinces**: `code`, `province`
+- **Regencies**: `code`, `regency`, `provinceCode`, `type`
+- **Districts**: `code`, `district`, `regencyCode`
+- **Villages**: `code`, `village`, `districtCode`, `postalCode`
+
+**Examples:**
+```bash
+# Sort provinces by name in ascending order
+GET /province?sortBy=province&sortDirection=ASC
+
+# Sort regencies by name in descending order
+GET /regency?provinceCode=11&sortBy=regency&sortDirection=DESC
+
+# Default behavior (no sorting params = sort by code ASC)
+GET /province
+```
+
 ## 🗄️ Database Setup (For Self-Hosting)
 
 ### Step 1: Create Supabase Project
@@ -188,7 +210,7 @@ In Vercel dashboard (or `.env` file for local development), add:
 DATABASE_URL=postgresql://postgres.[PROJECT-REF]:[PASSWORD]@aws-0-[REGION].pooler.supabase.com:6543/postgres?pgbouncer=true
 NODE_ENV=production
 APP_ENV=production
-DATABASE_SCHEMA=aloe  # Optional: only if using a custom schema
+DATABASE_SCHEMA=konoland-schema  # Optional: only if using a custom schema
 ```
 
 ## 🛠️ Local Development

src/common/dto/pagination.dto.ts

@@ -1,4 +1,4 @@
-import { IsOptional, IsInt, Min, Max } from 'class-validator';
+import { IsOptional, IsInt, Min, Max, IsString, IsIn } from 'class-validator';
 import { Type } from 'class-transformer';
 
 export class PaginationDTO {
@@ -13,5 +13,13 @@ export class PaginationDTO {
   @IsInt()
   @Min(1)
   page?: number = 1;
+
+  @IsOptional()
+  @IsString()
+  sortBy?: string;
+
+  @IsOptional()
+  @IsIn(['ASC', 'DESC', 'asc', 'desc'])
+  sortDirection?: 'ASC' | 'DESC' = 'ASC';
 }
 

src/main.ts

@@ -30,8 +30,8 @@ async function createNestApp(): Promise<express.Express> {
 // For Vercel serverless function
 export default async function handler(req: express.Request, res: express.Response) {
   try {
-    const app = await createNestApp();
-    return app(req, res);
+  const app = await createNestApp();
+  return app(req, res);
   } catch (error) {
     console.error('Serverless function error:', error);
     res.status(500).json({

src/modules/district/district.service.ts

@@ -12,7 +12,7 @@ export class DistrictService {
   ) {}
 
   async getDistricts(getDistrictsQuery: GetDistrictsDTO) {
-    const { limit = 10, page = 1, name, code, regencyCode } = getDistrictsQuery;
+    const { limit = 10, page = 1, name, code, regencyCode, sortBy, sortDirection = 'ASC' } = getDistrictsQuery;
 
     // If code is provided, return the entity directly (backward compatibility)
     if (code) {
@@ -30,12 +30,17 @@ export class DistrictService {
       where.regencyCode = regencyCode;
     }
 
+    // Define allowed sort fields to prevent SQL injection
+    const allowedSortFields = ['code', 'district', 'regencyCode'];
+    const orderField = sortBy && allowedSortFields.includes(sortBy) ? sortBy : 'code';
+    const orderDirection = sortDirection.toUpperCase() as 'ASC' | 'DESC';
+
     const [districts, total] = await this.districtRepository.findAndCount({
       where,
       relations: ['regency'],
       take: limit,
       skip: (page - 1) * limit,
-      order: { code: 'ASC' },
+      order: { [orderField]: orderDirection },
     });
 
     return {

src/modules/province/province.service.ts

@@ -12,7 +12,7 @@ export class ProvinceService {
   ) {}
 
   async getProvinces(getProvincesQuery: GetProvincesDTO) {
-    const { limit = 10, page = 1, name, code } = getProvincesQuery;
+    const { limit = 10, page = 1, name, code, sortBy, sortDirection = 'ASC' } = getProvincesQuery;
 
     // If code is provided, return the entity directly (backward compatibility)
     if (code) {
@@ -26,11 +26,16 @@ export class ProvinceService {
       where.province = Like(`%${name}%`);
     }
 
+    // Define allowed sort fields to prevent SQL injection
+    const allowedSortFields = ['code', 'province'];
+    const orderField = sortBy && allowedSortFields.includes(sortBy) ? sortBy : 'code';
+    const orderDirection = sortDirection.toUpperCase() as 'ASC' | 'DESC';
+
     const [provinces, total] = await this.provinceRepository.findAndCount({
       where,
       take: limit,
       skip: (page - 1) * limit,
-      order: { code: 'ASC' },
+      order: { [orderField]: orderDirection },
     });
 
     return {

src/modules/regency/regency.service.ts

@@ -12,7 +12,7 @@ export class RegencyService {
   ) {}
 
   async getRegencies(getRegenciesQuery: GetRegenciesDTO) {
-    const { limit = 10, page = 1, name, code, provinceCode } = getRegenciesQuery;
+    const { limit = 10, page = 1, name, code, provinceCode, sortBy, sortDirection = 'ASC' } = getRegenciesQuery;
 
     // If code is provided, return the entity directly (backward compatibility)
     if (code) {
@@ -30,12 +30,17 @@ export class RegencyService {
       where.provinceCode = provinceCode;
     }
 
+    // Define allowed sort fields to prevent SQL injection
+    const allowedSortFields = ['code', 'regency', 'provinceCode', 'type'];
+    const orderField = sortBy && allowedSortFields.includes(sortBy) ? sortBy : 'code';
+    const orderDirection = sortDirection.toUpperCase() as 'ASC' | 'DESC';
+
     const [regencies, total] = await this.regencyRepository.findAndCount({
       where,
       relations: ['province'],
       take: limit,
       skip: (page - 1) * limit,
-      order: { code: 'ASC' },
+      order: { [orderField]: orderDirection },
     });
 
     return {

src/modules/village/village.service.ts

@@ -12,7 +12,7 @@ export class VillageService {
   ) {}
 
   async getVillages(getVillagesQuery: GetVillagesDTO) {
-    const { limit = 10, page = 1, name, code, districtCode } = getVillagesQuery;
+    const { limit = 10, page = 1, name, code, districtCode, sortBy, sortDirection = 'ASC' } = getVillagesQuery;
 
     // If code is provided, return the entity directly (backward compatibility)
     if (code) {
@@ -30,12 +30,17 @@ export class VillageService {
       where.districtCode = districtCode;
     }
 
+    // Define allowed sort fields to prevent SQL injection
+    const allowedSortFields = ['code', 'village', 'districtCode', 'postalCode'];
+    const orderField = sortBy && allowedSortFields.includes(sortBy) ? sortBy : 'code';
+    const orderDirection = sortDirection.toUpperCase() as 'ASC' | 'DESC';
+
     const [villages, total] = await this.villageRepository.findAndCount({
       where,
       relations: ['district'],
       take: limit,
       skip: (page - 1) * limit,
-      order: { code: 'ASC' },
+      order: { [orderField]: orderDirection },
     });
 
     return {