mindee 4.3.1 → 4.3.3

package/src/parsing/common/page.d.ts

@@ -17,9 +17,8 @@ export declare class Page<T extends Prediction> {
     /** Potential `Extras` fields sent back along with the prediction. */
     extras?: Extras;
     /**
-     *
-     * @param inferenceClass constructor signature for an inference.
-     * @param httpResponse raw http response.
+     * @param predictionType constructor signature for an inference.
+     * @param rawPrediction raw http response.
      * @param pageId the page's index (identifier).
      * @param orientation the page's orientation.
      */

package/src/parsing/common/page.js

@@ -11,9 +11,8 @@ const orientation_1 = require("./orientation");
  */
 class Page {
     /**
-     *
-     * @param inferenceClass constructor signature for an inference.
-     * @param httpResponse raw http response.
+     * @param predictionType constructor signature for an inference.
+     * @param rawPrediction raw http response.
      * @param pageId the page's index (identifier).
      * @param orientation the page's orientation.
      */

package/src/parsing/common/predictResponse.d.ts

@@ -4,14 +4,14 @@ import { Document, Inference, StringDict } from ".";
  *
  * @category API Response
  * @category Synchronous
-*/
+ */
 export declare class PredictResponse<T extends Inference> extends ApiResponse {
     /** A document prediction response. */
     document: Document<T>;
     /**
      *
      * @param inferenceClass constructor signature for an inference.
-     * @param rawPrediction raw http response.
+     * @param serverResponse raw http response.
      */
-    constructor(inferenceClass: new (rawPrediction: StringDict) => T, rawPrediction: StringDict);
+    constructor(inferenceClass: new (serverResponse: StringDict) => T, serverResponse: StringDict);
 }

package/src/parsing/common/predictResponse.js

@@ -7,16 +7,16 @@ const _1 = require(".");
  *
  * @category API Response
  * @category Synchronous
-*/
+ */
 class PredictResponse extends apiResponse_1.ApiResponse {
     /**
      *
      * @param inferenceClass constructor signature for an inference.
-     * @param rawPrediction raw http response.
+     * @param serverResponse raw http response.
      */
-    constructor(inferenceClass, rawPrediction) {
-        super(rawPrediction);
-        this.document = new _1.Document(inferenceClass, rawPrediction["document"]);
+    constructor(inferenceClass, serverResponse) {
+        super(serverResponse);
+        this.document = new _1.Document(inferenceClass, serverResponse["document"]);
     }
 }
 exports.PredictResponse = PredictResponse;

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

@@ -1,9 +1,9 @@
-import { FieldConstructor } from "../standard";
+import { BaseFieldConstructor } from "../standard";
 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).
@@ -32,7 +32,10 @@ export declare class ListField {
     reconstructed: boolean;
     /** The document page on which the information was found. */
     pageId: number;
-    constructor({ prediction, reconstructed, pageId, }: FieldConstructor);
+    /**
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
+     */
+    constructor({ prediction, reconstructed, pageId, }: BaseFieldConstructor);
     contentsList(): Array<string | number>;
     contentsString(separator?: string): string;
     /**

package/src/parsing/custom/listField.js

@@ -30,6 +30,9 @@ class ListFieldValue {
 }
 exports.ListFieldValue = ListFieldValue;
 class ListField {
+    /**
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
+     */
     constructor({ prediction = {}, reconstructed = false, pageId, }) {
         this.values = [];
         this.confidence = prediction["confidence"];

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

@@ -1,4 +1,5 @@
-import { Field, FieldConstructor } from "./field";
+import { Field } from "./field";
+import { BaseFieldConstructor } from "./base";
 export declare function floatToString(value: number): string;
 /**
  * A field containing an amount value.
@@ -7,12 +8,9 @@ export declare class AmountField extends Field {
     /** The value. */
     value?: number;
     /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict
-     * @param {Boolean} reconstructed - Is the object reconstructed (not extracted by the API)
-     * @param {Integer} pageId - Page ID for multi-page document
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
-    constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
+    constructor({ prediction, valueKey, reconstructed, pageId, }: BaseFieldConstructor);
     /**
      * Default string representation.
      */

package/src/parsing/standard/amount.js

@@ -15,10 +15,7 @@ exports.floatToString = floatToString;
  */
 class AmountField extends field_1.Field {
     /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict
-     * @param {Boolean} reconstructed - Is the object reconstructed (not extracted by the API)
-     * @param {Integer} pageId - Page ID for multi-page document
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
     constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId = undefined, }) {
         super({ prediction, valueKey, reconstructed, pageId });

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

@@ -1,4 +1,10 @@
 import { StringDict } from "../common";
+/**
+ * @property {object} prediction - Prediction object from HTTP response.
+ * @property {string} valueKey - Key to use in the prediction dict.
+ * @property {boolean} reconstructed - Is the object reconstructed (not extracted by the API).
+ * @property {number} pageId - Page ID for multi-page document.
+ */
 export interface BaseFieldConstructor {
     prediction: StringDict;
     valueKey?: string;
@@ -13,17 +19,16 @@ export declare class BaseField {
     value?: string | number;
     /** `true` when the field was reconstructed or computed using other fields. */
     reconstructed: boolean;
+    /** Page ID for multi-page document. */
     pageId?: number;
     /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param valueKey - Key to use in the prediction dict
-     * @param reconstructed - Is the object reconstructed (not extracted by the API)
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
     constructor({ prediction, valueKey, reconstructed, pageId, }: BaseFieldConstructor);
     compare(other: BaseField): boolean;
     /**
      * @param {BaseField[]} array - Array of Fields
-     * @returns {Number} Sum of all the Fields values in the array
+     * @returns {number} Sum of all the Fields values in the array
      */
     static arraySum(array: BaseField[]): number;
     /**

package/src/parsing/standard/base.js

@@ -6,9 +6,7 @@ exports.BaseField = void 0;
  */
 class BaseField {
     /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param valueKey - Key to use in the prediction dict
-     * @param reconstructed - Is the object reconstructed (not extracted by the API)
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
     constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId = undefined, }) {
         /** The value. */
@@ -34,7 +32,7 @@ class BaseField {
     }
     /**
      * @param {BaseField[]} array - Array of Fields
-     * @returns {Number} Sum of all the Fields values in the array
+     * @returns {number} Sum of all the Fields values in the array
      */
     static arraySum(array) {
         let total = 0.0;

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

@@ -1,4 +1,5 @@
-import { Field, FieldConstructor } from "./field";
+import { Field } from "./field";
+import { BaseFieldConstructor } from "./base";
 /**
  * A company registration item.
  */
@@ -7,5 +8,5 @@ export declare class CompanyRegistrationField extends Field {
     value?: string;
     /** Type of company registration. */
     type: string;
-    constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
+    constructor({ prediction, valueKey, reconstructed, pageId, }: BaseFieldConstructor);
 }

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

@@ -1,4 +1,5 @@
-import { Field, FieldConstructor } from "./field";
+import { Field } from "./field";
+import { BaseFieldConstructor } from "./base";
 /**
  * A field containing a date value.
  */
@@ -8,11 +9,8 @@ export declare class DateField extends Field {
     /** Date as a standard JavaScript `Date` object. */
     dateObject?: Date;
     /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict
-     * @param {Boolean} reconstructed - Is the object reconstructed (not extracted by the API)
-     * @param {Integer} pageId - Page ID for multi-page document
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
-    constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
+    constructor({ prediction, valueKey, reconstructed, pageId, }: BaseFieldConstructor);
     static compareDates(date1: Date, date2: Date): boolean;
 }

package/src/parsing/standard/date.js

@@ -7,10 +7,7 @@ const field_1 = require("./field");
  */
 class DateField extends field_1.Field {
     /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict
-     * @param {Boolean} reconstructed - Is the object reconstructed (not extracted by the API)
-     * @param {Integer} pageId - Page ID for multi-page document
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
     constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId, }) {
         super({ prediction, valueKey, reconstructed, pageId });

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

@@ -1,12 +1,5 @@
-import { BaseField } from "./base";
+import { BaseField, BaseFieldConstructor } from "./base";
 import { Polygon, BoundingBox } from "../../geometry";
-import { StringDict } from "../common";
-export interface FieldConstructor {
-    prediction: StringDict;
-    valueKey?: string;
-    reconstructed?: boolean;
-    pageId?: number | undefined;
-}
 /**
  * A basic field with position and page information.
  */
@@ -24,13 +17,9 @@ export declare class Field extends BaseField {
     /** The confidence score of the prediction. */
     confidence: number;
     /**
-     * @param prediction - Prediction object from HTTP response
-     * @param valueKey - Key to use in the prediction dict
-     * @param reconstructed - Does the object is reconstructed (not extracted by the API)
-     * @param pageId - Page ID for multi-page document
-     * @param extraFields - Extra fields to get from the prediction and to set as attribute of the Field
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
-    constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
+    constructor({ prediction, valueKey, reconstructed, pageId, }: BaseFieldConstructor);
     /**
     @param array1 first Array of Fields
     @param array2 second Array of Fields
@@ -40,7 +29,7 @@ export declare class Field extends BaseField {
     static compareArrays(array1: Field[], array2: Field[], attr?: string): boolean;
     /**
      * @param {Field[]} array - Array of Fields
-     * @returns {Number} product of all the fields probability
+     * @returns {number} product of all the fields probability
      */
     static arrayConfidence(array: Field[]): number;
 }

package/src/parsing/standard/field.js

@@ -8,11 +8,7 @@ const geometry_1 = require("../../geometry");
  */
 class Field extends base_1.BaseField {
     /**
-     * @param prediction - Prediction object from HTTP response
-     * @param valueKey - Key to use in the prediction dict
-     * @param reconstructed - Does the object is reconstructed (not extracted by the API)
-     * @param pageId - Page ID for multi-page document
-     * @param extraFields - Extra fields to get from the prediction and to set as attribute of the Field
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
     constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId, }) {
         super({ prediction, valueKey, reconstructed, pageId });
@@ -46,7 +42,7 @@ class Field extends base_1.BaseField {
     }
     /**
      * @param {Field[]} array - Array of Fields
-     * @returns {Number} product of all the fields probability
+     * @returns {number} product of all the fields probability
      */
     static arrayConfidence(array) {
         let total = 1.0;

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

@@ -9,4 +9,4 @@ export { Word } from "./word";
 export { CompanyRegistrationField } from "./companyRegistration";
 export { PositionField } from "./position";
 export { StringField } from "./text";
-export { Field, FieldConstructor } from "./field";
+export { Field } from "./field";

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

@@ -14,9 +14,7 @@ export declare class LocaleField extends BaseField {
     /** ISO 4217 currency code */
     currency?: string;
     /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict
-     * @param {boolean} reconstructed - Is the object reconstructed (not extracted by the API)
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
     constructor({ prediction, reconstructed, pageId, }: BaseFieldConstructor);
     /**

package/src/parsing/standard/locale.js

@@ -7,9 +7,7 @@ const base_1 = require("./base");
  */
 class LocaleField extends base_1.BaseField {
     /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict
-     * @param {boolean} reconstructed - Is the object reconstructed (not extracted by the API)
+     * @param {BaseFieldConstructor} constructor Constructor parameters.
      */
     constructor({ prediction = {}, reconstructed = false, pageId = undefined, }) {
         const valueKey = prediction["value"] !== undefined ? "value" : "language";

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

@@ -1,5 +1,15 @@
 import { StringDict } from "../common";
 import { Field } from "./field";
+/**
+ * @property {StringDict} constructor.prediction - Prediction object from HTTP response
+ * @property {string} constructor.valueKey - Key to use in the prediction dict to get the iban.
+ * @property {string} constructor.accountNumberKey - Key to use to get the account number in the prediction dict.
+ * @property {string} constructor.ibanKey - Key to use to get the IBAN in the prediction dict.
+ * @property {string} constructor.routingNumberKey - Key to use to get the routing number in the prediction dict.
+ * @property {string} constructor.swiftKey - Key to use to get the SWIFT in the prediction dict.
+ * @property {boolean} constructor.reconstructed - Is the object reconstructed (not extracted by the API).
+ * @property {number} constructor.pageId - Page ID for multi-page document.
+ */
 interface PaymentDetailsConstructor {
     prediction: StringDict;
     valueKey?: string;
@@ -26,14 +36,7 @@ export declare class PaymentDetailsField extends Field {
     /** The bank's SWIFT Business Identifier Code (BIC). */
     swift: string | undefined;
     /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict to get the iban
-     * @param {String} accountNumberKey - Key to use to get the account number in the prediction dict
-     * @param {String} ibanKey - Key to use to get the IBAN in the prediction dict
-     * @param {String} routingNumberKey - Key to use to get the routing number in the prediction dict
-     * @param {String} swiftKey - Key to use to get the SWIFT in the prediction dict
-     * @param {Boolean} reconstructed - Is the object reconstructed (not extracted by the API)
-     * @param {Integer} pageId - Page ID for multi-page document
+     * @param {PaymentDetailsConstructor} constructor Constructor parameters.
      */
     constructor({ prediction, valueKey, accountNumberKey, ibanKey, routingNumberKey, swiftKey, reconstructed, pageId, }: PaymentDetailsConstructor);
     /**

package/src/parsing/standard/paymentDetails.js

@@ -13,14 +13,7 @@ const field_1 = require("./field");
  */
 class PaymentDetailsField extends field_1.Field {
     /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict to get the iban
-     * @param {String} accountNumberKey - Key to use to get the account number in the prediction dict
-     * @param {String} ibanKey - Key to use to get the IBAN in the prediction dict
-     * @param {String} routingNumberKey - Key to use to get the routing number in the prediction dict
-     * @param {String} swiftKey - Key to use to get the SWIFT in the prediction dict
-     * @param {Boolean} reconstructed - Is the object reconstructed (not extracted by the API)
-     * @param {Integer} pageId - Page ID for multi-page document
+     * @param {PaymentDetailsConstructor} constructor Constructor parameters.
      */
     constructor({ prediction = {}, valueKey = "iban", accountNumberKey = "account_number", ibanKey = "iban", routingNumberKey = "routing_number", swiftKey = "swift", reconstructed = false, pageId = undefined, }) {
         super({ prediction, valueKey, reconstructed, pageId });

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

@@ -1,13 +1,15 @@
 import { StringDict } from "../common";
 import { Field } from "./field";
-interface TaxConstructor {
-    prediction: StringDict;
-    valueKey?: string;
+import { BaseFieldConstructor } from "./base";
+/**
+ * @property {string} constructor.rateKey - Key to use to get the tax rate in the prediction dict.
+ * @property {string} constructor.codeKey - Key to use to get the tax code in the prediction dict.
+ * @property {string} constructor.baseKey - Key to use to get the base tax in the prediction dict.
+ */
+interface TaxConstructor extends BaseFieldConstructor {
     rateKey?: string;
     codeKey?: string;
     baseKey?: string;
-    reconstructed?: boolean;
-    pageId?: number;
 }
 /**
  * Represent a single tax line.
@@ -25,13 +27,7 @@ export declare class TaxField extends Field {
     /** The document page on which the information was found. */
     pageId: number;
     /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict to get the tax value
-     * @param {String} rateKey - Key to use to get the tax rate in the prediction dict
-     * @param {String} codeKey - Key to use to get the tax code in the prediction dict
-     * @param {String} baseKey - Key to use to get the base tax in the prediction dict
-     * @param {Boolean} reconstructed - Is the object reconstructed (not extracted by the API)
-     * @param {Integer} pageNumber - Page ID for multi-page document
+     * @param {TaxConstructor} constructor Constructor parameters.
      */
     constructor({ prediction, valueKey, rateKey, codeKey, baseKey, reconstructed, pageId, }: TaxConstructor);
     /**

package/src/parsing/standard/tax.js

@@ -14,13 +14,7 @@ const amount_1 = require("./amount");
  */
 class TaxField extends field_1.Field {
     /**
-     * @param {Object} prediction - Prediction object from HTTP response
-     * @param {String} valueKey - Key to use in the prediction dict to get the tax value
-     * @param {String} rateKey - Key to use to get the tax rate in the prediction dict
-     * @param {String} codeKey - Key to use to get the tax code in the prediction dict
-     * @param {String} baseKey - Key to use to get the base tax in the prediction dict
-     * @param {Boolean} reconstructed - Is the object reconstructed (not extracted by the API)
-     * @param {Integer} pageNumber - Page ID for multi-page document
+     * @param {TaxConstructor} constructor Constructor parameters.
      */
     constructor({ prediction = {}, valueKey = "value", rateKey = "rate", codeKey = "code", baseKey = "base", reconstructed = false, pageId = undefined, }) {
         super({ prediction, valueKey, reconstructed, pageId });

package/src/product/financialDocument/financialDocumentV1Document.js

@@ -141,11 +141,11 @@ class FinancialDocumentV1Document {
 :Total Amount: ${this.totalAmount}
 :Taxes: ${this.taxes}
 :Supplier Payment Details: ${supplierPaymentDetails}
-:Supplier name: ${this.supplierName}
+:Supplier Name: ${this.supplierName}
 :Supplier Company Registrations: ${supplierCompanyRegistrations}
 :Supplier Address: ${this.supplierAddress}
 :Supplier Phone Number: ${this.supplierPhoneNumber}
-:Customer name: ${this.customerName}
+:Customer Name: ${this.customerName}
 :Customer Company Registrations: ${customerCompanyRegistrations}
 :Customer Address: ${this.customerAddress}
 :Document Type: ${this.documentType}

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

@@ -1,46 +1,47 @@
 import { Prediction, StringDict } from "../../parsing/common";
-import { ClassificationField, Taxes, PaymentDetailsField, LocaleField, AmountField, StringField, DateField, CompanyRegistrationField } from "../../parsing/standard";
 import { InvoiceV4LineItem } from "./invoiceV4LineItem";
+import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes } from "../../parsing/standard";
 /**
  * Document data for Invoice, API version 4.
  */
 export declare class InvoiceV4Document implements Prediction {
-    /** LocaleField information. */
-    locale: LocaleField;
-    /** The nature of the invoice. */
-    documentType: ClassificationField;
-    /** List of Reference numbers including PO number. */
-    referenceNumbers: StringField[];
-    /** The total amount with tax included. */
-    totalAmount: AmountField;
-    /** The creation date of the invoice. */
+    /** The address of the customer. */
+    customerAddress: StringField;
+    /** List of company registrations associated to the customer. */
+    customerCompanyRegistrations: CompanyRegistrationField[];
+    /** The name of the customer or client. */
+    customerName: StringField;
+    /** The date the purchase was made. */
     date: DateField;
-    /** The due date of the invoice. */
+    /** One of: 'INVOICE', 'CREDIT NOTE'. */
+    documentType: ClassificationField;
+    /** The date on which the payment is due. */
     dueDate: DateField;
-    /** The total tax. */
-    totalTax: AmountField;
-    /** The total amount without the tax value. */
-    totalNet: AmountField;
-    /** The supplier name. */
-    supplierName: StringField;
-    /** The supplier address. */
+    /** The invoice number or identifier. */
+    invoiceNumber: StringField;
+    /** List of line item details. */
+    lineItems: InvoiceV4LineItem[];
+    /** The locale detected on the document. */
+    locale: LocaleField;
+    /** List of Reference numbers, including PO number. */
+    referenceNumbers: StringField[];
+    /** The address of the supplier or merchant. */
     supplierAddress: StringField;
-    /** The payment information. */
-    supplierPaymentDetails: PaymentDetailsField[];
-    /** The supplier company registration information. */
+    /** List of company registrations associated to the supplier. */
     supplierCompanyRegistrations: CompanyRegistrationField[];
-    /** The invoice number. */
-    invoiceNumber: StringField;
-    /** The name of the customer. */
-    customerName: StringField;
-    /** The address of the customer. */
-    customerAddress: StringField;
-    /** The company registration information for the customer. */
-    customerCompanyRegistrations: CompanyRegistrationField[];
-    /** The list of the taxes. */
+    /** The name of the supplier or merchant. */
+    supplierName: StringField;
+    /** List of payment details associated to the supplier. */
+    supplierPaymentDetails: PaymentDetailsField[];
+    /** List of tax line details. */
     taxes: Taxes;
-    /** Line items details. */
-    lineItems: InvoiceV4LineItem[];
+    /** The total amount paid: includes taxes, tips, fees, and other charges. */
+    totalAmount: AmountField;
+    /** The net amount paid: does not include taxes, fees, and discounts. */
+    totalNet: AmountField;
     constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }