mindee - npm Package Compare versions

Comparing version 4.7.0 to 4.8.0

CHANGELOG.md

 # 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
@@ -4,0 +21,0 @@ ### Changes

package.json

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

src/cli.js

@@ -34,2 +34,3 @@ "use strict";
 const COMMAND_CUSTOM = "custom";
+const COMMAND_GENERATED = "generated";
 //
@@ -52,2 +53,12 @@ // PRODUCT CONFIGURATION
     [
+        COMMAND_GENERATED,
+        {
+            displayName: "Generated Document",
+            docClass: product.GeneratedV1,
+            allWords: true,
+            async: true,
+            sync: true,
+        },
+    ],
+    [
         "cropper",
@@ -202,3 +213,3 @@ {
     let response;
-    if (command === COMMAND_CUSTOM) {
+    if (command === COMMAND_CUSTOM || command === COMMAND_GENERATED) {
         const customEndpoint = mindeeClient.createEndpoint(options.endpoint, options.account, options.version);
@@ -227,3 +238,3 @@ response = await mindeeClient.parse(productClass, inputSource, {
     let response;
-    if (command === COMMAND_CUSTOM) {
+    if (command === COMMAND_CUSTOM || command === COMMAND_GENERATED) {
         const customEndpoint = mindeeClient.createEndpoint(options.endpoint, options.account, options.version);
@@ -315,3 +326,3 @@ response = await mindeeClient.enqueueAndParse(productClass, inputSource, {
 function addPredictAction(prog) {
-    if (prog.name() === COMMAND_CUSTOM) {
+    if (prog.name() === COMMAND_CUSTOM || prog.name() === COMMAND_GENERATED) {
         prog.action(function (inputPath, options, command) {
@@ -378,3 +389,3 @@ const allOptions = {
         }
-        if (name === COMMAND_CUSTOM) {
+        if (name === COMMAND_CUSTOM || name === COMMAND_GENERATED) {
             addCustomPostOptions(predictProductCmd);
@@ -381,0 +392,0 @@ }

src/index.d.ts

 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";

src/index.js

@@ -26,3 +26,3 @@ "use strict";
 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"));
@@ -34,2 +34,4 @@ var client_1 = require("./client");
 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; } });
@@ -36,0 +38,0 @@ Object.defineProperty(exports, "Page", { enumerable: true, get: function () { return common_1.Page; } });

src/parsing/index.d.ts

 export * as common from "./common";
 export * as custom from "./custom";
 export * as standard from "./standard";
+export * as generated from "./generated";

src/parsing/index.js

@@ -26,5 +26,6 @@ "use strict";
 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"));

src/product/custom/customV1Document.d.ts

@@ -7,5 +7,5 @@ import { StringDict, Prediction } from "../../parsing/common";
 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>;
@@ -12,0 +12,0 @@ constructor(rawPrediction: StringDict, pageId?: number);

src/product/custom/customV1Document.js

@@ -11,5 +11,5 @@ "use strict";
     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();
@@ -16,0 +16,0 @@ Object.entries(rawPrediction).forEach(([fieldName, fieldValue]) => {

src/product/custom/customV1Page.d.ts

@@ -7,3 +7,3 @@ import { StringDict, Prediction } from "../../parsing/common";
 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>;
@@ -10,0 +10,0 @@ constructor(rawPrediction: StringDict, pageId?: number);

src/product/custom/customV1Page.js

@@ -11,3 +11,3 @@ "use strict";
     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();
@@ -14,0 +14,0 @@ Object.entries(rawPrediction).forEach(([fieldName, fieldValue]) => {

src/product/index.d.ts

@@ -7,2 +7,3 @@ export { BarcodeReaderV1 } from "./barcodeReader/barcodeReaderV1";
 export { InvoiceSplitterV1 } from "./invoiceSplitter/invoiceSplitterV1";
+export { GeneratedV1 } from "./generated/generatedV1";
 export { MultiReceiptsDetectorV1 } from "./multiReceiptsDetector/multiReceiptsDetectorV1";
@@ -9,0 +10,0 @@ export { PassportV1 } from "./passport/passportV1";

src/product/index.js

@@ -26,3 +26,3 @@ "use strict";
 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");
@@ -40,2 +40,4 @@ Object.defineProperty(exports, "BarcodeReaderV1", { enumerable: true, get: function () { return barcodeReaderV1_1.BarcodeReaderV1; } });
 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");
@@ -42,0 +44,0 @@ Object.defineProperty(exports, "MultiReceiptsDetectorV1", { enumerable: true, get: function () { return multiReceiptsDetectorV1_1.MultiReceiptsDetectorV1; } });

src/product/internal.d.ts

 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";
@@ -5,0 +6,0 @@ export * as financialDocument from "./financialDocument/internal";

src/product/internal.js

@@ -26,6 +26,7 @@ "use strict";
 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"));
@@ -32,0 +33,0 @@ exports.financialDocument = __importStar(require("./financialDocument/internal"));

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

426216

increased by5.08%

Number of package files

322

increased by5.23%

Lines of code

9925

increased by5.02%

No dependency changes