mindee 3.4.0 → 3.4.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## v3.4.1 - 2023-01-05
+### Changes
+* :label: Added typing information, get rid of `any` type in various places
+* :recycle: Use a specific `TextField` class for fields we know are textual
+* :arrow_up: update dependencies
+
+### Fixes
+* :bug: Expose various class and type definitions to improve developer experience
+
 ## v3.4.0 - 2023-01-04
 ### Changes
 * :sparkles: Support Receipt V4.1

package/README.md

@@ -1,3 +1,8 @@
+[![License: MIT](https://img.shields.io/github/license/mindee/mindee-api-nodejs)](https://opensource.org/licenses/MIT)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mindee/mindee-api-nodejs/test.yml)](https://github.com/mindee/mindee-api-nodejs)
+[![NPM Version](https://img.shields.io/npm/v/mindee)](https://www.npmjs.com/package/mindee)
+[![Downloads](https://img.shields.io/npm/dm/mindee)](https://www.npmjs.com/package/mindee)
+
 # Mindee API Helper Library for Node.js
 Quickly and easily connect to Mindee's API services using Node.js.
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "3.4.0",
+    "version": "3.4.1",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",
@@ -38,27 +38,27 @@
     },
     "homepage": "https://mindee.com/",
     "devDependencies": {
-        "@types/chai": "^4.3.1",
+        "@types/chai": "^4.3.4",
         "@types/mocha": "^9.1.1",
-        "@types/node": "^17.0.38",
-        "@typescript-eslint/eslint-plugin": "^5.30.0",
-        "@typescript-eslint/parser": "^5.30.0",
-        "chai": "^4.3.6",
-        "eslint": "^8.18.0",
-        "eslint-config-prettier": "^8.5.0",
-        "eslint-plugin-prettier": "^4.1.0",
-        "jsdoc": "^3.6.10",
-        "mocha": "^10.0.0",
-        "prettier": "^2.7.1",
-        "ts-node": "^10.8.1",
-        "typescript": "^4.7.4"
+        "@types/node": "^18.11.18",
+        "@typescript-eslint/eslint-plugin": "^5.48.0",
+        "@typescript-eslint/parser": "^5.48.0",
+        "chai": "^4.3.7",
+        "eslint": "^8.31.0",
+        "eslint-config-prettier": "^8.6.0",
+        "eslint-plugin-prettier": "^4.2.1",
+        "jsdoc": "^3.6.11",
+        "mocha": "^10.1.0",
+        "prettier": "^2.8.1",
+        "ts-node": "^10.9.1",
+        "typescript": "^4.9.4"
     },
     "dependencies": {
-        "commander": "^9.4.0",
-        "file-type": "^16.5.4",
-        "form-data": "^3.0.1",
-        "mrz": "^3.1.4",
-        "pdf-lib": "^1.17.1"
+        "commander": "~9.4.1",
+        "file-type": "~16.5.4",
+        "form-data": "~3.0.1",
+        "mrz": "~3.2.1",
+        "pdf-lib": "~1.17.1"
     },
     "keywords": [
         "typescript",

package/src/api/index.d.ts

@@ -1,2 +1,2 @@
-export { Response } from "./response";
+export { Response, ResponseSig } from "./response";
 export { Endpoint, CustomEndpoint, StandardEndpoint, predictResponse, STANDARD_API_OWNER, API_KEY_ENVVAR_NAME, } from "./endpoint";

package/src/api/response.d.ts

@@ -7,6 +7,9 @@ export interface ResponseProps {
     input: InputSource;
     error: boolean;
 }
+export type ResponseSig<DocType extends Document> = {
+    new (documentClass: DocumentSig<DocType>, params: ResponseProps): Response<DocType>;
+};
 /**
  * Base class for all responses.
  */

package/src/client.d.ts

@@ -1,10 +1,10 @@
 /// <reference types="node" />
 /// <reference types="node" />
+import { Readable } from "stream";
 import { InputSource, PageOptions } from "./inputs";
 import { Response } from "./api";
 import { Document, DocumentSig } from "./documents";
 import { DocumentConfig } from "./documents/documentConfig";
-import { ReadStream } from "fs";
 type DocConfigs = Map<string[], DocumentConfig<any>>;
 export interface PredictOptions {
     /**
@@ -100,11 +100,11 @@ export declare class Client {
      */
     docFromBase64(inputString: string, filename: string): DocumentClient;
     /**
-     * Load an input document from a `ReadStream`.
+     * Load an input document from a `stream.Readable` object.
      * @param inputStream
      * @param filename
      */
-    docFromStream(inputStream: ReadStream, filename: string): DocumentClient;
+    docFromStream(inputStream: Readable, filename: string): DocumentClient;
     /**
      * Load an input document from a bytes string.
      * @param inputBytes

package/src/client.js

@@ -155,7 +155,7 @@ class Client {
         return new DocumentClient(doc, this.docConfigs);
     }
     /**
-     * Load an input document from a `ReadStream`.
+     * Load an input document from a `stream.Readable` object.
      * @param inputStream
      * @param filename
      */

package/src/documents/{custom.d.ts → custom/customV1.d.ts}

@@ -1,10 +1,10 @@
-import { Document, DocumentConstructorProps } from "./document";
-import { ClassificationField, ListField } from "../fields";
-import { stringDict } from "../fields";
+import { Document, DocumentConstructorProps } from "../document";
+import { ClassificationField, ListField } from "./fields";
+import { StringDict } from "../../fields";
 export declare class CustomV1 extends Document {
     fields: Map<string, ListField>;
     classifications: Map<string, ClassificationField>;
     constructor({ inputSource, prediction, extras, orientation, pageId, documentType, }: DocumentConstructorProps);
-    protected setField(fieldName: string, apiPrediction: stringDict, pageId: number | undefined): void;
+    protected setField(fieldName: string, apiPrediction: StringDict, pageId: number | undefined): void;
     toString(): string;
 }

package/src/documents/{custom.js → custom/customV1.js}

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomV1 = void 0;
-const document_1 = require("./document");
-const fields_1 = require("../fields");
+const document_1 = require("../document");
+const fields_1 = require("./fields");
 class CustomV1 extends document_1.Document {
     constructor({ inputSource, prediction, extras = undefined, orientation = undefined, pageId, documentType, }) {
         super({

package/src/{fields/apiBuilder.d.ts → documents/custom/fields.d.ts}

@@ -1,5 +1,6 @@
-import { FieldConstructor, stringDict } from "./field";
-import { Polygon } from "../geometry";
+import { StringDict } from "../../fields/base";
+import { FieldConstructor } from "../../fields/field";
+import { Polygon } from "../../geometry";
 export declare class ClassificationField {
     /** The value for the classification. */
     value: string;
@@ -9,12 +10,13 @@ export declare class ClassificationField {
      */
     confidence: number;
     constructor({ prediction }: {
-        prediction: stringDict;
+        prediction: StringDict;
     });
     toString(): string;
 }
 export declare class ListFieldValue {
-    content: any;
+    /** Extracted content of the prediction */
+    content: string | number;
     /**
      * The confidence score of the prediction.
      * Note: Score is calculated on **word selection**, not its textual content (OCR).
@@ -30,7 +32,7 @@ export declare class ListFieldValue {
      * the word in the document.
      */
     polygon: Polygon;
-    constructor(prediction: stringDict);
+    constructor(prediction: StringDict);
     toString(): string;
 }
 export declare class ListField {
@@ -41,7 +43,7 @@ export declare class ListField {
     /** The document page on which the information was found. */
     pageId: number;
     constructor({ prediction, reconstructed, pageId }: FieldConstructor);
-    contentsList(): Array<any>;
+    contentsList(): Array<string | number>;
     contentsString(separator?: string): string;
     toString(): string;
 }

package/src/{fields/apiBuilder.js → documents/custom/fields.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ListField = exports.ListFieldValue = exports.ClassificationField = void 0;
-const geometry_1 = require("../geometry");
+const geometry_1 = require("../../geometry");
 class ClassificationField {
     constructor({ prediction }) {
         this.value = prediction["value"];

package/src/documents/document.d.ts

@@ -1,17 +1,17 @@
 import { InputSource } from "../inputs";
-import { PositionField, FullText, OrientationField, stringDict } from "../fields";
+import { PositionField, FullText, OrientationField, StringDict } from "../fields";
 export type DocumentSig<DocType extends Document> = {
     new ({ prediction, orientation, extras, inputSource, pageId, fullText, documentType, }: DocumentConstructorProps): DocType;
 };
 export interface DocumentConstructorProps extends BaseDocumentConstructorProps {
     /** JSON parsed prediction from HTTP response */
-    prediction: stringDict;
+    prediction: StringDict;
 }
 interface BaseDocumentConstructorProps {
     /** Orientation JSON for page-level document */
-    orientation?: stringDict;
+    orientation?: StringDict;
     /** Extras JSON */
-    extras?: stringDict;
+    extras?: StringDict;
     /** input file given to parse the document */
     inputSource?: InputSource;
     /** Page ID for page-level document */

package/src/documents/eu/licensePlate/licensePlateV1.d.ts

@@ -1,8 +1,8 @@
 import { Document, DocumentConstructorProps } from "../../document";
-import { Field } from "../../../fields";
+import { TextField } from "../../../fields";
 export declare class LicensePlateV1 extends Document {
     /** A list of license plates values. */
-    licensePlates: Field[];
+    licensePlates: TextField[];
     constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
     toString(): string;
 }

package/src/documents/eu/licensePlate/licensePlateV1.js

@@ -13,7 +13,7 @@ class LicensePlateV1 extends document_1.Document {
         });
         /** A list of license plates values. */
         this.licensePlates = [];
-        prediction.license_plates.map((prediction) => this.licensePlates.push(new fields_1.Field({
+        prediction.license_plates.map((prediction) => this.licensePlates.push(new fields_1.TextField({
             prediction: prediction,
             pageId: pageId,
         })));

package/src/documents/financialDocument/financialDocumentV1.d.ts

@@ -1,5 +1,5 @@
 import { Document, DocumentConstructorProps } from "../document";
-import { TaxField, Field, Amount, Locale, DateField as Date, CompanyRegistration } from "../../fields";
+import { TaxField, TextField, Amount, Locale, DateField as Date, CompanyRegistration } from "../../fields";
 export declare class FinancialDocumentV1 extends Document {
     #private;
     pageId: number | undefined;
@@ -7,18 +7,18 @@ export declare class FinancialDocumentV1 extends Document {
     totalIncl: Amount;
     date: Date;
     dueDate: Date;
-    category: Field;
-    time: Field;
+    category: TextField;
+    time: TextField;
     taxes: TaxField[];
     totalTax: Amount;
     totalExcl: Amount;
-    supplier: Field;
-    supplierAddress: Field;
-    invoiceNumber: Field;
+    supplier: TextField;
+    supplierAddress: TextField;
+    invoiceNumber: TextField;
     companyRegistration: CompanyRegistration[];
-    customerName: Field;
-    customerAddress: Field;
-    paymentDetails: Field[];
+    customerName: TextField;
+    customerAddress: TextField;
+    paymentDetails: TextField[];
     customerCompanyRegistration: CompanyRegistration[];
     constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
     toString(): string;

package/src/documents/financialDocument/financialDocumentV1.js

@@ -63,7 +63,7 @@ _FinancialDocumentV1_instances = new WeakSet(), _FinancialDocumentV1_initFromApi
         this.companyRegistration = invoice.customerCompanyRegistration;
         this.orientation = invoice.orientation;
         this.totalTax = invoice.totalTax;
-        this.time = new fields_1.Field({
+        this.time = new fields_1.TextField({
             prediction: { value: undefined, confidence: 0.0 },
         });
         this.customerName = invoice.customerName;
@@ -86,18 +86,18 @@ _FinancialDocumentV1_instances = new WeakSet(), _FinancialDocumentV1_initFromApi
         this.totalIncl = receipt.totalIncl;
         this.totalExcl = receipt.totalExcl;
         this.supplier = receipt.merchantName;
-        this.supplierAddress = new fields_1.Field({
+        this.supplierAddress = new fields_1.TextField({
             prediction: { value: undefined, confidence: 0.0 },
         });
         this.time = receipt.time;
         this.totalTax = receipt.totalTax;
-        this.invoiceNumber = new fields_1.Field({
+        this.invoiceNumber = new fields_1.TextField({
             prediction: { value: undefined, confidence: 0.0 },
         });
-        this.customerName = new fields_1.Field({
+        this.customerName = new fields_1.TextField({
             prediction: { value: undefined, confidence: 0.0 },
         });
-        this.customerAddress = new fields_1.Field({
+        this.customerAddress = new fields_1.TextField({
             prediction: { value: undefined, confidence: 0.0 },
         });
     }

package/src/documents/fr/bankAccountDetails/bankAccountDetailsV1.d.ts

@@ -1,12 +1,12 @@
 import { Document, DocumentConstructorProps } from "../../document";
-import { Field } from "../../../fields";
+import { TextField } from "../../../fields";
 export declare class BankAccountDetailsV1 extends Document {
     /** The IBAN number. */
-    iban: Field;
+    iban: TextField;
     /** The account holder name. */
-    accountHolderName: Field;
+    accountHolderName: TextField;
     /** The SWIFT value. */
-    swift: Field;
+    swift: TextField;
     constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
     toString(): string;
 }

package/src/documents/fr/bankAccountDetails/bankAccountDetailsV1.js

@@ -11,15 +11,15 @@ class BankAccountDetailsV1 extends document_1.Document {
             orientation: orientation,
             extras: extras,
         });
-        this.iban = new fields_1.Field({
+        this.iban = new fields_1.TextField({
             prediction: prediction.iban,
             pageId: pageId,
         });
-        this.accountHolderName = new fields_1.Field({
+        this.accountHolderName = new fields_1.TextField({
             prediction: prediction.account_holder_name,
             pageId: pageId,
         });
-        this.swift = new fields_1.Field({
+        this.swift = new fields_1.TextField({
             prediction: prediction.swift,
             pageId: pageId,
         });

package/src/documents/fr/carteVitale/carteVitaleV1.d.ts

@@ -1,12 +1,12 @@
 import { Document, DocumentConstructorProps } from "../../document";
-import { Field, DateField } from "../../../fields";
+import { TextField, DateField } from "../../../fields";
 export declare class CarteVitaleV1 extends Document {
     /** The list of the names of the person. */
-    givenNames: Field[];
+    givenNames: TextField[];
     /** The surname of the person. */
-    surname: Field;
+    surname: TextField;
     /** The ID number of the card. */
-    idNumber: Field;
+    idNumber: TextField;
     /** The issuance date of the card. */
     issuanceDate: DateField;
     constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);

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

@@ -13,7 +13,7 @@ class CarteVitaleV1 extends document_1.Document {
         });
         /** The list of the names of the person. */
         this.givenNames = [];
-        this.idNumber = new fields_1.Field({
+        this.idNumber = new fields_1.TextField({
             prediction: prediction.social_security,
             pageId: pageId,
         });
@@ -21,11 +21,11 @@ class CarteVitaleV1 extends document_1.Document {
             prediction: prediction.issuance_date,
             pageId: pageId,
         });
-        this.surname = new fields_1.Field({
+        this.surname = new fields_1.TextField({
             prediction: prediction.surname,
             pageId: pageId,
         });
-        prediction.given_names.map((prediction) => this.givenNames.push(new fields_1.Field({
+        prediction.given_names.map((prediction) => this.givenNames.push(new fields_1.TextField({
             prediction: prediction,
             pageId: pageId,
         })));

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

@@ -1,28 +1,28 @@
 import { Document, DocumentConstructorProps } from "../../document";
-import { Field, DateField, BaseField } from "../../../fields";
+import { TextField, DateField, BaseField } from "../../../fields";
 export declare class IdCardV1 extends Document {
     /** The authority which has issued the card. */
-    authority: Field;
+    authority: TextField;
     /** Indicates if it is the recto, the verso or the both of it. */
     documentSide: BaseField;
     /** The id number of the card. */
-    idNumber: Field;
+    idNumber: TextField;
     /** The birth date of the person. */
     birthDate: DateField;
     /** The expiry date of the card. */
     expiryDate: DateField;
     /** The birth place of the person. */
-    birthPlace: Field;
+    birthPlace: TextField;
     /** The gender of the person. */
-    gender: Field;
+    gender: TextField;
     /** The first mrz value. */
-    mrz1: Field;
+    mrz1: TextField;
     /** The second mrz value. */
-    mrz2: Field;
+    mrz2: TextField;
     /** The surname of the person. */
-    surname: Field;
+    surname: TextField;
     /** The list of the names of the person. */
-    givenNames: Field[];
+    givenNames: TextField[];
     constructor({ prediction, orientation, extras, inputSource, pageId, }: DocumentConstructorProps);
     toString(): string;
 }

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

@@ -13,14 +13,14 @@ class IdCardV1 extends document_1.Document {
         });
         /** The list of the names of the person. */
         this.givenNames = [];
-        this.authority = new fields_1.Field({
+        this.authority = new fields_1.TextField({
             prediction: prediction.authority,
             pageId: pageId,
         });
         this.documentSide = new fields_1.BaseField({
             prediction: prediction.document_side,
         });
-        this.idNumber = new fields_1.Field({
+        this.idNumber = new fields_1.TextField({
             prediction: prediction.id_number,
             pageId: pageId,
         });
@@ -32,27 +32,27 @@ class IdCardV1 extends document_1.Document {
             prediction: prediction.expiry_date,
             pageId: pageId,
         });
-        this.birthPlace = new fields_1.Field({
+        this.birthPlace = new fields_1.TextField({
             prediction: prediction.birth_place,
             pageId: pageId,
         });
-        this.gender = new fields_1.Field({
+        this.gender = new fields_1.TextField({
             prediction: prediction.gender,
             pageId: pageId,
         });
-        this.surname = new fields_1.Field({
+        this.surname = new fields_1.TextField({
             prediction: prediction.surname,
             pageId: pageId,
         });
-        this.mrz1 = new fields_1.Field({
+        this.mrz1 = new fields_1.TextField({
             prediction: prediction.mrz1,
             pageId: pageId,
         });
-        this.mrz2 = new fields_1.Field({
+        this.mrz2 = new fields_1.TextField({
             prediction: prediction.mrz2,
             pageId: pageId,
         });
-        prediction.given_names.map((prediction) => this.givenNames.push(new fields_1.Field({
+        prediction.given_names.map((prediction) => this.givenNames.push(new fields_1.TextField({
             prediction: prediction,
             pageId: pageId,
         })));

package/src/documents/index.d.ts

@@ -4,7 +4,7 @@ export { ReceiptV3 } from "./receipt/receiptV3";
 export { ReceiptV4 } from "./receipt/receiptV4";
 export { PassportV1 } from "./passport/passportV1";
 export { FinancialDocumentV1 } from "./financialDocument/financialDocumentV1";
-export { CustomV1 } from "./custom";
+export { CustomV1 } from "./custom/customV1";
 export { CropperV1 } from "./cropper/cropperV1";
 export { ShippingContainerV1 } from "./shipping_container/shippingContainerV1";
 export { Document, DocumentConstructorProps, DocumentSig } from "./document";

package/src/documents/index.js

@@ -36,8 +36,8 @@ var passportV1_1 = require("./passport/passportV1");
 Object.defineProperty(exports, "PassportV1", { enumerable: true, get: function () { return passportV1_1.PassportV1; } });
 var financialDocumentV1_1 = require("./financialDocument/financialDocumentV1");
 Object.defineProperty(exports, "FinancialDocumentV1", { enumerable: true, get: function () { return financialDocumentV1_1.FinancialDocumentV1; } });
-var custom_1 = require("./custom");
-Object.defineProperty(exports, "CustomV1", { enumerable: true, get: function () { return custom_1.CustomV1; } });
+var customV1_1 = require("./custom/customV1");
+Object.defineProperty(exports, "CustomV1", { enumerable: true, get: function () { return customV1_1.CustomV1; } });
 var cropperV1_1 = require("./cropper/cropperV1");
 Object.defineProperty(exports, "CropperV1", { enumerable: true, get: function () { return cropperV1_1.CropperV1; } });
 var shippingContainerV1_1 = require("./shipping_container/shippingContainerV1");

package/src/documents/invoice/invoiceLineItem.d.ts

@@ -1,4 +1,4 @@
-import { stringDict } from "../../fields";
+import { StringDict } from "../../fields";
 import { Polygon } from "../../geometry";
 export declare class InvoiceLineItem {
     /** The product code referring to the item. */
@@ -24,6 +24,6 @@ export declare class InvoiceLineItem {
      * the field in the document.
      */
     polygon: Polygon;
-    constructor({ prediction }: stringDict);
+    constructor({ prediction }: StringDict);
     toString(): string;
 }

package/src/documents/invoice/invoiceV3.d.ts

@@ -1,5 +1,5 @@
 import { Document, DocumentConstructorProps } from "../document";
-import { BaseField, TaxField, PaymentDetails, Locale, Amount, Field, DateField, CompanyRegistration } from "../../fields";
+import { BaseField, TaxField, PaymentDetails, Locale, Amount, TextField, DateField, CompanyRegistration } from "../../fields";
 export declare class InvoiceV3 extends Document {
     #private;
     /** Total amount with the tax amount of the purchase. */
@@ -13,23 +13,23 @@ export declare class InvoiceV3 extends Document {
     /** The due date of the invoice. */
     dueDate: DateField;
     /** The created time of the invoice */
-    time: Field;
+    time: TextField;
     /** The total tax. */
     totalTax: Amount;
     /** The total amount without the tax value. Same as totalExcl. */
     totalNet: Amount;
     /** The supplier name. */
-    supplier: Field;
+    supplier: TextField;
     /** The supplier address. */
-    supplierAddress: Field;
+    supplierAddress: TextField;
     /** The invoice number. */
-    invoiceNumber: Field;
+    invoiceNumber: TextField;
     /** The company regitration information. */
     companyRegistration: CompanyRegistration[];
     /** The name of the customer. */
-    customerName: Field;
+    customerName: TextField;
     /** The address of the customer. */
-    customerAddress: Field;
+    customerAddress: TextField;
     /** The list of the taxes. */
     taxes: TaxField[];
     /** The payment information. */

package/src/documents/invoice/invoiceV3.js

@@ -129,23 +129,23 @@ _InvoiceV3_instances = new WeakSet(), _InvoiceV3_initFromApiPrediction = functio
         prediction: apiPrediction.due_date,
         pageId: pageId,
     });
-    this.invoiceNumber = new fields_1.Field({
+    this.invoiceNumber = new fields_1.TextField({
         prediction: apiPrediction.invoice_number,
         pageId: pageId,
     });
-    this.supplier = new fields_1.Field({
+    this.supplier = new fields_1.TextField({
         prediction: apiPrediction.supplier,
         pageId: pageId,
     });
-    this.supplierAddress = new fields_1.Field({
+    this.supplierAddress = new fields_1.TextField({
         prediction: apiPrediction.supplier_address,
         pageId: pageId,
     });
-    this.customerName = new fields_1.Field({
+    this.customerName = new fields_1.TextField({
         prediction: apiPrediction.customer,
         pageId: pageId,
     });
-    this.customerAddress = new fields_1.Field({
+    this.customerAddress = new fields_1.TextField({
         prediction: apiPrediction.customer_address,
         pageId: pageId,
     });