@authme/id-recognition 2.7.3 → 2.8.0

package/index.cjs

@@ -374,15 +374,15 @@ const twoWayAuthmeCardClassMap = (() => {
 })();
 
 var name = "authme/sdk";
-var version$1 = "2.7.3";
-var date = "2024-10-25T01:07:20+0000";
+var version$1 = "2.8.0";
+var date = "2025-01-13T09:38:31+0000";
 var packageInfo = {
 	name: name,
 	version: version$1,
 	date: date
 };
 
-function init(type, country, needConfirm, cardTypes, encrypt = true) {
+function initScan(type, country, needConfirm, cardTypes) {
   // let useCardTypes: any = getCardSubTypes(type, country).map((c) =>
   //   twoWayAuthmeCardClassMap.toServer(c)
   // );
@@ -394,32 +394,47 @@ function init(type, country, needConfirm, cardTypes, encrypt = true) {
     scanType: type === exports.IdRecognitionCardType.Passport ? `ALL_Passport` : `${country}_${type}`,
     cardTypes: useCardTypes,
     needConfirm,
-    encrypt,
     clientInfo: {
       os: 'web',
       os_ver: util.osVersion(),
       client_ver: packageInfo.version
     }
   };
+  const customParameters = util.Storage.getItem('customParameters');
+  if (customParameters) {
+    body['customParameters'] = customParameters;
+  }
   return core.sendRequest('/api/identity-verification/id-recognition/v3/init-scan', 'POST', {
     body: JSON.stringify(body)
   });
 }
-function initScanDocument(scanId, cardType) {
-  const body = {
-    scanId,
-    cardType
-  };
-  return core.sendRequest('/api/identity-verification/id-recognition/v3/init-scan-doc', 'POST', {
+// export function initScanDocument(
+//   scanId: string,
+//   cardType: string
+// ): Promise<InitScanDocumentParams> {
+function initScanDocument(body) {
+  // const body = {
+  //   scanId,
+  //   cardType,
+  // };
+  let encryptApiPath = '';
+  if (body.encryptedBase64String) {
+    encryptApiPath = `/encrypted`;
+  }
+  return core.sendRequest(`/api/identity-verification/id-recognition/v3/init-scan-doc${encryptApiPath}`, 'POST', {
     body: JSON.stringify(body)
   });
 }
-function initScanDocumentResourceBase64(scanId, ResourceId) {
-  const body = {
-    scanId,
-    ResourceId
-  };
-  return core.sendRequest('/api/identity-verification/id-recognition/v3/init-scan-doc/resource/base64', 'POST', {
+// export function initScanDocumentResourceBase64(
+//   scanId: string,
+//   ResourceId: string
+// ): Promise<InitScanDocumentResourceBase64Params> {
+function initScanDocumentResourceBase64(body) {
+  let encryptApiPath = '';
+  if (body.encryptedBase64String) {
+    encryptApiPath = `/encrypted`;
+  }
+  return core.sendRequest(`/api/identity-verification/id-recognition/v3/init-scan-doc/resource/base64${encryptApiPath}`, 'POST', {
     body: JSON.stringify(body)
   });
 }
@@ -441,16 +456,19 @@ 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
-      }
-    }),
+// export function recognizeBase64(
+//   documentId: string,
+//   base64Text: string,
+//   report: string,
+//   fileType: RecognitionFileType
+// ): Promise<{ retry?: boolean; details: { [key: string]: string | null } }> {
+function recognizeBase64(body) {
+  let encryptApiPath = '';
+  if (body.encryptedBase64String) {
+    encryptApiPath = `/encrypted`;
+  }
+  return core.sendRequest(`/api/identity-verification/id-recognition/v3/recognize-base64${encryptApiPath}`, 'POST', {
+    body: JSON.stringify(body),
     contentType: 'application/json'
   }).catch(error => {
     var _a, _b, _c;
@@ -463,18 +481,27 @@ function recognitionEncrypt(documentId, base64Text, report, fileType) {
     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
-      }
-    }),
+// export function uploadFrameBase64(
+//   documentId: string,
+//   base64Text: string,
+//   index: number,
+//   type: ResourceImageType = ResourceImageType.Recognition,
+//   report?: string
+// ): Promise<{ retry?: boolean; details: { [key: string]: string | null } }> {
+function uploadFrameBase64(body) {
+  let encryptApiPath = '';
+  if (body.encryptedBase64String) {
+    encryptApiPath = `/encrypted`;
+  }
+  return core.sendRequest(`/api/identity-verification/id-recognition/v3/upload-frame-base64${encryptApiPath}`, 'POST', {
+    // body: JSON.stringify({
+    //   scanDocumentId: documentId,
+    //   image: base64Text,
+    //   type,
+    //   // fileType: 'image/jpeg',
+    //   info: { report, index },
+    // }),
+    body: JSON.stringify(body),
     contentType: 'application/json'
   }).catch(error => {
     var _a, _b, _c;
@@ -497,22 +524,39 @@ function saveResourceImage(documentId, type, file) {
     contentType: 'multipart/form-data'
   });
 }
-function finishScanDocument(documentId, details, fraud) {
-  const body = {
-    scanDocumentId: documentId,
-    details,
-    fraud
-  };
-  return core.sendRequest('/api/identity-verification/id-recognition/v3/finish-scan-doc', 'POST', {
+// export function finishScanDocument(
+//   documentId: string,
+//   details: { [key: string]: string | null },
+//   fraud: boolean | null
+// ) {
+function finishScanDocument(body) {
+  // const body = {
+  //   scanDocumentId: documentId,
+  //   details,
+  //   fraud,
+  // };
+  let encryptApiPath = '';
+  if (body.encryptedBase64String) {
+    encryptApiPath = `/encrypted`;
+  }
+  return core.sendRequest(`/api/identity-verification/id-recognition/v3/finish-scan-doc${encryptApiPath}`, 'POST', {
     body: JSON.stringify(body)
   });
 }
-function confirmScan(scanId, details) {
-  const body = {
-    scanId,
-    details
-  };
-  return core.sendRequest('/api/identity-verification/id-recognition/v3/confirm-scan', 'POST', {
+// export function confirmScan(
+//   scanId: string,
+//   details: { [key: string]: string | null }
+// ) {
+function confirmScan(body) {
+  // const body = {
+  //   scanId,
+  //   details,
+  // };
+  let encryptApiPath = '';
+  if (body.encryptedBase64String) {
+    encryptApiPath = `/encrypted`;
+  }
+  return core.sendRequest(`/api/identity-verification/id-recognition/v3/confirm-scan${encryptApiPath}`, 'POST', {
     body: JSON.stringify(body)
   });
 }
@@ -528,6 +572,19 @@ function saveExtraDoc(params) {
     contentType: 'multipart/form-data'
   });
 }
+function logCollect(message, stackTrace) {
+  const body = {
+    message: message,
+    stack_trace: stackTrace,
+    metadata: {
+      platform: 'web',
+      sdkVersion: packageInfo.version
+    }
+  };
+  return core.sendRequest('/api/identity-verification/v1/logs/collect', 'POST', {
+    body: JSON.stringify(body)
+  });
+}
 
 var _a;
 var _b, _c;
@@ -575,12 +632,13 @@ exports.finishScanDocument = finishScanDocument;
 exports.getCardSubTypes = getCardSubTypes;
 exports.getCardTypes = getCardTypes;
 exports.getRecognitionColumnOrder = getRecognitionColumnOrder;
-exports.init = init;
+exports.initScan = initScan;
 exports.initScanDocument = initScanDocument;
 exports.initScanDocumentResourceBase64 = initScanDocumentResourceBase64;
+exports.logCollect = logCollect;
 exports.mapCardtypeToAuthmeClass = mapCardtypeToAuthmeClass;
 exports.recognition = recognition;
-exports.recognitionEncrypt = recognitionEncrypt;
+exports.recognizeBase64 = recognizeBase64;
 exports.saveExtraDoc = saveExtraDoc;
 exports.saveResourceImage = saveResourceImage;
 exports.thicknessDefaultConfig = thicknessDefaultConfig;

package/index.js

@@ -5,7 +5,7 @@ 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';
 import { sendRequest, AuthmeError } from '@authme/core';
-import { osVersion } from '@authme/util';
+import { osVersion, Storage } from '@authme/util';
 import 'core-js/modules/es.symbol.description.js';
 
 var ResourceImageType;
@@ -371,15 +371,15 @@ const twoWayAuthmeCardClassMap = (() => {
 })();
 
 var name = "authme/sdk";
-var version$1 = "2.7.3";
-var date = "2024-10-25T01:07:20+0000";
+var version$1 = "2.8.0";
+var date = "2025-01-13T09:38:31+0000";
 var packageInfo = {
 	name: name,
 	version: version$1,
 	date: date
 };
 
-function init(type, country, needConfirm, cardTypes, encrypt = true) {
+function initScan(type, country, needConfirm, cardTypes) {
   // let useCardTypes: any = getCardSubTypes(type, country).map((c) =>
   //   twoWayAuthmeCardClassMap.toServer(c)
   // );
@@ -391,32 +391,47 @@ function init(type, country, needConfirm, cardTypes, encrypt = true) {
     scanType: type === IdRecognitionCardType.Passport ? `ALL_Passport` : `${country}_${type}`,
     cardTypes: useCardTypes,
     needConfirm,
-    encrypt,
     clientInfo: {
       os: 'web',
       os_ver: osVersion(),
       client_ver: packageInfo.version
     }
   };
+  const customParameters = Storage.getItem('customParameters');
+  if (customParameters) {
+    body['customParameters'] = customParameters;
+  }
   return sendRequest('/api/identity-verification/id-recognition/v3/init-scan', 'POST', {
     body: JSON.stringify(body)
   });
 }
-function initScanDocument(scanId, cardType) {
-  const body = {
-    scanId,
-    cardType
-  };
-  return sendRequest('/api/identity-verification/id-recognition/v3/init-scan-doc', 'POST', {
+// export function initScanDocument(
+//   scanId: string,
+//   cardType: string
+// ): Promise<InitScanDocumentParams> {
+function initScanDocument(body) {
+  // const body = {
+  //   scanId,
+  //   cardType,
+  // };
+  let encryptApiPath = '';
+  if (body.encryptedBase64String) {
+    encryptApiPath = `/encrypted`;
+  }
+  return sendRequest(`/api/identity-verification/id-recognition/v3/init-scan-doc${encryptApiPath}`, 'POST', {
     body: JSON.stringify(body)
   });
 }
-function initScanDocumentResourceBase64(scanId, ResourceId) {
-  const body = {
-    scanId,
-    ResourceId
-  };
-  return sendRequest('/api/identity-verification/id-recognition/v3/init-scan-doc/resource/base64', 'POST', {
+// export function initScanDocumentResourceBase64(
+//   scanId: string,
+//   ResourceId: string
+// ): Promise<InitScanDocumentResourceBase64Params> {
+function initScanDocumentResourceBase64(body) {
+  let encryptApiPath = '';
+  if (body.encryptedBase64String) {
+    encryptApiPath = `/encrypted`;
+  }
+  return sendRequest(`/api/identity-verification/id-recognition/v3/init-scan-doc/resource/base64${encryptApiPath}`, 'POST', {
     body: JSON.stringify(body)
   });
 }
@@ -438,16 +453,19 @@ 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
-      }
-    }),
+// export function recognizeBase64(
+//   documentId: string,
+//   base64Text: string,
+//   report: string,
+//   fileType: RecognitionFileType
+// ): Promise<{ retry?: boolean; details: { [key: string]: string | null } }> {
+function recognizeBase64(body) {
+  let encryptApiPath = '';
+  if (body.encryptedBase64String) {
+    encryptApiPath = `/encrypted`;
+  }
+  return sendRequest(`/api/identity-verification/id-recognition/v3/recognize-base64${encryptApiPath}`, 'POST', {
+    body: JSON.stringify(body),
     contentType: 'application/json'
   }).catch(error => {
     var _a, _b, _c;
@@ -460,18 +478,27 @@ function recognitionEncrypt(documentId, base64Text, report, fileType) {
     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
-      }
-    }),
+// export function uploadFrameBase64(
+//   documentId: string,
+//   base64Text: string,
+//   index: number,
+//   type: ResourceImageType = ResourceImageType.Recognition,
+//   report?: string
+// ): Promise<{ retry?: boolean; details: { [key: string]: string | null } }> {
+function uploadFrameBase64(body) {
+  let encryptApiPath = '';
+  if (body.encryptedBase64String) {
+    encryptApiPath = `/encrypted`;
+  }
+  return sendRequest(`/api/identity-verification/id-recognition/v3/upload-frame-base64${encryptApiPath}`, 'POST', {
+    // body: JSON.stringify({
+    //   scanDocumentId: documentId,
+    //   image: base64Text,
+    //   type,
+    //   // fileType: 'image/jpeg',
+    //   info: { report, index },
+    // }),
+    body: JSON.stringify(body),
     contentType: 'application/json'
   }).catch(error => {
     var _a, _b, _c;
@@ -494,22 +521,39 @@ function saveResourceImage(documentId, type, file) {
     contentType: 'multipart/form-data'
   });
 }
-function finishScanDocument(documentId, details, fraud) {
-  const body = {
-    scanDocumentId: documentId,
-    details,
-    fraud
-  };
-  return sendRequest('/api/identity-verification/id-recognition/v3/finish-scan-doc', 'POST', {
+// export function finishScanDocument(
+//   documentId: string,
+//   details: { [key: string]: string | null },
+//   fraud: boolean | null
+// ) {
+function finishScanDocument(body) {
+  // const body = {
+  //   scanDocumentId: documentId,
+  //   details,
+  //   fraud,
+  // };
+  let encryptApiPath = '';
+  if (body.encryptedBase64String) {
+    encryptApiPath = `/encrypted`;
+  }
+  return sendRequest(`/api/identity-verification/id-recognition/v3/finish-scan-doc${encryptApiPath}`, 'POST', {
     body: JSON.stringify(body)
   });
 }
-function confirmScan(scanId, details) {
-  const body = {
-    scanId,
-    details
-  };
-  return sendRequest('/api/identity-verification/id-recognition/v3/confirm-scan', 'POST', {
+// export function confirmScan(
+//   scanId: string,
+//   details: { [key: string]: string | null }
+// ) {
+function confirmScan(body) {
+  // const body = {
+  //   scanId,
+  //   details,
+  // };
+  let encryptApiPath = '';
+  if (body.encryptedBase64String) {
+    encryptApiPath = `/encrypted`;
+  }
+  return sendRequest(`/api/identity-verification/id-recognition/v3/confirm-scan${encryptApiPath}`, 'POST', {
     body: JSON.stringify(body)
   });
 }
@@ -525,6 +569,19 @@ function saveExtraDoc(params) {
     contentType: 'multipart/form-data'
   });
 }
+function logCollect(message, stackTrace) {
+  const body = {
+    message: message,
+    stack_trace: stackTrace,
+    metadata: {
+      platform: 'web',
+      sdkVersion: packageInfo.version
+    }
+  };
+  return sendRequest('/api/identity-verification/v1/logs/collect', 'POST', {
+    body: JSON.stringify(body)
+  });
+}
 
 var _a;
 var _b, _c;
@@ -532,4 +589,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, IdRecognitionCardName, IdRecognitionCardType, IdType, IdTypeConfig, MRZService, RecognitionFileType, ResourceImageType, ServerSideEAuthMeCardClass, cardTypeConfirmTitle, cardTypeHeader, cardTypeTitle, confirmScan, finishScanDocument, getCardSubTypes, getCardTypes, getRecognitionColumnOrder, init, initScanDocument, initScanDocumentResourceBase64, mapCardtypeToAuthmeClass, recognition, recognitionEncrypt, saveExtraDoc, saveResourceImage, thicknessDefaultConfig, twoWayAuthmeCardClassMap, uploadFrameBase64, version };
+export { CardOCR, CountryCode, IdCardAntiFraudService, IdRecognitionCardName, IdRecognitionCardType, IdType, IdTypeConfig, MRZService, RecognitionFileType, ResourceImageType, ServerSideEAuthMeCardClass, cardTypeConfirmTitle, cardTypeHeader, cardTypeTitle, confirmScan, finishScanDocument, getCardSubTypes, getCardTypes, getRecognitionColumnOrder, initScan, initScanDocument, initScanDocumentResourceBase64, logCollect, mapCardtypeToAuthmeClass, recognition, recognizeBase64, saveExtraDoc, saveResourceImage, thicknessDefaultConfig, twoWayAuthmeCardClassMap, uploadFrameBase64, version };

package/package.json

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

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

@@ -11,33 +11,73 @@ interface InitScanDocumentResourceBase64Params {
     fileId: string;
     data: string;
 }
-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<InitScanDocumentParams>;
-export declare function initScanDocumentResourceBase64(scanId: string, ResourceId: string): Promise<InitScanDocumentResourceBase64Params>;
+export declare function initScan(type: IdRecognitionCardType, country: CountryCode, needConfirm: boolean, cardTypes: string[]): Promise<InitScanResponse>;
+export declare function initScanDocument(body: {
+    scanId?: string;
+    cardType?: string;
+    id?: string;
+    encryptedBase64String?: string;
+}): Promise<InitScanDocumentParams>;
+export declare function initScanDocumentResourceBase64(body: {
+    scanId?: string;
+    ResourceId?: string;
+    id?: string;
+    encryptedBase64String?: string;
+}): Promise<InitScanDocumentResourceBase64Params>;
 export declare function recognition(documentId: string, file: Blob): Promise<{
     retry?: boolean;
     details: {
         [key: string]: string | null;
     };
 }>;
-export declare function recognitionEncrypt(documentId: string, base64Text: string, report: string, fileType: RecognitionFileType): Promise<{
+export declare function recognizeBase64(body: {
+    scanDocumentId?: string;
+    image?: string;
+    fileType?: RecognitionFileType;
+    info?: {
+        report: string;
+    };
+    id?: string;
+    encryptedBase64String?: string;
+}): Promise<{
     retry?: boolean;
     details: {
         [key: string]: string | null;
     };
 }>;
-export declare function uploadFrameBase64(documentId: string, base64Text: string, index: number, type?: ResourceImageType, report?: string): Promise<{
+export declare function uploadFrameBase64(body: {
+    scanDocumentId?: string;
+    image?: string;
+    type?: ResourceImageType;
+    info?: {
+        report?: string;
+        index: number;
+    };
+    id?: string;
+    encryptedBase64String?: 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;
-}, fraud: boolean | null): Promise<any>;
-export declare function confirmScan(scanId: string, details: {
-    [key: string]: string | null;
+export declare function finishScanDocument(body: {
+    scanDocumentId?: string;
+    details?: {
+        [key: string]: string | null;
+    };
+    fraud?: boolean | null;
+    id?: string;
+    encryptedBase64String?: string;
+}): Promise<any>;
+export declare function confirmScan(body: {
+    scanId?: string;
+    details?: {
+        [key: string]: string | null;
+    };
+    id?: string;
+    encryptedBase64String?: string;
 }): Promise<any>;
 export declare function saveExtraDoc(params: {
     file: Blob;
@@ -45,4 +85,5 @@ export declare function saveExtraDoc(params: {
         [key: string]: string | null;
     };
 }): Promise<any>;
+export declare function logCollect(message: string, stackTrace: string): Promise<any>;
 export {};

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

@@ -8,6 +8,7 @@ export declare type IdRecognitionInfoConfirmRequest = IdRecognitionResponse;
 export interface InitScanResponse {
     scanId: string;
     expiredIn: number;
+    shouldEncrypt: boolean;
     parameters: {
         enableManualUpload: boolean;
         fraudRetryTimes: number;