@ahmed_hani/dot-auto-capture-ui 7.4.0 → 7.7.0

package/ui/src/types/multi-range.d.ts

@@ -0,0 +1,28 @@
+import type { BaseComponentsUiProps, CustomizationContextProps, EscalatedInstructions, HTMLElementWithProps, UiProps } from './common';
+import type { CustomElement, DeepRequired, MultiRangeEscalatedInstructionCodes, MultiRangeInstructionCode, ObjectValues } from '../../../ui-common/src/types';
+export * from './common';
+declare global {
+    namespace preact.JSX {
+        interface IntrinsicElements {
+            'x-dot-multi-range-liveness-ui': CustomElement<{
+                props: MultiRangeUiProps;
+            }>;
+        }
+    }
+    namespace React.JSX {
+        interface IntrinsicElements {
+            'x-dot-multi-range-liveness-ui': CustomElement<{
+                props: MultiRangeUiProps;
+            }>;
+        }
+    }
+}
+export declare const MultiRangePlaceholderIconValues: {
+    readonly CIRCLE_SOLID: "circle-solid";
+};
+export type MultiRangePlaceholderIcon = ObjectValues<typeof MultiRangePlaceholderIconValues>;
+export type MultiRangeInstructions = Record<MultiRangeInstructionCode, string>;
+export type MultiRangeUiProps<I = MultiRangeInstructions> = UiProps<I> & BaseComponentsUiProps<MultiRangePlaceholderIcon> & EscalatedInstructions<MultiRangeEscalatedInstructionCodes>;
+type RequiredUiProps = DeepRequired<MultiRangeUiProps<MultiRangeInstructions>>;
+export type MultiRangeProps = CustomizationContextProps<RequiredUiProps> & EscalatedInstructions<MultiRangeEscalatedInstructionCodes>;
+export type HTMLMultiRangeLivenessUiElement = HTMLElementWithProps<MultiRangeUiProps>;

package/ui/src/types/palm.d.ts

@@ -18,7 +18,8 @@ declare global {
     }
 }
 export declare const PalmPlaceholderIconValues: {
-    readonly WITHOUT_FINGERS: "withoutFingers";
+    readonly LEFT: "left";
+    readonly RIGHT: "right";
 };
 export type PalmPlaceholderIcon = ObjectValues<typeof PalmPlaceholderIconValues>;
 export type PalmInstructions = Record<PalmInstructionCode, string>;

package/ui-common/src/types/common.d.ts

@@ -26,15 +26,17 @@ export declare const CaptureMode: {
     readonly WAIT_FOR_REQUEST: "WAIT_FOR_REQUEST";
 };
 export type CaptureModeValues = ObjectValues<typeof CaptureMode>;
-export type BaseCameraProps<CallbackData> = {
+export type BaseCameraProps<TDetectedObject> = {
     assetsDirectoryPath?: string;
     cameraFacing?: FacingModeValues;
     candidateSelectionDurationMillis?: number;
     captureMode?: CaptureModeValues;
+    isVideoCaptureEnabled?: boolean;
     onError: (e: Error) => void;
-    onPhotoTaken: (imageData: CallbackImage<CallbackData>, content: Uint8Array) => void;
+    onPhotoTaken: (imageData: CallbackImage<TDetectedObject>, content: Uint8Array) => void;
     sessionToken?: string;
     styleTarget?: HTMLElement;
+    transactionCountingToken?: string;
 };
 export type ImageParameters = {
     brightness: number;
@@ -56,6 +58,7 @@ export declare const AppStateValues: {
     readonly ERROR: "ERROR";
     readonly WAITING: "WAITING";
     readonly RUNNING: "RUNNING";
+    readonly COMPLETE: "COMPLETE";
 };
 export declare const LivenessStateValues: {
     readonly DONE: "DONE";
@@ -63,6 +66,7 @@ export declare const LivenessStateValues: {
     readonly ERROR: "ERROR";
     readonly WAITING: "WAITING";
     readonly RUNNING: "RUNNING";
+    readonly COMPLETE: "COMPLETE";
 };
 export type AppState = ObjectValues<typeof AppStateValues>;
 export type Crop = {
@@ -71,10 +75,14 @@ export type Crop = {
     shiftY: number;
     width: number;
 };
-export type CallbackImage<T> = {
-    data: T;
+export type CallbackImage<TDetectedObject> = {
+    data: CallbackImageMetadata<TDetectedObject>;
     image: Blob;
 };
+export type CallbackImageMetadata<TDetectedObject> = {
+    detection: TDetectedObject;
+    imageResolution: Resolution;
+};
 export type DetectedCorners = {
     bottomLeft: Point;
     bottomRight: Point;
@@ -85,4 +93,7 @@ export type ThresholdInterval = {
     max: number;
     min: number;
 };
+export declare const EyeInstructionCodeValues: {
+    readonly EYE_NOT_PRESENT: "eye_not_present";
+};
 export {};

package/ui-common/src/types/events/common.d.ts

@@ -44,6 +44,11 @@ export type InstructionChangeEvent<T> = {
         isEscalated: boolean;
     };
 } & Event;
+export type PhaseChangedEvent<T> = {
+    detail?: {
+        phaseName: T;
+    };
+} & Event;
 export type InstructionEscalatedEvent<T> = {
     detail?: {
         instructionCode: T;
@@ -72,3 +77,39 @@ export type DetectionEvent<TDetectedObject, TInstructionCode extends string = st
         image: HTMLCanvasElement;
     };
 } & Event;
+type DetectionDetails<TDetectedObject, TInstructionCode> = {
+    avgFps: number;
+    detectionTime: number;
+    fps: number;
+    processedImage: ProcessedImage<TDetectedObject, TInstructionCode>;
+    resolution: Resolution;
+};
+type ProcessedImage<TDetection, TInstructionCode> = {
+    detection: TDetection;
+    instructionCode: TInstructionCode;
+    invalidValidators: TInstructionCode[];
+    isEscalated: boolean;
+    isInCandidateSelection: boolean;
+};
+export type DetectionChangedEvent<TDetectedObject, TInstructionCode> = {
+    detail?: {
+        detectionDetails: DetectionDetails<TDetectedObject, TInstructionCode>;
+        image: HTMLCanvasElement;
+    };
+} & Event;
+export type CommonCustomEventKeys = {
+    CAMERA_PROPS_CHANGED: string;
+    CHALLENGE_VALUE_CHANGED: string;
+    CONTROL: string;
+    DETECTION_CHANGED: string;
+    INSTRUCTION_CHANGED: string;
+    INSTRUCTION_ESCALATED: string;
+    PHASE_CHANGED: string;
+    STATE_CHANGED: string;
+    VIDEO_ELEMENT_SIZE: string;
+};
+type DashCase<T extends string> = T extends `${infer A}_${infer B}` ? `${Lowercase<A>}-${DashCase<B>}` : Lowercase<T>;
+export type CommonCustomEvent<TPrefix extends string, TKeys extends CommonCustomEventKeys = CommonCustomEventKeys> = {
+    [K in keyof TKeys]: `${TPrefix}:${DashCase<K & string>}`;
+};
+export {};

package/ui-common/src/types/events/index.d.ts

@@ -6,3 +6,4 @@ export * from './liveness';
 export * from './smile';
 export * from './palm';
 export * from './eye-gaze';
+export * from './multi-range';

package/ui-common/src/types/events/multi-range.d.ts

@@ -0,0 +1,16 @@
+import type { ObjectValues } from '../common';
+import type { InstructionChangeEvent } from './common';
+import type { MultiRangeInstructionCode } from '../multi-range';
+export declare const MultiRangeCustomEvent: {
+    readonly DETECTION_CHANGED: "multi-range-auto-capture:detection-changed";
+    readonly CAMERA_PROPS_CHANGED: "multi-range-auto-capture:camera-props-changed";
+    readonly CONTROL: "multi-range-auto-capture:control";
+    readonly PHASE_CHANGED: "multi-range-auto-capture:phase-changed";
+    readonly INSTRUCTION_CHANGED: "multi-range-auto-capture:instruction-changed";
+    readonly INSTRUCTION_ESCALATED: "multi-range-auto-capture:instruction-escalated";
+    readonly VIDEO_ELEMENT_SIZE: "multi-range-auto-capture:video-element-size";
+    readonly CHALLENGE_VALUE_CHANGED: "multi-range-auto-capture:challenge-value-changed";
+    readonly STATE_CHANGED: "multi-range-auto-capture:state-changed";
+};
+export type MultiRangeCustomEventValues = ObjectValues<typeof MultiRangeCustomEvent>;
+export type MultiRangeInstructionChangeEvent = InstructionChangeEvent<MultiRangeInstructionCode>;

package/ui-common/src/types/eye-gaze.d.ts

@@ -28,6 +28,7 @@ export declare const EyeGazeStateValues: {
     readonly ERROR: "ERROR";
     readonly WAITING: "WAITING";
     readonly RUNNING: "RUNNING";
+    readonly COMPLETE: "COMPLETE";
 };
 export type EyeGazeState = ObjectValues<typeof EyeGazeStateValues>;
 export declare const Corner: {

package/ui-common/src/types/index.d.ts

@@ -6,3 +6,4 @@ export * from './magnifeye';
 export * from './smile';
 export * from './palm';
 export * from './eye-gaze';
+export * from './multi-range';

package/ui-common/src/types/magnifeye.d.ts

@@ -28,5 +28,6 @@ export declare const MagnifEyeStateValues: {
     readonly ERROR: "ERROR";
     readonly WAITING: "WAITING";
     readonly RUNNING: "RUNNING";
+    readonly COMPLETE: "COMPLETE";
 };
 export type MagnifEyeState = ObjectValues<typeof MagnifEyeStateValues>;

package/ui-common/src/types/multi-range.d.ts

@@ -0,0 +1,37 @@
+import type { ObjectValues } from './common';
+export declare const MultiRangeInstructionCodeValues: {
+    readonly CANDIDATE_SELECTION: "candidate_selection";
+    readonly FACE_TOO_CLOSE: "face_too_close";
+    readonly FACE_TOO_FAR: "face_too_far";
+    readonly FACE_CENTERING: "face_centering";
+    readonly FACE_NOT_PRESENT: "face_not_present";
+    readonly SHARPNESS_TOO_LOW: "sharpness_too_low";
+    readonly BRIGHTNESS_TOO_LOW: "brightness_too_low";
+    readonly BRIGHTNESS_TOO_HIGH: "brightness_too_high";
+    readonly DEVICE_PITCHED: "device_pitched";
+    readonly LEFT_EYE_NOT_PRESENT: "left_eye_not_present";
+    readonly RIGHT_EYE_NOT_PRESENT: "right_eye_not_present";
+};
+export type MultiRangeInstructionCode = ObjectValues<typeof MultiRangeInstructionCodeValues>;
+export declare const MultiRangeCheckToInstructionCodeMap: {
+    isPresent: "face_not_present";
+    isNotPitched: "device_pitched";
+    isNotSmall: "face_too_far";
+    isNotLarge: "face_too_close";
+    isNotOutOfBounds: "face_centering";
+    isNotDim: "brightness_too_low";
+    isNotBright: "brightness_too_high";
+    isSharp: "sharpness_too_low";
+    isLeftEyePresent: "left_eye_not_present";
+    isRightEyePresent: "right_eye_not_present";
+};
+export type MultiRangeEscalatedInstructionCodes = typeof MultiRangeInstructionCodeValues.FACE_TOO_CLOSE | typeof MultiRangeInstructionCodeValues.FACE_TOO_FAR;
+export declare const MultiRangeLivenessChallengeItem: {
+    readonly ZERO: "ZERO";
+    readonly ONE: "ONE";
+    readonly TWO: "TWO";
+    readonly THREE: "THREE";
+    readonly FOUR: "FOUR";
+    readonly FIVE: "FIVE";
+};
+export type MultiRangeLivenessChallengeItemValues = ObjectValues<typeof MultiRangeLivenessChallengeItem>;

package/ui-common/src/types/palm.d.ts

@@ -36,7 +36,7 @@ export type PalmImageParameters = ImageParameters;
 export type PalmQualityAttributes = {
     handOrientation: ObjectValues<typeof PalmHandOrientation>;
     handPosition: ObjectValues<typeof PalmHandPosition>;
-    quality: number;
+    templateExtractionQuality: number;
 };
 export type DetectedPalm = PalmQualityAttributes & PalmImageParameters & DetectedPalmCorners & {
     confidence: number;

package/ui-common/src/types/smile.d.ts

@@ -31,6 +31,7 @@ export declare const SmileStateValues: {
     readonly ERROR: "ERROR";
     readonly WAITING: "WAITING";
     readonly RUNNING: "RUNNING";
+    readonly COMPLETE: "COMPLETE";
 };
 export type SmileState = ObjectValues<typeof SmileStateValues>;
 export type SmileEscalatedInstructionCodes = typeof SmileInstructionCodeValues.SMILE | typeof SmileInstructionCodeValues.KEEP_NEUTRAL_EXPRESSION;

package/tsconfig.production.json

@@ -1,22 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "jsx": "react-jsx",
-    "jsxImportSource": "preact",
-    "declaration": true,
-    "declarationMap": false,
-    "emitDeclarationOnly": false,
-    "skipLibCheck": true,
-    "strict": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true,
-    "allowSyntheticDefaultImports": true,
-    "baseUrl": ".",
-    "outDir": "dist",
-    "rootDir": "."
-  },
-  "include": ["src", "ui", "ui/src", "types"]
-}