Add supplementary data to KiwiPage (#29)

Closes #28
kiwiproject · Jul 6, 2023 · 52c5dbc · 52c5dbc
1 parent 3568bfc
commit 52c5dbc
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/__tests__/search/kiwi-page.t.ts b/__tests__/search/kiwi-page.t.ts
@@ -56,6 +56,15 @@ describe('KiwiPage', () => {
     });
   });
 
+  describe('addSupplementaryData', () => {
+    it('should set the supplementary data on the KiwiPage', () => {
+      const page = KiwiPage.of(10, 1, 100, []);
+      page.addSupplementaryData({ aggregations: {} });
+
+      expect(page.supplementaryData).toEqual({ aggregations: {}});
+    });
+  });
+
   describe('usingZeroAsFirstPage', () => {
     it('should set pagingStartsWith to zero', () => {
       const page = KiwiPage.of(10, 1, 100, []);

diff --git a/src/search/kiwi-page.ts b/src/search/kiwi-page.ts
@@ -53,6 +53,11 @@ export class KiwiPage {
    */
   pagingStartsWith: number = 0;
 
+  /**
+   * Optional extra supplementary data related to the page
+   */
+  supplementaryData: object = {};
+
   constructor(content: object[], size: number, number: number, numberOfElements: number, totalPages: number, totalElements: number, sort: KiwiSort) {
     this.content = content;
     this.size = size;
@@ -99,4 +104,9 @@ export class KiwiPage {
   isSorted(): boolean {
     return this.sort !== undefined && this.sort !== null;
   }
+
+  addSupplementaryData(supplementaryData: object): this {
+    this.supplementaryData = supplementaryData;
+    return this;
+  }
 }