mindee 4.0.1 → 4.1.0

package/src/parsing/common/apiRequest.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiRequest = void 0;
+/**
+ * Holds the information relating to an API HTTP request.
+ *
+ * @category API Response
+ */
 class ApiRequest {
     constructor(serverResponse) {
         this.error = serverResponse["error"];

package/src/parsing/common/apiResponse.d.ts

@@ -1,6 +1,21 @@
 import { ApiRequest } from "./apiRequest";
 import { StringDict } from "./stringDict";
+/** Base wrapper for API requests.
+ *
+ * @category API Response
+*/
 export declare abstract class ApiResponse {
+    /** Initial request sent to the API. */
     apiRequest: ApiRequest;
+    /** Raw text representation of the API's response. */
+    private readonly rawHttp;
+    /**
+     * @param serverResponse JSON response from the server.
+     */
     constructor(serverResponse: StringDict);
+    /**
+     * Raw HTTP request sent from server, as a JSON-like structure
+     * @returns The HTTP request
+     */
+    getRawHttp(): StringDict;
 }

package/src/parsing/common/apiResponse.js

@@ -2,9 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiResponse = void 0;
 const apiRequest_1 = require("./apiRequest");
+/** Base wrapper for API requests.
+ *
+ * @category API Response
+*/
 class ApiResponse {
+    /**
+     * @param serverResponse JSON response from the server.
+     */
     constructor(serverResponse) {
         this.apiRequest = new apiRequest_1.ApiRequest(serverResponse["api_request"]);
+        this.rawHttp = serverResponse;
+    }
+    /**
+     * Raw HTTP request sent from server, as a JSON-like structure
+     * @returns The HTTP request
+     */
+    getRawHttp() {
+        return this.rawHttp;
     }
 }
 exports.ApiResponse = ApiResponse;

package/src/parsing/common/asyncPredictResponse.d.ts

@@ -2,20 +2,41 @@ import { ApiResponse } from "./apiResponse";
 import { StringDict } from "./stringDict";
 import { Inference } from "./inference";
 import { Document } from "./document";
+/** Wrapper for asynchronous request queues. Holds information regarding a job (queue).
+ *
+ * @category API Response
+ * @category Asynchronous
+*/
 export declare class Job {
+    /** Timestamp noting the enqueueing of a document. */
     issuedAt: Date;
+    /** Timestamp noting the availability of a prediction for an enqueued document. */
     availableAt?: Date;
+    /** ID of the job. */
     id: string;
+    /** Status of the job. */
     status?: "waiting" | "processing" | "completed";
-    /**
-     * The time taken to process the job, in milliseconds.
-     */
+    /** The time taken to process the job, in milliseconds. */
     milliSecsTaken?: number;
     constructor(jsonResponse: StringDict);
     protected datetimeWithTimezone(date: string): Date;
 }
+/** Wrapper for asynchronous jobs and parsing results.
+ *
+ * @category API Response
+ * @category Asynchronous
+*/
 export declare class AsyncPredictResponse<T extends Inference> extends ApiResponse {
+    /** Job for a queue. */
     job: Job;
+    /** Prediction for an asynchronous request. Will not be available so long as the job is not
+     * `completed`.
+     */
     document?: Document<T>;
+    /**
+     *
+     * @param inferenceClass constructor signature for an inference.
+     * @param httpResponse raw http response.
+     */
     constructor(inferenceClass: new (httpResponse: StringDict) => T, httpResponse: StringDict);
 }

package/src/parsing/common/asyncPredictResponse.js

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AsyncPredictResponse = exports.Job = void 0;
 const apiResponse_1 = require("./apiResponse");
 const document_1 = require("./document");
+/** Wrapper for asynchronous request queues. Holds information regarding a job (queue).
+ *
+ * @category API Response
+ * @category Asynchronous
+*/
 class Job {
     constructor(jsonResponse) {
         this.issuedAt = this.datetimeWithTimezone(jsonResponse["issued_at"]);
@@ -26,7 +31,17 @@ class Job {
     }
 }
 exports.Job = Job;
+/** Wrapper for asynchronous jobs and parsing results.
+ *
+ * @category API Response
+ * @category Asynchronous
+*/
 class AsyncPredictResponse extends apiResponse_1.ApiResponse {
+    /**
+     *
+     * @param inferenceClass constructor signature for an inference.
+     * @param httpResponse raw http response.
+     */
     constructor(inferenceClass, httpResponse) {
         super(httpResponse);
         this.job = new Job(httpResponse["job"]);

package/src/parsing/common/document.d.ts

@@ -2,12 +2,29 @@ import { Extras } from "./extras/extras";
 import { Inference } from "./inference";
 import { Ocr } from "./ocr";
 import { StringDict } from "./stringDict";
+/**
+ * Document prediction wrapper class. Holds the results of a parsed document.
+ * @typeParam T an extension of an `Inference`. Mandatory in order to properly create an inference.
+ */
 export declare class Document<T extends Inference> {
+    /** File name as sent back by the server. */
     filename: string;
+    /** Result of the base inference. */
     inference: T;
+    /** Id of the document as sent back by the server. */
     id: string;
+    /** Potential `Extras` fields sent back along the prediction. */
     extras?: Extras;
+    /** Raw-text response for `allWords` parsing. */
     ocr?: Ocr;
+    /**
+     *
+     * @param inferenceClass constructor signature for an inference.
+     * @param httpResponse raw http response.
+     */
     constructor(inferenceClass: new (httpResponse: StringDict) => T, httpResponse: StringDict);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/parsing/common/document.js

@@ -3,14 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Document = void 0;
 const cropperExtra_1 = require("./extras/cropperExtra");
 const extras_1 = require("./extras/extras");
+/**
+ * Document prediction wrapper class. Holds the results of a parsed document.
+ * @typeParam T an extension of an `Inference`. Mandatory in order to properly create an inference.
+ */
 class Document {
+    /**
+     *
+     * @param inferenceClass constructor signature for an inference.
+     * @param httpResponse raw http response.
+     */
     constructor(inferenceClass, httpResponse) {
-        this.id = httpResponse["id"] ?? "";
-        this.filename = httpResponse["name"] ?? "";
-        this.ocr = httpResponse["ocr"] ?? undefined;
+        this.id = httpResponse?.id ?? "";
+        this.filename = httpResponse?.name ?? "";
+        this.ocr = httpResponse?.ocr ?? undefined;
         this.inference = new inferenceClass(httpResponse["inference"]);
         // Note: this is a convoluted but functional way of being able to implement/use Extras fields
-        // as an extension of a Map object (like having an adapted toString() method, for instance)
+        // as an extension of a Map object (like having an adapted toString() method, for instance).
         if (httpResponse["extras"] &&
             Object.keys(httpResponse["extras"].length > 0)) {
             const extras = {};
@@ -23,6 +32,9 @@ class Document {
             this.extras = new extras_1.Extras(extras);
         }
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         return `########\nDocument\n########
 :Mindee ID: ${this.id}

package/src/parsing/common/extras/cropperExtra.d.ts

@@ -4,5 +4,8 @@ import { ExtraField } from "./extras";
 export declare class CropperExtra extends ExtraField {
     cropping: PositionField[];
     constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/parsing/common/extras/cropperExtra.js

@@ -16,6 +16,9 @@ class CropperExtra extends extras_1.ExtraField {
                 }));
             });
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const cropping = this.cropping
             .map((crop) => crop.toString())

package/src/parsing/common/extras/extras.d.ts

@@ -6,6 +6,9 @@ interface ExtraDict<T extends ExtraField> {
 export declare class Extras<ExtraT extends ExtraField = ExtraField> implements ExtraDict<ExtraT> {
     [key: string]: ExtraT | (() => string);
     constructor(fields: Record<string, ExtraT>);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }
 export {};

package/src/parsing/common/extras/extras.js

@@ -9,6 +9,9 @@ class Extras {
         Object.keys(fields).length > 0 &&
             Object.keys(fields).forEach((name) => (this[name] = fields[name]));
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         return (Object.entries(this)
             .map(([name, extraField]) => name + ":\n" + extraField.toString())

package/src/parsing/common/inference.d.ts

@@ -3,18 +3,44 @@ import { ExtraField } from "./extras/extras";
 import { Page } from "./page";
 import type { Prediction } from "./prediction";
 import { Product } from "./product";
+/**
+ *
+ * @typeParam DocT an extension of a `Prediction`. Is generic by default to
+ * allow for easier optional `PageT` generic typing.
+ * @typeParam PageT an extension of a `DocT` (`Prediction`). Should only be set
+ * if a document's pages have specific implementation.
+ */
 export declare abstract class Inference<DocT extends Prediction = Prediction, PageT extends DocT = DocT> {
+    /** A boolean denoting whether a given inference result was rotated. */
     isRotationApplied?: boolean;
+    /** Name and version of a given product. */
     product: Product;
+    /** Wrapper for a document's pages prediction. */
     pages: Page<PageT>[];
+    /** A document's top-level `Prediction`. */
     prediction: DocT;
+    /** Extraneous fields relating to specific tools for some APIs. */
     extras?: ExtraField[];
+    /** Name of a document's endpoint. Has a default value for OTS APIs. */
     endpointName?: string;
+    /** A document's version. Has a default value for OTS APIs. */
     endpointVersion?: string;
     constructor(rawPrediction: StringDict);
+    /**
+     * Default string representation.
+     */
     toString(): string;
+    /**
+     * Takes in an input string and replaces line breaks with `\n`.
+     * @param outStr string to cleanup
+     * @returns cleaned out string
+     */
     static cleanOutString(outStr: string): string;
 }
+/**
+ * Factory to allow for static-like property access syntax in TypeScript.
+ * Used to retrieve endpoint data for standard products.
+ */
 export declare class InferenceFactory {
     /**
      * Builds a blank product of the given type & sends back the endpointName & endpointVersion parameters of OTS classes.

package/src/parsing/common/inference.js

@@ -1,13 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InferenceFactory = exports.Inference = void 0;
+/**
+ *
+ * @typeParam DocT an extension of a `Prediction`. Is generic by default to
+ * allow for easier optional `PageT` generic typing.
+ * @typeParam PageT an extension of a `DocT` (`Prediction`). Should only be set
+ * if a document's pages have specific implementation.
+ */
 class Inference {
     constructor(rawPrediction) {
+        /** Wrapper for a document's pages prediction. */
         this.pages = [];
+        /** Extraneous fields relating to specific tools for some APIs. */
         this.extras = [];
-        this.isRotationApplied = rawPrediction["is_rotation_applied"] ?? undefined;
-        this.product = rawPrediction["product"];
+        this.isRotationApplied = rawPrediction?.is_rotation_applied ?? undefined;
+        this.product = rawPrediction?.product;
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         return `Inference
 #########
@@ -23,12 +35,21 @@ Page Predictions
 
 ${this.pages.map((e) => e.toString() || "").join("\n")}`;
     }
+    /**
+     * Takes in an input string and replaces line breaks with `\n`.
+     * @param outStr string to cleanup
+     * @returns cleaned out string
+     */
     static cleanOutString(outStr) {
         const lines = / \n/gm;
         return outStr.replace(lines, "\n");
     }
 }
 exports.Inference = Inference;
+/**
+ * Factory to allow for static-like property access syntax in TypeScript.
+ * Used to retrieve endpoint data for standard products.
+ */
 class InferenceFactory {
     /**
      * Builds a blank product of the given type & sends back the endpointName & endpointVersion parameters of OTS classes.

package/src/parsing/common/mvisionV1.d.ts

@@ -4,5 +4,8 @@ export declare class MvisionV1 {
     /** List of words found on the page. */
     pages: OcrPage[];
     constructor(rawPrediction: StringDict);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/parsing/common/mvisionV1.js

@@ -10,6 +10,9 @@ class MvisionV1 {
             this.pages.push(new ocrPage_1.OcrPage(page));
         });
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         return this.pages.map((page) => page.toString()).join("\n") + "\n";
     }

package/src/parsing/common/ocr.d.ts

@@ -4,5 +4,8 @@ export declare class Ocr {
     /** Default Mindee OCR */
     mVisionV1: MvisionV1;
     constructor(rawPrediction: StringDict);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/parsing/common/ocr.js

@@ -6,6 +6,9 @@ class Ocr {
     constructor(rawPrediction) {
         this.mVisionV1 = new mvisionV1_1.MvisionV1(rawPrediction["mvision-v1"]);
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         return this.mVisionV1.toString();
     }

package/src/parsing/common/ocrPage.d.ts

@@ -12,5 +12,8 @@ export declare class OcrPage {
      * @returns Sorted lines on the pages
      */
     getAllLines(): Word[][];
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/parsing/common/ocrPage.js

@@ -32,6 +32,9 @@ class OcrPage {
         }
         return this.allLines;
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         return this.getAllLines()
             .map((line) => line.map((word) => word.text).join(" "))

package/src/parsing/common/orientation.d.ts

@@ -17,6 +17,9 @@ export declare class OrientationField extends BaseField {
      * @param {Integer} pageId - Page ID for multi-page document
      */
     constructor({ prediction, valueKey, reconstructed, pageId, }: OrientationFieldConstructor);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }
 export {};

package/src/parsing/common/orientation.js

@@ -20,6 +20,9 @@ class OrientationField extends standard_1.BaseField {
         if (!orientations.includes(this.value))
             this.value = 0;
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         return `${this.value} degrees`;
     }

package/src/parsing/common/page.d.ts

@@ -2,11 +2,30 @@ import { Extras } from "./extras/extras";
 import { OrientationField } from "./orientation";
 import { Prediction } from "./prediction";
 import { StringDict } from "./stringDict";
+/**
+ * Page prediction wrapper class. Holds the results of a parsed document's page.
+ * Holds a `Prediction` that's either a document-level Prediction, or inherits from one.
+ * @typeParam T an extension of an `Prediction`. Mandatory in order to properly create a page-level prediction.
+ */
 export declare class Page<T extends Prediction> {
+    /** The page's index (identifier). */
     id: number;
+    /** The page's orientation */
     orientation?: OrientationField;
+    /** A page-level prediction. Can either be specific to pages or identical to the document prediction. */
     prediction: T;
+    /** Potential `Extras` fields sent back along with the prediction. */
     extras?: Extras;
+    /**
+     *
+     * @param inferenceClass constructor signature for an inference.
+     * @param httpResponse raw http response.
+     * @param pageId the page's index (identifier).
+     * @param orientation the page's orientation.
+     */
     constructor(predictionType: new (rawPrediction: StringDict, pageId: number) => T, rawPrediction: StringDict, pageId: number, orientation?: StringDict);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/parsing/common/page.js

@@ -4,7 +4,19 @@ exports.Page = void 0;
 const cropperExtra_1 = require("./extras/cropperExtra");
 const extras_1 = require("./extras/extras");
 const orientation_1 = require("./orientation");
+/**
+ * Page prediction wrapper class. Holds the results of a parsed document's page.
+ * Holds a `Prediction` that's either a document-level Prediction, or inherits from one.
+ * @typeParam T an extension of an `Prediction`. Mandatory in order to properly create a page-level prediction.
+ */
 class Page {
+    /**
+     *
+     * @param inferenceClass constructor signature for an inference.
+     * @param httpResponse raw http response.
+     * @param pageId the page's index (identifier).
+     * @param orientation the page's orientation.
+     */
     constructor(predictionType, rawPrediction, pageId, orientation) {
         if (pageId !== undefined && orientation !== undefined) {
             this.orientation = new orientation_1.OrientationField({
@@ -29,6 +41,9 @@ class Page {
             this.extras = new extras_1.Extras(extras);
         }
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const title = `Page ${this.id}`;
         return `${title}

package/src/parsing/common/predictResponse.d.ts

@@ -1,6 +1,17 @@
 import { ApiResponse } from "./apiResponse";
 import { Document, Inference, StringDict } from ".";
+/** Wrapper for synchronous prediction response.
+ *
+ * @category API Response
+ * @category Synchronous
+*/
 export declare class PredictResponse<T extends Inference> extends ApiResponse {
+    /** A document prediction response. */
     document: Document<T>;
+    /**
+     *
+     * @param inferenceClass constructor signature for an inference.
+     * @param rawPrediction raw http response.
+     */
     constructor(inferenceClass: new (rawPrediction: StringDict) => T, rawPrediction: StringDict);
 }

package/src/parsing/common/predictResponse.js

@@ -3,7 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PredictResponse = void 0;
 const apiResponse_1 = require("./apiResponse");
 const _1 = require(".");
+/** Wrapper for synchronous prediction response.
+ *
+ * @category API Response
+ * @category Synchronous
+*/
 class PredictResponse extends apiResponse_1.ApiResponse {
+    /**
+     *
+     * @param inferenceClass constructor signature for an inference.
+     * @param rawPrediction raw http response.
+     */
     constructor(inferenceClass, rawPrediction) {
         super(rawPrediction);
         this.document = new _1.Document(inferenceClass, rawPrediction["document"]);

package/src/parsing/custom/classificationField.d.ts

@@ -12,5 +12,8 @@ export declare class ClassificationField {
         prediction: StringDict;
         pageId?: number;
     });
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/parsing/custom/classificationField.js

@@ -7,6 +7,9 @@ class ClassificationField {
         this.confidence = prediction["confidence"];
         this.pageId ?? (this.pageId = pageId);
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         return `${this.value}`;
     }

package/src/parsing/custom/listField.d.ts

@@ -20,6 +20,9 @@ export declare class ListFieldValue {
      */
     polygon: Polygon;
     constructor(prediction: StringDict);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }
 export declare class ListField {
@@ -32,5 +35,8 @@ export declare class ListField {
     constructor({ prediction, reconstructed, pageId, }: FieldConstructor);
     contentsList(): Array<string | number>;
     contentsString(separator?: string): string;
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/parsing/custom/listField.js

@@ -21,6 +21,9 @@ class ListFieldValue {
             this.bbox = (0, geometry_1.getBoundingBox)(prediction["polygon"]);
         }
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         return `${this.content}`;
     }
@@ -44,6 +47,9 @@ class ListField {
     contentsString(separator = " ") {
         return this.values.map((item) => `${item.content}`).join(separator);
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         return this.contentsString();
     }

package/src/parsing/standard/amount.d.ts

@@ -13,5 +13,8 @@ export declare class AmountField extends Field {
      * @param {Integer} pageId - Page ID for multi-page document
      */
     constructor({ prediction, valueKey, reconstructed, pageId, }: FieldConstructor);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/parsing/standard/amount.js

@@ -30,6 +30,9 @@ class AmountField extends field_1.Field {
             this.confidence = 0.0;
         }
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         if (this.value !== undefined) {
             return floatToString(this.value);

package/src/parsing/standard/base.d.ts

@@ -26,5 +26,8 @@ export declare class BaseField {
      * @returns {Number} Sum of all the Fields values in the array
      */
     static arraySum(array: BaseField[]): number;
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/parsing/standard/base.js

@@ -47,6 +47,9 @@ class BaseField {
         }
         return total;
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         if (this.value !== undefined) {
             return `${this.value}`;

package/src/parsing/standard/locale.d.ts

@@ -19,5 +19,8 @@ export declare class LocaleField extends BaseField {
      * @param {boolean} reconstructed - Is the object reconstructed (not extracted by the API)
      */
     constructor({ prediction, reconstructed, pageId, }: BaseFieldConstructor);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/parsing/standard/locale.js

@@ -22,6 +22,9 @@ class LocaleField extends base_1.BaseField {
         this.currency =
             prediction["currency"] !== undefined ? prediction["currency"] : undefined;
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         let outStr = "";
         if (this.value) {

package/src/parsing/standard/paymentDetails.d.ts

@@ -36,6 +36,9 @@ export declare class PaymentDetailsField extends Field {
      * @param {Integer} pageId - Page ID for multi-page document
      */
     constructor({ prediction, valueKey, accountNumberKey, ibanKey, routingNumberKey, swiftKey, reconstructed, pageId, }: PaymentDetailsConstructor);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }
 export {};