mindee 5.8.0 → 5.10.0

package/src/v1/extraction/invoiceSplitterExtractor/invoiceSplitterExtractor.js

@@ -1,6 +1,6 @@
 import { MindeeError, MindeeInputSourceError } from "../../../errors/index.js";
-import { InvoiceSplitterV1 } from "../../../v1/product/index.js";
-import { ExtractedInvoiceSplitterImage } from "../../../v1/extraction/index.js";
+import { InvoiceSplitterV1 } from "../../product/index.js";
+import { ExtractedInvoiceSplitterImage } from "../index.js";
 import { loadOptionalDependency } from "../../../dependency/index.js";
 let pdfLib = null;
 /**
@@ -20,13 +20,13 @@ async function getPdfLib() {
  * @returns Extracted invoice splitter images.
  */
 async function splitPdf(pdfDoc, invoicePageGroups) {
-    const pdfLib = await getPdfLib();
+    const currentPdfLib = await getPdfLib();
     if (invoicePageGroups.length === 0) {
         return [];
     }
     const generatedPdfs = [];
     for (let i = 0; i < invoicePageGroups.length; i++) {
-        const subdocument = await pdfLib.PDFDocument.create();
+        const subdocument = await currentPdfLib.PDFDocument.create();
         const fullIndexes = [];
         for (let j = invoicePageGroups[i][0]; j <= invoicePageGroups[i][invoicePageGroups[i].length - 1]; j++) {
             fullIndexes.push(j);
@@ -46,12 +46,12 @@ async function splitPdf(pdfDoc, invoicePageGroups) {
  * @returns PDF document.
  */
 async function getPdfDoc(inputFile) {
-    const pdfLib = await getPdfLib();
+    const currentPdfLib = await getPdfLib();
     await inputFile.init();
     if (!inputFile.isPdf()) {
         throw new MindeeInputSourceError("Invoice Splitter is only compatible with PDF documents.");
     }
-    const pdfDoc = await pdfLib.PDFDocument.load(inputFile.fileObject, {
+    const pdfDoc = await currentPdfLib.PDFDocument.load(inputFile.fileObject, {
         ignoreEncryption: true,
         password: ""
     });

package/src/v1/extraction/multiReceiptsExtractor/extractedMultiReceiptImage.d.ts

@@ -3,9 +3,13 @@ import { ExtractedImage } from "../../../image/index.js";
  * Wrapper class for extracted multiple-receipts images.
  */
 export declare class ExtractedMultiReceiptImage extends ExtractedImage {
-    /** Receipt index within the source page. */
+    /**
+     * Receipt index within the source page.
+     */
     readonly receiptId: number;
-    /** Source page identifier. */
+    /**
+     * Source page identifier.
+     */
     readonly pageId: number;
     constructor(buffer: Uint8Array, pageId: number, receiptId: number);
 }

package/src/v1/extraction/multiReceiptsExtractor/multiReceiptsExtractor.d.ts

@@ -1,5 +1,5 @@
-import { MultiReceiptsDetectorV1 } from "../../../v1/product/index.js";
-import { ExtractedMultiReceiptImage } from "../../../v1/extraction/index.js";
+import { MultiReceiptsDetectorV1 } from "../../product/index.js";
+import { ExtractedMultiReceiptImage } from "../index.js";
 import { LocalInputSource } from "../../../input/index.js";
 /**
  * Extracts individual receipts from multi-receipts documents.

package/src/v1/extraction/multiReceiptsExtractor/multiReceiptsExtractor.js

@@ -1,6 +1,6 @@
 import { MindeeError } from "../../../errors/index.js";
 import { createPdfFromInputSource } from "../../../pdf/pdfOperation.js";
-import { ExtractedMultiReceiptImage } from "../../../v1/extraction/index.js";
+import { ExtractedMultiReceiptImage } from "../index.js";
 import { extractFromPage } from "../../../image/index.js";
 import { loadOptionalDependency } from "../../../dependency/index.js";
 let pdfLib = null;
@@ -40,7 +40,7 @@ async function extractReceiptsFromPage(pdfPage, boundingBoxes, pageId) {
  * @returns Individual extracted receipts as an array of ExtractedMultiReceiptImage.
  */
 export async function extractReceipts(inputFile, inference) {
-    const pdfLib = await getPdfLib();
+    const currentPdfLib = await getPdfLib();
     const images = [];
     if (!inference.prediction.receipts) {
         throw new MindeeError("No possible receipts candidates found for MultiReceipts extraction.");
@@ -48,7 +48,7 @@ export async function extractReceipts(inputFile, inference) {
     const pdfDoc = await createPdfFromInputSource(inputFile);
     for (let pageId = 0; pageId < pdfDoc.getPageCount(); pageId++) {
         const page = pdfDoc.getPage(pageId);
-        page.setRotation(pdfLib.degrees(inference.pages[pageId].orientation?.value ?? 0));
+        page.setRotation(currentPdfLib.degrees(inference.pages[pageId].orientation?.value ?? 0));
         const receiptPositions = inference.pages[pageId].prediction.receipts.map((receipt) => receipt.boundingBox);
         const extractedReceipts = await extractReceiptsFromPage(page, receiptPositions, pageId);
         images.push(...extractedReceipts);

package/src/v1/http/apiSettingsV1.d.ts

@@ -1,13 +1,23 @@
 import { BaseSettings, MindeeApiConstructorProps } from "../../http/baseSettings.js";
-/** Default account owner for built-in v1 APIs. */
+/**
+ * Default account owner for built-in v1 APIs.
+ */
 export declare const STANDARD_API_OWNER: string;
-/** Runtime settings container for v1 API calls. */
+/**
+ * Runtime settings container for v1 API calls.
+ */
 export declare class ApiSettingsV1 extends BaseSettings {
-    /** Default headers sent with each v1 API request. */
+    /**
+     * Default headers sent with each v1 API request.
+     */
     baseHeaders: Record<string, string>;
     constructor({ apiKey, dispatcher, }: MindeeApiConstructorProps);
-    /** Resolves the API key from environment variables. */
+    /**
+     * Resolves the API key from environment variables.
+     */
     protected apiKeyFromEnv(): string;
-    /** Resolves the API hostname from environment variables. */
+    /**
+     * Resolves the API hostname from environment variables.
+     */
     protected hostnameFromEnv(): string;
 }

package/src/v1/http/apiSettingsV1.js

@@ -1,12 +1,16 @@
 import { logger } from "../../logger.js";
 import { BaseSettings } from "../../http/baseSettings.js";
 import { MindeeConfigurationError } from "../../errors/index.js";
-/** Default account owner for built-in v1 APIs. */
+/**
+ * Default account owner for built-in v1 APIs.
+ */
 export const STANDARD_API_OWNER = "mindee";
 const API_V1_KEY_ENVVAR_NAME = "MINDEE_API_KEY";
 const API_V1_HOST_ENVVAR_NAME = "MINDEE_API_HOST";
 const DEFAULT_MINDEE_API_HOST = "api.mindee.net";
-/** Runtime settings container for v1 API calls. */
+/**
+ * Runtime settings container for v1 API calls.
+ */
 export class ApiSettingsV1 extends BaseSettings {
     constructor({ apiKey, dispatcher, }) {
         super(apiKey, dispatcher);
@@ -20,7 +24,9 @@ export class ApiSettingsV1 extends BaseSettings {
             Authorization: `Token ${this.apiKey}`,
         };
     }
-    /** Resolves the API key from environment variables. */
+    /**
+     * Resolves the API key from environment variables.
+     */
     apiKeyFromEnv() {
         const envVarValue = process.env[API_V1_KEY_ENVVAR_NAME];
         if (envVarValue) {
@@ -29,7 +35,9 @@ export class ApiSettingsV1 extends BaseSettings {
         }
         return "";
     }
-    /** Resolves the API hostname from environment variables. */
+    /**
+     * Resolves the API hostname from environment variables.
+     */
     hostnameFromEnv() {
         const envVarValue = process.env[API_V1_HOST_ENVVAR_NAME];
         if (envVarValue) {

package/src/v1/http/baseEndpoint.d.ts

@@ -1,9 +1,13 @@
 import { InputSource, PageOptions } from "../../input/index.js";
-import { ApiSettingsV1 } from "../../v1/http/apiSettingsV1.js";
+import { ApiSettingsV1 } from "./apiSettingsV1.js";
 export declare abstract class BaseEndpoint {
-    /** Settings relating to the API. */
+    /**
+     * Settings relating to the API.
+     */
     settings: ApiSettingsV1;
-    /** Root of the URL for API calls. */
+    /**
+     * Root of the URL for API calls.
+     */
     urlRoot: string;
     protected constructor(settings: ApiSettingsV1, urlRoot: string);
     /**

package/src/v1/http/endpoint.d.ts

@@ -3,17 +3,23 @@ import { StringDict } from "../../parsing/stringDict.js";
 import { BaseHttpResponse } from "../../http/apiCore.js";
 import { ApiSettingsV1 } from "./apiSettingsV1.js";
 import { PredictParams } from "./httpParams.js";
-import { BaseEndpoint } from "../../v1/http/baseEndpoint.js";
+import { BaseEndpoint } from "./baseEndpoint.js";
 /**
  * Endpoint for a product (OTS or Custom).
  */
 export declare class Endpoint extends BaseEndpoint {
     #private;
-    /** URL of a product. */
+    /**
+     * URL of a product.
+     */
     urlName: string;
-    /** Account owning the product. */
+    /**
+     * Account owning the product.
+     */
     owner: string;
-    /** Product's version, as a string. */
+    /**
+     * Product's version, as a string.
+     */
     version: string;
     constructor(urlName: string, owner: string, version: string, settings: ApiSettingsV1);
     /**

package/src/v1/http/endpoint.js

@@ -4,13 +4,13 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _Endpoint_instances, _Endpoint_predictReqPost, _Endpoint_predictAsyncReqPost, _Endpoint_documentQueueReqGet, _Endpoint_documentGetReq, _Endpoint_documentFeedbackPutReq;
-import { URLSearchParams } from "url";
+import { URLSearchParams } from "node:url";
 import { FormData } from "undici";
 import { LocalInputSource } from "../../input/index.js";
 import { sendRequestAndReadResponse, } from "../../http/apiCore.js";
 import { handleError } from "./errors.js";
 import { isValidAsyncResponse, isValidSyncResponse } from "./responseValidation.js";
-import { BaseEndpoint } from "../../v1/http/baseEndpoint.js";
+import { BaseEndpoint } from "./baseEndpoint.js";
 /**
  * Endpoint for a product (OTS or Custom).
  */

package/src/v1/http/errors.d.ts

@@ -13,11 +13,17 @@ export declare function handleError(urlName: string, response: BaseHttpResponse,
  * Is used when an error is lacking a handled error code.
  */
 export declare class MindeeHttpErrorV1 extends MindeeError {
-    /** Description of the error. */
+    /**
+     * Description of the error.
+     */
     message: string;
-    /** Additional details on the error. */
+    /**
+     * Additional details on the error.
+     */
     details: string | StringDict;
-    /** Standard HTTP error code. */
+    /**
+     * Standard HTTP error code.
+     */
     code?: number;
     constructor(httpError: StringDict, urlName: string, code?: number);
 }

package/src/v1/http/errors.js

@@ -83,9 +83,13 @@ export function handleError(urlName, response, serverError) {
 export class MindeeHttpErrorV1 extends MindeeError {
     constructor(httpError, urlName, code) {
         super(`${urlName} API ${code} HTTP error: ${httpError.message}`);
-        /** Description of the error. */
+        /**
+         * Description of the error.
+         */
         this.message = "";
-        /** Additional details on the error. */
+        /**
+         * Additional details on the error.
+         */
         this.details = "";
         this.details = httpError.details;
         this.message = httpError.message;

package/src/v1/http/httpParams.d.ts

@@ -1,31 +1,55 @@
 import { InputSource, PageOptions } from "../../input/index.js";
-import { ExecutionPriority } from "../../v1/parsing/common/index.js";
+import { ExecutionPriority } from "../parsing/common/index.js";
 interface HTTPParams {
-    /** Input source to submit to the API. */
+    /**
+     * Input source to submit to the API.
+     */
     inputDoc: InputSource;
-    /** Enables full-text OCR output when supported. */
+    /**
+     * Enables full-text OCR output when supported.
+     */
     fullText: boolean;
-    /** Optional local page filtering options applied before upload. */
+    /**
+     * Optional local page filtering options applied before upload.
+     */
     pageOptions?: PageOptions;
-    /** Enables Retrieval-Augmented Generation when supported. */
+    /**
+     * Enables Retrieval-Augmented Generation when supported.
+     */
     rag?: boolean;
 }
-/** Parameters sent to synchronous/asynchronous prediction endpoints. */
+/**
+ * Parameters sent to synchronous/asynchronous prediction endpoints.
+ */
 export interface PredictParams extends HTTPParams {
-    /** Enables word-level OCR details in the response. */
+    /**
+     * Enables word-level OCR details in the response.
+     */
     includeWords: boolean;
-    /** Enables cropper extras in the response. */
+    /**
+     * Enables cropper extras in the response.
+     */
     cropper: boolean;
-    /** Optional workflow ID used for workflow-backed inference. */
+    /**
+     * Optional workflow ID used for workflow-backed inference.
+     */
     workflowId?: string;
 }
-/** Parameters sent to workflow execution endpoints. */
+/**
+ * Parameters sent to workflow execution endpoints.
+ */
 export interface WorkflowParams extends HTTPParams {
-    /** Custom alias assigned to the submitted file. */
+    /**
+     * Custom alias assigned to the submitted file.
+     */
     alias?: string;
-    /** Processing priority of the workflow execution. */
+    /**
+     * Processing priority of the workflow execution.
+     */
     priority?: ExecutionPriority;
-    /** Whether to request a public validation URL. */
+    /**
+     * Whether to request a public validation URL.
+     */
     publicUrl?: string;
 }
 export {};

package/src/v1/http/workflowEndpoint.d.ts

@@ -1,9 +1,9 @@
 import { InputSource } from "../../input/index.js";
-import { ExecutionPriority } from "../../v1/parsing/common/index.js";
+import { ExecutionPriority } from "../parsing/common/index.js";
 import { BaseHttpResponse } from "../../http/apiCore.js";
 import { ApiSettingsV1 } from "./apiSettingsV1.js";
 import { WorkflowParams } from "./httpParams.js";
-import { BaseEndpoint } from "../../v1/http/baseEndpoint.js";
+import { BaseEndpoint } from "./baseEndpoint.js";
 /**
  * Endpoint for a workflow.
  */

package/src/v1/http/workflowEndpoint.js

@@ -4,13 +4,13 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _WorkflowEndpoint_instances, _WorkflowEndpoint_workflowReqPost;
-import { URLSearchParams } from "url";
+import { URLSearchParams } from "node:url";
 import { FormData } from "undici";
 import { LocalInputSource } from "../../input/index.js";
 import { sendRequestAndReadResponse, } from "../../http/apiCore.js";
 import { handleError } from "./errors.js";
 import { isValidSyncResponse } from "./responseValidation.js";
-import { BaseEndpoint } from "../../v1/http/baseEndpoint.js";
+import { BaseEndpoint } from "./baseEndpoint.js";
 /**
  * Endpoint for a workflow.
  */

package/src/v1/parsing/common/apiRequest.d.ts

@@ -5,15 +5,25 @@ import { StringDict } from "../../../parsing/stringDict.js";
  * @category API Response
  */
 export declare class ApiRequest {
-    /**  An object detailing the error. */
+    /**
+     * An object detailing the error.
+     */
     error: StringDict;
-    /** Target of the request. */
+    /**
+     * Target of the request.
+     */
     resources: string[];
-    /** Status of the request. Either "failure" or "success". */
+    /**
+     * Status of the request. Either "failure" or "success".
+     */
     status: "failure" | "success";
-    /** HTTP status code */
+    /**
+     * HTTP status code
+     */
     statusCode: number;
-    /** URL of the request. */
+    /**
+     * URL of the request.
+     */
     url: string;
     constructor(serverResponse: StringDict);
 }

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

@@ -5,9 +5,13 @@ import { StringDict } from "../../../parsing/stringDict.js";
  * @category API Response
  */
 export declare abstract class ApiResponse {
-    /** Initial request sent to the API. */
+    /**
+     * Initial request sent to the API.
+     */
     apiRequest: ApiRequest;
-    /** Raw text representation of the API's response. */
+    /**
+     * Raw text representation of the API's response.
+     */
     private readonly rawHttp;
     /**
      * @param serverResponse JSON response from the server.

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

@@ -8,17 +8,29 @@ import { Document } from "./document.js";
  * @category Asynchronous
  */
 export declare class Job {
-    /** Timestamp noting the enqueueing of a document. */
+    /**
+     * Timestamp noting the enqueueing of a document.
+     */
     issuedAt: Date;
-    /** Timestamp noting the availability of a prediction for an enqueued document. */
+    /**
+     * Timestamp noting the availability of a prediction for an enqueued document.
+     */
     availableAt?: Date;
-    /** Information about an error that occurred during the job processing. */
+    /**
+     * Information about an error that occurred during the job processing.
+     */
     error?: StringDict;
-    /** ID of the job. */
+    /**
+     * ID of the job.
+     */
     id: string;
-    /** Status of the job. */
+    /**
+     * Status of the job.
+     */
     status?: "waiting" | "processing" | "completed" | "failed";
-    /** The time taken to process the job, in milliseconds. */
+    /**
+     * The time taken to process the job, in milliseconds.
+     */
     milliSecsTaken?: number;
     constructor(jsonResponse: StringDict);
 }
@@ -33,7 +45,9 @@ export declare function datetimeWithTimezone(date: string): Date;
  * @category Asynchronous
  */
 export declare class AsyncPredictResponse<T extends Inference> extends ApiResponse {
-    /** Job for a queue. */
+    /**
+     * Job for a queue.
+     */
     job: Job;
     /** Prediction for an asynchronous request. Will not be available so long as the job is not
      * `completed`.

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

@@ -7,17 +7,29 @@ import { StringDict } from "../../../parsing/stringDict.js";
  * @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. */
+    /**
+     * File name as sent back by the server.
+     */
     filename: string;
-    /** Result of the base inference. */
+    /**
+     * Result of the base inference.
+     */
     inference: T;
-    /** ID of the document as sent back by the server. */
+    /**
+     * ID of the document as sent back by the server.
+     */
     id: string;
-    /** Potential `Extras` fields sent back along the prediction. */
+    /**
+     * Potential `Extras` fields sent back along the prediction.
+     */
     extras?: Extras;
-    /** Raw-text response for `allWords` parsing. */
+    /**
+     * Raw-text response for `allWords` parsing.
+     */
     ocr?: Ocr;
-    /** Page number as sent back by the API. */
+    /**
+     * Page number as sent back by the API.
+     */
     nPages: number;
     /**
      *

package/src/v1/parsing/common/document.js

@@ -50,9 +50,9 @@ export class Document {
 ${this.inference?.toString()}`;
     }
     injectFullTextOcr(rawPrediction) {
-        if (rawPrediction["inference"]["pages"].length < 1 ||
+        if (rawPrediction["inference"]["pages"].length === 0 ||
             !("extras" in rawPrediction["inference"]["pages"][0]) ||
-            rawPrediction["inference"]["pages"][0]["extras"].length < 1 ||
+            rawPrediction["inference"]["pages"][0]["extras"].length === 0 ||
             !("full_text_ocr" in rawPrediction["inference"]["pages"][0]["extras"]) ||
             !rawPrediction["inference"]["pages"][0]["extras"]["full_text_ocr"] ||
             !("content" in rawPrediction["inference"]["pages"][0]["extras"]["full_text_ocr"]) ||

package/src/v1/parsing/common/execution.d.ts

@@ -1,5 +1,5 @@
 import { Inference } from "./inference.js";
-import { GeneratedV1Document } from "../../../v1/product/generated/generatedV1Document.js";
+import { GeneratedV1Document } from "../../product/generated/generatedV1Document.js";
 import { ExecutionFile } from "./executionFile.js";
 import { StringDict } from "../../../parsing/stringDict.js";
 import { ExecutionPriority } from "./executionPriority.js";
@@ -8,31 +8,57 @@ import { ExecutionPriority } from "./executionPriority.js";
  * @category Workflow
  */
 export declare class Execution<T extends Inference> {
-    /** Identifier for the batch to which the execution belongs. */
+    /**
+     * Identifier for the batch to which the execution belongs.
+     */
     batchName: string;
-    /** The time at which the execution started. */
+    /**
+     * The time at which the execution started.
+     */
     createdAt: Date | null;
-    /** File representation within a workflow execution. */
+    /**
+     * File representation within a workflow execution.
+     */
     file: ExecutionFile;
-    /** Identifier for the execution. */
+    /**
+     * Identifier for the execution.
+     */
     id: string;
-    /** Deserialized inference object. */
+    /**
+     * Deserialized inference object.
+     */
     inference: T | null;
-    /** Priority of the execution. */
+    /**
+     * Priority of the execution.
+     */
     priority: ExecutionPriority | null;
-    /** The time at which the file was tagged as reviewed. */
+    /**
+     * The time at which the file was tagged as reviewed.
+     */
     reviewedAt: Date | null;
-    /** The time at which the file was uploaded to a workflow. */
+    /**
+     * The time at which the file was uploaded to a workflow.
+     */
     availableAt: Date | null;
-    /** Reviewed fields and values. */
+    /**
+     * Reviewed fields and values.
+     */
     reviewedPrediction: GeneratedV1Document | null;
-    /** Execution Status. */
+    /**
+     * Execution Status.
+     */
     status: string;
-    /** Execution type. */
+    /**
+     * Execution type.
+     */
     type: string | null;
-    /** The time at which the file was uploaded to a workflow. */
+    /**
+     * The time at which the file was uploaded to a workflow.
+     */
     uploadedAt: Date | null;
-    /** Identifier for the workflow. */
+    /**
+     * Identifier for the workflow.
+     */
     workflowId: string;
     constructor(inferenceClass: new (serverResponse: StringDict) => T, jsonResponse: StringDict);
 }

package/src/v1/parsing/common/execution.js

@@ -1,4 +1,4 @@
-import { GeneratedV1Document } from "../../../v1/product/generated/generatedV1Document.js";
+import { GeneratedV1Document } from "../../product/generated/generatedV1Document.js";
 import { parseDate } from "../../../parsing/dateParser.js";
 /**
  * Representation of an execution for a workflow.

package/src/v1/parsing/common/executionFile.d.ts

@@ -4,9 +4,13 @@ import { StringDict } from "../../../parsing/stringDict.js";
  * @category Workflow
  */
 export declare class ExecutionFile {
-    /** File name. */
+    /**
+     * File name.
+     */
     name: string | null;
-    /** Optional alias for the fil. */
+    /**
+     * Optional alias for the file.
+     */
     alias: string | null;
     constructor(jsonResponse: StringDict);
 }

package/src/v1/parsing/common/executionPriority.d.ts

@@ -1,9 +1,17 @@
-/** Execution priority levels available for workflow requests. */
+/**
+ * Execution priority levels available for workflow requests.
+ */
 export declare enum ExecutionPriority {
-    /** Low-priority background processing. */
+    /**
+     * Low-priority background processing.
+     */
     low = "low",
-    /** Standard processing priority. */
+    /**
+     * Standard processing priority.
+     */
     medium = "medium",
-    /** High-priority processing. */
+    /**
+     * High-priority processing.
+     */
     high = "high"
 }