• ✨ add support for crop operation for V2
• ✨ add support for split operation for V2
• ⬆️ bump dependencies

• 🐛 fix quality defaulting to 4.17 (300/72) instead of 1 when extracting cropped zones
• 🐛 fix split extraction not allowing for image files
• 🐛 fix naming in extracted PDFs

• ➖ tslib is never imported, remove from dependencies

• ✨ add to job information

• 🐛 fix for printing crop results
• 🐛 proper init of webhook payload

• 🐛 always use the provided result URL

• ♻️ rename client options directory (internal)
• ⬆️ bump dev dependencies to fix vulnerabilities

• 💥 ✨ move PDF and image libraries to optional dependencies (resolves #388)
• ♻️ 💥 rework of directory structure and exports (resolves #276)
• 💥 drop support for node.js 18
• 💥 ♻️ separate polling options
• ⚰️ remove support for API builder (no longer maintained, use v2)
• ⚰️ remove support for v1 products available in v2
• ⚰️ remove support for unused products

• ✨ add support for all utility products
• ✨ add V2 CLI
• ✨ add Job to inference responses
• ✨ handle abort signal stream inputs
• ♻️ use undici (compatible with v6 or v7) for HTTP requests and mocking
• ✨ add the ability for a user to specify their own undici Dispatcher instance
• ♻️ migrate to ES modules

• ✨ add Job to inference responses

• 🐛 fix for bin scripts

• 💥 drop support for node.js 18
• 💥 ♻️ separate polling options

• ♻️ use node test methods
• ♻️ v1 ocr word should be a class
• ♻️ make v2 products top level
• 🐛 fix for optional node-poppler

• ⬆️ update file-type
• ♻️ migrate to ES modules (node18)
• ⚰️ remove support for obsolete/unused products:
  • API builder (no longer maintained, use v2)
• ⚰️ remove support for unused products available in v2:
  • nutrition facts
  • business card
  • US healthcare cards
  • bill of lading
• ⚰️ remove support for unused products:
  • delivery note
  • payslip_fra_v2_async
  • idcard_fr_v1
  • ind_passport_v1_async
  • us_mail_v3_async
  • energy_bill_fra_v1_async
  • french_healthcard_v1_async
  • payslip_fra_v3_async
• ♻️ use undici for HTTP requests and mocking
• ✨ add ability for a user to specify their own undici Dispatcher instance
• ✨ add basic V2 CLI
• ♻️ 💥 rework of directory structure
• ♻️ 💥 rework input source errors
• ✨ handle abort signal stream inputs
• ✨ add support for all utility products
• 💥 ✨ move PDF and image libraries to optional dependencies

• 🐛 fix streams not loading properly

• 🗑️ deprecate docFromXxx methods

• 🐛 extracted images should take rotation into account
• ♻️ fix minor issues with param syntaxes

• ✨ add support for dataschema param

• ✨ add multi-receipt custom file saving formats

• 🐛 fix image extractor dropping quality of extracted PDFs

• ✨ add support for text context

• 🔊 add error code to v2 exceptions

• ✨ add more details to V2 errors
• ✨ add RAG metadata in V2 results

• ✨ add getting page count of a local source

• 🐛 make sure input sources are only initialized once

• ✨ allow comparing V2 field confidence
• ⚰️ remove obsolete US Mail V2

• ✨ add support for inference options
• ♻️ refactor rst display to match other SDKs

• ♻️ 💥 update raw text output from server

• ✨ add typed accessors for fields, list, object
• ✨ add typed value accessors
• ✨ add geometry methods to polygon class

• 🐛 Polygon and BoundingBox should be a real classes

• ♻️ rework local and input sources

• ♻️ allow direct import of input sources

• ✨ add support for page count & mime type + fix syntaxes
• ♻️ update internal field syntaxes to match other SDKs
• ♻️ upgrade toString() display for most fields
• ♻️ fix internals & upgrade tests

• ✨ add support for URL input source

• ⬆️ bump dependencies to cover vulnerabilities

• ♻️ harmonize with other client libraries

• ✨ add support for V2 client
• ♻️ tweak CI & testing
• ♻️ deprecate cutPdf() in favor of applyPageOperations() in LocalInputSource
• ♻️ refactor some internals to account for new changes

• 🐛 fix bug where polling parameters could ignore validation checks on V1

• ✨ add support for address fields
• ✨ add support for Financial Document V1.12
• ✨ add support for Invoices V4.10
• ✨ add support for US Healthcare Cards V1.2

• 🐛 fix default-encrypted & XFA pdfs not opening

• 🐛 fix workflow polling not working when ran with ts-node
• 📝 add example script for workflow polling

• ✨ add support for RAG polling
• ✨ add extras accessor from inference

• 🐛 fix improper deserialization of extras in some instances

• ✨ add support for rag param in workflow executions

• ✨ add support for Financial Document V1.12
• ✨ add support for Invoices V4.10
• ✨ add support for US Healthcare Cards V1.2

• ⬆️ upgrade mocha dependency

• 🐛 fix null objects being return in extras

• ✨ update structure for InvoiceSplitterV1
• ✨ update FR EnegryBillV1 to V1.2
• ✨ update US HealthcareCardV1 to V1.1
• ⚰️ remove support for EU Driver License
• ⚰️ remove support for License Plates
• ⚰️ remove support for ReceiptV4
• ⚰️ remove support for Proof of Address
• ⚰️ remove support for US Driver License
• ⚰️ remove support for US W9V1

• 🐛 fix invalid indexes of some products
• ♻️ update CLI structure

• ♻️ remove superfluous canvas dependency
• 📝 update doc

• ✨ add support for image & PDF compression

• 🐛 add missing 'failed' value to jobs

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

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

• 🐛 fix broken loading from bytes

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

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

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

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

• ✨ 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

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

• 🐛 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

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

• ✨ 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

• 🐛 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.

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

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

• 📝 add classification detail to guide documentation

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

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

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

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

• ♻️ fixed Locale display

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

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

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

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

• ♻️ 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

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

📝 misc doc fixes

• ♻️ increased update time for async retries

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

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

• ✨ 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)

• 📝 fix invoice v4 md doc

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

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

• ✨ 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

• ✨ 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

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

• 🐛 fix broken page_id attribute for newer custom builds

• ♻️ update invoice splitter

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

• ⬆️ dependency upgrade
• ♻️ minor refactoring

• 🐛 take line height tolerance into account when evaluating fields

• ✨ add line items reconstruction for API builder

• ✨ 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

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

• ♻️ tweaked timer management in async

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

• 💥 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

• 🐛 fix miscellaneous bugs related to http parsing issues

• ♻️ updated technical documentation

• 🐛 fix url source document not being sent properly

• 🐛 fixed pre-commit dependency script blocking installs

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

• ✨ 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)

• 🔊 better logging of JSON errors

• ⬆️ update dependencies

• ✏️ added missing entry in changelog

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

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

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

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

• ✅ minor improvements to tests

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

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

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

• 🐛 make sure all documents are exported properly

• ✨ 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

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

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

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.

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

• 🐛 fix for CLI command option description

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

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

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

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

• ✨ 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

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

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

• 🐛 Fix for supplier property name in ReceiptV4 document.

• ✨ 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.

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

• 🐛 fix for sending base64 documents.

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

• 🐛 Fix for packaging and documentation related to commonJS imports

This is a complete rewrite in TypeScript!

It's not backwards compatible with previous versions.

• ✨ 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

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

• 🐛 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

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

• 🐛 use PDF length instead of cut PDF size limit

• 🐛 forward api error to stderr instead of stdout

• ✨ 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

• 🐛 Get words values when includeWords parameter is true

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

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

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

• 🐛 handle attribute of type array when merging pages

• 🙈 add .DS_Store to ignore file

• 🐛 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

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

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

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

• ⚡ Better coverage for total tax

• 🐛 includeWords is now working

• 🎉 First release