scandit-datacapture-frameworks-core 8.3.1 → 8.4.0

package/__mocks__/Defaults.ts

@@ -6,6 +6,7 @@ export const mockCoreDefaultsData: any = {
     "Settings": {
       "zoomFactor": 1,
       "zoomGestureZoomFactor": 2,
+      "zoomLevels": [1, 2],
       "focusGestureStrategy": "manualUntilCapture",
       "focusRange": "near",
       "preferredResolution": "auto",
@@ -19,6 +20,13 @@ export const mockCoreDefaultsData: any = {
     },
     "availablePositions": ["worldFacing", "userFacing"]
   },
+  "ZoomSwitchControl": {
+    "orientation": "horizontal",
+    "isAlwaysExpanded": false,
+    "isExpanded": false,
+    "accessibilityLabel": "Zoom <level>",
+    "accessibilityHint": "Adjusts the camera zoom level"
+  },
   "Version": "8.1.0-test",
   "deviceID": "test-device-id",
   "AimerViewfinder": {
@@ -42,6 +50,7 @@ export const mockCoreDefaultsData: any = {
   },
   "DataCaptureView": {
     "zoomGesture": "{\"type\":\"swipeToZoom\"}",
+    "zoomGestures": "[{\"type\":\"swipeToZoom\"},{\"type\":\"pinchToZoom\"}]",
     "pointOfInterest": "{\"x\":{\"unit\":\"fraction\",\"value\":0.5},\"y\":{\"unit\":\"fraction\",\"value\":0.5}}",
     "focusGesture": "{\"showUIIndicator\":true,\"type\":\"tapToFocus\"}",
     "logoStyle": "extended",

package/dist/dts/camera/Camera.d.ts

@@ -1,5 +1,5 @@
 import { DataCaptureContext } from "../context";
-import { FrameSource, FrameSourceListener, FrameSourceState, TorchListener, MacroModeListener } from "../frame";
+import { FrameSource, FrameSourceListener, FrameSourceState, TorchListener, MacroModeListener, ZoomListener } from "../frame";
 import { DefaultSerializeable } from "../serializable";
 import { CameraController } from "./controller/CameraController";
 import { TorchState } from "./TorchState";
@@ -38,6 +38,8 @@ export declare class Camera extends DefaultSerializeable implements FrameSource
     private listeners;
     private torchListeners;
     private macroModeListeners;
+    private zoomListeners;
+    private _hasZoomListeners;
     private _context;
     private nativeReadyResolver;
     private nativeReadyRejecter;
@@ -58,6 +60,8 @@ export declare class Camera extends DefaultSerializeable implements FrameSource
     removeTorchListener(listener: TorchListener): void;
     addMacroModeListener(listener: MacroModeListener): void;
     removeMacroModeListener(listener: MacroModeListener): void;
+    addZoomListener(listener: ZoomListener): void;
+    removeZoomListener(listener: ZoomListener): void;
     applySettings(settings: CameraSettings): Promise<void>;
     private set context(value);
     private get context();
@@ -83,6 +87,7 @@ export interface PrivateCamera {
     listeners: FrameSourceListener[];
     torchListeners: TorchListener[];
     macroModeListeners: MacroModeListener[];
+    zoomListeners: ZoomListener[];
     controller: CameraController;
     get isActiveCamera(): boolean;
     initialize: () => void;

package/dist/dts/camera/CameraSettings.d.ts

@@ -7,6 +7,7 @@ export interface CameraSettingsJSON {
     preferredResolution: string;
     zoomFactor: number;
     zoomGestureZoomFactor: number;
+    zoomLevels?: number[];
     macroMode?: string;
     adaptiveExposure?: boolean;
     torchLevel?: number;
@@ -23,7 +24,9 @@ export interface PrivateCameraSettings {
 export declare class CameraSettings extends DefaultSerializeable {
     preferredResolution: VideoResolution;
     zoomFactor: number;
+    /** @deprecated Use zoomLevels instead. */
     zoomGestureZoomFactor: number;
+    zoomLevels: number[];
     torchLevel: number;
     macroMode: MacroMode;
     adaptiveExposure: boolean;

package/dist/dts/camera/PinchToZoom.d.ts

@@ -0,0 +1,20 @@
+import { DefaultSerializeable } from "../serializable";
+import { DataCaptureViewController } from "../view";
+import { ZoomGesture } from "./ZoomGesture";
+import { ZoomGestureListener } from "./ZoomGestureListener";
+export interface PrivatePinchToZoom {
+    listeners: ZoomGestureListener[];
+    onListenersChanged?(): void;
+    _controller?: DataCaptureViewController | null;
+}
+export declare class PinchToZoom extends DefaultSerializeable implements ZoomGesture {
+    private type;
+    private listeners;
+    private onListenersChanged?;
+    private _controller?;
+    constructor();
+    addListener(listener: ZoomGestureListener): void;
+    removeListener(listener: ZoomGestureListener): void;
+    triggerZoomIn(): Promise<void>;
+    triggerZoomOut(): Promise<void>;
+}

package/dist/dts/camera/PrivateZoomGestureDeserializer.d.ts

@@ -0,0 +1,5 @@
+import { ZoomGesture, ZoomGestureJSON } from "./ZoomGesture";
+export declare class PrivateZoomGestureDeserializer {
+    static fromJSON(json: ZoomGestureJSON | null): ZoomGesture | null;
+    static fromJSONArray(jsonArray: ZoomGestureJSON[]): ZoomGesture[];
+}

package/dist/dts/camera/ZoomGesture.d.ts

@@ -8,6 +8,3 @@ export interface ZoomGesture {
 export interface ZoomGestureJSON {
     type: string;
 }
-export declare class PrivateZoomGestureDeserializer {
-    static fromJSON(json: ZoomGestureJSON | null): ZoomGesture | null;
-}

package/dist/dts/camera/ZoomSwitchControl.d.ts

@@ -1,28 +1,56 @@
 import { DefaultSerializeable } from "../serializable";
 import { Control } from "../view";
+import { ZoomSwitchOrientation } from "./ZoomSwitchOrientation";
 export declare class ZoomSwitchControl extends DefaultSerializeable implements Control {
     private type;
     private icon;
     private view;
     private anchor;
     private offset;
+    private static get coreDefaults();
+    /** @deprecated Use the unified `accessibilityLabel` property instead. */
     contentDescriptionWhenZoomedOut: string | null;
+    /** @deprecated Use the unified `accessibilityLabel` property instead. */
     contentDescriptionWhenZoomedIn: string | null;
+    /** @deprecated Use the unified `accessibilityLabel` property instead. */
     accessibilityLabelWhenZoomedOut: string | null;
+    /** @deprecated Use the unified `accessibilityLabel` property instead. */
     accessibilityLabelWhenZoomedIn: string | null;
+    /** @deprecated Use the unified `accessibilityHint` property instead. */
     accessibilityHintWhenZoomedOut: string | null;
+    /** @deprecated Use the unified `accessibilityHint` property instead. */
     accessibilityHintWhenZoomedIn: string | null;
+    orientation: ZoomSwitchOrientation;
+    isAlwaysExpanded: boolean;
+    isExpanded: boolean;
+    accessibilityLabel: string;
+    accessibilityHint: string;
+    private _selectedZoomLevel;
+    get selectedZoomLevel(): number;
     constructor();
+    selectZoomLevel(level: number): Promise<number>;
+    /** @deprecated Use the new ZoomSwitchControl v2 API. Image-based customization will be removed in 9.0. */
     get zoomedOutImage(): string | null;
+    /** @deprecated Use the new ZoomSwitchControl v2 API. Image-based customization will be removed in 9.0. */
     set zoomedOutImage(zoomedOutImage: string | null);
+    /** @deprecated Use the new ZoomSwitchControl v2 API. Image-based customization will be removed in 9.0. */
     get zoomedInImage(): string | null;
+    /** @deprecated Use the new ZoomSwitchControl v2 API. Image-based customization will be removed in 9.0. */
     set zoomedInImage(zoomedInImage: string | null);
+    /** @deprecated Use the new ZoomSwitchControl v2 API. Image-based customization will be removed in 9.0. */
     get zoomedInPressedImage(): string | null;
+    /** @deprecated Use the new ZoomSwitchControl v2 API. Image-based customization will be removed in 9.0. */
     set zoomedInPressedImage(zoomedInPressedImage: string | null);
+    /** @deprecated Use the new ZoomSwitchControl v2 API. Image-based customization will be removed in 9.0. */
     get zoomedOutPressedImage(): string | null;
+    /** @deprecated Use the new ZoomSwitchControl v2 API. Image-based customization will be removed in 9.0. */
     set zoomedOutPressedImage(zoomedOutPressedImage: string | null);
+    /** @deprecated Use the new ZoomSwitchControl v2 API. Image-based customization will be removed in 9.0. */
     setZoomedInImage(resource: string): void;
+    /** @deprecated Use the new ZoomSwitchControl v2 API. Image-based customization will be removed in 9.0. */
     setZoomedInPressedImage(resource: string): void;
+    /** @deprecated Use the new ZoomSwitchControl v2 API. Image-based customization will be removed in 9.0. */
     setZoomedOutImage(resource: string): void;
+    /** @deprecated Use the new ZoomSwitchControl v2 API. Image-based customization will be removed in 9.0. */
     setZoomedOutPressedImage(resource: string): void;
 }

package/dist/dts/camera/ZoomSwitchOrientation.d.ts

@@ -0,0 +1,5 @@
+export declare enum ZoomSwitchOrientation {
+    Default = "default",
+    Horizontal = "horizontal",
+    Vertical = "vertical"
+}

package/dist/dts/camera/controller/CameraController.d.ts

@@ -16,6 +16,8 @@ export declare class CameraController extends BaseController<CoreProxy> {
     unsubscribeTorchListener(): Promise<void>;
     subscribeMacroModeListener(): Promise<void>;
     unsubscribeMacroModeListener(): Promise<void>;
+    subscribeZoomListener(): Promise<void>;
+    unsubscribeZoomListener(): Promise<void>;
     dispose(): void;
     private handleDidChangeStateEvent;
     private handleDidChangeStateEventWrapper;
@@ -23,4 +25,6 @@ export declare class CameraController extends BaseController<CoreProxy> {
     private handleDidChangeTorchToStateEventWrapper;
     private handleDidChangeMacroModeEvent;
     private handleDidChangeMacroModeEventWrapper;
+    private handleDidChangeZoomLevelEvent;
+    private handleDidChangeZoomLevelEventWrapper;
 }

package/dist/dts/camera/index.d.ts

@@ -4,6 +4,7 @@ export * from "./FocusGestureListenerEvents";
 export * from "./TapToFocus";
 export * from "./PrivateFocusGestureDeserializer";
 export * from "./ZoomGesture";
+export * from "./PrivateZoomGestureDeserializer";
 export * from "./ZoomGestureListener";
 export * from "./ZoomGestureListenerEvents";
 export * from "./controller/CameraController";
@@ -17,5 +18,7 @@ export * from "./FocusRange";
 export * from "./FocusGestureStrategy";
 export * from "./LogoStyle";
 export * from "./SwipeToZoom";
+export * from "./PinchToZoom";
 export * from "./CameraSettings";
 export * from "./MacroMode";
+export * from "./ZoomSwitchOrientation";

package/dist/dts/camerahelpers/ZoomListenerEvents.d.ts

@@ -0,0 +1,3 @@
+export declare enum ZoomListenerEvents {
+    didChangeZoomLevel = "ZoomListener.onZoomLevelChanged"
+}

package/dist/dts/camerahelpers/index.d.ts

@@ -5,3 +5,4 @@ export * from "./MacroModeListenerEvents";
 export * from "./CameraOwner";
 export * from "./CameraOwnershipManager";
 export * from "./CameraOwnershipHelper";
+export * from "./ZoomListenerEvents";

package/dist/dts/defaults/CoreDefaults.d.ts

@@ -1,7 +1,7 @@
-import { FocusGesture, FocusGestureStrategy, FocusRange, LogoStyle, MacroMode, VideoResolution, ZoomGesture } from "../camera";
-import { CameraPosition } from "../camerahelpers";
-import { Anchor, Brush, Color, MarginsWithUnit, NumberWithUnit, PointWithUnit, SizeWithUnitAndAspect } from "../common";
-import { RectangularViewfinderAnimation, RectangularViewfinderLineStyle, RectangularViewfinderStyle } from "../viewfinder";
+import { FocusGesture, FocusGestureStrategy, FocusRange, LogoStyle, MacroMode, VideoResolution, ZoomGesture, ZoomSwitchOrientation } from '../camera';
+import { CameraPosition } from '../camerahelpers';
+import { Anchor, Brush, Color, MarginsWithUnit, NumberWithUnit, PointWithUnit, SizeWithUnitAndAspect } from '../common';
+import { RectangularViewfinderAnimation, RectangularViewfinderLineStyle, RectangularViewfinderStyle } from '../viewfinder';
 export interface CameraSettingsDefaults {
     preferredResolution: VideoResolution;
     zoomFactor: number;
@@ -11,6 +11,7 @@ export interface CameraSettingsDefaults {
     shouldPreferSmoothAutoFocus: boolean;
     manualLensPosition: number;
     focusStrategy: string;
+    zoomLevels: number[];
     torchLevel: number;
     macroMode: MacroMode;
     adaptiveExposure: boolean;
@@ -18,12 +19,20 @@ export interface CameraSettingsDefaults {
         [key: string]: unknown;
     };
 }
+export interface ZoomSwitchControlDefaults {
+    orientation: ZoomSwitchOrientation;
+    isAlwaysExpanded: boolean;
+    isExpanded: boolean;
+    accessibilityLabel: string;
+    accessibilityHint: string;
+}
 export interface CoreDefaults {
     Camera: {
         Settings: CameraSettingsDefaults;
         defaultPosition: CameraPosition | null;
         availablePositions: CameraPosition[];
     };
+    ZoomSwitchControl: ZoomSwitchControlDefaults;
     DataCaptureView: {
         scanAreaMargins: MarginsWithUnit;
         pointOfInterest: PointWithUnit;
@@ -31,6 +40,7 @@ export interface CoreDefaults {
         logoOffset: PointWithUnit;
         focusGesture: FocusGesture | null;
         zoomGesture: ZoomGesture | null;
+        zoomGestures: ZoomGesture[];
         logoStyle: LogoStyle;
         shouldShowZoomNotification?: boolean;
     };

package/dist/dts/frame/ZoomListener.d.ts

@@ -0,0 +1,3 @@
+export interface ZoomListener {
+    didChangeZoomLevel?(oldZoomLevel: number, newZoomLevel: number): void;
+}

package/dist/dts/frame/index.d.ts

@@ -2,6 +2,7 @@ export { FrameSource } from "./FrameSource";
 export { FrameSourceListener } from "./FrameSourceListener";
 export { TorchListener } from "./TorchListener";
 export { MacroModeListener } from "./MacroModeListener";
+export { ZoomListener } from "./ZoomListener";
 export { FrameSourceState } from "./FrameSourceState";
 export { FrameData } from "./FrameData";
 export { ImageBuffer } from "./ImageBuffer";

package/dist/dts/generated/CoreProxyAdapter.d.ts

@@ -49,6 +49,23 @@ export declare class CoreProxyAdapter {
      * Unregisters the torch state event listener
      */
     unregisterTorchStateListener(): Promise<void>;
+    /**
+     * Registers a persistent listener for zoom level change events
+     */
+    registerZoomLevelListener(): Promise<void>;
+    /**
+     * Unregisters the zoom level event listener
+     */
+    unregisterZoomLevelListener(): Promise<void>;
+    /**
+     * Selects the zoom level on the ZoomSwitchControl. Returns the actual zoom level applied.
+     * @param viewId View identifier
+     * @param zoomLevel Desired zoom level as a zoom factor
+     */
+    selectZoomLevel({ viewId, zoomLevel }: {
+        viewId: number;
+        zoomLevel: number;
+    }): Promise<number>;
     /**
      * Registers a persistent listener for macro mode change events
      */

package/dist/dts/view/DataCaptureView.d.ts

@@ -36,8 +36,12 @@ export declare class BaseDataCaptureView extends DefaultSerializeable {
     private _focusGesture;
     get focusGesture(): FocusGesture | null;
     set focusGesture(newValue: FocusGesture | null);
-    private _zoomGesture;
+    private _zoomGestures;
+    get zoomGestures(): ZoomGesture[];
+    set zoomGestures(newValue: ZoomGesture[]);
+    /** @deprecated Use zoomGestures instead. Will be removed in a future version. */
     get zoomGesture(): ZoomGesture | null;
+    /** @deprecated Use zoomGestures instead. Will be removed in a future version. */
     set zoomGesture(newValue: ZoomGesture | null);
     private _logoStyle;
     get logoStyle(): LogoStyle;
@@ -74,4 +78,5 @@ export declare class BaseDataCaptureView extends DefaultSerializeable {
     show(): Promise<void>;
     hide(): Promise<void>;
     setProperty<T>(name: string, value: T): void;
+    selectZoomLevel(zoomLevel: number): Promise<number>;
 }

package/dist/dts/view/DataCaptureViewController.d.ts

@@ -56,6 +56,7 @@ export declare class DataCaptureViewController extends BaseController<DataCaptur
     private handleOnFocusGestureEvent;
     private handleOnFocusGestureEventWrapper;
     updateZoomGestureListenerSubscription(zoomGesture: ZoomGesture | null, shouldSubscribe: boolean): Promise<void>;
+    selectZoomLevel(zoomLevel: number): Promise<number>;
     private subscribeZoomGestureListener;
     private unsubscribeZoomGestureListener;
     private handleOnZoomInGestureEvent;