🐛 Polygon and BoundingBox should be a real classes

src/geometry/boundingBox.ts

@@ -1,4 +1,5 @@
 import { Point } from "./point";
+import { Polygon } from "./polygon";
 
 /** A simple bounding box defined by 4 coordinates: xMin, yMin, xMax, yMax */
 export class BBox {
@@ -16,4 +17,8 @@ export class BBox {
 }
 
 /** A bounding box defined by 4 points. */
-export type BoundingBox = [Point, Point, Point, Point];
+export class BoundingBox extends Polygon {
+  constructor(topLeft: Point, topRight: Point, bottomRight: Point, bottomLeft: Point) {
+    super(topLeft, topRight, bottomRight, bottomLeft);
+  }
+}

src/geometry/boundingBoxUtils.ts

@@ -13,12 +13,12 @@ export function getBoundingBox(polygon: Polygon): BoundingBox {
  * Given a BBox, generate the associated bounding box.
  */
 export function getBoundingBoxFromBBox(bbox: BBox): BoundingBox {
-  return [
+  return new BoundingBox(
     [bbox.xMin, bbox.yMin],
     [bbox.xMax, bbox.yMin],
     [bbox.xMax, bbox.yMax],
     [bbox.xMin, bbox.yMax],
-  ];
+  );
 }
 
 /**

src/geometry/polygon.ts

@@ -1,4 +1,9 @@
 import { Point } from "./point";
 
 /** A polygon, composed of several Points. */
-export class Polygon extends Array<Point> {}
+export class Polygon extends Array<Point> {
+
+  constructor(...args: Point[]) {
+    super(...args);
+  }
+}

src/parsing/custom/listField.ts

@@ -1,5 +1,5 @@
 import { BaseFieldConstructor } from "../standard";
-import { Polygon, getBoundingBox } from "../../geometry";
+import { Polygon, getBoundingBox, BoundingBox } from "../../geometry";
 import { StringDict } from "../common";
 
 export class ListFieldValue {
@@ -14,12 +14,12 @@ export class ListFieldValue {
    * Contains exactly 4 relative vertices coordinates (points) of a right
    * rectangle containing the word in the document.
    */
-  bbox: Polygon = [];
+  bbox?: BoundingBox;
   /**
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the word in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
   /** The document page on which the information was found. */
   pageId?: number;
 

src/parsing/standard/field.ts

@@ -14,7 +14,7 @@ export class Field extends BaseField {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
   /** The confidence score of the prediction. */
   confidence: number;
 

src/product/billOfLading/billOfLadingV1Carrier.ts

@@ -19,7 +19,7 @@ export class BillOfLadingV1Carrier {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.name = prediction["name"];

src/product/billOfLading/billOfLadingV1CarrierItem.ts

@@ -26,7 +26,7 @@ export class BillOfLadingV1CarrierItem {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.description = prediction["description"];

src/product/billOfLading/billOfLadingV1Consignee.ts

@@ -21,7 +21,7 @@ export class BillOfLadingV1Consignee {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.address = prediction["address"];

src/product/billOfLading/billOfLadingV1NotifyParty.ts

@@ -21,7 +21,7 @@ export class BillOfLadingV1NotifyParty {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.address = prediction["address"];

src/product/billOfLading/billOfLadingV1Shipper.ts

@@ -21,7 +21,7 @@ export class BillOfLadingV1Shipper {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.address = prediction["address"];

src/product/financialDocument/financialDocumentV1LineItem.ts

@@ -30,7 +30,7 @@ export class FinancialDocumentV1LineItem {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.description = prediction["description"];

src/product/fr/bankAccountDetails/bankAccountDetailsV2Bban.ts

@@ -21,7 +21,7 @@ export class BankAccountDetailsV2Bban {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.bbanBankCode = prediction["bban_bank_code"];

src/product/fr/energyBill/energyBillV1EnergyConsumer.ts

@@ -17,7 +17,7 @@ export class EnergyBillV1EnergyConsumer {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.address = prediction["address"];

src/product/fr/energyBill/energyBillV1EnergySupplier.ts

@@ -17,7 +17,7 @@ export class EnergyBillV1EnergySupplier {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.address = prediction["address"];

src/product/fr/energyBill/energyBillV1EnergyUsage.ts

@@ -30,7 +30,7 @@ export class EnergyBillV1EnergyUsage {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     if (

src/product/fr/energyBill/energyBillV1MeterDetail.ts

@@ -19,7 +19,7 @@ export class EnergyBillV1MeterDetail {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.meterNumber = prediction["meter_number"];

src/product/fr/energyBill/energyBillV1Subscription.ts

@@ -26,7 +26,7 @@ export class EnergyBillV1Subscription {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.description = prediction["description"];

src/product/fr/energyBill/energyBillV1TaxesAndContribution.ts

@@ -26,7 +26,7 @@ export class EnergyBillV1TaxesAndContribution {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.description = prediction["description"];

src/product/fr/payslip/payslipV2BankAccountDetail.ts

@@ -19,7 +19,7 @@ export class PayslipV2BankAccountDetail {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.bankName = prediction["bank_name"];

src/product/fr/payslip/payslipV2Employee.ts

@@ -27,7 +27,7 @@ export class PayslipV2Employee {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.address = prediction["address"];

src/product/fr/payslip/payslipV2Employer.ts

@@ -27,7 +27,7 @@ export class PayslipV2Employer {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.address = prediction["address"];

src/product/fr/payslip/payslipV2Employment.ts

@@ -27,7 +27,7 @@ export class PayslipV2Employment {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.category = prediction["category"];

src/product/fr/payslip/payslipV2PayDetail.ts

@@ -35,7 +35,7 @@ export class PayslipV2PayDetail {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     if (

src/product/fr/payslip/payslipV2PayPeriod.ts

@@ -23,7 +23,7 @@ export class PayslipV2PayPeriod {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.endDate = prediction["end_date"];

src/product/fr/payslip/payslipV2Pto.ts

@@ -21,7 +21,7 @@ export class PayslipV2Pto {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     if (

src/product/fr/payslip/payslipV2SalaryDetail.ts

@@ -22,7 +22,7 @@ export class PayslipV2SalaryDetail {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     if (

src/product/fr/payslip/payslipV3BankAccountDetail.ts

@@ -19,7 +19,7 @@ export class PayslipV3BankAccountDetail {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.bankName = prediction["bank_name"];

src/product/fr/payslip/payslipV3Employee.ts

@@ -27,7 +27,7 @@ export class PayslipV3Employee {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.address = prediction["address"];

src/product/fr/payslip/payslipV3Employer.ts

@@ -27,7 +27,7 @@ export class PayslipV3Employer {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.address = prediction["address"];

src/product/fr/payslip/payslipV3Employment.ts

@@ -27,7 +27,7 @@ export class PayslipV3Employment {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.category = prediction["category"];

src/product/fr/payslip/payslipV3PaidTimeOff.ts

@@ -24,7 +24,7 @@ export class PayslipV3PaidTimeOff {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     if (

src/product/fr/payslip/payslipV3PayDetail.ts

@@ -35,7 +35,7 @@ export class PayslipV3PayDetail {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     if (

src/product/fr/payslip/payslipV3PayPeriod.ts

@@ -23,7 +23,7 @@ export class PayslipV3PayPeriod {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.endDate = prediction["end_date"];

src/product/fr/payslip/payslipV3SalaryDetail.ts

@@ -24,7 +24,7 @@ export class PayslipV3SalaryDetail {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     if (

src/product/invoice/invoiceV4LineItem.ts

@@ -30,7 +30,7 @@ export class InvoiceV4LineItem {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.description = prediction["description"];

src/product/invoiceSplitter/invoiceSplitterV1InvoicePageGroup.ts

@@ -15,7 +15,7 @@ export class InvoiceSplitterV1InvoicePageGroup {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     this.pageIndexes = prediction["page_indexes"];

src/product/nutritionFactsLabel/nutritionFactsLabelV1AddedSugar.ts

@@ -21,7 +21,7 @@ export class NutritionFactsLabelV1AddedSugar {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     if (

src/product/nutritionFactsLabel/nutritionFactsLabelV1Calorie.ts

@@ -21,7 +21,7 @@ export class NutritionFactsLabelV1Calorie {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     if (

src/product/nutritionFactsLabel/nutritionFactsLabelV1Cholesterol.ts

@@ -21,7 +21,7 @@ export class NutritionFactsLabelV1Cholesterol {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     if (

src/product/nutritionFactsLabel/nutritionFactsLabelV1DietaryFiber.ts

@@ -21,7 +21,7 @@ export class NutritionFactsLabelV1DietaryFiber {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     if (

src/product/nutritionFactsLabel/nutritionFactsLabelV1Nutrient.ts

@@ -24,7 +24,7 @@ export class NutritionFactsLabelV1Nutrient {
    * Contains the relative vertices coordinates (points) of a polygon containing
    * the field in the document.
    */
-  polygon: Polygon = [];
+  polygon: Polygon = new Polygon();
 
   constructor({ prediction = {} }: StringDict) {
     if (