@authme/id-recognition 2.3.1-rc.3 → 2.4.6

package/index.cjs

@@ -2,6 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+require('core-js/modules/es.object.assign.js');
 var engine = require('@authme/engine');
 require('core-js/modules/es.array.iterator.js');
 require('core-js/modules/es.object.from-entries.js');
@@ -18,6 +19,7 @@ exports.ResourceImageType = void 0;
 exports.CountryCode = void 0;
 (function (CountryCode) {
   CountryCode["TWN"] = "TWN";
+  CountryCode["JPW"] = "JP";
 })(exports.CountryCode || (exports.CountryCode = {}));
 exports.IdRecognitionCardType = void 0;
 (function (IdRecognitionCardType) {
@@ -41,6 +43,11 @@ exports.ServerSideEAuthMeCardClass = void 0;
   ServerSideEAuthMeCardClass["TWN_HealthCard_Front"] = "TWN_HealthCard_Front";
   ServerSideEAuthMeCardClass["TWN_VehiclesLicense_Front"] = "TWN_VehiclesLicense_Front";
 })(exports.ServerSideEAuthMeCardClass || (exports.ServerSideEAuthMeCardClass = {}));
+exports.RecognitionFileType = void 0;
+(function (RecognitionFileType) {
+  RecognitionFileType["OriginImage"] = "OriginImage";
+  RecognitionFileType["FlatImage"] = "FlatImage";
+})(exports.RecognitionFileType || (exports.RecognitionFileType = {}));
 
 class CardOCR extends engine.AuthmeEngineModuleBase {
   constructor(engine$1) {
@@ -57,6 +64,13 @@ class CardOCR extends engine.AuthmeEngineModuleBase {
   getType() {
     return this.type;
   }
+  setParams(params) {
+    var _a;
+    if (((_a = params.type) !== null && _a !== void 0 ? _a : this.type) === engine.EAuthMeCardClass.Invalid) throw new Error('Please set type first');
+    return this.engine.run(this.moduleName, 'setParams', Object.assign({
+      type: this.type
+    }, params));
+  }
 }
 class IdCardAntiFraudService extends engine.AuthmeEngineModuleBase {
   constructor(engine$1) {
@@ -67,11 +81,19 @@ class IdCardAntiFraudService extends engine.AuthmeEngineModuleBase {
     const stageStrList = stageList.map(x => x.split('_')[1]);
     return this.engine.run(this.moduleName, 'setStage', stageStrList);
   }
+  getCardMatchROI() {
+    return this.engine.run(this.moduleName, 'getCardMatchROI');
+  }
 }
 class MRZService extends engine.AuthmeEngineModuleBase {
-  constructor(engine$1) {
+  constructor(engine$1, type = 'passport') {
     super(engine$1);
-    this.moduleName = engine.EngineModule.PassportService;
+    this.type = type;
+    if (this.type === 'passport') {
+      this.moduleName = engine.EngineModule.MRZPassportService;
+    } else if (this.type === 'residentCard') {
+      this.moduleName = engine.EngineModule.MRZResidentCardService;
+    }
   }
   getFinalResult() {
     return this.engine.run(this.moduleName, 'getFinalResult');
@@ -135,11 +157,12 @@ const twoWayAuthmeCardClassMap = (() => {
   };
 })();
 
-function init(type, country, needConfirm) {
+function init(type, country, needConfirm, encrypt = true) {
   const body = {
     scanType: type === exports.IdRecognitionCardType.Passport ? type : `${country}_${type}`,
     cardTypes: getCardSubTypes(type).map(c => twoWayAuthmeCardClassMap.toServer(c)),
-    needConfirm
+    needConfirm,
+    encrypt
   };
   return core.sendRequest('/api/identity-verification/id-recognition/v3/init-scan', 'POST', {
     body: JSON.stringify(body)
@@ -172,6 +195,52 @@ function recognition(documentId, file) {
     throw error;
   });
 }
+function recognitionEncrypt(documentId, base64Text, report, fileType) {
+  return core.sendRequest('/api/identity-verification/id-recognition/v3/recognize-base64', 'POST', {
+    body: JSON.stringify({
+      scanDocumentId: documentId,
+      image: base64Text,
+      fileType: fileType,
+      info: {
+        report
+      }
+    }),
+    contentType: 'application/json'
+  }).catch(error => {
+    var _a, _b, _c;
+    if (error instanceof core.AuthmeError && ((_c = (_b = (_a = error.cause) === null || _a === void 0 ? void 0 : _a.error) === null || _b === void 0 ? void 0 : _b.error) === null || _c === void 0 ? void 0 : _c.code) === 'AuthMe.IDRecognition:000201') {
+      return {
+        retry: true,
+        details: {}
+      };
+    }
+    throw error;
+  });
+}
+function uploadFrameBase64(documentId, base64Text, index, type = exports.ResourceImageType.Recognition, report) {
+  return core.sendRequest('/api/identity-verification/id-recognition/v3/upload-frame-base64', 'POST', {
+    body: JSON.stringify({
+      scanDocumentId: documentId,
+      image: base64Text,
+      type,
+      // fileType: 'image/jpeg',
+      info: {
+        report,
+        index
+      }
+    }),
+    contentType: 'application/json'
+  }).catch(error => {
+    var _a, _b, _c;
+    if (error instanceof core.AuthmeError && ((_c = (_b = (_a = error.cause) === null || _a === void 0 ? void 0 : _a.error) === null || _b === void 0 ? void 0 : _b.error) === null || _c === void 0 ? void 0 : _c.code) === 'AuthMe.IDRecognition:000201') {
+      return {
+        retry: true,
+        details: {}
+      };
+    }
+    throw error;
+  });
+}
 function saveResourceImage(documentId, type, file) {
   const formData = new FormData();
   formData.append('scanDocumentId', documentId);
@@ -215,7 +284,7 @@ function saveExtraDoc(params) {
 }
 
 var name = "@authme/id-recognition";
-var version$1 = "2.3.1-rc.3";
+var version$1 = "2.4.6";
 var peerDependencies = {
 	"core-js": "^3.6.0"
 };
@@ -255,9 +324,9 @@ Object.defineProperty(exports, 'EAuthMeMRZRecogStatus', {
   enumerable: true,
   get: function () { return engine.EAuthMeMRZRecogStatus; }
 });
-Object.defineProperty(exports, 'EAuthMePassportServiceStatus', {
+Object.defineProperty(exports, 'EAuthMeMRZServiceStatus', {
   enumerable: true,
-  get: function () { return engine.EAuthMePassportServiceStatus; }
+  get: function () { return engine.EAuthMeMRZServiceStatus; }
 });
 exports.CardOCR = CardOCR;
 exports.IdCardAntiFraudService = IdCardAntiFraudService;
@@ -270,7 +339,9 @@ exports.getRecognitionColumnOrder = getRecognitionColumnOrder;
 exports.init = init;
 exports.initScanDocument = initScanDocument;
 exports.recognition = recognition;
+exports.recognitionEncrypt = recognitionEncrypt;
 exports.saveExtraDoc = saveExtraDoc;
 exports.saveResourceImage = saveResourceImage;
 exports.twoWayAuthmeCardClassMap = twoWayAuthmeCardClassMap;
+exports.uploadFrameBase64 = uploadFrameBase64;
 exports.version = version;

package/index.js

@@ -1,5 +1,6 @@
+import 'core-js/modules/es.object.assign.js';
 import { AuthmeEngineModuleBase, EAuthMeCardClass, EngineModule } from '@authme/engine';
-export { EAuthMeCardClass, EAuthMeCardMatchStatus, EAuthMeCardOCRStatus, EAuthMeIDCardAntiFraudStage, EAuthMeIDCardAntiFraudStatus, EAuthMeMRZRecogStatus, EAuthMePassportServiceStatus } from '@authme/engine';
+export { EAuthMeCardClass, EAuthMeCardMatchStatus, EAuthMeCardOCRStatus, EAuthMeIDCardAntiFraudStage, EAuthMeIDCardAntiFraudStatus, EAuthMeMRZRecogStatus, EAuthMeMRZServiceStatus } from '@authme/engine';
 import 'core-js/modules/es.array.iterator.js';
 import 'core-js/modules/es.object.from-entries.js';
 import 'core-js/modules/web.dom-collections.iterator.js';
@@ -15,6 +16,7 @@ var ResourceImageType;
 var CountryCode;
 (function (CountryCode) {
   CountryCode["TWN"] = "TWN";
+  CountryCode["JPW"] = "JP";
 })(CountryCode || (CountryCode = {}));
 var IdRecognitionCardType;
 (function (IdRecognitionCardType) {
@@ -38,6 +40,11 @@ var ServerSideEAuthMeCardClass;
   ServerSideEAuthMeCardClass["TWN_HealthCard_Front"] = "TWN_HealthCard_Front";
   ServerSideEAuthMeCardClass["TWN_VehiclesLicense_Front"] = "TWN_VehiclesLicense_Front";
 })(ServerSideEAuthMeCardClass || (ServerSideEAuthMeCardClass = {}));
+var RecognitionFileType;
+(function (RecognitionFileType) {
+  RecognitionFileType["OriginImage"] = "OriginImage";
+  RecognitionFileType["FlatImage"] = "FlatImage";
+})(RecognitionFileType || (RecognitionFileType = {}));
 
 class CardOCR extends AuthmeEngineModuleBase {
   constructor(engine) {
@@ -54,6 +61,13 @@ class CardOCR extends AuthmeEngineModuleBase {
   getType() {
     return this.type;
   }
+  setParams(params) {
+    var _a;
+    if (((_a = params.type) !== null && _a !== void 0 ? _a : this.type) === EAuthMeCardClass.Invalid) throw new Error('Please set type first');
+    return this.engine.run(this.moduleName, 'setParams', Object.assign({
+      type: this.type
+    }, params));
+  }
 }
 class IdCardAntiFraudService extends AuthmeEngineModuleBase {
   constructor(engine) {
@@ -64,11 +78,19 @@ class IdCardAntiFraudService extends AuthmeEngineModuleBase {
     const stageStrList = stageList.map(x => x.split('_')[1]);
     return this.engine.run(this.moduleName, 'setStage', stageStrList);
   }
+  getCardMatchROI() {
+    return this.engine.run(this.moduleName, 'getCardMatchROI');
+  }
 }
 class MRZService extends AuthmeEngineModuleBase {
-  constructor(engine) {
+  constructor(engine, type = 'passport') {
     super(engine);
-    this.moduleName = EngineModule.PassportService;
+    this.type = type;
+    if (this.type === 'passport') {
+      this.moduleName = EngineModule.MRZPassportService;
+    } else if (this.type === 'residentCard') {
+      this.moduleName = EngineModule.MRZResidentCardService;
+    }
   }
   getFinalResult() {
     return this.engine.run(this.moduleName, 'getFinalResult');
@@ -132,11 +154,12 @@ const twoWayAuthmeCardClassMap = (() => {
   };
 })();
 
-function init(type, country, needConfirm) {
+function init(type, country, needConfirm, encrypt = true) {
   const body = {
     scanType: type === IdRecognitionCardType.Passport ? type : `${country}_${type}`,
     cardTypes: getCardSubTypes(type).map(c => twoWayAuthmeCardClassMap.toServer(c)),
-    needConfirm
+    needConfirm,
+    encrypt
   };
   return sendRequest('/api/identity-verification/id-recognition/v3/init-scan', 'POST', {
     body: JSON.stringify(body)
@@ -169,6 +192,52 @@ function recognition(documentId, file) {
     throw error;
   });
 }
+function recognitionEncrypt(documentId, base64Text, report, fileType) {
+  return sendRequest('/api/identity-verification/id-recognition/v3/recognize-base64', 'POST', {
+    body: JSON.stringify({
+      scanDocumentId: documentId,
+      image: base64Text,
+      fileType: fileType,
+      info: {
+        report
+      }
+    }),
+    contentType: 'application/json'
+  }).catch(error => {
+    var _a, _b, _c;
+    if (error instanceof AuthmeError && ((_c = (_b = (_a = error.cause) === null || _a === void 0 ? void 0 : _a.error) === null || _b === void 0 ? void 0 : _b.error) === null || _c === void 0 ? void 0 : _c.code) === 'AuthMe.IDRecognition:000201') {
+      return {
+        retry: true,
+        details: {}
+      };
+    }
+    throw error;
+  });
+}
+function uploadFrameBase64(documentId, base64Text, index, type = ResourceImageType.Recognition, report) {
+  return sendRequest('/api/identity-verification/id-recognition/v3/upload-frame-base64', 'POST', {
+    body: JSON.stringify({
+      scanDocumentId: documentId,
+      image: base64Text,
+      type,
+      // fileType: 'image/jpeg',
+      info: {
+        report,
+        index
+      }
+    }),
+    contentType: 'application/json'
+  }).catch(error => {
+    var _a, _b, _c;
+    if (error instanceof AuthmeError && ((_c = (_b = (_a = error.cause) === null || _a === void 0 ? void 0 : _a.error) === null || _b === void 0 ? void 0 : _b.error) === null || _c === void 0 ? void 0 : _c.code) === 'AuthMe.IDRecognition:000201') {
+      return {
+        retry: true,
+        details: {}
+      };
+    }
+    throw error;
+  });
+}
 function saveResourceImage(documentId, type, file) {
   const formData = new FormData();
   formData.append('scanDocumentId', documentId);
@@ -212,7 +281,7 @@ function saveExtraDoc(params) {
 }
 
 var name = "@authme/id-recognition";
-var version$1 = "2.3.1-rc.3";
+var version$1 = "2.4.6";
 var peerDependencies = {
 	"core-js": "^3.6.0"
 };
@@ -228,4 +297,4 @@ const version = packageInfo.version;
 (_a = (_b = window)[_c = Symbol.for('authme-sdk')]) !== null && _a !== void 0 ? _a : _b[_c] = {};
 window[Symbol.for('authme-sdk')][packageInfo.name] = version;
 
-export { CardOCR, CountryCode, IdCardAntiFraudService, IdRecognitionCardType, IdType, IdTypeConfig, MRZService, ResourceImageType, ServerSideEAuthMeCardClass, confirmScan, finishScanDocument, getCardSubTypes, getRecognitionColumnOrder, init, initScanDocument, recognition, saveExtraDoc, saveResourceImage, twoWayAuthmeCardClassMap, version };
+export { CardOCR, CountryCode, IdCardAntiFraudService, IdRecognitionCardType, IdType, IdTypeConfig, MRZService, RecognitionFileType, ResourceImageType, ServerSideEAuthMeCardClass, confirmScan, finishScanDocument, getCardSubTypes, getRecognitionColumnOrder, init, initScanDocument, recognition, recognitionEncrypt, saveExtraDoc, saveResourceImage, twoWayAuthmeCardClassMap, uploadFrameBase64, version };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@authme/id-recognition",
-  "version": "2.3.1-rc.3",
+  "version": "2.4.6",
   "peerDependencies": {
     "core-js": "^3.6.0",
-    "@authme/core": "2.3.1-rc.3",
-    "@authme/engine": "2.3.1-rc.3"
+    "@authme/core": "2.4.6",
+    "@authme/engine": "2.4.6"
   },
   "module": "./index.js",
   "main": "./index.cjs",

package/src/lib/data-access/api.d.ts

@@ -1,6 +1,6 @@
-import { CountryCode, IdRecognitionCardType, ResourceImageType, ServerSideEAuthMeCardClass } from '../enum';
+import { CountryCode, IdRecognitionCardType, RecognitionFileType, ResourceImageType, ServerSideEAuthMeCardClass } from '../enum';
 import { InitScanResponse } from '../model';
-export declare function init(type: IdRecognitionCardType, country: CountryCode, needConfirm: boolean): Promise<InitScanResponse>;
+export declare function init(type: IdRecognitionCardType, country: CountryCode, needConfirm: boolean, encrypt?: boolean): Promise<InitScanResponse>;
 export declare function initScanDocument(scanId: string, cardType: `${ServerSideEAuthMeCardClass}`): Promise<{
     scanDocumentId: string;
 }>;
@@ -10,6 +10,18 @@ export declare function recognition(documentId: string, file: Blob): Promise<{
         [key: string]: string | null;
     };
 }>;
+export declare function recognitionEncrypt(documentId: string, base64Text: string, report: string, fileType: RecognitionFileType): Promise<{
+    retry?: boolean;
+    details: {
+        [key: string]: string | null;
+    };
+}>;
+export declare function uploadFrameBase64(documentId: string, base64Text: string, index: number, type?: ResourceImageType, report?: string): Promise<{
+    retry?: boolean;
+    details: {
+        [key: string]: string | null;
+    };
+}>;
 export declare function saveResourceImage(documentId: string, type: ResourceImageType, file: Blob): Promise<any>;
 export declare function finishScanDocument(documentId: string, details: {
     [key: string]: string | null;

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

@@ -1,11 +1,12 @@
-export { EAuthMeCardClass, EAuthMeCardMatchStatus, EAuthMeCardOCRStatus, EAuthMeIDCardAntiFraudStage, EAuthMeIDCardAntiFraudStatus, EAuthMeMRZRecogStatus, EAuthMePassportServiceStatus, } from '@authme/engine';
+export { EAuthMeCardClass, EAuthMeCardMatchStatus, EAuthMeCardOCRStatus, EAuthMeIDCardAntiFraudStage, EAuthMeIDCardAntiFraudStatus, EAuthMeMRZRecogStatus, EAuthMeMRZServiceStatus, } from '@authme/engine';
 export declare enum ResourceImageType {
     Recognition = "Recognition",
     Fraud = "Fraud",
     Manual = "Manual"
 }
 export declare enum CountryCode {
-    TWN = "TWN"
+    TWN = "TWN",
+    JPW = "JP"
 }
 export declare enum IdRecognitionCardType {
     IDCard = "IDCard",
@@ -27,3 +28,7 @@ export declare enum ServerSideEAuthMeCardClass {
     TWN_HealthCard_Front = "TWN_HealthCard_Front",
     TWN_VehiclesLicense_Front = "TWN_VehiclesLicense_Front"
 }
+export declare enum RecognitionFileType {
+    OriginImage = "OriginImage",
+    FlatImage = "FlatImage"
+}

package/src/lib/interface/id-recognition-type.interface.d.ts

@@ -1,5 +1,5 @@
 import { EAuthMeIDCardMetalTagStatus } from '@authme/engine';
-import { EAuthMeCardClass, EAuthMeCardMatchStatus, EAuthMeCardOCRStatus, EAuthMeIDCardAntiFraudStage, EAuthMeIDCardAntiFraudStatus, EAuthMeMRZRecogStatus, EAuthMePassportServiceStatus } from '../enum';
+import { EAuthMeCardClass, EAuthMeCardMatchStatus, EAuthMeCardOCRStatus, EAuthMeIDCardAntiFraudStage, EAuthMeIDCardAntiFraudStatus, EAuthMeMRZRecogStatus, EAuthMeMRZServiceStatus } from '../enum';
 export interface IDCardAntiFraudResult {
     info: AuthMeIDCardAntiFraudInfo;
     statistics: AuthMeIDCardAntiFraudStatistics;
@@ -52,7 +52,12 @@ export interface AuthMeCardOCRInfo {
 }
 export interface PassportResult {
     info: AuthMeMRZInfo;
-    eStatus: EAuthMePassportServiceStatus;
+    eStatus: EAuthMeMRZServiceStatus;
+    tField: MRZFieldTD3;
+}
+export interface ResidentCardResult {
+    info: AuthMeMRZInfo;
+    eStatus: EAuthMeMRZServiceStatus;
     tField: MRZFieldTD3;
 }
 export interface MRZFieldTD3 {

package/src/lib/model/dto.model.d.ts

@@ -13,5 +13,14 @@ export interface InitScanResponse {
         fraudRetryTimes: number;
         fraudTimeout: number;
         fraudMaxFps: number;
+        pubKey: string;
+        fraud?: {
+            collectAllFrames: boolean;
+            maxFps: number;
+            retryTimes: number;
+            stages: Array<unknown>;
+            timeout: number;
+            totalTimeout: number;
+        };
     };
 }

package/src/lib/modules-id-recognition-feature-id-recognition.d.ts

@@ -1,18 +1,25 @@
 import { AuthmeEngineModuleBase, MlEngine } from '@authme/engine';
-import { CardOCRResult, IDCardAntiFraudResult, PassportResult } from './interface';
+import { CardOCRResult, IDCardAntiFraudResult, PassportResult, ResidentCardResult } from './interface';
 import { EAuthMeCardClass, EAuthMeIDCardAntiFraudStage } from './enum';
 export declare class CardOCR extends AuthmeEngineModuleBase<CardOCRResult> {
     private type;
     constructor(engine: MlEngine);
     setType(type: EAuthMeCardClass): Promise<unknown>;
     getType(): EAuthMeCardClass;
+    setParams(params: any): Promise<unknown>;
+}
+export interface Point {
+    x: number;
+    y: number;
 }
 export declare class IdCardAntiFraudService extends AuthmeEngineModuleBase<IDCardAntiFraudResult> {
     constructor(engine: MlEngine);
     setStage(stageList: EAuthMeIDCardAntiFraudStage[]): Promise<unknown>;
+    getCardMatchROI(): Promise<Point[]>;
 }
-export declare class MRZService extends AuthmeEngineModuleBase<PassportResult> {
-    constructor(engine: MlEngine);
+export declare class MRZService<T extends PassportResult | ResidentCardResult> extends AuthmeEngineModuleBase<T> {
+    private type;
+    constructor(engine: MlEngine, type?: 'passport' | 'residentCard');
     getFinalResult(): Promise<unknown>;
     toJson(params: unknown): Promise<string>;
 }