mindee 4.11.0 → 4.12.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v4.12.0 - 2024-05-16
+### Changes
+* :sparkles: update receipt to 5.2 and financial document to 1.7 (#270)
+
+
 # v4.11.0 - 2024-04-30
 ### Changes
 * :sparkles: update invoice to 4.6 & financial document to 1.6 (#269)

package/package.json

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

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.6 document data.
+ * Financial Document API version 1.7 document data.
  */
 export declare class FinancialDocumentV1Document implements Prediction {
     /** The customer's address used for billing. */
@@ -19,16 +19,20 @@ export declare class FinancialDocumentV1Document implements Prediction {
     customerName: StringField;
     /** The date the purchase was made. */
     date: DateField;
+    /** The document number or identifier. */
+    documentNumber: StringField;
     /** One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'. */
     documentType: ClassificationField;
     /** The date on which the payment is due. */
     dueDate: DateField;
-    /** The invoice number or identifier. */
+    /** The invoice number or identifier only if document is an invoice. */
     invoiceNumber: StringField;
     /** List of line item details. */
     lineItems: FinancialDocumentV1LineItem[];
     /** The locale detected on the document. */
     locale: LocaleField;
+    /** The receipt number or identifier only if document is a receipt. */
+    receiptNumber: StringField;
     /** List of Reference numbers, including PO number. */
     referenceNumbers: StringField[];
     /** The customer's address used for shipping. */

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.6 document data.
+ * Financial Document API version 1.7 document data.
  */
 class FinancialDocumentV1Document {
     constructor(rawPrediction, pageId) {
@@ -47,6 +47,10 @@ class FinancialDocumentV1Document {
             prediction: rawPrediction["date"],
             pageId: pageId,
         });
+        this.documentNumber = new standard_1.StringField({
+            prediction: rawPrediction["document_number"],
+            pageId: pageId,
+        });
         this.documentType = new standard_1.ClassificationField({
             prediction: rawPrediction["document_type"],
         });
@@ -66,6 +70,10 @@ class FinancialDocumentV1Document {
         this.locale = new standard_1.LocaleField({
             prediction: rawPrediction["locale"],
         });
+        this.receiptNumber = new standard_1.StringField({
+            prediction: rawPrediction["receipt_number"],
+            pageId: pageId,
+        });
         rawPrediction["reference_numbers"] &&
             rawPrediction["reference_numbers"].map((itemPrediction) => this.referenceNumbers.push(new standard_1.StringField({
                 prediction: itemPrediction,
@@ -154,6 +162,8 @@ class FinancialDocumentV1Document {
         }
         const outStr = `:Locale: ${this.locale}
 :Invoice Number: ${this.invoiceNumber}
+:Receipt Number: ${this.receiptNumber}
+:Document Number: ${this.documentNumber}
 :Reference Numbers: ${referenceNumbers}
 :Purchase Date: ${this.date}
 :Due Date: ${this.dueDate}

package/src/product/receipt/receiptV5Document.d.ts

@@ -2,7 +2,7 @@ import { Prediction, StringDict } from "../../parsing/common";
 import { ReceiptV5LineItem } from "./receiptV5LineItem";
 import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, StringField, Taxes } from "../../parsing/standard";
 /**
- * Receipt API version 5.1 document data.
+ * Receipt API version 5.2 document data.
  */
 export declare class ReceiptV5Document implements Prediction {
     /** The purchase category among predefined classes. */
@@ -15,6 +15,8 @@ export declare class ReceiptV5Document implements Prediction {
     lineItems: ReceiptV5LineItem[];
     /** The locale detected on the document. */
     locale: LocaleField;
+    /** The receipt number or identifier. */
+    receiptNumber: StringField;
     /** The purchase subcategory among predefined classes for transport and food. */
     subcategory: ClassificationField;
     /** The address of the supplier or merchant. */

package/src/product/receipt/receiptV5Document.js

@@ -5,7 +5,7 @@ const common_1 = require("../../parsing/common");
 const receiptV5LineItem_1 = require("./receiptV5LineItem");
 const standard_1 = require("../../parsing/standard");
 /**
- * Receipt API version 5.1 document data.
+ * Receipt API version 5.2 document data.
  */
 class ReceiptV5Document {
     constructor(rawPrediction, pageId) {
@@ -31,6 +31,10 @@ class ReceiptV5Document {
         this.locale = new standard_1.LocaleField({
             prediction: rawPrediction["locale"],
         });
+        this.receiptNumber = new standard_1.StringField({
+            prediction: rawPrediction["receipt_number"],
+            pageId: pageId,
+        });
         this.subcategory = new standard_1.ClassificationField({
             prediction: rawPrediction["subcategory"],
         });
@@ -104,6 +108,7 @@ class ReceiptV5Document {
 :Supplier Company Registrations: ${supplierCompanyRegistrations}
 :Supplier Address: ${this.supplierAddress}
 :Supplier Phone Number: ${this.supplierPhoneNumber}
+:Receipt Number: ${this.receiptNumber}
 :Line Items: ${lineItemsSummary}`.trimEnd();
         return (0, common_1.cleanOutString)(outStr);
     }