cordova-plugin-scanbot-sdk - npm Package Compare versions

Comparing version 4.6.3-beta1 to 4.7.0-beta1

download-ios-framework.js

@@ -7,4 +7,4 @@
 
-const version = "1.12.3";
-const url = `https://download.scanbot.io/sdk/ios/scanbot-ios-sdk${version}.zip`;
+const version = "1.13.0-cordova";
+const url = `https://download.scanbot.io/sdk/ios-cordova/scanbot-ios-sdk${version}.zip`;
 const zipFile = "sdk-ios.zip";
@@ -11,0 +11,0 @@

index.d.ts

@@ -693,3 +693,165 @@ export interface DocumentScannerConfiguration
 
-type HealthInsuranceCardValidationType =
+export interface LicensePlateScannerConfiguration {
+    /**
+     * Background color of the top bar.
+     */
+    topBarBackgroundColor?: string;
+    /**
+     * Color of the top bar buttons.
+     */
+    topBarButtonsColor?: string;
+    /**
+     * String being displayed on the cancel button.
+     */
+    cancelButtonTitle?: string;
+    /**
+     * Color of the finder window's outline.
+     */
+    finderLineColor?: string;
+    /**
+     * Thickness of the finder window's outline.
+     */
+    finderLineWidth?: number;
+    /**
+     * Color of the text hint under the finder window.
+     */
+    finderTextHintColor?: string;
+    /**
+     * Should the flashlight be enabled on start?
+     */
+    flashEnabled?: boolean;
+    /**
+     * Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE.
+     * Android only.
+     */
+    useButtonsAllCaps?: boolean;
+    /**
+     * Title of the button that opens the screen where the user can allow
+     * the usage of the camera by the app.
+     */
+    enableCameraButtonTitle?: string;
+    /**
+     * Text that will be displayed when the app
+     * is not allowed to use the camera, prompting the user
+     * to enable the usage of the camera.
+     */
+    enableCameraExplanationText?: string;
+    /**
+     * Orientation lock mode of the UI and the camera preview.
+     * By default the orientation is not locked.
+     */
+    orientationLockMode?: CameraOrientationMode;
+    /**
+     * Detector mode, classic (OCR based) or ML (machine learning based) approach.
+     */
+    detectorMode?: LicensePlateDetectorMode;
+    /**
+     * User guidance hint text.
+     */
+    guidanceText?: string;
+}
+
+export interface DataScannerConfiguration {
+    /**
+     * Background color of the top bar.
+     */
+    topBarBackgroundColor?: string;
+    /**
+     * Color of the top bar buttons.
+     */
+    topBarButtonsColor?: string;
+    /**
+     * String being displayed on the cancel button.
+     */
+    cancelButtonTitle?: string;
+    /**
+     * Color of the finder window's outline.
+     */
+    finderLineColor?: string;
+    /**
+     * Thickness of the finder window's outline.
+     */
+    finderLineWidth?: number;
+    /**
+     * Color of the text hint under the finder window.
+     */
+    finderTextHintColor?: string;
+    /**
+     * Should the flashlight be enabled on start?
+     */
+    flashEnabled?: boolean;
+    /**
+     * Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE.
+     * Android only.
+     */
+    useButtonsAllCaps?: boolean;
+    /**
+     * Title of the button that opens the screen where the user can allow
+     * the usage of the camera by the app.
+     */
+    enableCameraButtonTitle?: string;
+    /**
+     * Text that will be displayed when the app
+     * is not allowed to use the camera, prompting the user
+     * to enable the usage of the camera.
+     */
+    enableCameraExplanationText?: string;
+    /**
+     * Orientation lock mode of the UI and the camera preview.
+     * By default the orientation is not locked.
+     */
+    orientationLockMode?: CameraOrientationMode;
+}
+
+export interface TextDataScannerStep {
+    /**
+     * User guidance hint text.
+     */
+    guidanceText: string;
+    /**
+     * Validation pattern to automatically validate recognized text.
+     * '?' = any character,
+     * '#' - any digit,
+     * all other characters represent themselves.
+     * An empty string or nil value will disable the validation pattern.
+     */
+    pattern?: string;
+    /**
+     * If set to TRUE pattern validation also validates successfully if only a part of the whole recognized text matches
+     * the the validation pattern.
+     * If set to FALSE, the whole text must match the validation pattern.
+     * Applies to pattern validation only. Defaults to FALSE.
+     */
+    shouldMatchSubstring?: boolean;
+    /**
+     * The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one
+     * to avoid clipping of finder area and maintain its aspect ratio and height;
+     */
+    preferredZoom?: number;
+    /**
+     * The aspect ratio of the view finder area.
+     */
+    aspectRatio?: FinderAspectRatio;
+    /**
+     * The preferred height of the finder for zoom scale 1.0 (unzoomed).
+     * The actual finder height might change to maintain aspect ratio and to not clip the screen.
+     * Defaults to 40 points.
+     */
+    unzoomedFinderHeight?: number;
+    /**
+     * A string (list) of accepted characters during text recognition. If empty or nil, all characters are accepted.
+     * Defaults to nil.
+     */
+    allowedSymbols?: string;
+    /**
+     * Recognition strategy for the text.
+     */
+    textFilterStrategy?: TextFilterStrategy;
+}
+
+export type LicensePlateDetectorMode = "CLASSIC" | "ML_BASED";
+
+export type TextFilterStrategy = "DOCUMENT" | "LC_DOT_MATRIX_DISPLAY";
+
+export type HealthInsuranceCardValidationType =
     "NONE"
@@ -890,2 +1052,19 @@ | "AUTO_ANY"
 
+export interface LicensePlateScannerResult {
+    status: Status;
+    licensePlateResult?: {
+        ocrValue: string;
+        countryCode?: string;
+        licensePlate: string;
+    }
+}
+
+export interface DataScannerResult {
+    status: Status;
+    dataResult?: {
+        textValue: string;
+        confidence: number;
+    }
+}
+
 export interface FinderAspectRatio {
@@ -966,2 +1145,4 @@ width: number;
     startEHICScanner(args?: {uiConfigs?: HealthInsuranceCardScannerConfiguration}): Promise<HealthInsuranceCardScannerResult>;
+    startLicensePlateScanner(args?: {uiConfigs?: LicensePlateScannerConfiguration}): Promise<LicensePlateScannerResult>;
+    startDataScanner(args?: {uiConfigs?: DataScannerConfiguration, scannerStep: TextDataScannerStep}): Promise<DataScannerResult>;
 }
@@ -1059,2 +1240,10 @@
         args?: {uiConfigs?: HealthInsuranceCardScannerConfiguration});
+    startLicensePlateScanner(
+        success: SuccessCallback<LicensePlateScannerResult>,
+        error: ErrorCallback,
+        args?: {uiConfigs?: LicensePlateScannerConfiguration});
+    startDataScanner(
+        success: SuccessCallback<DataScannerResult>,
+        error: ErrorCallback,
+        args?: {uiConfigs?: DataScannerConfiguration, scannerStep: TextDataScannerStep});
 }
@@ -1061,0 +1250,0 @@

package.json

 {
   "name": "cordova-plugin-scanbot-sdk",
-  "version": "4.6.3-beta1",
+  "version": "4.7.0-beta1",
   "description": "Cordova Plugin for Scanbot SDK",
@@ -5,0 +5,0 @@ "cordova": {

www/ScanbotSdk.js

@@ -34,2 +34,4 @@ /*
     startEHICScanner: makeUiCaller("startEHICScanner"),
+    startLicensePlateScanner: makeUiCaller("startLicensePlateScanner"),
+    startDataScanner: makeUiCaller("startDataScanner"),
   },
@@ -36,0 +38,0 @@

No alert changes

Improved metrics

Total package byte prevSize

393930

increased by6.13%

Number of package files

54

increased by3.85%

Lines of code

4574

increased by8.13%

No dependency changes