refactor: 💡 Changed deals.getAll API response

Added pagination parameters

Author: kostysh

examples/manager/package.json

@@ -13,6 +13,7 @@
     "@windingtree/sdk-storage": "workspace:*",
     "@windingtree/sdk-messages": "workspace:*",
     "@windingtree/sdk-node-api": "workspace:*",
+    "@windingtree/sdk-db": "workspace:*",
     "wtmp-examples-shared-files": "workspace:*",
     "eslint": "^8.45.0",
     "eslint-config-react-app": "^7.0.1",

examples/manager/src/components/Deals.tsx

@@ -9,6 +9,7 @@ import {
   GenericQuery,
 } from '@windingtree/sdk-types';
 import { centerEllipsis, formatBalance } from '@windingtree/sdk-react/utils';
+import { PaginatedDealRecords } from '@windingtree/sdk-db';
 
 /**
  * Deals table
@@ -30,7 +31,7 @@ export const Deals = () => {
     if (!node) {
       return;
     }
-    const records = await node.deals.getAll.query({});
+    const { records } = await node.deals.getAll.query({}) as PaginatedDealRecords;
     console.log('Deals:', records);
     setDeals(records);
   }, [node]);
@@ -88,6 +89,9 @@ export const Deals = () => {
           </tbody>
         </table>
       </div>
+
+      {message && <div style={{ marginTop: 20 }}>🚨 {message}</div>}
+      {error && <div style={{ marginTop: 20 }}>🚨 {error}</div>}
     </div>
   );
 };

packages/db/src/deals.ts

@@ -5,6 +5,11 @@ import { createLogger } from '@windingtree/sdk-logger';
 
 const logger = createLogger('DealsDb');
 
+export interface PaginatedDealRecords extends Required<PaginationOptions> {
+  total: number;
+  records: DealRecord[];
+}
+
 /**
  * Interface defining the properties of a Deal.
  */
@@ -84,7 +89,7 @@ export class DealsDb {
    * @returns {Promise<DealRecord[]>} Deals records
    * @memberof DealsDb
    */
-  getAll(pagination?: PaginationOptions): Promise<DealRecord[]> {
+  getAll(pagination?: PaginationOptions): Promise<PaginatedDealRecords> {
     // eslint-disable-next-line @typescript-eslint/no-misused-promises, no-async-promise-executor
     return new Promise(async (resolve, reject) => {
       try {
@@ -105,7 +110,11 @@ export class DealsDb {
           cursor++;
         }
 
-        resolve(records);
+        resolve({
+          ...page,
+          total: cursor,
+          records,
+        });
       } catch (error) {
         logger.error('getAll', error);
         reject(error);

packages/db/test/db.deals.spec.ts

@@ -77,21 +77,24 @@ describe('DealsDb', () => {
     it('get all deal records from the storage', async () => {
       const pagination = { start: 0, skip: 10 };
       const deals = await dealsDb.getAll(pagination);
-      expect(deals.length).toEqual(pagination.skip);
-      deals.forEach((d) => {
+      expect(deals.records.length).toEqual(pagination.skip);
+      deals.records.forEach((d) => {
         const record = records.find((r) => r.offer.id === d.offer.id);
         expect(record).to.be.deep.eq(d);
       });
+      expect(deals.total).to.be.equal(records.length);
+      expect(deals.start).to.be.equal(pagination.start);
+      expect(deals.skip).to.be.equal(pagination.skip);
     });
 
     it('should return an empty array when no deals are found', async () => {
       const deals = await dealsDb.getAll({ start: 100, skip: 10 });
-      expect(deals.length).toBe(0);
+      expect(deals.records.length).toBe(0);
     });
 
     it('should return all remaining deals when the skip count exceeds available deals', async () => {
       const deals = await dealsDb.getAll({ start: 5, skip: 10 });
-      expect(deals.length).toBe(5);
+      expect(deals.records.length).toBe(5);
     });
   });
 });