scandit-datacapture-frameworks-core 7.0.1 → 7.1.0-beta.1

package/dist/dts/BaseController.d.ts

@@ -10,3 +10,41 @@ export declare class BaseNativeProxy {
     protected eventEmitter: EventEmitter;
     constructor();
 }
+/**
+ * Framework specific native calls provider
+ */
+export interface NativeCaller {
+    callFn(fnName: string, args: object | undefined | null): Promise<any>;
+    registerEvent(evName: string, handler: (args: any) => Promise<void>): Promise<any>;
+    unregisterEvent(evName: string, subscription: any): Promise<void>;
+}
+export interface ProxyEvent {
+    name: string;
+    nativeEventName: string;
+}
+/**
+ * AdvancedNativeProxy will provide an easy way to communicate between native proxies
+ * and other parts of the architecture such as the controller layer
+ */
+export declare class AdvancedNativeProxy extends BaseNativeProxy {
+    protected nativeCaller: NativeCaller;
+    protected events: ProxyEvent[];
+    protected eventSubscriptions: Map<string, any>;
+    [k: string]: any;
+    constructor(nativeCaller: NativeCaller, events?: ProxyEvent[]);
+    dispose(): Promise<void>;
+    _call(fnName: string, args: object | undefined | null): Promise<any>;
+    _registerEvent(event: ProxyEvent): Promise<void>;
+    _unregisterEvent(event: ProxyEvent): Promise<void>;
+}
+/**
+ * Function to create a custom AdvancedNativeProxy. This will return an object which will provide dynamically the
+ * methods specified in the PROXY interface.
+ *
+ * The Proxy interface implemented in order to call native methods will require a special mark
+ * `$methodName` for method calls
+ * `on$methodName` for the listeners added to the events defined in eventsEnum
+ * @param nativeCaller
+ * @param eventsEnum
+ */
+export declare function createAdvancedNativeProxy<PROXY>(nativeCaller: NativeCaller, eventsEnum?: any): PROXY;

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

@@ -1,14 +1,15 @@
 import { Camera } from "./Camera";
 import { FrameData, FrameSourceState } from "../frame";
 import { CameraPosition } from "../camerahelpers";
+import { NativeCallResult } from "../common";
 export interface CameraProxy {
-    getCurrentCameraState(position: CameraPosition): Promise<FrameSourceState>;
+    getCurrentCameraState(position: CameraPosition): Promise<NativeCallResult>;
     switchCameraToDesiredState(desiredStateJson: string): Promise<void>;
-    isTorchAvailable(position: CameraPosition): Promise<boolean>;
+    isTorchAvailable(position: CameraPosition): Promise<NativeCallResult>;
     registerListenerForCameraEvents(): void;
     unregisterListenerForCameraEvents(): Promise<void>;
     subscribeDidChangeState?(): void;
-    getFrame(frameId: string): Promise<string | null>;
+    getFrame(frameId: string): Promise<NativeCallResult | null>;
 }
 export declare class CameraController {
     private camera;

package/dist/dts/common/FontFamily.d.ts

@@ -0,0 +1,5 @@
+export declare enum FontFamily {
+    SystemDefault = "systemDefault",
+    ModernMono = "modernMono",
+    SystemSans = "systemSans"
+}

package/dist/dts/common/Observable.d.ts

@@ -0,0 +1,10 @@
+import { DefaultSerializeable } from "../serializable";
+export interface PropertyChangeListener {
+    (property: string, value: any): void;
+}
+export declare class Observable extends DefaultSerializeable {
+    private listeners;
+    addListener(listener: PropertyChangeListener): void;
+    removeListener(listener: PropertyChangeListener): void;
+    protected notifyListeners(property: string, value: any): void;
+}

package/dist/dts/common/Payload.d.ts

@@ -1,3 +1,4 @@
+import { FrameSourceState } from "../frame/FrameSourceState";
 import { SizeJSON } from "./Size";
 export interface DidChangeSizeEventPayload {
     size: SizeJSON;
@@ -9,3 +10,16 @@ export interface DidChangeStatusEventPayload {
 export interface DidChangeStateEventPayload {
     state: string;
 }
+export interface EventPayload {
+    name: string;
+    data: string;
+}
+export declare class EventDataParser {
+    static parse<T>(data: string): T | null;
+}
+export interface NativeCallResult {
+    data: string;
+}
+export interface FrameSourceDidChangeStateEventPayload {
+    state: FrameSourceState;
+}

package/dist/dts/common/ScanditIcon.d.ts

@@ -0,0 +1,31 @@
+import { DefaultSerializeable } from "../serializable";
+import { Color } from "./Color";
+import { ScanditIconShape } from "./ScanditIconShape";
+import { ScanditIconType } from "./ScanditIconType";
+export type ScanditIconJSON = {
+    backgroundColor: Color | null;
+    backgroundShape: ScanditIconShape | null;
+    icon: ScanditIconType | null;
+    iconColor: Color | null;
+    backgroundStrokeColor: Color | null;
+    backgroundStrokeWidth: number;
+};
+export interface PrivateScanditIcon {
+    fromJSON(json: ScanditIconJSON): ScanditIcon;
+}
+export declare class ScanditIcon extends DefaultSerializeable {
+    private _backgroundColor;
+    private _backgroundShape;
+    private _icon;
+    private _iconColor;
+    private _backgroundStrokeColor;
+    private _backgroundStrokeWidth;
+    private static fromJSON;
+    constructor(iconColor: Color | null, backgroundColor: Color | null, backgroundShape: ScanditIconShape | null, icon: ScanditIconType | null, backgroundStrokeColor: Color | null, backgroundStrokeWidth: number);
+    get backgroundColor(): Color | null;
+    get backgroundShape(): ScanditIconShape | null;
+    get icon(): ScanditIconType | null;
+    get iconColor(): Color | null;
+    get backgroundStrokeColor(): Color | null;
+    get backgroundStrokeWidth(): number;
+}

package/dist/dts/common/ScanditIconBuilder.d.ts

@@ -0,0 +1,19 @@
+import { ScanditIcon } from "./ScanditIcon";
+import { Color } from "./Color";
+import { ScanditIconShape } from "./ScanditIconShape";
+import { ScanditIconType } from "./ScanditIconType";
+export declare class ScanditIconBuilder {
+    private _iconColor;
+    private _backgroundColor;
+    private _backgroundShape;
+    private _icon;
+    private _backgroundStrokeColor;
+    private _backgroundStrokeWidth;
+    withIconColor(iconColor: Color | null): ScanditIconBuilder;
+    withBackgroundColor(backgroundColor: Color | null): ScanditIconBuilder;
+    withBackgroundShape(backgroundShape: ScanditIconShape | null): ScanditIconBuilder;
+    withIcon(iconType: ScanditIconType | null): ScanditIconBuilder;
+    withBackgroundStrokeColor(backgroundStrokeColor: Color | null): ScanditIconBuilder;
+    withBackgroundStrokeWidth(backgroundStrokeWidth: number): ScanditIconBuilder;
+    build(): ScanditIcon;
+}

package/dist/dts/common/ScanditIconShape.d.ts

@@ -0,0 +1,4 @@
+export declare enum ScanditIconShape {
+    Circle = "circle",
+    Square = "square"
+}

package/dist/dts/common/ScanditIconType.d.ts

@@ -0,0 +1,24 @@
+export declare enum ScanditIconType {
+    ArrowRight = "arrowRight",
+    ArrowLeft = "arrowLeft",
+    ArrowUp = "arrowUp",
+    ArrowDown = "arrowDown",
+    ToPick = "toPick",
+    Checkmark = "checkmark",
+    XMark = "xmark",
+    QuestionMark = "questionMark",
+    ExclamationMark = "exclamationMark",
+    LowStock = "lowStock",
+    ExpiredItem = "expiredItem",
+    WrongItem = "wrongItem",
+    FragileItem = "fragileItem",
+    StarFilled = "starFilled",
+    StarHalfFilled = "starHalfFilled",
+    ChevronUp = "chevronUp",
+    ChevronDown = "chevronDown",
+    ChevronLeft = "chevronLeft",
+    ChevronRight = "chevronRight",
+    InspectItem = "inspectItem",
+    StarOutlined = "starOutlined",
+    Print = "print"
+}

package/dist/dts/common/TextAlignment.d.ts

@@ -0,0 +1,7 @@
+export declare enum TextAlignment {
+    Left = "left",
+    Right = "right",
+    Center = "center",
+    Start = "start",
+    End = "end"
+}

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

@@ -1,9 +1,15 @@
+export { FontFamily } from "./FontFamily";
+export { TextAlignment } from "./TextAlignment";
 export { Point } from "./Point";
 export { Quadrilateral } from "./Quadrilateral";
 export { NumberWithUnit } from "./NumberWithUnit";
 export { PointWithUnit } from "./PointWithUnit";
 export { Rect } from "./Rect";
 export { RectWithUnit } from "./RectWithUnit";
+export { ScanditIcon } from "./ScanditIcon";
+export { ScanditIconBuilder } from "./ScanditIconBuilder";
+export { ScanditIconShape } from "./ScanditIconShape";
+export { ScanditIconType } from "./ScanditIconType";
 export { Size } from "./Size";
 export { SizeWithAspect } from "./SizeWithAspect";
 export { SizeWithUnit } from "./SizeWithUnit";
@@ -18,12 +24,16 @@ export { Orientation } from "./Orientation";
 export { Direction } from "./Direction";
 export { ScanIntention } from "./ScanIntention";
 export * from "./Payload";
+export { Observable, PropertyChangeListener } from "./Observable";
+export * from "./FontFamily";
+export * from "./TextAlignment";
 export * from "./Point";
 export * from "./Quadrilateral";
 export * from "./NumberWithUnit";
 export * from "./PointWithUnit";
 export * from "./Rect";
 export * from "./RectWithUnit";
+export * from "./ScanditIcon";
 export * from "./Size";
 export * from "./SizeWithAspect";
 export * from "./SizeWithUnit";

package/dist/dts/context/DataCaptureContext.d.ts

@@ -12,13 +12,13 @@ export declare class DataCaptureContext extends DefaultSerializeable {
     private licenseKey;
     private deviceName;
     private static instance;
-    private get framework();
-    private get frameworkVersion();
+    private controller;
+    private _framework;
+    private _frameworkVersion;
     private settings;
     private _frameSource;
     private view;
     private modes;
-    private controller;
     private listeners;
     private static get coreDefaults();
     get frameSource(): FrameSource | null;
@@ -42,6 +42,7 @@ export declare class DataCaptureContext extends DefaultSerializeable {
     applySettings(settings: DataCaptureContextSettings): Promise<void>;
     static getOpenSourceSoftwareLicenseInfo(): Promise<OpenSourceSoftwareLicenseInfo>;
     private initialize;
+    private initializeAsync;
     private update;
 }
 export interface PrivateDataCaptureContext {
@@ -52,4 +53,5 @@ export interface PrivateDataCaptureContext {
     view: BaseDataCaptureView | null;
     update: () => Promise<void>;
     initialize(): void;
+    initializeAsync(): Promise<void>;
 }

package/dist/dts/context/controller/DataCaptureContextController.d.ts

@@ -1,10 +1,11 @@
 import { DataCaptureContext } from "../DataCaptureContext";
 import { DataCaptureMode } from "../DataCaptureMode";
 import { OpenSourceSoftwareLicenseInfo } from "../OpenSourceSoftwareLicenseInfo";
+import { NativeCallResult } from "../../common";
 export interface DataCaptureContextProxy {
     get framework(): string;
     get frameworkVersion(): string;
-    contextFromJSON(contextJson: string): Promise<string>;
+    contextFromJSON(contextJson: string): Promise<NativeCallResult>;
     updateContextFromJSON(contextJson: string): Promise<void>;
     dispose(): void;
     registerListenerForDataCaptureContext(): void;
@@ -14,7 +15,7 @@ export interface DataCaptureContextProxy {
     addModeToContext(modeJson: string): Promise<void>;
     removeModeFromContext(modeJson: string): Promise<void>;
     removeAllModesFromContext(): Promise<void>;
-    getOpenSourceSoftwareLicenseInfo(): Promise<string>;
+    getOpenSourceSoftwareLicenseInfo(): Promise<NativeCallResult>;
 }
 export declare enum DataCaptureContextEvents {
     didChangeStatus = "DataCaptureContextListener.onStatusChanged",
@@ -24,10 +25,11 @@ export declare class DataCaptureContextController {
     private _proxy;
     private context;
     private eventEmitter;
-    get framework(): string;
-    get frameworkVersion(): string;
+    static get framework(): string;
+    static get frameworkVersion(): string;
     private get privateContext();
     static forDataCaptureContext(context: DataCaptureContext): DataCaptureContextController;
+    static forDataCaptureContextAsync(context: DataCaptureContext): Promise<DataCaptureContextController>;
     private constructor();
     updateContextFromJSON(): Promise<void>;
     addModeToContext(mode: DataCaptureMode): Promise<void>;

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

@@ -1,8 +1,9 @@
 import { FrameSourceState } from "./FrameSourceState";
 import { ImageFrameSource } from "./ImageFrameSource";
 import { CameraPosition } from "../camerahelpers";
+import { NativeCallResult } from "../common";
 export interface ImageFrameSourceProxy {
-    getCurrentCameraState(position: CameraPosition): Promise<FrameSourceState>;
+    getCurrentCameraState(position: CameraPosition): Promise<NativeCallResult>;
     switchCameraToDesiredState(desiredStateJson: string): Promise<void>;
     registerListenerForEvents(): void;
     unregisterListenerForEvents(): void;

package/dist/dts/index.d.ts

@@ -1,5 +1,5 @@
 export { EventEmitter } from "./EventEmitter";
-export { BaseController, BaseNativeProxy } from "./BaseController";
+export * from "./BaseController";
 export * from "./defaults";
 export { loadCoreDefaults } from "./defaults/loadCoreDefaults";
 export * from "./common";

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

@@ -1,9 +1,9 @@
-import { Point, Quadrilateral } from "../common";
+import { NativeCallResult, Point, Quadrilateral } from "../common";
 import { BaseDataCaptureView } from "./DataCaptureView";
 import { BaseController } from "../BaseController";
 export interface DataCaptureViewProxy {
-    viewPointForFramePoint(pointJson: string): Promise<string>;
-    viewQuadrilateralForFrameQuadrilateral(quadrilateralJson: string): Promise<string>;
+    viewPointForFramePoint(pointJson: string): Promise<NativeCallResult>;
+    viewQuadrilateralForFrameQuadrilateral(quadrilateralJson: string): Promise<NativeCallResult>;
     registerListenerForViewEvents(): void;
     unregisterListenerForViewEvents(): void;
     subscribeDidChangeSize?(): void;