This repository has been archived by the owner on Feb 8, 2024. It is now read-only.
Releases: PhotoPay/photopay-in-browser
Releases · PhotoPay/photopay-in-browser
Release 7.7.9
7.7.9
- We've updated Microblink logo and colors
Release 7.7.8
7.7.8
Platform-related SDK changes
- We've added methods for programmatically starting camera and image scan when using the UI component.
- It's possible to call
startCameraScan()
andstartImageScan(File)
methods on the custom web element.
- It's possible to call
- We've standardized error structures returned from the WebAssembly library and the UI component.
- See SDKError.ts and ErrorTypes.ts for a complete list of possible error codes.
- We've completed support for
part::
selector and added an example. - We've simplified integration of the UI component with Angular and React frameworks.
Bug fixes
- We've ensured that all SDK errors can be visible from
fatalError
andscanError
events in the UI component. - We've fixed a bug where a user couldn't upload an image after the camera scan failed to start.
- We've fixed a bug where the video feed wasn't released in the scenario where the UI component was removed from the DOM.
- We've improved memory management during the initialization of the UI component to avoid the creation of unnecessary web workers.
Release 7.7.7
7.7.7
Platform-related SDK changes
- We've improved the performance of the SDK by adding support for WebAssembly SIMD.
- This increases the scanning performance on compatible browsers up to 77% and up to 94% in cases when WebAssembly threads are also supported.
- Keep in mind that this feature requires a compatible browser (Chrome 91 and Firefox 90 or newer versions). Only
advanced
andadvanced-threads
binaries are using SIMD. In case that the browser doesn't support this feature,basic
binary will be used.
- We've reduced the memory fragmentation during video processing, resulting in a smaller memory footprint.
- We've added a camera management UI module for the selection of connected cameras
- We've added
VideoRecognizer.changeCameraDevice
method that can be used to change the active camera device during the scanning session
- We've added
- We've improved accessibility of the UI component by changing background contrasts and increasing default font sizes
- We've added a mechanism to automatically delete an instance of worker script in case of unsuccessful SDK initialization.
- New method
WasmSDK.delete()
was added for this purpose and is available on every instance of the SDK.
- New method
- We've changed improper error handling in the
VideoRecognizer
class.- From now on, it's possible to catch all errors that happen during the video recognition.
Bug fixes
- We've optimised memory usage of the SDK by fixing a problem where every refresh of the UI component would result in a new instance of web worker
Release 7.7.6
7.7.6
SDK changes
- We've exposed a couple of functions that are used by the SDK to determine which WebAssembly bundle to load and from which location
- Function
detectWasmType()
returns the best possible WebAssembly bundle based on the features a browser supports. - Function
wasmFolder( WasmType )
returns the name of the resources subfolder of the provided WebAssembly bundle type. - For more information on how to implement these functions, see
WasmLoadUtils.ts
file.
- Function
UI Improvements
- You can now set a camera feedback message to the user
- Set
showCameraFeedbackBarcodeMessage
property to display a custom message. - Use
translations
property to translate a custom message.
- Set
- Camera rectangle cursor is more responsive now.
Bugfixes
- Container width size on UI component for action label (
Scan or choose from gallery
) and action buttons (Device camera
andFrom gallery
) are now responsive on Safari.
Release 7.7.5
7.7.5
- We've fixed a broken
rollup.config.js
which resulted in an unusable UMD development bundle
Release 7.7.4
7.7.4
Breaking changes
- We've changed the way how recognizer options are set up when using the UI component
- You can now specify how a recognizer should behave by using the new
recognizerOptions
property. - To see the full list of available recognizer options, as well as examples on how to use them, check out the relevant source code.
- You can now specify how a recognizer should behave by using the new
Performance improvements
- We've added three different flavors of WebAssembly builds to the SDK, to provide better performance across all browsers
- Unless defined otherwise, the SDK will load the best possible bundle during initialization:
Basic
Same as the existing WebAssembly build, most compatible, but least performant.Advanced
WebAssembly build that provides better performance but requires a browser with advanced features.AdvancedWithThreads
Most performant WebAssembly build which requires a proper setup of COOP and COEP headers on the server-side.
- For more information about different WebAssembly builds and how to use them properly, check out the relevant section in our official documentation
- Unless defined otherwise, the SDK will load the best possible bundle during initialization:
SDK changes
- Constructor of
VideoRecognizer
class is now public
Camera management updates
- We've enabled camera image flipping
- Method
flipCamera
has been added toVideoRecognizer
. - You can now let your users mirror the camera image vertically in case they find it easier to scan that way.
- By default, the UI component will display a flip icon in the top left corner once the camera is live.
- Method
- We've improved camera management on devices with multiple cameras
- Method
createVideoRecognizerFromCameraStream
has been extended inVideoRecognizer
class. - Attribute
[camera-id]
has been added to the UI component so that your users can preselect their desired camera.
- Method
Bugfixes
- We fixed the initialization problem that prevented the SDK from loading on iOS 13 and older versions
Release 7.7.3
- Fixed NPM package to include UI component.
Release 7.7.2
UI component
- We added a UI component in the format of a custom web element to use BlinkID on your web in an effortless way.
- Check out the README file for instructions on how to use UI component, or check the ui directory for complete source code.
Minor API changes
- We removed
workerLocation
property fromWasmSDKLoadSettings
.- Web worker is now inlined into the source code, which simplifies the SDK deployment and usage.
- Property
engineLocation
inWasmSDKLoadSettings
must be an absolute path. - Removed
useWebWorker
property fromWasmSDKLoadSettings
, since web worker is now always used as it provides much better user experience
and does not block the UI browser thread.
Fixes
- We fixed the initialization promise chain so that you can handle all initialization errors with a single error handler.
Release 7.7.1
- Removed
alert()
from VideoRecognizer and addedallowManualVideoPlayout
to constructor ofVideoRecognizer
class - Added
locateFile
method to MicroblinkSDK to fix problem when SDK is not using web worker - File
package.json
- Added field
engines
to explicitly specify Node version which was used during development - Fixed typo in
repository
field so NPM package can be used with yarn
- Added field
- Documentation
- Added more information and renamed section "Optimal deployment of your web app" to "Deployment guidelines"
- Added links to Codepen examples and official demo app
Release 7.7.0
- Standardization of NPM package
- NPM package can be used in environments with module bundlers
- Added ES and UMD bundles for the SDK
- Types are now exposed and accessible in standard manner for NPM environment
- Extended
package.json
with project information and scripts for building and publishing - Added Rollup build system to provide developers with infrastructure for easier customization of SDK
- Extension of examples
- Examples now cover more functionalities of the SDK
- Provided examples for integration in TS, ES and UMD environment
- Configuration options for WASM engine and WebWorker locations
- Configurations
engineLocation
andworkerLocation
are defined in theWasmSDKLoadSettings
class
- Configurations
- Improved stability and readability of SDK TypeScript source code
- Added ESLint for automatic check of unsecure language constructs
- Added Babel for safe transpiling to ES6 and better browser support