mindee 4.36.2 → 5.0.0-alpha1

package/src/cli.js

@@ -1,264 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cli = cli;
-const commander_1 = require("commander");
-const client_1 = require("./client");
-const input_1 = require("./input");
-const console = __importStar(require("console"));
-const cliProducts_1 = require("./cliProducts");
-const program = new commander_1.Command();
-//
-// EXECUTE THE COMMANDS
-//
-function initClient(options) {
-    return new client_1.Client({
-        apiKey: options.apiKey,
-        debug: options.debug,
-    });
-}
-function getConfig(command) {
-    const conf = cliProducts_1.CLI_COMMAND_CONFIG.get(command);
-    if (conf === undefined) {
-        throw new Error(`Invalid document type ${command}`);
-    }
-    return conf;
-}
-function getPageOptions(options) {
-    let pageOptions = undefined;
-    if (options.cutPages) {
-        pageOptions = {
-            operation: input_1.PageOptionsOperation.KeepOnly,
-            pageIndexes: [0, 1, 2, 3, 4],
-            onMinPages: 5,
-        };
-    }
-    return pageOptions;
-}
-function getPredictParams(options) {
-    return {
-        allWords: options.allWords,
-        cropper: options.cropper,
-    };
-}
-async function callParse(productClass, command, inputPath, options) {
-    const mindeeClient = initClient(options);
-    const predictParams = getPredictParams(options);
-    const pageOptions = getPageOptions(options);
-    const inputSource = new input_1.PathInput({ inputPath: inputPath });
-    let response;
-    if (command === cliProducts_1.COMMAND_CUSTOM || command === cliProducts_1.COMMAND_GENERATED) {
-        const customEndpoint = mindeeClient.createEndpoint(options.endpoint, options.account, options.version);
-        response = await mindeeClient.parse(productClass, inputSource, {
-            endpoint: customEndpoint,
-            pageOptions: pageOptions,
-            allWords: predictParams.allWords,
-            cropper: predictParams.cropper,
-        });
-    }
-    else {
-        response = await mindeeClient.parse(productClass, inputSource, {
-            pageOptions: pageOptions,
-            allWords: predictParams.allWords,
-            cropper: predictParams.cropper,
-        });
-    }
-    printResponse(response.document, options);
-}
-async function callEnqueueAndParse(productClass, command, inputPath, options) {
-    const mindeeClient = initClient(options);
-    const predictParams = getPredictParams(options);
-    const pageOptions = getPageOptions(options);
-    const inputSource = new input_1.PathInput({ inputPath: inputPath });
-    let response;
-    if (command === cliProducts_1.COMMAND_CUSTOM || command === cliProducts_1.COMMAND_GENERATED) {
-        const customEndpoint = mindeeClient.createEndpoint(options.endpoint, options.account, options.version);
-        response = await mindeeClient.enqueueAndParse(productClass, inputSource, {
-            endpoint: customEndpoint,
-            pageOptions: pageOptions,
-            allWords: predictParams.allWords,
-            cropper: predictParams.cropper,
-            initialDelaySec: 2,
-            delaySec: 1.5,
-            maxRetries: 80,
-        });
-    }
-    else {
-        response = await mindeeClient.enqueueAndParse(productClass, inputSource, {
-            pageOptions: pageOptions,
-            allWords: predictParams.allWords,
-            cropper: predictParams.cropper,
-            initialDelaySec: 2,
-            delaySec: 1.5,
-            maxRetries: 80,
-        });
-        if (!response.document) {
-            throw Error("Document could not be retrieved");
-        }
-        printResponse(response.document, options);
-    }
-}
-async function callGetDocument(productClass, documentId, options) {
-    const mindeeClient = initClient(options);
-    const response = await mindeeClient.getDocument(productClass, documentId);
-    printResponse(response.document, options);
-}
-async function callSendFeedback(productClass, documentId, feedbackStr, options) {
-    const mindeeClient = initClient(options);
-    const feedback = {
-        feedback: JSON.parse(feedbackStr),
-    };
-    const response = await mindeeClient.sendFeedback(productClass, documentId, feedback);
-    console.log(response.feedback);
-}
-function printResponse(document, options) {
-    if (options.allWords) {
-        document.ocr?.mVisionV1.pages.forEach((page) => {
-            console.log(page.allWords.toString());
-        });
-    }
-    if (options.pages) {
-        document.inference.pages.forEach((page) => {
-            console.log(`\n${page}`);
-        });
-    }
-    if (document) {
-        console.log(`\n${document}`);
-    }
-}
-//
-// BUILD THE COMMANDS
-//
-function addMainOptions(prog) {
-    prog.option("-k, --api-key <api_key>", "API key for document endpoint");
-}
-function addPostOptions(prog, info) {
-    prog.option("-c, --cut-pages", "keep only the first 5 pages of the document");
-    if (info.allWords) {
-        prog.option("-w, --all-words", "to get all the words in the current document. False by default.");
-    }
-    prog.argument("<input_path>", "full path to the file");
-}
-function addCustomPostOptions(prog) {
-    prog.requiredOption("-e, --endpoint <endpoint_name>", "API endpoint name (required)");
-    prog.requiredOption("-a, --account <account_name>", "API account name for the endpoint (required)");
-    prog.option("-v, --version <version>", "version for the endpoint, use the latest version if not specified");
-}
-function addDisplayOptions(prog) {
-    prog.option("-p, --pages", "show content of individual pages");
-}
-function routeSwitchboard(command, inputPath, allOptions) {
-    if (command.parent === null || command.parent === undefined) {
-        throw new Error(`Improperly configured command: ${command.name()}`);
-    }
-    const docClass = getConfig(command.parent.name()).docClass;
-    if ("async" in command.opts() && command.opts()["async"]) {
-        return callEnqueueAndParse(docClass, command.name(), inputPath, allOptions);
-    }
-    return callParse(docClass, command.name(), inputPath, allOptions);
-}
-function addPredictAction(prog) {
-    if (prog.name() === cliProducts_1.COMMAND_CUSTOM || prog.name() === cliProducts_1.COMMAND_GENERATED) {
-        prog.action(function (inputPath, options, command) {
-            const allOptions = {
-                ...prog.parent?.parent?.opts(),
-                ...prog.parent?.opts(),
-                ...prog.opts(),
-                ...options,
-            };
-            return routeSwitchboard(command, inputPath, allOptions);
-        });
-    }
-    else {
-        prog.action(function (inputPath, options, command) {
-            const allOptions = {
-                ...prog.parent?.parent?.opts(),
-                ...prog.parent?.opts(),
-                ...prog.opts(),
-                ...options,
-            };
-            return routeSwitchboard(command, inputPath, allOptions);
-        });
-    }
-}
-function cli() {
-    program.name("mindee")
-        .description("Command line interface for Mindee products.")
-        .option("-d, --debug", "high verbosity mode");
-    cliProducts_1.CLI_COMMAND_CONFIG.forEach((info, name) => {
-        const productCmd = program.command(name)
-            .description(info.displayName);
-        if (info.async) {
-            const getDocProductCmd = productCmd.command("fetch")
-                .description("Fetch previously parsed results.")
-                .argument("<documentId>", "Unique ID of the document.")
-                .action(async (documentId, options) => {
-                const docClass = getConfig(name).docClass;
-                await callGetDocument(docClass, documentId, { ...options, ...productCmd.opts(), ...program.opts() });
-            });
-            addMainOptions(getDocProductCmd);
-        }
-        const feedbackProductCmd = productCmd.command("feedback")
-            .description("Send feedback for a document.")
-            .argument("<documentId>", "Unique ID of the document.")
-            .argument("<feedback>", "Feedback to send, ex '{\"key\": \"value\"}'.")
-            .action(async (documentId, feedback, options) => {
-            const docClass = getConfig(name).docClass;
-            await callSendFeedback(docClass, documentId, feedback, { ...options, ...productCmd.opts(), ...program.opts() });
-        });
-        addMainOptions(feedbackProductCmd);
-        const predictProductCmd = productCmd.command("parse")
-            .description("Send a file for parsing.");
-        if (info.async) {
-            const asyncOpt = new commander_1.Option("-A, --async", "Call asynchronously");
-            if (info.sync) {
-                asyncOpt.default(false);
-            }
-            else {
-                asyncOpt.default(true);
-                asyncOpt.hideHelp();
-            }
-            predictProductCmd.addOption(asyncOpt);
-        }
-        if (name === cliProducts_1.COMMAND_CUSTOM || name === cliProducts_1.COMMAND_GENERATED) {
-            addCustomPostOptions(predictProductCmd);
-        }
-        addMainOptions(predictProductCmd);
-        addDisplayOptions(predictProductCmd);
-        addPostOptions(predictProductCmd, info);
-        addPredictAction(predictProductCmd);
-    });
-    program.parse(process.argv);
-}

package/src/cliProducts.d.ts

@@ -1,11 +0,0 @@
-import { Inference, StringDict } from "./parsing/common";
-export declare const COMMAND_CUSTOM = "custom";
-export declare const COMMAND_GENERATED = "generated";
-export interface ProductConfig<T extends Inference = Inference> {
-    displayName: string;
-    docClass: new (rawPrediction: StringDict) => T;
-    allWords: boolean;
-    async: boolean;
-    sync: boolean;
-}
-export declare const CLI_COMMAND_CONFIG: Map<string, ProductConfig<Inference<import("./parsing/common").Prediction, import("./parsing/common").Prediction>>>;

package/src/cliProducts.js

@@ -1,316 +0,0 @@
-"use strict";
-//
-// PRODUCT CONFIGURATION
-//
-// The Map's key is the command name as it will appear on the console.
-//
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CLI_COMMAND_CONFIG = exports.COMMAND_GENERATED = exports.COMMAND_CUSTOM = void 0;
-const product = __importStar(require("./product"));
-exports.COMMAND_CUSTOM = "custom";
-exports.COMMAND_GENERATED = "generated";
-exports.CLI_COMMAND_CONFIG = new Map([
-    [
-        exports.COMMAND_CUSTOM,
-        {
-            displayName: "Custom Document",
-            docClass: product.CustomV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        exports.COMMAND_GENERATED,
-        {
-            displayName: "Generated Document",
-            docClass: product.GeneratedV1,
-            allWords: true,
-            async: true,
-            sync: true,
-        },
-    ],
-    [
-        "barcode-reader",
-        {
-            displayName: "Barcode Reader",
-            docClass: product.BarcodeReaderV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "bill-of-lading",
-        {
-            displayName: "Bill of Lading",
-            docClass: product.BillOfLadingV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "business-card",
-        {
-            displayName: "Business Card",
-            docClass: product.BusinessCardV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "cropper",
-        {
-            displayName: "Cropper",
-            docClass: product.CropperV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "delivery-note",
-        {
-            displayName: "Delivery note",
-            docClass: product.DeliveryNoteV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "driver-license",
-        {
-            displayName: "Driver License",
-            docClass: product.DriverLicenseV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "financial-document",
-        {
-            displayName: "Financial Document",
-            docClass: product.FinancialDocumentV1,
-            allWords: true,
-            async: true,
-            sync: true,
-        },
-    ],
-    [
-        "fr-bank-account-details",
-        {
-            displayName: "FR Bank Account Details",
-            docClass: product.fr.BankAccountDetailsV2,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "fr-carte-grise",
-        {
-            displayName: "FR Carte Grise",
-            docClass: product.fr.CarteGriseV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "fr-energy-bill",
-        {
-            displayName: "FR Energy Bill",
-            docClass: product.fr.EnergyBillV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "fr-health-card",
-        {
-            displayName: "FR Health Card",
-            docClass: product.fr.HealthCardV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "fr-carte-nationale-d-identite",
-        {
-            displayName: "FR Carte Nationale d'Identité",
-            docClass: product.fr.IdCardV2,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "fr-payslip",
-        {
-            displayName: "FR Payslip",
-            docClass: product.fr.PayslipV3,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "ind-passport-india",
-        {
-            displayName: "IND Passport - India",
-            docClass: product.ind.IndianPassportV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "international-id",
-        {
-            displayName: "International ID",
-            docClass: product.InternationalIdV2,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "invoice",
-        {
-            displayName: "Invoice",
-            docClass: product.InvoiceV4,
-            allWords: true,
-            async: true,
-            sync: true,
-        },
-    ],
-    [
-        "invoice-splitter",
-        {
-            displayName: "Invoice Splitter",
-            docClass: product.InvoiceSplitterV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "multi-receipts-detector",
-        {
-            displayName: "Multi Receipts Detector",
-            docClass: product.MultiReceiptsDetectorV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "nutrition-facts-label",
-        {
-            displayName: "Nutrition Facts Label",
-            docClass: product.NutritionFactsLabelV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "passport",
-        {
-            displayName: "Passport",
-            docClass: product.PassportV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "receipt",
-        {
-            displayName: "Receipt",
-            docClass: product.ReceiptV5,
-            allWords: true,
-            async: true,
-            sync: true,
-        },
-    ],
-    [
-        "resume",
-        {
-            displayName: "Resume",
-            docClass: product.ResumeV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "us-bank-check",
-        {
-            displayName: "US Bank Check",
-            docClass: product.us.BankCheckV1,
-            allWords: false,
-            async: false,
-            sync: true,
-        },
-    ],
-    [
-        "us-healthcare-card",
-        {
-            displayName: "US Healthcare Card",
-            docClass: product.us.HealthcareCardV1,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-    [
-        "us-us-mail",
-        {
-            displayName: "US US Mail",
-            docClass: product.us.UsMailV3,
-            allWords: false,
-            async: true,
-            sync: false,
-        },
-    ],
-]);