mindee 3.0.0 → 3.0.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v3.0.1 - 2022-11-02
+### Fixes
+* :bug: Fix for `supplier` property name in `ReceiptV4` document.
+
 ## v3.0.0 - 2022-10-31
 ### ¡Breaking Changes!
 * :sparkles: New PDF cut system, which allows specifying exactly which pages to keep or remove.

package/README.md

@@ -30,7 +30,19 @@ const invoiceResponse = mindeeClient
 
 // Print a brief summary of the parsed data
 invoiceResponse.then((resp) => {
+
+    // The document property can be undefined:
+    // * TypeScript will throw an error without this guard clause
+    //   (or consider using the '?' notation)
+    // * JavaScript will be very happy to produce subtle bugs
+    //   without this guard clause
+    if (resp.document === undefined) return;
+
+    // full object
     console.log(resp.document);
+
+    // string summary
+    console.log(resp.document.toString());
 });
 ```
 
@@ -55,7 +67,14 @@ const customResponse = mindeeClient
 
 // Print a brief summary of the parsed data
 customResponse.then((resp) => {
+
+    if (resp.document === undefined) return;
+    
+    // full object
     console.log(resp.document);
+
+    // string summary
+    console.log(resp.document.toString());
 });
 ```
 

package/package.json

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

package/src/documents/receipt/receiptV4.d.ts

@@ -2,16 +2,25 @@ import { Document, DocumentConstructorProps } from "../document";
 import { Amount, DateField, Field, Locale, TaxField } from "../../fields";
 export declare class ReceiptV4 extends Document {
     #private;
+    /** Where the purchase was made, the language, and the currency. */
     locale: Locale;
+    /** The purchase date. */
     date: DateField;
-    /** Receipt category as seen on the receipt. */
+    /** The type of purchase. */
     category: Field;
-    merchantName: Field;
+    /** Merchant's name as seen on the receipt. */
+    supplier: Field;
+    /** Time as seen on the receipt in HH:MM format. */
     time: Field;
+    /** List of taxes detected on the receipt. */
     taxes: TaxField[];
+    /** Total amount of tip and gratuity. */
     tip: Amount;
+    /** total spent including taxes, discounts, fees, tips, and gratuity. */
     totalAmount: Amount;
+    /** Total amount of the purchase excluding taxes. */
     totalNet: Amount;
+    /** Total tax amount of the purchase. */
     totalTax: Amount;
     constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
     toString(): string;

package/src/documents/receipt/receiptV4.js

@@ -20,6 +20,7 @@ class ReceiptV4 extends document_1.Document {
             fullText: fullText,
         });
         _ReceiptV4_instances.add(this);
+        /** List of taxes detected on the receipt. */
         this.taxes = [];
         __classPrivateFieldGet(this, _ReceiptV4_instances, "m", _ReceiptV4_initFromApiPrediction).call(this, prediction, pageId);
     }
@@ -33,7 +34,7 @@ Tip: ${this.tip}
 Date: ${this.date}
 Category: ${this.category}
 Time: ${this.time}
-Supplier name: ${this.merchantName}
+Supplier name: ${this.supplier}
 Taxes: ${taxes}
 Total taxes: ${this.totalTax}
 Locale: ${this.locale}
@@ -76,7 +77,7 @@ _ReceiptV4_instances = new WeakSet(), _ReceiptV4_initFromApiPrediction = functio
         prediction: apiPrediction.category,
         pageId: pageId,
     });
-    this.merchantName = new fields_1.Field({
+    this.supplier = new fields_1.Field({
         prediction: apiPrediction.supplier,
         pageId: pageId,
     });

package/src/inputs/index.d.ts

@@ -1,3 +1,3 @@
 export { PageOptions, PageOptionsOperation } from "./pageOptions";
 export { Base64Input, BytesInput, PathInput, StreamInput, UrlInput, } from "./sources";
-export { InputSource, INPUT_TYPE_BASE64, INPUT_TYPE_BYTES, INPUT_TYPE_PATH, INPUT_TYPE_STREAM, } from "./base";
+export { InputSource, INPUT_TYPE_BASE64, INPUT_TYPE_BYTES, INPUT_TYPE_PATH, INPUT_TYPE_STREAM, INPUT_TYPE_URL, } from "./base";

package/src/inputs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.INPUT_TYPE_STREAM = exports.INPUT_TYPE_PATH = exports.INPUT_TYPE_BYTES = exports.INPUT_TYPE_BASE64 = exports.InputSource = exports.UrlInput = exports.StreamInput = exports.PathInput = exports.BytesInput = exports.Base64Input = exports.PageOptionsOperation = void 0;
+exports.INPUT_TYPE_URL = exports.INPUT_TYPE_STREAM = exports.INPUT_TYPE_PATH = exports.INPUT_TYPE_BYTES = exports.INPUT_TYPE_BASE64 = exports.InputSource = exports.UrlInput = exports.StreamInput = exports.PathInput = exports.BytesInput = exports.Base64Input = exports.PageOptionsOperation = void 0;
 var pageOptions_1 = require("./pageOptions");
 Object.defineProperty(exports, "PageOptionsOperation", { enumerable: true, get: function () { return pageOptions_1.PageOptionsOperation; } });
 var sources_1 = require("./sources");
@@ -15,3 +15,4 @@ Object.defineProperty(exports, "INPUT_TYPE_BASE64", { enumerable: true, get: fun
 Object.defineProperty(exports, "INPUT_TYPE_BYTES", { enumerable: true, get: function () { return base_1.INPUT_TYPE_BYTES; } });
 Object.defineProperty(exports, "INPUT_TYPE_PATH", { enumerable: true, get: function () { return base_1.INPUT_TYPE_PATH; } });
 Object.defineProperty(exports, "INPUT_TYPE_STREAM", { enumerable: true, get: function () { return base_1.INPUT_TYPE_STREAM; } });
+Object.defineProperty(exports, "INPUT_TYPE_URL", { enumerable: true, get: function () { return base_1.INPUT_TYPE_URL; } });