mindee 1.1.2 → 1.3.1

package/CHANGELOG.md

@@ -1,86 +1,107 @@
 # CHANGELOG
 
+## v1.3.1
+
+### Fixes
+* 🐛 forward api error to stderr instead of stdout
+
+## v1.3.0
+
+### Changes
+
+* :sparkles: allow sending the filename for streams and base64
+* fixes :bug: not able to specify MIME type
+* :page_facing_up: change license to MIT
+* :white_check_mark: add node18 to tests
+* various package updates
+
+## v1.2.0
+
+### Fixes
+
+* fix: 🐛 Get `words` values when `includeWords` parameter is `true`
+
 ## v1.1.2
 
 ### Fixes
 
-- fix: 🐛 Fix returned probability value
-- fix: 🐛 Fix returned bbox value
+* fix: 🐛 Fix returned probability value
+* fix: 🐛 Fix returned bbox value
 
 ### new
 
-- new: ✨ New Mindee Invoice API V3 support
-- new: ✨ Add new supplier and customer fields
+* new: ✨ New Mindee Invoice API V3 support
+* new: ✨ Add new supplier and customer fields
 
 ## v1.1.0 (2022-01-03)
 
 ### new
 
-- chg: :sparkles: New Mindee API V2 support
-- chg: :zap: Server side invoice reconstruction from multi-page pdfs
-- new: :sparkles: Added OS in User-Agent headers
+* chg: :sparkles: New Mindee API V2 support
+* chg: :zap: Server side invoice reconstruction from multi-page pdfs
+* new: :sparkles: Added OS in User-Agent headers
 
 
 ## v1.0.9 (2021-12-09)
 
 ### Fixes
 
-- fix: 🐛 handle attribute of type array when merging pages
+* fix: 🐛 handle attribute of type array when merging pages
 
 ## v1.0.8 (2021-11-29)
 
 ### Fixes
 
-- 🐛 fix cutPDF for ReadableStream + add it for base64 file string
-- 🐛 Updated api Input initialization to specifically declare parameters
-- 🐛 prevent error when the mime type isn't detectable
-- 🐛 raise proper error when the APi doesn't return a valid JSON
+* 🐛 fix cutPDF for ReadableStream + add it for base64 file string
+* 🐛 Updated api Input initialization to specifically declare parameters
+* 🐛 prevent error when the mime type isn't detectable
+* 🐛 raise proper error when the APi doesn't return a valid JSON
 
 ### new
 
-- :see_no_evil: add .DS_Store to ignore file
+* :see_no_evil: add .DS_Store to ignore file
 
 ## v1.0.7 (2021-11-25)
 
 ### New
 
-- ✨ Added pdf page number parameter for multi-pages pdfs with file
+* ✨ 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
+* :arrow_up: upgrade path-parse dependency
+* :arrow_up: upgrade browserslist dependency
+* :arrow_up: upgrade lodash dependency
+* :arrow_up: upgrade y18n dependency
 
 ## v1.0.4 (2021-02-18)
 
 ### New
 
-- :sparkles: :zap: Add a parameter `filename` and a default filename for streams
+* :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
+* :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
+* :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
+* :zap: Better coverage for total tax
 
 ### Fixes
 
-- :bug: `includeWords` is now working
+* :bug: `includeWords` is now working
 
 ## v1.0.1 (2021-01-11)
 
-- 🎉 First release
+* 🎉 First release

package/LICENSE

@@ -1,202 +1,21 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-
+MIT License
+
+Copyright (c) 2020-Present Mindee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,4 +1,4 @@
-# API SDK for Node.js
+# Mindee Client Library for Node.js
 
 # Installation
 
@@ -35,10 +35,23 @@ mindeeClient.financialDocument.parse({
 });
 ```
 
-Three apis are actually supported : invoice (`ìnvoice`), receipt (`receipt`) and financial document (`financialDocument`)
+Three APIs are actually supported: invoice (`ìnvoice`), receipt (`receipt`) and financial document (`financialDocument`)
 
 You can find more examples on how to use the SDK into the folder `examples`.
 
+## MIME Types
+When using `stream` or `base64` inputs, the MIME type is guessed using magic numbers.
+In some cases, for example with non-standard files, it will not be possible to detect the MIME type in this way.
+
+If you are getting MIME type errors, you will need to specify a file name having the correct extension, for example:
+```js
+mindeeClient.invoice.parse({
+  input: base64String,
+  inputType: "base64",
+  filename: "myfile.pdf",
+});
+```
+
 ## Client
 
 The Mindee client can take multiple parameters to be initialize.

package/dist/api/financialDocument.js

@@ -0,0 +1,51 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIFinancialDocument = void 0;
+const object_1 = require("@api/object");
+const inputs_1 = require("@mindee/inputs");
+class APIFinancialDocument extends object_1.APIObject {
+    constructor(invoiceToken, receiptToken) {
+        super(undefined, "financialDocument");
+        this.invoiceToken = invoiceToken;
+        this.receiptToken = receiptToken;
+        this.invoiceToken = invoiceToken;
+        this.receiptToken = receiptToken;
+    }
+    /**
+     * @param {String} file: Receipt filepath (allowed jpg, png, tiff, pdf)
+     * @param {String} inputType: String in {'path', 'stream', 'base64'}
+     * @param {Boolean} includeWords: extract all words into http_response
+     * @param {String} version: expense_receipt api version
+     * @param {Boolean} cutPdf: Automatically reconstruct pdf with more than 4 pages
+     * @returns {Response} Wrapped response with Receipts objects parsed
+     */
+    parse({ input, inputType = "path", filename = undefined, version = "3", cutPdf = true, includeWords = false, }) {
+        const _super = Object.create(null, {
+            parse: { get: () => super.parse },
+            _request: { get: () => super._request }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            const inputFile = new inputs_1.Input(input, inputType, cutPdf, filename);
+            yield inputFile.init();
+            this.apiToken =
+                inputFile.fileExtension === "application/pdf"
+                    ? this.invoiceToken
+                    : this.receiptToken;
+            const url = inputFile.fileExtension === "application/pdf"
+                ? `/invoices/v${version}/predict`
+                : `/expense_receipts/v${version}/predict`;
+            _super.parse.call(this);
+            return _super._request.call(this, url, inputFile, includeWords);
+        });
+    }
+}
+exports.APIFinancialDocument = APIFinancialDocument;

package/dist/api/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIInvoice = exports.request = exports.Response = exports.APIReceipt = exports.APIObject = void 0;
+var object_1 = require("@api/object");
+Object.defineProperty(exports, "APIObject", { enumerable: true, get: function () { return object_1.APIObject; } });
+var receipt_1 = require("@api/receipt");
+Object.defineProperty(exports, "APIReceipt", { enumerable: true, get: function () { return receipt_1.APIReceipt; } });
+var response_1 = require("@api/response");
+Object.defineProperty(exports, "Response", { enumerable: true, get: function () { return response_1.Response; } });
+var request_1 = require("@api/request");
+Object.defineProperty(exports, "request", { enumerable: true, get: function () { return request_1.request; } });
+var invoice_1 = require("@api/invoice");
+Object.defineProperty(exports, "APIInvoice", { enumerable: true, get: function () { return invoice_1.APIInvoice; } });

package/dist/api/invoice.js

@@ -0,0 +1,59 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIInvoice = void 0;
+const object_1 = require("@api/object");
+const inputs_1 = require("@mindee/inputs");
+class APIInvoice extends object_1.APIObject {
+    constructor(apiToken = undefined) {
+        super(apiToken, "invoice");
+        this.apiToken = apiToken;
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore TO DO : FIX
+        this.baseUrl = `${this.baseUrl}/invoices/`;
+    }
+    /**
+     * @param {Boolean} includeWords: , extract all words into http_response
+     * @param {Boolean} cutPdf: Automatically reconstruct pdf with more than 4 pages
+     * @param {String} inputType: String in {'path', 'stream', 'base64'}
+     * @param {String} file: Receipt filepath (allowed jpg, png, tiff, pdf)
+     * @param {String} version: expense_receipt api version
+     * @returns {Response} Wrapped response with Receipts objects parsed
+     */
+    parse({ input, inputType = "path", filename = undefined, version = "3", cutPdf = true, includeWords = false, }) {
+        const _super = Object.create(null, {
+            parse: { get: () => super.parse },
+            _request: { get: () => super._request }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            _super.parse.call(this);
+            const inputFile = new inputs_1.Input(input, inputType, cutPdf, filename);
+            yield inputFile.init();
+            const url = `v${version}/predict`;
+            return yield _super._request.call(this, url, inputFile, includeWords);
+        });
+    }
+    /**
+      @param {String} inputFile - Input object
+      @param {} response - HTTP response
+      @param {Document} documentType - Document class in {"Receipt", "Invoice", "Financial_document"}
+      @returns {Response}
+    */
+    wrapResponse(inputFile, response, documentType) {
+        var _a, _b, _c, _d, _e;
+        const result = super.wrapResponse(inputFile, response, documentType);
+        result.documentType =
+            ((_e = (_d = (_c = (_b = (_a = result.httpResponse.data) === null || _a === void 0 ? void 0 : _a.predictions) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.document_type) === null || _d === void 0 ? void 0 : _d.value) === null || _e === void 0 ? void 0 : _e.toLowerCase()) ||
+                result.documentType;
+        return result;
+    }
+}
+exports.APIInvoice = APIInvoice;

package/dist/api/object.js

@@ -0,0 +1,80 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIObject = void 0;
+const response_1 = require("@api/response");
+const handler_1 = require("@errors/handler");
+const request_1 = require("@api/request");
+/**
+ * Base class for APIs (APIReceipt & APIInvoice)
+ *  @param {String} apiToken - Token of the API used for parsing document
+ *  @param {String} apiName - Name of the API used for parsing document
+ */
+class APIObject {
+    constructor(apiToken = undefined, apiName = "") {
+        this.apiToken = apiToken;
+        this.apiName = apiName;
+        this.apiToken = apiToken;
+        this.baseUrl = "https://api.mindee.net/v1/products/mindee";
+        this.apiName = apiName;
+    }
+    /**
+     */
+    parse() {
+        if (!this.apiToken) {
+            handler_1.errorHandler.throw({
+                error: new Error(`Missing API token for ${this.apiName}. \
+          Have you create a mindee Client with a ${this.apiName}Token in parameters ?`),
+            });
+        }
+    }
+    /**
+      @param {String} url - API url for request
+      @param {Input} inputFile - input file for API
+      @param {Boolean} includeWords - Include Mindee vision words in Response
+      @returns {Response}
+    */
+    _request(url, inputFile, includeWords = false) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const headers = {
+                "X-Inferuser-Token": this.apiToken,
+            };
+            const response = yield (0, request_1.request)(`${this.baseUrl}${url}`, "POST", headers, inputFile, includeWords);
+            return this.wrapResponse(inputFile, response, this.apiName);
+        });
+    }
+    /**
+      @param {String} inputFile - Input object
+      @param {} response - HTTP response
+      @param {Document} documentType - Document class in {"Receipt", "Invoice", "Financial_document"}
+      @returns {Response}
+    */
+    wrapResponse(inputFile, response, documentType) {
+        if (response.statusCode > 201) {
+            const errorMessage = JSON.stringify(response.data, null, 4);
+            handler_1.errorHandler.throw(new Error(`${this.apiName} API ${response.statusCode} HTTP error: ${errorMessage}`));
+            return new response_1.Response({
+                httpResponse: response,
+                documentType: documentType,
+                document: undefined,
+                input: inputFile,
+                error: true,
+            });
+        }
+        return new response_1.Response({
+            httpResponse: response,
+            documentType: documentType,
+            document: inputFile,
+            input: inputFile,
+        });
+    }
+}
+exports.APIObject = APIObject;

package/dist/api/receipt.js

@@ -0,0 +1,45 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIReceipt = void 0;
+const object_1 = require("@api/object");
+const inputs_1 = require("@mindee/inputs");
+class APIReceipt extends object_1.APIObject {
+    constructor(apiToken = undefined) {
+        super(apiToken, "receipt");
+        this.apiToken = apiToken;
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore TO DO : FIX
+        this.baseUrl = `${this.baseUrl}/expense_receipts/`;
+    }
+    /**
+     * @param {String} file: Receipt filepath (allowed jpg, png, tiff, pdf)
+     * @param {String} inputType: String in {'path', 'stream', 'base64'}
+     * @param {Boolean} includeWords: extract all words into http_response
+     * @param {String} version: expense_receipt api version
+     * @param {Boolean} cutPdf: Automatically reconstruct pdf with more than 4 pages
+     * @returns {Response} Wrapped response with Receipts objects parsed
+     */
+    parse({ input, inputType = "path", filename = undefined, version = "3", cutPdf = true, includeWords = false, }) {
+        const _super = Object.create(null, {
+            parse: { get: () => super.parse },
+            _request: { get: () => super._request }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            _super.parse.call(this);
+            const inputFile = new inputs_1.Input(input, inputType, cutPdf, filename);
+            yield inputFile.init();
+            const url = `v${version}/predict`;
+            return yield _super._request.call(this, url, inputFile, includeWords);
+        });
+    }
+}
+exports.APIReceipt = APIReceipt;