scandit-datacapture-frameworks-label 7.4.0 → 7.5.0-beta.1

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

@@ -7,6 +7,16 @@ export interface LabelCaptureDefaults {
             DefaultCapturedFieldBrush: Brush;
             DefaultLabelBrush: Brush;
         };
+        LabelCaptureValidationFlowOverlay: {
+            Settings: {
+                missingFieldsHintText: string;
+                standbyHintText: string;
+                validationHintText: string;
+                validationErrorText: string;
+                requiredFieldErrorText: string;
+                manualInputButtonText: string;
+            };
+        };
     };
 }
 export declare function loadLabelCaptureDefaults(jsonDefaults: any): void;

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

@@ -15,9 +15,7 @@ export declare class LabelCapture extends DefaultSerializeable implements DataCa
     private get _context();
     private set _context(value);
     private listeners;
-    private listenerController;
-    private isInListenerCallback;
-    private modeController;
+    private controller;
     static forContext(context: DataCaptureContext | null, settings: LabelCaptureSettings): LabelCapture;
     private constructor();
     applySettings(settings: LabelCaptureSettings): Promise<void>;

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

@@ -0,0 +1,4 @@
+import { LabelField } from "./LabelField";
+export interface LabelCaptureValidationFlowListener {
+    didCaptureLabelWithFields(fields: LabelField[]): void;
+}

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

@@ -0,0 +1,23 @@
+import { DefaultSerializeable } from 'scandit-datacapture-frameworks-core';
+export declare class LabelCaptureValidationFlowSettings extends DefaultSerializeable {
+    private _missingFieldsHintText;
+    private _standbyHintText;
+    private _validationHintText;
+    private _validationErrorText;
+    private _requiredFieldErrorText;
+    private _manualInputButtonText;
+    static create(): LabelCaptureValidationFlowSettings;
+    private constructor();
+    get missingFieldsHintText(): string;
+    set missingFieldsHintText(text: string);
+    get standbyHintText(): string;
+    set standbyHintText(text: string);
+    get validationHintText(): string;
+    set validationHintText(text: string);
+    get validationErrorText(): string;
+    set validationErrorText(text: string);
+    get requiredFieldErrorText(): string;
+    set requiredFieldErrorText(text: string);
+    get manualInputButtonText(): string;
+    set manualInputButtonText(text: string);
+}

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

@@ -3,6 +3,7 @@ import { LabelFieldDefinition } from './LabelFieldDefinition';
 export declare class LabelDefinition extends DefaultSerializeable {
     private _name;
     private _fields;
+    private _type;
     private _hiddenProperties;
     get name(): string;
     get fields(): LabelFieldDefinition[];
@@ -14,5 +15,8 @@ export declare class LabelDefinition extends DefaultSerializeable {
         [key: string]: object;
     });
     private static fromJSON;
+    static createVinLabelDefinition(name: string): LabelDefinition;
+    static createPriceCaptureDefinition(name: string): LabelDefinition;
+    static createSevenSegmentDisplayLabelDefinition(name: string): LabelDefinition;
     constructor(name: string);
 }

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

@@ -1,4 +1,4 @@
-import { PointWithUnit, Anchor, BaseController, EventPayload } from 'scandit-datacapture-frameworks-core';
+import { PointWithUnit, Anchor, BaseController, EventEmitter } from 'scandit-datacapture-frameworks-core';
 import { LabelCaptureAdvancedOverlayView } from '../view/LabelCaptureAdvancedOverlayView';
 import { LabelCaptureAdvancedOverlay } from '../view/LabelCaptureAdvancedOverlay';
 import { CapturedLabel } from '../CapturedLabel';
@@ -12,42 +12,53 @@ export declare enum LabelCaptureAdvancedOverlayListenerEvents {
     offsetForCapturedLabelField = "LabelCaptureAdvancedOverlayListener.offsetForFieldOfLabel"
 }
 export interface LabelCaptureAdvancedOverlayProxy {
-    $setViewForCapturedLabel({ jsonView, trackingId }: {
+    $setViewForCapturedLabel({ dataCaptureViewId, jsonView, trackingId }: {
+        dataCaptureViewId: number;
         jsonView: string | null;
         trackingId: number;
     }): Promise<void>;
-    $setAnchorForCapturedLabel({ anchor, trackingId }: {
+    $setAnchorForCapturedLabel({ dataCaptureViewId, anchor, trackingId }: {
+        dataCaptureViewId: number;
         anchor: Anchor;
         trackingId: number;
     }): Promise<void>;
-    $setOffsetForCapturedLabel({ offsetJson, trackingId }: {
+    $setOffsetForCapturedLabel({ dataCaptureViewId, offsetJson, trackingId }: {
+        dataCaptureViewId: number;
         offsetJson: string;
         trackingId: number;
     }): Promise<void>;
-    $setViewForCapturedLabelField({ view, identifier }: {
+    $setViewForCapturedLabelField({ dataCaptureViewId, view, identifier }: {
+        dataCaptureViewId: number;
         view: string | null;
         identifier: string;
     }): Promise<void>;
-    $setAnchorForCapturedLabelField({ anchor, identifier }: {
+    $setAnchorForCapturedLabelField({ dataCaptureViewId, anchor, identifier }: {
+        dataCaptureViewId: number;
         anchor: Anchor;
         identifier: string;
     }): Promise<void>;
-    $setOffsetForCapturedLabelField({ offset, identifier }: {
+    $setOffsetForCapturedLabelField({ dataCaptureViewId, offset, identifier }: {
+        dataCaptureViewId: number;
         offset: string;
         identifier: string;
     }): Promise<void>;
-    $clearCapturedLabelViews(): Promise<void>;
-    $registerListenerForAdvancedOverlayEvents(): Promise<void>;
-    $unregisterListenerForAdvancedOverlayEvents(): Promise<void>;
-    $updateLabelCaptureAdvancedOverlay({ advancedOverlayJson }: {
+    $clearCapturedLabelViews({ dataCaptureViewId }: {
+        dataCaptureViewId: number;
+    }): Promise<void>;
+    $registerListenerForAdvancedOverlayEvents({ dataCaptureViewId }: {
+        dataCaptureViewId: number;
+    }): Promise<void>;
+    $unregisterListenerForAdvancedOverlayEvents({ dataCaptureViewId }: {
+        dataCaptureViewId: number;
+    }): Promise<void>;
+    $updateLabelCaptureAdvancedOverlay({ dataCaptureViewId, advancedOverlayJson }: {
+        dataCaptureViewId: number;
         advancedOverlayJson: string;
     }): Promise<void>;
-    on$viewForLabel: (ev: EventPayload) => Promise<void>;
-    on$anchorForLabel: (ev: EventPayload) => Promise<void>;
-    on$offsetForLabel: (ev: EventPayload) => Promise<void>;
-    on$viewForCapturedLabelField: (ev: EventPayload) => Promise<void>;
-    on$anchorForCapturedLabelField: (ev: EventPayload) => Promise<void>;
-    on$offsetForCapturedLabelField: (ev: EventPayload) => Promise<void>;
+    subscribeForEvents(events: string[]): void;
+    unsubscribeFromEvents(events: string[]): void;
+    dispose(): void;
+    eventEmitter: EventEmitter;
 }
 export declare class LabelCaptureAdvancedOverlayController extends BaseController<LabelCaptureAdvancedOverlayProxy> {
     private overlay;
@@ -64,8 +75,16 @@ export declare class LabelCaptureAdvancedOverlayController extends BaseControlle
     private setOffsetForCapturedLabelFieldPrivate;
     clearCapturedLabelViews(): Promise<void>;
     subscribeListener(): void;
-    unsubscribeListener(): Promise<void>;
+    private handleViewForLabel;
+    private handleAnchorForLabel;
+    private handleViewForCapturedLabelField;
+    private handleOffsetForLabel;
+    private handleAnchorForCapturedLabelField;
+    private handleOffsetForCapturedLabelField;
+    unsubscribeListener(): void;
+    dispose(): void;
     updateAdvancedOverlay(advancedOverlayJson: string): Promise<void>;
+    private get dataCaptureViewId();
 }
 export interface LabelCaptureAdvancedOverlayEventPayload {
     label: string;

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

@@ -1,4 +1,4 @@
-import { BaseController, Brush, EventPayload } from 'scandit-datacapture-frameworks-core';
+import { BaseController, Brush, EventEmitter } from 'scandit-datacapture-frameworks-core';
 import { LabelCaptureBasicOverlay } from '../view/LabelCaptureBasicOverlay';
 import { LabelField } from '../LabelField';
 import { CapturedLabel } from '../CapturedLabel';
@@ -8,23 +8,31 @@ export declare enum LabelCaptureBasicOverlayListenerEvents {
     didTapLabel = "LabelCaptureBasicOverlayListener.didTapLabel"
 }
 export interface LabelCaptureBasicOverlayProxy {
-    $setBrushForFieldOfLabel({ brushJson, fieldName, trackingId }: {
+    $setBrushForFieldOfLabel({ dataCaptureViewId, brushJson, fieldName, trackingId }: {
+        dataCaptureViewId: number;
         brushJson: string | null;
         fieldName: string;
         trackingId: number;
     }): Promise<void>;
-    $setBrushForLabel({ brushJson, trackingId }: {
+    $setBrushForLabel({ dataCaptureViewId, brushJson, trackingId }: {
+        dataCaptureViewId: number;
         brushJson: string | null;
         trackingId: number;
     }): Promise<void>;
-    $registerListenerForBasicOverlayEvents(): Promise<void>;
-    $unregisterListenerForBasicOverlayEvents(): Promise<void>;
-    $updateLabelCaptureBasicOverlay({ basicOverlayJson }: {
+    $registerListenerForBasicOverlayEvents({ dataCaptureViewId }: {
+        dataCaptureViewId: number;
+    }): Promise<void>;
+    $unregisterListenerForBasicOverlayEvents({ dataCaptureViewId }: {
+        dataCaptureViewId: number;
+    }): Promise<void>;
+    $updateLabelCaptureBasicOverlay({ dataCaptureViewId, basicOverlayJson }: {
+        dataCaptureViewId: number;
         basicOverlayJson: string;
     }): Promise<void>;
-    on$brushForFieldOfLabel: (ev: EventPayload) => Promise<void>;
-    on$brushForLabel: (ev: EventPayload) => Promise<void>;
-    on$didTapLabel: (ev: EventPayload) => Promise<void>;
+    subscribeForEvents(events: string[]): void;
+    unsubscribeFromEvents(events: string[]): void;
+    dispose(): void;
+    eventEmitter: EventEmitter;
 }
 export declare class LabelCaptureBasicOverlayController extends BaseController<LabelCaptureBasicOverlayProxy> {
     private overlay;
@@ -33,8 +41,12 @@ export declare class LabelCaptureBasicOverlayController extends BaseController<L
     setBrushForFieldOfLabel(brush: Brush | null, field: LabelField, label: CapturedLabel): Promise<void>;
     setBrushForLabel(brush: Brush | null, label: CapturedLabel): Promise<void>;
     subscribeListener(): Promise<void>;
+    private handleBrushForFieldOfLabel;
+    private handleBrushForLabel;
+    private handleDidTapLabel;
     unsubscribeListener(): Promise<void>;
     updateBasicOverlay(basicOverlayJson: string): Promise<void>;
+    private get dataCaptureViewId();
 }
 export interface LabelCaptureBasicOverlayEventPayload {
     field: string;

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

@@ -1,5 +1,12 @@
-import { BaseController } from "scandit-datacapture-frameworks-core";
+import { BaseController, EventEmitter } from "scandit-datacapture-frameworks-core";
 import { LabelCapture } from "../LabelCapture";
+export declare enum LabelCaptureListenerEvents {
+    didUpdateSession = "LabelCaptureListener.didUpdateSession"
+}
+export interface LabelCaptureSessionEventPayload {
+    session: string;
+    isBarcodeArFull: boolean | null;
+}
 export interface LabelCaptureProxy {
     $setModeEnabledState({ modeId, isEnabled }: {
         modeId: number;
@@ -9,10 +16,27 @@ export interface LabelCaptureProxy {
         modeId: number;
         settingsJson: string;
     }): Promise<void>;
+    $registerListenerForEvents({ modeId }: {
+        modeId: number;
+    }): Promise<void>;
+    $unregisterListenerForEvents({ modeId }: {
+        modeId: number;
+    }): Promise<void>;
+    $finishDidUpdateSessionCallback({ isEnabled }: {
+        isEnabled: boolean;
+    }): Promise<void>;
+    subscribeForEvents(events: string[]): void;
+    unsubscribeFromEvents(events: string[]): void;
+    dispose(): void;
+    eventEmitter: EventEmitter;
 }
 export declare class LabelCaptureController extends BaseController<LabelCaptureProxy> {
     private mode;
     constructor(mode: LabelCapture);
     setModeEnabledState(isEnabled: boolean): Promise<void>;
     updateLabelCaptureSettings(settingsJson: string): Promise<void>;
+    subscribeLabelCaptureListener(): Promise<void>;
+    private handleDidUpdateSessionEvent;
+    unsubscribeLabelCaptureListener(): Promise<void>;
+    private notifyListenersOfDidUpdateSession;
 }

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

@@ -0,0 +1,41 @@
+import { BaseController, EventEmitter } from 'scandit-datacapture-frameworks-core';
+import { LabelCaptureValidationFlowOverlay } from '../view/LabelCaptureValidationFlowOverlay';
+import { LabelCapture } from '../LabelCapture';
+export interface LabelCaptureValidationFlowListenerEventPayload {
+    fields: string[];
+}
+export declare enum LabelCaptureValidationFlowListenerEvents {
+    didCaptureLabelWithFields = "LabelCaptureValidationFlowListener.didCaptureLabelWithFields"
+}
+export interface LabelCaptureValidationFlowOverlayProxy {
+    $registerListenerForValidationFlowEvents({ dataCaptureViewId }: {
+        dataCaptureViewId: number;
+    }): Promise<void>;
+    $unregisterListenerForValidationFlowEvents({ dataCaptureViewId }: {
+        dataCaptureViewId: number;
+    }): Promise<void>;
+    $updateLabelCaptureValidationFlowOverlay({ dataCaptureViewId, overlayJson }: {
+        dataCaptureViewId: number;
+        overlayJson: string;
+    }): Promise<void>;
+    subscribeForEvents(events: string[]): void;
+    unsubscribeFromEvents(events: string[]): void;
+    dispose(): void;
+    eventEmitter: EventEmitter;
+}
+export declare class LabelCaptureValidationFlowOverlayController extends BaseController<LabelCaptureValidationFlowOverlayProxy> {
+    private overlay;
+    private isSubscribed;
+    private constructor();
+    static forOverlay(overlay: LabelCaptureValidationFlowOverlay): LabelCaptureValidationFlowOverlayController;
+    updateValidationFlowOverlay(): Promise<void>;
+    subscribeLabelCaptureValidationFlowListener(): void;
+    unsubscribeLabelCaptureValidationFlowListener(): void;
+    private handleDidCaptureLabelWithFieldsEvent;
+    private notifyListenersOfDidCaptureLabelWithFields;
+    private get dataCaptureViewId();
+    dispose(): void;
+}
+export interface PrivateLabelCaptureValidationFlowOverlay {
+    mode: LabelCapture;
+}

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

@@ -32,4 +32,7 @@ export * from './view/LabelCaptureAdvancedOverlayListener';
 export * from './controller/LabelCaptureAdvancedOverlayController';
 export * from './controller/LabelCaptureBasicOverlayController';
 export * from './controller/LabelCaptureController';
-export * from './controller/LabelCaptureListenerController';
+export * from './view/LabelCaptureValidationFlowOverlay';
+export * from './LabelCaptureValidationFlowListener';
+export * from './LabelCaptureValidationFlowSettings';
+export * from './controller/LabelCaptureValidationFlowOverlayController';

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

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

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

@@ -13,7 +13,10 @@ export declare class LabelCaptureAdvancedOverlay extends DefaultSerializeable im
     private proxy;
     private mode;
     private _view;
-    listener: LabelCaptureAdvancedOverlayListener | null;
+    private _listener;
+    private hasListener;
+    get listener(): LabelCaptureAdvancedOverlayListener | null;
+    set listener(listener: LabelCaptureAdvancedOverlayListener | null);
     private _shouldShowScanAreaGuides;
     static withLabelCaptureForView(labelCapture: LabelCapture, view: DataCaptureView | null): LabelCaptureAdvancedOverlay;
     private constructor();

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

@@ -27,7 +27,10 @@ export declare class LabelCaptureBasicOverlay extends DefaultSerializeable imple
     get labelBrush(): Brush | null;
     set labelBrush(newBrush: Brush | null);
     private _shouldShowScanAreaGuides;
-    listener: LabelCaptureBasicOverlayListener | null;
+    private hasListener;
+    private _listener;
+    get listener(): LabelCaptureBasicOverlayListener | null;
+    set listener(listener: LabelCaptureBasicOverlayListener | null);
     private controller;
     get shouldShowScanAreaGuides(): boolean;
     set shouldShowScanAreaGuides(shouldShow: boolean);

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

@@ -0,0 +1,20 @@
+import { DataCaptureOverlay, DefaultSerializeable, DataCaptureView } from 'scandit-datacapture-frameworks-core';
+import { LabelCapture } from '../LabelCapture';
+import { LabelCaptureValidationFlowSettings } from '../LabelCaptureValidationFlowSettings';
+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 get view();
+    static withLabelCaptureForView(labelCapture: LabelCapture, view: DataCaptureView | null): LabelCaptureValidationFlowOverlay;
+    get listener(): LabelCaptureValidationFlowListener | null;
+    set listener(listener: LabelCaptureValidationFlowListener | null);
+    applySettings(settings: LabelCaptureValidationFlowSettings): Promise<void>;
+    private constructor();
+}