mindee 1.0.2 → 1.0.7

package/CHANGELOG.md

@@ -1,11 +1,42 @@
 # CHANGELOG
 
-## v1.0.2 (11/01/2021)
+## v1.0.7 (2021-11-25)
 
-chg: :sparkles: Better coverage for total tax
-fix: :bug: includeWords is now working
+### New
+- ✨ Added pdf page number parameter for multi-pages pdfs with file
 
+### Changes
+- :arrow_up: upgrade path-parse dependency
+- :arrow_up: upgrade browserslist dependency
+- :arrow_up: upgrade lodash dependency
+- :arrow_up: upgrade y18n dependency
 
-## v1.0.1 (11/01/2021)
+## v1.0.4 (2021-02-18)
 
-🎉 First release
+### New
+* :sparkles: :zap: Add a parameter `filename` and a default filename for streams
+
+### Changes
+* :zap: Change parse function to use an object instead of multiples parameters
+
+
+## v1.0.3 (2021-02-01)
+
+### Fixes
+* :bug: _request parameters
+* :bug: `pageNumber` default value
+* :bug: reconstruction method set fields to probability
+
+
+## v1.0.2 (2021-02-01)
+
+### Changes
+* :zap: Better coverage for total tax
+
+### Fixes
+* :bug: `includeWords` is now working
+
+
+## v1.0.1 (2021-01-11)
+
+* 🎉 First release

package/README.md

@@ -17,14 +17,17 @@ You can use the SDK easily by creating a Client like this :
 ```js
 const { Client } = require("mindee");
 
-const mindeeClient = Client({
+const mindeeClient = new Client({
   invoiceToken: "invoiceApiToken",
   receiptToken: "receiptExpenseApiToken",
 });
 
-mindeeClient.invoice.parse("path/to/file", "file");
-mindeeClient.receipt.parse(base64String, "base64");
-mindeeClient.financialDocument.parse(base64String, "base64");
+mindeeClient.invoice.parse({ input: "path/to/file", inputType: "file" });
+mindeeClient.receipt.parse({ input: base64String, inputType: "base64" });
+mindeeClient.financialDocument.parse({
+  input: base64String,
+  inputType: "base64",
+});
 ```
 
 Three apis are actually supported : invoice (`ìnvoice`), receipt (`receipt`) and financial document (`financialDocument`)
@@ -54,7 +57,7 @@ const mindeeClient = new Client();
 
 // parsing invoice from pdf
 mindeeClient.invoice
-  .parse("./documents/invoices/invoice.pdf") // see examples for more input types
+  .parse({ input: "./documents/invoices/invoice.pdf" }) // see examples for more input types
   .then((res) => {
     console.log("Success !");
     console.log(res.invoices);
@@ -66,6 +69,7 @@ mindeeClient.invoice
 ```
 
 ## Parsing receipts
+
 ```js
 const { Client } = require("mindee");
 const fs = require("fs");
@@ -75,7 +79,7 @@ const mindeeClient = new Client();
 
 // parsing receipt from picture
 mindeeClient.receipt
-  .parse("./documents/receipts/receipt.jpg") // see examples for more input types
+  .parse({ input: "./documents/receipts/receipt.jpg" }) // see examples for more input types
   .then((res) => {
     console.log("Success !");
     console.log(res.receipts);
@@ -101,7 +105,7 @@ const mindeeClient = new Client();
 
 // parsing receipt from picture
 mindeeClient.financialDocument
-  .parse("./documents/receipts/receipt.jpg")
+  .parse({ input: "./documents/receipts/receipt.jpg" })
   .then((res) => {
     console.log("Success !");
     console.log(res.financialDocuments);
@@ -110,7 +114,6 @@ mindeeClient.financialDocument
   .catch((err) => {
     console.error(err);
   });
-
 ```
 
 # Tests