@privateid/ultrapass-web-sdk 1.7.0 → 2.0.0

package/dist/faceModule.d.ts

@@ -1,233 +0,0 @@
-import { callbackTypeEnum } from './createCallback';
-import { CameraFaceMode } from './types';
-interface CameraOpenResult {
-    stream: MediaStream | null;
-    devices: MediaDeviceInfo[] | null;
-    faceMode: CameraFaceMode | null;
-    settings: MediaTrackSettings | null;
-    status: boolean;
-    errorMessage?: string | null;
-    capabilities: MediaTrackCapabilities | null;
-}
-interface openCameraProps {
-    videoElementId: string;
-    deviceId?: string;
-    requestFaceMode?: CameraFaceMode;
-    canvasResolution?: {
-        width: number;
-        height: number;
-    };
-    isDocumentScan?: boolean;
-}
-export declare const openCamera: ({ videoElementId, deviceId, requestFaceMode, canvasResolution, isDocumentScan, }: openCameraProps) => Promise<CameraOpenResult>;
-/**
- * This function close camera, and clear all memories related to the camera.
- * @category Face
- * @param domElement id of the video tag
- * @deprecated This function is being replaced with cameraClose.
- */
-export declare const closeCamera: (element: string) => Promise<void>;
-interface openCameraProps {
-    videoElementId: string;
-    deviceId?: string;
-    requestFaceMode?: CameraFaceMode;
-    canvasResolution?: {
-        width: number;
-        height: number;
-    };
-    isDocumentScan?: boolean;
-}
-/**
- * This function switch camera from front to back on mobile, and to another device on desktop
- * @category Face
- * @param selectedCamera Selected camera either front or back
- * @param device Selected camera ID
- * @param canvasResolution
- * @deprecated This function is being replaced with cameraSwitch.
- */
-export declare const switchCamera: (selectedCamera: CameraFaceMode | null, device: string, canvasResolution?: {
-    width: number;
-    height: number;
-} | null) => Promise<{
-    capabilities: MediaTrackCapabilities | null;
-    settings: MediaTrackSettings | null;
-} | null>;
-interface enrollProps {
-    callback: (result: any) => void;
-    config?: any;
-    element?: string;
-    returnPortrait?: boolean;
-}
-export declare const getBaseConfigEnroll: () => {
-    input_image_format: string;
-    angle_rotation_left_threshold: number;
-    angle_rotation_right_threshold: number;
-    threshold_high_vertical_enroll: number;
-    threshold_down_vertical_enroll: number;
-    anti_spoofing_threshold: number;
-    threshold_profile_enroll: number;
-    blur_threshold_enroll_pred: number;
-    threshold_user_too_close: number;
-    threshold_user_too_far: number;
-    allow_only_one_face: boolean;
-    threshold_user_up: number;
-    threshold_user_down: number;
-    threshold_user_left: number;
-    threshold_user_right: number;
-};
-/**
- * @deprecated This function is being replaced with faceEnroll.
- */
-export declare function enroll({ callback, config, element, returnPortrait }: enrollProps): Promise<ImageData | {
-    result: number;
-    imageData: Uint8ClampedArray;
-    height: number;
-    width: number;
-} | {
-    result: string;
-}>;
-interface BaseProps {
-    callback: (result: any) => void;
-    config?: any;
-    element?: string;
-    returnPortrait?: boolean;
-}
-interface FaceLoginProps extends BaseProps {
-}
-interface PredictProps extends BaseProps {
-    image?: ImageData;
-}
-/**
- * This function performs faceLogin, the camera should already be open. the functions performs the identification and return the result. This function is more restrictive than predict1Fa.
- * @category Face
- * @param callback Callbacks triggered on the  `predict` operation
- * @param config Configuration recommeded default: { input_image_format: "rgba" }
- * @param element Element id of video tag. (Optional) By default it uses the element id used when opening the camera using openCamera()
- */
-interface FaceLoginProps {
-    callback: (result: any) => void;
-    config?: any;
-    element?: string;
-    returnPortrait?: boolean;
-}
-/**
- * @deprecated This function is being replaced with faceAgeEstimation.
- */
-export declare const estimateAge: (options: Parameters<typeof runUltraProcess>[1]) => Promise<any>;
-type PredictFunction = (images: ImageData[], isSimd: boolean, config: string, resultProxy: any) => Promise<any>;
-declare const runUltraProcess: (fn: PredictFunction, options: {
-    callback: (result: any) => void;
-    config?: any;
-    element?: string;
-    image?: ImageData;
-    returnPortrait?: boolean;
-    useExistingCanvas?: boolean;
-    logMessage?: string;
-    callbackType?: callbackTypeEnum;
-}) => Promise<any>;
-/**
- * @deprecated This function is being replaced with facePredict.
- */
-export declare const faceLogin: (props: FaceLoginProps) => Promise<any>;
-/**
- * @deprecated This function is being replaced with facePredict({ type: 'VERIFY' }).
- * This function performs predict, the camera should already be open. the functions performs the identification return the result then restart again.
- * @category Face
- * @param callback Callbacks triggered on the predict operation
- * @param config Configuration recommeded default: { input_image_format: "rgba" }
- * @param element Element id of video tag. (Optional) By default it uses the element id used when opening the camera using openCamera()
- * @param image ImageData, If there is an image passed, it will be predicting the image instead of the video feed.
- */
-export declare const predictVerify: (props: PredictProps) => Promise<any>;
-/**
- * @deprecated This function is being replaced with facePredict({ type: 'PREDICT' }).
- */
-export declare const predict: (props: PredictProps) => Promise<any>;
-/**
- * @deprecated This function is being replaced with facePredict({ type: 'PREDICT_STATUS' }).
- */
-export declare const predictWithStatus: (props: PredictProps) => Promise<any>;
-/**
- * @deprecated This function is being replaced with facePredict({ type: 'CONFIRM_USER' }).
- */
-export declare const predictConfirmUser: (props: PredictProps) => Promise<any>;
-/**
- * @deprecated This function is being replaced with facePredict({ type: 'ULTRA_VERIFY' }).
- */
-export declare const ultraVerify: (props: PredictProps) => Promise<any>;
-/**
- * @deprecated This function is being replaced with facePredict({ type: 'DELETE' }).
- */
-export declare const predictDeleteUser: (props: PredictProps) => Promise<any>;
-/**
- *
- * @deprecated This function is being replaced with engineEncryptData.
- */
-export declare const pkiEncryptData: (payload: any) => Promise<(string | null)[]>;
-/**
- * @deprecated This function is being replaced with engineCheckModelsAreLoaded.
- */
-export declare const checkIfModelsAreLoaded: (isEnroll: boolean) => Promise<number>;
-interface frontScanInterface {
-    callback: (returnData: any) => void;
-    config?: any;
-    doOcr?: boolean;
-}
-/**
- * @deprecated This function is being replaced with documentScanGovernmentPhotoId.
- */
-export declare const scanFrontDocument: ({ callback, config }: frontScanInterface) => Promise<{
-    result: string;
-} | {
-    result: number;
-}>;
-/**
- * @deprecated This function is being replaced with documentScanPassport.
- */
-export declare const scanPassport: ({ callback, config }: frontScanInterface) => Promise<{
-    result: string;
-} | {
-    result: number;
-}>;
-interface backScanInterface {
-    callback: (returnData: any) => void;
-    image?: ImageData;
-    config?: any;
-}
-/**
- * @deprecated This function is being replaced with documentScanBackGovernmentPhotoId.
- */
-export declare const scanBackDocument: ({ callback, image, config }: backScanInterface) => Promise<{
-    result: string;
-} | {
-    [x: string]: any;
-    result?: undefined;
-} | {
-    result: number;
-}>;
-/**
- * @deprecated This function is being replaced with compareImageEmbeddings.
- */
-export declare const compareEmbeddings: (embeddingsA: string, embeddingsB: string, config: {}, callback: (result: any) => void, encryptData?: boolean) => Promise<{
-    result: number;
-    imageData: Uint8ClampedArray;
-    height: number;
-    width: number;
-}>;
-interface documentOcrInterface {
-    inputImage: string;
-    callback: (returnData: any) => void;
-    config?: any;
-}
-/**
- * @deprecated This function is being replaced with documentExtractOCR.
- */
-export declare const documentOcr: ({ inputImage, callback, config }: documentOcrInterface) => Promise<{
-    result: number;
-}>;
-/**
- *
- * @deprecated This function is being replaced with engineFreeMemory.
- */
-export declare const freeFrontScanMemory: () => Promise<boolean>;
-export {};