🐛 fix for printing crop results

Author: ianardee

src/geometry/polygon.ts

@@ -47,6 +47,7 @@ export class Polygon extends Array<Point> {
   }
 
   toString(): string {
-    return this.map((point) => `(${point})`).join(", ");
+    const points = this.map((point) => `(${point})`).join(", ");
+    return `(${points})`;
   }
 }

src/v2/parsing/inference/field/fieldLocation.ts

@@ -2,21 +2,20 @@ import { Polygon } from "@/geometry/index.js";
 import { StringDict } from "@/parsing/stringDict.js";
 
 /**
- * Location of a field.
+ * A field's location on the document.
  */
 export class FieldLocation {
-  /** Free polygon made up of points (can be null when not provided). */
-  readonly polygon: Polygon | null;
-
-  /** Page ID. */
-  readonly page: number | undefined;
+  /** Position information as a list of points in clockwise order. */
+  readonly polygon: Polygon;
+  /** 0-based page index of where the polygon is located. */
+  readonly page;
 
   constructor(serverResponse: StringDict) {
-    this.polygon = "polygon" in serverResponse ? new Polygon(...serverResponse["polygon"]) : null;
-    this.page = "page" in serverResponse ? serverResponse["page"] : undefined;
+    this.polygon = new Polygon(...serverResponse["polygon"]);
+    this.page = serverResponse["page"];
   }
 
   toString(): string {
-    return this.polygon?.toString() ?? "";
+    return `${this.polygon} on page ${this.page}`;
   }
 }

src/v2/product/crop/cropItem.ts

@@ -11,6 +11,6 @@ export class CropItem {
   }
 
   toString(): string {
-    return `${this.objectType}: ${this.location}`;
+    return `* :Location: ${this.location}\n  :Object Type: ${this.objectType}`;
   }
 }

src/v2/product/crop/cropResult.ts

@@ -12,7 +12,7 @@ export class CropResult {
   }
 
   toString(): string {
-    const crops = this.crops.map(item => item.toString()).join("\n * ");
-    return `Crop\n====\n * ${crops}`;
+    const crops = this.crops.map(item => item.toString()).join("\n");
+    return `Crops\n=====\n${crops}`;
   }
 }

tests/data

@@ -47,6 +47,11 @@ describe("MindeeV2 - Crop Response", async () => {
     assert.strictEqual(polygon[2][1], 0.947);
     assert.strictEqual(polygon[3][0], 0.15);
     assert.strictEqual(polygon[3][1], 0.947);
+
+    const rstString = await fs.readFile(
+      path.join(V2_PRODUCT_PATH, "crop", "crop_single.rst"), "utf8"
+    );
+    assert.strictEqual(response.inference.toString(), rstString);
   });
 
   it("should load multiple results", async () => {
@@ -101,19 +106,10 @@ describe("MindeeV2 - Crop Response", async () => {
     assert.strictEqual(secondPolygon[2][1], 0.97);
     assert.strictEqual(secondPolygon[3][0], 0.547);
     assert.strictEqual(secondPolygon[3][1], 0.97);
-  });
 
-  describe("RST Display", async () => {
-    it("to be properly exposed", async () => {
-      const response = await loadV2Response(
-        crop.CropResponse,
-        path.join(V2_PRODUCT_PATH, "crop", "crop_single.json")
-      );
-      const rstString = await fs.readFile(
-        path.join(V2_PRODUCT_PATH, "crop", "crop_single.rst"), "utf8"
-      );
-      assert.notStrictEqual(response.inference, null);
-      assert.strictEqual(response.inference.toString(), rstString);
-    });
+    const rstString = await fs.readFile(
+      path.join(V2_PRODUCT_PATH, "crop", "crop_multiple.rst"), "utf8"
+    );
+    assert.strictEqual(response.inference.toString(), rstString);
   });
 });