@regulaforensics/vp-frontend-face-components 8.4.2361-rc → 8.4.2363-nightly

package/dist/index.d.ts

@@ -49,6 +49,37 @@ export declare interface DetailEvent<A, R> {
     data: CustomEventDataType<R> | null;
 }
 
+declare type EnrollConfig = {
+    person: EnrollPersonConfig;
+    search?: EnrollSearchConfig;
+};
+
+declare type EnrollPersonConfig = {
+    name?: string;
+    externalId?: string;
+    metadata?: Record<string, any>;
+    groups?: string[];
+    ttl?: number;
+    expireAt?: number;
+};
+
+declare type EnrollResult = {
+    enrolled: boolean;
+    person: PersonResult | null;
+    search: SearchResult | null;
+};
+
+declare type EnrollSearchConfig = {
+    groupIds?: string[];
+    filter?: {
+        op: string;
+        field: string;
+        value: string[];
+    };
+    threshold: number;
+    limit: number;
+};
+
 export declare const ErrorTypes: {
     readonly WASM_ERROR: "WASM_ERROR";
     readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
@@ -119,6 +150,35 @@ export declare class FaceDetectionWebComponent extends HTMLElement {
 
 export declare type FaceDictionaries = Partial<Record<Locales, FaceTranslations>>;
 
+export declare type FaceEnrollDetailType = DetailEvent<FaceEventActions, FaceEnrollResponseType>;
+
+/** web component enroll response */
+export declare type FaceEnrollResponseType = FaceLivenessResponseType & {
+    enrollResult: EnrollResult;
+};
+
+export declare interface FaceEnrollSettings extends FaceLivenessSettings {
+    enroll?: EnrollConfig;
+}
+
+export declare class FaceEnrollWebComponent extends HTMLElement {
+    private _root;
+    private _mounted;
+    private _translations;
+    constructor();
+    static get observedAttributes(): Array<string>;
+    private onEvent;
+    attributeChangedCallback(name: string): void;
+    connectedCallback(): void;
+    get version(): string;
+    set translations(dictionary: FaceDictionaries | null);
+    get translations(): FaceDictionaries | null;
+    set settings(params: FaceEnrollSettings);
+    get settings(): FaceEnrollSettings;
+    private render;
+    disconnectedCallback(): void;
+}
+
 export declare const FaceEventActions: {
     readonly ELEMENT_VISIBLE: "ELEMENT_VISIBLE";
     readonly PRESS_START_BUTTON: "PRESS_START_BUTTON";
@@ -134,7 +194,7 @@ export declare type FaceEventActions = (typeof FaceEventActions)[keyof typeof Fa
 
 export declare type FaceLivenessDetailType = DetailEvent<FaceEventActions, FaceLivenessResponseType>;
 
-/** web component response */
+/** web component liveness response */
 export declare type FaceLivenessResponseType = {
     images: Array<string>;
     code: number;
@@ -196,6 +256,35 @@ export declare class FaceLivenessWebComponent extends HTMLElement {
 
 export declare type FaceTranslations = Partial<Record<Labels, string>>;
 
+export declare type FaceVerifyDetailType = DetailEvent<FaceEventActions, FaceVerifyResponseType>;
+
+/** web component verify response */
+export declare type FaceVerifyResponseType = FaceLivenessResponseType & {
+    verifyResult: VerifyResult;
+};
+
+export declare interface FaceVerifySettings extends FaceLivenessSettings {
+    verify?: VerifyConfig;
+}
+
+export declare class FaceVerifyWebComponent extends HTMLElement {
+    private _root;
+    private _mounted;
+    private _translations;
+    constructor();
+    static get observedAttributes(): Array<string>;
+    private onEvent;
+    attributeChangedCallback(name: string): void;
+    connectedCallback(): void;
+    get version(): string;
+    set translations(dictionary: FaceDictionaries | null);
+    get translations(): FaceDictionaries | null;
+    set settings(params: FaceVerifySettings);
+    get settings(): FaceVerifySettings;
+    private render;
+    disconnectedCallback(): void;
+}
+
 export declare class FullScreenContainer extends HTMLElement {
     private _root;
     constructor();
@@ -211,11 +300,19 @@ export declare interface IFaceDetection {
     'finish-screen'?: boolean;
 }
 
+export declare interface IFaceEnroll extends IFaceLiveness {
+    enroll?: EnrollConfig;
+}
+
 export declare interface IFaceLiveness extends IFaceDetection {
     url?: string;
     'device-orientation'?: boolean;
 }
 
+export declare interface IFaceVerify extends IFaceLiveness {
+    verify?: VerifyConfig;
+}
+
 declare type Labels = 'showOnlyOneFace' | 'preparingCamera' | 'allowAccessCamera' | 'somethingWentWrong' | 'incorrectCameraId' | 'checkCameraId' | 'preparingService' | 'allowAccessToCamera' | 'error' | 'versionNotSupported' | 'updateBrowser' | 'licenseError' | 'licenseExpired' | 'onlyPortraitOrientation' | 'turnDeviceIntoPortrait' | 'tryAgain' | 'noCameraAvailable' | 'checkCameraConnection' | 'noMaskSunglassesHeaddress' | 'ambientLighting' | 'lookStraight' | 'fitYourFace' | 'moveCloser' | 'moveAway' | 'holdSteady' | 'takeAPhoto' | 'turnHead' | 'removeOcclusion' | 'turnHeadUp' | 'turnHeadDown' | 'turnHeadLeft' | 'turnHeadRight' | 'blinkYourEyes' | 'processing' | 'retryButtonText' | 'followGuidelinesText' | 'letsTryAgainTitle' | 'noCameraPermission' | 'goButton' | 'centerFaceTurnHead' | 'centerFace' | 'selfieTime' | 'errorCode' | 'illumination' | 'cameraLevel' | 'noAccessories' | 'getReady' | 'httpNotSupported' | 'webServerNotCompatible' | 'processCompleted' | 'notSufficientQuality' | 'cleanCameraLens' | 'addMoreLight' | 'wipeOutOcclusions' | 'changeBackground' | 'tooMuchTurn' | 'makeFaceFullyVisible' | 'done' | 'close';
 
 declare type LanguageCodes = 'ru' | 'en' | 'de' | 'pl' | 'it' | 'hu' | 'zh' | 'sk' | 'uk' | 'fr' | 'es' | 'pt' | 'ar' | 'nl' | 'id' | 'vi' | 'ko' | 'ms' | 'ro' | 'el' | 'tr' | 'ja' | 'cs' | 'th' | 'hi' | 'bn' | 'he' | 'fi' | 'sv' | 'da' | 'hr' | 'no' | 'uz' | 'ku' | 'tg' | 'ky' | 'hy';
@@ -226,6 +323,17 @@ declare type LocalCodes = 'ru-RU' | 'en-US' | 'de-DE' | 'pl-PL' | 'it-IT' | 'hu-
 
 export declare type Locales = Languages | string;
 
+declare type PersonResult = {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string | null;
+    externalId: string | null;
+    metadata: Record<string, any>;
+    groups: string[];
+    expireAt: string | null;
+};
+
 export declare const RecordingProcess: {
     readonly ASYNCHRONOUS_UPLOAD: 0;
     readonly SYNCHRONOUS_UPLOAD: 1;
@@ -242,6 +350,63 @@ export declare const ResponseCode: {
 
 export declare type ResponseCode = (typeof ResponseCode)[keyof typeof ResponseCode];
 
+declare type SearchPerson = {
+    name: string;
+    externalId: string;
+    metadata: Record<string, any>;
+    groups: string[];
+    expireAt: string;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    detection: {
+        code: number;
+        crop: string;
+        detectorType: number;
+        hash: string;
+        idx: number;
+        image: string;
+        landmarks: number[];
+        landmarksType: number;
+        msg: string;
+        roi: number[];
+        versionSDK: string;
+    };
+    images: Array<{
+        id: string;
+        content: string;
+        contentType: string;
+        createdAt: string;
+        updatedAt: string;
+        path: string;
+        url: string;
+        metadata: Record<string, any>;
+        similarity: number;
+        distance: number;
+    }>;
+};
+
+declare type SearchResult = {
+    persons: SearchPerson[];
+};
+
+declare type VerifyConfig = {
+    personId: string;
+    threshold?: number;
+} | {
+    externalId: string;
+    threshold?: number;
+};
+
+declare type VerifyResult = {
+    verified: boolean;
+    person: PersonResult | null;
+    match: {
+        verified: boolean;
+        similarity: number;
+    } | null;
+};
+
 export { }
 
 
@@ -250,5 +415,7 @@ declare global {
     interface HTMLElementEventMap {
         'face-liveness': CustomEvent<FaceLivenessDetailType>;
         'face-capture': CustomEvent<FaceCaptureDetailType>;
+        'face-enroll': CustomEvent<FaceEnrollDetailType>;
+        'face-verify': CustomEvent<FaceVerifyDetailType>;
     }
 }