react-native-scanbot-barcode-scanner-sdk 7.1.2-rc.2 → 8.0.0-rc.1

package/src/{imageRef → types/core/image}/image.ts

@@ -1,6 +1,7 @@
-import { NativeModules, Platform } from 'react-native';
-import { ImageSerializationMode } from '../utils';
-import { DeepPartial, PartiallyConstructible } from '../utils/utils';
+import { NativeModules } from 'react-native';
+import { InvalidImageRefError } from '../../base/errors';
+import { ImageSerializationMode } from '../common/JsonSerializationTypes';
+import { DeepPartial } from '../utils/utils';
 import {
   BufferImageLoadOptions,
   EncodeImageOptions,
@@ -10,19 +11,13 @@ import {
   SaveImageOptions,
 } from './ImageRefTypes';
 
-const LINKING_ERROR =
-  `The package 'react-native-scanbot-barcode-scanner-sdk' doesn't seem to be linked. Make sure: \n\n` +
-  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
-  '- You rebuilt the app after installing the package\n' +
-  '- You are not using Expo Go\n';
-
-const ScanbotBarcodeSDKImpl = NativeModules.ScanbotBarcodeSdk
+const ScanbotBarcodeSDKModule = NativeModules.ScanbotBarcodeSdk
   ? NativeModules.ScanbotBarcodeSdk
   : new Proxy(
       {},
       {
         get() {
-          throw new Error(LINKING_ERROR);
+          throw new Error();
         },
       }
     );
@@ -69,12 +64,10 @@ export async function autorelease<TReturn>(
   }
 }
 
-export abstract class AutoReleasable extends PartiallyConstructible {
+abstract class AutoReleasable {
   private retained: boolean = false;
 
   protected constructor(uniqueId?: string) {
-    super();
-
     if (uniqueId) {
       if (AutoReleasePool.globalPull === null) {
         const errorMessage =
@@ -83,7 +76,7 @@ export abstract class AutoReleasable extends PartiallyConstructible {
           '\n  const barcodeItem = new BarcodeItem(source);' +
           '\n });';
 
-        throw new Error(errorMessage);
+        throw new InvalidImageRefError(errorMessage);
       }
 
       AutoReleasePool.globalPull.addObject(this);
@@ -118,7 +111,7 @@ export class ImageRef extends AutoReleasable {
     this._buffer = buffer;
   }
 
-  public static From(source: DeepPartial<ImageRef>): ImageRef {
+  public static from(source: DeepPartial<ImageRef>): ImageRef {
     if (source.buffer) {
       return new ImageRef(undefined, source.buffer);
     } else {
@@ -128,22 +121,18 @@ export class ImageRef extends AutoReleasable {
 
   public static deserialize(serializedRef: DeepPartial<ImageRef>): ImageRef {
     if (!serializedRef.uniqueId) {
-      throw new Error('uniqueId must be present in serializedRef argument');
+      throw new InvalidImageRefError('uniqueId must be present in serializedRef argument');
     }
 
     // The promise is intentionally not awaited here
-    ScanbotBarcodeSDKImpl.imageRefDeserialize(serializedRef.uniqueId)
-      .catch((error: any) => {
-        console.error(
-          `Error while deserializing ImageRef with uniqueId ${serializedRef.uniqueId}: ${error}`
-        );
-      })
+    ScanbotBarcodeSDKModule.imageRefDeserialize({ uniqueId: serializedRef.uniqueId })
       .then((success: boolean) => {
         if (!success) {
-          console.error(
-            `Unsuccessful deserialization of ImageRef with uniqueId ${serializedRef.uniqueId}`
-          );
+          console.error(`Unsuccessful deserialization of ImageRef with uniqueId ${serializedRef.uniqueId}`);
         }
+      })
+      .catch((error: any) => {
+        console.error(`Error while deserializing ImageRef with uniqueId ${serializedRef.uniqueId}: ${error}`);
       });
 
     return new ImageRef(serializedRef.uniqueId, undefined);
@@ -168,16 +157,14 @@ export class ImageRef extends AutoReleasable {
       this.throwErrorIfReleased();
 
       // The promise is intentionally not awaited here
-      ScanbotBarcodeSDKImpl.imageRefSerialize(this.uniqueId)
-        .catch((error: any) => {
-          console.error(
-            `Error while serializing ImageRef with uniqueId ${this.uniqueId}: ${error}`
-          );
-        })
+      ScanbotBarcodeSDKModule.imageRefSerialize({ uniqueId: this.uniqueId })
         .then((success: boolean) => {
           if (!success) {
             console.error(`Unsuccessful serialization of ImageRef with uniqueId ${this.uniqueId}`);
           }
+        })
+        .catch((error: any) => {
+          console.error(`Error while serializing ImageRef with uniqueId ${this.uniqueId}: ${error}`);
         });
 
       return { uniqueId: this.uniqueId };
@@ -185,7 +172,7 @@ export class ImageRef extends AutoReleasable {
   }
 
   /**
-   * Creates ImageRef with uniqueId from the path to an image.
+   * Creates ImageRef with uniqueId from the file uri to an image.
    */
   public static async fromImageFileUri(
     uri: string,
@@ -193,7 +180,7 @@ export class ImageRef extends AutoReleasable {
   ): Promise<ImageRef | null> {
     try {
       const serializedImageRefUniqueId: string =
-        await ScanbotBarcodeSDKImpl.imageRefFromImageFileUri(uri, options);
+        await ScanbotBarcodeSDKModule.imageRefFromImageFileUri({ uri, options });
 
       return ImageRef.deserialize({ uniqueId: serializedImageRefUniqueId });
     } catch (error: any) {
@@ -212,28 +199,7 @@ export class ImageRef extends AutoReleasable {
   ): Promise<ImageRef | null> {
     try {
       const serializedImageRefUniqueId: string =
-        await ScanbotBarcodeSDKImpl.imageRefFromEncodedBuffer(buffer, options);
-
-      return ImageRef.deserialize({ uniqueId: serializedImageRefUniqueId });
-    } catch (error: any) {
-      console.error(error);
-
-      return null;
-    }
-  }
-
-  /**
-   * Creates a deep copy of the image.
-   * If uniqueId is not set or the image is already released, an exception will be thrown.
-   */
-  public async clone(): Promise<ImageRef | null> {
-    this.throwErrorIfUniqueIdIsMissing();
-    this.throwErrorIfReleased();
-
-    try {
-      const serializedImageRefUniqueId: string = await ScanbotBarcodeSDKImpl.imageRefClone(
-        this.uniqueId
-      );
+        await ScanbotBarcodeSDKModule.imageRefFromEncodedBuffer({ buffer, options });
 
       return ImageRef.deserialize({ uniqueId: serializedImageRefUniqueId });
     } catch (error: any) {
@@ -252,7 +218,7 @@ export class ImageRef extends AutoReleasable {
     this.throwErrorIfReleased();
 
     try {
-      await ScanbotBarcodeSDKImpl.imageRefHibernate(this.uniqueId);
+      await ScanbotBarcodeSDKModule.imageRefHibernate({ uniqueId: this.uniqueId });
     } catch (error: any) {
       console.error(error);
     }
@@ -268,7 +234,7 @@ export class ImageRef extends AutoReleasable {
     this.throwErrorIfReleased();
 
     try {
-      await ScanbotBarcodeSDKImpl.imageRefClear(this.uniqueId);
+      await ScanbotBarcodeSDKModule.imageRefClear({ uniqueId: this.uniqueId });
     } catch (error: any) {
       console.error(error);
     }
@@ -283,7 +249,7 @@ export class ImageRef extends AutoReleasable {
     this.throwErrorIfReleased();
 
     try {
-      const imageInfo = await ScanbotBarcodeSDKImpl.imageRefInfo(this.uniqueId);
+      const imageInfo = await ScanbotBarcodeSDKModule.imageRefInfo({ uniqueId: this.uniqueId });
 
       return new ImageInfo(imageInfo);
     } catch (error: any) {
@@ -305,7 +271,11 @@ export class ImageRef extends AutoReleasable {
     this.throwErrorIfReleased();
 
     try {
-      return await ScanbotBarcodeSDKImpl.imageRefSaveImage(this.uniqueId, path, options);
+      return await ScanbotBarcodeSDKModule.imageRefSaveImage({
+        uniqueId: this.uniqueId,
+        path,
+        options,
+      });
     } catch (error: any) {
       console.error(error);
 
@@ -324,10 +294,10 @@ export class ImageRef extends AutoReleasable {
       this.throwErrorIfReleased();
 
       try {
-        const imageAsBuffer = await ScanbotBarcodeSDKImpl.imageRefEncodeImage(
-          this.uniqueId,
-          new EncodeImageOptions()
-        );
+        const imageAsBuffer = await ScanbotBarcodeSDKModule.imageRefEncodeImage({
+          uniqueId: this.uniqueId,
+          options: new EncodeImageOptions(),
+        });
 
         if (imageAsBuffer) {
           this._buffer = imageAsBuffer;
@@ -344,9 +314,7 @@ export class ImageRef extends AutoReleasable {
   public async encodeImage(options?: EncodeImageOptions): Promise<string | null> {
     if (this._buffer) {
       if (options) {
-        throw new Error(
-          'EncodeImageOptions are not available when image is already encoded to base64'
-        );
+        throw new InvalidImageRefError('EncodeImageOptions are not available when image is already encoded to base64');
       }
 
       return this._buffer;
@@ -355,10 +323,10 @@ export class ImageRef extends AutoReleasable {
       this.throwErrorIfReleased();
 
       try {
-        return await ScanbotBarcodeSDKImpl.imageRefEncodeImage(
-          this.uniqueId,
-          options ?? new EncodeImageOptions()
-        );
+        return await ScanbotBarcodeSDKModule.imageRefEncodeImage({
+          uniqueId: this.uniqueId,
+          options: options ?? new EncodeImageOptions(),
+        });
       } catch (error: any) {
         console.error(error);
 
@@ -376,7 +344,7 @@ export class ImageRef extends AutoReleasable {
 
     if (!this.released) {
       // The promise is intentionally not awaited here
-      ScanbotBarcodeSDKImpl.imageRefRelease(this.uniqueId).catch((error: any) => {
+      ScanbotBarcodeSDKModule.imageRefRelease({ uniqueId: this.uniqueId }).catch((error: any) => {
         console.error(`Error while releasing ImageRef with uniqueId ${this.uniqueId}: ${error}`);
       });
 
@@ -390,7 +358,7 @@ export class ImageRef extends AutoReleasable {
    */
   public static async makeSnapshot(): Promise<ImageRefPoolSnapshot | null> {
     try {
-      const snapshot = await ScanbotBarcodeSDKImpl.makeSnapshot();
+      const snapshot = await ScanbotBarcodeSDKModule.makeSnapshot();
 
       return new ImageRefPoolSnapshot(snapshot);
     } catch (error: any) {
@@ -405,18 +373,18 @@ export class ImageRef extends AutoReleasable {
    */
   public static releaseAll() {
     // The promise is intentionally not awaited here
-    ScanbotBarcodeSDKImpl.imageRefReleaseAll().catch(() => {});
+    ScanbotBarcodeSDKModule.imageRefReleaseAll().catch(() => {});
   }
 
   private throwErrorIfUniqueIdIsMissing(): void {
     if (!this.uniqueId) {
-      throw new Error('uniqueId is missing');
+      throw new InvalidImageRefError('uniqueId is missing');
     }
   }
 
   private throwErrorIfReleased(): void {
     if (this.released) {
-      throw new Error(`ImageRef with uniqueId ${this.uniqueId} has been released`);
+      throw new InvalidImageRefError(`ImageRef with uniqueId ${this.uniqueId} has been released`);
     }
   }
 }

package/src/{imageRef → types/core/image}/index.ts

@@ -1,4 +1,3 @@
 export * from './ImageRefTypes';
 export * from './ImageTypes';
-export * from './ObjectPoolTypes';
 export * from './image';

package/src/types/core/index.ts

@@ -0,0 +1,9 @@
+export * from './barcode';
+export * from './camera';
+export * from './common';
+export * from './generic_document';
+export * from './geometry';
+export * from './image';
+export * from './licensing';
+export * from './ui_v2';
+export * from './utils';

package/src/types/core/licensing/LicensingTypes.ts

@@ -0,0 +1,377 @@
+/// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
+/// Generated from core/schemas/LicensingTypes.yaml
+
+import { ToJsonConfiguration } from '../common/JsonSerializationTypes';
+import { DeepPartial } from '../utils/utils';
+
+/**
+Status of the license plate scanner.
+
+- `OKAY`:
+   License is valid and accepted.
+- `TRIAL`:
+   No license set yet. The SDK is in trial mode.
+- `OKAY_EXPIRING_SOON`:
+   License is valid but will expire soon. Make sure to update your license before it expires to ensure uninterrupted function.
+- `FAILURE_NOT_SET`:
+   No license set. On platforms that support trial mode, it means that the SDK's trial mode is over.
+- `FAILURE_CORRUPTED`:
+   No license active. The set license was unreadable or has an invalid format.
+- `FAILURE_WRONG_OS`:
+   No license active. The set license does not cover the current operating system.
+- `FAILURE_APP_ID_MISMATCH`:
+   No license active. The set license does not cover the current app's bundle identifier.
+- `FAILURE_EXPIRED`:
+   No license active. The set license is valid but it has expired.
+- `FAILURE_SERVER`:
+   No license active. The online license check failed.
+- `FAILURE_VERSION`:
+   No license active. The set license does not cover the current SDK version.
+- `FAILURE_INACTIVE`:
+   No license active. The set license is not yet active.
+*/
+export type LicenseStatus =
+  /**
+    License is valid and accepted.
+    */
+  | 'OKAY'
+  /**
+    No license set yet. The SDK is in trial mode.
+    */
+  | 'TRIAL'
+  /**
+    License is valid but will expire soon. Make sure to update your license before it expires to ensure uninterrupted function.
+    */
+  | 'OKAY_EXPIRING_SOON'
+  /**
+    No license set. On platforms that support trial mode, it means that the SDK's trial mode is over.
+    */
+  | 'FAILURE_NOT_SET'
+  /**
+    No license active. The set license was unreadable or has an invalid format.
+    */
+  | 'FAILURE_CORRUPTED'
+  /**
+    No license active. The set license does not cover the current operating system.
+    */
+  | 'FAILURE_WRONG_OS'
+  /**
+    No license active. The set license does not cover the current app's bundle identifier.
+    */
+  | 'FAILURE_APP_ID_MISMATCH'
+  /**
+    No license active. The set license is valid but it has expired.
+    */
+  | 'FAILURE_EXPIRED'
+  /**
+    No license active. The online license check failed.
+    */
+  | 'FAILURE_SERVER'
+  /**
+    No license active. The set license does not cover the current SDK version.
+    */
+  | 'FAILURE_VERSION'
+  /**
+    No license active. The set license is not yet active.
+    */
+  | 'FAILURE_INACTIVE';
+
+/** @hidden */
+export const LicenseStatusValues: ReadonlyArray<LicenseStatus> = [
+  'OKAY',
+  'TRIAL',
+  'OKAY_EXPIRING_SOON',
+  'FAILURE_NOT_SET',
+  'FAILURE_CORRUPTED',
+  'FAILURE_WRONG_OS',
+  'FAILURE_APP_ID_MISMATCH',
+  'FAILURE_EXPIRED',
+  'FAILURE_SERVER',
+  'FAILURE_VERSION',
+  'FAILURE_INACTIVE',
+] as const;
+
+/**
+Description of error that occurred during device deregistration.
+*/
+export class DeviceDeregistrationError {
+  /**
+    Sequential number of the device registration. Starts with 0. Each time a call to initializeLicense with a new license is made, the device ID.
+    */
+  public readonly deviceId: number;
+  /**
+    Error message describing the error.
+    */
+  public readonly errorMessage: string;
+
+  /** @param source {@displayType `DeepPartial<DeviceDeregistrationError>`} */
+  public constructor(source: DeepPartial<DeviceDeregistrationError> = {}) {
+    if (source.deviceId !== undefined) {
+      this.deviceId = source.deviceId;
+    } else {
+      throw new Error('deviceId must be present in constructor argument');
+    }
+    if (source.errorMessage !== undefined) {
+      this.errorMessage = source.errorMessage;
+    } else {
+      throw new Error('errorMessage must be present in constructor argument');
+    }
+  }
+
+  public serialize(
+    config: ToJsonConfiguration = new ToJsonConfiguration()
+  ): DeepPartial<DeviceDeregistrationError> {
+    return {
+      deviceId: this.deviceId,
+      errorMessage: this.errorMessage,
+    };
+  }
+}
+
+/**
+Information about the SDK license.
+*/
+export class LicenseInfo {
+  /**
+    License status.
+    */
+  public readonly status: LicenseStatus;
+  /**
+    True if the license status corresponds to a valid license.
+    */
+  public readonly isValid: boolean;
+  /**
+    Message describing the license status.
+    */
+  public readonly licenseStatusMessage: string;
+  /**
+    Expiration timestamp of the license or trial period in seconds since the UNIX epoch.
+    */
+  public readonly expirationTimestamp: number;
+  /**
+    Expiration date of the license or trial period in ISO 8601 date-time format.
+    */
+  public readonly expirationDateString: string;
+  /**
+    Additional error message in case of a license error.
+    */
+  public readonly errorMessage: string;
+  /**
+    True if an online license check is in progress.
+    */
+  public readonly onlineLicenseCheckInProgress: boolean;
+  /**
+    The currently active license. May be different from the license used to initialize
+    the SDK if the online license check has completed and the server has sent
+    an updated license.
+    */
+  public readonly license: string;
+  /**
+    Number of devices the license is valid for, if the license is floating.
+    */
+  public readonly devices: number | null = null;
+  /**
+    Time in milliseconds until the next online license check will be performed. -1 if no online license check is scheduled.
+    */
+  public readonly nextOnlineLicenseCheckInMs: number;
+  /**
+    List of errors that occurred during device deregistration. If for some device deregistration completed successfully, it will not be listed here. For each device at most one entry will be present.
+    */
+  public readonly deviceDeregistationErrors: DeviceDeregistrationError[];
+
+  /** @param source {@displayType `DeepPartial<LicenseInfo>`} */
+  public constructor(source: DeepPartial<LicenseInfo> = {}) {
+    if (source.status !== undefined) {
+      this.status = source.status;
+    } else {
+      throw new Error('status must be present in constructor argument');
+    }
+    if (source.isValid !== undefined) {
+      this.isValid = source.isValid;
+    } else {
+      throw new Error('isValid must be present in constructor argument');
+    }
+    if (source.licenseStatusMessage !== undefined) {
+      this.licenseStatusMessage = source.licenseStatusMessage;
+    } else {
+      throw new Error('licenseStatusMessage must be present in constructor argument');
+    }
+    if (source.expirationTimestamp !== undefined) {
+      this.expirationTimestamp = source.expirationTimestamp;
+    } else {
+      throw new Error('expirationTimestamp must be present in constructor argument');
+    }
+    if (source.expirationDateString !== undefined) {
+      this.expirationDateString = source.expirationDateString;
+    } else {
+      throw new Error('expirationDateString must be present in constructor argument');
+    }
+    if (source.errorMessage !== undefined) {
+      this.errorMessage = source.errorMessage;
+    } else {
+      throw new Error('errorMessage must be present in constructor argument');
+    }
+    if (source.onlineLicenseCheckInProgress !== undefined) {
+      this.onlineLicenseCheckInProgress = source.onlineLicenseCheckInProgress;
+    } else {
+      throw new Error('onlineLicenseCheckInProgress must be present in constructor argument');
+    }
+    if (source.license !== undefined) {
+      this.license = source.license;
+    } else {
+      throw new Error('license must be present in constructor argument');
+    }
+    if (source.devices !== undefined) {
+      this.devices = source.devices != null ? source.devices : null;
+    }
+    if (source.nextOnlineLicenseCheckInMs !== undefined) {
+      this.nextOnlineLicenseCheckInMs = source.nextOnlineLicenseCheckInMs;
+    } else {
+      throw new Error('nextOnlineLicenseCheckInMs must be present in constructor argument');
+    }
+    if (source.deviceDeregistationErrors !== undefined) {
+      this.deviceDeregistationErrors = source.deviceDeregistationErrors.map(
+        (it: DeepPartial<DeviceDeregistrationError>) => {
+          return new DeviceDeregistrationError(it);
+        }
+      );
+    } else {
+      throw new Error('deviceDeregistationErrors must be present in constructor argument');
+    }
+  }
+
+  public serialize(
+    config: ToJsonConfiguration = new ToJsonConfiguration()
+  ): DeepPartial<LicenseInfo> {
+    return {
+      status: this.status,
+      isValid: this.isValid,
+      licenseStatusMessage: this.licenseStatusMessage,
+      expirationTimestamp: this.expirationTimestamp,
+      expirationDateString: this.expirationDateString,
+      errorMessage: this.errorMessage,
+      onlineLicenseCheckInProgress: this.onlineLicenseCheckInProgress,
+      license: this.license,
+      devices: this.devices != null ? this.devices : null,
+      nextOnlineLicenseCheckInMs: this.nextOnlineLicenseCheckInMs,
+      deviceDeregistationErrors: this.deviceDeregistationErrors.map((it: any) => {
+        return it.serialize(config);
+      }),
+    };
+  }
+}
+
+/**
+License features.
+
+- `BARCODE_SCANNER`:
+   Barcode scanner.
+- `CHECK_SCANNER`:
+   Check scanner.
+- `CREDIT_CARD_SCANNER`:
+   Credit card scanner.
+- `IMAGE_PROCESSING`:
+   Image processing.
+- `DOCUMENT_SCANNER`:
+   Document scanner.
+- `LICENSE_PLATE_SCANNER`:
+   License plate scanner.
+- `MEDICAL_CERTIFICATE_SCANNER`:
+   Medical certificate scanner.
+- `MRZ_SCANNER`:
+   MRZ scanner.
+- `OCR`:
+   OCR.
+- `TEXT_PATTERN_SCANNER`:
+   Text pattern scanner.
+- `PDF_CREATION`:
+   PDF creation.
+- `ID_CARD_SCANNER`:
+   ID card scanner.
+- `DRIVER_LICENSE_SCANNER`:
+   Driver license scanner.
+- `EHIC_SCANNER`:
+   EHIC scanner.
+- `DOCUMENT_CLASSIFICATION`:
+   Document classification.
+*/
+export type Feature =
+  /**
+    Barcode scanner.
+    */
+  | 'BARCODE_SCANNER'
+  /**
+    Check scanner.
+    */
+  | 'CHECK_SCANNER'
+  /**
+    Credit card scanner.
+    */
+  | 'CREDIT_CARD_SCANNER'
+  /**
+    Image processing.
+    */
+  | 'IMAGE_PROCESSING'
+  /**
+    Document scanner.
+    */
+  | 'DOCUMENT_SCANNER'
+  /**
+    License plate scanner.
+    */
+  | 'LICENSE_PLATE_SCANNER'
+  /**
+    Medical certificate scanner.
+    */
+  | 'MEDICAL_CERTIFICATE_SCANNER'
+  /**
+    MRZ scanner.
+    */
+  | 'MRZ_SCANNER'
+  /**
+    OCR.
+    */
+  | 'OCR'
+  /**
+    Text pattern scanner.
+    */
+  | 'TEXT_PATTERN_SCANNER'
+  /**
+    PDF creation.
+    */
+  | 'PDF_CREATION'
+  /**
+    ID card scanner.
+    */
+  | 'ID_CARD_SCANNER'
+  /**
+    Driver license scanner.
+    */
+  | 'DRIVER_LICENSE_SCANNER'
+  /**
+    EHIC scanner.
+    */
+  | 'EHIC_SCANNER'
+  /**
+    Document classification.
+    */
+  | 'DOCUMENT_CLASSIFICATION';
+
+/** @hidden */
+export const FeatureValues: ReadonlyArray<Feature> = [
+  'BARCODE_SCANNER',
+  'CHECK_SCANNER',
+  'CREDIT_CARD_SCANNER',
+  'IMAGE_PROCESSING',
+  'DOCUMENT_SCANNER',
+  'LICENSE_PLATE_SCANNER',
+  'MEDICAL_CERTIFICATE_SCANNER',
+  'MRZ_SCANNER',
+  'OCR',
+  'TEXT_PATTERN_SCANNER',
+  'PDF_CREATION',
+  'ID_CARD_SCANNER',
+  'DRIVER_LICENSE_SCANNER',
+  'EHIC_SCANNER',
+  'DOCUMENT_CLASSIFICATION',
+] as const;

package/src/types/core/licensing/index.ts

@@ -0,0 +1 @@
+export * from './LicensingTypes';