mindee 3.4.0 → 3.5.0

package/src/fields/tax.d.ts

@@ -1,9 +1,11 @@
+import { StringDict } from "./base";
 import { Field } from "./field";
 interface TaxConstructor {
-    prediction: any;
+    prediction: StringDict;
     valueKey?: string;
     rateKey?: string;
     codeKey?: string;
+    baseKey?: string;
     reconstructed?: boolean;
     pageId?: number;
 }
@@ -14,6 +16,8 @@ export declare class TaxField extends Field {
     rate?: number;
     /**  The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..). */
     code?: string;
+    /**  The tax base */
+    base?: number;
     /** The document page on which the information was found. */
     pageId: number;
     /**
@@ -21,10 +25,11 @@ export declare class TaxField extends Field {
      * @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 - Does the object is reconstructed (not extracted by the API)
      * @param {Integer} pageNumber - Page ID for multi-page document
      */
-    constructor({ prediction, valueKey, rateKey, codeKey, reconstructed, pageId, }: TaxConstructor);
+    constructor({ prediction, valueKey, rateKey, codeKey, baseKey, reconstructed, pageId, }: TaxConstructor);
     toString(): string;
 }
 export {};

package/src/fields/tax.js

@@ -9,10 +9,11 @@ class TaxField extends field_1.Field {
      * @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 - Does the object is reconstructed (not extracted by the API)
      * @param {Integer} pageNumber - Page ID for multi-page document
      */
-    constructor({ prediction, valueKey = "value", rateKey = "rate", codeKey = "code", reconstructed = false, pageId = undefined, }) {
+    constructor({ prediction, valueKey = "value", rateKey = "rate", codeKey = "code", baseKey = "base", reconstructed = false, pageId = undefined, }) {
         super({ prediction, valueKey, reconstructed, pageId });
         /** The tax amount. */
         this.value = undefined;
@@ -20,6 +21,8 @@ class TaxField extends field_1.Field {
         this.rate = undefined;
         /**  The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..). */
         this.code = undefined;
+        /**  The tax base */
+        this.base = undefined;
         this.rate = +parseFloat(prediction[rateKey]);
         if (isNaN(this.rate))
             this.rate = undefined;
@@ -32,6 +35,9 @@ class TaxField extends field_1.Field {
             this.value = undefined;
             this.confidence = 0.0;
         }
+        this.base = parseFloat(prediction[baseKey]);
+        if (isNaN(this.base))
+            this.base = undefined;
     }
     toString() {
         let outStr = "";
@@ -44,6 +50,9 @@ class TaxField extends field_1.Field {
         if (this.code !== undefined) {
             outStr += ` ${this.code}`;
         }
+        if (this.base !== undefined) {
+            outStr += ` ${(0, amount_1.floatToString)(this.base)}`;
+        }
         return outStr.trim();
     }
 }

package/src/fields/text.d.ts

@@ -0,0 +1,13 @@
+import { StringDict } from "./base";
+import { Field } from "./field";
+export interface FieldConstructor {
+    prediction: StringDict;
+    valueKey?: string;
+    reconstructed?: boolean;
+    pageId?: number | undefined;
+}
+export declare class TextField extends Field {
+    /** The value. */
+    value?: string;
+    constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
+}

package/src/fields/text.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextField = void 0;
+const field_1 = require("./field");
+class TextField extends field_1.Field {
+    constructor({ prediction, valueKey = "value", reconstructed = false, pageId, }) {
+        super({ prediction, valueKey, reconstructed, pageId });
+    }
+}
+exports.TextField = TextField;

package/src/geometry.d.ts

@@ -1,4 +1,4 @@
-type MinMax = {
+export type MinMax = {
     min: number;
     max: number;
 };
@@ -56,4 +56,3 @@ export declare function isPointInPolygonX(centroid: Point, polygon: Polygon): bo
  * Can be used to order (sort) words in the same line.
  */
 export declare function relativeX(polygon: Polygon): number;
-export {};

package/src/index.d.ts

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

package/src/index.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PageOptionsOperation = exports.Client = exports.eu = exports.us = exports.fr = exports.ShippingContainerV1 = exports.CropperV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PassportV1 = exports.InvoiceV4 = exports.InvoiceV3 = exports.FinancialDocumentV1 = exports.CustomV1 = void 0;
+exports.PageOptionsOperation = exports.InputSource = exports.Response = exports.Client = exports.eu = exports.us = exports.fr = exports.ShippingContainerV1 = exports.CropperV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PassportV1 = exports.InvoiceV4 = exports.InvoiceV3 = exports.FinancialDocumentV1 = 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; } });
 Object.defineProperty(exports, "FinancialDocumentV1", { enumerable: true, get: function () { return documents_1.FinancialDocumentV1; } });
 Object.defineProperty(exports, "InvoiceV3", { enumerable: true, get: function () { return documents_1.InvoiceV3; } });
 Object.defineProperty(exports, "InvoiceV4", { enumerable: true, get: function () { return documents_1.InvoiceV4; } });
@@ -16,5 +17,8 @@ Object.defineProperty(exports, "us", { enumerable: true, get: function () { retu
 Object.defineProperty(exports, "eu", { enumerable: true, get: function () { return documents_1.eu; } });
 var client_1 = require("./client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });
+var api_1 = require("./api");
+Object.defineProperty(exports, "Response", { enumerable: true, get: function () { return api_1.Response; } });
 var inputs_1 = require("./inputs");
+Object.defineProperty(exports, "InputSource", { enumerable: true, get: function () { return inputs_1.InputSource; } });
 Object.defineProperty(exports, "PageOptionsOperation", { enumerable: true, get: function () { return inputs_1.PageOptionsOperation; } });

package/src/inputs/sources.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { ReadStream } from "fs";
-import { Buffer } from "node:buffer";
+import { Readable } from "stream";
+import { Buffer } from "buffer";
 import { InputSource } from "./base";
 interface PathInputProps {
     inputPath: string;
@@ -23,7 +23,7 @@ export declare class Base64Input extends InputSource {
     init(): Promise<void>;
 }
 interface StreamInputProps {
-    inputStream: ReadStream;
+    inputStream: Readable;
     filename: string;
 }
 export declare class StreamInput extends InputSource {
@@ -31,7 +31,7 @@ export declare class StreamInput extends InputSource {
     fileObject: Buffer;
     constructor({ inputStream, filename }: StreamInputProps);
     init(): Promise<void>;
-    stream2buffer(stream: ReadStream): Promise<Buffer>;
+    stream2buffer(stream: Readable): Promise<Buffer>;
 }
 interface BytesInputProps {
     inputBytes: string;

package/src/inputs/sources.js

@@ -27,7 +27,7 @@ exports.BufferInput = exports.UrlInput = exports.BytesInput = exports.StreamInpu
 const fs_1 = require("fs");
 const path = __importStar(require("path"));
 const handler_1 = require("../errors/handler");
-const node_buffer_1 = require("node:buffer");
+const buffer_1 = require("buffer");
 const logger_1 = require("../logger");
 const base_1 = require("./base");
 class PathInput extends base_1.InputSource {
@@ -35,13 +35,13 @@ class PathInput extends base_1.InputSource {
         super({
             inputType: base_1.INPUT_TYPE_PATH,
         });
-        this.fileObject = node_buffer_1.Buffer.alloc(0);
+        this.fileObject = buffer_1.Buffer.alloc(0);
         this.inputPath = inputPath;
         this.filename = path.basename(this.inputPath);
     }
     async init() {
         logger_1.logger.debug(`Loading from: ${this.inputPath}`);
-        this.fileObject = node_buffer_1.Buffer.from(await fs_1.promises.readFile(this.inputPath));
+        this.fileObject = buffer_1.Buffer.from(await fs_1.promises.readFile(this.inputPath));
         this.mimeType = await this.checkMimetype();
     }
 }
@@ -51,12 +51,12 @@ class Base64Input extends base_1.InputSource {
         super({
             inputType: base_1.INPUT_TYPE_BASE64,
         });
-        this.fileObject = node_buffer_1.Buffer.alloc(0);
+        this.fileObject = buffer_1.Buffer.alloc(0);
         this.filename = filename;
         this.inputString = inputString;
     }
     async init() {
-        this.fileObject = node_buffer_1.Buffer.from(this.inputString, "base64");
+        this.fileObject = buffer_1.Buffer.from(this.inputString, "base64");
         this.mimeType = await this.checkMimetype();
         // clear out the string
         this.inputString = "";
@@ -68,7 +68,7 @@ class StreamInput extends base_1.InputSource {
         super({
             inputType: base_1.INPUT_TYPE_STREAM,
         });
-        this.fileObject = node_buffer_1.Buffer.alloc(0);
+        this.fileObject = buffer_1.Buffer.alloc(0);
         this.filename = filename;
         this.inputStream = inputStream;
     }
@@ -80,7 +80,7 @@ class StreamInput extends base_1.InputSource {
         return new Promise((resolve, reject) => {
             const _buf = Array();
             stream.on("data", (chunk) => _buf.push(chunk));
-            stream.on("end", () => resolve(node_buffer_1.Buffer.concat(_buf)));
+            stream.on("end", () => resolve(buffer_1.Buffer.concat(_buf)));
             stream.on("error", (err) => reject(`Error converting stream - ${err}`));
         });
     }
@@ -91,12 +91,12 @@ class BytesInput extends base_1.InputSource {
         super({
             inputType: base_1.INPUT_TYPE_BYTES,
         });
-        this.fileObject = node_buffer_1.Buffer.alloc(0);
+        this.fileObject = buffer_1.Buffer.alloc(0);
         this.filename = filename;
         this.inputBytes = inputBytes;
     }
     async init() {
-        this.fileObject = node_buffer_1.Buffer.from(this.inputBytes, "hex");
+        this.fileObject = buffer_1.Buffer.from(this.inputBytes, "hex");
         this.mimeType = await this.checkMimetype();
         // clear out the string
         this.inputBytes = "";

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

@@ -1,25 +0,0 @@
-import { TaxField } from "../../fields";
-interface ReceiptTaxConstructor {
-    prediction: any;
-    valueKey?: string;
-    rateKey?: string;
-    codeKey?: string;
-    baseKey?: string;
-    reconstructed?: boolean;
-    pageId?: number;
-}
-export declare class ReceiptTaxField extends TaxField {
-    /**  The tax base */
-    base?: 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 {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
-     * @param {Integer} pageNumber - Page ID for multi-page document
-     */
-    constructor({ prediction, valueKey, rateKey, codeKey, baseKey, reconstructed, pageId, }: ReceiptTaxConstructor);
-    toString(): string;
-}
-export {};

package/src/documents/receipt/tax.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReceiptTaxField = void 0;
-const fields_1 = require("../../fields");
-const amount_1 = require("../../fields/amount");
-class ReceiptTaxField extends fields_1.TaxField {
-    /**
-     * @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 {Boolean} reconstructed - Does the object is reconstructed (not extracted by the API)
-     * @param {Integer} pageNumber - Page ID for multi-page document
-     */
-    constructor({ prediction, valueKey = "value", rateKey = "rate", codeKey = "code", baseKey = "base", reconstructed = false, pageId = undefined, }) {
-        super({ prediction, valueKey, rateKey, codeKey, reconstructed, pageId });
-        /**  The tax base */
-        this.base = undefined;
-        this.base = parseFloat(prediction[baseKey]);
-        if (isNaN(this.base))
-            this.base = undefined;
-    }
-    toString() {
-        let outStr = "";
-        if (this.value !== undefined) {
-            outStr += `${(0, amount_1.floatToString)(this.value)}`;
-        }
-        if (this.rate !== undefined) {
-            outStr += ` ${(0, amount_1.floatToString)(this.rate)}%`;
-        }
-        if (this.code !== undefined) {
-            outStr += ` ${this.code}`;
-        }
-        if (this.base !== undefined) {
-            outStr += ` ${this.base}`;
-        }
-        return outStr.trim();
-    }
-}
-exports.ReceiptTaxField = ReceiptTaxField;