@anytestforpm/ocr 1.2.0

package/README.md

@@ -0,0 +1,56 @@
+# Install
+npm i @anytestforpm/ocr
+# Usage Example 
+1.初始化OCR設定，取得后台設定檔  
+```javascript
+import { initOCR } from '@anytestforpm/ocr';
+
+mounted() {  
+  //init ocr config , region support VN IN ID BR
+  if (process.env.NODE_ENV === 'production') {  
+    initOCR('VN','https://your-api-domain');
+  } else { 
+    initOCR('VN','https://your-api-domain');
+  } 
+},
+```
+2.執行OCR圖片辨識  
+```javascript
+import { recognizeOCR, RESULT_TYPE } from '@anytestforpm/ocr';
+
+try {
+  let ocrResData = await recognizeOCR(imgUrl);
+  //取得后台設定檔失敗
+  if (ocrResData.type === RESULT_TYPE.CONFIG_INVALID) {
+    //do something
+  }
+  //圖片辨識功能已停用
+  if (ocrResData.type === RESULT_TYPE.CONFIG_DISABLED) {
+    //do something
+  }
+  //驗證成功
+  if (ocrResData.type === RESULT_TYPE.KEYWORDS_SUCCESS) {
+    //do something
+  }
+  //驗證不合格 - 關鍵字匹配不合格
+  if (ocrResData.type === RESULT_TYPE.KEYWORDS_NOT_FOUND) {
+    //do something
+  }
+  //驗證不合格 - 不合法的關鍵字
+  if (ocrResData.type === RESULT_TYPE.KEYWORDS_INVALID) {
+    //do something
+  }
+  //驗證超時
+  if (ocrResData.type === RESULT_TYPE.KEYWORDS_TIMEOUT) {
+    //do something
+  }  
+} catch (execption) {
+  //do something
+}
+
+```
+3.入參imgUrl  
+let ocrResData = await recognizeOCR(imgUrl);  
+mixins.js 
+![action](https://drive.google.com/uc?export=view&id=1glB1dtkpb344ezPqzzZFjrY85epR2HCh)
+    

package/ocr.js

@@ -0,0 +1,183 @@
+
+import { createWorker } from 'tesseract.js';
+import axios from 'axios'
+var md5 = require('md5');
+
+var configData = null; //configuration file returned by API
+
+const OCR_LANGUAGE_MAP = {
+  VN: "vie",
+  ID: "ind",
+  IN: "hin",
+  BR: "por",
+  EN: "eng"
+}
+
+const setResponseData = (val) => {
+  return {
+    type: val
+  };
+}
+
+export const RESULT_TYPE = {
+  KEYWORDS_SUCCESS: "SUCCESS",
+  KEYWORDS_NOT_FOUND: "NOT_FOUND",
+  KEYWORDS_INVALID: "INVALID",
+  KEYWORDS_TIMEOUT: "TIMEOUT",
+  KEYWORDS_EXCEPTION: "EXCEPTION",
+  CONFIG_INVALID: "CONFIG_INVALID",
+  CONFIG_DISABLED: "CONFIG_DISABLED",
+}
+
+/**
+ * @description for testing
+ * @param {String} val
+ */
+export const hello = (val) => {
+  return 'Hello,' + val;
+}
+
+/**
+ * @description initialization ocr config
+ * @param {String} region area of config
+ */
+export const initOCR = (region,apiHost) => {
+  try {
+    //sign
+    let timestamp = Math.fround(Date.now()/1000);
+    let hashString = md5(region+"."+timestamp).toUpperCase();
+    
+    //get config
+    configData = null;
+    axios({
+      url: apiHost,
+      method: "post",
+      timeout: 60000,
+      responseType: "json",
+      data: {
+        "region": region,
+        "timestamp": timestamp,
+        "sign": hashString
+      },
+    })
+      .then((res) => {
+        if (res.status === 200 && res.data.config.enable) {
+          configData = res.data;
+          console.log("Initialization successful");
+        }else  if (res.status === 200 && !res.data.config.enable) {
+          configData = res.data;
+          console.log("OCR service disabled");
+        }else {
+          console.log("Initialization failed");
+        }
+      })
+      .catch((error) => {
+        console.error(error)
+      });
+  } catch (error) {
+    console.error('exception: ', error);
+  }
+
+}
+
+/**
+ * @description start ocr recognize
+ * @param {String} ImageUrl image url
+ */
+export const recognizeOCR = async (ImageUrl) => {
+  
+  //初始化失敗
+  if (!configData) {
+    return new Promise((resolve, reject) => {
+      console.error(RESULT_TYPE.CONFIG_INVALID);
+      resolve(setResponseData(RESULT_TYPE.CONFIG_INVALID));
+    });
+  }
+  //后台停用辨識圖片功能
+  if (!configData.config.enable) {
+    return new Promise((resolve, reject) => {
+      console.error(RESULT_TYPE.CONFIG_DISABLED);
+      resolve(setResponseData(RESULT_TYPE.CONFIG_DISABLED));
+    });
+  }
+  
+  let ocr_setTimeout = null;
+  let startTime = new Date();
+  let worker = await createWorker(
+    {
+      logger: msg => {
+        console.log(new Date() - startTime, msg);
+      },
+    }
+  );
+
+  //OCR辨識過程中發生超時
+  const timeoutPromise = new Promise((resolve, reject) => {
+    ocr_setTimeout = setTimeout(() => {
+      console.error(RESULT_TYPE.KEYWORDS_TIMEOUT);
+      resolve(setResponseData(RESULT_TYPE.KEYWORDS_TIMEOUT));
+    }, configData.config.timeout_in_seconds * 1000); //设置超时时间
+  });
+
+  //OCR辨識
+  const ocrPromise = new Promise(async (resolve, reject) => {
+    try {
+      await worker.loadLanguage(OCR_LANGUAGE_MAP[configData.region]);
+      await worker.initialize(OCR_LANGUAGE_MAP[configData.region]);
+      
+      //OCR辨識結果的內文
+      const result = await worker.recognize(ImageUrl);
+      const resText = String(result.data.text);
+      console.log("OCR Text >>> ", resText);
+
+      //比對不合法的關鍵字
+      let invalidKeyWords = configData.keywords.invalid.filter((item) => resText.search(item) >= 0);
+      console.log("search invalid keywords result >>> ", invalidKeyWords);
+      if (invalidKeyWords.length != 0) {
+        resolve(setResponseData(RESULT_TYPE.KEYWORDS_INVALID));
+        return;
+      }
+
+      //比對合法的關鍵字
+      let validKeyWords = configData.keywords.valid.filter((item) => resText.search(item) >= 0);
+      console.log("search valid keywords result >>> ", validKeyWords);
+      if (validKeyWords.length >= configData.config.verify_in_counts) {
+        resolve(setResponseData(RESULT_TYPE.KEYWORDS_SUCCESS));
+        return;
+      }
+
+      //比對電話卡數字長度
+      if (configData.config.phone_number_in_continuous) {
+        let phoneCardLength = 0;
+        for (let val of resText.split("")) {
+          if (val === "\u0020") continue;
+          !isNaN(parseInt(val)) ? phoneCardLength++ : phoneCardLength = 0;
+          if (phoneCardLength >= configData.config.phone_number_in_continuous) break;
+        }
+        console.log("search phoneCard max Length result >>> ", phoneCardLength);
+        if (phoneCardLength >= configData.config.phone_number_in_continuous) {
+          resolve(setResponseData(RESULT_TYPE.KEYWORDS_SUCCESS));
+          return;
+        }
+      }
+      
+
+      //驗證失敗 沒有找到任何匹配的條件
+      console.log("verification failed , keywords not found");
+      resolve(setResponseData(RESULT_TYPE.KEYWORDS_NOT_FOUND));
+
+    } catch (error) {
+      reject(setResponseData(RESULT_TYPE.KEYWORDS_EXCEPTION));
+      console.error(error);
+    } finally {
+      
+      clearTimeout(ocr_setTimeout);
+      await worker.terminate();
+      worker = null;
+      //URL.revokeObjectURL(imagePath);
+      console.log('free up memory');
+    }
+  });
+
+  return Promise.race([ocrPromise, timeoutPromise]);
+}

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@anytestforpm/ocr",
+  "version": "1.2.0",
+  "description": "",
+  "main": "ocr.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^0.19.0",
+    "md5": "^2.3.0",
+    "tesseract.js": "^4.0.2"
+  }
+}