eo-client-security-kit-mp 0.0.1-beta.3 → 0.0.1-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
English | [简体中文](./README.zh-CN.md)
|
|
2
|
-
|
|
3
1
|
## Introduction
|
|
4
2
|
|
|
5
3
|
`eo-client-security-kit-mp` is a WeChat Mini Program client security verification SDK provided by EdgeOne for security verification scenarios in Mini Programs.
|
|
@@ -188,9 +186,9 @@ Page({
|
|
|
188
186
|
| Property | Type | Required | Default | Description |
|
|
189
187
|
| ------------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------- |
|
|
190
188
|
| domain | string | Yes | '' | The domain for current verification, must match the business API domain |
|
|
191
|
-
| protocol | string | No | 'https' | Request protocol, options: `http` / `https`. Use http for debugging if https requests fail
|
|
192
|
-
| rceTuringSDK | object | No | null | turing SDK instance, passed in by host Mini Program (required for RCE risk control)
|
|
193
|
-
| captchaProperties | object | No | below | Captcha configuration (size/lang/themeColor)
|
|
189
|
+
| protocol | string | No | 'https' | Request protocol, options: `http` / `https`. Use http for debugging if https requests fail |
|
|
190
|
+
| rceTuringSDK | object | No | null | turing SDK instance, passed in by host Mini Program (required for RCE risk control) |
|
|
191
|
+
| captchaProperties | object | No | below | Captcha configuration (size/lang/themeColor) |
|
|
194
192
|
| generic:captcha-component | - | No | - | Abstract node for injecting captcha component, value is the component name defined in page JSON |
|
|
195
193
|
|
|
196
194
|
> **Note**: The component has built-in Canvas nodes required by RCE SDK, no additional configuration needed.
|
|
@@ -240,8 +238,8 @@ const token = await this.securityKit.verify('attest-406')
|
|
|
240
238
|
|
|
241
239
|
**Parameters**:
|
|
242
240
|
|
|
243
|
-
| Parameter | Type | Required | Description
|
|
244
|
-
| --------- | ------ | -------- |
|
|
241
|
+
| Parameter | Type | Required | Description |
|
|
242
|
+
| --------- | ------ | -------- | ----------------------------------------------------------------------------- |
|
|
245
243
|
| attestId | string | Yes | Verification rule ID configured in EdgeOne backend, format is `attest-number` |
|
|
246
244
|
|
|
247
245
|
**Return Value**: `Promise<string>` - Token after verification passes
|
|
@@ -271,12 +269,12 @@ this.securityKit.clearToken()
|
|
|
271
269
|
|
|
272
270
|
### Component Events
|
|
273
271
|
|
|
274
|
-
| Event | Trigger Timing
|
|
275
|
-
| ----------------- |
|
|
276
|
-
| bindready | Component initialization complete
|
|
277
|
-
| binderror | Initialization or verification error | `{ error }`
|
|
278
|
-
| bindverifysuccess | Verification successful
|
|
279
|
-
| bindverifyfailed | Verification failed
|
|
272
|
+
| Event | Trigger Timing | Callback Parameters |
|
|
273
|
+
| ----------------- | ------------------------------------ | -------------------------------- |
|
|
274
|
+
| bindready | Component initialization complete | `{ timestamp }` |
|
|
275
|
+
| binderror | Initialization or verification error | `{ error }` |
|
|
276
|
+
| bindverifysuccess | Verification successful | `{ attestId, token, timestamp }` |
|
|
277
|
+
| bindverifyfailed | Verification failed | `{ attestId, error, timestamp }` |
|
|
280
278
|
|
|
281
279
|
```xml
|
|
282
280
|
<security-kit
|