Releases: Dynamsoft/document-scanner-javascript
Releases · Dynamsoft/document-scanner-javascript
v1.4.0
Features
Breaking changes
- Rename
document-scanner.ui.htmltodocument-scanner.ui.xmlto better reflect its purpose as a declarative UI configuration template.- This affects self hosting users only - you must update the path in the
scannerViewConfig.cameraEnhancerUIPathproperty accordingly and rebuild the library.
- This affects self hosting users only - you must update the path in the
Scanning Capabilities
- Select the clearest of multiple video frames on scan with
enableFrameVerification(defaulttrue). - Add continuous scanning mode to make multiple scans on a single
launch(), enabled byenableContinuousScanning(defaultfalse).- Add
onDocumentScannedhandler to get single scan results in continuous scanning mode. - Add a thumbnail scan preview in the scanner view for continuous scanning mode with an optional
onThumbnailClickedclick handler. - Add
stopContinuousScanningto programmatically stop the scanning loop.
- Add
- Add
enableBoundsDetectionModeto set default bounds detection mode.
UI/UX Improvements
- Remove the animated shutter spinner.
Samples
- Add sample demonstrating minimal code to integrate MDS with Dynamsoft Document Scanner (DDV) to scan to PDF with continuous scanning.
- Add minimal MDS-only continuous scanning sample.
Fixes
- Fix "Torch not supported" message appearing unecessarily.
- Update framework sample dependencies to resolve security vulnerabilities.
- Remove memory leak caused by logging results to console.
Documentation
- Add guides to using continuous scan mode and integrating with DDV.
- Add full
tsdocannotation coverage for all MDS APIs to bring API references to IDEs and allow content extraction with compatible development tools.
Dependencies
v1.3.1
Release Notes
SDK
Features
- Upgraded to version 3.0.6001 of Dynamsoft Capture Vision JS (from 2.6.1000).
- Improved document detection, especially for white documents on white backgrounds.
- Simplified build and bundling.
- Improved TypeScript configuration and module resolution.
- Added ready-made samples for Angular, React, and Vue.
Fixes
- Set
boundsDetectionEnabledtotruefor clarity, since its value was already overridden during MDS instantiation. - Changed the type of
DocumentResult.correctedImageResultfromDeskewedImageResultItem | DSImageDatatoDeskewedImageResultItemto resolve a TypeScript error when calling methods liketoCanvas(). - Created the
dds.esm.d.tsdeclaration file to fix ESM import/export issues.
Dependencies
Documentation
- Updated SDK versions from v1.2.0 to v1.3.1.
- Added
tsdocannotations to bring API references to IDEs and support compatible development tools. - Added developer guides for JavaScript Framework samples.
v1.3.0-beta-202509040001
Release Notes
SDK
Features
- Upgrade to version 3.0.6001 of Dynamsoft Capture Vision JS (from version 2.6.1000).
- This upgrade improves document detection effectiveness, especially for white documents on white backgrounds.
- Simplify build and bundling approach.
- Improve TypeScript configuration and module resolution.
- Add ready-made samples for Angular, React, and Vue.
Fixes
- Set
boundsDetectionEnabledtotrueto make code clearer, since its value already overridden totruewhen instantiating the MDS object. - Change the type of
DocumentResult.correctedImageResultfromDeskewedImageResultItem | DSImageDatatoDeskewedImageResultItemto fix a TypeScript error when calling methods liketoCanvas(). - Create the
dds.esm.d.tsdeclaration file to fix ESM import/export issues.
Dependencies
Documentation
- Update SDK versions from v1.2.0 to v1.3.0.
- Add
tsdocannotations to bring API references to IDEs and allow content extraction with compatible development tools. - Add developer guides for JavaScript Framework samples.
v1.2.0
Release Notes
SDK
[Features]
DocumentScannerconfiguration options- ScannerViewConfig
enableAutoCropMode?: boolean; // False by defaultenableSmartCaptureMode?: boolean; // False by defaultshowSubfooter: Toggle showing the subfooter container that allows users to toggle scan modes (Detect border, Smart capture, Auto crop).trueby defaultshowPoweredByDynamsoft: Toggle showingPowered by Dynamsoftmessage on the scanner view.trueby defaultminVerifiedFramesForAutoCapture: Change the minimum verified frames to auto capture the document.2frames are needed by default. Lower this number to make the capture faster (this could have an effect on accuracy/quality of image scanned).scanRegion: allows users to set a scan region while scanning a document
- ScannerViewConfig
export interface ScanRegion {
ratio: {
width: number;
height: number;
}; // Ratio of the scan region
regionBottomMargin: number; // Bottom margin calculated in pixel. This will "push" the scan region upwards
style: {
strokeWidth: number; // width of the scan region border
strokeColor: string; // color of the scan region border
};
}
- Added
Re-takebutton in Correction View. this will allow users to retake/rescan the document through the correction view. - Provide landscape support for the Document Scanner View (implemented in
document-scanner.ui.html) - Template optimization: Updated
scaleDownThresholdto1000 - Allow
launch()with a static image. A sample is provided undersample/scenarios/use-file-input.html - Set the default resolution when opening camera to
2Kresolution
[Fixes]
- Enable
OutputOriginalImageon the template by default. Before, it required us to enable it manually if we use a custom template. - Set
engineResourcePathsbeforeinitLicenseto prevent a bug when a user implements a custom engineResourcePath. - Update trial license banner link to lead to
https://www.dynamsoft.com/customer/license/trialLicense?product=mwc&deploymenttype=web
Docs
- Version update from 1.1.1 to 1.2.0
- Added docs on the new properties in
DocumentScannerConfig
v1.2.0-beta-1745342777464
Release Notes
SDK
[Features]
DocumentScannerconfiguration options- ScannerViewConfig
enableAutoCropMode?: boolean; // False by defaultenableSmartCaptureMode?: boolean; // False by defaultshowSubfooter: Toggle showing the subfooter container that allows users to toggle scan modes (Detect border, Smart capture, Auto crop).trueby defaultshowPoweredByDynamsoft: Toggle showingPowered by Dynamsoftmessage on the scanner view.trueby defaultminVerifiedFramesForAutoCapture: Change the minimum verified frames to auto capture the document.2frames are needed by default. Lower this number to make the capture faster (this could have an effect on accuracy/quality of image scanned).scanRegion: allows users to set a scan region while scanning a document
- ScannerViewConfig
export interface ScanRegion {
ratio: {
width: number;
height: number;
}; // Ratio of the scan region
regionBottomMargin: number; // Bottom margin calculated in pixel. This will "push" the scan region upwards
style: {
strokeWidth: number; // width of the scan region border
strokeColor: string; // color of the scan region border
};
}
- Added
Re-takebutton in Correction View. this will allow users to retake/rescan the document through the correction view. - Provide landscape support for the Document Scanner View (implemented in
document-scanner.ui.html) - Template optimization: Updated
scaleDownThresholdto1100 - Allow
launch()with a static image. A sample is provided undersample/scenarios/use-file-input.html
[Fixes]
- Enable
OutputOriginalImageon the template by default. Before, it required us to enable it manually if we use a custom template. - Set
engineResourcePathsbeforeinitLicenseto prevent a bug when a user implements a custom engineResourcePath. - Update trial license banner link to lead to
https://www.dynamsoft.com/customer/license/trialLicense?product=mwc&deploymenttype=web
Docs
- Version update from 1.1.1 to 1.2.0-beta...
- Added docs on the new properties in
DocumentScannerConfig[TODO]
v1.1.1
Release Notes
SDK
[Fixes]
- Fixed icon not showing up on Firefox mobile
Docs
- Version update from 1.1.0 to 1.1.1
v1.1.0
Release Notes
SDK
[Features]
DocumentScannerconfiguration options- View Control
showCorrectionView: Toggle correction view visibility and workflowshowResultView: Togle result view visibility and workflow- UI Changes
- Hidden
DocumentCorrectionView->Smart Capturebutton hidden onDocumentScannerView - Hidden
DocumentResultView->Applychanges toDoneinDocumentCorrectionView
- Hidden
- Resource Configuration
engineResourcePaths: to configure DCV engine resourcestemplateFilePath: set template file location
- View Control
- Added
EnumDDSViewsenum (Scanner/Result/Correction)
[Fixes]
- Fixed button state issues with hidden views
- Fixed
containertype flexibility inDocumentScannerViewConfig
Docs
- Version update from 1.0.3 to 1.1.0
- Added docs on the new properties in
DocumentScannerConfig - Change on Workflow customization
v1.0.3
Release Notes [Patch for v1.0.2]
SDK
[Fixes]
- Fixed missing devDependency in
package.json
Docs
- Version update from 1.0.2 to 1.0.3
v1.0.2
Release Notes
SDK
[BREAKING CHANGES]
- Renamed
ScanResultViewtoDocumentResultView. - Renamed
DocumentScanResulttoDocumentResult. - Renamed
scanResultViewConfigtoresultViewConfig. - Renamed
ControlButtontoToolbarConfig. - Changed
textproperty for toolbar buttons tolabel.
[Features]
- Added support for
<img>tags on toolbar icons. - Updated the Share PNG icon to match other products.
- Added an upload button when users specify the
onUploadfunction.
[Fixes]
- Fixed an issue where importing an image larger than the canvas dimensions caused the detected border to be positioned incorrectly. This was due to scaleDown not working properly.
Samples
[Features]
- Added a rotate message on
/demo.htmlto handle landscape mode.
[Fixes]
- Fixed an issue where the camera and resolution outline logic would break when transitioning from the Demo Camera to the Live Camera.
Docs
- Significantly updated the README and User Guide, including a link to the demo.
Built-in Server
- Changed the configuration to allow showcasing the "Upload" feature.
- Added URLs to specific pages when running
npm run serve.
v1.0.1
feat: release v1.0.1