mindee 4.16.0 → 4.17.1

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 # CHANGELOG
 
-# v4.16.0 - 2024-09-17
+## v4.17.1 - 2024-10-17
+### Fixes
+* :bug: fix invalid handling of boolean fields & fix accidental coercion into numbers in `GeneratedObjectField` fields
+* :bug: fix `GeneratedObjectField` fields being inaccessible in typescript without going through the main object
+
+
+## v4.17.0 - 2024-10-11
+### Changes
+* :sparkles: add support for Financial Document v1.10
+* :sparkles: add support for Invoice v4.8
+
+
+## v4.16.0 - 2024-09-17
 ### Changes
 * :sparkles: add support for US Mail V2
 * :sparkles: add support for Bill of Lading V1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "4.16.0",
+    "version": "4.17.1",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",

package/src/parsing/generated/generatedObject.d.ts

@@ -10,6 +10,8 @@ export declare class GeneratedObjectField {
     rawValue?: string;
     /** List of all printable field names. */
     private printableValues;
+    /** All potentially present fields. */
+    [key: string]: string | number | boolean | object | undefined;
     constructor({ prediction, pageId, }: BaseFieldConstructor);
     /**
      * ReSTructured-compliant string representation.
@@ -24,6 +26,7 @@ export declare class GeneratedObjectField {
      */
     private toNumberString;
     toString(): string;
+    get(fieldName: string): string | number | boolean | object | undefined;
 }
 /**
  * Checks whether a field is a custom object or not.

package/src/parsing/generated/generatedObject.js

@@ -28,9 +28,16 @@ class GeneratedObjectField {
                 this.rawValue = fieldValue;
             }
             else {
-                if (fieldValue !== null && fieldValue !== undefined && !isNaN(fieldValue) && fieldName !== "degrees") {
+                if (fieldValue !== null &&
+                    fieldValue !== undefined &&
+                    typeof fieldValue === "number" &&
+                    !isNaN(fieldValue) &&
+                    fieldName !== "degrees") {
                     Object.assign(this, { [fieldName]: this.toNumberString(fieldValue) });
                 }
+                else if (typeof fieldValue === "boolean") {
+                    Object.assign(this, { [fieldName]: fieldValue });
+                }
                 else {
                     Object.assign(this, {
                         [fieldName]: (fieldValue !== undefined && fieldValue !== null) ?
@@ -70,6 +77,9 @@ class GeneratedObjectField {
     toString() {
         return this.toStringLevel();
     }
+    get(fieldName) {
+        return this[fieldName];
+    }
 }
 exports.GeneratedObjectField = GeneratedObjectField;
 /**

package/src/parsing/standard/date.d.ts

@@ -8,6 +8,8 @@ export declare class DateField extends Field {
     value?: string;
     /** Date as a standard JavaScript `Date` object. */
     dateObject?: Date;
+    /** Whether the field was computed or retrieved directly from the document. */
+    isComputed?: boolean;
     /**
      * @param {BaseFieldConstructor} constructor Constructor parameters.
      */

package/src/parsing/standard/date.js

@@ -11,6 +11,9 @@ class DateField extends field_1.Field {
      */
     constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId, }) {
         super({ prediction, valueKey, reconstructed, pageId });
+        if ("is_computed" in prediction) {
+            this.isComputed = prediction["is_computed"];
+        }
         if (typeof this.value === "string") {
             this.dateObject = new Date(this.value);
             if (isNaN(this.dateObject.valueOf())) {
@@ -24,10 +27,9 @@ class DateField extends field_1.Field {
         }
     }
     static compareDates(date1, date2) {
-        const check = date1.getFullYear() === date2.getFullYear() &&
+        return date1.getFullYear() === date2.getFullYear() &&
             date1.getMonth() === date2.getMonth() &&
             date1.getDate() === date2.getDate();
-        return check;
     }
 }
 exports.DateField = DateField;

package/src/product/financialDocument/financialDocumentV1Document.d.ts

@@ -2,7 +2,7 @@ import { Prediction, StringDict } from "../../parsing/common";
 import { FinancialDocumentV1LineItem } from "./financialDocumentV1LineItem";
 import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes } from "../../parsing/standard";
 /**
- * Financial Document API version 1.9 document data.
+ * Financial Document API version 1.10 document data.
  */
 export declare class FinancialDocumentV1Document implements Prediction {
     /** The customer's address used for billing. */
@@ -31,6 +31,10 @@ export declare class FinancialDocumentV1Document implements Prediction {
     lineItems: FinancialDocumentV1LineItem[];
     /** The locale detected on the document. */
     locale: LocaleField;
+    /** The date on which the payment is due / fullfilled. */
+    paymentDate: DateField;
+    /** The purchase order number. */
+    poNumber: StringField;
     /** The receipt number or identifier only if document is a receipt. */
     receiptNumber: StringField;
     /** List of Reference numbers, including PO number. */

package/src/product/financialDocument/financialDocumentV1Document.js

@@ -5,7 +5,7 @@ const common_1 = require("../../parsing/common");
 const financialDocumentV1LineItem_1 = require("./financialDocumentV1LineItem");
 const standard_1 = require("../../parsing/standard");
 /**
- * Financial Document API version 1.9 document data.
+ * Financial Document API version 1.10 document data.
  */
 class FinancialDocumentV1Document {
     constructor(rawPrediction, pageId) {
@@ -70,6 +70,14 @@ class FinancialDocumentV1Document {
         this.locale = new standard_1.LocaleField({
             prediction: rawPrediction["locale"],
         });
+        this.paymentDate = new standard_1.DateField({
+            prediction: rawPrediction["payment_date"],
+            pageId: pageId,
+        });
+        this.poNumber = new standard_1.StringField({
+            prediction: rawPrediction["po_number"],
+            pageId: pageId,
+        });
         this.receiptNumber = new standard_1.StringField({
             prediction: rawPrediction["receipt_number"],
             pageId: pageId,
@@ -163,11 +171,13 @@ class FinancialDocumentV1Document {
         }
         const outStr = `:Locale: ${this.locale}
 :Invoice Number: ${this.invoiceNumber}
+:Purchase Order Number: ${this.poNumber}
 :Receipt Number: ${this.receiptNumber}
 :Document Number: ${this.documentNumber}
 :Reference Numbers: ${referenceNumbers}
 :Purchase Date: ${this.date}
 :Due Date: ${this.dueDate}
+:Payment Date: ${this.paymentDate}
 :Total Net: ${this.totalNet}
 :Total Amount: ${this.totalAmount}
 :Taxes: ${this.taxes}

package/src/product/invoice/invoiceV4Document.d.ts

@@ -2,7 +2,7 @@ import { Prediction, StringDict } from "../../parsing/common";
 import { InvoiceV4LineItem } from "./invoiceV4LineItem";
 import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes } from "../../parsing/standard";
 /**
- * Invoice API version 4.7 document data.
+ * Invoice API version 4.8 document data.
  */
 export declare class InvoiceV4Document implements Prediction {
     /** The customer's address used for billing. */
@@ -27,6 +27,10 @@ export declare class InvoiceV4Document implements Prediction {
     lineItems: InvoiceV4LineItem[];
     /** The locale detected on the document. */
     locale: LocaleField;
+    /** The date on which the payment is due/ was full-filled. */
+    paymentDate: DateField;
+    /** The purchase order number. */
+    poNumber: StringField;
     /** List of Reference numbers, including PO number. */
     referenceNumbers: StringField[];
     /** Customer's delivery address. */

package/src/product/invoice/invoiceV4Document.js

@@ -5,7 +5,7 @@ const common_1 = require("../../parsing/common");
 const invoiceV4LineItem_1 = require("./invoiceV4LineItem");
 const standard_1 = require("../../parsing/standard");
 /**
- * Invoice API version 4.7 document data.
+ * Invoice API version 4.8 document data.
  */
 class InvoiceV4Document {
     constructor(rawPrediction, pageId) {
@@ -63,6 +63,14 @@ class InvoiceV4Document {
         this.locale = new standard_1.LocaleField({
             prediction: rawPrediction["locale"],
         });
+        this.paymentDate = new standard_1.DateField({
+            prediction: rawPrediction["payment_date"],
+            pageId: pageId,
+        });
+        this.poNumber = new standard_1.StringField({
+            prediction: rawPrediction["po_number"],
+            pageId: pageId,
+        });
         rawPrediction["reference_numbers"] &&
             rawPrediction["reference_numbers"].map((itemPrediction) => this.referenceNumbers.push(new standard_1.StringField({
                 prediction: itemPrediction,
@@ -141,9 +149,11 @@ class InvoiceV4Document {
         }
         const outStr = `:Locale: ${this.locale}
 :Invoice Number: ${this.invoiceNumber}
+:Purchase Order Number: ${this.poNumber}
 :Reference Numbers: ${referenceNumbers}
 :Purchase Date: ${this.date}
 :Due Date: ${this.dueDate}
+:Payment Date: ${this.paymentDate}
 :Total Net: ${this.totalNet}
 :Total Amount: ${this.totalAmount}
 :Total Tax: ${this.totalTax}