mindee 1.3.3 → 1.4.0

package/lib/documents/receipt.js

@@ -1,332 +0,0 @@
-"use strict";
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
-
-function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
-
-function _classPrivateMethodGet(receiver, privateSet, fn) { if (!privateSet.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return fn; }
-
-var Document = require("./document");
-
-var Field = require("./fields").field;
-
-var Date = require("./fields").date;
-
-var Amount = require("./fields").amount;
-
-var Locale = require("./fields").locale;
-
-var Orientation = require("./fields").orientation;
-
-var Tax = require("./fields").tax;
-
-var fs = require("fs").promises;
-
-var _initFromScratch = new WeakSet();
-
-var _initFromApiPrediction = new WeakSet();
-
-var _checklist = new WeakSet();
-
-var _taxesMatchTotal = new WeakSet();
-
-var _reconstruct = new WeakSet();
-
-var _reconstructTotalExclFromTCCAndTaxes = new WeakSet();
-
-var _reconstructTotalTax = new WeakSet();
-
-class Receipt extends Document {
-  /**
-   *  @param {Object} apiPrediction - Json parsed prediction from HTTP response
-   *  @param {Input} input - Input object
-   *  @param {Integer} pageNumber - Page number for multi pages pdf input
-   *  @param {Object} locale - locale value for creating Receipt object from scratch
-   *  @param {Object} totalIncl - total tax Included value for creating Receipt object from scratch
-   *  @param {Object} date - date value for creating Receipt object from scratch
-   *  @param {Object} category - category value for creating Receipt object from scratch
-   *  @param {Object} merchantName - merchant name value for creating Receipt object from scratch
-   *  @param {Object} time - time value for creating Receipt object from scratch
-   *  @param {Object} taxes - taxes value for creating Receipt object from scratch
-   *  @param {Object} orientation - orientation value for creating Receipt object from scratch
-   *  @param {Object} totalTax - total taxes value for creating Receipt object from scratch
-   *  @param {Object} totalExcl - total taxes excluded value for creating Receipt object from scratch
-   *  @param {String} level - specify whether object is built from "page" level or "document" level prediction
-   */
-  constructor(_ref) {
-    var {
-      apiPrediction: _apiPrediction = undefined,
-      inputFile = undefined,
-      locale: _locale = undefined,
-      totalIncl: _totalIncl = undefined,
-      date: _date = undefined,
-      category: _category = undefined,
-      merchantName: _merchantName = undefined,
-      time: _time = undefined,
-      taxes: _taxes = undefined,
-      orientation: _orientation = undefined,
-      totalTax: _totalTax = undefined,
-      totalExcl: _totalExcl = undefined,
-      pageNumber: _pageNumber = 0,
-      level = "page"
-    } = _ref;
-    super(inputFile);
-
-    _reconstructTotalTax.add(this);
-
-    _reconstructTotalExclFromTCCAndTaxes.add(this);
-
-    _reconstruct.add(this);
-
-    _taxesMatchTotal.add(this);
-
-    _checklist.add(this);
-
-    _initFromApiPrediction.add(this);
-
-    _initFromScratch.add(this);
-
-    this.level = level;
-
-    this.constructPrediction = function (item) {
-      return {
-        prediction: {
-          value: item
-        },
-        valueKey: "value",
-        pageNumber: _pageNumber
-      };
-    };
-
-    if (_apiPrediction === undefined) {
-      _classPrivateMethodGet(this, _initFromScratch, _initFromScratch2).call(this, {
-        locale: _locale,
-        totalExcl: _totalExcl,
-        totalIncl: _totalIncl,
-        date: _date,
-        category: _category,
-        merchantName: _merchantName,
-        time: _time,
-        taxes: _taxes,
-        orientation: _orientation,
-        totalTax: _totalTax,
-        pageNumber: _pageNumber
-      });
-    } else {
-      _classPrivateMethodGet(this, _initFromApiPrediction, _initFromApiPrediction2).call(this, _apiPrediction, _pageNumber);
-    }
-
-    _classPrivateMethodGet(this, _checklist, _checklist2).call(this);
-
-    _classPrivateMethodGet(this, _reconstruct, _reconstruct2).call(this);
-  }
-
-  toString() {
-    return "\n    -----Receipt data-----\n    Filename: ".concat(this.filename, "\n    Total amount: ").concat(this.totalIncl.value, "\n    Date: ").concat(this.date.value, "\n    Category: ").concat(this.category.value, "\n    Time: ").concat(this.time.value, "\n    Merchant name: ").concat(this.merchantName.value, "\n    Taxes: ").concat(this.taxes.map(tax => tax.toString()).join(" - "), "\n    Total taxes: ").concat(this.totalTax.value, "\n    ");
-  }
-
-  static load(path) {
-    return _asyncToGenerator(function* () {
-      var file = fs.readFile(path);
-      var args = JSON.parse(file);
-      return new Receipt(_objectSpread({
-        reconsctruted: true
-      }, args));
-    })();
-  }
-  /**
-   * Call all check methods
-   */
-
-
-}
-
-var _initFromScratch2 = function _initFromScratch2(_ref2) {
-  var {
-    locale,
-    totalExcl,
-    totalIncl,
-    date,
-    category,
-    merchantName,
-    time,
-    taxes,
-    orientation,
-    totalTax,
-    pageNumber
-  } = _ref2;
-  this.locale = new Locale(this.constructPrediction(locale));
-  this.totalIncl = new Amount(this.constructPrediction(totalIncl));
-  this.date = new Date(this.constructPrediction(date));
-  this.category = new Field(this.constructPrediction(category));
-  this.merchantName = new Field(this.constructPrediction(merchantName));
-  this.time = new Field(this.constructPrediction(time));
-
-  if (taxes !== undefined) {
-    this.taxes = [];
-
-    for (var t of taxes) {
-      this.taxes.push(new Tax({
-        prediction: {
-          value: t[0],
-          rate: t[1]
-        },
-        pageNumber,
-        valueKey: "value",
-        rateKey: "rate"
-      }));
-    }
-  }
-
-  this.orientation = new Orientation(this.constructPrediction(orientation));
-  this.totalTax = new Amount(this.constructPrediction(totalTax));
-  this.totalExcl = new Amount(this.constructPrediction(totalExcl));
-};
-
-var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, pageNumber) {
-  this.words = [];
-  this.locale = new Locale({
-    prediction: apiPrediction.locale,
-    pageNumber
-  });
-  this.totalIncl = new Amount({
-    prediction: apiPrediction.total_incl,
-    valueKey: "value",
-    pageNumber
-  });
-  this.date = new Date({
-    prediction: apiPrediction.date,
-    valueKey: "value",
-    pageNumber
-  });
-  this.category = new Field({
-    prediction: apiPrediction.category,
-    pageNumber
-  });
-  this.merchantName = new Field({
-    prediction: apiPrediction.supplier,
-    valueKey: "value",
-    pageNumber
-  });
-  this.time = new Field({
-    prediction: apiPrediction.time,
-    valueKey: "value",
-    pageNumber
-  });
-  this.taxes = apiPrediction.taxes.map(taxPrediction => new Tax({
-    prediction: taxPrediction,
-    pageNumber,
-    valueKey: "value",
-    rateKey: "rate",
-    codeKey: "code"
-  }));
-  this.totalTax = new Amount({
-    prediction: {
-      value: undefined,
-      probability: 0
-    },
-    valueKey: "value",
-    pageNumber
-  });
-  this.totalExcl = new Amount({
-    prediction: {
-      value: undefined,
-      probability: 0
-    },
-    valueKey: "value",
-    pageNumber
-  });
-
-  if (this.level === "page") {
-    this.orientation = new Orientation({
-      prediction: apiPrediction.orientation,
-      pageNumber
-    });
-  } else {
-    this.orientation = new Orientation(this.constructPrediction({
-      prediction: {
-        value: undefined,
-        probability: 0.0,
-        degrees: undefined
-      }
-    }));
-  }
-
-  if ("mvision" in apiPrediction) this.words = apiPrediction.mvision;
-};
-
-var _checklist2 = function _checklist2() {
-  this.checklist = {
-    taxesMatchTotalIncl: _classPrivateMethodGet(this, _taxesMatchTotal, _taxesMatchTotal2).call(this)
-  };
-};
-
-var _taxesMatchTotal2 = function _taxesMatchTotal2() {
-  // Check taxes and total amount exist
-  if (this.taxes.length === 0 || this.totalIncl.value == null) return false; // Reconstruct total_incl from taxes
-
-  var totalVat = 0;
-  var reconstructedTotal = 0;
-  this.taxes.forEach(tax => {
-    if (tax.value == null || !tax.rate) return false;
-    totalVat += tax.value;
-    reconstructedTotal += tax.value + 100 * tax.value / tax.rate;
-  }); // Sanity check
-
-  if (totalVat <= 0) return false; // Crate epsilon
-
-  var eps = 1 / (100 * totalVat);
-
-  if (this.totalIncl.value * (1 - eps) - 0.02 <= reconstructedTotal && reconstructedTotal <= this.totalIncl.value * (1 + eps) + 0.02) {
-    this.taxes = this.taxes.map(tax => _objectSpread(_objectSpread({}, tax), {}, {
-      probability: 1.0
-    }));
-    this.totalTax.probability = 1.0;
-    this.totalIncl.probability = 1.0;
-    return true;
-  }
-
-  return false;
-};
-
-var _reconstruct2 = function _reconstruct2() {
-  _classPrivateMethodGet(this, _reconstructTotalExclFromTCCAndTaxes, _reconstructTotalExclFromTCCAndTaxes2).call(this);
-
-  _classPrivateMethodGet(this, _reconstructTotalTax, _reconstructTotalTax2).call(this);
-};
-
-var _reconstructTotalExclFromTCCAndTaxes2 = function _reconstructTotalExclFromTCCAndTaxes2() {
-  if (this.taxes.length && this.totalIncl.value != null) {
-    var totalExcl = {
-      value: this.totalIncl.value - Field.arraySum(this.taxes),
-      probability: Field.arrayProbability(this.taxes) * this.totalIncl.probability
-    };
-    this.totalExcl = new Amount({
-      prediction: totalExcl,
-      valueKey: "value",
-      reconstructed: true
-    });
-  }
-};
-
-var _reconstructTotalTax2 = function _reconstructTotalTax2() {
-  if (this.taxes.length && this.totalTax.value == null) {
-    var totalTax = {
-      value: this.taxes.map(tax => tax.value || 0).reduce((a, b) => a + b, 0),
-      probability: Field.arrayProbability(this.taxes)
-    };
-    if (totalTax.value > 0) this.totalTax = new Amount({
-      prediction: totalTax,
-      valueKey: "value",
-      reconstructed: true
-    });
-  }
-};
-
-module.exports = Receipt;

package/lib/errors/handler.js

@@ -1,19 +0,0 @@
-"use strict";
-
-var logger = require("../logger");
-
-class ErrorHandler {
-  constructor() {
-    var throwOnError = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
-    this.throwOnError = throwOnError;
-  }
-
-  throw(error) {
-    var force = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
-    if (this.throwOnError || force) throw error;else logger.error(error.message);
-  }
-
-}
-
-var errorHandler = new ErrorHandler();
-module.exports = errorHandler;

package/lib/index.js

@@ -1,40 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.Client = void 0;
-
-var handler_1 = require("@errors/handler");
-
-var logger_1 = require("@mindee/logger");
-
-var receipt_1 = require("@mindee/api/receipt");
-
-var invoice_1 = require("@mindee/api/invoice");
-
-var financialDocument_1 = require("@mindee/api/financialDocument");
-
-var Client =
-/** @class */
-function () {
-  function Client(_a) {
-    var receiptToken = _a.receiptToken,
-        invoiceToken = _a.invoiceToken,
-        _b = _a.throwOnError,
-        throwOnError = _b === void 0 ? true : _b,
-        debug = _a.debug;
-    this.receiptToken = receiptToken || process.env.MINDEE_RECEIPT_TOKEN;
-    this.invoiceToken = invoiceToken || process.env.MINDEE_INVOICE_TOKEN;
-    handler_1.errorHandler.throwOnError = throwOnError;
-    logger_1.logger.level = (debug !== null && debug !== void 0 ? debug : process.env.MINDEE_DEBUG) ? "debug" : "warn";
-    this.receipt = new receipt_1.APIReceipt(this.receiptToken);
-    this.invoice = new invoice_1.APIInvoice(this.invoiceToken);
-    this.financialDocument = new financialDocument_1.APIFinancialDocument(this.invoiceToken, this.receiptToken);
-  }
-
-  return Client;
-}();
-
-exports.Client = Client;
-exports.documents = require("./documents");
-exports.api = require("./api");
-exports.inputs = require("./inputs");

package/lib/inputs.js

@@ -1,190 +0,0 @@
-"use strict";
-
-function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
-
-function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-var fs = require("fs").promises;
-
-var errorHandler = require("./errors/handler");
-
-var path = require("path");
-
-var {
-  PDFDocument
-} = require("pdf-lib");
-
-var concat = require("concat-stream");
-
-var {
-  Base64Encode
-} = require("base64-stream");
-
-var fileType = require("file-type");
-
-var ArrayBufferEncode = require("base64-arraybuffer");
-
-class Input {
-  /**
-   * @param {(String | Buffer)} file - the file that will be read. Either path or base64 string, or a steam
-   * @param {String} inputType - the type of input used in file ("base64", "path", "dummy").
-   *                             NB: dummy is only used for tests purposes
-   * @param {String} filename - File name of the input
-   * @param {Boolean} cut_pdf: Automatically reconstruct pdf with more than 4 pages
-   * NB: Because of async calls, init() should be called after creating the object
-   */
-  constructor(_ref) {
-    var {
-      file,
-      filename = undefined,
-      inputType,
-      allowCutPdf = true
-    } = _ref;
-
-    _defineProperty(this, "MIMETYPES", {
-      png: "image/png",
-      jpg: "image/jpg",
-      jpeg: "image/jpeg",
-      webp: "image/webp",
-      pdf: "application/pdf"
-    });
-
-    _defineProperty(this, "ALLOWED_INPUT_TYPE", ["base64", "path", "stream", "dummy"]);
-
-    _defineProperty(this, "CUT_PDF_SIZE", 5);
-
-    // Check if inputType is valid
-    if (!this.ALLOWED_INPUT_TYPE.includes(inputType)) {
-      errorHandler.throw(new Error("The input type is invalid. It should be             ".concat(this.ALLOWED_INPUT_TYPE.toString())));
-    }
-
-    this.file = file;
-    this.filename = filename;
-    this.inputType = inputType;
-    this.allowCutPdf = allowCutPdf;
-  }
-
-  init() {
-    var _this = this;
-
-    return _asyncToGenerator(function* () {
-      if (_this.inputType === "base64") yield _this.initBase64();else if (_this.inputType === "path") yield _this.initFile();else if (_this.inputType === "stream") yield _this.initStream();else _this.initDummy();
-    })();
-  }
-
-  initBase64() {
-    var _this2 = this;
-
-    return _asyncToGenerator(function* () {
-      _this2.fileObject = _this2.file;
-      _this2.filepath = undefined;
-      _this2.fileExtension = undefined;
-
-      if (_this2.allowCutPdf == true) {
-        var typeOfFile = yield fileType.fromBuffer(Buffer.from(_this2.fileObject, "base64"));
-
-        if (typeOfFile === undefined) {
-          console.error("Cannot detect mime type of: ".concat(_this2.fileObject));
-        } else if (typeOfFile.mime === "application/pdf") {
-          yield _this2.cutPdf();
-        }
-      }
-    })();
-  }
-
-  initFile() {
-    var _this3 = this;
-
-    return _asyncToGenerator(function* () {
-      _this3.fileObject = yield fs.readFile(_this3.file);
-      _this3.filepath = _this3.file;
-      _this3.filename = _this3.filename || path.basename(_this3.file); // Check if file type is valid
-
-      var filetype = _this3.filename.split(".").pop();
-
-      console.log(_this3.filename.split("."));
-
-      if (!(filetype in _this3.MIMETYPES)) {
-        errorHandler.throw(new Error("File type is not allowed. It must be ".concat(Object.keys(_this3.MIMETYPES).toString())));
-      }
-
-      _this3.fileExtension = _this3.MIMETYPES[filetype];
-
-      if (_this3.fileExtension === "application/pdf" && _this3.allowCutPdf == true) {
-        yield _this3.cutPdf();
-      }
-    })();
-  }
-
-  initStream() {
-    var _this4 = this;
-
-    return _asyncToGenerator(function* () {
-      var file = yield _this4.streamToBase64(_this4.file);
-      _this4.file = file;
-      _this4.inputType = "base64";
-      yield _this4.initBase64();
-    })();
-  }
-
-  initDummy() {
-    this.fileObject = "";
-    this.filename = "";
-    this.filepath = "";
-    this.fileExtension = "";
-  }
-  /**
-   * Convert ReadableStream to Base64 encoded String
-   *
-   * @param {*} stream ReadableStream to encode
-   * @returns Base64 encoded String
-   */
-
-
-  streamToBase64(stream) {
-    return _asyncToGenerator(function* () {
-      return new Promise((resolve, reject) => {
-        var base64 = new Base64Encode();
-
-        var cbConcat = base64 => {
-          resolve(base64);
-        };
-
-        stream.pipe(base64).pipe(concat(cbConcat)).on("error", error => {
-          reject(error);
-        });
-      });
-    })();
-  }
-  /** Cut PDF if pages > 5 */
-
-
-  cutPdf() {
-    var _this5 = this;
-
-    return _asyncToGenerator(function* () {
-      // convert document to PDFDocument & cut CUT_PDF_SIZE - 1 first pages and last page
-      var pdfDocument = yield PDFDocument.load(_this5.fileObject, {
-        ignoreEncryption: true
-      });
-      var splitedPdfDocument = yield PDFDocument.create();
-      var pdfLength = pdfDocument.getPageCount();
-      if (pdfLength <= _this5.CUT_PDF_SIZE) return;
-      var pagesNumbers = [...Array(_this5.CUT_PDF_SIZE - 1).keys(), pdfLength - 1];
-      var pages = yield splitedPdfDocument.copyPages(pdfDocument, pagesNumbers);
-      pages.forEach(page => splitedPdfDocument.addPage(page));
-      var data = yield splitedPdfDocument.save();
-
-      if (_this5.inputType === "path") {
-        _this5.fileObject = Buffer.from(data);
-      } else if (_this5.inputType === "base64") {
-        _this5.fileObject = ArrayBufferEncode.encode(data);
-      }
-    })();
-  }
-
-}
-
-module.exports = Input;

package/lib/logger.js

@@ -1,52 +0,0 @@
-"use strict";
-
-var LOGGER_LEVELS = {
-  debug: 0,
-  info: 1,
-  warn: 2,
-  error: 3
-};
-
-class Logger {
-  constructor() {
-    var level = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "debug";
-    if (!(level in LOGGER_LEVELS)) level = "debug";
-    this.level = LOGGER_LEVELS[level];
-  }
-
-  debug() {
-    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-      args[_key] = arguments[_key];
-    }
-
-    if (this.level <= LOGGER_LEVELS["debug"]) console.debug(args);
-  }
-
-  info() {
-    for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
-      args[_key2] = arguments[_key2];
-    }
-
-    if (this.level <= LOGGER_LEVELS["info"]) console.info(args);
-  }
-
-  warn() {
-    for (var _len3 = arguments.length, args = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
-      args[_key3] = arguments[_key3];
-    }
-
-    if (this.level <= LOGGER_LEVELS["warn"]) console.warn(args);
-  }
-
-  error() {
-    for (var _len4 = arguments.length, args = new Array(_len4), _key4 = 0; _key4 < _len4; _key4++) {
-      args[_key4] = arguments[_key4];
-    }
-
-    if (this.level <= LOGGER_LEVELS["error"]) console.error(args);
-  }
-
-}
-
-var logger = new Logger();
-module.exports = logger;