@authme/engine 2.2.0 → 2.2.1-rc.3

package/src/lib/engine.d.ts

@@ -1,42 +1,52 @@
-import { Observable } from 'rxjs';
-import { EngineModule } from './enum';
-import { EngineDebugInfo, MlEngineConfig } from './interface';
-export declare abstract class AuthmeFunctionModule {
-    init(config: MlEngineConfig): Promise<void>;
-    static getVersion(): string;
-}
-export declare class MlEngine {
-    static instance: MlEngine | null;
-    private worker;
-    path: string;
-    private workerMessage$;
-    private config;
-    constructor(config: MlEngineConfig);
-    init(): Promise<void>;
-    run(module: string, command: string, value?: any): Observable<any>;
-    setConfig(config: MlEngineConfig): Promise<any>;
-    getConfig(): MlEngineConfig;
-    loadEngine(): Promise<any>;
-    debug$(): Observable<string>;
-}
-export declare abstract class AuthmeEngineModuleBase<T = any> {
-    protected engine: MlEngine;
-    protected initialized: boolean;
-    protected initializing: boolean;
-    protected setSized: boolean;
-    protected received: boolean;
-    protected moduleName: EngineModule;
-    constructor(engine: MlEngine);
-    _engineRunAsync(command: string, value?: any): Promise<any>;
-    init(): Promise<boolean>;
-    startSession(): Promise<void>;
-    stop(): Promise<void>;
-    getReport(): Promise<string>;
-    recognition(data: Uint8Array | Uint8ClampedArray): Promise<T & EngineDebugInfo>;
-    getDebugImageData(data: Uint8Array | Uint8ClampedArray): Promise<Uint8Array>;
-    setFrameSize(width: number, height: number): Promise<boolean>;
-    getParams(): Promise<any>;
-    setParams(params: any): Promise<any>;
-    setMaskPosition(positions: number[][]): Promise<any>;
-    destroy(): Promise<boolean>;
-}
+import { EngineModule } from './enum';
+import { EngineDebugInfo, MlEngineConfig } from './interface';
+export declare abstract class AuthmeFunctionModule {
+    init(config: MlEngineConfig): Promise<void>;
+    static getVersion(): string;
+}
+export declare class MlEngine {
+    private static _ENGINE_CACHE;
+    private config;
+    private workerAndStreamPromise;
+    private preloadPromise;
+    constructor(config: MlEngineConfig);
+    private _run;
+    private _makeWorkerAndStreamAsync;
+    private _backgroundPreloadAsync;
+    terminateWorkerAsync(): Promise<void>;
+    private _preloadAndWaitReadyAsync;
+    private _checkEnumConsistencyAsync;
+    run<TResp = unknown>(module: string, command: string, value?: unknown): Promise<TResp>;
+    getConfig(): MlEngineConfig;
+    setConfig(config: MlEngineConfig): Promise<void>;
+    private _loadEngineAsync;
+}
+export declare abstract class AuthmeEngineModuleBase<T = any> {
+    private static _MODEL_CACHE;
+    private _initPromise;
+    protected engine: MlEngine;
+    protected initialized: boolean;
+    protected initializing: boolean;
+    protected setSized: boolean;
+    protected received: boolean;
+    protected moduleName: EngineModule;
+    constructor(engine: MlEngine);
+    private _engineRunAsync;
+    private _init;
+    init(): Promise<boolean>;
+    preloadAsync(): Promise<boolean>;
+    startSession(): Promise<void>;
+    stop(): Promise<void>;
+    getReport(): Promise<string>;
+    recognition(data: Uint8Array | Uint8ClampedArray): Promise<T & EngineDebugInfo>;
+    getDebugImageData(data: Uint8Array | Uint8ClampedArray): Promise<Uint8Array>;
+    setFrameSize(width: number, height: number): Promise<boolean>;
+    getParams(): Promise<{
+        timeoutSec: number;
+        fFASTh: number;
+    }>;
+    setParams(params: any): Promise<unknown>;
+    setMaskPosition(positions: number[][]): Promise<unknown>;
+    destroy(): Promise<boolean>;
+    static reset_MODEL_CACHE(): void;
+}

package/src/lib/enum/auth.enum.d.ts

@@ -1,3 +1,3 @@
-export declare enum EAuthMeSDKAuthStatus {
-    Pass = "EAuthMeSDKAuthStatus_Pass"
-}
+export declare enum EAuthMeEngineReturnCode {
+    Pass = "EAuthMeEngineReturnCode_eAuthMe_Engine_Authorization_Pass"
+}

package/src/lib/enum/fas-recognition.enum.d.ts

@@ -0,0 +1,46 @@
+export declare enum EAuthMeFASServiceStatus {
+    Failed = "EAuthMeFASServiceStatus_Failed",
+    NoFace = "EAuthMeFASServiceStatus_NoFace",
+    FaceNotAtCenter = "EAuthMeFASServiceStatus_FaceNotAtCenter",
+    FaceTooSmall = "EAuthMeFASServiceStatus_FaceTooSmall",
+    FaceTooLarge = "EAuthMeFASServiceStatus_FaceTooLarge",
+    NeedFaceToCamera = "EAuthMeFASServiceStatus_NeedFaceToCamera",
+    FaceMasked = "EAuthMeFASServiceStatus_FaceMasked",
+    NeedOpenMouth = "EAuthMeFASServiceStatus_NeedOpenMouth",
+    NeedCloseMouth = "EAuthMeFASServiceStatus_NeedCloseMouth",
+    NeedSmile = "EAuthMeFASServiceStatus_NeedSmile",
+    NeedOpenEyes = "EAuthMeFASServiceStatus_NeedOpenEyes",
+    NeedMoreFrame = "EAuthMeFASServiceStatus_NeedMoreFrame",
+    Error = "EAuthMeFASServiceStatus_Error",
+    Pass = "EAuthMeFASServiceStatus_Pass"
+}
+export declare enum EAuthMeFASServiceStage {
+    Passive = "EAuthMeFASServiceStage_Passive",
+    OpenMouth = "EAuthMeFASServiceStage_OpenMouth",
+    CloseMouth = "EAuthMeFASServiceStage_CloseMouth",
+    Smile = "EAuthMeFASServiceStage_Smile",
+    Done = "EAuthMeFASServiceStage_Done"
+}
+export declare enum EAuthMeEyeStatus {
+    Eye_Close = "EAuthMeEyeStatus_Eye_Close",
+    Eye_Open = "EAuthMeEyeStatus_Eye_Open"
+}
+export declare enum EAuthMeMouthStatus {
+    Mouth_Close = "EAuthMeMouthStatus_Mouth_Close",
+    Mouth_Open = "EAuthMeMouthStatus_Mouth_Open"
+}
+export declare enum EAuthMeFacePose {
+    Unknown = "EAuthMeFacePose_Unknown",
+    LeftProfile = "EAuthMeFacePose_LeftProfile",
+    LeftFrontal = "EAuthMeFacePose_LeftFrontal",
+    Frontal = "EAuthMeFacePose_Frontal",
+    RightFrontal = "EAuthMeFacePose_RightFrontal",
+    RightProfile = "EAuthMeFacePose_RightProfile",
+    UpFrontal = "EAuthMeFacePose_UpFrontal",
+    DownFrontal = "EAuthMeFacePose_DownFrontal"
+}
+export declare enum EAuthMeFaceAntiSpoofingStatus {
+    FrameNotEnough = "EAuthMeFaceAntiSpoofingStatus_FrameNotEnough",
+    Real = "EAuthMeFaceAntiSpoofingStatus_Real",
+    Spoof = "EAuthMeFaceAntiSpoofingStatus_Spoof"
+}

package/src/lib/enum/id-recognition.enum.d.ts

@@ -0,0 +1,64 @@
+export declare enum EAuthMeCardClass {
+    Invalid = "EAuthMeCardClass_Invalid",
+    Unknown = "EAuthMeCardClass_UnknownCard",
+    Passport = "EAuthMeCardClass_Passport",
+    TWN_IDCard_Front = "EAuthMeCardClass_TWN_IDCard_Front",
+    TWN_IDCard_Back = "EAuthMeCardClass_TWN_IDCard_Back",
+    TWN_DriverLicense_Front = "EAuthMeCardClass_TWN_DriverLicense_Front",
+    TWN_DriverLicense_Back = "EAuthMeCardClass_TWN_DriverLicense_Back",
+    TWN_ResidentCard_Front = "EAuthMeCardClass_TWN_ResidentCard_Front",
+    TWN_ResidentCard_Back = "EAuthMeCardClass_TWN_ResidentCard_Back",
+    TWN_HealthCard_Front = "EAuthMeCardClass_TWN_HealthCard_Front",
+    TWN_VehiclesLicense_Front = "EAuthMeCardClass_TWN_VehiclesLicense_Front"
+}
+export declare enum EAuthMeIDCardMetalTagStatus {
+    NotFound = "EAuthMeIDCardMetalTagStatus_NotFound",
+    Bright = "EAuthMeIDCardMetalTagStatus_Bright",
+    Dark = "EAuthMeIDCardMetalTagStatus_Dark"
+}
+export declare enum EAuthMeCardMatchStatus {
+    None = "EAuthMeCardMatchStatus_None",
+    Mismatch = "EAuthMeCardMatchStatus_Mismatch",
+    NeedMoreFrame = "EAuthMeCardMatchStatus_NeedMoreFrame",
+    Match = "EAuthMeCardMatchStatus_Match"
+}
+export declare enum EAuthMeCardOCRStatus {
+    NoCard = "EAuthMeCardOCRStatus_NoCard",
+    WrongCardType = "EAuthMeCardOCRStatus_WrongCardType",
+    PositionNotMatch = "EAuthMeCardOCRStatus_PositionNotMatch",
+    Reflective = "EAuthMeCardOCRStatus_Reflective",
+    Blur = "EAuthMeCardOCRStatus_Blur",
+    Pass = "EAuthMeCardOCRStatus_Pass",
+    Error = "EAuthMeCardOCRStatus_Error"
+}
+export declare enum EAuthMeIDCardAntiFraudStatus {
+    Failed = "EAuthMeIDCardAntiFraudStatus_Failed",
+    NoCard = "EAuthMeIDCardAntiFraudStatus_NoCard",
+    WrongCardType = "EAuthMeIDCardAntiFraudStatus_WrongCardType",
+    Reflective = "EAuthMeIDCardAntiFraudStatus_Reflective",
+    Blur = "EAuthMeIDCardAntiFraudStatus_Blur",
+    Gray = "EAuthMeIDCardAntiFraudStatus_Gray",
+    PositionNotMatch = "EAuthMeIDCardAntiFraudStatus_PositionNotMatch",
+    NeedMoreFrame = "EAuthMeIDCardAntiFraudStatus_NeedMoreFrame",
+    Pass = "EAuthMeIDCardAntiFraudStatus_Pass",
+    Error = "EAuthMeIDCardAntiFraudStatus_Error"
+}
+export declare enum EAuthMeMRZRecogStatus {
+    Success = "EAuthMeMRZRecogStatus_Success",
+    WrongFormat = "EAuthMeMRZRecogStatus_WrongFormat"
+}
+export declare enum EAuthMePassportServiceStatus {
+    Success = "EAuthMePassportServiceStatus_Success",
+    NotFound = "EAuthMePassportServiceStatus_NotFound",
+    RecogFailed = "EAuthMePassportServiceStatus_RecogFailed",
+    Error = "EAuthMePassportServiceStatus_Error"
+}
+export declare enum EAuthMeIDCardAntiFraudStage {
+    Frontal = "EAuthMeIDCardAntiFraudStage_Frontal",
+    Up = "EAuthMeIDCardAntiFraudStage_Up",
+    Down = "EAuthMeIDCardAntiFraudStage_Down",
+    Left = "EAuthMeIDCardAntiFraudStage_Left",
+    Right = "EAuthMeIDCardAntiFraudStage_Right",
+    IgnoreCardMatch = "EAuthMeIDCardAntiFraudStage_IgnoreCardMatch",
+    Done = "EAuthMeIDCardAntiFraudStage_Done"
+}

package/src/lib/enum/index.d.ts

@@ -1,2 +1,4 @@
-export * from './module.enum';
-export * from './auth.enum';
+export * from './module.enum';
+export * from './auth.enum';
+export * from './id-recognition.enum';
+export * from './fas-recognition.enum';

package/src/lib/enum/module.enum.d.ts

@@ -1,8 +1,8 @@
-export declare enum EngineModule {
-    Fas = "Fas",
-    IdCardAntiFraud = "IdCardAntiFraud",
-    CardOCR = "CardOCR",
-    PassportService = "PassportService",
-    DEBUG = "DEBUG",
-    Core = "Core"
-}
+export declare enum EngineModule {
+    Fas = "Fas",
+    IdCardAntiFraud = "IdCardAntiFraud",
+    CardOCR = "CardOCR",
+    PassportService = "PassportService",
+    DEBUG = "DEBUG",
+    Core = "Core"
+}

package/src/lib/interface/basic-type.interface.d.ts

@@ -1,12 +1,12 @@
-export interface AuthMeRectFloat {
-    fLeft: number;
-    fTop: number;
-    fRight: number;
-    fBottom: number;
-}
-export interface EngineDebugInfo {
-    debugInfo: {
-        inferenceTime: number;
-        debugImage?: Uint8Array;
-    };
-}
+export interface AuthMeRectFloat {
+    fLeft: number;
+    fTop: number;
+    fRight: number;
+    fBottom: number;
+}
+export interface EngineDebugInfo {
+    debugInfo: {
+        inferenceTime: number;
+        debugImage?: Uint8Array;
+    };
+}

package/src/lib/interface/config.interface.d.ts

@@ -1,7 +1,7 @@
-export interface MlEngineConfig {
-    token?: string;
-    scriptPath?: string;
-    apiBaseUrl?: string;
-    dataTransferMethod?: 'binary' | 'base64';
-}
-export declare const defaultMlEngineConfig: MlEngineConfig;
+export interface MlEngineConfig {
+    token?: string;
+    scriptPath?: string;
+    apiBaseUrl?: string;
+    dataTransferMethod?: 'binary' | 'base64';
+}
+export declare const defaultMlEngineConfig: MlEngineConfig;

package/src/lib/interface/index.d.ts

@@ -1,3 +1,3 @@
-export * from './worker-command.interface';
-export * from './basic-type.interface';
-export * from './config.interface';
+export * from './worker-command.interface';
+export * from './basic-type.interface';
+export * from './config.interface';

package/src/lib/interface/worker-command.interface.d.ts

@@ -1,7 +1,7 @@
-import { EngineModule } from '../enum';
-export interface WorkerCommand {
-    module: EngineModule;
-    command: string;
-    id: any;
-    value?: any;
-}
+import { EngineModule } from '../enum';
+export interface WorkerCommand {
+    module: EngineModule;
+    command: string;
+    id: any;
+    value?: any;
+}

package/src/lib/version.d.ts

@@ -0,0 +1 @@
+export declare const version: string;