sonic-widget 2.6.21 → 2.7.0

package/README.md

@@ -12,7 +12,7 @@
 Use this script tag to get access to the widget:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.6.21/dist/index.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.7.0/dist/index.min.js"></script>
 ```
 
 or 
@@ -39,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.6.21/dist/index.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.7.0/dist/index.min.js"></script>
 ```
 
 or 
@@ -97,8 +97,11 @@ ngOnInit(): void {
 		branchId: string, //used to identify the bank branch
 		sendLogsEmail: boolean, //used to send logs through email
 		blinkThreshold: number, // used for blink threshold
+		eyeOpenThreshold: number, // used for eye open threshold
+		disableUploadDocs: boolean, // used to show/hide the upload docs option.
 		objectPersonThreshold: number, // used for object Person score threshold
 		objectPhoneThreshold: number, // used for object Phone score threshold
+		grayscalePercentageThreshold: number, // used for black&white percentage score threshold
 		onMessage: function (data) {}, // callback function, when api response message or error or any other actions
 	};
 
@@ -233,7 +236,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.6.21/dist/index.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/sonic-widget@2.7.0/dist/index.min.js"></script>
 ```
 
 5. Next, add the script tag at a necessary place. But add below the widget script.
@@ -263,9 +266,12 @@ 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.4)
+		blinkThreshold: number, // threshold used to calculate the user's eye blinked or not, with range limit 0-1(default value is 0.35)
+		eyeOpenThreshold: number, // threshold used to calculate the user's eye open or not, with range limit 0-1(default value is 0.2)
+		disableUploadDocs: boolean, // used to pass a boolean value. It is used to disable the upload option the document process
 		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)
+		grayscalePercentageThreshold: number, // used for black&white percentage score threshold with range limit 0-100(default value is 80)
 		onMessage: function (data) {}, // callback function, when api response message or error or any other actions
 	};
 	// get the element used in the action button 
@@ -315,10 +321,58 @@ Check with **`data.code`**_
 - _**`phone`** should pass as a string value. It is used to create an application for onboard sonic kyc._
 - _**`applicationNo`** should pass as a string value. It is used to create an application for onboard sonic kyc._
 - _**`sendLogsEmail`** is used to pass a boolean value. It is used to send logs to client email address._
-- _**`blinkThreshold`** is used to pass a numerical value. It is used to check the user blinks (range 0-1 and default 0.5)._
+- _**`blinkThreshold`** is used to pass a numerical value. It is used to check the user blinking (range 0-1 and default 0.35). Above the threshold consider to be blinking or eye closed._
+- _**`disableUploadDocs`** is used to pass a boolean value. It is used to disable the upload option the document process._
+- _**`eyeOpenThreshold`** is used to pass a numerical value. It is used to check the user eyes are open (range 0-1 and default 0.2). Below the threshold consider to be eyes are open._
 - _**`objectPersonThreshold`** is used to pass a numerical value. It is used to check the image person as object found with required score as threshold (range 0-1 and default 0.925)._
 - _**`objectPhoneThreshold`** is used to pass a numerical value. It is used to check the image phone/laptop as object found with required score as threshold (range 0-1 and default 0.5)._
+- _**`grayscalePercentageThreshold`** is used to pass a numerical value for percentage. It is used to check the image color as black&white found with required percentage as threshold (range 0-100 and default 80)._
 - _**`onMessage`** is a callback function. It is getting called when the API gives a message or at any configuration error. Return data is an object with its API endpoint and result._
 
 
+<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ DEVELOPER info ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
+
 <!-- use node 18 and install packages using yarn and do yarn dev -->
+
+<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ GrayScale info ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
+
+<!-- GrayScale Suggestions
+
+1. RGB Difference Threshold for Grayscale Detection:
+
+Low Threshold: A low threshold (e.g., 5-10) is good if you want to consider any slight variation in color as an indication that the image is colored. This is more sensitive to minor color differences.
+
+Moderate Threshold: A threshold of around 10-20 is a more balanced approach. It allows for small variations due to noise or minor imperfections in grayscale images but still classifies them as black and white.
+
+High Threshold: A higher threshold (e.g., 20-50) will classify images as grayscale even if there are noticeable color variations, which might be acceptable for images that are predominantly black and white but have some color noise or artifacts.
+
+2. Percentage of Grayscale Pixels:
+
+After detecting grayscale pixels, you need to determine the percentage of grayscale pixels required to classify the image as black and white.
+
+80-90% Grayscale Pixels: This threshold means that if 80-90% of the pixels are grayscale, the image will be classified as black and white. This works well for documents and images that are mostly grayscale but may have some minor color elements (e.g., stamps, logos).
+
+90-100% Grayscale Pixels: This is a stricter threshold, ensuring that the image is classified as black and white only if nearly all pixels are grayscale. -->
+
+<!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Selfie info ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
+
+<!-- 
+1.blinkThreshold: number
+
+Description : The blinkThreshold is used to determine whether the user's eye is considered blinked. It represents the sensitivity to eye closure during a blink.
+Range : 0-1 (default: 0.35)
+Functionality :
+* If either of the user's eyes exceeds the specified threshold (i.e., the eye closure ratio is greater than the blinkThreshold), the eye is detected as "blinked."
+* This helps identify blinks during facial detection or tracking processes.
+
+2.eyeOpenThreshold: number
+
+Description : The eyeOpenThreshold is used to detect whether the user's eyes are open or not. It determines the sensitivity to eye openness by checking the openness ratio.
+Range : 0-1 (default: 0.25)
+Functionality :
+* If both eyes fall below the defined threshold, the system interprets that the eyes are open.
+* This value helps differentiate between an open eye and a partially closed
+
+Both thresholds work together to archive ekyc selfie process. 
+-->
+