@regulaforensics/vp-frontend-face-components 6.3.1413-nightly → 6.3.1415-rc

package/{dist → lib}/index.d.ts

@@ -1,223 +1,140 @@
-export declare type ComputedCss = {
-    fontFamily?: string;
-    fontSize?: string;
-    onboardingScreenStartButtonBackground?: string;
-    onboardingScreenStartButtonBackgroundHover?: string;
-    onboardingScreenStartButtonTitle?: string;
-    onboardingScreenStartButtonTitleHover?: string;
-    onboardingScreenIllumination?: string;
-    onboardingScreenAccessories?: string;
-    onboardingScreenCameraLevel?: string;
-    cameraScreenSectorTarget?: string;
-    cameraScreenSectorActive?: string;
-    cameraScreenStrokeNormal?: string;
-    retryScreenRetryButtonBackground?: string;
-    retryScreenRetryButtonBackgroundHover?: string;
-    retryScreenRetryButtonTitle?: string;
-    retryScreenRetryButtonTitleHover?: string;
-    processingScreenProgress?: string;
-    cameraScreenFrontHintLabelBackground?: string;
-    cameraScreenFrontHintLabelText?: string;
-    successScreenImage?: string;
-    retryScreenEnvironmentImage?: string;
-    retryScreenPersonImage?: string;
-};
-
-export declare type CustomEventDataType<R> = {
-    status: ResponseCode;
-    reason?: ErrorTypes;
-    response?: R;
-};
-
-declare type DebugOptions = {
-    faceDebugOutputCanvasFromWasm?: boolean;
-    extendedWasmResponse?: boolean;
-    deviceOrientationPlate?: boolean;
-    videoRecordingSaveVideo?: boolean;
-};
-
-export declare interface DetailEvent<A, R> {
-    action: A;
-    data: CustomEventDataType<R> | null;
-}
-
-export declare type ErrorTypes = 'WASM_ERROR' | 'UNKNOWN_ERROR' | 'NOT_SUPPORTED' | 'CAMERA_UNKNOWN_ERROR' | 'CAMERA_PERMISSION_DENIED' | 'NO_CAMERA' | 'INCORRECT_CAMERA_ID' | 'CONNECTION_ERROR' | 'LANDSCAPE_MODE_RESTRICTED' | 'TIMEOUT_ERROR' | 'CHANGE_CAMERA' | 'DEVICE_ROTATE' | 'APP_INACTIVE' | 'HTTP_NOT_SUPPORTED';
-
-export declare type FaceCaptureDetailType = DetailEvent<FaceEventActions, FaceDetectionResponseType>;
-
-export declare type FaceDetectionResponseType = {
-    capture: Array<string>;
-};
-
-export declare interface FaceDetectionSettings {
-    url?: string;
-    debug?: DebugOptions;
-    locale?: Locales | string;
-    copyright?: boolean;
-    cameraId?: string;
-    changeCamera?: boolean;
-    closeDisabled?: boolean;
-    finishScreen?: boolean;
-    startScreen?: boolean;
-    customization?: ComputedCss;
-    nonce?: string;
-    rotationAngle?: number;
-    holdStillDuration?: number;
-    timeoutInterval?: number;
-    workerPath?: string;
-    detectOcclusion?: boolean;
-}
-
-export declare class FaceDetectionWebComponent extends HTMLElement {
-    private _root;
-    private _mounted;
-    private _translations;
-    constructor();
-    static get observedAttributes(): Array<string>;
-    private onEvent;
-    get version(): string;
-    set translations(dictionary: FaceDictionaries | null);
-    get translations(): FaceDictionaries | null;
-    set settings(params: FaceDetectionSettings);
-    get settings(): FaceDetectionSettings;
-    attributeChangedCallback(name: string): void;
-    connectedCallback(): void;
-    private render;
-    disconnectedCallback(): void;
-}
-
-export declare type FaceDictionaries = Partial<Record<Locales, FaceTranslations>>;
-
-export declare type FaceEventActions = 'ELEMENT_VISIBLE' | 'PRESS_START_BUTTON' | 'PRESS_RETRY_BUTTON' | 'CLOSE' | 'PROCESS_FINISHED' | 'SERVICE_INITIALIZED' | 'RETRY_COUNTER_EXCEEDED';
-
-export declare type FaceLivenessDetailType = DetailEvent<FaceEventActions, FaceLivenessResponseType>;
-
-export declare type FaceLivenessResponseType = {
-    images: Array<string>;
-    code: number;
-    metadata: Record<string, any>;
-    estimatedAge: number | null;
-    tag: string;
-    status: number;
-    transactionId: string;
-    type: number;
-};
-
-export declare interface FaceLivenessSettings extends Omit<FaceDetectionSettings, 'holdStillDuration' | 'timeoutInterval'> {
-    url?: string;
-    deviceOrientation?: boolean;
-    videoRecording?: boolean;
-    tag?: string;
-    headers?: Record<string, string>;
-    retryCount?: number;
-    metadata?: Record<string, any>;
-    recordingProcess?: RecordingProcess;
-    livenessType?: FaceLivenessType;
-}
-
-export declare enum FaceLivenessType {
-    ACTIVE = 0,
-    PASSIVE = 1
-}
-
-export declare class FaceLivenessWebComponent 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: FaceLivenessSettings);
-    get settings(): FaceLivenessSettings;
-    private render;
-    disconnectedCallback(): void;
-}
-
-export declare interface FaceTranslations {
-    showOnlyOneFace?: string;
-    preparingCamera?: string;
-    allowAccessCamera?: string;
-    somethingWentWrong?: string;
-    incorrectCameraId?: string;
-    checkCameraId?: string;
-    preparingService?: string;
-    allowAccessToCamera?: string;
-    error?: string;
-    versionNotSupported?: string;
-    updateBrowser?: string;
-    licenseError?: string;
-    licenseExpired?: string;
-    onlyPortraitOrientation?: string;
-    turnDeviceIntoPortrait?: string;
-    tryAgain?: string;
-    noCameraAvailable?: string;
-    checkCameraConnection?: string;
-    noMaskSunglassesHeaddress?: string;
-    ambientLighting?: string;
-    lookStraight?: string;
-    fitYourFace?: string;
-    moveCloser?: string;
-    moveAway?: string;
-    holdSteady?: string;
-    turnHead?: string;
-    processing?: string;
-    retryButtonText?: string;
-    followGuidelinesText?: string;
-    letsTryAgainTitle?: string;
-    noCameraPermission?: string;
-    goButton?: string;
-    centerFaceTurnHead?: string;
-    centerFace?: string;
-    selfieTime?: string;
-    errorCode?: string;
-    illumination?: string;
-    cameraLevel?: string;
-    noAccessories?: string;
-    getReady?: string;
-}
-
-export declare class FullScreenContainer extends HTMLElement {
-    private _root;
-    constructor();
-}
-
-export declare interface IFaceDetection {
-    locale?: Locales | string;
-    copyright?: boolean;
-    'camera-id'?: string;
-    'change-camera'?: boolean;
-    'start-screen'?: boolean;
-    'close-disabled'?: boolean;
-    'finish-screen'?: boolean;
-}
-
-export declare interface IFaceLiveness extends IFaceDetection {
-    url?: string;
-    'device-orientation'?: boolean;
-}
-
-export declare type Locales = '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' | string;
-
-export declare enum RecordingProcess {
-    ASYNCHRONOUS_UPLOAD = 0,
-    SYNCHRONOUS_UPLOAD = 1,
-    NOT_UPLOAD = 2
-}
-
-declare enum ResponseCode {
-    EMPTY = -1,
-    ERROR = 0,
-    OK = 1,
-    TIMEOUT = 2
-}
-
-export { }
+type Locales =
+    | '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'
+    | string;
 
+interface FaceTranslations {
+    showOnlyOneFace?: string;
+    preparingCamera?: string;
+    allowAccessCamera?: string;
+    somethingWentWrong?: string;
+    incorrectCameraId?: string;
+    checkCameraId?: string;
+    preparingService?: string;
+    allowAccessToCamera?: string;
+    error?: string;
+    versionNotSupported?: string;
+    updateBrowser?: string;
+    licenseError?: string;
+    licenseExpired?: string;
+    onlyPortraitOrientation?: string;
+    turnDeviceIntoPortrait?: string;
+    tryAgain?: string;
+    noCameraAvailable?: string;
+    checkCameraConnection?: string;
+    noMaskSunglassesHeaddress?: string;
+    ambientLighting?: string;
+    lookStraight?: string;
+    fitYourFace?: string;
+    moveCloser?: string;
+    moveAway?: string;
+    holdSteady?: string;
+    turnHead?: string;
+    processing?: string;
+    retryButtonText?: string;
+    followGuidelinesText?: string;
+    letsTryAgainTitle?: string;
+    noCameraPermission?: string;
+    goButton?: string;
+    centerFaceTurnHead?: string;
+    centerFace?: string;
+    selfieTime?: string;
+    errorCode?: string;
+    illumination?: string;
+    cameraLevel?: string;
+    noAccessories?: string;
+    getReady?: string;
+}
+
+type FaceDictionaries = Partial<Record<Locales, FaceTranslations>>;
+
+type ErrorTypes =
+    | 'WASM_ERROR'
+    | 'UNKNOWN_ERROR'
+    | 'NOT_SUPPORTED'
+    | 'CAMERA_UNKNOWN_ERROR'
+    | 'CAMERA_PERMISSION_DENIED'
+    | 'NO_CAMERA'
+    | 'INCORRECT_CAMERA_ID'
+    | 'CONNECTION_ERROR'
+    | 'LANDSCAPE_MODE_RESTRICTED'
+    | 'TIMEOUT_ERROR'
+    | 'CHANGE_CAMERA'
+    | 'DEVICE_ROTATE'
+    | 'APP_INACTIVE'
+    | 'HTTP_NOT_SUPPORTED';
+
+type FaceEventActions =
+    | 'ELEMENT_VISIBLE'
+    | 'PRESS_START_BUTTON'
+    | 'PRESS_RETRY_BUTTON'
+    | 'CLOSE'
+    | 'PROCESS_FINISHED'
+    | 'SERVICE_INITIALIZED'
+    | 'RETRY_COUNTER_EXCEEDED';
+
+declare enum ResponseCode {
+    EMPTY = -1,
+    ERROR = 0,
+    OK = 1,
+    TIMEOUT = 2,
+}
+
+type CustomEventDataType<R> = {
+    status: ResponseCode;
+    reason?: ErrorTypes;
+    response?: R;
+};
+
+interface DetailEvent<A, R> {
+    action: A;
+    data: CustomEventDataType<R> | null;
+}
+
+type FaceLivenessResponseType = {
+    images: Array<string>;
+    code: number;
+    metadata: Record<string, any>;
+    estimatedAge: number | null;
+    tag: string;
+    status: number;
+    transactionId: string;
+    type: number;
+};
+
+type FaceDetectionResponseType = {
+    capture: Array<string>;
+};
 
 declare global {
     interface HTMLElementEventMap {
@@ -225,3 +142,105 @@ declare global {
         'face-capture': CustomEvent<FaceCaptureDetailType>;
     }
 }
+
+export interface IFaceDetection {
+    locale?: Locales | string;
+    copyright?: boolean;
+    'camera-id'?: string;
+    'change-camera'?: boolean;
+    'start-screen'?: boolean;
+    debug?: boolean;
+    'close-disabled'?: boolean;
+    'finish-screen'?: boolean;
+}
+
+export interface IFaceLiveness extends IFaceDetection {
+    url?: string;
+    'device-orientation'?: boolean;
+}
+
+export type ComputedCss = {
+    fontFamily?: string;
+    fontSize?: string;
+    onboardingScreenStartButtonBackground?: string;
+    onboardingScreenStartButtonBackgroundHover?: string;
+    onboardingScreenStartButtonTitle?: string;
+    onboardingScreenStartButtonTitleHover?: string;
+    onboardingScreenIllumination?: string;
+    onboardingScreenAccessories?: string;
+    onboardingScreenCameraLevel?: string;
+    cameraScreenSectorTarget?: string;
+    cameraScreenSectorActive?: string;
+    cameraScreenStrokeNormal?: string;
+    retryScreenRetryButtonBackground?: string;
+    retryScreenRetryButtonBackgroundHover?: string;
+    retryScreenRetryButtonTitle?: string;
+    retryScreenRetryButtonTitleHover?: string;
+    processingScreenProgress?: string;
+    cameraScreenFrontHintLabelBackground?: string;
+    cameraScreenFrontHintLabelText?: string;
+    successScreenImage?: string;
+    retryScreenEnvironmentImage?: string;
+    retryScreenPersonImage?: string;
+};
+
+declare enum RecordingProcess {
+    ASYNCHRONOUS_UPLOAD = 0,
+    SYNCHRONOUS_UPLOAD = 1,
+    NOT_UPLOAD = 2,
+}
+
+declare enum FaceLivenessType {
+    ACTIVE = 0,
+    PASSIVE = 1,
+}
+
+interface FaceDetectionSettings {
+    url?: string;
+    debug?: boolean;
+    locale?: Locales | string;
+    copyright?: boolean;
+    cameraId?: string;
+    changeCamera?: boolean;
+    closeDisabled?: boolean;
+    finishScreen?: boolean;
+    startScreen?: boolean;
+    customization?: ComputedCss;
+    nonce?: string;
+    rotationAngle?: number;
+    holdStillDuration?: number;
+    timeoutInterval?: number;
+}
+
+interface FaceLivenessSettings extends Omit<FaceDetectionSettings, 'holdStillDuration' | 'timeoutInterval'> {
+    url?: string;
+    deviceOrientation?: boolean;
+    videoRecording?: boolean;
+    tag?: string;
+    headers?: Record<string, string>;
+    retryCount?: number;
+    metadata?: Record<string, any>;
+    recordingProcess?: RecordingProcess;
+    livenessType?: FaceLivenessType;
+}
+
+export type FaceLivenessDetailType = DetailEvent<FaceEventActions, FaceLivenessResponseType>;
+export type FaceCaptureDetailType = DetailEvent<FaceEventActions, FaceDetectionResponseType>;
+
+export class FullScreenContainer extends HTMLElement {}
+
+export class FaceDetectionWebComponent extends HTMLElement {
+    get version(): string;
+    set translations(dictionary: FaceDictionaries | null);
+    get translations(): FaceDictionaries | null;
+    get settings(): FaceDetectionSettings;
+    set settings(params: FaceDetectionSettings);
+}
+
+export class FaceLivenessWebComponent extends HTMLElement {
+    get version(): string;
+    set translations(dictionary: FaceDictionaries | null);
+    get translations(): FaceDictionaries | null;
+    get settings(): FaceLivenessSettings;
+    set settings(params: FaceLivenessSettings);
+}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@regulaforensics/vp-frontend-face-components",
-  "version": "6.3.1413-nightly",
+  "version": "6.3.1415-rc",
   "description": "Regula framework agnostic web components to work with webcamera",
-  "types": "./dist/index.d.ts",
+  "types": "./lib/index.d.ts",
   "main": "./dist/main.iife.js",
   "type": "module",
   "files": [
     "dist/main.iife.js",
-    "dist/index.d.ts"
+    "lib"
   ],
   "author": "Regula Forensics, Inc.",
   "license": "MIT",