mindee 4.1.1 → 4.3.0

package/src/product/multiReceiptsDetector/internal.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultiReceiptsDetectorV1Document = exports.MultiReceiptsDetectorV1 = void 0;
+var multiReceiptsDetectorV1_1 = require("./multiReceiptsDetectorV1");
+Object.defineProperty(exports, "MultiReceiptsDetectorV1", { enumerable: true, get: function () { return multiReceiptsDetectorV1_1.MultiReceiptsDetectorV1; } });
+var multiReceiptsDetectorV1Document_1 = require("./multiReceiptsDetectorV1Document");
+Object.defineProperty(exports, "MultiReceiptsDetectorV1Document", { enumerable: true, get: function () { return multiReceiptsDetectorV1Document_1.MultiReceiptsDetectorV1Document; } });

package/src/product/multiReceiptsDetector/multiReceiptsDetectorV1.d.ts

@@ -0,0 +1,16 @@
+import { Inference, StringDict, Page } from "../../parsing/common";
+import { MultiReceiptsDetectorV1Document } from "./multiReceiptsDetectorV1Document";
+/**
+ * Inference prediction for Multi Receipts Detector, API version 1.
+ */
+export declare class MultiReceiptsDetectorV1 extends Inference {
+    /** The endpoint's name. */
+    endpointName: string;
+    /** The endpoint's version. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: MultiReceiptsDetectorV1Document;
+    /** The document's pages. */
+    pages: Page<MultiReceiptsDetectorV1Document>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/product/multiReceiptsDetector/multiReceiptsDetectorV1.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultiReceiptsDetectorV1 = void 0;
+const common_1 = require("../../parsing/common");
+const multiReceiptsDetectorV1Document_1 = require("./multiReceiptsDetectorV1Document");
+/**
+ * Inference prediction for Multi Receipts Detector, API version 1.
+ */
+class MultiReceiptsDetectorV1 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "multi_receipts_detector";
+        /** The endpoint's version. */
+        this.endpointVersion = "1";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new multiReceiptsDetectorV1Document_1.MultiReceiptsDetectorV1Document(rawPrediction["prediction"]);
+        this.pages = rawPrediction["pages"].map((page) => new common_1.Page(multiReceiptsDetectorV1Document_1.MultiReceiptsDetectorV1Document, page, page["id"], page["orientation"]));
+    }
+}
+exports.MultiReceiptsDetectorV1 = MultiReceiptsDetectorV1;

package/src/product/multiReceiptsDetector/multiReceiptsDetectorV1Document.d.ts

@@ -0,0 +1,14 @@
+import { Prediction, StringDict } from "../../parsing/common";
+import { PositionField } from "../../parsing/standard";
+/**
+ * Document data for Multi Receipts Detector, API version 1.
+ */
+export declare class MultiReceiptsDetectorV1Document implements Prediction {
+    /** Positions of the receipts on the document. */
+    receipts: PositionField[];
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/product/multiReceiptsDetector/multiReceiptsDetectorV1Document.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultiReceiptsDetectorV1Document = void 0;
+const common_1 = require("../../parsing/common");
+const standard_1 = require("../../parsing/standard");
+/**
+ * Document data for Multi Receipts Detector, API version 1.
+ */
+class MultiReceiptsDetectorV1Document {
+    constructor(rawPrediction, pageId) {
+        /** Positions of the receipts on the document. */
+        this.receipts = [];
+        rawPrediction["receipts"] &&
+            rawPrediction["receipts"].map((itemPrediction) => this.receipts.push(new standard_1.PositionField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const receipts = this.receipts.join("\n                   ");
+        const outStr = `:List of Receipts: ${receipts}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.MultiReceiptsDetectorV1Document = MultiReceiptsDetectorV1Document;

package/src/product/passport/passportV1Document.js

@@ -60,7 +60,7 @@ class PassportV1Document {
      * Default string representation.
      */
     toString() {
-        const givenNames = this.givenNames.join("\n              ");
+        const givenNames = this.givenNames.join("\n                ");
         const outStr = `:Country Code: ${this.country}
 :ID Number: ${this.idNumber}
 :Given Name(s): ${givenNames}

package/src/product/proofOfAddress/proofOfAddressV1Document.js

@@ -57,8 +57,8 @@ class ProofOfAddressV1Document {
      * Default string representation.
      */
     toString() {
-        const issuerCompanyRegistration = this.issuerCompanyRegistration.join("\n                              ");
-        const recipientCompanyRegistration = this.recipientCompanyRegistration.join("\n                                 ");
+        const issuerCompanyRegistration = this.issuerCompanyRegistration.join("\n                               ");
+        const recipientCompanyRegistration = this.recipientCompanyRegistration.join("\n                                  ");
         const dates = this.dates.join("\n        ");
         const outStr = `:Locale: ${this.locale}
 :Issuer Name: ${this.issuerName}

package/src/product/us/bankCheck/bankCheckV1Page.js

@@ -22,7 +22,7 @@ class BankCheckV1Page extends bankCheckV1Document_1.BankCheckV1Document {
         })));
     }
     toString() {
-        const signaturesPositions = this.signaturesPositions.join("\n                       ");
+        const signaturesPositions = this.signaturesPositions.join("\n                      ");
         let outStr = `:Check Position: ${this.checkPosition}
 :Signature Positions: ${signaturesPositions}`.trimEnd();
         outStr += "\n" + super.toString();

package/src/product/us/index.d.ts

@@ -1,2 +1,3 @@
 export { BankCheckV1 } from "./bankCheck/bankCheckV1";
 export { DriverLicenseV1 } from "./driverLicense/driverLicenseV1";
+export { W9V1 } from "./w9/w9V1";

package/src/product/us/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DriverLicenseV1 = exports.BankCheckV1 = void 0;
+exports.W9V1 = exports.DriverLicenseV1 = exports.BankCheckV1 = void 0;
 var bankCheckV1_1 = require("./bankCheck/bankCheckV1");
 Object.defineProperty(exports, "BankCheckV1", { enumerable: true, get: function () { return bankCheckV1_1.BankCheckV1; } });
 var driverLicenseV1_1 = require("./driverLicense/driverLicenseV1");
 Object.defineProperty(exports, "DriverLicenseV1", { enumerable: true, get: function () { return driverLicenseV1_1.DriverLicenseV1; } });
+var w9V1_1 = require("./w9/w9V1");
+Object.defineProperty(exports, "W9V1", { enumerable: true, get: function () { return w9V1_1.W9V1; } });

package/src/product/us/w9/internal.d.ts

@@ -0,0 +1,3 @@
+export { W9V1 } from "./w9V1";
+export { W9V1Document } from "./w9V1Document";
+export { W9V1Page } from "./w9V1Page";

package/src/product/us/w9/internal.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.W9V1Page = exports.W9V1Document = exports.W9V1 = void 0;
+var w9V1_1 = require("./w9V1");
+Object.defineProperty(exports, "W9V1", { enumerable: true, get: function () { return w9V1_1.W9V1; } });
+var w9V1Document_1 = require("./w9V1Document");
+Object.defineProperty(exports, "W9V1Document", { enumerable: true, get: function () { return w9V1Document_1.W9V1Document; } });
+var w9V1Page_1 = require("./w9V1Page");
+Object.defineProperty(exports, "W9V1Page", { enumerable: true, get: function () { return w9V1Page_1.W9V1Page; } });

package/src/product/us/w9/w9V1.d.ts

@@ -0,0 +1,17 @@
+import { Inference, StringDict, Page } from "../../../parsing/common";
+import { W9V1Document } from "./w9V1Document";
+import { W9V1Page } from "./w9V1Page";
+/**
+ * Inference prediction for US W9, API version 1.
+ */
+export declare class W9V1 extends Inference {
+    /** The endpoint's name. */
+    endpointName: string;
+    /** The endpoint's version. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: W9V1Document;
+    /** The document's pages. */
+    pages: Page<W9V1Page>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/product/us/w9/w9V1.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.W9V1 = void 0;
+const common_1 = require("../../../parsing/common");
+const w9V1Document_1 = require("./w9V1Document");
+const w9V1Page_1 = require("./w9V1Page");
+/**
+ * Inference prediction for US W9, API version 1.
+ */
+class W9V1 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "us_w9";
+        /** The endpoint's version. */
+        this.endpointVersion = "1";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new w9V1Document_1.W9V1Document();
+        this.pages = rawPrediction["pages"].map((page) => new common_1.Page(w9V1Page_1.W9V1Page, page, page["id"], page["orientation"]));
+    }
+}
+exports.W9V1 = W9V1;

package/src/product/us/w9/w9V1Document.d.ts

@@ -0,0 +1,10 @@
+import { Prediction } from "../../../parsing/common";
+/**
+ * Document data for US W9, API version 1.
+ */
+export declare class W9V1Document implements Prediction {
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/product/us/w9/w9V1Document.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.W9V1Document = void 0;
+/**
+ * Document data for US W9, API version 1.
+ */
+class W9V1Document {
+    /**
+     * Default string representation.
+     */
+    toString() {
+        return "";
+    }
+}
+exports.W9V1Document = W9V1Document;

package/src/product/us/w9/w9V1Page.d.ts

@@ -0,0 +1,34 @@
+import { StringDict } from "../../../parsing/common";
+import { PositionField, StringField } from "../../../parsing/standard";
+import { W9V1Document } from "./w9V1Document";
+/**
+ * Page data for US W9, API version 1.
+ */
+export declare class W9V1Page extends W9V1Document {
+    /** The street address (number, street, and apt. or suite no.) of the applicant. */
+    address: StringField;
+    /** The business name or disregarded entity name, if different from Name. */
+    businessName: StringField;
+    /** The city, state, and ZIP code of the applicant. */
+    cityStateZip: StringField;
+    /** The employer identification number. */
+    ein: StringField;
+    /** Name as shown on the applicant's income tax return. */
+    name: StringField;
+    /** Position of the signature date on the document. */
+    signatureDatePosition: PositionField;
+    /** Position of the signature on the document. */
+    signaturePosition: PositionField;
+    /** The applicant's social security number. */
+    ssn: StringField;
+    /** The federal tax classification, which can vary depending on the revision date. */
+    taxClassification: StringField;
+    /** Depending on revision year, among S, C, P or D for Limited Liability Company Classification. */
+    taxClassificationLlc: StringField;
+    /** Tax Classification Other Details. */
+    taxClassificationOtherDetails: StringField;
+    /** The Revision month and year of the W9 form. */
+    w9RevisionDate: StringField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    toString(): string;
+}

package/src/product/us/w9/w9V1Page.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.W9V1Page = void 0;
+const common_1 = require("../../../parsing/common");
+const standard_1 = require("../../../parsing/standard");
+const w9V1Document_1 = require("./w9V1Document");
+/**
+ * Page data for US W9, API version 1.
+ */
+class W9V1Page extends w9V1Document_1.W9V1Document {
+    constructor(rawPrediction, pageId) {
+        super();
+        this.address = new standard_1.StringField({
+            prediction: rawPrediction["address"],
+            pageId: pageId,
+        });
+        this.businessName = new standard_1.StringField({
+            prediction: rawPrediction["business_name"],
+            pageId: pageId,
+        });
+        this.cityStateZip = new standard_1.StringField({
+            prediction: rawPrediction["city_state_zip"],
+            pageId: pageId,
+        });
+        this.ein = new standard_1.StringField({
+            prediction: rawPrediction["ein"],
+            pageId: pageId,
+        });
+        this.name = new standard_1.StringField({
+            prediction: rawPrediction["name"],
+            pageId: pageId,
+        });
+        this.signatureDatePosition = new standard_1.PositionField({
+            prediction: rawPrediction["signature_date_position"],
+            pageId: pageId,
+        });
+        this.signaturePosition = new standard_1.PositionField({
+            prediction: rawPrediction["signature_position"],
+            pageId: pageId,
+        });
+        this.ssn = new standard_1.StringField({
+            prediction: rawPrediction["ssn"],
+            pageId: pageId,
+        });
+        this.taxClassification = new standard_1.StringField({
+            prediction: rawPrediction["tax_classification"],
+            pageId: pageId,
+        });
+        this.taxClassificationLlc = new standard_1.StringField({
+            prediction: rawPrediction["tax_classification_llc"],
+            pageId: pageId,
+        });
+        this.taxClassificationOtherDetails = new standard_1.StringField({
+            prediction: rawPrediction["tax_classification_other_details"],
+            pageId: pageId,
+        });
+        this.w9RevisionDate = new standard_1.StringField({
+            prediction: rawPrediction["w9_revision_date"],
+            pageId: pageId,
+        });
+    }
+    toString() {
+        const outStr = `:Name: ${this.name}
+:SSN: ${this.ssn}
+:Address: ${this.address}
+:City State Zip: ${this.cityStateZip}
+:Business Name: ${this.businessName}
+:EIN: ${this.ein}
+:Tax Classification: ${this.taxClassification}
+:Tax Classification Other Details: ${this.taxClassificationOtherDetails}
+:W9 Revision Date: ${this.w9RevisionDate}
+:Signature Position: ${this.signaturePosition}
+:Signature Date Position: ${this.signatureDatePosition}
+:Tax Classification LLC: ${this.taxClassificationLlc}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.W9V1Page = W9V1Page;