@ahmed_hani/dot-document-auto-capture 7.7.0 → 8.0.0

package/common/src/types/configuration.d.ts

@@ -0,0 +1,34 @@
+import type { CallbackImage, ObjectValues } from '../../../ui-common/src/types/common';
+export declare const CameraFacingMode: {
+    readonly FRONT: "user";
+    readonly BACK: "environment";
+};
+export type CameraFacingModeValues = ObjectValues<typeof CameraFacingMode>;
+export declare const CaptureMode: {
+    readonly AUTO_CAPTURE: "AUTO_CAPTURE";
+    readonly WAIT_FOR_REQUEST: "WAIT_FOR_REQUEST";
+};
+export type CaptureModeValues = ObjectValues<typeof CaptureMode>;
+export type CameraConfiguration = {
+    facingMode?: CameraFacingModeValues;
+    isVideoCaptureEnabled?: boolean;
+};
+export type CommonConfiguration = {
+    assetsDirectoryPath?: string;
+    captureMode?: CaptureModeValues;
+    sessionToken?: string;
+    styleTarget?: HTMLElement;
+    transactionCountingToken?: string;
+};
+export type CallbackConfiguration<TDetectedObject> = {
+    onComplete: (imageData: CallbackImage<TDetectedObject>, content: Uint8Array) => void;
+    onError: (e: Error) => void;
+};
+export type AutoCaptureConfiguration = {
+    candidateSelectionDurationMillis?: number;
+};
+export type BaseConfiguration<TDetectedObject, TQualityAttributeThresholds> = CommonConfiguration & CallbackConfiguration<TDetectedObject> & {
+    autoCapture?: AutoCaptureConfiguration;
+    camera?: CameraConfiguration;
+    qualityAttributeThresholds?: TQualityAttributeThresholds;
+};

package/common/src/types/document.d.ts

@@ -1,4 +1,6 @@
-import type { BaseCameraProps, CustomElement, DetectedDocument, Resolution } from '../../../ui-common/src/types';
+import type { BaseConfiguration } from './configuration';
+import type { CallbackImage, CustomElement, MaxInterval, MinInterval, MinOrMaxInterval, Resolution } from '../../../ui-common/src/types';
+import type { DetectedDocument } from '../../../ui-common/src/types/modality/detection/document';
 export * from '../../../ui-common/src/types/common';
 export * from '../../../ui-common/src/types/document';
 export * from '../../../ui-common/src/error';
@@ -9,35 +11,33 @@ declare global {
     namespace preact.JSX {
         interface IntrinsicElements {
             'x-dot-document-auto-capture': CustomElement<{
-                cameraOptions: DocumentCameraProps;
+                configuration: DocumentConfiguration;
             }>;
         }
     }
     namespace React.JSX {
         interface IntrinsicElements {
             'x-dot-document-auto-capture': CustomElement<{
-                cameraOptions: DocumentCameraProps;
+                configuration: DocumentConfiguration;
             }>;
         }
     }
 }
 export type HTMLDocumentCaptureElement = HTMLElement & {
-    cameraOptions: DocumentCameraProps;
+    configuration: DocumentConfiguration;
 };
 export type DocumentComponentData = {
     detection: DetectedDocument;
     imageResolution: Resolution;
 };
 export type DocumentThresholds = {
-    brightnessHighThreshold?: number;
-    brightnessLowThreshold?: number;
-    confidenceThreshold?: number;
-    hotspotsScoreThreshold?: number;
-    outOfBoundsThreshold?: number;
-    sharpnessThreshold?: number;
-    sizeSmallThreshold?: number;
+    brightness?: MinOrMaxInterval;
+    confidence?: MinInterval;
+    edgeDistanceToImageShorterSideRatio?: MinInterval;
+    hotspotsScore?: MaxInterval;
+    sharpness?: MinInterval;
+    size?: MinInterval;
 };
-export type DocumentCameraProps = BaseCameraProps<DetectedDocument> & {
-    thresholds?: DocumentThresholds;
-};
-export type DocumentCallback = DocumentCameraProps['onPhotoTaken'];
+export type DocumentConfiguration = BaseConfiguration<DetectedDocument, DocumentThresholds>;
+export type DocumentOnCompleteCallbackImage = CallbackImage<DetectedDocument>;
+export type DocumentOnCompleteCallback = DocumentConfiguration['onComplete'];

package/events.mjs

@@ -1,51 +1,44 @@
-const u = {};
-u.CONTINUE_DETECTION = "continue-detection", u.SWITCH_CAMERA = "switch-camera", u.TOGGLE_MIRROR = "toggle-mirror";
-const l = u, s = {};
-s.FIRST_FRAME = "first-frame", s.FIRST_VALID_FRAME = "first-valid-frame";
-const G = s, N = {};
-N.REQUEST_CAPTURE = "dot-custom-event:request-capture";
-const i = N;
-var R = ((t) => (t.CAMERA_PROPS_CHANGED = "document-auto-capture:camera-props-changed", t.CONTROL = "document-auto-capture:control", t.DETECTED_DOCUMENT_CHANGED = "document-auto-capture:detected-document-changed", t.DOCUMENT_DETECTION = "document-auto-capture:document-detection", t.INSTRUCTION_CHANGED = "document-auto-capture:instruction-changed", t.INSTRUCTION_ESCALATED = "document-auto-capture:instruction-escalated", t.STATE_CHANGED = "document-auto-capture:state-changed", t.VIDEO_ELEMENT_SIZE = "document-auto-capture:video-element-size", t))(R || {}), p = ((t) => (t.CAMERA_PROPS_CHANGED = "face-auto-capture:camera-props-changed", t.CONTROL = "face-auto-capture:control", t.DETECTED_FACE_CHANGED = "face-auto-capture:detected-face-changed", t.FACE_DETECTION = "face-auto-capture:face-detection", t.INSTRUCTION_CHANGED = "face-auto-capture:instruction-changed", t.STATE_CHANGED = "face-auto-capture:state-changed", t.VIDEO_ELEMENT_SIZE = "face-auto-capture:video-element-size", t))(p || {}), A = ((t) => (t.ANIMATION_END = "magnifeye-auto-capture:animation-end", t.CONTROL = "magnifeye-auto-capture:control", t.STATUS_CHANGED = "magnifeye-auto-capture:status-changed", t))(A || {}), S = ((t) => (t.CONTROL = "smile-auto-capture:control", t.INSTRUCTION_ESCALATED = "smile:instruction-escalated", t.STATUS_CHANGED = "smile-auto-capture:status-changed", t))(S || {}), m = ((t) => (t.CAMERA_PROPS_CHANGED = "palm-capture:camera-props-changed", t.CONTROL = "palm-capture:control", t.DETECTED_PALM_CHANGED = "palm-capture:detected-palm-changed", t.INSTRUCTION_CHANGED = "palm-capture:instruction-changed", t.STATE_CHANGED = "palm-capture:state-changed", t.VIDEO_ELEMENT_SIZE = "palm-capture:video-element-size", t))(m || {}), d = ((t) => (t.CONTROL = "eye-gaze-auto-capture:control", t.STATUS_CHANGED = "eye-gaze-auto-capture:status-changed", t))(d || {});
-const O = (t, c) => {
+const _ = {};
+_.CONTINUE_DETECTION = "continue-detection", _.SWITCH_CAMERA = "switch-camera", _.TOGGLE_MIRROR = "toggle-mirror";
+const S = _, T = {};
+T.FIRST_FRAME = "first-frame", T.FIRST_VALID_FRAME = "first-valid-frame";
+const R = T, u = {};
+u.REQUEST_CAPTURE = "dot-custom-event:request-capture";
+const N = u, a = (t, s) => {
   const n = {};
-  n.detail = c, document.dispatchEvent(new CustomEvent(t, n));
-}, g = (t, c) => {
+  n.detail = s, document.dispatchEvent(new CustomEvent(t, n));
+}, I = (t, s) => {
   const n = {};
-  n.instruction = c, O(t, n);
+  n.instruction = s, a(t, n);
 };
-function h(t) {
-  const c = {};
-  c.instruction = t;
-  const n = c;
-  O(i.REQUEST_CAPTURE, n);
+function m(t) {
+  const s = {};
+  s.instruction = t;
+  const n = s;
+  a(N.REQUEST_CAPTURE, n);
 }
-const T = {};
-T.FRONT = "user", T.REAR = "environment";
-const H = T, r = {};
-r.AUTO_CAPTURE = "AUTO_CAPTURE", r.WAIT_FOR_REQUEST = "WAIT_FOR_REQUEST";
-const U = r, E = {};
-E.LOADING = "LOADING", E.ERROR = "ERROR", E.WAITING = "WAITING", E.RUNNING = "RUNNING", E.COMPLETE = "COMPLETE";
-const I = E, C = { ...I };
-C.DONE = "DONE";
-const v = C, _ = {};
-_.EYE_NOT_PRESENT = "eye_not_present";
-const M = _, e = {};
+const E = {};
+E.LOADING = "loading", E.ERROR = "error", E.WAITING = "waiting", E.RUNNING = "running", E.COMPLETE = "complete";
+const i = E, r = { ...i };
+r.DONE = "done";
+const p = r, O = {};
+O.EYE_NOT_PRESENT = "eye_not_present";
+const A = O, e = {};
 e.CANDIDATE_SELECTION = "candidate_selection", e.DOCUMENT_CENTERING = "document_centering", e.DOCUMENT_NOT_PRESENT = "document_not_present", e.DOCUMENT_TOO_FAR = "document_too_far", e.SHARPNESS_TOO_LOW = "sharpness_too_low", e.BRIGHTNESS_TOO_LOW = "brightness_too_low", e.BRIGHTNESS_TOO_HIGH = "brightness_too_high", e.HOTSPOTS_PRESENT = "hotspots_present";
-const a = e, o = {};
-o.isPresent = a.DOCUMENT_NOT_PRESENT, o.isNotSmall = a.DOCUMENT_TOO_FAR, o.isNotOutOfBounds = a.DOCUMENT_CENTERING, o.isSharp = a.SHARPNESS_TOO_LOW, o.isNotDim = a.BRIGHTNESS_TOO_LOW, o.isNotBright = a.BRIGHTNESS_TOO_HIGH, o.noHotspots = a.HOTSPOTS_PRESENT;
-const L = o;
+const c = e, o = {};
+o.isPresent = c.DOCUMENT_NOT_PRESENT, o.isNotSmall = c.DOCUMENT_TOO_FAR, o.isNotOutOfBounds = c.DOCUMENT_CENTERING, o.isSharp = c.SHARPNESS_TOO_LOW, o.isNotDim = c.BRIGHTNESS_TOO_LOW, o.isNotBright = c.BRIGHTNESS_TOO_HIGH, o.noHotspots = c.HOTSPOTS_PRESENT;
+const D = o;
+var C = ((t) => (t.CAMERA_PROPS_CHANGED = "document-auto-capture:camera-props-changed", t.CONTROL = "document-auto-capture:control", t.DETECTION_CHANGED = "document-auto-capture:detection-changed", t.INSTRUCTION_CHANGED = "document-auto-capture:instruction-changed", t.INSTRUCTION_ESCALATED = "document-auto-capture:instruction-escalated", t.STATE_CHANGED = "document-auto-capture:state-changed", t.VIDEO_ELEMENT_SIZE = "document-auto-capture:video-element-size", t))(C || {});
 export {
-  I as AppStateValues,
-  U as CaptureMode,
-  i as ComponentCustomEvent,
-  l as ControlEventInstruction,
-  L as DocumentCheckToInstructionCodeMap,
-  R as DocumentCustomEvent,
-  a as DocumentInstructionCodeValues,
-  M as EyeInstructionCodeValues,
-  H as FacingMode,
-  v as LivenessStateValues,
-  G as RequestCaptureInstruction,
-  h as dispatchCaptureEvent,
-  g as dispatchControlEvent
+  i as AppStateValues,
+  N as ComponentCustomEvent,
+  S as ControlEventInstruction,
+  D as DocumentCheckToInstructionCodeMap,
+  C as DocumentCustomEvent,
+  c as DocumentInstructionCodeValues,
+  A as EyeInstructionCodeValues,
+  p as LivenessStateValues,
+  R as RequestCaptureInstruction,
+  m as dispatchCaptureEvent,
+  I as dispatchControlEvent
 };

package/events.umd.js

@@ -1 +1 @@
-(function(e,o){typeof exports=="object"&&typeof module<"u"?o(exports):typeof define=="function"&&define.amd?define(["exports"],o):(e=typeof globalThis<"u"?globalThis:e||self,o(e["@innovatrics/dot-events-auto-capture"]={}))})(this,function(e){"use strict";const o={};o.CONTINUE_DETECTION="continue-detection",o.SWITCH_CAMERA="switch-camera",o.TOGGLE_MIRROR="toggle-mirror";const R=o,T={};T.FIRST_FRAME="first-frame",T.FIRST_VALID_FRAME="first-valid-frame";const A=T,C={};C.REQUEST_CAPTURE="dot-custom-event:request-capture";const N=C;var O=(t=>(t.CAMERA_PROPS_CHANGED="document-auto-capture:camera-props-changed",t.CONTROL="document-auto-capture:control",t.DETECTED_DOCUMENT_CHANGED="document-auto-capture:detected-document-changed",t.DOCUMENT_DETECTION="document-auto-capture:document-detection",t.INSTRUCTION_CHANGED="document-auto-capture:instruction-changed",t.INSTRUCTION_ESCALATED="document-auto-capture:instruction-escalated",t.STATE_CHANGED="document-auto-capture:state-changed",t.VIDEO_ELEMENT_SIZE="document-auto-capture:video-element-size",t))(O||{}),S=(t=>(t.CAMERA_PROPS_CHANGED="face-auto-capture:camera-props-changed",t.CONTROL="face-auto-capture:control",t.DETECTED_FACE_CHANGED="face-auto-capture:detected-face-changed",t.FACE_DETECTION="face-auto-capture:face-detection",t.INSTRUCTION_CHANGED="face-auto-capture:instruction-changed",t.STATE_CHANGED="face-auto-capture:state-changed",t.VIDEO_ELEMENT_SIZE="face-auto-capture:video-element-size",t))(S||{}),I=(t=>(t.ANIMATION_END="magnifeye-auto-capture:animation-end",t.CONTROL="magnifeye-auto-capture:control",t.STATUS_CHANGED="magnifeye-auto-capture:status-changed",t))(I||{}),D=(t=>(t.CONTROL="smile-auto-capture:control",t.INSTRUCTION_ESCALATED="smile:instruction-escalated",t.STATUS_CHANGED="smile-auto-capture:status-changed",t))(D||{}),l=(t=>(t.CAMERA_PROPS_CHANGED="palm-capture:camera-props-changed",t.CONTROL="palm-capture:control",t.DETECTED_PALM_CHANGED="palm-capture:detected-palm-changed",t.INSTRUCTION_CHANGED="palm-capture:instruction-changed",t.STATE_CHANGED="palm-capture:state-changed",t.VIDEO_ELEMENT_SIZE="palm-capture:video-element-size",t))(l||{}),h=(t=>(t.CONTROL="eye-gaze-auto-capture:control",t.STATUS_CHANGED="eye-gaze-auto-capture:status-changed",t))(h||{});const _=(t,s)=>{const u={};u.detail=s,document.dispatchEvent(new CustomEvent(t,u))},v=(t,s)=>{const u={};u.instruction=s,_(t,u)};function g(t){const s={};s.instruction=t;const u=s;_(N.REQUEST_CAPTURE,u)}const r={};r.FRONT="user",r.REAR="environment";const G=r,i={};i.AUTO_CAPTURE="AUTO_CAPTURE",i.WAIT_FOR_REQUEST="WAIT_FOR_REQUEST";const M=i,E={};E.LOADING="LOADING",E.ERROR="ERROR",E.WAITING="WAITING",E.RUNNING="RUNNING",E.COMPLETE="COMPLETE";const d=E,m={...d};m.DONE="DONE";const H=m,p={};p.EYE_NOT_PRESENT="eye_not_present";const U=p,n={};n.CANDIDATE_SELECTION="candidate_selection",n.DOCUMENT_CENTERING="document_centering",n.DOCUMENT_NOT_PRESENT="document_not_present",n.DOCUMENT_TOO_FAR="document_too_far",n.SHARPNESS_TOO_LOW="sharpness_too_low",n.BRIGHTNESS_TOO_LOW="brightness_too_low",n.BRIGHTNESS_TOO_HIGH="brightness_too_high",n.HOTSPOTS_PRESENT="hotspots_present";const a=n,c={};c.isPresent=a.DOCUMENT_NOT_PRESENT,c.isNotSmall=a.DOCUMENT_TOO_FAR,c.isNotOutOfBounds=a.DOCUMENT_CENTERING,c.isSharp=a.SHARPNESS_TOO_LOW,c.isNotDim=a.BRIGHTNESS_TOO_LOW,c.isNotBright=a.BRIGHTNESS_TOO_HIGH,c.noHotspots=a.HOTSPOTS_PRESENT;const f=c;e.AppStateValues=d,e.CaptureMode=M,e.ComponentCustomEvent=N,e.ControlEventInstruction=R,e.DocumentCheckToInstructionCodeMap=f,e.DocumentCustomEvent=O,e.DocumentInstructionCodeValues=a,e.EyeInstructionCodeValues=U,e.FacingMode=G,e.LivenessStateValues=H,e.RequestCaptureInstruction=A,e.dispatchCaptureEvent=g,e.dispatchControlEvent=v,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})});
+(function(t,o){typeof exports=="object"&&typeof module<"u"?o(exports):typeof define=="function"&&define.amd?define(["exports"],o):(t=typeof globalThis<"u"?globalThis:t||self,o(t["@innovatrics/dot-events-auto-capture"]={}))})(this,function(t){"use strict";const o={};o.CONTINUE_DETECTION="continue-detection",o.SWITCH_CAMERA="switch-camera",o.TOGGLE_MIRROR="toggle-mirror";const S=o,a={};a.FIRST_FRAME="first-frame",a.FIRST_VALID_FRAME="first-valid-frame";const m=a,_={};_.REQUEST_CAPTURE="dot-custom-event:request-capture";const T=_,d=(e,i)=>{const u={};u.detail=i,document.dispatchEvent(new CustomEvent(e,u))},I=(e,i)=>{const u={};u.instruction=i,d(e,u)};function R(e){const i={};i.instruction=e;const u=i;d(T.REQUEST_CAPTURE,u)}const E={};E.LOADING="loading",E.ERROR="error",E.WAITING="waiting",E.RUNNING="running",E.COMPLETE="complete";const r=E,O={...r};O.DONE="done";const p=O,C={};C.EYE_NOT_PRESENT="eye_not_present";const l=C,n={};n.CANDIDATE_SELECTION="candidate_selection",n.DOCUMENT_CENTERING="document_centering",n.DOCUMENT_NOT_PRESENT="document_not_present",n.DOCUMENT_TOO_FAR="document_too_far",n.SHARPNESS_TOO_LOW="sharpness_too_low",n.BRIGHTNESS_TOO_LOW="brightness_too_low",n.BRIGHTNESS_TOO_HIGH="brightness_too_high",n.HOTSPOTS_PRESENT="hotspots_present";const c=n,s={};s.isPresent=c.DOCUMENT_NOT_PRESENT,s.isNotSmall=c.DOCUMENT_TOO_FAR,s.isNotOutOfBounds=c.DOCUMENT_CENTERING,s.isSharp=c.SHARPNESS_TOO_LOW,s.isNotDim=c.BRIGHTNESS_TOO_LOW,s.isNotBright=c.BRIGHTNESS_TOO_HIGH,s.noHotspots=c.HOTSPOTS_PRESENT;const A=s;var N=(e=>(e.CAMERA_PROPS_CHANGED="document-auto-capture:camera-props-changed",e.CONTROL="document-auto-capture:control",e.DETECTION_CHANGED="document-auto-capture:detection-changed",e.INSTRUCTION_CHANGED="document-auto-capture:instruction-changed",e.INSTRUCTION_ESCALATED="document-auto-capture:instruction-escalated",e.STATE_CHANGED="document-auto-capture:state-changed",e.VIDEO_ELEMENT_SIZE="document-auto-capture:video-element-size",e))(N||{});t.AppStateValues=r,t.ComponentCustomEvent=T,t.ControlEventInstruction=S,t.DocumentCheckToInstructionCodeMap=A,t.DocumentCustomEvent=N,t.DocumentInstructionCodeValues=c,t.EyeInstructionCodeValues=l,t.LivenessStateValues=p,t.RequestCaptureInstruction=m,t.dispatchCaptureEvent=R,t.dispatchControlEvent=I,Object.defineProperty(t,Symbol.toStringTag,{value:"Module"})});