Skip to content

Releases: Dynamsoft/document-scanner-javascript

v1.4.0

25 Nov 01:25
v1.4.0

Choose a tag to compare

Features

Breaking changes

  • Rename document-scanner.ui.html to document-scanner.ui.xml to better reflect its purpose as a declarative UI configuration template.
    • This affects self hosting users only - you must update the path in the scannerViewConfig.cameraEnhancerUIPath property accordingly and rebuild the library.

Scanning Capabilities

  • Select the clearest of multiple video frames on scan with enableFrameVerification (default true).
  • Add continuous scanning mode to make multiple scans on a single launch(), enabled by enableContinuousScanning (default false).
    • Add onDocumentScanned handler 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 onThumbnailClicked click handler.
    • Add stopContinuousScanning to programmatically stop the scanning loop.
  • Add enableBoundsDetectionMode to 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 tsdoc annotation coverage for all MDS APIs to bring API references to IDEs and allow content extraction with compatible development tools.

Dependencies

v1.3.1

05 Sep 19:36
f2486a1

Choose a tag to compare

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 boundsDetectionEnabled to true for clarity, since its value was already overridden during MDS instantiation.
  • Changed the type of DocumentResult.correctedImageResult from DeskewedImageResultItem | DSImageData to DeskewedImageResultItem to resolve a TypeScript error when calling methods like toCanvas().
  • Created the dds.esm.d.ts declaration file to fix ESM import/export issues.

Dependencies

Documentation

  • Updated SDK versions from v1.2.0 to v1.3.1.
  • Added tsdoc annotations to bring API references to IDEs and support compatible development tools.
  • Added developer guides for JavaScript Framework samples.

v1.3.0-beta-202509040001

05 Sep 00:44

Choose a tag to compare

Pre-release

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 boundsDetectionEnabled to true to make code clearer, since its value already overridden to true when instantiating the MDS object.
  • Change the type of DocumentResult.correctedImageResult from DeskewedImageResultItem | DSImageData to DeskewedImageResultItem to fix a TypeScript error when calling methods like toCanvas().
  • Create the dds.esm.d.ts declaration file to fix ESM import/export issues.

Dependencies

Documentation

  • Update SDK versions from v1.2.0 to v1.3.0.
  • Add tsdoc annotations to bring API references to IDEs and allow content extraction with compatible development tools.
  • Add developer guides for JavaScript Framework samples.

v1.2.0

30 Apr 22:30

Choose a tag to compare

Release Notes

SDK

[Features]

  • DocumentScanner configuration options
    • ScannerViewConfig
      • enableAutoCropMode?: boolean; // False by default
      • enableSmartCaptureMode?: boolean; // False by default
      • showSubfooter: Toggle showing the subfooter container that allows users to toggle scan modes (Detect border, Smart capture, Auto crop). true by default
      • showPoweredByDynamsoft: Toggle showing Powered by Dynamsoft message on the scanner view. true by default
      • minVerifiedFramesForAutoCapture: Change the minimum verified frames to auto capture the document. 2 frames 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
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-take button 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 indocument-scanner.ui.html)
  • Template optimization: Updated scaleDownThreshold to 1000
  • Allow launch() with a static image. A sample is provided under sample/scenarios/use-file-input.html
  • Set the default resolution when opening camera to 2K resolution

[Fixes]

  • Enable OutputOriginalImage on the template by default. Before, it required us to enable it manually if we use a custom template.
  • Set engineResourcePaths before initLicense to 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

29 Apr 02:14

Choose a tag to compare

Pre-release

Release Notes

SDK

[Features]

  • DocumentScanner configuration options
    • ScannerViewConfig
      • enableAutoCropMode?: boolean; // False by default
      • enableSmartCaptureMode?: boolean; // False by default
      • showSubfooter: Toggle showing the subfooter container that allows users to toggle scan modes (Detect border, Smart capture, Auto crop). true by default
      • showPoweredByDynamsoft: Toggle showing Powered by Dynamsoft message on the scanner view. true by default
      • minVerifiedFramesForAutoCapture: Change the minimum verified frames to auto capture the document. 2 frames 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
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-take button 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 indocument-scanner.ui.html)
  • Template optimization: Updated scaleDownThreshold to 1100
  • Allow launch() with a static image. A sample is provided under sample/scenarios/use-file-input.html

[Fixes]

  • Enable OutputOriginalImage on the template by default. Before, it required us to enable it manually if we use a custom template.
  • Set engineResourcePaths before initLicense to 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

08 Feb 04:48
9a9508c

Choose a tag to compare

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

08 Feb 02:58
f107f76

Choose a tag to compare

Release Notes

SDK

[Features]

  • DocumentScanner configuration options
    • View Control
      • showCorrectionView: Toggle correction view visibility and workflow
      • showResultView: Togle result view visibility and workflow
      • UI Changes
        • Hidden DocumentCorrectionView -> Smart Capture button hidden on DocumentScannerView
        • Hidden DocumentResultView -> Apply changes to Done in DocumentCorrectionView
    • Resource Configuration
      • engineResourcePaths: to configure DCV engine resources
      • templateFilePath: set template file location
  • Added EnumDDSViews enum (Scanner/Result/Correction)

[Fixes]

  • Fixed button state issues with hidden views
  • Fixed container type flexibility in DocumentScannerViewConfig

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

08 Feb 02:58

Choose a tag to compare

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

06 Feb 00:27
b08e0a8

Choose a tag to compare

Release Notes

SDK

[BREAKING CHANGES]

  • Renamed ScanResultView to DocumentResultView.
  • Renamed DocumentScanResult to DocumentResult.
  • Renamed scanResultViewConfig to resultViewConfig.
  • Renamed ControlButton to ToolbarConfig.
  • Changed text property for toolbar buttons to label.

[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 onUpload function.

[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.html to 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

28 Jan 00:13

Choose a tag to compare

feat: release v1.0.1