mindee 4.36.3 → 5.0.0-alpha1

package/src/v1/parsing/standard/position.d.ts

@@ -0,0 +1,27 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+import { Polygon } from "../../../geometry/index.js";
+export interface PositionFieldConstructor {
+    prediction: StringDict;
+    valueKey?: string;
+    pageId?: number | undefined;
+}
+/**
+ * A field indicating a position or area on the document.
+ */
+export declare class PositionField {
+    /** Straight rectangle. */
+    boundingBox: Polygon;
+    /** Free polygon with up to 30 vertices. */
+    polygon: Polygon;
+    /** Free polygon with 4 vertices. */
+    quadrangle: Polygon;
+    /** Rectangle that may be oriented (can go beyond the canvas). */
+    rectangle: Polygon;
+    /** The document page on which the information was found. */
+    pageId: number | undefined;
+    constructor({ prediction, pageId }: PositionFieldConstructor);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/v1/parsing/standard/position.js

@@ -0,0 +1,29 @@
+/**
+ * A field indicating a position or area on the document.
+ */
+export class PositionField {
+    constructor({ prediction = {}, pageId }) {
+        this.pageId = pageId;
+        this.boundingBox = "bounding_box" in prediction ? prediction["bounding_box"] : [];
+        this.polygon = "polygon" in prediction ? prediction["polygon"] : [];
+        this.quadrangle = "quadrangle" in prediction ? prediction["quadrangle"] : [];
+        this.rectangle = "rectangle" in prediction ? prediction["rectangle"] : [];
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        if (this.polygon && this.polygon.length > 0)
+            return `Polygon with ${this.polygon.length} points.`;
+        if (this.boundingBox && this.boundingBox.length > 0) {
+            return `Polygon with ${this.boundingBox.length} points.`;
+        }
+        if (this.rectangle && this.rectangle.length > 0) {
+            return `Polygon with ${this.rectangle.length} points.`;
+        }
+        if (this.quadrangle && this.quadrangle.length > 0) {
+            return `Polygon with ${this.quadrangle.length} points.`;
+        }
+        return "";
+    }
+}

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

@@ -0,0 +1,53 @@
+import { StringDict } from "../../../v1/parsing/common/index.js";
+import { Field } from "./field.js";
+import { BaseFieldConstructor } from "./base.js";
+/**
+ * @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;
+}
+/**
+ * Represent a single tax line.
+ */
+export declare class TaxField extends Field {
+    #private;
+    /** The tax amount. */
+    value?: number;
+    /** The tax rate. */
+    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;
+    /**
+     * @param {TaxConstructor} constructor Constructor parameters.
+     */
+    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[] | undefined, pageId: number | undefined): this;
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}
+export {};

package/src/v1/parsing/standard/tax.js

@@ -0,0 +1,119 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _TaxField_instances, _TaxField_printableValues, _Taxes_instances, _Taxes_lineSeparator;
+import { floatToString } from "../../../v1/parsing/common/index.js";
+import { Field } from "./field.js";
+/**
+ * Represent a single tax line.
+ */
+export class TaxField extends Field {
+    /**
+     * @param {TaxConstructor} constructor Constructor parameters.
+     */
+    constructor({ prediction = {}, valueKey = "value", rateKey = "rate", codeKey = "code", baseKey = "base", reconstructed = false, pageId = undefined, }) {
+        super({ prediction, valueKey, reconstructed, pageId });
+        _TaxField_instances.add(this);
+        /** The tax amount. */
+        this.value = undefined;
+        /** The tax rate. */
+        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;
+        this.code = prediction[codeKey]?.toString();
+        if (this.code === "N/A" || this.code === "None") {
+            this.code = undefined;
+        }
+        this.value = parseFloat(prediction[valueKey]);
+        if (isNaN(this.value)) {
+            this.value = undefined;
+            this.confidence = 0.0;
+        }
+        this.base = parseFloat(prediction[baseKey]);
+        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 ("| " +
+            printable.base.padEnd(13) +
+            " | " +
+            printable.code.padEnd(6) +
+            " | " +
+            printable.rate.padEnd(8) +
+            " | " +
+            printable.value.padEnd(13) +
+            " |");
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const printable = __classPrivateFieldGet(this, _TaxField_instances, "m", _TaxField_printableValues).call(this);
+        return ("Base: " +
+            printable.base +
+            ", Code: " +
+            printable.code +
+            ", Rate (%): " +
+            printable.rate +
+            ", Amount: " +
+            printable.value).trim();
+    }
+}
+_TaxField_instances = new WeakSet(), _TaxField_printableValues = function _TaxField_printableValues() {
+    return {
+        code: this.code ?? "",
+        base: this.base !== undefined ? floatToString(this.base) : "",
+        rate: this.rate !== undefined ? floatToString(this.rate) : "",
+        value: this.value !== undefined ? floatToString(this.value) : "",
+    };
+};
+/**
+ * Represent all items.
+ */
+export class Taxes extends Array {
+    constructor() {
+        super(...arguments);
+        _Taxes_instances.add(this);
+    }
+    init(prediction = [], pageId) {
+        for (const entry of prediction) {
+            this.push(new TaxField({
+                prediction: entry,
+                pageId: pageId,
+            }));
+        }
+        return this;
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        let outStr = `
+${__classPrivateFieldGet(this, _Taxes_instances, "m", _Taxes_lineSeparator).call(this, "-")}
+  | Base          | Code   | Rate (%) | Amount        |
+${__classPrivateFieldGet(this, _Taxes_instances, "m", _Taxes_lineSeparator).call(this, "=")}`;
+        for (const entry of this.entries()) {
+            outStr += `\n  ${entry[1].toTableLine()}\n${__classPrivateFieldGet(this, _Taxes_instances, "m", _Taxes_lineSeparator).call(this, "-")}`;
+        }
+        return outStr;
+    }
+}
+_Taxes_instances = new WeakSet(), _Taxes_lineSeparator = function _Taxes_lineSeparator(char) {
+    let outStr = "  ";
+    outStr += `+${char.repeat(15)}`;
+    outStr += `+${char.repeat(8)}`;
+    outStr += `+${char.repeat(10)}`;
+    outStr += `+${char.repeat(15)}`;
+    return outStr + "+";
+};

package/src/v1/parsing/standard/text.d.ts

@@ -0,0 +1,18 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+import { Field } from "./field.js";
+export interface FieldConstructor {
+    prediction: StringDict;
+    valueKey?: string;
+    reconstructed?: boolean;
+    pageId?: number | undefined;
+}
+/**
+ * A field containing a text value.
+ */
+export declare class StringField extends Field {
+    /** The value. */
+    value?: string;
+    /** Value as it appears on the document. */
+    rawValue?: string;
+    constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
+}

package/src/v1/parsing/standard/text.js

@@ -0,0 +1,12 @@
+import { Field } from "./field.js";
+/**
+ * A field containing a text value.
+ */
+export class StringField extends Field {
+    constructor({ prediction = {}, valueKey = "value", reconstructed = false, pageId, }) {
+        super({ prediction, valueKey, reconstructed, pageId });
+        if (prediction["raw_value"]) {
+            this.rawValue = prediction["raw_value"];
+        }
+    }
+}

package/src/v1/parsing/standard/word.d.ts

@@ -0,0 +1,10 @@
+import * as geometry from "../../../geometry/index.js";
+export type Word = {
+    /**
+     * Contains the relative vertices coordinates (points) of a polygon containing
+     * the field in the document.
+     */
+    polygon: geometry.Polygon;
+    text: string;
+    confidence: number;
+};

package/src/v1/parsing/standard/word.js

@@ -0,0 +1 @@
+export {};

package/src/v1/product/barcodeReader/barcodeReaderV1.d.ts

@@ -0,0 +1,16 @@
+import { Inference, StringDict, Page } from "../../../v1/parsing/common/index.js";
+import { BarcodeReaderV1Document } from "./barcodeReaderV1Document.js";
+/**
+ * Barcode Reader API version 1 inference prediction.
+ */
+export declare class BarcodeReaderV1 extends Inference {
+    /** The endpoint's name. */
+    endpointName: string;
+    /** The endpoint's version. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: BarcodeReaderV1Document;
+    /** The document's pages. */
+    pages: Page<BarcodeReaderV1Document>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/v1/product/barcodeReader/barcodeReaderV1.js

@@ -0,0 +1,23 @@
+import { Inference, Page } from "../../../v1/parsing/common/index.js";
+import { BarcodeReaderV1Document } from "./barcodeReaderV1Document.js";
+/**
+ * Barcode Reader API version 1 inference prediction.
+ */
+export class BarcodeReaderV1 extends Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "barcode_reader";
+        /** The endpoint's version. */
+        this.endpointVersion = "1";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new BarcodeReaderV1Document(rawPrediction["prediction"]);
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new Page(BarcodeReaderV1Document, page, page["id"], page["orientation"]));
+            }
+        });
+    }
+}

package/src/v1/product/barcodeReader/barcodeReaderV1Document.d.ts

@@ -0,0 +1,16 @@
+import { Prediction, StringDict } from "../../../v1/parsing/common/index.js";
+import { StringField } from "../../../v1/parsing/standard/index.js";
+/**
+ * Barcode Reader API version 1.0 document data.
+ */
+export declare class BarcodeReaderV1Document implements Prediction {
+    /** List of decoded 1D barcodes. */
+    codes1D: StringField[];
+    /** List of decoded 2D barcodes. */
+    codes2D: StringField[];
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/v1/product/barcodeReader/barcodeReaderV1Document.js

@@ -0,0 +1,35 @@
+import { cleanOutString, } from "../../../v1/parsing/common/index.js";
+import { StringField } from "../../../v1/parsing/standard/index.js";
+/**
+ * Barcode Reader API version 1.0 document data.
+ */
+export class BarcodeReaderV1Document {
+    constructor(rawPrediction, pageId) {
+        /** List of decoded 1D barcodes. */
+        this.codes1D = [];
+        /** List of decoded 2D barcodes. */
+        this.codes2D = [];
+        if (rawPrediction["codes_1d"]) {
+            rawPrediction["codes_1d"].map((itemPrediction) => this.codes1D.push(new StringField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        }
+        if (rawPrediction["codes_2d"]) {
+            rawPrediction["codes_2d"].map((itemPrediction) => this.codes2D.push(new StringField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        }
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const codes1D = this.codes1D.join("\n              ");
+        const codes2D = this.codes2D.join("\n              ");
+        const outStr = `:Barcodes 1D: ${codes1D}
+:Barcodes 2D: ${codes2D}`.trimEnd();
+        return cleanOutString(outStr);
+    }
+}

package/src/v1/product/barcodeReader/index.d.ts

@@ -0,0 +1,2 @@
+export { BarcodeReaderV1 } from "./barcodeReaderV1.js";
+export { BarcodeReaderV1Document } from "./barcodeReaderV1Document.js";

package/src/v1/product/barcodeReader/index.js

@@ -0,0 +1,2 @@
+export { BarcodeReaderV1 } from "./barcodeReaderV1.js";
+export { BarcodeReaderV1Document } from "./barcodeReaderV1Document.js";

package/src/v1/product/cliProducts.d.ts

@@ -0,0 +1,10 @@
+import { Inference, StringDict } from "../../v1/parsing/common/index.js";
+export declare const COMMAND_GENERATED = "generated";
+export interface ProductConfig<T extends Inference = Inference> {
+    displayName: string;
+    docClass: new (rawPrediction: StringDict) => T;
+    allWords: boolean;
+    async: boolean;
+    sync: boolean;
+}
+export declare const CLI_COMMAND_CONFIG: Map<string, ProductConfig<Inference<import("../../v1/parsing/common/index.js").Prediction, import("../../v1/parsing/common/index.js").Prediction>>>;

package/src/v1/product/cliProducts.js

@@ -0,0 +1,159 @@
+//
+// PRODUCT CONFIGURATION
+//
+// The Map's key is the command name as it will appear on the console.
+//
+import * as product from "../../v1/product/index.js";
+export const COMMAND_GENERATED = "generated";
+export const CLI_COMMAND_CONFIG = new Map([
+    [
+        COMMAND_GENERATED,
+        {
+            displayName: "Generated Document",
+            docClass: product.GeneratedV1,
+            allWords: true,
+            async: true,
+            sync: true,
+        },
+    ],
+    [
+        "barcode-reader",
+        {
+            displayName: "Barcode Reader",
+            docClass: product.BarcodeReaderV1,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        "cropper",
+        {
+            displayName: "Cropper",
+            docClass: product.CropperV1,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        "driver-license",
+        {
+            displayName: "Driver License",
+            docClass: product.DriverLicenseV1,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "financial-document",
+        {
+            displayName: "Financial Document",
+            docClass: product.FinancialDocumentV1,
+            allWords: true,
+            async: true,
+            sync: true,
+        },
+    ],
+    [
+        "fr-bank-account-details",
+        {
+            displayName: "FR Bank Account Details",
+            docClass: product.fr.BankAccountDetailsV2,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        "fr-carte-nationale-d-identite",
+        {
+            displayName: "FR Carte Nationale d'Identité",
+            docClass: product.fr.IdCardV2,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        "international-id",
+        {
+            displayName: "International ID",
+            docClass: product.InternationalIdV2,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "invoice",
+        {
+            displayName: "Invoice",
+            docClass: product.InvoiceV4,
+            allWords: true,
+            async: true,
+            sync: true,
+        },
+    ],
+    [
+        "invoice-splitter",
+        {
+            displayName: "Invoice Splitter",
+            docClass: product.InvoiceSplitterV1,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "multi-receipts-detector",
+        {
+            displayName: "Multi Receipts Detector",
+            docClass: product.MultiReceiptsDetectorV1,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        "passport",
+        {
+            displayName: "Passport",
+            docClass: product.PassportV1,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+    [
+        "receipt",
+        {
+            displayName: "Receipt",
+            docClass: product.ReceiptV5,
+            allWords: true,
+            async: true,
+            sync: true,
+        },
+    ],
+    [
+        "resume",
+        {
+            displayName: "Resume",
+            docClass: product.ResumeV1,
+            allWords: false,
+            async: true,
+            sync: false,
+        },
+    ],
+    [
+        "us-bank-check",
+        {
+            displayName: "US Bank Check",
+            docClass: product.us.BankCheckV1,
+            allWords: false,
+            async: false,
+            sync: true,
+        },
+    ],
+]);

package/src/v1/product/cropper/cropperV1.d.ts

@@ -0,0 +1,17 @@
+import { Inference, StringDict, Page } from "../../../v1/parsing/common/index.js";
+import { CropperV1Document } from "./cropperV1Document.js";
+import { CropperV1Page } from "./cropperV1Page.js";
+/**
+ * Cropper API version 1 inference prediction.
+ */
+export declare class CropperV1 extends Inference {
+    /** The endpoint's name. */
+    endpointName: string;
+    /** The endpoint's version. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: CropperV1Document;
+    /** The document's pages. */
+    pages: Page<CropperV1Page>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/v1/product/cropper/cropperV1.js

@@ -0,0 +1,24 @@
+import { Inference, Page } from "../../../v1/parsing/common/index.js";
+import { CropperV1Document } from "./cropperV1Document.js";
+import { CropperV1Page } from "./cropperV1Page.js";
+/**
+ * Cropper API version 1 inference prediction.
+ */
+export class CropperV1 extends Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "cropper";
+        /** The endpoint's version. */
+        this.endpointVersion = "1";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new CropperV1Document();
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new Page(CropperV1Page, page, page["id"], page["orientation"]));
+            }
+        });
+    }
+}

package/src/v1/product/cropper/cropperV1Document.d.ts

@@ -0,0 +1,10 @@
+import { Prediction } from "../../../v1/parsing/common/index.js";
+/**
+ * Cropper API version 1.1 document data.
+ */
+export declare class CropperV1Document implements Prediction {
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/v1/product/cropper/cropperV1Document.js

@@ -0,0 +1,11 @@
+/**
+ * Cropper API version 1.1 document data.
+ */
+export class CropperV1Document {
+    /**
+     * Default string representation.
+     */
+    toString() {
+        return "";
+    }
+}

package/src/v1/product/cropper/cropperV1Page.d.ts

@@ -0,0 +1,12 @@
+import { StringDict } from "../../../v1/parsing/common/index.js";
+import { PositionField } from "../../../v1/parsing/standard/index.js";
+import { CropperV1Document } from "./cropperV1Document.js";
+/**
+ * Cropper API version 1.1 page data.
+ */
+export declare class CropperV1Page extends CropperV1Document {
+    /** List of documents found in the image. */
+    cropping: PositionField[];
+    constructor(rawPrediction: StringDict, pageId?: number);
+    toString(): string;
+}

package/src/v1/product/cropper/cropperV1Page.js

@@ -0,0 +1,22 @@
+import { cleanOutString } from "../../../v1/parsing/common/index.js";
+import { PositionField } from "../../../v1/parsing/standard/index.js";
+import { CropperV1Document } from "./cropperV1Document.js";
+/**
+ * Cropper API version 1.1 page data.
+ */
+export class CropperV1Page extends CropperV1Document {
+    constructor(rawPrediction, pageId) {
+        super();
+        /** List of documents found in the image. */
+        this.cropping = [];
+        rawPrediction["cropping"].map((itemPrediction) => this.cropping.push(new PositionField({
+            prediction: itemPrediction,
+            pageId: pageId,
+        })));
+    }
+    toString() {
+        const cropping = this.cropping.join("\n                   ");
+        const outStr = `:Document Cropper: ${cropping}`.trimEnd();
+        return cleanOutString(outStr);
+    }
+}

package/src/v1/product/cropper/index.d.ts

@@ -0,0 +1,3 @@
+export { CropperV1 } from "./cropperV1.js";
+export { CropperV1Document } from "./cropperV1Document.js";
+export { CropperV1Page } from "./cropperV1Page.js";

package/src/v1/product/cropper/index.js

@@ -0,0 +1,3 @@
+export { CropperV1 } from "./cropperV1.js";
+export { CropperV1Document } from "./cropperV1Document.js";
+export { CropperV1Page } from "./cropperV1Page.js";