sonic-widget 2.5.1 → 2.5.2

package/README.md

@@ -1,14 +1,10 @@
-<center> 
-
-<h1> SONIC WIDGET </h1>
+# SONIC WIDGET
 
 [![version](https://img.shields.io/npm/v/sonic-widget?style=flat)](https://www.npmjs.com/package/sonic-widget)
 [![downloads](https://img.shields.io/npm/dm/sonic-widget?style=flat)](https://www.npmjs.com/package/sonic-widget)
 [![jsdelivr](https://data.jsdelivr.com/v1/package/npm/sonic-widget/badge)](https://www.jsdelivr.com/package/npm/sonic-widget)
 [![NPM](https://img.shields.io/npm/l/sonic-widget)](https://www.jsdelivr.com/package/npm/sonic-widget)
 
-</center>
-
 ## Installation:
 
 **Sonic Widget** - _used to show the onboard kyc at your web page itself._
@@ -16,7 +12,7 @@
 Use this script tag to get access to the widget:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.5.1/dist/index.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.5.2/dist/index.min.js"></script>
 ```
 
 or 
@@ -43,7 +39,7 @@ and adding path in `angular.json`
 2. Use this script tag to get access to the widget at initial html page:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.5.1/dist/index.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.5.2/dist/index.min.js"></script>
 ```
 
 or 
@@ -79,8 +75,11 @@ ngOnInit(): void {
 	
 	const config = {
 		baseurl: string, // the base url of the backend server
-		docModelUrl: string, // the doc model url of the document recognition process 
-		maskModelUrl: string, // the mask model url of the mask detect process
+		docModelPath: string, // the doc model url of the document recognition process 
+		maskModelPath: string, // the mask model url of the mask detect process
+		faceModelUrl: string, // the face model url of the face recognition process
+      	handModelUrl: string, // the hand model url of the hand recognition process
+      	objectModelUrl: string, // the object model url of the object recognition process
 		showPage: boolean, // used to show the page or not
 		speedCheckURL: string, // public URL of the internet speed check
 		videoURL: string, // url of video to do (e.g: demo doing kyc) (Optional)
@@ -232,7 +231,7 @@ it can be added in `angular.json` by installing the npm package
 4. Add a Script tag to the head tag or body tag. And use the latest version.
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.5.1/dist/index.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.5.2/dist/index.min.js"></script>
 ```
 
 5. Next, add the script tag at a necessary place. But add below the widget script.
@@ -241,8 +240,11 @@ it can be added in `angular.json` by installing the npm package
 <script>
 	const config = {
 		baseurl: string, // the base url of the backend server
-		docModelUrl: string, // the doc model url of the document recognition process
-		maskModelUrl: string, // the mask model url of the mask detect process
+		docModelPath: string, // the doc model url of the document recognition process
+		maskModelPath: string, // the mask model url of the mask detect process
+		faceModelUrl: string, // the face model url of the face recognition process
+      	handModelUrl: string, // the hand model url of the hand recognition process
+      	objectModelUrl: string, // the object model url of the object recognition process
 		showPage: boolean, // used to show the page or not
 		speedCheckURL: string, // public URL of the internet speed check
 		videoURL: string, // url of video to do (e.g: demo doing kyc) (Optional)
@@ -257,9 +259,9 @@ it can be added in `angular.json` by installing the npm package
 		isMalay: boolean, //used to change the default language english to malay
 		branchId: string, // branch id to identify the branch of the bank
 		sendLogsEmail: boolean, //used to send logs through email
-		blinkThreshold: number, // threshold used to calculate the user blinked or not, with range limit 0-1(default value is 0.35)
-		objectPersonThreshold: number, // used for object Person score threshold with range limit 0-1(default value is 0.35)
-		objectPhoneThreshold: number, // used for object Phone score threshold with range limit 0-1(default value is 0.35)
+		blinkThreshold: number, // threshold used to calculate the user blinked or not, with range limit 0-1(default value is 0.4)
+		objectPersonThreshold: number, // used for object Person score threshold with range limit 0-1(default value is 0.925)
+		objectPhoneThreshold: number, // used for object Phone score threshold with range limit 0-1(default value is 0.5)
 		onMessage: function (data) {}, // callback function, when api response message or error or any other actions
 	};
 	// get the element used in the action button 
@@ -290,8 +292,11 @@ Check with **`data.code`**_
 
 <!-- - _**`serviceWorkerPath`** should pass as a string value. It is used as the service worker path and its default path is **`/demo-app/assets/service-worker.js`** and Cache name should be different to fix conflict._ -->
 - _**`baseurl`** should pass as a string value. It is used as the base URL for API calls._
-- _**`docModelUrl`** should pass as a string value. It is used as the base URL for document model._
-- _**`maskModelUrl`** should pass as a string value. It is used as the base URL for mask model._
+- _**`docModelPath`** should pass as a string value. It is used as the base URL for document model._
+- _**`maskModelPath`** should pass as a string value. It is used as the base URL for mask model._
+- _**`faceModelUrl`** should pass as a string value. It is used as the base URL for task vision face model._
+- _**`handModelUrl`** should pass as a string value. It is used as the base URL for task vision hand model._
+- _**`objectModelUrl`** should pass as a string value. It is used as the base URL for coco-ssd object model._
 - _**`showPage`** is used to pass a boolean value ( **`true`** or **`false`** ). To toggle the widget page open or close._
 - _**`speedCheckURL`** should pass as a string value. It is used to detect internet speed and intimate the user._
 - _**`videoURL`** should pass as a string value as url. It is used to show the video onboard sonic kyc and it is optional._