mindee 3.10.2 → 4.0.0

package/src/client.d.ts

@@ -1,68 +1,28 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import { Readable } from "stream";
-import { InputSource, PageOptions } from "./inputs";
-import { Response, AsyncPredictResponse } from "./api";
-import { Document, DocumentSig } from "./documents";
-import { DocumentConfig } from "./documents/documentConfig";
-type DocConfigs = Map<string[], DocumentConfig<any>>;
+import { InputSource, PageOptions } from "./input";
+import { Endpoint } from "./http";
+import { Inference, AsyncPredictResponse, StringDict, PredictResponse } from "./parsing/common";
 export interface PredictOptions {
-    /**
-     * For custom endpoints, the "API name" field in the "Settings" page of the API Builder.
-     *
-     * Do not set for standard (off the shelf) endpoints.
-     */
     endpointName?: string;
-    /**
-     * For custom endpoints, your account or organization's username on the API Builder.
-     * This is normally not required unless you have a custom endpoint which has the
-     * same name as standard (off the shelf) endpoint.
-     *
-     * Do not set for standard (off the shelf) endpoints.
-     */
     accountName?: string;
+    endpointVersion?: string;
+    endpoint?: Endpoint;
     /**
      * Whether to include the full text for each page.
      *
      * This performs a full OCR operation on the server and will increase response time.
      */
-    fullText?: boolean;
+    allWords?: boolean;
     /**
      * Whether to include cropper results for each page.
      *
      * This performs a cropping operation on the server and will increase response time.
      */
     cropper?: boolean;
-    /**
-     * If set, remove pages from the document as specified.
-     *
-     * This is done before sending the file to the server and is useful to avoid page limitations.
-     */
     pageOptions?: PageOptions;
 }
-export declare class DocumentClient {
-    docConfigs: DocConfigs;
-    inputSource?: InputSource;
-    constructor(docConfigs: DocConfigs, inputSource?: InputSource);
-    /**
-     * Send a document to a synchronous endpoint and parse the predictions.
-     * @param documentClass
-     * @param params
-     */
-    parse<DocType extends Document>(documentClass: DocumentSig<DocType>, params?: PredictOptions): Promise<Response<DocType>>;
-    /**
-     * Send the document to an asynchronous endpoint and return its ID in the queue.
-     * @param documentClass
-     * @param params
-     */
-    enqueue<DocType extends Document>(documentClass: DocumentSig<DocType>, params?: PredictOptions): Promise<AsyncPredictResponse<DocType>>;
-    parseQueued<DocType extends Document>(documentClass: DocumentSig<DocType>, queueId: string, params?: {
-        endpointName?: string;
-        accountName?: string;
-    }): Promise<AsyncPredictResponse<DocType>>;
-    protected getBooleanParam(param?: boolean): boolean;
-    protected getDocConfig<DocType extends Document>(documentClass: DocumentSig<DocType>, endpointName?: string, accountName?: string): DocumentConfig<DocType>;
-}
 export interface CustomConfigParams {
     /** Your organization's username on the API Builder. */
     accountName: string;
@@ -86,57 +46,66 @@ export interface ClientOptions {
  * Mindee Client
  */
 export declare class Client {
-    readonly docConfigs: DocConfigs;
+    #private;
     protected apiKey: string;
     /**
      * @param options
      */
-    constructor({ apiKey, throwOnError, debug, }: ClientOptions);
-    protected addStandardEndpoints(): void;
+    constructor({ apiKey, throwOnError, debug }?: ClientOptions);
     /**
-     * Add a custom endpoint to the client.
-     * @param accountName
-     * @param endpointName
-     * @param version
+     * Send a document to a synchronous endpoint and parse the predictions.
+     * @param productClass
+     * @param params
      */
-    addEndpoint({ accountName, endpointName, version, }: CustomConfigParams): this;
+    parse<T extends Inference>(productClass: new (httpResponse: StringDict) => T, inputSource: InputSource, params?: PredictOptions): Promise<PredictResponse<T>>;
+    /**
+     * Send the document to an asynchronous endpoint and return its ID in the queue.
+     * @param productClass
+     * @param params
+     */
+    enqueue<T extends Inference>(productClass: new (httpResponse: StringDict) => T, inputSource: InputSource, params?: PredictOptions): Promise<AsyncPredictResponse<T>>;
+    parseQueued<T extends Inference>(productClass: new (httpResponse: StringDict) => T, queueId: string, params?: PredictOptions): Promise<AsyncPredictResponse<T>>;
+    protected getBooleanParam(param?: boolean): boolean;
+    /**
+     * Creates a custom endpoint with the given values. Raises an error if the endpoint is invalid.
+     * @param productClass Class of the product
+     * @param endpointName Name of a custom Endpoint
+     * @param accountName Name of the account tied to the active Endpoint
+     * @param version Version of a custom Endpoint
+     */
+    createEndpoint(endpointName: string, accountName: string, endpointVersion?: string): Endpoint;
     /**
      * Load an input document from a local path.
      * @param inputPath
      */
-    docFromPath(inputPath: string): DocumentClient;
+    docFromPath(inputPath: string): InputSource;
     /**
      * Load an input document from a base64 encoded string.
      * @param inputString
      * @param filename
      */
-    docFromBase64(inputString: string, filename: string): DocumentClient;
+    docFromBase64(inputString: string, filename: string): InputSource;
     /**
      * Load an input document from a `stream.Readable` object.
      * @param inputStream
      * @param filename
      */
-    docFromStream(inputStream: Readable, filename: string): DocumentClient;
+    docFromStream(inputStream: Readable, filename: string): InputSource;
     /**
      * Load an input document from a bytes string.
      * @param inputBytes
      * @param filename
      */
-    docFromBytes(inputBytes: string, filename: string): DocumentClient;
+    docFromBytes(inputBytes: string, filename: string): InputSource;
     /**
      * Load an input document from a URL.
      * @param url
      */
-    docFromUrl(url: string): DocumentClient;
+    docFromUrl(url: string): InputSource;
     /**
      * Load an input document from a Buffer.
      * @param buffer
      * @param filename
      */
-    docFromBuffer(buffer: Buffer, filename: string): DocumentClient;
-    /**
-     * Load an empty input document from an asynchronous call.
-     */
-    docForAsync(): DocumentClient;
+    docFromBuffer(buffer: Buffer, filename: string): InputSource;
 }
-export {};

package/src/client.js

@@ -1,199 +1,119 @@
 "use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _Client_instances, _Client_buildEndpoint, _Client_initializeOTSEndpoint, _Client_cleanAccountName, _Client_getEndpoint;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Client = exports.DocumentClient = void 0;
-const inputs_1 = require("./inputs");
-const api_1 = require("./api");
-const documents_1 = require("./documents");
-const documentConfig_1 = require("./documents/documentConfig");
+exports.Client = void 0;
+const input_1 = require("./input");
+const http_1 = require("./http");
+const common_1 = require("./parsing/common");
 const handler_1 = require("./errors/handler");
 const logger_1 = require("./logger");
-class DocumentClient {
-    constructor(docConfigs, inputSource) {
-        this.inputSource = inputSource;
-        this.docConfigs = docConfigs;
+const inference_1 = require("./parsing/common/inference");
+const product_1 = require("./product");
+/**
+ * Mindee Client
+ */
+class Client {
+    /**
+     * @param options
+     */
+    constructor({ apiKey, throwOnError, debug } = {
+        apiKey: "",
+        throwOnError: true,
+        debug: false,
+    }) {
+        _Client_instances.add(this);
+        this.apiKey = apiKey ? apiKey : "";
+        handler_1.errorHandler.throwOnError = throwOnError ?? true;
+        logger_1.logger.level =
+            debug ?? process.env.MINDEE_DEBUG
+                ? logger_1.LOG_LEVELS["debug"]
+                : logger_1.LOG_LEVELS["warn"];
+        logger_1.logger.debug("Client initialized");
     }
     /**
      * Send a document to a synchronous endpoint and parse the predictions.
-     * @param documentClass
+     * @param productClass
      * @param params
      */
-    async parse(documentClass, params = {
-        endpointName: "",
-        accountName: "",
-        fullText: false,
-        cropper: false,
+    async parse(productClass, inputSource, params = {
+        endpoint: undefined,
+        allWords: undefined,
+        cropper: undefined,
         pageOptions: undefined,
     }) {
-        const docConfig = this.getDocConfig(documentClass, params.endpointName, params.accountName);
-        if (this.inputSource === undefined) {
+        const endpoint = params?.endpoint ?? __classPrivateFieldGet(this, _Client_instances, "m", _Client_initializeOTSEndpoint).call(this, productClass);
+        if (inputSource === undefined) {
             throw new Error("The 'parse' function requires an input document.");
         }
-        return await docConfig.predict({
-            inputDoc: this.inputSource,
-            includeWords: this.getBooleanParam(params.fullText),
+        const rawPrediction = await endpoint.predict({
+            inputDoc: inputSource,
+            includeWords: this.getBooleanParam(params.allWords),
             pageOptions: params.pageOptions,
             cropper: this.getBooleanParam(params.cropper),
         });
+        return new common_1.PredictResponse(productClass, rawPrediction.data);
     }
     /**
      * Send the document to an asynchronous endpoint and return its ID in the queue.
-     * @param documentClass
+     * @param productClass
      * @param params
      */
-    async enqueue(documentClass, params = {
-        endpointName: "",
-        accountName: "",
-        fullText: false,
-        cropper: false,
-        pageOptions: undefined,
-    }) {
-        const docConfig = this.getDocConfig(documentClass, params.endpointName, params.accountName);
-        if (this.inputSource === undefined) {
-            throw new Error("The 'enqueue' function requires an input document.");
+    async enqueue(productClass, inputSource, params = {}) {
+        const endpoint = params?.endpoint ?? __classPrivateFieldGet(this, _Client_instances, "m", _Client_initializeOTSEndpoint).call(this, productClass);
+        if (inputSource === undefined) {
+            throw new Error("The 'parse' function requires an input document.");
         }
-        return await docConfig.predictAsync({
-            inputDoc: this.inputSource,
-            includeWords: this.getBooleanParam(params.fullText),
-            pageOptions: params.pageOptions,
+        const rawResponse = await endpoint.predictAsync({
+            inputDoc: inputSource,
+            includeWords: this.getBooleanParam(params.allWords),
+            pageOptions: params?.pageOptions,
             cropper: this.getBooleanParam(params.cropper),
         });
+        return new common_1.AsyncPredictResponse(productClass, rawResponse.data);
     }
-    async parseQueued(documentClass, queueId, params = {
-        endpointName: "",
-        accountName: "",
-    }) {
-        const docConfig = this.getDocConfig(documentClass, params.endpointName, params.accountName);
-        return await docConfig.getQueuedDocument(queueId);
+    async parseQueued(productClass, queueId, params = {}) {
+        const endpoint = params?.endpoint ?? __classPrivateFieldGet(this, _Client_instances, "m", _Client_initializeOTSEndpoint).call(this, productClass);
+        const docResponse = await endpoint.getQueuedDocument(queueId);
+        return new common_1.AsyncPredictResponse(productClass, docResponse.data);
     }
     getBooleanParam(param) {
         return param !== undefined ? param : false;
     }
-    getDocConfig(documentClass, endpointName, accountName) {
-        const docType = endpointName === undefined || endpointName === ""
-            ? documentClass.name
-            : endpointName;
-        const found = [];
-        this.docConfigs.forEach((config, configKey) => {
-            if (configKey[1] === docType) {
-                found.push(configKey);
-            }
-        });
-        if (found.length === 0) {
-            throw `Document type not configured: '${docType}'`;
-        }
-        let configKey = [];
-        if (found.length === 1) {
-            configKey = found[0];
+    /**
+     * Creates a custom endpoint with the given values. Raises an error if the endpoint is invalid.
+     * @param productClass Class of the product
+     * @param endpointName Name of a custom Endpoint
+     * @param accountName Name of the account tied to the active Endpoint
+     * @param version Version of a custom Endpoint
+     */
+    createEndpoint(endpointName, accountName, endpointVersion) {
+        const cleanAccountName = __classPrivateFieldGet(this, _Client_instances, "m", _Client_cleanAccountName).call(this, product_1.CustomV1, accountName);
+        if (!endpointName || endpointName.length === 0) {
+            throw new Error("Missing parameter 'endpointName' for custom build!");
         }
-        else if (accountName) {
-            configKey = [accountName, docType];
+        let cleanEndpointVersion;
+        if (!endpointVersion || endpointVersion.length === 0) {
+            logger_1.logger.debug("Warning: No version provided for a custom build, will attempt to poll version 1 by default.");
+            cleanEndpointVersion = "1";
         }
-        const docConfig = this.docConfigs.get(configKey);
-        if (docConfig === undefined) {
-            // TODO: raise error printing all usernames
-            throw `Couldn't find the config '${configKey}'`;
+        else {
+            cleanEndpointVersion = endpointVersion;
         }
-        return docConfig;
-    }
-}
-exports.DocumentClient = DocumentClient;
-/**
- * Mindee Client
- */
-class Client {
-    /**
-     * @param options
-     */
-    constructor({ apiKey = "", throwOnError = true, debug = false, }) {
-        this.docConfigs = new Map();
-        this.apiKey = apiKey;
-        handler_1.errorHandler.throwOnError = throwOnError;
-        logger_1.logger.level =
-            debug ?? process.env.MINDEE_DEBUG
-                ? logger_1.LOG_LEVELS["debug"]
-                : logger_1.LOG_LEVELS["warn"];
-        logger_1.logger.debug("Client initialized");
-        this.addStandardEndpoints();
-    }
-    // TODO: init only those endpoints we actually need.
-    addStandardEndpoints() {
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.FinancialDocumentV0.name], new documentConfig_1.FinancialDocV0Config(this.apiKey));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.FinancialDocumentV1.name], new documentConfig_1.DocumentConfig(documents_1.FinancialDocumentV1, [
-            new api_1.StandardEndpoint("financial_document", "1", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.InvoiceV3.name], new documentConfig_1.DocumentConfig(documents_1.InvoiceV3, [
-            new api_1.StandardEndpoint("invoices", "3", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.InvoiceV4.name], new documentConfig_1.DocumentConfig(documents_1.InvoiceV4, [
-            new api_1.StandardEndpoint("invoices", "4", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.InvoiceSplitterV1.name], new documentConfig_1.DocumentConfig(documents_1.InvoiceSplitterV1, [
-            new api_1.StandardEndpoint("invoice_splitter", "1", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.ReceiptV3.name], new documentConfig_1.DocumentConfig(documents_1.ReceiptV3, [
-            new api_1.StandardEndpoint("expense_receipts", "3", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.ReceiptV4.name], new documentConfig_1.DocumentConfig(documents_1.ReceiptV4, [
-            new api_1.StandardEndpoint("expense_receipts", "4", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.ReceiptV5.name], new documentConfig_1.DocumentConfig(documents_1.ReceiptV5, [
-            new api_1.StandardEndpoint("expense_receipts", "5", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.PassportV1.name], new documentConfig_1.DocumentConfig(documents_1.PassportV1, [
-            new api_1.StandardEndpoint("passport", "1", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.CropperV1.name], new documentConfig_1.DocumentConfig(documents_1.CropperV1, [
-            new api_1.StandardEndpoint("cropper", "1", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.fr.IdCardV1.name], new documentConfig_1.DocumentConfig(documents_1.fr.IdCardV1, [
-            new api_1.StandardEndpoint("idcard_fr", "1", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.us.BankCheckV1.name], new documentConfig_1.DocumentConfig(documents_1.us.BankCheckV1, [
-            new api_1.StandardEndpoint("bank_check", "1", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.fr.BankAccountDetailsV1.name], new documentConfig_1.DocumentConfig(documents_1.fr.BankAccountDetailsV1, [
-            new api_1.StandardEndpoint("bank_account_details", "1", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.fr.BankAccountDetailsV2.name], new documentConfig_1.DocumentConfig(documents_1.fr.BankAccountDetailsV2, [
-            new api_1.StandardEndpoint("bank_account_details", "2", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.fr.CarteVitaleV1.name], new documentConfig_1.DocumentConfig(documents_1.fr.CarteVitaleV1, [
-            new api_1.StandardEndpoint("carte_vitale", "1", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.eu.LicensePlateV1.name], new documentConfig_1.DocumentConfig(documents_1.eu.LicensePlateV1, [
-            new api_1.StandardEndpoint("license_plates", "1", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.MindeeVisionV1.name], new documentConfig_1.DocumentConfig(documents_1.MindeeVisionV1, [
-            new api_1.StandardEndpoint("mindee_vision", "1", this.apiKey),
-        ]));
-        this.docConfigs.set([api_1.STANDARD_API_OWNER, documents_1.ProofOfAddressV1.name], new documentConfig_1.DocumentConfig(documents_1.ProofOfAddressV1, [
-            new api_1.StandardEndpoint("proof_of_address", "1", this.apiKey),
-        ]));
-    }
-    /**
-     * Add a custom endpoint to the client.
-     * @param accountName
-     * @param endpointName
-     * @param version
-     */
-    addEndpoint({ accountName, endpointName, version = "1", }) {
-        this.docConfigs.set([accountName, endpointName], new documentConfig_1.CustomDocConfig({
-            accountName: accountName,
-            endpointName: endpointName,
-            version: version,
-            apiKey: this.apiKey,
-        }));
-        return this;
+        return __classPrivateFieldGet(this, _Client_instances, "m", _Client_buildEndpoint).call(this, endpointName, cleanAccountName, cleanEndpointVersion);
     }
     /**
      * Load an input document from a local path.
      * @param inputPath
      */
     docFromPath(inputPath) {
-        const doc = new inputs_1.PathInput({
+        return new input_1.PathInput({
             inputPath: inputPath,
         });
-        return new DocumentClient(this.docConfigs, doc);
     }
     /**
      * Load an input document from a base64 encoded string.
@@ -201,11 +121,10 @@ class Client {
      * @param filename
      */
     docFromBase64(inputString, filename) {
-        const doc = new inputs_1.Base64Input({
+        return new input_1.Base64Input({
             inputString: inputString,
             filename: filename,
         });
-        return new DocumentClient(this.docConfigs, doc);
     }
     /**
      * Load an input document from a `stream.Readable` object.
@@ -213,11 +132,10 @@ class Client {
      * @param filename
      */
     docFromStream(inputStream, filename) {
-        const doc = new inputs_1.StreamInput({
+        return new input_1.StreamInput({
             inputStream: inputStream,
             filename: filename,
         });
-        return new DocumentClient(this.docConfigs, doc);
     }
     /**
      * Load an input document from a bytes string.
@@ -225,21 +143,19 @@ class Client {
      * @param filename
      */
     docFromBytes(inputBytes, filename) {
-        const doc = new inputs_1.BytesInput({
+        return new input_1.BytesInput({
             inputBytes: inputBytes,
             filename: filename,
         });
-        return new DocumentClient(this.docConfigs, doc);
     }
     /**
      * Load an input document from a URL.
      * @param url
      */
     docFromUrl(url) {
-        const doc = new inputs_1.UrlInput({
+        return new input_1.UrlInput({
             url: url,
         });
-        return new DocumentClient(this.docConfigs, doc);
     }
     /**
      * Load an input document from a Buffer.
@@ -247,17 +163,37 @@ class Client {
      * @param filename
      */
     docFromBuffer(buffer, filename) {
-        const doc = new inputs_1.BufferInput({
+        return new input_1.BufferInput({
             buffer: buffer,
             filename: filename,
         });
-        return new DocumentClient(this.docConfigs, doc);
-    }
-    /**
-     * Load an empty input document from an asynchronous call.
-     */
-    docForAsync() {
-        return new DocumentClient(this.docConfigs);
     }
 }
 exports.Client = Client;
+_Client_instances = new WeakSet(), _Client_buildEndpoint = function _Client_buildEndpoint(endpointName, accountName, endpointVersion) {
+    const apiSettings = new http_1.MindeeApi({
+        apiKey: this.apiKey,
+        urlName: endpointName,
+        version: endpointVersion,
+        owner: accountName,
+    });
+    return new http_1.Endpoint(endpointName, accountName, endpointVersion, apiSettings);
+}, _Client_initializeOTSEndpoint = function _Client_initializeOTSEndpoint(productClass) {
+    if (productClass.name === "CustomV1") {
+        throw new Error("Incorrect parameters for Custom build.");
+    }
+    const [endpointName, endpointVersion] = __classPrivateFieldGet(this, _Client_instances, "m", _Client_getEndpoint).call(this, productClass);
+    return __classPrivateFieldGet(this, _Client_instances, "m", _Client_buildEndpoint).call(this, endpointName, http_1.STANDARD_API_OWNER, endpointVersion);
+}, _Client_cleanAccountName = function _Client_cleanAccountName(productClass, accountName) {
+    if (productClass.name === "CustomV1") {
+        if (!accountName || accountName.length === 0) {
+            logger_1.logger.debug(`Warning: no account name provided for custom build, ${http_1.STANDARD_API_OWNER} will be used by default`);
+            return http_1.STANDARD_API_OWNER;
+        }
+        return accountName;
+    }
+    return http_1.STANDARD_API_OWNER;
+}, _Client_getEndpoint = function _Client_getEndpoint(productClass) {
+    const [endpointName, endpointVersion] = inference_1.InferenceFactory.getEndpoint(productClass);
+    return [endpointName, endpointVersion];
+};

package/src/geometry/boundingBox.d.ts

@@ -0,0 +1,5 @@
+import { Point } from "./point";
+/** A simple bounding box defined by 4 coordinates: xMin, yMin, xMax, yMax */
+export type BBox = [number, number, number, number];
+/** A bounding box defined by 4 points. */
+export type BoundingBox = [Point, Point, Point, Point];

package/src/geometry/boundingBox.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/geometry/boundingBoxUtils.d.ts

@@ -0,0 +1,22 @@
+import { BoundingBox, BBox } from "./boundingBox";
+import { Polygon } from "./polygon";
+/**
+ * Given a Polygon, calculate a polygon that encompasses all points.
+ */
+export declare function getBoundingBox(polygon: Polygon): BoundingBox;
+/**
+ * Given a BBox, generate the associated bounding box.
+ */
+export declare function getBoundingBoxFromBBox(bbox: BBox): BoundingBox;
+/**
+ * Given 2 bbox, merge them.
+ */
+export declare function mergeBbox(bbox1: BBox, bbox2: BBox): BBox;
+/**
+ * Given a Polygon, calculate a bounding box that encompasses all points.
+ */
+export declare function getBbox(polygon: Polygon): BBox;
+/**
+ * Given polygons, calculate a bounding box that encompasses all points.
+ */
+export declare function getBBoxForPolygons(polygons: Polygon[]): BBox;

package/src/geometry/boundingBoxUtils.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBBoxForPolygons = exports.getBbox = exports.mergeBbox = exports.getBoundingBoxFromBBox = exports.getBoundingBox = void 0;
+/**
+ * Given a Polygon, calculate a polygon that encompasses all points.
+ */
+function getBoundingBox(polygon) {
+    const bbox = getBbox(polygon);
+    return [
+        [bbox[0], bbox[1]],
+        [bbox[2], bbox[1]],
+        [bbox[2], bbox[3]],
+        [bbox[0], bbox[3]],
+    ];
+}
+exports.getBoundingBox = getBoundingBox;
+/**
+ * Given a BBox, generate the associated bounding box.
+ */
+function getBoundingBoxFromBBox(bbox) {
+    return [
+        [bbox[0], bbox[1]],
+        [bbox[2], bbox[1]],
+        [bbox[2], bbox[3]],
+        [bbox[0], bbox[3]],
+    ];
+}
+exports.getBoundingBoxFromBBox = getBoundingBoxFromBBox;
+/**
+ * Given 2 bbox, merge them.
+ */
+function mergeBbox(bbox1, bbox2) {
+    return [
+        Math.min(bbox1[0], bbox2[0]),
+        Math.min(bbox1[1], bbox2[1]),
+        Math.max(bbox1[2], bbox2[2]),
+        Math.max(bbox1[3], bbox2[3]),
+    ];
+}
+exports.mergeBbox = mergeBbox;
+/**
+ * Given a Polygon, calculate a bounding box that encompasses all points.
+ */
+function getBbox(polygon) {
+    const allY = polygon.map((point) => point[1]);
+    const allX = polygon.map((point) => point[0]);
+    const yMin = Math.min(...allY);
+    const yMax = Math.max(...allY);
+    const xMin = Math.min(...allX);
+    const xMax = Math.max(...allX);
+    return [xMin, yMin, xMax, yMax];
+}
+exports.getBbox = getBbox;
+/**
+ * Given polygons, calculate a bounding box that encompasses all points.
+ */
+function getBBoxForPolygons(polygons) {
+    const allY = polygons.flatMap((polygon) => polygon.map((point) => point[1]));
+    const allX = polygons.flatMap((polygon) => polygon.map((point) => point[0]));
+    const yMin = Math.min(...allY);
+    const yMax = Math.max(...allY);
+    const xMin = Math.min(...allX);
+    const xMax = Math.max(...allX);
+    return [xMin, yMin, xMax, yMax];
+}
+exports.getBBoxForPolygons = getBBoxForPolygons;

package/src/geometry/index.d.ts

@@ -0,0 +1,6 @@
+export { Polygon } from "./polygon";
+export { compareOnX, compareOnY, getCentroid, isPointInPolygonX, isPointInPolygonY, relativeX, relativeY, getMinMaxX, getMinMaxY, } from "./polygonUtils";
+export { BoundingBox, BBox } from "./boundingBox";
+export { getBbox, getBBoxForPolygons, getBoundingBox, getBoundingBoxFromBBox, mergeBbox, } from "./boundingBoxUtils";
+export { MinMax } from "./minMax";
+export { Point } from "./point";

package/src/geometry/index.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeBbox = exports.getBoundingBoxFromBBox = exports.getBoundingBox = exports.getBBoxForPolygons = exports.getBbox = exports.getMinMaxY = exports.getMinMaxX = exports.relativeY = exports.relativeX = exports.isPointInPolygonY = exports.isPointInPolygonX = exports.getCentroid = exports.compareOnY = exports.compareOnX = exports.Polygon = void 0;
+var polygon_1 = require("./polygon");
+Object.defineProperty(exports, "Polygon", { enumerable: true, get: function () { return polygon_1.Polygon; } });
+var polygonUtils_1 = require("./polygonUtils");
+Object.defineProperty(exports, "compareOnX", { enumerable: true, get: function () { return polygonUtils_1.compareOnX; } });
+Object.defineProperty(exports, "compareOnY", { enumerable: true, get: function () { return polygonUtils_1.compareOnY; } });
+Object.defineProperty(exports, "getCentroid", { enumerable: true, get: function () { return polygonUtils_1.getCentroid; } });
+Object.defineProperty(exports, "isPointInPolygonX", { enumerable: true, get: function () { return polygonUtils_1.isPointInPolygonX; } });
+Object.defineProperty(exports, "isPointInPolygonY", { enumerable: true, get: function () { return polygonUtils_1.isPointInPolygonY; } });
+Object.defineProperty(exports, "relativeX", { enumerable: true, get: function () { return polygonUtils_1.relativeX; } });
+Object.defineProperty(exports, "relativeY", { enumerable: true, get: function () { return polygonUtils_1.relativeY; } });
+Object.defineProperty(exports, "getMinMaxX", { enumerable: true, get: function () { return polygonUtils_1.getMinMaxX; } });
+Object.defineProperty(exports, "getMinMaxY", { enumerable: true, get: function () { return polygonUtils_1.getMinMaxY; } });
+var boundingBoxUtils_1 = require("./boundingBoxUtils");
+Object.defineProperty(exports, "getBbox", { enumerable: true, get: function () { return boundingBoxUtils_1.getBbox; } });
+Object.defineProperty(exports, "getBBoxForPolygons", { enumerable: true, get: function () { return boundingBoxUtils_1.getBBoxForPolygons; } });
+Object.defineProperty(exports, "getBoundingBox", { enumerable: true, get: function () { return boundingBoxUtils_1.getBoundingBox; } });
+Object.defineProperty(exports, "getBoundingBoxFromBBox", { enumerable: true, get: function () { return boundingBoxUtils_1.getBoundingBoxFromBBox; } });
+Object.defineProperty(exports, "mergeBbox", { enumerable: true, get: function () { return boundingBoxUtils_1.mergeBbox; } });