Skip to content

Latest commit

 

History

History
625 lines (447 loc) · 16.8 KB

CHANGELOG.md

File metadata and controls

625 lines (447 loc) · 16.8 KB

CHANGELOG

v4.22.0 - 2025-01-14

Changes

  • ✨ add support for US Mail V3
  • ♻️ increase async retry timers

v4.21.0 - 2024-12-13

Changes

  • ✨ allow local downloading of remote sources
  • ⚰️ remove support for (FR) Carte Vitale V1 in favor of French Health Card V1

Fixes

  • 🐛 fix broken loading from bytes

v4.20.0 - 2024-11-28

Changes

  • ✨ add support for French Health Card V1
  • ✨ add support for Driver License V1
  • ✨ add support for Payslip FR V3

v4.19.0 - 2024-11-27

Changes

  • ⚰️ remove support for international ID V1
  • ✨ add support for workflows
  • ✨ add configurable http request timeout

Fixes

  • 🐛 fix http errors improperly showing as 500 in rare instances

v4.18.1 - 2024-11-19

Fixes

  • 🐛 fix composed API server response not properly filling full_text_ocr in pages
  • ⬆️ bump dependencies

v4.18.0 - 2024-11-14

Changes

  • ✨ add support for business cards V1
  • ✨ add support for delivery note V1.1
  • ✨ add support for indian passport V1
  • ✨ add support for resume V1.1

Fixes

  • ♻️ adjust default values for async delays
  • ♻️ remove unused dependencies

v4.17.1 - 2024-10-17

Fixes

  • 🐛 fix invalid handling of boolean fields & fix accidental coercion into numbers in GeneratedObjectField fields
  • 🐛 fix GeneratedObjectField fields being inaccessible in typescript without going through the main object

v4.17.0 - 2024-10-11

Changes

  • ✨ add support for Financial Document v1.10
  • ✨ add support for Invoice v4.8

v4.16.0 - 2024-09-17

Changes

  • ✨ add support for US Mail V2
  • ✨ add support for Bill of Lading V1
  • ✨ add support for FR Energy Bill V1
  • ✨ add support for FR Payslips V1
  • ✨ add support for Nutrition Facts Label V1
  • ♻️ refactor internals to accommodate for new changes

Fixes

  • 🐛 fix float numbers not containing more 3 decimals in some instances
  • 🐛 fix boolean field display issues
  • 🐛 fix values being extracted as undefined instead of null, as is present in the initial prediction.

v4.15.0 - 2024-09-12

Changes

  • ✨ add support for full text OCR extraction
  • 🔧 add stricter linting rules
  • ♻️ add integration tests

Fixes

  • 🐛 fix page operations not taking minimum threshold into account.

v4.14.1 - 2024-09-03

Changes

  • 📝 add classification detail to guide documentation

Fixes

  • ⬆️ update dependencies
  • 📝 fix broken documentation URLs
  • ♻️ generate missing accessors for products
  • ♻️ add missing async code samples

v4.14.0 - 2024-07-24

Changes

  • ✨ add support for Healthcare Card V1
  • ✨ add support for Invoice V4.7
  • ✨ add support for Financial Document V1.9
  • ♻️ update display for registration field

v4.13.1 - 2024-06-10

Fixes

  • ♻️ refactored image extraction module to allow for more generic manipulations
  • ♻️ add tests for multipage receipts extraction

v4.13.0 - 2024-05-28

Changes

  • ✨ add support for local response loading
  • ✨ add support for HMAC validation for webhooks
  • ✨ add support for US Mail V2
  • ✨ add support for boolean fields

Fixes

  • ♻️ fixed Locale display

v4.12.0 - 2024-05-16

Changes

  • ✨ update receipt to 5.2 and financial document to 1.7 (#270)

v4.11.0 - 2024-04-30

Changes

  • ✨ update invoice to 4.6 & financial document to 1.6 (#269)

v4.10.0 - 2024-04-12

Changes

  • ✨ update Invoice to v4.5 (#264)

Fixes

  • 🐛 fix error management not following intended flow (#267)
  • ♻️ deprecated old error handler (#266)

v4.9.1 - 2024-03-05

Changes

  • ♻️ update error handling to account for future evolutions
  • ♻️ expose the input, geometry & imageOperations modules in internals for better fine-tuning
  • ♻️ fix inconsistencies with naming conventions
  • 📝 add missing reference documentation

v4.9.0 - 2024-02-21

Changes

  • ✨ add support for resume V1
  • ✨ add support for International ID v2
  • ✨ add support for EU Driver License V1

Fixes

📝 misc doc fixes

v4.8.2 - 2024-02-09

Changes

  • ♻️ increased update time for async retries

Fixes

  • 🐛 fixed improper float parsing for Generated list objects
  • 🐛 typescript should now allow the use of default values for enqueueAndParse() async options

v4.8.1 - 2024-02-06

Fixes

  • 🐛 fixed invalid code samples for generated & async generic APIs
  • 📝 fix corresponding docs

v4.8.0 - 2024-02-05

Changes

  • ✨ add support for Generated APIs
  • ✨ add custom GeneratedList & GeneratedObject classes linked to Generated APIs
  • ⬆️ update test lib to add testing samples for Generated APIs
  • ⬆️ upgraded dependencies & lockfile version
  • ♻️ add new generated namespace & associated documentation
  • 🔧 add unit tests for generated APIs
  • 🔧 add code samples for generated APIs
  • ♻️ add CLI entry for generated APIs
  • 📝 add documentation entry for generated APIs
  • ♻️ expose a bit more of our internals for easier use (#247)

Fixes

  • 📝 fix invoice v4 md doc

v4.7.0 - 2024-01-30

Changes

  • ⬆️ update invoices to 4.4
  • ✨ add rawValue to string fields.

v4.6.1 - 2023-12-15

Changes

  • ♻️ tweak async delays & retry
  • ♻️ tweak default async sample delays & retry
  • 📝 update md doc & fix typos

v4.6.0 - 2023-12-11

Changes

  • ✨ add invoice-splitter auto-splitting feature
  • 📝 add examples to illustrate auto-splitting feature
  • ♻️ add unit tests for auto-splitting feature
  • ♻️ rename exemple folder to example
  • ⬆️ update testing library

v4.5.0 - 2023-11-29

Changes

  • ✨ add Multi-Receipts auto-extraction feature
  • 🎨 add example file to illustrate multi-receipt image extraction feature
  • ♻️ add new imageOperations namespace
  • ♻️ fix loose typing issues for inputsources

v4.4.0 - 2023-11-17

Changes

  • ✨ add support for Carte Grise V1
  • ✨ add page nubmer attribute to doc
  • ⬆️ update product tests & doc

Fixes

  • 🐛 fix broken page_id attribute for newer custom builds

v4.3.2 - 2023-11-07

Changes

  • ♻️ update invoice splitter

Fixes

  • 🐛 fix display issues when products didn't have pages
  • 📝 fix doc typos

v4.3.2 - 2023-10-04

Changes

  • ⬆️ dependency upgrade
  • ♻️ minor refactoring

v4.3.1 - 2023-09-20

Fixes

  • 🐛 take line height tolerance into account when evaluating fields

v4.3.0 - 2023-09-19

Changes

  • ✨ add line items reconstruction for API builder

v4.2.0 - 2023-09-15

Changes

  • ✨ add support for W9 V1
  • ✨ add support for Barcode Reader V11
  • ✨ add support for Multi Receipt Detector V1
  • ✨ add support for FR Id Card V2
  • ✨ add support for OTS Cropper V1
  • 📝 update documentation

Fixes

  • 🐛 fix missing position field display issues
  • 🐛 fix issues with asynchronous timeouts crashing in some instances

v4.1.1 - 2023-09-04

Changes

  • ♻️ tweaked timer management in async

Fixes

  • 🐛 fix ocr option not being generated as an Ocr object

v4.1.0 - 2023-08-31

Changes

  • 💥 remove support for node versions <16
  • ✨ add support for auto-polling in asynchronous calls
  • ✨ update HTTP error management system
  • ✨ add possibility to access raw server response
  • ⬆️ add support for node 20
  • 🔧 expose more internal tools
  • 📝 add better technical documentation
  • ♻️ remove deprecated examples
  • ♻️ update linting rules
  • ⬆️ update testing library

Fixes

  • 🐛 fix miscellaneous bugs related to http parsing issues

v4.0.2 - 2023-08-24

Changes

  • ♻️ updated technical documentation

Fixes

  • 🐛 fix url source document not being sent properly

v4.0.1 - 2023-08-22

Fixes

  • 🐛 fixed pre-commit dependency script blocking installs

v4.0.0 - 2023-08-14

¡Breaking Changes!

  • 🎨 💥 harmonize response types with other libraries
  • 🎨 💥 change endpoint management & syntax
  • 🎨 💥 move products to product module

Changes

  • ✨ add full support for page-specific attributes
  • ✨ add support for FR Id Card
  • ✨ add support for US Driver License
  • ✨ add auto-generated md documentation
  • ✨ add text reconstruction when using the allWords parameter (full OCR)
  • ♻️ updated CLI to accommodate for newest changes
  • ⚰️ remove InvoiceV3
  • ⚰️ remove ReceiptV3
  • ♻️ update tests to accommodate for newest changes
  • ♻️ re-organized parsing module (common/standard/custom)

v3.10.2 - 2023-08-11

Changes

  • 🔊 better logging of JSON errors

v3.10.1 - 2023-07-04

Changes

  • ⬆️ update dependencies

Fixes

  • ✏️ added missing entry in changelog

v3.10.0 - 2023-07-04

Changes

  • ✨ add support for FR Bank Account Details V2
  • ♻️ update printing syntax & unit test for Receipt v5
  • ⚰️ removed support for Shipping Container

v3.9.0 - 2023-06-06

Changes

  • ✨ support for financial document v1.1
  • ♻️ change http status code handling for async requests

Fixes

  • 🐛 fix typing in PaymentDetails
  • 🐛 locale value should always be set
  • 🐛 add missing class properties on new line items

v3.8.0 - 2023-05-25

Changes

  • ✨ add support for receipt v5
  • ✨ print taxes in table layout

v3.7.4 - 2023-04-20

Changes

  • ✅ minor improvements to tests

Fixes

  • 🐛 fix for options not being passed properly in the CLI tool

v3.7.3 - 2023-04-11

Changes

  • ⬆️ upgrade to TypeScript 5.0.3
  • 🦺 ban-ts-comment should be an error
  • ✅ Add docs with code samples and use them for testing

v3.7.2 - 2023-04-04

Fixes

  • 🐛 export DocumentClient class for easier 3rd party integration
  • 🐛 only display the job info when CLI parse-queued is processing

v3.7.1 - 2023-03-31

Fixes

  • 🐛 make sure all documents are exported properly

v3.7.0 - 2023-03-31

Changes

  • ✨ add support for asynchronous predictions
  • ✨ add experimental support for line items in custom documents
  • 🎨 harmonize bbox and bounding box terminology
  • ⬆️ update test files, minor updates to string output
  • 🏷️ classification fields are always strings

Fixes

  • 🐛 fix error message for missing API key, document type may be undefined

v3.6.0 - 2023-02-01

Changes

  • ✨ Add support for the mindee_vision API (for internal testing)
  • ✨ support Proof of Address V1
  • ✨ Add support for: financial document v1
  • ⬆️ update jsdoc

¡Warning!

The FinancialDocumentV1 class now uses an actual API call to the new route financial_document. Previously, determining whether a document is an invoice or a receipt was done internally by this library.

The API call way is much better, however some fields have been renamed compared to the internal handling. This was done so field names now match exactly Invoice and Receipt classes.

As such, we encourage users to migrate to the new field structure.

If this is problematic, it's possible to use the deprecated way. Simply pass FinancialDocumentV0 to the parse method. Usage is otherwise identical.

v3.5.0 - 2023-01-17

Changes

  • 📝 updates to class documentation
  • ✨ Add invoice splitter support (beta)

Fixes

  • 🐛 fix for CLI command option description

v3.4.1 - 2023-01-05

Changes

  • 🏷️ Added typing information, get rid of any type in various places
  • ♻️ Use a specific TextField class for fields we know are textual
  • ⬆️ update dependencies

Fixes

  • 🐛 Expose various class and type definitions to improve developer experience

v3.4.0 - 2023-01-04

Changes

  • ✨ Support Receipt V4.1
  • ✨ Support Invoice V4.1

v3.3.0 - 2022-12-01

Changes

  • ✨ Add Invoice V4 with line items
  • ✨ An env variable can be used to change the Mindee base API url

v3.2.0 - 2022-11-14

Changes

  • ✨ Add support for shipping container API V1
  • ✨ Add support for EU license plate V1
  • 🐛 Fix page removal in CLI
  • ✨ Add support for Carte Vitale V1
  • ✨ Add support for FR Bank Account Details V1
  • 📝 Export and add comments for method parameters.
  • ✨ Add support for US Bank Check V1

v3.1.1 - 2022-11-08

Changes

  • 🐛 fix proper import and documentation of region-specific documents

v3.1.0 - 2022-11-08

Changes

  • ✨ Add support for French ID cards.
  • ✨ add buffer input source

v3.0.1 - 2022-11-02

Fixes

  • 🐛 Fix for supplier property name in ReceiptV4 document.

v3.0.0 - 2022-10-31

¡Breaking Changes!

  • ✨ New PDF cut system, which allows specifying exactly which pages to keep or remove.
  • ♻️ PDF documents are no longer cut by default, use the pageOptions parameter in the parse method.
  • ✨ Document (endpoints) are now versioned, providing better backward-compatible support.
  • ♻️ Pass the document class instead of the response class to the parse method.
  • ♻️ Some methods and parameters renamed for better clarity.

Changes

  • ✨ New URL input source, docFromUrl.
  • ✨ Add support for expense receipts V4

v2.1.1 - 2022-10-28

Fixes

  • 🐛 fix for sending base64 documents.

v2.1.0 - 2022-10-19

Changes

  • ✨ add cropper support to predict requests
  • ✨ add stand-alone cropper support

v2.0.1 - 2022-10-13

Fixes

  • 🐛 Fix for packaging and documentation related to commonJS imports

v2.0.0 - 2022-08-26

Note

This is a complete rewrite in TypeScript!

It's not backwards compatible with previous versions.

Changes

  • ✨ Add Passport API support
  • ✨ Add custom document support (API builder)
  • ✨ Add basic geometry functions
  • 🏷️ everything is typed, in particular response objects. Allows for much easier auto-completion in your IDE.
  • ⬆️ all major dependencies updated

v1.4.0

Fixes

  • 🐛 cut/merge pages of an encrypted PDF leads to unexpected results
  • 🐛 logger not activating in some cases
  • 🐛 align PDF cut/merge with other client libs

Changes

  • ✨ Add TIFF and HEIC support
  • ✅ fully test PDF cut function

v1.3.3

Fixes

  • 🐛 reject errors instead of printing them only to the console

v1.3.2

Fixes

  • 🐛 use PDF length instead of cut PDF size limit

v1.3.1

Fixes

  • 🐛 forward api error to stderr instead of stdout

v1.3.0

Changes

  • ✨ allow sending the filename for streams and base64
  • 🐛 not able to specify MIME type
  • 📄 change license to MIT
  • ✅ add node18 to tests
  • various package updates

v1.2.0

Fixes

  • 🐛 Get words values when includeWords parameter is true

v1.1.2

Changes

  • ✨ New Mindee Invoice API V3 support
  • ✨ Add new supplier and customer fields

Fixes

  • 🐛 Fix returned probability value
  • 🐛 Fix returned bbox value

v1.1.0 (2022-01-03)

Changes

  • ✨ New Mindee API V2 support
  • ⚡ Server side invoice reconstruction from multi-page pdfs
  • ✨ Added OS in User-Agent headers

v1.0.9 (2021-12-09)

Fixes

  • 🐛 handle attribute of type array when merging pages

v1.0.8 (2021-11-29)

Changes

  • 🙈 add .DS_Store to ignore file

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

v1.0.7 (2021-11-25)

Changes

  • ✨ Added pdf page number parameter for multi-pages pdfs with file
  • ⬆️ upgrade path-parse dependency
  • ⬆️ upgrade browserslist dependency
  • ⬆️ upgrade lodash dependency
  • ⬆️ upgrade y18n dependency

v1.0.4 (2021-02-18)

Changes

  • ✨ ⚡ Add a parameter filename and a default filename for streams
  • ⚡ Change parse function to use an object instead of multiples parameters

v1.0.3 (2021-02-01)

Fixes

  • 🐛 _request parameters
  • 🐛 pageNumber default value
  • 🐛 reconstruction method set fields to probability

v1.0.2 (2021-02-01)

Changes

  • ⚡ Better coverage for total tax

Fixes

  • 🐛 includeWords is now working

v1.0.1 (2021-01-11)

  • 🎉 First release