Feature: Escrow Overview Endpoint

[dDevAhmed]

closes #96

This PR introduces the GET /escrows/overview endpoint, which provides a paginated, filterable overview of escrows for a given user. This endpoint is optimized for powering the main "Escrows" dashboard in the app.

---

Changes

1. Controller:

   • Added GET /escrows/overview route.
   • Integrated query parameters for filtering, sorting, and pagination.
   • Documented the endpoint using Swagger.

2. Service:

   • Implemented findOverview method to query escrows efficiently using TypeORM.
   • Supports filtering by role, status, token, and date range.
   • Includes pagination metadata (totalItems, totalPages, etc.).

3. DTOs:

   • Added EscrowOverviewQueryDto for query validation.
   • Added EscrowOverviewResponseDto for consistent response structure.

4. Database:

   • Added indexes to improve query performance for common filters (e.g., creatorId, status, createdAt).

5. Tests:

   • Unit tests for findOverview service method.
   • E2E tests for role/status filtering, pagination edge cases, and sorting.

---

Acceptance Criteria

• Endpoint documented via Swagger.
• Returns correct data based on role, status, token, and date filters.
• Pagination works and metadata is accurate.
• Unit and integration tests cover filtering, pagination, and sorting.

---

How to Test

1. Run unit tests:

   npm run test

2. Run e2e tests:

   npm run test:e2e

3. Access Swagger docs:
   • Start the backend server.
   • Navigate to /api/docs to view the endpoint documentation.

[Cedarich]

please run npm lint and address the few linting errors. Thank you

[Cedarich]

Please resolve conflicts also Run npm run lint and address few lint errors. Thank you @dDevAhmed

[dDevAhmed]

conflicts resolved @Cedarich

[Cedarich]

Please address lint