Update batch object and tests

Author: Strift

src/batch.ts

@@ -14,6 +14,7 @@ class Batch {
   startedAt: BatchObject["startedAt"];
   finishedAt: BatchObject["finishedAt"];
   duration: BatchObject["duration"];
+  progress: BatchObject["progress"];
 
   constructor(batch: BatchObject) {
     this.uid = batch.uid;
@@ -22,6 +23,7 @@ class Batch {
     this.startedAt = batch.startedAt;
     this.finishedAt = batch.finishedAt;
     this.duration = batch.duration;
+    this.progress = batch.progress;
   }
 }
 

src/types/types.ts

@@ -697,8 +697,22 @@ export type BatchObject = {
     deletedDocuments?: number;
   };
 
-  /** Progress indicator (currently always null) */
-  progress: null;
+  /** Progress and indexing step of the batch, null if the batch is finished */
+  progress: null | {
+    /** An array of all the steps currently being processed */
+    steps: Array<{
+      /** A string representing the name of the current step
+       * NOT stable. Only use for debugging purposes.
+       */
+      currentStep: string;
+      /** Number of finished tasks */
+      finished: number;
+      /** Total number of tasks to finish before moving to the next step */
+      total: number;
+    }>;
+    /** Percentage of progression of all steps currently being processed*/
+    percentage: number;
+  };
 
   /** Statistics about tasks within the batch */
   stats: {

tests/batch.test.ts

@@ -42,6 +42,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
       expect(batch.duration).toBeDefined();
       expect(batch.startedAt).toBeDefined();
       expect(batch.finishedAt).toBeDefined();
+      expect(batch.progress).toBeDefined();
     });
   },
 );