scanbot-web-sdk 5.0.0-alpha.2 → 5.0.0-rc.2

package/@types/document-scanner-view.d.ts

@@ -24,7 +24,7 @@ export default class DocumentScannerView extends ScannerView<DocumentScannerProp
     get defaultAction(): ShutterButtonAction;
     get enabled(): boolean;
     get configuration(): DocumentScannerConfiguration;
-    get autoCaptureDelay(): number;
+    get autoCaptureSensitivity(): number;
     /**
      * Public API functions
      */
@@ -43,6 +43,7 @@ export default class DocumentScannerView extends ScannerView<DocumentScannerProp
     detect(): Promise<void>;
     getStatusString(detectionResult: any): string;
     detectInWebWorker(): Promise<any>;
+    preventAutoCapture?: boolean;
     handleAutoCapture(statusOk: boolean, polygon?: Polygon): Promise<void>;
     updateButton(action: ShutterButtonAction): void;
     render(): JSX.Element;

package/@types/model/configuration/document-scanner-configuration.d.ts

@@ -74,6 +74,14 @@ export declare class DocumentScannerConfiguration extends ScannerConfiguration {
      * a value of 0.0 delays the automatic by 3 seconds. The default value is 0.66 (2 seconds)
      */
     autoCaptureSensitivity?: number;
+    /**
+     * Delay in milliseconds before the auto-capture is triggered after 'onDocumentDetected' has been called.
+     * This delay is used to prevent too many documents being captured in a row.
+     * In essence, autoCaptureSensitivity controls the speed of autocapture during the detection phase,
+     * while autoCaptureDelay controls the speed of autocapture after the detection phase.
+     * Default is 1000ms.
+     */
+    autoCaptureDelay?: number;
     /**
      * Determines whether to ignore the OK_BUT_BAD_ASPECT_RATIO detection status.
      * By default BadAspectRatio is not ignored.

package/@types/service/pdf-generator.d.ts

@@ -52,12 +52,16 @@ export declare type PageFit = "FIT_IN" | "FILL_IN" | "STRETCH" | "NONE";
  *       resulting PDF will be smaller in size.
  */
 export interface PdfGenerationOptions {
-    /** Physical size of the page. If CUSTOM, the page size will be set as the image size at given dpi. */
+    /** Physical size of the page. If CUSTOM, the page size will be set as the image size at given dpi.
+     * Default value: A4
+     * */
     standardPaperSize?: PageSize;
+    /** Default value: PORTRAIT */
     pageDirection?: PageDirection;
     /** How to fit the image into the page. Only used if `pageSize` is not `CUSTOM`.
      * The image can either be stretched to fill the page, in one of three ways, or
      * centered on the page without stretching.
+     * Default value: FIT_IN
      */
     pageFit?: PageFit;
     /** The `dpi` parameter has two different meanings depending on the value of `pageSize` and
@@ -66,17 +70,23 @@ export interface PdfGenerationOptions {
      * raw) to the PDF. Otherwise, if `resample` is true, then the image is downscaled if necessary
      * (if the image after being fit to the page has a higher calculated DPI than `dpi`) to match
      * `dpi` before adding it to the PDF. Otherwise, the setting is ignored and the calculated
-     * image DPI is used instead. */
+     * image DPI is used instead.
+     * Default value: 72
+     */
     dpi?: number;
     /** JPEG quality for images.
      * Applies if an image is added as a cv::Mat and therefore needs to be encoded.
      * Also applies if `resample` is true and the image being added needs to be downscaled.
      * Otherwise, when adding JPEG files to the PDF, the files are copied directly into the PDF and
-     * not re-encoded, which is many times faster and also preserves the quality of the original. */
+     * not re-encoded, which is many times faster and also preserves the quality of the original.
+     * Default value: 80
+     */
     jpegQuality?: number;
     /** false: always geometrically rescale the image to fit the page if necessary. Fast.
      * true: downscale the bitmap to match the `dpi` setting before adding it to the PDF if
-     *    the calculated image DPI after stretching is greater than `dpi`. Slower. */
+     *       the calculated image DPI after stretching is greater than `dpi`. Slower.
+     * Default value: false
+     */
     resample?: boolean;
 }
 export default class PdfGenerator {

package/@types/view/document-outline.d.ts

@@ -6,7 +6,7 @@ import { OutlineStyleConfiguration } from "../model/configuration/document-scann
 export interface DocumentOutlineProps {
     style?: OutlineStyleConfiguration;
     action?: ShutterButtonAction;
-    autoCaptureDelay?: number;
+    autoCaptureSensitivity?: number;
 }
 export declare class DocumentOutline extends React.Component<DocumentOutlineProps, any> {
     hintLabelClassName: string;

package/@types/view/polygon/animated-document-polygon.d.ts

@@ -5,7 +5,7 @@ import { ShutterButtonAction } from "../shutter-button";
 import { CaptureAnimationStyleConfiguration, OutlinePolygonStyleConfiguration } from "../../model/configuration/document-scanner-configuration";
 export declare class AnimatedDocumentPolygonProps {
     action?: ShutterButtonAction;
-    autoCaptureDelay?: number;
+    autoCaptureSensitivity?: number;
     style?: any;
     isOk?: boolean;
     isVisible?: boolean;

package/README.md

@@ -1,14 +1,14 @@
-# Web Scan SDK
+# Scanbot Web SDK
+
+## JavaScript Document Scanner, Barcode Scanner, and Data Capture SDK for the Web
 
-## Add enterprise-grade barcode-, MRZ-, and document scanning to your app in no time
 The Scanbot Web SDK makes it possible to add barcode-, MRZ-, as well as 
 [document scanning to your website or to your web application](https://scanbot.io/products/document-scanning/web-document-scanner/).
 
-The Scanbot Web SDK is based on WebAssembly and the HTML Media Capture API and can be used on iOS 
-(Safari; Chrome and Firefox as of iOS 14.4.2) and Android (Chrome, Firefox, Edge, Samsung Internet).
-
+The Scanbot Web SDK is based on WebAssembly and the HTML Media Capture API and can be used on iOS 14.5+
+(Safari, Chrome, Firefox, Edge) and Android (Chrome, Firefox, Edge, Samsung Internet).
 
-# Barcode Scanner for the Web
+## Barcode Scanner for the Web
 The [Web Barcode Scanner](https://scanbot.io/products/barcode-software/web-barcode-scanner/) allows you to easily 
 implement barcode scanning. Determine the barcode type, the data contained in it, and data from a potentially 
 binary result (rawBytes).
@@ -35,8 +35,7 @@ like [Code 39](https://scanbot.io/products/barcode-software/1d-barcode-scanner/c
 
 Check out our [live demo](https://scanbot.io/trial/demo-web/barcode-demo/).
 
-
-# Document Scanner for the Web
+## Document Scanner for the Web
 The [Web Document Scanner](https://scanbot.io/products/document-scanning/web-document-scanner/) allows you to easily 
 implement real-time document detection with user guidance, auto-snapping, auto-cropping, and perspective correction.
 
@@ -45,15 +44,13 @@ as well as the option to save detected documents as PDF or TIFF.
 
 Check out our [live demo](https://scanbot.io/trial/demo-web/).
 
-
-# MRZ Scanner for the Web
+## MRZ Scanner for the Web
 With the Scanbot [MRZ Scanner SDK for the web](https://scanbot.io/products/data-capture/mrz-software/web-mrz-scanner/), 
 you can extract personal data from machine-readable zones (MRZ), for example on ID cards.
 
 Check out our [live demo](https://scanbot.io/trial/demo-web/).
 
-
-# Documentation & Example App
+## Documentation & Example App
 To integrate this plugin into your application please follow the steps in our 
 [documentation](https://docs.scanbot.io/document-scanner-sdk/web/introduction/) and check out our Angular, React and 
 plain JS [example apps](https://github.com/doo/scanbot-sdk-example-web).
@@ -62,8 +59,7 @@ This library is meant to be used natively in a web browser, if you are instead l
 please go here: [Document Scanner](https://www.npmjs.com/package/cordova-plugin-scanbot-sdk) / 
 [Barcode Scanner](https://www.npmjs.com/package/cordova-plugin-scanbot-barcode-scanner).
 
-
-# Changelog
+## Changelog
 For a detailed list of the changes included in each version, please see the 
 [changelog](https://docs.scanbot.io/document-scanner-sdk/web/changelog/).
 
@@ -75,4 +71,4 @@ Please kindly note that a trial license can only be used in a **development and
 
 
 ## Free Developer Support
-We provide free "no-strings-attached" developer support for the implementation & testing of the Scanbot SDK. If you encounter technical issues with integrating the Scanbot SDK or need advice on choosing the appropriate framework or features, please visit our [Support Page](https://docs.scanbot.io/support/).
+We provide free "no-strings-attached" developer support for the implementation & testing of the Scanbot SDK. If you encounter technical issues with integrating the Scanbot SDK or need advice on choosing the appropriate framework or features, please visit our [Support Page](https://docs.scanbot.io/support/).