mindee 4.0.1 → 4.1.0

package/src/product/fr/carteVitale/carteVitaleV1.js

@@ -3,11 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CarteVitaleV1 = void 0;
 const common_1 = require("../../../parsing/common");
 const carteVitaleV1Document_1 = require("./carteVitaleV1Document");
+/**
+ * Inference prediction for Carte Vitale, API version 1.
+ */
 class CarteVitaleV1 extends common_1.Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
+        /** The endpoint's name. */
         this.endpointName = "carte_vitale";
+        /** The endpoint's version. */
         this.endpointVersion = "1";
+        /** The document's pages. */
         this.pages = [];
         this.prediction = new carteVitaleV1Document_1.CarteVitaleV1Document(rawPrediction["prediction"]);
         this.pages = rawPrediction["pages"].map((page) => new common_1.Page(carteVitaleV1Document_1.CarteVitaleV1Document, page, page["id"], page["orientation"]));

package/src/product/fr/carteVitale/carteVitaleV1Document.d.ts

@@ -13,5 +13,8 @@ export declare class CarteVitaleV1Document implements Prediction {
     /** The surname of the card holder. */
     surname: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/product/fr/carteVitale/carteVitaleV1Document.js

@@ -28,6 +28,9 @@ class CarteVitaleV1Document {
             pageId: pageId,
         });
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const givenNames = this.givenNames.join("\n              ");
         const outStr = `:Given Name(s): ${givenNames}

package/src/product/fr/carteVitale/internal.d.ts

@@ -0,0 +1,2 @@
+export { CarteVitaleV1 } from "./carteVitaleV1";
+export { CarteVitaleV1Document } from "./carteVitaleV1Document";

package/src/product/fr/carteVitale/internal.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CarteVitaleV1Document = exports.CarteVitaleV1 = void 0;
+var carteVitaleV1_1 = require("./carteVitaleV1");
+Object.defineProperty(exports, "CarteVitaleV1", { enumerable: true, get: function () { return carteVitaleV1_1.CarteVitaleV1; } });
+var carteVitaleV1Document_1 = require("./carteVitaleV1Document");
+Object.defineProperty(exports, "CarteVitaleV1Document", { enumerable: true, get: function () { return carteVitaleV1Document_1.CarteVitaleV1Document; } });

package/src/product/fr/idCard/idCardV1.d.ts

@@ -1,10 +1,17 @@
 import { Inference, StringDict, Page } from "../../../parsing/common";
 import { IdCardV1Document } from "./idCardV1Document";
 import { IdCardV1Page } from "./idCardV1Page";
+/**
+ * Inference prediction for Carte Nationale d'Identité, API version 1.
+ */
 export declare class IdCardV1 extends Inference {
+    /** The endpoint's name. */
     endpointName: string;
+    /** The endpoint's version. */
     endpointVersion: string;
+    /** The document-level prediction. */
     prediction: IdCardV1Document;
+    /** The document's pages. */
     pages: Page<IdCardV1Page>[];
     constructor(rawPrediction: StringDict);
 }

package/src/product/fr/idCard/idCardV1.js

@@ -4,11 +4,17 @@ exports.IdCardV1 = void 0;
 const common_1 = require("../../../parsing/common");
 const idCardV1Document_1 = require("./idCardV1Document");
 const idCardV1Page_1 = require("./idCardV1Page");
+/**
+ * Inference prediction for Carte Nationale d'Identité, API version 1.
+ */
 class IdCardV1 extends common_1.Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
+        /** The endpoint's name. */
         this.endpointName = "idcard_fr";
+        /** The endpoint's version. */
         this.endpointVersion = "1";
+        /** The document's pages. */
         this.pages = [];
         this.prediction = new idCardV1Document_1.IdCardV1Document(rawPrediction["prediction"]);
         this.pages = rawPrediction["pages"].map((page) => new common_1.Page(idCardV1Page_1.IdCardV1Page, page, page["id"], page["orientation"]));

package/src/product/fr/idCard/idCardV1Document.d.ts

@@ -25,5 +25,8 @@ export declare class IdCardV1Document implements Prediction {
     /** The surname of the card holder. */
     surname: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/product/fr/idCard/idCardV1Document.js

@@ -52,6 +52,9 @@ class IdCardV1Document {
             pageId: pageId,
         });
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const givenNames = this.givenNames.join("\n              ");
         const outStr = `:Identity Number: ${this.idNumber}

package/src/product/fr/idCard/internal.d.ts

@@ -0,0 +1,3 @@
+export { IdCardV1 } from "./idCardV1";
+export { IdCardV1Document } from "./idCardV1Document";
+export { IdCardV1Page } from "./idCardV1Page";

package/src/product/fr/idCard/internal.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdCardV1Page = exports.IdCardV1Document = exports.IdCardV1 = void 0;
+var idCardV1_1 = require("./idCardV1");
+Object.defineProperty(exports, "IdCardV1", { enumerable: true, get: function () { return idCardV1_1.IdCardV1; } });
+var idCardV1Document_1 = require("./idCardV1Document");
+Object.defineProperty(exports, "IdCardV1Document", { enumerable: true, get: function () { return idCardV1Document_1.IdCardV1Document; } });
+var idCardV1Page_1 = require("./idCardV1Page");
+Object.defineProperty(exports, "IdCardV1Page", { enumerable: true, get: function () { return idCardV1Page_1.IdCardV1Page; } });

package/src/product/fr/internal.d.ts

@@ -0,0 +1,3 @@
+export * as bankAccountDetails from "./bankAccountDetails/internal";
+export * as carteVitale from "./carteVitale/internal";
+export * as idCard from "./idCard/internal";

package/src/product/fr/internal.js

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.idCard = exports.carteVitale = exports.bankAccountDetails = void 0;
+exports.bankAccountDetails = __importStar(require("./bankAccountDetails/internal"));
+exports.carteVitale = __importStar(require("./carteVitale/internal"));
+exports.idCard = __importStar(require("./idCard/internal"));

package/src/product/index.d.ts

@@ -1,6 +1,5 @@
 export { InvoiceV4 } from "./invoice/invoiceV4";
 export { InvoiceSplitterV1 } from "./invoiceSplitter/invoiceSplitterV1";
-export { PageGroup } from "./invoiceSplitter/invoiceSplitterV1PageGroup";
 export { ReceiptV4 } from "./receipt/receiptV4";
 export { ReceiptV5 } from "./receipt/receiptV5";
 export { PassportV1 } from "./passport/passportV1";

package/src/product/index.js

@@ -23,13 +23,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.eu = exports.us = exports.fr = exports.ProofOfAddressV1 = exports.CropperV1 = exports.CustomV1 = exports.FinancialDocumentV1 = exports.PassportV1 = exports.ReceiptV5 = exports.ReceiptV4 = exports.PageGroup = exports.InvoiceSplitterV1 = exports.InvoiceV4 = void 0;
+exports.eu = exports.us = exports.fr = exports.ProofOfAddressV1 = exports.CropperV1 = exports.CustomV1 = exports.FinancialDocumentV1 = exports.PassportV1 = exports.ReceiptV5 = exports.ReceiptV4 = exports.InvoiceSplitterV1 = exports.InvoiceV4 = void 0;
 var invoiceV4_1 = require("./invoice/invoiceV4");
 Object.defineProperty(exports, "InvoiceV4", { enumerable: true, get: function () { return invoiceV4_1.InvoiceV4; } });
 var invoiceSplitterV1_1 = require("./invoiceSplitter/invoiceSplitterV1");
 Object.defineProperty(exports, "InvoiceSplitterV1", { enumerable: true, get: function () { return invoiceSplitterV1_1.InvoiceSplitterV1; } });
-var invoiceSplitterV1PageGroup_1 = require("./invoiceSplitter/invoiceSplitterV1PageGroup");
-Object.defineProperty(exports, "PageGroup", { enumerable: true, get: function () { return invoiceSplitterV1PageGroup_1.PageGroup; } });
 var receiptV4_1 = require("./receipt/receiptV4");
 Object.defineProperty(exports, "ReceiptV4", { enumerable: true, get: function () { return receiptV4_1.ReceiptV4; } });
 var receiptV5_1 = require("./receipt/receiptV5");

package/src/product/internal.d.ts

@@ -0,0 +1,11 @@
+export * as cropper from "./cropper/internal";
+export * as custom from "./custom/internal";
+export * as eu from "./eu/internal";
+export * as financialDocument from "./financialDocument/internal";
+export * as fr from "./fr/internal";
+export * as invoice from "./invoice/internal";
+export * as invoiceSplitter from "./invoiceSplitter/internal";
+export * as passport from "./passport/internal";
+export * as proofOfAddress from "./proofOfAddress/internal";
+export * as receipt from "./receipt/internal";
+export * as us from "./us/internal";

package/src/product/internal.js

@@ -0,0 +1,37 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.us = exports.receipt = exports.proofOfAddress = exports.passport = exports.invoiceSplitter = exports.invoice = exports.fr = exports.financialDocument = exports.eu = exports.custom = exports.cropper = void 0;
+exports.cropper = __importStar(require("./cropper/internal"));
+exports.custom = __importStar(require("./custom/internal"));
+exports.eu = __importStar(require("./eu/internal"));
+exports.financialDocument = __importStar(require("./financialDocument/internal"));
+exports.fr = __importStar(require("./fr/internal"));
+exports.invoice = __importStar(require("./invoice/internal"));
+exports.invoiceSplitter = __importStar(require("./invoiceSplitter/internal"));
+exports.passport = __importStar(require("./passport/internal"));
+exports.proofOfAddress = __importStar(require("./proofOfAddress/internal"));
+exports.receipt = __importStar(require("./receipt/internal"));
+exports.us = __importStar(require("./us/internal"));

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

@@ -0,0 +1,3 @@
+export { InvoiceV4 } from "./invoiceV4";
+export { InvoiceV4Document } from "./invoiceV4Document";
+export { InvoiceV4LineItem } from "./invoiceV4LineItem";

package/src/product/invoice/internal.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvoiceV4LineItem = exports.InvoiceV4Document = exports.InvoiceV4 = void 0;
+var invoiceV4_1 = require("./invoiceV4");
+Object.defineProperty(exports, "InvoiceV4", { enumerable: true, get: function () { return invoiceV4_1.InvoiceV4; } });
+var invoiceV4Document_1 = require("./invoiceV4Document");
+Object.defineProperty(exports, "InvoiceV4Document", { enumerable: true, get: function () { return invoiceV4Document_1.InvoiceV4Document; } });
+var invoiceV4LineItem_1 = require("./invoiceV4LineItem");
+Object.defineProperty(exports, "InvoiceV4LineItem", { enumerable: true, get: function () { return invoiceV4LineItem_1.InvoiceV4LineItem; } });

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

@@ -1,9 +1,16 @@
 import { Inference, StringDict, Page } from "../../parsing/common";
 import { InvoiceV4Document } from "./invoiceV4Document";
+/**
+ * Inference prediction for Invoice, API version 4.
+ */
 export declare class InvoiceV4 extends Inference {
+    /** The endpoint's name. */
     endpointName: string;
+    /** The endpoint's version. */
     endpointVersion: string;
+    /** The document-level prediction. */
     prediction: InvoiceV4Document;
+    /** The document's pages. */
     pages: Page<InvoiceV4Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/product/invoice/invoiceV4.js

@@ -3,11 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvoiceV4 = void 0;
 const common_1 = require("../../parsing/common");
 const invoiceV4Document_1 = require("./invoiceV4Document");
+/**
+ * Inference prediction for Invoice, API version 4.
+ */
 class InvoiceV4 extends common_1.Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
+        /** The endpoint's name. */
         this.endpointName = "invoices";
+        /** The endpoint's version. */
         this.endpointVersion = "4";
+        /** The document's pages. */
         this.pages = [];
         this.prediction = new invoiceV4Document_1.InvoiceV4Document(rawPrediction["prediction"]);
         this.pages = rawPrediction["pages"].map((page) => new common_1.Page(invoiceV4Document_1.InvoiceV4Document, page, page["id"], page["orientation"]));

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

@@ -1,7 +1,9 @@
 import { Prediction, StringDict } from "../../parsing/common";
 import { ClassificationField, Taxes, PaymentDetailsField, LocaleField, AmountField, StringField, DateField, CompanyRegistrationField } from "../../parsing/standard";
 import { InvoiceV4LineItem } from "./invoiceV4LineItem";
-/** Invoice V4 */
+/**
+ * Document data for Invoice, API version 4.
+ */
 export declare class InvoiceV4Document implements Prediction {
     /** LocaleField information. */
     locale: LocaleField;

package/src/product/invoice/invoiceV4Document.js

@@ -4,7 +4,9 @@ exports.InvoiceV4Document = void 0;
 const summaryHelper_1 = require("../../parsing/common/summaryHelper");
 const standard_1 = require("../../parsing/standard");
 const invoiceV4LineItem_1 = require("./invoiceV4LineItem");
-/** Invoice V4 */
+/**
+ * Document data for Invoice, API version 4.
+ */
 class InvoiceV4Document {
     constructor(rawPrediction, pageId) {
         /** List of Reference numbers including PO number. */

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

@@ -1,5 +1,8 @@
 import { Polygon } from "../../geometry";
 import { StringDict } from "../../parsing/common";
+/**
+ * List of line item details.
+ */
 export declare class InvoiceV4LineItem {
     #private;
     /** The product code referring to the item. */
@@ -26,6 +29,12 @@ export declare class InvoiceV4LineItem {
      */
     polygon: Polygon;
     constructor(rawPrediction: StringDict);
+    /**
+     * Output in a format suitable for inclusion in an rST table.
+     */
     toTableLine(): string;
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/product/invoice/invoiceV4LineItem.js

@@ -8,6 +8,9 @@ var _InvoiceV4LineItem_instances, _InvoiceV4LineItem_printableValues;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvoiceV4LineItem = void 0;
 const standard_1 = require("../../parsing/standard");
+/**
+ * List of line item details.
+ */
 class InvoiceV4LineItem {
     constructor(rawPrediction) {
         _InvoiceV4LineItem_instances.add(this);
@@ -51,6 +54,9 @@ class InvoiceV4LineItem {
             this.polygon = rawPrediction["polygon"];
         }
     }
+    /**
+     * Output in a format suitable for inclusion in an rST table.
+     */
     toTableLine() {
         const printable = __classPrivateFieldGet(this, _InvoiceV4LineItem_instances, "m", _InvoiceV4LineItem_printableValues).call(this);
         return ("| " +
@@ -67,6 +73,9 @@ class InvoiceV4LineItem {
             printable.description.padEnd(36) +
             " |");
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const printable = __classPrivateFieldGet(this, _InvoiceV4LineItem_instances, "m", _InvoiceV4LineItem_printableValues).call(this);
         return ("Code: " +

package/src/product/invoiceSplitter/internal.d.ts

@@ -0,0 +1,3 @@
+export { InvoiceSplitterV1 } from "./invoiceSplitterV1";
+export { InvoiceSplitterV1Document } from "./invoiceSplitterV1Document";
+export { InvoiceSplitterV1PageGroup } from "./invoiceSplitterV1PageGroup";

package/src/product/invoiceSplitter/internal.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvoiceSplitterV1PageGroup = exports.InvoiceSplitterV1Document = exports.InvoiceSplitterV1 = void 0;
+var invoiceSplitterV1_1 = require("./invoiceSplitterV1");
+Object.defineProperty(exports, "InvoiceSplitterV1", { enumerable: true, get: function () { return invoiceSplitterV1_1.InvoiceSplitterV1; } });
+var invoiceSplitterV1Document_1 = require("./invoiceSplitterV1Document");
+Object.defineProperty(exports, "InvoiceSplitterV1Document", { enumerable: true, get: function () { return invoiceSplitterV1Document_1.InvoiceSplitterV1Document; } });
+var invoiceSplitterV1PageGroup_1 = require("./invoiceSplitterV1PageGroup");
+Object.defineProperty(exports, "InvoiceSplitterV1PageGroup", { enumerable: true, get: function () { return invoiceSplitterV1PageGroup_1.InvoiceSplitterV1PageGroup; } });

package/src/product/invoiceSplitter/invoiceSplitterV1.d.ts

@@ -1,9 +1,16 @@
 import { Inference, StringDict, Page } from "../../parsing/common";
 import { InvoiceSplitterV1Document } from "./invoiceSplitterV1Document";
+/**
+ * Inference prediction for Invoice Splitter, API version 1.
+ */
 export declare class InvoiceSplitterV1 extends Inference {
+    /** The endpoint's name. */
     endpointName: string;
+    /** The endpoint's version. */
     endpointVersion: string;
+    /** The document-level prediction. */
     prediction: InvoiceSplitterV1Document;
+    /** The document's pages. */
     pages: Page<InvoiceSplitterV1Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/product/invoiceSplitter/invoiceSplitterV1.js

@@ -3,11 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvoiceSplitterV1 = void 0;
 const common_1 = require("../../parsing/common");
 const invoiceSplitterV1Document_1 = require("./invoiceSplitterV1Document");
+/**
+ * Inference prediction for Invoice Splitter, API version 1.
+ */
 class InvoiceSplitterV1 extends common_1.Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
+        /** The endpoint's name. */
         this.endpointName = "invoice_splitter";
+        /** The endpoint's version. */
         this.endpointVersion = "1";
+        /** The document's pages. */
         this.pages = [];
         this.prediction = new invoiceSplitterV1Document_1.InvoiceSplitterV1Document(rawPrediction["prediction"]);
         this.pages = rawPrediction["pages"].map((page) => new common_1.Page(invoiceSplitterV1Document_1.InvoiceSplitterV1Document, page, page["id"], page["orientation"]));

package/src/product/invoiceSplitter/invoiceSplitterV1Document.d.ts

@@ -1,8 +1,14 @@
 import { Inference, StringDict } from "../../parsing/common";
-import { PageGroup } from "./invoiceSplitterV1PageGroup";
+import { InvoiceSplitterV1PageGroup } from "./invoiceSplitterV1PageGroup";
+/**
+ * Document data for Invoice Splitter, API version 1.
+ */
 export declare class InvoiceSplitterV1Document extends Inference {
     /** List of page indexes that belong to the same invoice in the PDF. */
-    invoicePageGroups: PageGroup[];
+    invoicePageGroups: InvoiceSplitterV1PageGroup[];
     constructor(rawPrediction: StringDict);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/product/invoiceSplitter/invoiceSplitterV1Document.js

@@ -3,14 +3,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvoiceSplitterV1Document = void 0;
 const common_1 = require("../../parsing/common");
 const invoiceSplitterV1PageGroup_1 = require("./invoiceSplitterV1PageGroup");
+/**
+ * Document data for Invoice Splitter, API version 1.
+ */
 class InvoiceSplitterV1Document extends common_1.Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
         /** List of page indexes that belong to the same invoice in the PDF. */
         this.invoicePageGroups = [];
         rawPrediction["invoice_page_groups"] &&
-            rawPrediction["invoice_page_groups"].forEach((prediction) => this.invoicePageGroups.push(new invoiceSplitterV1PageGroup_1.PageGroup(prediction)));
+            rawPrediction["invoice_page_groups"].forEach((prediction) => this.invoicePageGroups.push(new invoiceSplitterV1PageGroup_1.InvoiceSplitterV1PageGroup(prediction)));
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const invoicePageGroups = this.invoicePageGroups
             .map((item) => "\n  " + item.toString())

package/src/product/invoiceSplitter/invoiceSplitterV1PageGroup.d.ts

@@ -1,7 +1,15 @@
 import { StringDict } from "../../parsing/common";
-export declare class PageGroup {
+/**
+ * Pages indexes in a group.
+ */
+export declare class InvoiceSplitterV1PageGroup {
+    /** List of page indexes. */
     pageIndexes: number[];
+    /** Confidence score. */
     confidence: number;
     constructor(prediction: StringDict);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/product/invoiceSplitter/invoiceSplitterV1PageGroup.js

@@ -1,14 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PageGroup = void 0;
-class PageGroup {
+exports.InvoiceSplitterV1PageGroup = void 0;
+/**
+ * Pages indexes in a group.
+ */
+class InvoiceSplitterV1PageGroup {
     constructor(prediction) {
+        /** List of page indexes. */
         this.pageIndexes = [];
         this.pageIndexes = prediction.page_indexes;
         this.confidence = prediction["confidence"];
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         return `:Page indexes: ${this.pageIndexes.join(", ")}`;
     }
 }
-exports.PageGroup = PageGroup;
+exports.InvoiceSplitterV1PageGroup = InvoiceSplitterV1PageGroup;

package/src/product/passport/internal.d.ts

@@ -0,0 +1,2 @@
+export { PassportV1 } from "./passportV1";
+export { PassportV1Document } from "./passportV1Document";

package/src/product/passport/internal.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PassportV1Document = exports.PassportV1 = void 0;
+var passportV1_1 = require("./passportV1");
+Object.defineProperty(exports, "PassportV1", { enumerable: true, get: function () { return passportV1_1.PassportV1; } });
+var passportV1Document_1 = require("./passportV1Document");
+Object.defineProperty(exports, "PassportV1Document", { enumerable: true, get: function () { return passportV1Document_1.PassportV1Document; } });

package/src/product/passport/passportV1.d.ts

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

package/src/product/passport/passportV1.js

@@ -3,11 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PassportV1 = void 0;
 const common_1 = require("../../parsing/common");
 const passportV1Document_1 = require("./passportV1Document");
+/**
+ * Inference prediction for Passport, API version 1.
+ */
 class PassportV1 extends common_1.Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
+        /** The endpoint's name. */
         this.endpointName = "passport";
+        /** The endpoint's version. */
         this.endpointVersion = "1";
+        /** The document's pages. */
         this.pages = [];
         this.prediction = new passportV1Document_1.PassportV1Document(rawPrediction["prediction"]);
         this.pages = rawPrediction["pages"].map((page) => new common_1.Page(passportV1Document_1.PassportV1Document, page, page["id"], page["orientation"]));

package/src/product/passport/passportV1Document.d.ts

@@ -27,5 +27,8 @@ export declare class PassportV1Document implements Prediction {
     /** The surname of the passport holder. */
     surname: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/product/passport/passportV1Document.js

@@ -56,6 +56,9 @@ class PassportV1Document {
             pageId: pageId,
         });
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const givenNames = this.givenNames.join("\n              ");
         const outStr = `:Country Code: ${this.country}

package/src/product/proofOfAddress/internal.d.ts

@@ -0,0 +1,2 @@
+export { ProofOfAddressV1 } from "./proofOfAddressV1";
+export { ProofOfAddressV1Document } from "./proofOfAddressV1Document";

package/src/product/proofOfAddress/internal.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProofOfAddressV1Document = exports.ProofOfAddressV1 = void 0;
+var proofOfAddressV1_1 = require("./proofOfAddressV1");
+Object.defineProperty(exports, "ProofOfAddressV1", { enumerable: true, get: function () { return proofOfAddressV1_1.ProofOfAddressV1; } });
+var proofOfAddressV1Document_1 = require("./proofOfAddressV1Document");
+Object.defineProperty(exports, "ProofOfAddressV1Document", { enumerable: true, get: function () { return proofOfAddressV1Document_1.ProofOfAddressV1Document; } });

package/src/product/proofOfAddress/proofOfAddressV1.d.ts

@@ -1,9 +1,16 @@
 import { Inference, StringDict, Page } from "../../parsing/common";
 import { ProofOfAddressV1Document } from "./proofOfAddressV1Document";
+/**
+ * Inference prediction for Proof of Address, API version 1.
+ */
 export declare class ProofOfAddressV1 extends Inference {
+    /** The endpoint's name. */
     endpointName: string;
+    /** The endpoint's version. */
     endpointVersion: string;
+    /** The document-level prediction. */
     prediction: ProofOfAddressV1Document;
+    /** The document's pages. */
     pages: Page<ProofOfAddressV1Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/product/proofOfAddress/proofOfAddressV1.js

@@ -3,11 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProofOfAddressV1 = void 0;
 const common_1 = require("../../parsing/common");
 const proofOfAddressV1Document_1 = require("./proofOfAddressV1Document");
+/**
+ * Inference prediction for Proof of Address, API version 1.
+ */
 class ProofOfAddressV1 extends common_1.Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
+        /** The endpoint's name. */
         this.endpointName = "proof_of_address";
+        /** The endpoint's version. */
         this.endpointVersion = "1";
+        /** The document's pages. */
         this.pages = [];
         this.prediction = new proofOfAddressV1Document_1.ProofOfAddressV1Document(rawPrediction["prediction"]);
         this.pages = rawPrediction["pages"].map((page) => new common_1.Page(proofOfAddressV1Document_1.ProofOfAddressV1Document, page, page["id"], page["orientation"]));