scandit-datacapture-frameworks-label 7.5.1 → 7.6.0

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

@@ -1,4 +1,4 @@
-import { Brush, CameraSettings } from 'scandit-datacapture-frameworks-core';
+import { Brush, CameraSettings, Feedback } from 'scandit-datacapture-frameworks-core';
 export interface LabelCaptureDefaults {
     LabelCapture: {
         RecommendedCameraSettings: CameraSettings;
@@ -17,6 +17,9 @@ export interface LabelCaptureDefaults {
                 manualInputButtonText: string;
             };
         };
+        Feedback: {
+            success: Feedback;
+        };
     };
 }
 export declare function loadLabelCaptureDefaults(jsonDefaults: any): void;

package/dist/dts/labelcapture/LabelCapture.d.ts

@@ -1,24 +1,42 @@
 import { DefaultSerializeable, CameraSettings, DataCaptureContext, DataCaptureMode } from 'scandit-datacapture-frameworks-core';
 import { LabelCaptureListener } from './LabelCaptureListener';
 import { LabelCaptureSettings } from './LabelCaptureSettings';
+import { LabelCaptureFeedback } from './LabelCaptureFeedback';
 export declare class LabelCapture extends DefaultSerializeable implements DataCaptureMode {
+    private type;
+    private modeId;
+    private parentId;
     get isEnabled(): boolean;
     set isEnabled(isEnabled: boolean);
     get context(): DataCaptureContext | null;
+    static createRecommendedCameraSettings(): CameraSettings;
+    private static _recommendedCameraSettings;
+    /**
+     * @deprecated Use createRecommendedCameraSettings() instead to get a new instance that can be safely modified.
+     */
     static get recommendedCameraSettings(): CameraSettings;
-    private type;
-    private modeId;
     private _isEnabled;
     private settings;
+    private _feedback;
     private hasListeners;
     private privateContext;
     private get _context();
     private set _context(value);
     private listeners;
     private controller;
+    /**
+     * @deprecated Since 7.6. This factory will be removed in 8.0.
+     * Use the public constructor instead and configure manually:
+     * ```ts
+     * const mode = new LabelCapture(settings);
+     * context.addMode(mode);
+     * ```
+     */
     static forContext(context: DataCaptureContext | null, settings: LabelCaptureSettings): LabelCapture;
-    private constructor();
+    constructor(settings: LabelCaptureSettings);
     applySettings(settings: LabelCaptureSettings): Promise<void>;
     addListener(listener: LabelCaptureListener): void;
     removeListener(listener: LabelCaptureListener): void;
+    get feedback(): LabelCaptureFeedback;
+    set feedback(feedback: LabelCaptureFeedback);
 }

package/dist/dts/labelcapture/LabelCaptureFeedback.d.ts

@@ -0,0 +1,19 @@
+import { DefaultSerializeable, Feedback } from "scandit-datacapture-frameworks-core";
+import { LabelCaptureController } from "./controller/LabelCaptureController";
+export declare class LabelCaptureFeedback extends DefaultSerializeable {
+    static get defaultFeedback(): LabelCaptureFeedback;
+    private static get labelCaptureDefaults();
+    private _success;
+    get success(): Feedback;
+    set success(success: Feedback);
+    private controller;
+    private updateFeedback;
+    constructor();
+}
+export interface PrivateLabelCaptureFeedback {
+    controller: LabelCaptureController | null;
+    fromJSON(json: LabelCaptureFeedbackJSON): LabelCaptureFeedback;
+}
+export interface LabelCaptureFeedbackJSON {
+    success: Feedback;
+}

package/dist/dts/labelcapture/controller/LabelCaptureAdvancedOverlayController.d.ts

@@ -62,8 +62,8 @@ export interface LabelCaptureAdvancedOverlayProxy {
 }
 export declare class LabelCaptureAdvancedOverlayController extends BaseController<LabelCaptureAdvancedOverlayProxy> {
     private overlay;
-    private constructor();
-    static forOverlay(overlay: LabelCaptureAdvancedOverlay): LabelCaptureAdvancedOverlayController;
+    constructor(overlay: LabelCaptureAdvancedOverlay);
+    private initialize;
     setViewForCapturedLabel(label: CapturedLabel, view: LabelCaptureAdvancedOverlayView | null): Promise<void>;
     setAnchorForCapturedLabel(label: CapturedLabel, anchor: Anchor): Promise<void>;
     setOffsetForCapturedLabel(label: CapturedLabel, offset: PointWithUnit): Promise<void>;

package/dist/dts/labelcapture/controller/LabelCaptureBasicOverlayController.d.ts

@@ -36,8 +36,8 @@ export interface LabelCaptureBasicOverlayProxy {
 }
 export declare class LabelCaptureBasicOverlayController extends BaseController<LabelCaptureBasicOverlayProxy> {
     private overlay;
-    private constructor();
-    static forOverlay(overlay: LabelCaptureBasicOverlay): LabelCaptureBasicOverlayController;
+    constructor(overlay: LabelCaptureBasicOverlay);
+    private initialize;
     setBrushForFieldOfLabel(brush: Brush | null, field: LabelField, label: CapturedLabel): Promise<void>;
     setBrushForLabel(brush: Brush | null, label: CapturedLabel): Promise<void>;
     subscribeListener(): Promise<void>;
@@ -46,6 +46,7 @@ export declare class LabelCaptureBasicOverlayController extends BaseController<L
     private handleDidTapLabel;
     unsubscribeListener(): Promise<void>;
     updateBasicOverlay(basicOverlayJson: string): Promise<void>;
+    dispose(): void;
     private get dataCaptureViewId();
 }
 export interface LabelCaptureBasicOverlayEventPayload {

package/dist/dts/labelcapture/controller/LabelCaptureController.d.ts

@@ -1,5 +1,6 @@
-import { BaseController, EventEmitter } from "scandit-datacapture-frameworks-core";
+import { BaseNewController, EventEmitter } from "scandit-datacapture-frameworks-core";
 import { LabelCapture } from "../LabelCapture";
+import { LabelCaptureFeedback } from "../LabelCaptureFeedback";
 export declare enum LabelCaptureListenerEvents {
     didUpdateSession = "LabelCaptureListener.didUpdateSession"
 }
@@ -22,21 +23,31 @@ export interface LabelCaptureProxy {
     $unregisterListenerForEvents({ modeId }: {
         modeId: number;
     }): Promise<void>;
-    $finishDidUpdateSessionCallback({ isEnabled }: {
+    $finishDidUpdateSessionCallback({ modeId, isEnabled }: {
+        modeId: number;
         isEnabled: boolean;
     }): Promise<void>;
+    $updateLabelCaptureFeedback({ modeId, feedbackJson }: {
+        modeId: number;
+        feedbackJson: string;
+    }): Promise<void>;
     subscribeForEvents(events: string[]): void;
     unsubscribeFromEvents(events: string[]): void;
     dispose(): void;
     eventEmitter: EventEmitter;
 }
-export declare class LabelCaptureController extends BaseController<LabelCaptureProxy> {
+export declare class LabelCaptureController extends BaseNewController<LabelCaptureProxy> {
     private mode;
+    private _boundHandleDidUpdateSession?;
     constructor(mode: LabelCapture);
+    private initialize;
     setModeEnabledState(isEnabled: boolean): Promise<void>;
     updateLabelCaptureSettings(settingsJson: string): Promise<void>;
     subscribeLabelCaptureListener(): Promise<void>;
     private handleDidUpdateSessionEvent;
     unsubscribeLabelCaptureListener(): Promise<void>;
+    updateFeedback(feedback: LabelCaptureFeedback): void;
+    dispose(): void;
+    private get modeId();
     private notifyListenersOfDidUpdateSession;
 }

package/dist/dts/labelcapture/controller/LabelCaptureValidationFlowOverlayController.d.ts

@@ -26,8 +26,8 @@ export interface LabelCaptureValidationFlowOverlayProxy {
 export declare class LabelCaptureValidationFlowOverlayController extends BaseController<LabelCaptureValidationFlowOverlayProxy> {
     private overlay;
     private isSubscribed;
-    private constructor();
-    static forOverlay(overlay: LabelCaptureValidationFlowOverlay): LabelCaptureValidationFlowOverlayController;
+    constructor(overlay: LabelCaptureValidationFlowOverlay);
+    private initialize;
     updateValidationFlowOverlay(): Promise<void>;
     subscribeLabelCaptureValidationFlowListener(): void;
     unsubscribeLabelCaptureValidationFlowListener(): void;

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

@@ -6,6 +6,7 @@ export * from './ExpiryDateText';
 export * from './ImeiOneBarcode';
 export * from './ImeiTwoBarcode';
 export * from './LabelCapture';
+export * from './LabelCaptureFeedback';
 export * from './view/LabelCaptureAdvancedOverlay';
 export * from './LabelCaptureListener';
 export * from './LabelCaptureSession';
@@ -36,3 +37,4 @@ export * from './view/LabelCaptureValidationFlowOverlay';
 export * from './LabelCaptureValidationFlowListener';
 export * from './LabelCaptureValidationFlowSettings';
 export * from './controller/LabelCaptureValidationFlowOverlayController';
+export * from './private/PrivateLabelCapture';

package/dist/dts/labelcapture/private/PrivateLabelCapture.d.ts

@@ -3,4 +3,5 @@ import { LabelCaptureListener } from '../LabelCaptureListener';
 export interface PrivateLabelCapture extends PrivateDataCaptureMode {
     _context: DataCaptureContext | null;
     listeners: LabelCaptureListener[];
+    parentId: number | null;
 }

package/dist/dts/labelcapture/view/LabelCaptureAdvancedOverlay.d.ts

@@ -5,21 +5,29 @@ import { LabelCaptureAdvancedOverlayListener } from "./LabelCaptureAdvancedOverl
 import { CapturedLabel } from '../CapturedLabel';
 import { LabelField } from '../LabelField';
 export declare class LabelCaptureAdvancedOverlay extends DefaultSerializeable implements DataCaptureOverlay {
-    private set view(value);
+    private type;
+    private controller;
+    private _view;
+    private modeId;
     private get view();
+    private set view(value);
     get shouldShowScanAreaGuides(): boolean;
     set shouldShowScanAreaGuides(shouldShow: boolean);
-    private type;
-    private proxy;
-    private mode;
-    private _view;
     private _listener;
     private hasListener;
     get listener(): LabelCaptureAdvancedOverlayListener | null;
     set listener(listener: LabelCaptureAdvancedOverlayListener | null);
     private _shouldShowScanAreaGuides;
+    /**
+     * @deprecated Since 7.6. This factory will be removed in 8.0.
+     * Use the public constructor instead and add the overlay to the view manually:
+     * ```ts
+     * const overlay = new LabelCaptureAdvancedOverlay(labelCapture);
+     * view.addOverlay(overlay);
+     * ```
+     */
     static withLabelCaptureForView(labelCapture: LabelCapture, view: DataCaptureView | null): LabelCaptureAdvancedOverlay;
-    private constructor();
+    constructor(mode: LabelCapture);
     setViewForCapturedLabel(capturedLabel: CapturedLabel, view: LabelCaptureAdvancedOverlayView | null): Promise<void>;
     setViewForCapturedLabelField(field: LabelField, capturedLabel: CapturedLabel, view: LabelCaptureAdvancedOverlayView | null): Promise<void>;
     setAnchorForCapturedLabel(capturedLabel: CapturedLabel, anchor: Anchor): Promise<void>;

package/dist/dts/labelcapture/view/LabelCaptureBasicOverlay.d.ts

@@ -13,10 +13,11 @@ export declare class LabelCaptureBasicOverlay extends DefaultSerializeable imple
     static get defaultLabelBrush(): Brush;
     private static get labelCaptureDefaults();
     private type;
-    private mode;
+    private controller;
     private _view;
-    private set view(value);
+    private modeId;
     private get view();
+    private set view(value);
     private _predictedFieldBrush;
     get predictedFieldBrush(): Brush | null;
     set predictedFieldBrush(newBrush: Brush | null);
@@ -31,15 +32,26 @@ export declare class LabelCaptureBasicOverlay extends DefaultSerializeable imple
     private _listener;
     get listener(): LabelCaptureBasicOverlayListener | null;
     set listener(listener: LabelCaptureBasicOverlayListener | null);
-    private controller;
     get shouldShowScanAreaGuides(): boolean;
     set shouldShowScanAreaGuides(shouldShow: boolean);
     private _viewfinder;
     get viewfinder(): Viewfinder | null;
     set viewfinder(newViewfinder: Viewfinder | null);
+    /**
+     * @deprecated Since 7.6. These factories will be removed in 8.0.
+     * Use the public constructor instead and add the overlay to the view manually:
+     * const overlay = new LabelCaptureBasicOverlay(labelCapture);
+     * view.addOverlay(overlay);
+     */
     static withLabelCapture(labelCapture: LabelCapture): LabelCaptureBasicOverlay;
+    /**
+     * @deprecated Since 7.6. These factories will be removed in 8.0.
+     * Use the public constructor instead and add the overlay to the view manually:
+     * const overlay = new LabelCaptureBasicOverlay(labelCapture);
+     * view.addOverlay(overlay);
+     */
     static withLabelCaptureForView(labelCapture: LabelCapture, view: DataCaptureView | null): LabelCaptureBasicOverlay;
-    private constructor();
+    constructor(mode: LabelCapture);
     setBrushForFieldOfLabel(brush: Brush, field: LabelField, label: CapturedLabel): Promise<void>;
     setBrushForLabel(brush: Brush, label: CapturedLabel): Promise<void>;
 }

package/dist/dts/labelcapture/view/LabelCaptureValidationFlowOverlay.d.ts

@@ -4,17 +4,25 @@ import { LabelCaptureValidationFlowSettings } from '../LabelCaptureValidationFlo
 import { LabelCaptureValidationFlowListener } from '../LabelCaptureValidationFlowListener';
 export declare class LabelCaptureValidationFlowOverlay extends DefaultSerializeable implements DataCaptureOverlay {
     private type;
-    private mode;
-    private _view;
     private settings;
     private hasListener;
     private _listener;
     private controller;
-    private set view(value);
+    private _view;
+    private modeId;
     private get view();
+    private set view(value);
+    /**
+     * @deprecated Since 7.6. This factory will be removed in 8.0.
+     * Use the public constructor instead and add the overlay to the view manually:
+     * ```ts
+     * const overlay = new LabelCaptureValidationFlowOverlay(labelCapture);
+     * view.addOverlay(overlay);
+     * ```
+     */
     static withLabelCaptureForView(labelCapture: LabelCapture, view: DataCaptureView | null): LabelCaptureValidationFlowOverlay;
     get listener(): LabelCaptureValidationFlowListener | null;
     set listener(listener: LabelCaptureValidationFlowListener | null);
     applySettings(settings: LabelCaptureValidationFlowSettings): Promise<void>;
-    private constructor();
+    constructor(mode: LabelCapture);
 }