@authme/engine 2.2.0 → 2.2.1-rc.1

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [2.2.1-rc.1](https://github.com/AuthMe01/web-client-sdk/compare/v2.2.1-rc.0...v2.2.1-rc.1) (2022-12-28)
+
+### Features
+
+- upgrade engine to 5.1.0 ([26e2128](https://github.com/AuthMe01/web-client-sdk/commit/26e2128026edf36c4b54efdf61b339a2f755a528))
+
+### Bug Fixes
+
+- inconsistency enum (or remove unused) ([b716f14](https://github.com/AuthMe01/web-client-sdk/commit/b716f142fa20d2eebf0af66ff27f858ef1e825b0))
+
+## [2.2.1-rc.0](https://github.com/AuthMe01/web-client-sdk/compare/v2.2.0...v2.2.1-rc.0) (2022-12-22)
+
+### Features
+
+- implement preloadBackground feature ([4b58a16](https://github.com/AuthMe01/web-client-sdk/commit/4b58a16dbdd506d48ce9f9671d8154997f4b9839))
+
+### Bug Fixes
+
+- engine destroy fail problem ([e2ffc84](https://github.com/AuthMe01/web-client-sdk/commit/e2ffc843cafb2c414535be6d735957e1a04b7146))
+
 ## [2.2.0](https://github.com/AuthMe01/web-client-sdk/compare/v2.2.0-rc.13...v2.2.0) (2022-12-19)
 
 ## [2.2.0-rc.13](https://github.com/AuthMe01/web-client-sdk/compare/v2.2.0-rc.12...v2.2.0-rc.13) (2022-12-19)

package/assets/engine-worker.js

@@ -68,8 +68,14 @@
 
   // Base
   const baseFunctions = {
-    instance: null,
-    sessions: {},
+    // 由於不同 service 間的 _loadedSessions instance 是隔離開來的，
+    // 所以不能將 _loadedSessions: {} 直接放到這裡，
+    // 否則會造成 destroy 異常。
+    // 更好的做法會是用 class 替代現在的做法，只是改的幅度偏大，
+    // 所以暫時保留現有的做法。
+    _getLoadedModelKey({ modelVersion: { name, version } }) {
+      return `${name}#${version}`;
+    },
     _getModelVersions(constructorName) {
       const versionVector =
         self.EngineLib[constructorName]['getModelVersion']();
@@ -83,27 +89,34 @@
       }
       return models;
     },
+    _getNoLoadedModelVersions(constructorName) {
+      const modelVersions = this._getModelVersions(constructorName);
+      return modelVersions.filter(
+        (modelVersion) =>
+          !this._loadedSessions[this._getLoadedModelKey({ modelVersion })]
+      );
+    },
 
     // worker 專心處理 cpu 密集 (model 載入) 的工作，
     // 至於純 IO 下載的任務就交給 main thread 處理就好。
-    loadModel({ modelName, modelArrayBuffer }) {
+    loadSession({ modelVersion: { name, version }, modelArrayBuffer }) {
       let fileMounted = false;
       try {
         const FS = self.EngineLib.FS;
-        FS.mkdir(`/${modelName}/`);
+        FS.mkdir(`/${name}-${version}/`);
         FS.mount(
           FS.filesystems.WORKERFS,
           {
             blobs: [
               {
-                name: modelName,
+                name: `${name}-${version}`,
                 data: new Blob([modelArrayBuffer], {
                   type: 'application/octet-stream',
                 }),
               },
             ],
           },
-          `/${modelName}/`
+          `/${name}-${version}/`
         );
         fileMounted = true;
       } catch (error) {
@@ -116,11 +129,17 @@
       }
 
       if (fileMounted) {
-        const session = self.EngineLib.createInferenceSession(
-          modelName,
-          `/${modelName}/${modelName}`
-        );
-        this.sessions[modelName] = session;
+        const sessionKey = this._getLoadedModelKey({
+          modelVersion: { name, version },
+        });
+        if (this._loadedSessions[sessionKey]) {
+          throw new Error('should be undefined here.');
+        }
+        this._loadedSessions[sessionKey] =
+          self.EngineLib.createInferenceSession(
+            name,
+            `/${name}-${version}/${name}-${version}`
+          );
       }
     },
     async _init(constructorName) {
@@ -131,7 +150,10 @@
             const instance = new self.EngineLib[constructorName]();
             instance.initial(
               ...this._getModelVersions(constructorName).map(
-                ({ name }) => this.sessions[name]
+                (modelVersion) =>
+                  this._loadedSessions[
+                    this._getLoadedModelKey({ modelVersion })
+                  ]
               )
             );
             const engine = instance;
@@ -224,10 +246,10 @@
         this.instance.delete();
         this.instance = null;
       }
-      for (const session of Object.values(this.sessions)) {
+      for (const session of Object.values(this._loadedSessions)) {
         self.EngineLib.deleteSession(session);
       }
-      this.sessions = {};
+      this._loadedSessions = {};
     },
     getJsonReport() {
       return this.instance?.getJsonReport();
@@ -236,10 +258,12 @@
 
   // PassportService
   self.PassportService = {
+    instance: null,
+    _loadedSessions: {},
     ...baseFunctions,
 
-    getModelVersions() {
-      return this._getModelVersions('PassportService');
+    getNoLoadedModelVersions() {
+      return this._getNoLoadedModelVersions('PassportService');
     },
     init() {
       return this._init('PassportService');
@@ -272,10 +296,12 @@
 
   // Card OCR
   self.CardOCR = {
+    instance: null,
+    _loadedSessions: {},
     ...baseFunctions,
 
-    getModelVersions() {
-      return this._getModelVersions('CardOCR');
+    getNoLoadedModelVersions() {
+      return this._getNoLoadedModelVersions('CardOCR');
     },
     init() {
       return this._init('CardOCR');
@@ -296,12 +322,14 @@
       }
       return result;
     },
-    setType(params) {
+    setType({ type }) {
       const engine = this.instance;
       if (engine) {
         const engineParams = engine.getParams();
         engineParams.eTargetCardType =
-          self.EngineLib.EAuthMeCardClass.values[params.type];
+          self.EngineLib.EAuthMeCardClass[
+            type.replace(/^EAuthMeCardClass_/, '')
+          ];
         engineParams.fImageBlurTh = 750;
         engine.setParams(engineParams);
         return true;
@@ -325,10 +353,12 @@
 
   // Id Card Anti Fraud
   self.IdCardAntiFraud = {
+    instance: null,
+    _loadedSessions: {},
     ...baseFunctions,
 
-    getModelVersions() {
-      return this._getModelVersions('IdCardAntiFraudService');
+    getNoLoadedModelVersions() {
+      return this._getNoLoadedModelVersions('IdCardAntiFraudService');
     },
     async init() {
       await this._init('IdCardAntiFraudService');
@@ -382,10 +412,12 @@
   };
 
   self.Fas = {
+    instance: null,
+    _loadedSessions: {},
     ...baseFunctions,
 
-    getModelVersions() {
-      return this._getModelVersions('CFASService');
+    getNoLoadedModelVersions() {
+      return this._getNoLoadedModelVersions('CFASService');
     },
     init() {
       return this._init('CFASService');
@@ -448,6 +480,27 @@
       }
       return false;
     },
+    checkEnumConsistency(enums) {
+      const problem = [];
+      for (const [enumName, enumDef] of Object.entries(enums)) {
+        const actualEnumDef = self.EngineLib[enumName];
+        const actualEnumValues = actualEnumDef?.values ?? {};
+        const actualEnumMap = Object.fromEntries(
+          Object.values(actualEnumValues).map((enumValue) => [
+            enumValue.constructor.name,
+            enumValue.value,
+          ])
+        );
+
+        for (const [key, engineKey] of Object.entries(enumDef)) {
+          const actualValue = actualEnumMap[engineKey];
+          if (typeof actualValue === 'undefined') {
+            problem.push({ enumName, key, engineKey, actualEnumMap });
+          }
+        }
+      }
+      return problem;
+    },
   };
 
   addEventListener(