@yidun/livedetect-sdk-h5 2.0.1 → 2.2.0

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.
Files changed (33) hide show
  1. package/README.md +8 -4
  2. package/dist/{NELiveDetection.v2.0.1.umd.js → NELiveDetection.umd.js} +2 -2
  3. package/dist/es/NELiveDetection.esm.js +2 -2
  4. package/dist/es/typings/index.d.ts +3 -3
  5. package/dist/es/typings/main/constants.d.ts +34 -34
  6. package/dist/es/typings/main/helpers.d.ts +23 -23
  7. package/dist/es/typings/main/libs/BDFaceSdk.esm.min.d.ts +2 -2
  8. package/dist/es/typings/main/libs/asmcrypto.d.ts +32 -32
  9. package/dist/es/typings/main/libs/index.d.ts +8 -8
  10. package/dist/es/typings/main/live-detection.d.ts +36 -34
  11. package/dist/es/typings/main/modules/camera/index.d.ts +18 -18
  12. package/dist/es/typings/main/modules/color/index.d.ts +14 -14
  13. package/dist/es/typings/main/modules/footer/index.d.ts +8 -8
  14. package/dist/es/typings/main/modules/progress/index.d.ts +11 -11
  15. package/dist/es/typings/main/modules/record/checking.d.ts +5 -5
  16. package/dist/es/typings/main/modules/record/index.d.ts +15 -15
  17. package/dist/es/typings/main/modules/record/start.d.ts +14 -14
  18. package/dist/es/typings/main/modules/tip/index.d.ts +13 -13
  19. package/dist/es/typings/main/modules/toast/index.d.ts +12 -12
  20. package/dist/es/typings/main/modules/toast/toast-item.d.ts +9 -9
  21. package/dist/es/typings/main/types.d.ts +29 -27
  22. package/dist/es/typings/main/utils/collector.d.ts +13 -13
  23. package/dist/es/typings/main/utils/dispose.d.ts +8 -8
  24. package/dist/es/typings/main/utils/dom.d.ts +15 -15
  25. package/dist/es/typings/main/utils/domNode.d.ts +7 -7
  26. package/dist/es/typings/main/utils/eventmitter.d.ts +10 -10
  27. package/dist/es/typings/main/utils/i18n.d.ts +72 -72
  28. package/dist/es/typings/main/utils/index.d.ts +24 -24
  29. package/dist/es/typings/main/utils/is.d.ts +7 -7
  30. package/dist/es/typings/main/utils/logger.d.ts +9 -9
  31. package/dist/es/typings/main/utils/request.d.ts +12 -9
  32. package/package.json +6 -3
  33. /package/dist/{NELiveDetection.v2.0.1.min.css → NELiveDetection.min.css} +0 -0
package/README.md CHANGED
@@ -69,11 +69,13 @@ import '@yidun/livedetect-sdk-h5/dist/es/NELiveDetection.css';
69
69
 
70
70
  ```html
71
71
  <!-- head 标签下样式文件引入 -->
72
- <link rel="stylesheet" href="https://yidunfe.nosdn.127.net/sdk/NELiveDetection.v2.0.1.min.css" />
72
+ <link rel="stylesheet" href="https://yidunfe.nosdn.127.net/sdk/NELiveDetection.v<VERSION>.min.css" />
73
73
  <!-- body 标签下引入 sdk -->
74
- <script src="https://yidunfe.nosdn.127.net/sdk/NELiveDetection.v2.0.1.umd.js"></script>
74
+ <script src="https://yidunfe.nosdn.127.net/sdk/NELiveDetection.v<VERSION>.umd.js"></script>
75
75
  ```
76
76
 
77
+ <VERSION> 为占位符,详细版本列表见:https://www.npmjs.com/package/@yidun/livedetect-sdk-h5?activeTab=versions
78
+
77
79
  引入该脚本之后,不需要像**模块引入**方式一样通过 `import` 引入 `NELiveDetection` 变量,该变量已经挂载到全局,初始化时直接按下列方式即可:
78
80
 
79
81
  ```js
@@ -166,9 +168,11 @@ const neLiveDetection = new NELiveDetection({
166
168
  | diameter | Number | `220` | 图像显示区域大小,单位为 `px` | 否 |
167
169
  | audio | Boolean | `false` | 摄像头唤起时是否开启声音录制 | 否 |
168
170
  | footerTip | Boolean | `true` | 是否显示底部图像和文字提示 | 否 |
169
- | lang | string | `zh-CN` | 语言,支持列表见下方语言支持列表 | 否 |
171
+ | lang | String | `zh-CN` | 语言,支持列表见下方语言支持列表 | 否 |
172
+ | fallback | Boolean | `true` | 是否降级到视频录制上传 | 否 |
170
173
  | onMount | Function | - | 初始化实例挂载完成回调 | 否 |
171
174
  | onReady | Function | - | 活体检测前的准备工作已完成回调 | 否 |
175
+ | apiServer | String | https://verify.dun.163yun.com | 私有化接口服务地址,仅支持以 `https` 开头的域名,版本需要大于 2.2.0 | 否 |
172
176
 
173
177
  <md-attention>
174
178
 
@@ -273,7 +277,7 @@ instance.on('error', (err) => {
273
277
  | 10001 | 校验接口网络错误 |
274
278
  | 11000 | 获取相机权限失败 |
275
279
  | 11001 | 鉴权不通过 |
276
- | 11002 | 浏览器不支持 |
280
+ | 11002 | 浏览器不支持,默认降级到视频活体,如不需要,可以将初始化参数 `fallback` 设置为 `false` |
277
281
  | 11003 | 用户拒绝相机权限授权 |
278
282
  | 11004 | 找不到摄像头 |
279
283
  | 11005 | 异常硬件导致无法读取摄像头 |