mindee 3.8.0 → 3.10.0

package/src/fields/field.d.ts

@@ -6,6 +6,9 @@ export interface FieldConstructor {
     reconstructed?: boolean;
     pageId?: number | undefined;
 }
+/**
+ * A basic field with position and page information.
+ */
 export declare class Field extends BaseField {
     /**
      * Contains exactly 4 relative vertices coordinates (points) of a right

package/src/fields/field.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Field = void 0;
 const base_1 = require("./base");
 const geometry_1 = require("../geometry");
+/**
+ * A basic field with position and page information.
+ */
 class Field extends base_1.BaseField {
     /**
      * @param {Object} prediction - Prediction object from HTTP response

package/src/fields/fullText.d.ts

@@ -9,6 +9,9 @@ export type Word = {
     confidence: number;
 };
 type Line = Word[];
+/**
+ * OCR extraction from the entire document.
+ */
 export declare class FullText {
     words: Word[];
     /**

package/src/fields/fullText.js

@@ -62,6 +62,9 @@ function orderLines(fullText) {
     orderedLines.reverse();
     return orderedLines;
 }
+/**
+ * OCR extraction from the entire document.
+ */
 class FullText {
     constructor() {
         this.words = [];

package/src/fields/locale.d.ts

@@ -1,4 +1,7 @@
 import { BaseField, BaseFieldConstructor } from "./base";
+/**
+ * The locale detected on the document.
+ */
 export declare class Locale extends BaseField {
     /** Locale in ISO format. */
     value?: string;
@@ -15,6 +18,6 @@ export declare class Locale extends BaseField {
      * @param {String} valueKey - Key to use in the prediction dict
      * @param {boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
      */
-    constructor({ prediction, reconstructed, valueKey, }: BaseFieldConstructor);
+    constructor({ prediction, reconstructed }: BaseFieldConstructor);
     toString(): string;
 }

package/src/fields/locale.js

@@ -2,13 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Locale = void 0;
 const base_1 = require("./base");
+/**
+ * The locale detected on the document.
+ */
 class Locale 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 - Does the object is reconstructed (not extracted by the API)
      */
-    constructor({ prediction, reconstructed = false, valueKey = "value", }) {
+    constructor({ prediction, reconstructed = false }) {
+        const valueKey = prediction.value !== undefined ? "value" : "language";
         super({ prediction, valueKey, reconstructed });
         this.confidence = prediction.confidence ? prediction.confidence : 0.0;
         this.language = undefined;

package/src/fields/orientation.d.ts

@@ -2,6 +2,9 @@ import { BaseField, BaseFieldConstructor } from "./base";
 interface OrientationFieldConstructor extends BaseFieldConstructor {
     pageId: number;
 }
+/**
+ * The clockwise rotation to apply (in degrees) to make the image upright.
+ */
 export declare class OrientationField extends BaseField {
     /** Degrees of the rotation. */
     value: number;

package/src/fields/orientation.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OrientationField = void 0;
 const base_1 = require("./base");
+/**
+ * The clockwise rotation to apply (in degrees) to make the image upright.
+ */
 class OrientationField extends base_1.BaseField {
     /**
      * @param {Object} prediction - Prediction object from HTTP response

package/src/fields/paymentDetails.d.ts

@@ -10,18 +10,21 @@ interface PaymentDetailsConstructor {
     reconstructed?: boolean;
     pageId?: number;
 }
+/**
+ * Information on a single payment.
+ */
 export declare class PaymentDetails extends Field {
     #private;
     /** Synonym for the `iban` property */
     value?: string | undefined;
     /** The account number. */
-    accountNumber: number | undefined;
-    /** The account IBAN. */
+    accountNumber: string | undefined;
+    /** The International Bank Account Number (IBAN). */
     iban: string | undefined;
     /** The routing number. */
-    routingNumber: number | undefined;
-    /** The SWIFT value. */
-    swift: number | undefined;
+    routingNumber: string | undefined;
+    /** 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

package/src/fields/paymentDetails.js

@@ -8,6 +8,9 @@ var _a, _PaymentDetails_isKeySet;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PaymentDetails = void 0;
 const field_1 = require("./field");
+/**
+ * Information on a single payment.
+ */
 class PaymentDetails extends field_1.Field {
     /**
      * @param {Object} prediction - Prediction object from HTTP response

package/src/fields/position.d.ts

@@ -5,6 +5,9 @@ export interface PositionFieldConstructor {
     valueKey?: string;
     pageId?: number | undefined;
 }
+/**
+ * A field indicating a position or area on the document.
+ */
 export declare class PositionField {
     /** Straight rectangle. */
     boundingBox: Polygon;

package/src/fields/position.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PositionField = void 0;
+/**
+ * A field indicating a position or area on the document.
+ */
 class PositionField {
     constructor({ prediction, pageId }) {
         this.pageId = pageId;

package/src/fields/tax.d.ts

@@ -9,6 +9,9 @@ interface TaxConstructor {
     reconstructed?: boolean;
     pageId?: number;
 }
+/**
+ * Represent a single tax line.
+ */
 export declare class TaxField extends Field {
     #private;
     /** The tax amount. */
@@ -31,9 +34,18 @@ export declare class TaxField extends Field {
      * @param {Integer} pageNumber - Page ID for multi-page document
      */
     constructor({ prediction, valueKey, rateKey, codeKey, baseKey, reconstructed, pageId, }: TaxConstructor);
+    /**
+     * Output in a format suitable for inclusion in an rST table.
+     */
     toTableLine(): string;
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }
+/**
+ * Represent all items.
+ */
 export declare class Taxes extends Array<TaxField> {
     #private;
     init(prediction: StringDict[], pageId: number | undefined): this;

package/src/fields/tax.js

@@ -9,6 +9,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Taxes = exports.TaxField = void 0;
 const field_1 = require("./field");
 const amount_1 = require("./amount");
+/**
+ * Represent a single tax line.
+ */
 class TaxField extends field_1.Field {
     /**
      * @param {Object} prediction - Prediction object from HTTP response
@@ -46,6 +49,9 @@ class TaxField extends field_1.Field {
         if (isNaN(this.base))
             this.base = undefined;
     }
+    /**
+     * Output in a format suitable for inclusion in an rST table.
+     */
     toTableLine() {
         const printable = __classPrivateFieldGet(this, _TaxField_instances, "m", _TaxField_printableValues).call(this);
         return ("| " +
@@ -58,6 +64,9 @@ class TaxField extends field_1.Field {
             printable.value.padEnd(13) +
             " |");
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const printable = __classPrivateFieldGet(this, _TaxField_instances, "m", _TaxField_printableValues).call(this);
         return ("Base: " +
@@ -79,6 +88,9 @@ _TaxField_instances = new WeakSet(), _TaxField_printableValues = function _TaxFi
         value: this.value !== undefined ? (0, amount_1.floatToString)(this.value) : "",
     };
 };
+/**
+ * Represent all items.
+ */
 class Taxes extends Array {
     constructor() {
         super(...arguments);

package/src/fields/text.d.ts

@@ -6,6 +6,9 @@ export interface FieldConstructor {
     reconstructed?: boolean;
     pageId?: number | undefined;
 }
+/**
+ * A field containing a text value.
+ */
 export declare class TextField extends Field {
     /** The value. */
     value?: string;

package/src/fields/text.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TextField = void 0;
 const field_1 = require("./field");
+/**
+ * A field containing a text value.
+ */
 class TextField extends field_1.Field {
     constructor({ prediction, valueKey = "value", reconstructed = false, pageId, }) {
         super({ prediction, valueKey, reconstructed, pageId });

package/src/index.d.ts

@@ -1,4 +1,4 @@
-export { CustomV1, Document, FinancialDocumentV0, FinancialDocumentV1, InvoiceV3, InvoiceV4, InvoiceSplitterV1, PassportV1, ReceiptV3, ReceiptV4, ReceiptV5, CropperV1, ShippingContainerV1, MindeeVisionV1, ProofOfAddressV1, fr, us, eu, } from "./documents";
+export { CustomV1, Document, FinancialDocumentV0, FinancialDocumentV1, InvoiceV3, InvoiceV4, InvoiceSplitterV1, PassportV1, ReceiptV3, ReceiptV4, ReceiptV5, CropperV1, MindeeVisionV1, ProofOfAddressV1, fr, us, eu, } from "./documents";
 export { Client, ClientOptions, CustomConfigParams, DocumentClient, PredictOptions, } from "./client";
 export { ResponseSig, Response, AsyncPredictResponse } from "./api";
 export { InputSource, PageOptionsOperation } from "./inputs";

package/src/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PageOptionsOperation = exports.InputSource = exports.AsyncPredictResponse = exports.Response = exports.DocumentClient = exports.Client = exports.eu = exports.us = exports.fr = exports.ProofOfAddressV1 = exports.MindeeVisionV1 = exports.ShippingContainerV1 = exports.CropperV1 = exports.ReceiptV5 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PassportV1 = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.InvoiceV3 = exports.FinancialDocumentV1 = exports.FinancialDocumentV0 = exports.Document = exports.CustomV1 = void 0;
+exports.PageOptionsOperation = exports.InputSource = exports.AsyncPredictResponse = exports.Response = exports.DocumentClient = exports.Client = exports.eu = exports.us = exports.fr = exports.ProofOfAddressV1 = exports.MindeeVisionV1 = exports.CropperV1 = exports.ReceiptV5 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PassportV1 = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.InvoiceV3 = exports.FinancialDocumentV1 = exports.FinancialDocumentV0 = exports.Document = exports.CustomV1 = void 0;
 var documents_1 = require("./documents");
 Object.defineProperty(exports, "CustomV1", { enumerable: true, get: function () { return documents_1.CustomV1; } });
 Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return documents_1.Document; } });
@@ -14,7 +14,6 @@ Object.defineProperty(exports, "ReceiptV3", { enumerable: true, get: function ()
 Object.defineProperty(exports, "ReceiptV4", { enumerable: true, get: function () { return documents_1.ReceiptV4; } });
 Object.defineProperty(exports, "ReceiptV5", { enumerable: true, get: function () { return documents_1.ReceiptV5; } });
 Object.defineProperty(exports, "CropperV1", { enumerable: true, get: function () { return documents_1.CropperV1; } });
-Object.defineProperty(exports, "ShippingContainerV1", { enumerable: true, get: function () { return documents_1.ShippingContainerV1; } });
 Object.defineProperty(exports, "MindeeVisionV1", { enumerable: true, get: function () { return documents_1.MindeeVisionV1; } });
 Object.defineProperty(exports, "ProofOfAddressV1", { enumerable: true, get: function () { return documents_1.ProofOfAddressV1; } });
 Object.defineProperty(exports, "fr", { enumerable: true, get: function () { return documents_1.fr; } });

package/src/documents/shippingContainer/shippingContainerV1.d.ts

@@ -1,12 +0,0 @@
-import { Document, DocumentConstructorProps } from "../document";
-import { TextField } from "../../fields";
-export declare class ShippingContainerV1 extends Document {
-    /** ISO 6346 code for container owner prefix + equipment identifier. */
-    owner: TextField;
-    /** ISO 6346 code for container serial number (6+1 digits). */
-    serialNumber: TextField;
-    /** ISO 6346 code for container length, height and type. */
-    sizeType: TextField;
-    constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
-    toString(): string;
-}

package/src/documents/shippingContainer/shippingContainerV1.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ShippingContainerV1 = void 0;
-const document_1 = require("../document");
-const fields_1 = require("../../fields");
-class ShippingContainerV1 extends document_1.Document {
-    constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, pageId = undefined, }) {
-        super({
-            inputSource: inputSource,
-            pageId: pageId,
-            orientation: orientation,
-            extras: extras,
-        });
-        this.owner = new fields_1.TextField({
-            prediction: prediction.owner,
-            pageId: pageId,
-        });
-        this.serialNumber = new fields_1.TextField({
-            prediction: prediction.serial_number,
-            pageId: pageId,
-        });
-        this.sizeType = new fields_1.TextField({
-            prediction: prediction.size_type,
-            pageId: pageId,
-        });
-    }
-    toString() {
-        const outStr = `----- Shipping Container V1 -----
-Filename: ${this.filename}
-Owner: ${this.owner}
-Serial Number: ${this.serialNumber}
-Size and Type: ${this.sizeType}
-----------------------
-`;
-        return ShippingContainerV1.cleanOutString(outStr);
-    }
-}
-exports.ShippingContainerV1 = ShippingContainerV1;