@authme/id-recognition 2.4.6 → 2.4.7

package/index.cjs

@@ -6,8 +6,10 @@ 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');
+require('core-js/modules/es.regexp.to-string.js');
 require('core-js/modules/web.dom-collections.iterator.js');
 var core = require('@authme/core');
+var util = require('@authme/util');
 require('core-js/modules/es.symbol.description.js');
 
 exports.ResourceImageType = void 0;
@@ -19,7 +21,13 @@ exports.ResourceImageType = void 0;
 exports.CountryCode = void 0;
 (function (CountryCode) {
   CountryCode["TWN"] = "TWN";
-  CountryCode["JPW"] = "JP";
+  CountryCode["JPN"] = "JPN";
+  CountryCode["ZAF"] = "ZAF";
+  CountryCode["USA"] = "USA";
+  CountryCode["CHN"] = "CHN";
+  CountryCode["PHL"] = "PHL";
+  CountryCode["GBR"] = "GBR";
+  CountryCode["KOR"] = "KOR";
 })(exports.CountryCode || (exports.CountryCode = {}));
 exports.IdRecognitionCardType = void 0;
 (function (IdRecognitionCardType) {
@@ -140,6 +148,67 @@ const RECOGNITION_COLUMNS_ORDER = Object.fromEntries(['surname', 'givenName', 'n
 function getCardSubTypes(type, country) {
   return CardTypeMapping[type];
 }
+function cardTypeTitle(cardType) {
+  if (cardType == null) {
+    return '';
+  }
+  const cardTypeLower = cardType.toLowerCase();
+  let titleKey = null;
+  if (cardTypeLower.indexOf('idcard') != -1) {
+    if (cardTypeLower.indexOf('front')) {
+      titleKey = 'verify.idCardFrontSide';
+    } else {
+      titleKey = 'verify.idCardBackSide';
+    }
+  } else if (cardTypeLower.indexOf('driverlicense') != -1) {
+    if (cardTypeLower.indexOf('front')) {
+      titleKey = 'verify.licenseFrontSide';
+    } else {
+      titleKey = 'verify.licenseBackSide';
+    }
+  } else if (cardTypeLower.indexOf('resident') != -1) {
+    if (cardTypeLower.indexOf('front')) {
+      titleKey = 'verify.residentCardFrontSide';
+    } else {
+      titleKey = 'verify.residentCardBackSide';
+    }
+  }
+  return titleKey;
+}
+function cardTypeConfirmTitle(cardType) {
+  if (cardType == null) {
+    return '';
+  }
+  const cardTypeLower = cardType.toLowerCase();
+  let titleKey = null;
+  if (cardTypeLower.indexOf('idcard') != -1) {
+    if (cardTypeLower.indexOf('front')) {
+      titleKey = 'verify.confirmIdCardFront';
+    } else {
+      titleKey = 'verify.confirmIdCardBack';
+    }
+  } else if (cardTypeLower.indexOf('driverlicense') != -1) {
+    if (cardTypeLower.indexOf('front')) {
+      titleKey = 'verify.confirmLicenseFront';
+    } else {
+      titleKey = 'verify.confirmLicenseBack';
+    }
+  } else if (cardTypeLower.indexOf('resident') != -1) {
+    if (cardTypeLower.indexOf('front')) {
+      titleKey = 'verify.confirmResidentCardFrontSide';
+    } else {
+      titleKey = 'verify.confirmResidentCardBackSide';
+    }
+  }
+  return titleKey;
+}
+function mapCardtypeToAuthmeClass(type) {
+  const known_type = Object.keys(engine.EAuthMeCardClass).filter(key => engine.EAuthMeCardClass[key].toString().toLowerCase() == ('EAuthMeCardClass_' + type).toLowerCase())[0];
+  if (known_type == null) {
+    return engine.EAuthMeCardClass.Unknown;
+  }
+  return engine.EAuthMeCardClass[known_type];
+}
 function getRecognitionColumnOrder(column) {
   var _a;
   return (_a = RECOGNITION_COLUMNS_ORDER[column]) !== null && _a !== void 0 ? _a : Number.MAX_VALUE;
@@ -157,12 +226,30 @@ const twoWayAuthmeCardClassMap = (() => {
   };
 })();
 
-function init(type, country, needConfirm, encrypt = true) {
+var name = "authme/sdk";
+var version$1 = "2.4.7";
+var date = "2023-12-14T08:29:41+0000";
+var packageInfo = {
+	name: name,
+	version: version$1,
+	date: date
+};
+
+function init(type, country, needConfirm, cardTypes, encrypt = true) {
+  let useCardTypes = getCardSubTypes(type).map(c => twoWayAuthmeCardClassMap.toServer(c));
+  if (cardTypes.length) {
+    useCardTypes = cardTypes;
+  }
   const body = {
     scanType: type === exports.IdRecognitionCardType.Passport ? type : `${country}_${type}`,
-    cardTypes: getCardSubTypes(type).map(c => twoWayAuthmeCardClassMap.toServer(c)),
+    cardTypes: useCardTypes,
     needConfirm,
-    encrypt
+    encrypt,
+    clientInfo: {
+      os: 'web',
+      os_ver: util.osVersion(),
+      client_ver: packageInfo.version
+    }
   };
   return core.sendRequest('/api/identity-verification/id-recognition/v3/init-scan', 'POST', {
     body: JSON.stringify(body)
@@ -283,17 +370,6 @@ function saveExtraDoc(params) {
   });
 }
 
-var name = "@authme/id-recognition";
-var version$1 = "2.4.6";
-var peerDependencies = {
-	"core-js": "^3.6.0"
-};
-var packageInfo = {
-	name: name,
-	version: version$1,
-	peerDependencies: peerDependencies
-};
-
 var _a;
 var _b, _c;
 const version = packageInfo.version;
@@ -332,12 +408,15 @@ exports.CardOCR = CardOCR;
 exports.IdCardAntiFraudService = IdCardAntiFraudService;
 exports.IdTypeConfig = IdTypeConfig;
 exports.MRZService = MRZService;
+exports.cardTypeConfirmTitle = cardTypeConfirmTitle;
+exports.cardTypeTitle = cardTypeTitle;
 exports.confirmScan = confirmScan;
 exports.finishScanDocument = finishScanDocument;
 exports.getCardSubTypes = getCardSubTypes;
 exports.getRecognitionColumnOrder = getRecognitionColumnOrder;
 exports.init = init;
 exports.initScanDocument = initScanDocument;
+exports.mapCardtypeToAuthmeClass = mapCardtypeToAuthmeClass;
 exports.recognition = recognition;
 exports.recognitionEncrypt = recognitionEncrypt;
 exports.saveExtraDoc = saveExtraDoc;

package/index.js

@@ -3,8 +3,10 @@ import { AuthmeEngineModuleBase, EAuthMeCardClass, EngineModule } from '@authme/
 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/es.regexp.to-string.js';
 import 'core-js/modules/web.dom-collections.iterator.js';
 import { sendRequest, AuthmeError } from '@authme/core';
+import { osVersion } from '@authme/util';
 import 'core-js/modules/es.symbol.description.js';
 
 var ResourceImageType;
@@ -16,7 +18,13 @@ var ResourceImageType;
 var CountryCode;
 (function (CountryCode) {
   CountryCode["TWN"] = "TWN";
-  CountryCode["JPW"] = "JP";
+  CountryCode["JPN"] = "JPN";
+  CountryCode["ZAF"] = "ZAF";
+  CountryCode["USA"] = "USA";
+  CountryCode["CHN"] = "CHN";
+  CountryCode["PHL"] = "PHL";
+  CountryCode["GBR"] = "GBR";
+  CountryCode["KOR"] = "KOR";
 })(CountryCode || (CountryCode = {}));
 var IdRecognitionCardType;
 (function (IdRecognitionCardType) {
@@ -137,6 +145,67 @@ const RECOGNITION_COLUMNS_ORDER = Object.fromEntries(['surname', 'givenName', 'n
 function getCardSubTypes(type, country) {
   return CardTypeMapping[type];
 }
+function cardTypeTitle(cardType) {
+  if (cardType == null) {
+    return '';
+  }
+  const cardTypeLower = cardType.toLowerCase();
+  let titleKey = null;
+  if (cardTypeLower.indexOf('idcard') != -1) {
+    if (cardTypeLower.indexOf('front')) {
+      titleKey = 'verify.idCardFrontSide';
+    } else {
+      titleKey = 'verify.idCardBackSide';
+    }
+  } else if (cardTypeLower.indexOf('driverlicense') != -1) {
+    if (cardTypeLower.indexOf('front')) {
+      titleKey = 'verify.licenseFrontSide';
+    } else {
+      titleKey = 'verify.licenseBackSide';
+    }
+  } else if (cardTypeLower.indexOf('resident') != -1) {
+    if (cardTypeLower.indexOf('front')) {
+      titleKey = 'verify.residentCardFrontSide';
+    } else {
+      titleKey = 'verify.residentCardBackSide';
+    }
+  }
+  return titleKey;
+}
+function cardTypeConfirmTitle(cardType) {
+  if (cardType == null) {
+    return '';
+  }
+  const cardTypeLower = cardType.toLowerCase();
+  let titleKey = null;
+  if (cardTypeLower.indexOf('idcard') != -1) {
+    if (cardTypeLower.indexOf('front')) {
+      titleKey = 'verify.confirmIdCardFront';
+    } else {
+      titleKey = 'verify.confirmIdCardBack';
+    }
+  } else if (cardTypeLower.indexOf('driverlicense') != -1) {
+    if (cardTypeLower.indexOf('front')) {
+      titleKey = 'verify.confirmLicenseFront';
+    } else {
+      titleKey = 'verify.confirmLicenseBack';
+    }
+  } else if (cardTypeLower.indexOf('resident') != -1) {
+    if (cardTypeLower.indexOf('front')) {
+      titleKey = 'verify.confirmResidentCardFrontSide';
+    } else {
+      titleKey = 'verify.confirmResidentCardBackSide';
+    }
+  }
+  return titleKey;
+}
+function mapCardtypeToAuthmeClass(type) {
+  const known_type = Object.keys(EAuthMeCardClass).filter(key => EAuthMeCardClass[key].toString().toLowerCase() == ('EAuthMeCardClass_' + type).toLowerCase())[0];
+  if (known_type == null) {
+    return EAuthMeCardClass.Unknown;
+  }
+  return EAuthMeCardClass[known_type];
+}
 function getRecognitionColumnOrder(column) {
   var _a;
   return (_a = RECOGNITION_COLUMNS_ORDER[column]) !== null && _a !== void 0 ? _a : Number.MAX_VALUE;
@@ -154,12 +223,30 @@ const twoWayAuthmeCardClassMap = (() => {
   };
 })();
 
-function init(type, country, needConfirm, encrypt = true) {
+var name = "authme/sdk";
+var version$1 = "2.4.7";
+var date = "2023-12-14T08:29:41+0000";
+var packageInfo = {
+	name: name,
+	version: version$1,
+	date: date
+};
+
+function init(type, country, needConfirm, cardTypes, encrypt = true) {
+  let useCardTypes = getCardSubTypes(type).map(c => twoWayAuthmeCardClassMap.toServer(c));
+  if (cardTypes.length) {
+    useCardTypes = cardTypes;
+  }
   const body = {
     scanType: type === IdRecognitionCardType.Passport ? type : `${country}_${type}`,
-    cardTypes: getCardSubTypes(type).map(c => twoWayAuthmeCardClassMap.toServer(c)),
+    cardTypes: useCardTypes,
     needConfirm,
-    encrypt
+    encrypt,
+    clientInfo: {
+      os: 'web',
+      os_ver: osVersion(),
+      client_ver: packageInfo.version
+    }
   };
   return sendRequest('/api/identity-verification/id-recognition/v3/init-scan', 'POST', {
     body: JSON.stringify(body)
@@ -280,21 +367,10 @@ function saveExtraDoc(params) {
   });
 }
 
-var name = "@authme/id-recognition";
-var version$1 = "2.4.6";
-var peerDependencies = {
-	"core-js": "^3.6.0"
-};
-var packageInfo = {
-	name: name,
-	version: version$1,
-	peerDependencies: peerDependencies
-};
-
 var _a;
 var _b, _c;
 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, RecognitionFileType, ResourceImageType, ServerSideEAuthMeCardClass, confirmScan, finishScanDocument, getCardSubTypes, getRecognitionColumnOrder, init, initScanDocument, recognition, recognitionEncrypt, saveExtraDoc, saveResourceImage, twoWayAuthmeCardClassMap, uploadFrameBase64, version };
+export { CardOCR, CountryCode, IdCardAntiFraudService, IdRecognitionCardType, IdType, IdTypeConfig, MRZService, RecognitionFileType, ResourceImageType, ServerSideEAuthMeCardClass, cardTypeConfirmTitle, cardTypeTitle, confirmScan, finishScanDocument, getCardSubTypes, getRecognitionColumnOrder, init, initScanDocument, mapCardtypeToAuthmeClass, recognition, recognitionEncrypt, saveExtraDoc, saveResourceImage, twoWayAuthmeCardClassMap, uploadFrameBase64, version };

package/package.json

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

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

@@ -1,7 +1,7 @@
-import { CountryCode, IdRecognitionCardType, RecognitionFileType, ResourceImageType, ServerSideEAuthMeCardClass } from '../enum';
+import { CountryCode, IdRecognitionCardType, RecognitionFileType, ResourceImageType } from '../enum';
 import { InitScanResponse } from '../model';
-export declare function init(type: IdRecognitionCardType, country: CountryCode, needConfirm: boolean, encrypt?: boolean): Promise<InitScanResponse>;
-export declare function initScanDocument(scanId: string, cardType: `${ServerSideEAuthMeCardClass}`): Promise<{
+export declare function init(type: IdRecognitionCardType, country: CountryCode, needConfirm: boolean, cardTypes: string[], encrypt?: boolean): Promise<InitScanResponse>;
+export declare function initScanDocument(scanId: string, cardType: string): Promise<{
     scanDocumentId: string;
 }>;
 export declare function recognition(documentId: string, file: Blob): Promise<{

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

@@ -6,7 +6,13 @@ export declare enum ResourceImageType {
 }
 export declare enum CountryCode {
     TWN = "TWN",
-    JPW = "JP"
+    JPN = "JPN",
+    ZAF = "ZAF",
+    USA = "USA",
+    CHN = "CHN",
+    PHL = "PHL",
+    GBR = "GBR",
+    KOR = "KOR"
 }
 export declare enum IdRecognitionCardType {
     IDCard = "IDCard",

package/src/lib/util.d.ts

@@ -1,5 +1,8 @@
 import { CountryCode, EAuthMeCardClass, IdRecognitionCardType, ServerSideEAuthMeCardClass } from './enum';
 export declare function getCardSubTypes(type: IdRecognitionCardType, country: CountryCode): EAuthMeCardClass[];
+export declare function cardTypeTitle(cardType: string): any;
+export declare function cardTypeConfirmTitle(cardType: string): any;
+export declare function mapCardtypeToAuthmeClass(type: string): any;
 export declare function getRecognitionColumnOrder(column: string): number;
 export declare const twoWayAuthmeCardClassMap: {
     toServer(clientEnum: `${EAuthMeCardClass}`): `${ServerSideEAuthMeCardClass}`;