react-native-scanbot-barcode-scanner-sdk 4.2.0 → 4.3.0-beta.1

package/src/components/barcode-camera-view/scanbot-barcode-camera-view-types.ts

@@ -1,175 +0,0 @@
-import { StyleProp, ViewStyle } from 'react-native';
-
-import { BarcodeScannerResult } from '../../results';
-import { AspectRatio, BarcodeDocumentFormat, BarcodeFormat, BarcodesExtensionFilter, CodeDensity, EngineMode, Gs1HandlingMode, MSIPlesseyChecksumAlgorithm } from '../../types';
-
-export interface ScanbotBarcodeCameraViewProperties {
-  onBarcodeScannerResult?: (result: BarcodeScannerResult) => void;
-  configuration?: ScanbotBarcodeCameraViewConfiguration;
-  style: StyleProp<ViewStyle>;
-  children?: React.ReactNode;
-}
-
-export interface ScanbotBarcodeCameraNativeViewProperties {
-  onNativeBarcodeScannerResult?: (result: BarcodeScannerResult) => void;
-  requestComponentReload?: () => void;
-  configuration?: ScanbotBarcodeCameraViewConfiguration;
-  style: StyleProp<ViewStyle>;
-  children?: React.ReactNode;
-}
-
-export interface ScanbotBarcodeCameraViewBarcode {
-  text: string;
-  textWithExtension: string;
-  type: string;
-}
-
-/**
- * This class contians all the configurations needed for Scanbot Barcode Camera View.
- */
-export interface ScanbotBarcodeCameraViewConfiguration extends FinderConfig, BarcodeAdditionalParameters {
-  /**
-   * Whether flash is toggled on or off.
-   */
-  flashEnabled?: boolean;
-  /**
-   * List of accepted Barcode Formats; any formats that are not included in this
-   * list will not be detected by the `BarcodeCameraView`. By default, the list
-   * includes all supported barcode types.
-   */
-  barcodeFormats?: BarcodeFormat[];
-  /**
-   * An optional array of barcode document formats that acts as a detection filter.
-   * By default all supported document formats will be detected.
-   */
-  acceptedDocumentFormats?: BarcodeDocumentFormat[];
-  /**
-   * The engine mode of the barcode recognizer. Defaults to NEXT_GEN.
-   * To use legacy recognizer, please specify LEGACY
-   */
-  engineMode?: EngineMode;
-  /**
-   * The relative initial zoom level of the camera in the range [0,1], where 0 is zoomed out and 1 is zoomed in.
-   * The default value is 0.-
-   */
-  cameraZoomFactor?: number;
-  /**
-   *  The extension filter for EAN and UPC barcodes.
-  */
-  barcodesExtensionFilter?: BarcodesExtensionFilter;
-  /** 
-   * Enable or disable barcode detection. If disabled, the camera preview is active but no barcodes will be detected.
-   * Default is enabled.
-   */
-  scanningEnabled?: boolean;
-}
-
-/**
- * This class contains all the finder configurations.
- */
-export interface FinderConfig {
-
-  /**
-    * The finder view is a rectangular overlay view that clips the camera view,
-    * so that the detection will focus just a specific area. You can specify
-    * the size and positioning, as well as other UI properties.
-    * Set this property to `true` if you want to use the Finder View, `false` otherwise (default: false)
-    */
-  shouldUseFinderView?: boolean;
-  /**
-   * The finder view rectangular overlay border width
-   */
-  finderLineWidth?: number;
-  /**
-   * The finder view rectangular overlay border color
-   */
-  finderLineColor?: string;
-  /**
-   * The overlay background color, around the finder view rectangle
-   */
-  finderBackgroundColor?: string;
-  /**
-   * The overlay background color opacity, around the finder view rectangle
-   */
-  finderBackgroundOpacity?: number;
-  /**
-   * The finder view rectangle aspect ratio
-   */
-  finderAspectRatio?: AspectRatio;
-  /**
-   * Set the finderInsets left, top, bottom, right
-   */
-  finderInset?: FinderInset
-}
-
-/**
- * This class contains properties to Set the finder insets for the finder view.
- */
-export interface FinderInset {
-
-  /**
-   * set the left inset
-   */
-  left: number;
-  /**
-   * set the top inset
-   */
-  top: number;
-  /**
-   * set the bottom inset
-   */
-  bottom: number;
-  /**
-   * set the right inset
-   */
-  right: number;
-}
-
-/**
- * An interface that contains additional parameters for barcodes detection and filtering.
- */
-export interface BarcodeAdditionalParameters {
-  /**
-  * If `true`, enables the mode which slightly decreases the scanning quality and the energy consumption, thus increasing the scanning speed.
-  * The default is `false`.
-  * Android only.
-  */
-  lowPowerMode?: boolean;
-  /**
-   * Optional minimum required text length of the detected barcode.
-   * The default is 0 (setting is turned off).
-   * NOTE: This feature works on ITF and MSI Plessey barcodes only.
-   */
-  minimumTextLength?: number;
-  /**
-   * Optional maximum required text length of the detected barcode.
-   * The default is 0 (setting is turned off).
-   * NOTE: This feature works on ITF and MSI Plessey barcodes only.
-   */
-  maximumTextLength?: number;
-  /**
-   * Optional minimum required quiet zone on the barcode.
-   * Measured in modules (the size of narrowest bar in the barcode).
-   * The default is 10.
-   * NOTE: This feature works on ITF and MSI Plessey barcodes only.
-   */
-  minimum1DBarcodesQuietZone?: number;
-  /**
-   * With this option enabled, the scanner removes check digits for UPC, EAN and MSI Plessey codes.
-   * Has no effect if both single and double digit MSI Plessey checksums are enabled.
-   * The default is `false`.
-   */
-  stripCheckDigits?: boolean;
-  /** The GS1 handling mode. The default value is PARSE. */
-  gs1HandlingMode?: Gs1HandlingMode;
-  /**
-   * The checksum algorithm for MSI Plessey barcodes.
-   * The default value is MSIPlesseyChecksumAlgorithm.MOD_10.
-   */
-  msiPlesseyChecksumAlgorithm?: MSIPlesseyChecksumAlgorithm;
-  /**
-   * Low density. Finds up to 6 QR codes in one image or video frame. This is the default value.
-   * High density. Finds up to 24 QR codes in one image or video frame.
-   */
-  codeDensity?: CodeDensity;
-}

package/src/components/barcode-camera-view/scanbot-barcode-camera-view.tsx

@@ -1,270 +0,0 @@
-import React from 'react';
-import { EmitterSubscription, findNodeHandle, NativeMethods, Platform } from 'react-native';
-import { Dimensions } from 'react-native';
-import { ScanbotBarcodeCameraNativeViewProperties, ScanbotBarcodeCameraViewConfiguration, ScanbotBarcodeCameraViewProperties } from './scanbot-barcode-camera-view-types';
-import ScanbotNativeBarcodeCameraView, { BarcodeCameraViewNativeCommands } from './scanbot-native-barcode-camera-view';
-
-import { BarcodeScannerResult } from '../../results';
-
-const Device = {
-  isPortrait: () => {
-    const dim = Dimensions.get('screen');
-    return dim.height >= dim.width;
-  },
-  isLandscape: () => {
-    const dim = Dimensions.get('screen');
-    return dim.width >= dim.height;
-  },
-};
-
-interface ScanbotBarcodeCameraViewState {
-  orientation: string;
-}
-
-type Properties = ScanbotBarcodeCameraViewProperties;
-export class ScanbotBarcodeCameraView extends React.Component<Properties, {}> {
-
-  // Camera View Reference
-  cameraViewReference: React.RefObject<React.Component<ScanbotBarcodeCameraNativeViewProperties> & Readonly<NativeMethods>>
-
-  // String length of auto-generated component key
-  static UNIQUE_VIEW_KEY_LENGTH = 6;
-
-  // Listener for orientation changes
-  dimensionsChangeSubscription: EmitterSubscription | null = null;
-
-  // This attribute allows us to retrieve a key for the component depending on the current state.
-  // If the component has been invalidated, it returns a new key and the view gets recreated,
-  // otherwise it uses the last generated one
-  _cameraKey = '';
-  get cameraKey(): string {
-    if (!this.isDirty) {
-      return this._cameraKey;
-    }
-    this.isDirty = false;
-    this._cameraKey = ScanbotBarcodeCameraView.getRandomId(
-      ScanbotBarcodeCameraView.UNIQUE_VIEW_KEY_LENGTH,
-    );
-    return this._cameraKey;
-  }
-
-  // We keep track of the state of children components, so that we can re-render the component
-  // in some special cases (Android)
-  previousChildrenIds: string[] = [];
-  get childrenIds(): string[] {
-    const children = this.props.children
-      ? React.Children.map(this.props.children, child => child)
-      : [];
-
-    return children?.map((c: any) => `${c.type.name}-${c.key}`) ?? [];
-  }
-
-  // When true, a new component key will be generated on the next render,
-  // causing the component to be recreated
-  isDirty = true;
-
-  state: ScanbotBarcodeCameraViewState = {
-    orientation: Device.isPortrait() ? 'portrait' : 'landscape',
-  };
-
-  constructor(props: ScanbotBarcodeCameraViewProperties) {
-    super(props);
-    this.cameraViewReference = React.createRef();
-  }
-
-  // Returns a random string ID of the given length
-  static getRandomId(
-    length: number = ScanbotBarcodeCameraView.UNIQUE_VIEW_KEY_LENGTH,
-  ): string {
-    let result = '';
-    const characters =
-      'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
-    const charactersLength = characters.length;
-    for (let i = 0; i < length; i++) {
-      result += characters.charAt(Math.floor(Math.random() * charactersLength));
-    }
-    return result;
-  }
-
-  // Event Listener for orientation changes
-  orientationChangeHandler = () => {
-    this.sendCommandToCameraView("orientationChanged");
-    this._invalidate();
-    this.setState({
-      orientation: Device.isPortrait() ? 'portrait' : 'landscape',
-    });
-  };
-
-  receiveEvent(event: any) {}
-
-  // Maps the native bridge callback event from the Barcode Scanner
-  _onBarcodeScannerResult = (event: any) => {
-    if (!this.props.onBarcodeScannerResult) {
-      return;
-    }
-
-    let outResult: BarcodeScannerResult | undefined = undefined;
-    if (Platform.OS === 'ios') {
-      // The new-architecture Fabric Component callback returns a JSON string as a result
-      if (event.nativeEvent.jsonResult) {
-        outResult = JSON.parse(event.nativeEvent.jsonResult)?.result;
-      } else {
-        // Support for the old architecture
-        outResult = event.nativeEvent.result;
-      }
-    } else {
-      outResult = event.nativeEvent.result;
-    }
-
-    if (outResult) {
-      this.props.onBarcodeScannerResult(outResult);
-    }
-  };
-
-  render() {
-
-    this.evaluateComponentState();
-
-    const style = this.preprocessStyle();
-    const props = this.preprocessProps();
-
-    return (
-      <ScanbotNativeBarcodeCameraView
-        {...props}
-        style={style}
-        key={this.cameraKey}
-        ref={this.cameraViewReference}
-        onNativeBarcodeScannerResult={this._onBarcodeScannerResult}
-      />
-    );
-  }
-
-  componentDidMount() {
-    this.registerDimensionsListener();
-    this.previousChildrenIds = this.childrenIds;
-    this.sendCommandToCameraView("componentDidMount");
-  }
-
-  componentDidUpdate() {
-    this.sendCommandToCameraView("componentDidUpdate");
-  }
-
-  componentWillUnmount() {
-    this.unregisterDimensionsListener();
-    this.previousChildrenIds = [];
-    this.sendCommandToCameraView("componentWillUnmount");
-  }
-
-  evaluateComponentState = () => {
-    // We want to force a re-layout every time new children are added or removed
-    // from the BarcodeCameraView on Android; this will allow the native code to
-    // re-compute the size of every view inside the layout
-    if (Platform.OS === 'android') {
-      const currentChildrenIds = this.childrenIds;
-
-      const invalidate = () => {
-        this._invalidate();
-        this.previousChildrenIds = currentChildrenIds;
-      };
-      if (currentChildrenIds.length !== this.previousChildrenIds.length) {
-        invalidate();
-        return;
-      }
-
-      for (let i = 0; i < this.previousChildrenIds.length; i++) {
-        const previous = this.previousChildrenIds[i];
-        const current = currentChildrenIds[i];
-        if (previous !== current) {
-          invalidate();
-          return;
-        }
-      }
-    }
-  };
-
-  preprocessStyle = () => {
-    const style = this.props.style as any;
-    const newStyle = { ...style } || {};
-    // Override / Define styles here
-    return newStyle;
-  };
-
-  sanitizeNumbers = (obj: ScanbotBarcodeCameraViewConfiguration) => {
-    const outObj = {...obj};
-    outObj.cameraZoomFactor = obj.cameraZoomFactor ?? -1;
-    outObj.finderAspectRatio = obj.finderAspectRatio ?? { width: -1, height: -1 };
-    outObj.finderBackgroundOpacity = obj.finderBackgroundOpacity ?? -1;
-    outObj.finderInset = obj.finderInset ?? { left: -1, top: -1, bottom: -1, right: -1 };
-    outObj.finderLineWidth = obj.finderLineWidth ?? -1;
-    outObj.maximumTextLength = obj.maximumTextLength ?? -1;
-    outObj.minimumTextLength = obj.minimumTextLength ?? -1;
-    outObj.minimum1DBarcodesQuietZone = obj.minimum1DBarcodesQuietZone ?? -1;
-    
-    return outObj;
-  }
-
-  preprocessProps = () => {
-    const props = { ...this.props };
-    delete props.style;
-
-    const config = props.configuration;
-    if (config != null) {
-      props.configuration = this.sanitizeNumbers(config as any);
-
-      // When using new arch on iOS platform, if we don't specify default values for boolean properties all of them will be
-      // considered as false while code genenarion
-      if (Platform.OS === 'ios') {
-        // For now only scanningEnabled should be set as true by default
-        if (props.configuration.scanningEnabled === undefined)
-          props.configuration.scanningEnabled = true;
-      }
-    }
-    
-    return props;
-  };
-
-  // Invalidates the component so that it gets recreated on the next render
-  _invalidate = () => {
-    this.isDirty = true;
-    this.cameraViewReference = React.createRef();
-  };
-
-  registerDimensionsListener() {
-    if (this.usesEmitterSubscription()) {
-      this.dimensionsChangeSubscription = Dimensions.addEventListener('change', this.orientationChangeHandler) as unknown as EmitterSubscription;
-    } else {
-      Dimensions.addEventListener('change', this.orientationChangeHandler);
-    }
-  }
-
-  unregisterDimensionsListener() {
-    if (this.usesEmitterSubscription()) {
-      if (this.dimensionsChangeSubscription) {
-        this.dimensionsChangeSubscription.remove();
-      }
-    } else {
-      (Dimensions as any).removeEventListener('change', this.orientationChangeHandler);
-    }
-  }
-
-  // Since React Native 0.70 the method removeEventListener has been removed in favour of EmitterSubscription (returned by addEventListener)
-  // .remove() method; here we check if removeEventListener still exists in Dimensions to check if React Native < 0.70 is used
-  usesEmitterSubscription(): boolean {
-    return (Dimensions as any).removeEventListener == null || (Dimensions as any).removeEventListener == undefined;
-  }
-
-  sendCommandToCameraView = (command: string, args: any = []) => {
-    const viewId = findNodeHandle(this.cameraViewReference.current);
-    if (!viewId) {
-      return;
-    }
-    this.sendCommandToViewId(viewId, command, args);
-  }
-
-  sendCommandToViewId = (viewId: number, command: string, args: any = []) => {
-    const cameraView = this.cameraViewReference?.current;
-    if (cameraView) {
-      BarcodeCameraViewNativeCommands[command](cameraView);
-    }          
-  }
-}

package/src/components/barcode-camera-view/scanbot-native-barcode-camera-view.ts

@@ -1,7 +0,0 @@
-import { HostComponent } from "react-native";
-import { ScanbotBarcodeCameraNativeViewProperties } from "./scanbot-barcode-camera-view-types";
-
-const nativeBarcodeCameraView = require('../../../js/RTNScanbotBarcodeCameraViewNativeComponent').default;
-export const BarcodeCameraViewNativeCommands = require('../../../js/RTNScanbotBarcodeCameraViewNativeComponent').Commands;
-
-export default (nativeBarcodeCameraView as HostComponent<ScanbotBarcodeCameraNativeViewProperties>);