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

Comparing version 3.3.0 to 4.0.0-beta1

index.d.ts

@@ -30,3 +30,3 @@ export interface DocumentScannerConfiguration
     * A value of 1.0 triggers automatic capturing immediately, a value of 0.0 delays the automatic by 3 seconds.
-    * The default value is 0.66 (1 second).
+    * The default value is 0.66 (2 seconds)
     */
@@ -219,4 +219,4 @@ autoSnappingSensitivity?: number;
     shutterButtonHidden?: boolean;
-    /** 
-     * The text being displayed on the user-guidance label, when the scanners energy saver is activated. 
+    /**
+     * The text being displayed on the user-guidance label, when the scanners energy saver is activated.
      * iOS only.
@@ -383,93 +383,121 @@ */
 {
+    /**
+     * Allowed orientations for automatic interface rotations. *
+     */
+    allowedInterfaceOrientations?: UIInterfaceOrientationMask;
+    /**
+     * Specifies the way of barcode images generation or disables this generation at all.
+     * Use, if you want to receive a full sized image with barcodes.
+     * Defaults to SBSDKBarcodeImageGenerationTypeNone.
+     */
+    barcodeImageGenerationType?: SBSDKBarcodeImageGenerationType;
+    /**
+     * Foreground color of the flash button when flash is on.
+     */
     bottomButtonsActiveColor?: string;
+    /**
+     * Foreground color of the flash button when flash is off.
+     */
     bottomButtonsInactiveColor?: string;
     /**
-    * Background color outside of the finder window.
-    */
+     * Background color of the detection overlay.
+     */
     cameraOverlayColor?: string;
     /**
-    * Title of the cancel button.
-    */
+     * Whether the cancel button is hidden or not.
+     */
+    cancelButtonHidden?: boolean;
+    /**
+     * String being displayed on the cancel button.
+     */
     cancelButtonTitle?: string;
     /**
-    * 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;
-    /**
-    * Height of the finder window in pixels.
-    */
+     * Relative height of finder frame. Together with finderWidth it defines the aspect ratio, which is used to build actual finder frame. Default is 1.
+     * For example if finderWidth and finderHeight both equals 1 - it will make a square frame, which is good for QR capturing.
+     */
     finderHeight?: number;
     /**
-    * Color of the finder window's outline.
-    */
+     * Foreground color of the detection overlay.
+     */
     finderLineColor?: string;
     /**
-    * Thickness of the finder window's outline.
-    */
+     * Width of finder frame border. Default is 2.
+     */
     finderLineWidth?: number;
     /**
-    * Text hint shown under the finder window.
-    */
+     * String being displayed as description.
+     */
     finderTextHint?: string;
     /**
-    * Color of the text hint under the finder window.
-    */
+     * Foreground color of the description label.
+     */
     finderTextHintColor?: string;
     /**
-    * Width of the finder window in pixels.
-    */
+     * Relative width of finder frame. Together with finderHeight it defines the aspect ratio, which is used to build actual finder frame. Default is 1.
+     * For example if finderWidth and finderHeight both equals 1 - it will make a square frame, which is good for QR capturing.
+     */
     finderWidth?: number;
+    /**
+     * String being displayed on the flash button.
+     */
     flashButtonTitle?: string;
     /**
-    * Controls whether the flash should be initially enabled.
-    * The default value is FALSE.
-    */
+     * Whether flash is toggled on or off.
+     */
     flashEnabled?: boolean;
     /**
-    * Orientation lock mode of the camera: PORTRAIT or LANDSCAPE.
-    * By default the camera orientation is not locked.
-    */
-    orientationLockMode?: CameraOrientationMode;
-    /**
-    * Controls whether to play a beep sound after a successful detection.
-    * Default value is TRUE.
-    */
+     * Whether scanner screen should make a sound on successful barcode or MRZ detection.
+     */
     successBeepEnabled?: boolean;
     /**
-    * Background color of the top toolbar.
-    */
+     * Background color of the top bar.
+     */
     topBarBackgroundColor?: string;
     /**
-    * Color of the titles of all buttons in the top toolbar.
-    */
+     * Foreground color of the cancel button.
+     */
     topBarButtonsColor?: string;
+    /**
+     * Accepted barcode formats
+     */
+    barcodeFormats?: BarcodeFormat[];
+    /**
+     * iOS-only: true if the detector should also save image crops of each barcode
+     */
+    storeImages?: boolean;
 }
 
+export type UIInterfaceOrientationMask =
+    "PORTRAIT"
+    | "LANDSCAPE_LEFT"
+    | "LANDSCAPE_RIGHT"
+    | "PORTRAIT_UPSIDE_DOWN"
+    | "LANDSCAPE"
+    | "ALL"
+    | "ALL_BUT_UPSIDE_DOWN"
+    ;
+
+export type SBSDKBarcodeImageGenerationType =
+    "NONE"
+    | "FROM_VIDEO_FRAME"
+    | "CAPTURED_IMAGE"
+    ;
+
 export type BarcodeFormat =
-    "AZTEC"
-    | "CODABAR"
-    | "CODE_128"
-    | "CODE_39"
-    | "CODE_93"
-    | "DATA_MATRIX"
-    | "EAN_13"
-    | "EAN_8"
-    | "ITF"
-    | "MAXICODE"
-    | "PDF_417"
-    | "QR_CODE"
-    | "RSS_14"
-    | "RSS_EXPANDED"
-    | "UNKNOWN"
-    | "UPC_A"
-    | "UPC_E"
-    | "UPC_EAN_EXTENSION"
-;
+    "AZTEC" |
+    "CODABAR" |
+    "CODE_39" |
+    "CODE_93" |
+    "CODE_128" |
+    "DATA_MATRIX" |
+    "EAN_8" |
+    "EAN_13" |
+    "ITF" |
+    "PDF_417" |
+    "QR_CODE" |
+    "RSS_14" |
+    "RSS_EXPANDED" |
+    "UPC_A" |
+    "UPC_E" |
+    "UNKNOWN";
 
@@ -504,3 +532,3 @@ export type CameraPreviewMode =
 
-export type DetectionStatus = 
+export type DetectionStatus =
     "OK"
@@ -514,4 +542,3 @@ | "OK_BUT_TOO_SMALL"
     | "ERROR_TOO_DARK"
-    | "ERROR_TOO_NOISY"
-;
+    | "ERROR_TOO_NOISY";
 
@@ -533,4 +560,3 @@ export type Status = "OK" | "CANCELED";
     | "LOW_LIGHT_BINARIZATION_2"
-    | "EDGE_HIGHLIGHT"
-;
+    | "EDGE_HIGHLIGHT";
 
@@ -541,4 +567,3 @@ export type OCROutputFormat =
     | "PDF_FILE"
-    | "FULL_OCR_RESULT"
-;
+    | "FULL_OCR_RESULT";
 
@@ -553,18 +578,3 @@ export type PDFPageSize =
     | "AUTO"
-;
 
-export type TIFFCompression =
-    "NONE"
-    | "CCITTRLE"
-    | "CCITTFAX3"
-    | "CCITT_T4"
-    | "CCITTFAX4"
-    | "CCITT_T6"
-    | "CCITTRLEW"
-    | "LZW"
-    | "PACKBITS"
-    | "DEFLATE"
-    | "ADOBE_DEFLATE"
-;
-
 export interface DocumentDetectionResult {
@@ -576,2 +586,7 @@ detectionResult: DetectionStatus;
 
+export interface BarcodeDetectionResult {
+    status: DetectionStatus;
+    barcodes?: [];
+}
+
 export interface Point {
@@ -623,8 +638,52 @@ x: number;
 
+export interface LicenseInfo {
+    isLicenseValid: boolean;
+    licenseStatus: LicenseStatus;
+    licenseExpirationDate?: number;
+}
+
+export interface LicenseFailure {
+    licenseStatus: LicenseStatus;
+    licenseFeature: LicenseFeature;
+}
+
+export type LicenseStatus = "Okay" | "Trial" | "Expired" |
+    "WrongOS" | "Corrupted" | "AppIDMismatch" | "NotSet" | "Unknown";
+
+
+export type LicenseFeature =
+    "Cheque" | "OCR" | "QRCode" | "NoFeature" |
+    "CloudUpload" | "PDFCreation" | "W2Detection" |
+    "EdgeDetection" | "CreditCardRecognition" |
+    "DataIntelligence" | "MRZRecognition" |
+    "DisabilityCertRecognition" | "EdgeDetectionUI" |
+    "EHICRecognition" | "ImageProcessing" |
+    "InvoiceDetection" | "MultipleObjectsDetection" |
+    "PayformDetection" |"TextOrientationDetection" | "Unknown";
+
 export interface BarcodeResult {
     status: Status;
-    barcodeResult?: {
-        barcodeFormat?: BarcodeFormat;
-        textValue?: string;
-    }
+    barcodes?: [{
+        /**
+         * The barcode's format.
+         */
+        type: BarcodeFormat;
+
+        /**
+         * The raw text encoded into the barcode.
+         */
+        text: string;
+
+        /**
+         * URI of the image, containing the cropped-out image of the detected barcode. Available
+         * only for iOS, and only when the configs.storeImages option is set to true.
+         */
+        sourceImageUri?: string;
+    }]
+
+    /**
+     * Optional file URI of the captured camera image. Available only when
+     * `configs.barcodeImageGenerationType` is not `"NONE"`.
+     */
+    imageFileUri?: string;
 }
@@ -658,3 +717,4 @@
     initializeSdk(config: ScanbotSDKConfiguration): Promise<GenericResult>;
-    isLicenseValid(): Promise<GenericResult & {isLicenseValid: boolean}>;
+    getLicenseInfo(): Promise<GenericResult & {info: LicenseInfo}>;
+    setLicenseFailureHandler(success: SuccessCallback<LicenseFailure>): void;
 
@@ -665,2 +725,4 @@ detectDocument(args: {
     }): Promise<GenericResult & DocumentDetectionResult>;
+    detectBarcodesOnImage(args: { imageFileUri: string }): Promise<GenericResult & BarcodeDetectionResult>;
+
     applyImageFilter(args: {
@@ -677,15 +739,6 @@ imageFileUri: string,
 
-    getOcrConfigs(): Promise<GenericResult & {
-        languageDataPath: string;
-        installedLanguages: string[];
-    }>;
-    performOcr(args: {
-        images: string[];
-        languages: string[];
-        outputFormat?: OCROutputFormat;
-    }): Promise<GenericResult & {
-        plainText?: string;
-        pdfFileUri?: string;
-        jsonFileUri?: string;
-    }>;
+    getOcrConfigs(): Promise<GenericResult & { languageDataPath: string; installedLanguages: string[]; }>;
+    performOcr(
+        args: { images: string[]; languages: string[]; outputFormat?: OCROutputFormat;
+    }): Promise<GenericResult & { plainText?: string; pdfFileUri?: string; jsonFileUri?: string; }>;
 
@@ -697,4 +750,2 @@ createPdf(args: {images: string[], pageSize: PDFPageSize}): Promise<GenericResult & {pdfFileUri: string;}>;
         oneBitEncoded?: boolean;
-        dpi?: number;
-        compression?: TIFFCompression;
     }): Promise<GenericResult & {tiffFileUri: string;}>;
@@ -707,3 +758,4 @@
     rotatePage(args: {page: Page, times: number}): Promise<GenericResult & {page: Page}>;
-    getFilteredDocumentPreviewUri(args: {page: Page, imageFilter: ImageFilter}): Promise<GenericResult & {imageFileUri: string}>;
+    getFilteredDocumentPreviewUri(
+        args: {page: Page, imageFilter: ImageFilter}): Promise<GenericResult & {imageFileUri: string}>;
     removePage(args: {page: Page}): Promise<GenericResult>;
@@ -723,6 +775,18 @@
 export interface ScanbotSDKUICordova {
-    startDocumentScanner(success: SuccessCallback<DocumentScannerResult>, error: ErrorCallback, args?: {uiConfigs?: DocumentScannerConfiguration});
-    startCroppingScreen(success: SuccessCallback<CroppingResult>, error: ErrorCallback, args: {page: Page; uiConfigs?: CroppingScreenConfiguration});
-    startMrzScanner(success: SuccessCallback<MrzResult>, error: ErrorCallback, args?: {uiConfigs?: MrzScannerConfiguration});
-    startBarcodeScanner(success: SuccessCallback<BarcodeResult>, error: ErrorCallback, args?: {uiConfigs?: BarcodeScannerConfiguration});
+    startDocumentScanner(
+        success: SuccessCallback<DocumentScannerResult>,
+        error: ErrorCallback,
+        args?: {uiConfigs?: DocumentScannerConfiguration});
+    startCroppingScreen(
+        success: SuccessCallback<CroppingResult>,
+        error: ErrorCallback,
+        args: {page: Page; uiConfigs?: CroppingScreenConfiguration});
+    startMrzScanner(
+        success: SuccessCallback<MrzResult>,
+        error: ErrorCallback,
+        args?: {uiConfigs?: MrzScannerConfiguration});
+    startBarcodeScanner(
+        success: SuccessCallback<BarcodeResult>,
+        error: ErrorCallback,
+        args?: {uiConfigs?: BarcodeScannerConfiguration});
 }
@@ -732,3 +796,4 @@
     /**
-     * Returns a promisified version of the Scanbot SDK API. Available only if there is also an available Promise global function.
+     * Returns a promisified version of the Scanbot SDK API.
+     * Available only if there is also an available Promise global function.
      */
@@ -739,50 +804,70 @@ promisify?(): ScanbotSDK;
 
-    initializeSdk(success: SuccessCallback<GenericResult>, error: ErrorCallback, config: ScanbotSDKConfiguration): void;
-    isLicenseValid(success: SuccessCallback<GenericResult & {isLicenseValid: boolean}>, error: ErrorCallback): void;
+    initializeSdk(
+        success: SuccessCallback<GenericResult>,
+        error: ErrorCallback,
+        config: ScanbotSDKConfiguration): void;
+    getLicenseInfo(
+        success: SuccessCallback<GenericResult & {info: LicenseInfo}>,
+        error: ErrorCallback): void;
+    setLicenseFailureHandler(callback): void;
 
-    detectDocument(success: SuccessCallback<GenericResult & DocumentDetectionResult>, error: ErrorCallback, args: {
-        imageFileUri: string,
-        quality?: number
+    detectBarcodesOnImage(
+        success: SuccessCallback<GenericResult & BarcodeDetectionResult>,
+        error: ErrorCallback, args: { imageFileUri: string }): void;
+    detectDocument(
+        success: SuccessCallback<GenericResult & DocumentDetectionResult>,
+        error: ErrorCallback, args: { imageFileUri: string, quality?: number }): void;
+    applyImageFilter(
+        success: SuccessCallback<GenericResult & {imageFileUri: string}>,
+        error: ErrorCallback, args: { imageFileUri: string, imageFilter: ImageFilter, quality?: number
     }): void;
-    applyImageFilter(success: SuccessCallback<GenericResult & {imageFileUri: string}>, error: ErrorCallback, args: {
-        imageFileUri: string,
-        imageFilter: ImageFilter,
-        quality?: number
+    rotateImage(
+        success: SuccessCallback<GenericResult & {imageFileUri: string}>,
+        error: ErrorCallback, args: { imageFileUri: string, degrees: number, quality?: number
     }): void;
-    rotateImage(success: SuccessCallback<GenericResult & {imageFileUri: string}>, error: ErrorCallback, args: {
-        imageFileUri: string,
-        degrees: number,
-        quality?: number
+    getOcrConfigs(
+        success: SuccessCallback<GenericResult & { languageDataPath: string; installedLanguages: string[]; }>,
+        error: ErrorCallback): void;
+    performOcr(
+        success: SuccessCallback<GenericResult & { plainText?: string; pdfFileUri?: string; }>,
+        error: ErrorCallback, args: { images: string[]; languages: string[]; outputFormat?: OCROutputFormat;
     }): void;
 
-    getOcrConfigs(success: SuccessCallback<GenericResult & {
-        languageDataPath: string;
-        installedLanguages: string[];
-    }>, error: ErrorCallback): void;
-    performOcr(success: SuccessCallback<GenericResult & {
-        plainText?: string;
-        pdfFileUri?: string;
-    }>, error: ErrorCallback, args: {
-        images: string[];
-        languages: string[];
-        outputFormat?: OCROutputFormat;
-    }): void;
+    createPdf(
+        success: SuccessCallback<GenericResult & {pdfFileUri: string}>,
+        error: ErrorCallback,
+        args: {images: string[], pageSize: PDFPageSize}): void;
 
-    createPdf(success: SuccessCallback<GenericResult & {pdfFileUri: string}>, error: ErrorCallback, args: {images: string[], pageSize: PDFPageSize}): void;
+    writeTiff(
+        success: SuccessCallback<GenericResult & {tiffFileUri: string}>,
+        error: ErrorCallback, args: { images: string[]; oneBitEncoded?: boolean; }): void;
 
-    writeTiff(success: SuccessCallback<GenericResult & {tiffFileUri: string}>, error: ErrorCallback, args: {
-        images: string[];
-        oneBitEncoded?: boolean;
-        dpi?: number;
-        compression?: TIFFCompression;
-    }): void;
+    createPage(
+        success: SuccessCallback<GenericResult & {page: Page}>,
+        error: ErrorCallback,
+        args: {originalImageFileUri: string}): void;
+    setDocumentImage(
+        success: SuccessCallback<GenericResult & {page: Page}>,
+        error: ErrorCallback,
+        args: {page: Page, imageUri: string}): void;
+    detectDocumentOnPage(
+        success: SuccessCallback<GenericResult & {page: Page}>,
+        error: ErrorCallback,
+        args: {page: Page}): void;
+    applyImageFilterOnPage(
+        success: SuccessCallback<GenericResult & {page: Page}>,
+        error: ErrorCallback,
+        args: {page: Page, imageFilter: ImageFilter}): void;
+    rotatePage(
+        success: SuccessCallback<GenericResult & {page: Page}>,
+        error: ErrorCallback,
+        args: {page: Page, times: number}): void;
+    getFilteredDocumentPreviewUri(
+        success: SuccessCallback<GenericResult & {imageFileUri: string}>,
+        error: ErrorCallback,
+        args: {page: Page, imageFilter: ImageFilter}): void;
+    removePage(
+        success: SuccessCallback<GenericResult>,
+        error: ErrorCallback, page: Page): void;
 
-    createPage(success: SuccessCallback<GenericResult & {page: Page}>, error: ErrorCallback, args: {originalImageFileUri: string}): void;
-    setDocumentImage(success: SuccessCallback<GenericResult & {page: Page}>, error: ErrorCallback, args: {page: Page, imageUri: string}): void;
-    detectDocumentOnPage(success: SuccessCallback<GenericResult & {page: Page}>, error: ErrorCallback, args: {page: Page}): void;
-    applyImageFilterOnPage(success: SuccessCallback<GenericResult & {page: Page}>, error: ErrorCallback, args: {page: Page, imageFilter: ImageFilter}): void;
-    rotatePage(success: SuccessCallback<GenericResult & {page: Page}>, error: ErrorCallback, args: {page: Page, times: number}): void;
-    getFilteredDocumentPreviewUri(success: SuccessCallback<GenericResult & {imageFileUri: string}>, error: ErrorCallback, args: {page: Page, imageFilter: ImageFilter}): void;
-    removePage(success: SuccessCallback<GenericResult>, error: ErrorCallback, page: Page): void;
-
     cleanup(success: SuccessCallback<GenericResult>, error: ErrorCallback): void;
@@ -789,0 +874,0 @@ }

Libraries.txt

@@ -1,2 +0,2 @@
-Open Source libraries used in the Scanbot SDK for Android version 1.39.56.3:
+Open Source libraries used in the Scanbot SDK for Android version 1.39.52.2:
 
@@ -3,0 +3,0 @@ Android PDF Writer version 1.0.8

package.json

 {
   "name": "cordova-plugin-scanbot-sdk",
-  "version": "3.3.0",
+  "version": "4.0.0-beta1",
   "description": "Cordova Plugin for Scanbot SDK",
@@ -12,29 +12,30 @@ "cordova": {
   },
-  "scripts": {
-    "prepublish": "./prepare-scanbotsdk-framework.sh 1.9.3"
-  },
   "types": "index.d.ts",
   "main": "www/ScanbotSdk.js",
   "keywords": [
+    "scanbot",
+    "sdk",
+    "camera",
+    "scanner",
+    "scanning",
+    "document detection",
     "document scanner",
-    "barcode scanner",
-    "qr code scanner",
-    "qrcode",
-    "mrz scanner",
-    "scanner sdk",
-    "scanning sdk",
-    "scanbot sdk",
-    "document detection",
     "edge detection",
     "cropping",
+    "pdf",
+    "pdf creation",
+    "image optimization",
     "image filter",
-    "pdf",
-    "tiff",
     "ocr",
     "optical character recognition",
-    "ios",
-    "android",
-    "camera",
+    "barcode",
+    "barcode scanner",
+    "qr code",
+    "qr code scanner",
+    "mrz scanner",
     "cordova",
-    "ionic"
+    "plugin",
+    "ecosystem:cordova",
+    "cordova-android",
+    "cordova-ios"
   ],
@@ -41,0 +42,0 @@ "author": "doo GmbH",

README.md

@@ -1,16 +0,7 @@
-# Scanbot Document and Barcode Scanner SDK for Cordova
+# Scanbot SDK Cordova Plugin
 
 The [Scanbot SDK](https://scanbot.io/sdk.html) brings scanning and document creation capabilities to your mobile apps.
 
-This Cordova plugin provides implementations of the Scanbot Document Scanner SDK for Android and iOS.
+This Cordova plugin provides implementations of Scanbot SDK for iOS and Android.
 
-
-# Example App
-
-👉 [Ionic example app](https://github.com/doo/scanbot-sdk-example-ionic)
-
-
-# Documentation
-
-For the full API reference of the Scanbot SDK Cordova Plugin please check out 
-the [documentation](https://scanbotsdk.github.io/documentation/cordova/).
+For more details please see this [documentation page](https://scanbotsdk.github.io/documentation/cordova/).

www/ScanbotSdk.js

@@ -29,3 +29,2 @@ /*
     // Scanbot SDK UI functions:
-
     startDocumentScanner: makeUiCaller("startDocumentScanner"),
@@ -41,3 +40,16 @@ startCroppingScreen: makeUiCaller("startCroppingScreen"),
   initializeSdk: makeCaller("initializeSdk"),
-  isLicenseValid: makeCaller("isLicenseValid"),
+  getLicenseInfo: makeCaller("getLicenseInfo"),
+  setLicenseFailureHandler: function(callback) {
+    console.log("setLicenseFailureHandler: ", callback);
+    cordova.exec(
+        function(params) {
+          console.log("successcallback");
+          // TODO: callback reaches this point, but not the client code
+          callback(params);
+        },
+        function() {
+          console.log("errorcallback")
+        }, "ScanbotSdk", "setLicenseFailureHandler", []);
+  },
+
   detectDocument: makeCaller("detectDocument"),
@@ -57,2 +69,5 @@ applyImageFilter: makeCaller("applyImageFilter"),
   removePage: makeCaller("removePage"),
+
+  detectBarcodesOnImage: makeCaller("detectBarcodesOnImage"),
+
   cleanup: makeCaller("cleanup")
@@ -75,3 +90,6 @@ };
         var prop = obj[propName];
-        if (typeof prop === "function" && prop.__is_cordova_wrapper__) {
+        /**
+         * TODO: Is this prop necessary? It prevents the normal callback needed for setLicenseFailureHandler
+         */
+        if (typeof prop === "function"/* && prop.__is_cordova_wrapper__*/) {
           wrapper[propName] = promisify(prop);
@@ -91,5 +109,5 @@ }
     }
-  }  
+  }
 })();
 
 module.exports = API;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

285885989

Number of package files

274

increased by0.37%

Lines of code

892

increased by11.36%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

8

decreased by-52.94%

No dependency changes