mindee 4.7.0 → 4.8.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # CHANGELOG
 
+## v4.8.0 - 2024-02-05
+### Changes
+* :sparkles: add support for Generated APIs
+* :sparkles: add custom GeneratedList & GeneratedObject classes linked to Generated APIs
+* :arrow_up: update test lib to add testing samples for Generated APIs
+* :arrow_up: upgraded dependencies & lockfile version
+* :recycle: add new generated namespace & associated documentation
+* :wrench: add unit tests for generated APIs
+* :wrench: add code samples for generated APIs
+* :recycle: add CLI entry for generated APIs
+* :memo: add documentation entry for generated APIs
+* :recycle: expose a bit more of our internals for easier use (#247)
+
+### Fixes
+* :memo: fix invoice v4 md doc
+
+
 ## v4.7.0 - 2024-01-30
 ### Changes
 * :arrow_up: update invoices to 4.4

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "4.7.0",
+    "version": "4.8.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",

package/src/cli.js

@@ -31,6 +31,7 @@ const input_1 = require("./input");
 const console = __importStar(require("console"));
 const program = new commander_1.Command();
 const COMMAND_CUSTOM = "custom";
+const COMMAND_GENERATED = "generated";
 //
 // PRODUCT CONFIGURATION
 //
@@ -47,6 +48,16 @@ const CLI_COMMAND_CONFIG = new Map([
             sync: true,
         },
     ],
+    [
+        COMMAND_GENERATED,
+        {
+            displayName: "Generated Document",
+            docClass: product.GeneratedV1,
+            allWords: true,
+            async: true,
+            sync: true,
+        },
+    ],
     [
         "cropper",
         {
@@ -197,7 +208,7 @@ async function callParse(productClass, command, inputPath, options) {
     const pageOptions = getPageOptions(options);
     const inputSource = mindeeClient.docFromPath(inputPath);
     let response;
-    if (command === COMMAND_CUSTOM) {
+    if (command === COMMAND_CUSTOM || command === COMMAND_GENERATED) {
         const customEndpoint = mindeeClient.createEndpoint(options.endpoint, options.account, options.version);
         response = await mindeeClient.parse(productClass, inputSource, {
             endpoint: customEndpoint,
@@ -221,7 +232,7 @@ async function callEnqueueAndParse(productClass, command, inputPath, options) {
     const pageOptions = getPageOptions(options);
     const inputSource = mindeeClient.docFromPath(inputPath);
     let response;
-    if (command === COMMAND_CUSTOM) {
+    if (command === COMMAND_CUSTOM || command === COMMAND_GENERATED) {
         const customEndpoint = mindeeClient.createEndpoint(options.endpoint, options.account, options.version);
         response = await mindeeClient.enqueueAndParse(productClass, inputSource, {
             endpoint: customEndpoint,
@@ -308,7 +319,7 @@ function routeSwitchboard(command, inputPath, allOptions) {
     return callParse(docClass, command.name(), inputPath, allOptions);
 }
 function addPredictAction(prog) {
-    if (prog.name() === COMMAND_CUSTOM) {
+    if (prog.name() === COMMAND_CUSTOM || prog.name() === COMMAND_GENERATED) {
         prog.action(function (inputPath, options, command) {
             const allOptions = {
                 ...prog.parent?.parent?.opts(),
@@ -370,7 +381,7 @@ function cli() {
             }
             predictProductCmd.addOption(asyncOpt);
         }
-        if (name === COMMAND_CUSTOM) {
+        if (name === COMMAND_CUSTOM || name === COMMAND_GENERATED) {
             addCustomPostOptions(predictProductCmd);
         }
         addMainOptions(predictProductCmd);

package/src/index.d.ts

@@ -1,6 +1,6 @@
 export * as product from "./product";
 export { Client, PredictOptions } from "./client";
-export { AsyncPredictResponse, PredictResponse, Document, Page, } from "./parsing/common";
+export { AsyncPredictResponse, PredictResponse, Inference, Prediction, Document, Page, } from "./parsing/common";
 export { InputSource, PageOptionsOperation } from "./input";
 export * as internal from "./internal";
 export * as imageOperations from "./imageOperations";

package/src/index.js

@@ -23,13 +23,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.imageOperations = exports.internal = exports.PageOptionsOperation = exports.InputSource = exports.Page = exports.Document = exports.PredictResponse = exports.AsyncPredictResponse = exports.Client = exports.product = void 0;
+exports.imageOperations = exports.internal = exports.PageOptionsOperation = exports.InputSource = exports.Page = exports.Document = exports.Prediction = exports.Inference = exports.PredictResponse = exports.AsyncPredictResponse = exports.Client = exports.product = void 0;
 exports.product = __importStar(require("./product"));
 var client_1 = require("./client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });
 var common_1 = require("./parsing/common");
 Object.defineProperty(exports, "AsyncPredictResponse", { enumerable: true, get: function () { return common_1.AsyncPredictResponse; } });
 Object.defineProperty(exports, "PredictResponse", { enumerable: true, get: function () { return common_1.PredictResponse; } });
+Object.defineProperty(exports, "Inference", { enumerable: true, get: function () { return common_1.Inference; } });
+Object.defineProperty(exports, "Prediction", { enumerable: true, get: function () { return common_1.Prediction; } });
 Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return common_1.Document; } });
 Object.defineProperty(exports, "Page", { enumerable: true, get: function () { return common_1.Page; } });
 var input_1 = require("./input");

package/src/parsing/generated/generatedList.d.ts

@@ -0,0 +1,31 @@
+import { StringDict } from "../common";
+import { StringField } from "../standard";
+import { GeneratedObjectField } from "./generatedObject";
+export interface GeneratedListFieldConstructor {
+    prediction: StringDict[];
+    pageId?: number;
+}
+/**
+ * A list of values or objects, used in generated APIs.
+ */
+export declare class GeneratedListField {
+    /** Id of the page the object was found on. */
+    pageId?: number;
+    /** List of word values. */
+    values: Array<GeneratedObjectField | StringField>;
+    constructor({ prediction, pageId, }: GeneratedListFieldConstructor);
+    /**
+     * Returns an array of the contents of all values.
+     */
+    contentsList(): string[];
+    /**
+     * Return a string representation of all values.
+     * @param separator Character(s) to use when concatenating fields.
+     * @returns string representation.
+     */
+    contentsString(separator?: string): string;
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/parsing/generated/generatedList.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneratedListField = void 0;
+const standard_1 = require("../standard");
+const generatedObject_1 = require("./generatedObject");
+/**
+ * A list of values or objects, used in generated APIs.
+ */
+class GeneratedListField {
+    constructor({ prediction = [], pageId = undefined, }) {
+        this.values = [];
+        for (const value of prediction) {
+            if (value["page_id"] !== undefined && value["page_id"] !== null) {
+                this.pageId = value["page_id"];
+            }
+            if ((0, generatedObject_1.isGeneratedObject)(value)) {
+                this.values.push(new generatedObject_1.GeneratedObjectField({ prediction: value, pageId }));
+            }
+            else {
+                const valueStr = { ...value };
+                if (valueStr["value"] !== null && valueStr["value"] !== undefined && !isNaN(valueStr["value"])) {
+                    valueStr["value"] = value["value"].toFixed(1);
+                }
+                else if (value["value"] !== undefined && value["value"] !== null) {
+                    valueStr["value"] = value["value"].toString();
+                }
+                this.values.push(new standard_1.StringField({ prediction: valueStr, pageId: pageId }));
+            }
+        }
+    }
+    /**
+     * Returns an array of the contents of all values.
+     */
+    contentsList() {
+        return this.values.map((item) => item.toString());
+    }
+    /**
+     * Return a string representation of all values.
+     * @param separator Character(s) to use when concatenating fields.
+     * @returns string representation.
+     */
+    contentsString(separator = " ") {
+        return this.contentsList().map((item) => `${item.toString()}`).join(separator);
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        return this.contentsString();
+    }
+}
+exports.GeneratedListField = GeneratedListField;

package/src/parsing/generated/generatedObject.d.ts

@@ -0,0 +1,32 @@
+import { StringDict } from "../common";
+import { BaseFieldConstructor } from "../standard";
+/** A JSON-like object, with miscellaneous values. */
+export declare class GeneratedObjectField {
+    /** The document page on which the information was found. */
+    pageId?: number;
+    /** Confidence with which the value was assessed. */
+    confidence?: number;
+    /** Raw unprocessed value, as it was sent by the server. */
+    rawValue?: string;
+    /** List of all printable field names. */
+    private printableValues;
+    constructor({ prediction, pageId, }: BaseFieldConstructor);
+    /**
+     * ReSTructured-compliant string representation.
+       Takes into account level of indentation & displays elements as list elements.
+     * @param level Lvel of indentation. 0 by default.
+     */
+    toStringLevel(level?: number): string;
+    /**
+     * Formats a float number to have at least one decimal place.
+     * @param n Input number.
+     * @returns
+     */
+    private toNumberString;
+    toString(): string;
+}
+/**
+ * Checks whether an field is a custom object or not.
+ * @param strDict input dictionary to check.
+ */
+export declare function isGeneratedObject(strDict: StringDict): boolean;

package/src/parsing/generated/generatedObject.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isGeneratedObject = exports.GeneratedObjectField = void 0;
+const standard_1 = require("../standard");
+/** A JSON-like object, with miscellaneous values. */
+class GeneratedObjectField {
+    constructor({ prediction = {}, pageId, }) {
+        let itemPageId = null;
+        this.printableValues = [];
+        for (const [fieldName, fieldValue] of Object.entries(prediction)) {
+            if (fieldName === "page_id") {
+                itemPageId = fieldValue;
+            }
+            else if (["polygon", "rectangle", "quadrangle", "bounding_box"].includes(fieldName)) {
+                Object.assign(this, { [fieldName]: new standard_1.PositionField({ prediction: { [fieldName]: fieldValue }, valueKey: fieldName, pageId: pageId }) });
+                this.printableValues.push(fieldName);
+            }
+            else if (fieldName === "confidence") {
+                this.confidence = fieldValue;
+            }
+            else if (fieldName === "raw_value") {
+                this.rawValue = fieldValue;
+            }
+            else {
+                if (fieldValue !== null && fieldValue !== undefined && !isNaN(fieldValue) && fieldName !== "degrees") {
+                    Object.assign(this, { [fieldName]: this.toNumberString(fieldValue) });
+                }
+                else {
+                    Object.assign(this, { [fieldName]: (fieldValue !== undefined && fieldValue !== null) ? String(fieldValue) : null });
+                }
+                this.printableValues.push(fieldName);
+            }
+            this.pageId = pageId ?? itemPageId;
+        }
+    }
+    /**
+     * ReSTructured-compliant string representation.
+       Takes into account level of indentation & displays elements as list elements.
+     * @param level Lvel of indentation. 0 by default.
+     */
+    toStringLevel(level = 0) {
+        const indent = "  " + "  ".repeat(level);
+        let outStr = "";
+        this.printableValues.forEach((printableValue) => {
+            const strValue = this[printableValue];
+            outStr += `\n${indent}:${printableValue}: ${strValue !== null && strValue !== undefined ? strValue : ""}`;
+        });
+        return `\n${indent}${outStr.trim()}`;
+    }
+    /**
+     * Formats a float number to have at least one decimal place.
+     * @param n Input number.
+     * @returns
+     */
+    toNumberString(n) {
+        if (Number.isInteger(n)) {
+            return n + ".0";
+        }
+        return n.toString();
+    }
+    toString() {
+        return this.toStringLevel();
+    }
+}
+exports.GeneratedObjectField = GeneratedObjectField;
+/**
+ * Checks whether an field is a custom object or not.
+ * @param strDict input dictionary to check.
+ */
+function isGeneratedObject(strDict) {
+    const commonKeys = [
+        "value",
+        "polygon",
+        "rectangle",
+        "page_id",
+        "confidence",
+        "quadrangle",
+        "values",
+        "raw_value",
+    ];
+    for (const key in strDict) {
+        if (Object.prototype.hasOwnProperty.call(strDict, key) && !commonKeys.includes(key)) {
+            return true;
+        }
+    }
+    return false;
+}
+exports.isGeneratedObject = isGeneratedObject;

package/src/parsing/generated/index.d.ts

@@ -0,0 +1,2 @@
+export { GeneratedObjectField, isGeneratedObject } from "./generatedObject";
+export { GeneratedListField } from "./generatedList";

package/src/parsing/generated/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneratedListField = exports.isGeneratedObject = exports.GeneratedObjectField = void 0;
+var generatedObject_1 = require("./generatedObject");
+Object.defineProperty(exports, "GeneratedObjectField", { enumerable: true, get: function () { return generatedObject_1.GeneratedObjectField; } });
+Object.defineProperty(exports, "isGeneratedObject", { enumerable: true, get: function () { return generatedObject_1.isGeneratedObject; } });
+var generatedList_1 = require("./generatedList");
+Object.defineProperty(exports, "GeneratedListField", { enumerable: true, get: function () { return generatedList_1.GeneratedListField; } });

package/src/parsing/index.d.ts

@@ -1,3 +1,4 @@
 export * as common from "./common";
 export * as custom from "./custom";
 export * as standard from "./standard";
+export * as generated from "./generated";

package/src/parsing/index.js

@@ -23,7 +23,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.standard = exports.custom = exports.common = void 0;
+exports.generated = exports.standard = exports.custom = exports.common = void 0;
 exports.common = __importStar(require("./common"));
 exports.custom = __importStar(require("./custom"));
 exports.standard = __importStar(require("./standard"));
+exports.generated = __importStar(require("./generated"));

package/src/product/custom/customV1Document.d.ts

@@ -4,9 +4,9 @@ import { ClassificationField, ListField, CustomLines } from "../../parsing/custo
  * Document data for Custom builds.
  */
 export declare class CustomV1Document implements Prediction {
-    /** List of fields for a Custom build. */
+    /** Map of fields for a Custom build. */
     fields: Map<string, ListField>;
-    /** List of classification fields for a Custom build. */
+    /** Map of classification fields for a Custom build. */
     classifications: Map<string, ClassificationField>;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/product/custom/customV1Document.js

@@ -8,9 +8,9 @@ const custom_1 = require("../../parsing/custom");
  */
 class CustomV1Document {
     constructor(rawPrediction, pageId) {
-        /** List of fields for a Custom build. */
+        /** Map of fields for a Custom build. */
         this.fields = new Map();
-        /** List of classification fields for a Custom build. */
+        /** Map of classification fields for a Custom build. */
         this.classifications = new Map();
         Object.entries(rawPrediction).forEach(([fieldName, fieldValue]) => {
             this.setField(fieldName, fieldValue, pageId);

package/src/product/custom/customV1Page.d.ts

@@ -4,7 +4,7 @@ import { ListField, CustomLines } from "../../parsing/custom";
  * Page data for Custom builds.
  */
 export declare class CustomV1Page implements Prediction {
-    /** List of page-specific fields for a Custom build. Cannot include Classification fields. */
+    /** Map of page-specific fields for a Custom build. Cannot include Classification fields. */
     fields: Map<string, ListField>;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/product/custom/customV1Page.js

@@ -8,7 +8,7 @@ const custom_1 = require("../../parsing/custom");
  */
 class CustomV1Page {
     constructor(rawPrediction, pageId) {
-        /** List of page-specific fields for a Custom build. Cannot include Classification fields. */
+        /** Map of page-specific fields for a Custom build. Cannot include Classification fields. */
         this.fields = new Map();
         Object.entries(rawPrediction).forEach(([fieldName, fieldValue]) => {
             this.fields.set(fieldName, new custom_1.ListField({

package/src/product/generated/generatedV1.d.ts

@@ -0,0 +1,17 @@
+import { Inference, Page, StringDict } from "../../../src/parsing/common";
+import { GeneratedV1Document } from "./generatedV1Document";
+import { GeneratedV1Page } from "./generatedV1Page";
+/**
+ * Generated API V1 inference results.
+ */
+export declare class GeneratedV1 extends Inference {
+    /** The endpoint's name. Note: placeholder for custom APIs. */
+    endpointName: string;
+    /** The endpoint's version. Note: placeholder for custom APIs. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: GeneratedV1Document;
+    /** The document's pages. */
+    pages: Page<GeneratedV1Page>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/product/generated/generatedV1.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneratedV1 = void 0;
+const common_1 = require("../../../src/parsing/common");
+const generatedV1Document_1 = require("./generatedV1Document");
+const generatedV1Page_1 = require("./generatedV1Page");
+/**
+ * Generated API V1 inference results.
+ */
+class GeneratedV1 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. Note: placeholder for custom APIs. */
+        this.endpointName = "custom";
+        /** The endpoint's version. Note: placeholder for custom APIs. */
+        this.endpointVersion = "1";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new generatedV1Document_1.GeneratedV1Document(rawPrediction["prediction"]);
+        this.pages = rawPrediction["pages"].length > 0 && Object.keys(rawPrediction["pages"][0]["prediction"]).length > 0 ? rawPrediction["pages"].map((page) => new common_1.Page(generatedV1Page_1.GeneratedV1Page, page, page["id"])) : [];
+    }
+}
+exports.GeneratedV1 = GeneratedV1;

package/src/product/generated/generatedV1Document.d.ts

@@ -0,0 +1,8 @@
+import { StringDict } from "../../../src/parsing/common";
+import { GeneratedV1Prediction } from "./generatedV1Prediction";
+/**
+ * Generated V1 document prediction results.
+ */
+export declare class GeneratedV1Document extends GeneratedV1Prediction {
+    constructor(rawPrediction: StringDict);
+}

package/src/product/generated/generatedV1Document.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneratedV1Document = void 0;
+const generated_1 = require("../../../src/parsing/generated");
+const standard_1 = require("../../../src/parsing/standard");
+const generatedV1Prediction_1 = require("./generatedV1Prediction");
+/**
+ * Generated V1 document prediction results.
+ */
+class GeneratedV1Document extends generatedV1Prediction_1.GeneratedV1Prediction {
+    constructor(rawPrediction) {
+        super();
+        Object.entries(rawPrediction).forEach(([fieldName, fieldValue]) => {
+            if (Array.isArray(fieldValue)) {
+                this.fields.set(fieldName, new generated_1.GeneratedListField({ prediction: fieldValue }));
+            }
+            else if (typeof fieldValue === "object" && fieldValue !== null && (0, generated_1.isGeneratedObject)(fieldValue)) {
+                this.fields.set(fieldName, new generated_1.GeneratedObjectField({ prediction: fieldValue }));
+            }
+            else {
+                const fieldValueStr = fieldValue;
+                if (Object.prototype.hasOwnProperty.call(fieldValueStr, "value") && fieldValueStr["value"] !== null) {
+                    fieldValueStr["value"] = fieldValueStr["value"].toString();
+                }
+                this.fields.set(fieldName, new standard_1.StringField({ prediction: fieldValueStr }));
+            }
+        });
+    }
+}
+exports.GeneratedV1Document = GeneratedV1Document;

package/src/product/generated/generatedV1Page.d.ts

@@ -0,0 +1,8 @@
+import { StringDict } from "../../../src/parsing/common";
+import { GeneratedV1Prediction } from "./generatedV1Prediction";
+/**
+ * Generated V1 page prediction results.
+ */
+export declare class GeneratedV1Page extends GeneratedV1Prediction {
+    constructor(rawPrediction: StringDict, pageId?: number);
+}

package/src/product/generated/generatedV1Page.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneratedV1Page = void 0;
+const generated_1 = require("../../../src/parsing/generated");
+const standard_1 = require("../../../src/parsing/standard");
+const generatedV1Prediction_1 = require("./generatedV1Prediction");
+/**
+ * Generated V1 page prediction results.
+ */
+class GeneratedV1Page extends generatedV1Prediction_1.GeneratedV1Prediction {
+    constructor(rawPrediction, pageId) {
+        super();
+        Object.entries(rawPrediction).forEach(([fieldName, fieldValue]) => {
+            if (Array.isArray(fieldValue)) {
+                this.fields.set(fieldName, new generated_1.GeneratedListField({ prediction: fieldValue, pageId: pageId }));
+            }
+            else if (typeof fieldValue === "object" && fieldValue !== null && (0, generated_1.isGeneratedObject)(fieldValue)) {
+                this.fields.set(fieldName, new generated_1.GeneratedObjectField({ prediction: fieldValue, pageId: pageId }));
+            }
+            else {
+                const fieldValueStr = fieldValue;
+                if (Object.prototype.hasOwnProperty.call(fieldValueStr, "value") && fieldValueStr["value"] !== null) {
+                    fieldValueStr["value"] = fieldValueStr["value"].toString();
+                }
+                this.fields.set(fieldName, new standard_1.StringField({ prediction: fieldValueStr, pageId: pageId }));
+            }
+        });
+    }
+}
+exports.GeneratedV1Page = GeneratedV1Page;

package/src/product/generated/generatedV1Prediction.d.ts

@@ -0,0 +1,25 @@
+import { Prediction } from "../../../src/parsing/common";
+import { GeneratedListField } from "../../../src/parsing/generated";
+import { StringField } from "../../../src/parsing/standard";
+export declare class GeneratedV1Prediction implements Prediction {
+    /** Map of all fields in the document. */
+    fields: Map<string, any>;
+    constructor();
+    toString(): string;
+    /**
+     * Returns a dictionary of all fields that aren't a collection.
+     */
+    getSingleField(): Map<string, StringField>;
+    /**
+     * Returns a dictionary of all array-like fields.
+     */
+    getArrayFields(): Map<string, GeneratedListField>;
+    /**
+     * Returns a dictionary of all object-like fields.
+     */
+    getObjectFields(): Map<string, GeneratedListField>;
+    /**
+     * Lists names of all top-level field keys.
+     */
+    listFieldNames(): string[];
+}

package/src/product/generated/generatedV1Prediction.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneratedV1Prediction = void 0;
+const common_1 = require("../../../src/parsing/common");
+const generated_1 = require("../../../src/parsing/generated");
+const standard_1 = require("../../../src/parsing/standard");
+class GeneratedV1Prediction {
+    constructor() {
+        this.fields = new Map();
+    }
+    toString() {
+        let outStr = "";
+        const pattern = /^(\n*[  ]*)( {2}):/;
+        this.fields.forEach((fieldValue, fieldName) => {
+            let strValue = "";
+            if (fieldValue instanceof generated_1.GeneratedListField &&
+                fieldValue.values.length > 0) {
+                if (fieldValue.values[0] instanceof generated_1.GeneratedObjectField) {
+                    strValue += fieldValue.values[0].toStringLevel(1).replace(pattern, "$1* :");
+                }
+                else {
+                    strValue += fieldValue.values[0].toString().replace(pattern, "$1* :") + "\n";
+                }
+                for (const subValue of fieldValue.values.slice(1)) {
+                    if (subValue instanceof generated_1.GeneratedObjectField) {
+                        strValue += subValue.toStringLevel(1).replace(pattern, "$1* :");
+                    }
+                    else {
+                        strValue += ` ${" ".repeat(fieldName.length + 2)}${subValue}\n`;
+                    }
+                }
+                strValue = strValue.trimEnd();
+            }
+            else {
+                strValue = fieldValue.toString();
+            }
+            outStr += `:${fieldName}: ${strValue}\n`;
+        });
+        return (0, common_1.cleanOutString)(outStr.trimEnd());
+    }
+    /**
+     * Returns a dictionary of all fields that aren't a collection.
+     */
+    getSingleField() {
+        const singleFields = new Map();
+        for (const [fieldName, fieldValue] of Object.entries(this.fields)) {
+            if (fieldValue instanceof standard_1.StringField) {
+                singleFields.set(fieldName, fieldValue);
+            }
+        }
+        return singleFields;
+    }
+    /**
+     * Returns a dictionary of all array-like fields.
+     */
+    getArrayFields() {
+        const arrayFields = new Map();
+        for (const [fieldName, fieldValue] of Object.entries(this.fields)) {
+            if (fieldValue instanceof generated_1.GeneratedListField) {
+                arrayFields.set(fieldName, fieldValue);
+            }
+        }
+        return arrayFields;
+    }
+    /**
+     * Returns a dictionary of all object-like fields.
+     */
+    getObjectFields() {
+        const objectFields = new Map();
+        for (const [fieldName, fieldValue] of Object.entries(this.fields)) {
+            if (fieldValue instanceof generated_1.GeneratedObjectField) {
+                objectFields.set(fieldName, fieldValue);
+            }
+        }
+        return objectFields;
+    }
+    /**
+     * Lists names of all top-level field keys.
+     */
+    listFieldNames() {
+        return Object.keys(this.fields);
+    }
+}
+exports.GeneratedV1Prediction = GeneratedV1Prediction;

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

@@ -0,0 +1,4 @@
+export { GeneratedV1 } from "./generatedV1";
+export { GeneratedV1Document } from "./generatedV1Document";
+export { GeneratedV1Page } from "./generatedV1Page";
+export { GeneratedV1Prediction } from "./generatedV1Prediction";

package/src/product/generated/internal.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneratedV1Prediction = exports.GeneratedV1Page = exports.GeneratedV1Document = exports.GeneratedV1 = void 0;
+var generatedV1_1 = require("./generatedV1");
+Object.defineProperty(exports, "GeneratedV1", { enumerable: true, get: function () { return generatedV1_1.GeneratedV1; } });
+var generatedV1Document_1 = require("./generatedV1Document");
+Object.defineProperty(exports, "GeneratedV1Document", { enumerable: true, get: function () { return generatedV1Document_1.GeneratedV1Document; } });
+var generatedV1Page_1 = require("./generatedV1Page");
+Object.defineProperty(exports, "GeneratedV1Page", { enumerable: true, get: function () { return generatedV1Page_1.GeneratedV1Page; } });
+var generatedV1Prediction_1 = require("./generatedV1Prediction");
+Object.defineProperty(exports, "GeneratedV1Prediction", { enumerable: true, get: function () { return generatedV1Prediction_1.GeneratedV1Prediction; } });

package/src/product/index.d.ts

@@ -4,6 +4,7 @@ export { CustomV1 } from "./custom/customV1";
 export { FinancialDocumentV1 } from "./financialDocument/financialDocumentV1";
 export { InvoiceV4 } from "./invoice/invoiceV4";
 export { InvoiceSplitterV1 } from "./invoiceSplitter/invoiceSplitterV1";
+export { GeneratedV1 } from "./generated/generatedV1";
 export { MultiReceiptsDetectorV1 } from "./multiReceiptsDetector/multiReceiptsDetectorV1";
 export { PassportV1 } from "./passport/passportV1";
 export { ProofOfAddressV1 } from "./proofOfAddress/proofOfAddressV1";

package/src/product/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.us = exports.fr = exports.eu = exports.ReceiptV5 = exports.ReceiptV4 = exports.ProofOfAddressV1 = exports.PassportV1 = exports.MultiReceiptsDetectorV1 = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.FinancialDocumentV1 = exports.CustomV1 = exports.CropperV1 = exports.BarcodeReaderV1 = void 0;
+exports.us = exports.fr = exports.eu = exports.ReceiptV5 = exports.ReceiptV4 = exports.ProofOfAddressV1 = exports.PassportV1 = exports.MultiReceiptsDetectorV1 = exports.GeneratedV1 = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.FinancialDocumentV1 = exports.CustomV1 = exports.CropperV1 = exports.BarcodeReaderV1 = void 0;
 var barcodeReaderV1_1 = require("./barcodeReader/barcodeReaderV1");
 Object.defineProperty(exports, "BarcodeReaderV1", { enumerable: true, get: function () { return barcodeReaderV1_1.BarcodeReaderV1; } });
 var cropperV1_1 = require("./cropper/cropperV1");
@@ -36,6 +36,8 @@ var invoiceV4_1 = require("./invoice/invoiceV4");
 Object.defineProperty(exports, "InvoiceV4", { enumerable: true, get: function () { return invoiceV4_1.InvoiceV4; } });
 var invoiceSplitterV1_1 = require("./invoiceSplitter/invoiceSplitterV1");
 Object.defineProperty(exports, "InvoiceSplitterV1", { enumerable: true, get: function () { return invoiceSplitterV1_1.InvoiceSplitterV1; } });
+var generatedV1_1 = require("./generated/generatedV1");
+Object.defineProperty(exports, "GeneratedV1", { enumerable: true, get: function () { return generatedV1_1.GeneratedV1; } });
 var multiReceiptsDetectorV1_1 = require("./multiReceiptsDetector/multiReceiptsDetectorV1");
 Object.defineProperty(exports, "MultiReceiptsDetectorV1", { enumerable: true, get: function () { return multiReceiptsDetectorV1_1.MultiReceiptsDetectorV1; } });
 var passportV1_1 = require("./passport/passportV1");

package/src/product/internal.d.ts

@@ -1,6 +1,7 @@
 export * as barcodeReader from "./barcodeReader/internal";
 export * as cropper from "./cropper/internal";
 export * as custom from "./custom/internal";
+export * as generated from "./generated/internal";
 export * as eu from "./eu/internal";
 export * as financialDocument from "./financialDocument/internal";
 export * as fr from "./fr/internal";

package/src/product/internal.js

@@ -23,10 +23,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.us = exports.receipt = exports.proofOfAddress = exports.passport = exports.multiReceiptsDetector = exports.invoiceSplitter = exports.invoice = exports.fr = exports.financialDocument = exports.eu = exports.custom = exports.cropper = exports.barcodeReader = void 0;
+exports.us = exports.receipt = exports.proofOfAddress = exports.passport = exports.multiReceiptsDetector = exports.invoiceSplitter = exports.invoice = exports.fr = exports.financialDocument = exports.eu = exports.generated = exports.custom = exports.cropper = exports.barcodeReader = void 0;
 exports.barcodeReader = __importStar(require("./barcodeReader/internal"));
 exports.cropper = __importStar(require("./cropper/internal"));
 exports.custom = __importStar(require("./custom/internal"));
+exports.generated = __importStar(require("./generated/internal"));
 exports.eu = __importStar(require("./eu/internal"));
 exports.financialDocument = __importStar(require("./financialDocument/internal"));
 exports.fr = __importStar(require("./fr/internal"));