mindee 4.3.0 → 4.3.2

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## v4.3.2 - 2023-10-04
+### Changes
+* :arrow_up: dependency upgrade
+* :recycle: minor refactoring
+
+
+## v4.3.1 - 2023-09-20
+### Fixes
+* :bug: take line height tolerance into account when evaluating fields
+
+
 ## v4.3.0 - 2023-09-19
 ### Changes
 * :sparkles: add line items reconstruction for API builder

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "4.3.0",
+    "version": "4.3.2",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",
@@ -45,7 +45,7 @@
         "@types/node": "^18.15.11",
         "@typescript-eslint/eslint-plugin": "^5.57.1",
         "@typescript-eslint/parser": "^5.57.1",
-        "chai": "^4.3.7",
+        "chai": "^4.3.10",
         "eslint": "^8.47.0",
         "lint-staged": "^13.2.3",
         "mocha": "^10.1.0",

package/src/parsing/common/extras/cropperExtra.js

@@ -22,7 +22,7 @@ class CropperExtra extends extras_1.ExtraField {
     toString() {
         const cropping = this.cropping
             .map((crop) => crop.toString())
-            .join("\n          ");
+            .join("\n           ");
         return (0, summaryHelper_1.cleanOutString)(cropping);
     }
 }

package/src/parsing/custom/index.d.ts

@@ -1,3 +1,3 @@
-export { CustomLine, getLineItems } from "./lineItems";
+export { CustomLine, CustomLines, getLineItems } from "./lineItems";
 export { ClassificationField } from "./classificationField";
 export { ListField, ListFieldValue } from "./listField";

package/src/parsing/custom/index.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListFieldValue = exports.ListField = exports.ClassificationField = exports.getLineItems = exports.CustomLine = void 0;
+exports.ListFieldValue = exports.ListField = exports.ClassificationField = exports.getLineItems = exports.CustomLines = exports.CustomLine = void 0;
 var lineItems_1 = require("./lineItems");
 Object.defineProperty(exports, "CustomLine", { enumerable: true, get: function () { return lineItems_1.CustomLine; } });
+Object.defineProperty(exports, "CustomLines", { enumerable: true, get: function () { return lineItems_1.CustomLines; } });
 Object.defineProperty(exports, "getLineItems", { enumerable: true, get: function () { return lineItems_1.getLineItems; } });
 var classificationField_1 = require("./classificationField");
 Object.defineProperty(exports, "ClassificationField", { enumerable: true, get: function () { return classificationField_1.ClassificationField; } });

package/src/parsing/custom/lineItems.d.ts

@@ -11,7 +11,7 @@ export declare class CustomLine {
      */
     fields: Map<string, ListFieldValue>;
     /**
-     * The BBox of the current line.
+     * The BBox of the entire line, all fields included.
      */
     bbox: BBox;
     constructor(rowNumber: number);
@@ -25,4 +25,9 @@ export declare class CustomLine {
     extendWith(polygon: Polygon): void;
     updateField(name: string, fieldValue: ListFieldValue): void;
 }
-export declare function getLineItems(anchorNames: string[], fieldNames: string[], fields: Map<string, ListField>, heightLineTolerance: number): CustomLine[];
+export declare class CustomLines extends Array<CustomLine> {
+}
+/**
+ * Get line items from fields.
+ */
+export declare function getLineItems(anchorNames: string[], fieldNames: string[], fields: Map<string, ListField>, heightLineTolerance: number): CustomLines;

package/src/parsing/custom/lineItems.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLineItems = exports.CustomLine = void 0;
+exports.getLineItems = exports.CustomLines = exports.CustomLine = void 0;
 const handler_1 = require("../../errors/handler");
 const errors_1 = require("../../errors");
 const geometry_1 = require("../../geometry");
@@ -49,6 +49,12 @@ class CustomLine {
     }
 }
 exports.CustomLine = CustomLine;
+class CustomLines extends Array {
+}
+exports.CustomLines = CustomLines;
+/**
+ * Get line items from fields.
+ */
 function getLineItems(anchorNames, fieldNames, fields, heightLineTolerance) {
     const fieldsToTransformIntoLines = new Map([...fields].filter(([k]) => fieldNames.includes(k)));
     const anchorName = findBestAnchor(anchorNames, fieldsToTransformIntoLines);
@@ -56,9 +62,9 @@ function getLineItems(anchorNames, fieldNames, fields, heightLineTolerance) {
     linesPrepared.forEach((currentLine) => {
         fieldsToTransformIntoLines.forEach((field, fieldName) => {
             field.values.forEach((listFieldValue) => {
-                const minYCurrentValue = (0, geometry_1.getMinMaxY)(listFieldValue.polygon).min;
-                if (minYCurrentValue < currentLine.bbox.yMax &&
-                    minYCurrentValue >= currentLine.bbox.yMin) {
+                const minMaxY = (0, geometry_1.getMinMaxY)(listFieldValue.polygon);
+                if (Math.abs(minMaxY.max - currentLine.bbox.yMax) <= heightLineTolerance &&
+                    Math.abs(minMaxY.min - currentLine.bbox.yMin) <= heightLineTolerance) {
                     currentLine.updateField(fieldName, listFieldValue);
                 }
             });
@@ -67,6 +73,9 @@ function getLineItems(anchorNames, fieldNames, fields, heightLineTolerance) {
     return linesPrepared;
 }
 exports.getLineItems = getLineItems;
+/**
+ * Loop through the possible anchor fields and find the one with the most values.
+ */
 function findBestAnchor(possibleAnchorNames, fields) {
     let anchorName = "";
     let anchorRows = 0;

package/src/parsing/custom/listField.d.ts

@@ -3,7 +3,7 @@ import { Polygon } from "../../geometry";
 import { StringDict } from "../common";
 export declare class ListFieldValue {
     /** Extracted content of the prediction */
-    content: string | number;
+    content: string;
     /**
      * The confidence score of the prediction.
      * Note: Score is calculated on **word selection**, not its textual content (OCR).

package/src/product/custom/customV1Document.d.ts

@@ -1,5 +1,5 @@
 import { StringDict, Prediction } from "../../parsing/common";
-import { ClassificationField, ListField, CustomLine } from "../../parsing/custom";
+import { ClassificationField, ListField, CustomLines } from "../../parsing/custom";
 /**
  * Document data for Custom builds.
  */
@@ -24,7 +24,7 @@ export declare class CustomV1Document implements Prediction {
      * @param fieldNames list of all column fields.
      * @param heightTolerance height tolerance to apply to lines.
      */
-    columnsToLineItems(anchorNames: string[], fieldNames: string[], heightTolerance?: number): CustomLine[];
+    columnsToLineItems(anchorNames: string[], fieldNames: string[], heightTolerance?: number): CustomLines;
     /**
      * Default string representation.
      */

package/src/product/custom/customV1Page.d.ts

@@ -1,5 +1,5 @@
 import { StringDict, Prediction } from "../../parsing/common";
-import { ListField, CustomLine } from "../../parsing/custom";
+import { ListField, CustomLines } from "../../parsing/custom";
 /**
  * Page data for Custom builds.
  */
@@ -13,7 +13,7 @@ export declare class CustomV1Page implements Prediction {
      * @param fieldNames list of all column fields.
      * @param heightTolerance height tolerance to apply to lines.
      */
-    columnsToLineItems(anchorNames: string[], fieldNames: string[], heightTolerance?: number): CustomLine[];
+    columnsToLineItems(anchorNames: string[], fieldNames: string[], heightTolerance?: number): CustomLines;
     /**
      * Default string representation.
      */

package/src/product/invoiceSplitter/invoiceSplitterV1Document.d.ts

@@ -1,9 +1,9 @@
-import { Inference, StringDict } from "../../parsing/common";
+import { Prediction, StringDict } from "../../parsing/common";
 import { InvoiceSplitterV1PageGroup } from "./invoiceSplitterV1PageGroup";
 /**
  * Document data for Invoice Splitter, API version 1.
  */
-export declare class InvoiceSplitterV1Document extends Inference {
+export declare class InvoiceSplitterV1Document implements Prediction {
     /** List of page indexes that belong to the same invoice in the PDF. */
     invoicePageGroups: InvoiceSplitterV1PageGroup[];
     constructor(rawPrediction: StringDict);

package/src/product/invoiceSplitter/invoiceSplitterV1Document.js

@@ -6,9 +6,8 @@ const invoiceSplitterV1PageGroup_1 = require("./invoiceSplitterV1PageGroup");
 /**
  * Document data for Invoice Splitter, API version 1.
  */
-class InvoiceSplitterV1Document extends common_1.Inference {
+class InvoiceSplitterV1Document {
     constructor(rawPrediction) {
-        super(rawPrediction);
         /** List of page indexes that belong to the same invoice in the PDF. */
         this.invoicePageGroups = [];
         rawPrediction["invoice_page_groups"] &&

package/src/product/invoiceSplitter/invoiceSplitterV1PageGroup.d.ts

@@ -1,6 +1,6 @@
 import { StringDict } from "../../parsing/common";
 /**
- * Pages indexes in a group.
+ * Pages indexes in a group for Invoice Splitter V1.
  */
 export declare class InvoiceSplitterV1PageGroup {
     /** List of page indexes. */

package/src/product/invoiceSplitter/invoiceSplitterV1PageGroup.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvoiceSplitterV1PageGroup = void 0;
 /**
- * Pages indexes in a group.
+ * Pages indexes in a group for Invoice Splitter V1.
  */
 class InvoiceSplitterV1PageGroup {
     constructor(prediction) {