m8-framework-mcp 1.0.0

package/docs/ejs-doc/authentication/authentication.md

@@ -0,0 +1,28 @@
+# 鉴权API
+
+## 关于鉴权
+
+`ejs` 提供了一些 `Native` 能力的 `JsApi`，这些 `JsApi` 有很多是手机的基础能力，对这些 `JsApi` 的调用不需要进行鉴权，只需要保证在 `ejs.ready` 里面调用即可。对于一些业务相关、安全相关的 `JsApi` 调用，需要开发者先进行鉴权后再调用。
+
+## 鉴权示例
+
+```js
+// 仅在开启鉴权时，需要以下参数。 未开启鉴权，无需以下参数。
+ejs.config({
+  appKey: '',
+  timestamp: '',
+  nonceStr: '',
+  signature: '',
+  ticketCode: ''
+});
+```
+
+__参数说明__
+
+| 参数 | 参数类型 | 说明 |
+| :------------- |:-------------:|:-------------|
+| appKey | String | 应用key |
+| timestamp | String | 时间戳 |
+| nonceStr | String | 随机串 |
+| signature | String | 签名信息 |
+| ticketCode | String | 票据密文 |

package/docs/ejs-doc/changelog/changelog.md

@@ -0,0 +1,290 @@
+# 文档变更记录
+
+## 20250919
+
+版本更新 `4.2.22`
+
+- 新功能
+
+    - `runtime`模块新增`EUI4.0`相关原生方法: `getCurrentMode`、`getCurrentTheme`、`getModeConfig`、`getThemeConfig`、`getConfigValue`
+
+    - `io`模块新增一个原生埋点统计方法：`record`
+
+    - `event`模块新增`EUI4.0`相关原生事件：`onModeChanged`、`onThemeChanged`
+
+## 20250722
+
+版本更新 `4.2.21`
+
+- 修复问题
+
+    -  打包排除`vant`，修复`pickDate`切换`datetime`失效问题
+
+- 优化
+
+    - 鸿蒙环境与原生通讯不拆分长数据
+
+    - 完善`ejs.config`类型声明，修复ts项目使用该方法报错问题
+
+## 20250312
+
+版本更新 `4.2.20`
+
+- 新增功能
+
+    - `ejs.util.invokePluginApi`方法新增`isLongCb`参数用于标识是否是长期回调
+
+- 修复问题
+
+    - 修复`ejs.ui.confirm`弹窗快速点击取消回调执行俩次问题，修复弹窗消失比遮罩阴影慢问题
+
+- 优化
+
+    - 调整ejs输出产物，方便三方vue3项目引入
+
+
+## 20250116
+
+版本更新 `4.2.19`
+
+- 修复问题
+
+    - 修复两次调用`confirm`时，第二次弹窗无法正常展示问题
+
+
+## 20240814
+
+版本更新 `4.2.19-beta.1`
+
+- 新增功能
+
+    - 新增鸿蒙环境判断 `ejs.os.harmonyOs`
+
+- 修复问题
+
+    - 修复支付宝小程序中引入报错不支持`globalThis`问题
+
+## 20240715
+
+版本更新 `4.2.19-beta.0`
+
+- 修复问题
+
+    - 修复`ejs.ui.pickDateTime`组件中文字未翻译问题
+
+## 20240621
+
+版本更新 `4.2.18`
+
+- 修复问题
+
+    - 修复微信小程序端`ejs.io.downloadFile`下载`pdf`文件无法自动打开问题
+
+    - 修复添加的拦截器获取不到`h5UI`参数问题
+
+    - ejs新增es输出产物解决`vite`引入ejs报错问题
+
+- 优化
+
+    - 微信小程序端`ejs.io.downloadFile`改为微信小程序文件管理器方法进行文件保存
+
+    - `ejs.io.downloadFile`自动打开文件兼容文件后缀名大小写
+
+## 20240326
+
+版本更新 `4.2.17`
+
+- 新增功能
+
+    - 新增`storage.removeShareItem`方法H5环境兼容
+
+- 修复问题
+
+    - 修复某些版本微信小程序不支持`getUpdateManager`时`ejs`报错问题
+
+    - 优化强制更新小程序方法逻辑
+
+## 20240223
+
+版本更新 `4.2.16`
+
+- 修复问题
+
+    - 修复`actionSheet`点击取消返回参数与原生不一致问题
+
+- 优化
+
+    - 优化`ejs`构建流程，自动设置ejs版本号
+
+## 20231017
+
+版本更新 `4.2.13`
+
+- 修复问题
+
+    - 修复`ejsv4`引入时报错`weex`未定义的问题
+
+## 20230914
+
+版本更新 `4.2.12`
+
+- 修复问题
+
+    - 修复`ejsv4`与原生交互时的缺陷
+
+## 20230720
+
+版本更新 `4.2.11`
+
+- 修复问题
+
+    - 修复`ejsv4`在`ejs-weex`端不能正常调用问题
+
+- 优化
+
+    - 优化`ui`模块部分按钮默认值设置
+
+## 20230719
+
+版本更新 `4.2.10`
+
+- 新增功能
+
+    - 新增`ejs-weex`端API调用支持，部分API支持在官方`weex`端调用
+
+- 修复问题
+
+    - 修复`ejsv4`发布目录缺失问题
+
+- 优化
+
+    - 优化`JSBridge`获取回调集合的逻辑，兼容多个`ejs`资源冲突的情况
+
+## 20230626
+
+在线文档支持全局搜索功能
+
+## 20230506
+
+版本更新 `4.2.9`
+
+- 修复问题
+
+    - 修复第三方脚本引入没有全局`ejs`变量问题
+
+    - 修复`ejs.ui.showWaiting`和`ejs.ui.closeWaiting`同时调用时未正常关闭的问题
+
+## 20230321
+
+版本更新 `4.2.8`
+
+- 修复问题
+
+    - 修复跨端UI组件toast和alert同时调用时未正常回调的问题
+
+## 20230201
+
+版本更新 `4.2.7`
+
+- 优化
+
+    - 规范部分弹窗样式
+
+    - 优化`picker`相关组件惯性滚动时长
+
+## 20221219
+
+版本更新 `4.2.6`
+
+- 优化
+
+    - `ui.toast`方法兼容`null`传参
+
+    - 修改时间选择相关API，可选最小日期默认为`1900年`
+
+    - 优化`ui.pickDateTime`范围较大时卡顿问题
+
+- 修复问题
+
+    - 修复`ui.pickDateTime`无法正常展示可选时间范围的问题
+
+## 20221101
+
+版本更新 `4.2.5`
+
+- 修复问题
+
+    - 修复`ejs.page.replace`在`ejs`环境中跳转失败的问题
+
+    - 修复`page.close`回传长数字字符串时回调返回数值类型的问题
+
+## 20221026
+
+版本更新 `4.2.4`
+
+- 新增功能
+
+    - `ui.pickDate` `ui.pickTime` `ui.pickDateTime` `ui.pickMonth`新增跨端支持
+
+- 修复问题
+
+    - 修复`ejs`公共库未兼容`M8.2`应用的问题
+
+## 20221011
+
+版本更新 `4.2.3`
+
+- 新增功能
+
+    - 新增`auth.refreshUserInfo`方法
+
+- 优化
+
+    - EJS环境的库不再打包H5环境的API
+
+- 修复问题
+
+    - 修复npm/dist未正常发布的问题
+
+## 20220902
+
+版本更新 `4.2.2`
+
+- 新增功能
+
+    - `ui.select`多选模式下新增展示全选功能
+    - `page.open`新增`useRouter：auto`选项
+    - `page.close`新增`useRouter`参数
+
+- 修复问题
+
+    - 修复ejs容器中使用ui模块报错的问题
+    - 修复ejs容器中打开页面问题
+
+## 20220630
+
+版本更新 `4.2.1`
+
+- 新增功能
+
+    - 新增拦截器功能
+
+- 修复问题
+
+    - 修复`ui.actionSheet`首次调用一闪而过的问题
+
+- 优化
+
+    - 优化API调用环境提醒：新点移动端改为EJS客户端
+
+## 20220630
+
+版本更新 `4.2.0`
+
+- 新增功能
+
+    - 新增跨端API及各个API跨端说明
+
+    - 新增ejs.config的扩展功能
+
+    - 拆分选人组件

package/docs/ejs-doc/component_invokeplugin/component_invokeplugin.md

@@ -0,0 +1,54 @@
+# 组件使用
+
+## 说明
+
+EJS中除了框架API外还有按需使用的组件API
+
+调用每一个组件API，都需要采用 `invokePluginApi` API来进行调用
+
+__环境支持__
+
+`EJS`, `>= 3.2.0`
+
+`V7框架核心组件`, `>= 7.3`
+
+## 第一步：查找组件API文档获取组件相关信息
+
+__获取组件路径和调用参数__
+
+[组件API文档](https://fdoc.epoint.com.cn/onlinedoc/KlFront_new/newtechnology/031002/newtechnologydocpage?uri=/KlFront_new/newtechnology/031002/newtechnologydocpage.html#)
+
+组件 path:
+
+```js
+contact.provider.localOperation
+```
+
+组件 dataMap:
+
+```js
+{
+  method: 'getOUAndUserList',
+  ouguid: 'xxxxxxx'
+}
+```
+
+## 第二步：调用API
+
+获取组件路径和调用参数后使用 `util.invokePluginApi` 进行调用
+
+```js
+ejs.util.invokePluginApi({
+  path: 'contact.provider.localOperation',
+  dataMap: {
+    method: 'getOUAndUserList',
+    ouguid: 'xxxxxxx'
+  },
+  success: function(result) {
+    // result 返回数据
+  },
+  error: function(err) {
+    // err 错误信息
+  }
+});
+```

package/docs/ejs-doc/component_outline/component_outline.md

@@ -0,0 +1,71 @@
+# 自定义API的使用
+
+## 说明
+
+EJS自定义API是项目中可个性化新增的扩展能力
+
+每一个自定义API都需要遵循如下步骤才能使用
+
+## 第一步：获取自定义API的路径
+
+需要从相应的原生人员处获取对应的自定义API路径，譬如
+
+Android:
+
+```js
+com.epoint.xxxEJSApi
+```
+
+iOS:
+
+```js
+xxxEJSApi
+```
+
+## 第二步：注册自定义API
+
+__自定义API使用前必须先进行注册__
+
+```js
+ejs.error(function(error) {
+    // 添加自己的错误提示
+});
+
+ejs.config({
+    jsApiList: [{
+        // 别名可以换为对应自定义API的（譬如pay）
+        'moduleName': ejs.os.android ? 'com.epoint.xxxEJSApi' : 'xxxEJSApi',
+    }],
+});
+
+// initPage是页面初始函数
+ejs.ready(initPage);
+```
+
+__注意⚠️:必须容器支持该组件才能注册成功，否则注册失败__
+
+##  第三步：调用API
+
+注册成功后即可在需要的时候调用API
+
+```js
+ejs.callApi({
+    // 该组件下的任意api
+    name: "api1",
+    mudule: 'moduleName',
+    // 是否长期回调，为0时可以省略
+    isLongCb: 0,
+    data: {
+        // 任意键值
+        key1: value1,
+    },
+    success: function(result) {
+        // 处理成功
+    },
+    error: function(error) {
+        // 处理失败
+    }
+});
+```
+
+__注意⚠️：如果是长期回调，`isLongCb`请传`1`__

package/docs/ejs-doc/guid_apiconstraint/guid_apiconstraint.md

@@ -0,0 +1,30 @@
+# API约束
+
+## 调用示例
+
+```js
+ejs.模块名.方法({
+    参数1: "",
+    参数2: "",
+    success: fucntion(result) {
+        // 成功回调
+    },
+    error: fucntion(error) {
+        // 失败回调
+    }
+});
+```
+
+### 接口约定
+
+- 所有接口都为异步调用
+
+- 接收一个`object`类型的参数
+
+- 成功回调`success`
+
+    - 通过`result`获取成功数据
+    
+    - 回调函数的触发时机由具体的API决定，有的API是调用时即可回调，有的是某个事件触发后才被回调
+
+- 失败回调`error`，所有的API调用错误都会走失败回调

package/docs/ejs-doc/guid_debugpage/guid_debugpage.md

@@ -0,0 +1,53 @@
+# 调试页面
+
+## 说明
+
+鉴于平时每次调试EJS API时都得单独写测试页面，过于麻烦，而且有点影响效率
+
+于是提供了一个调试页面，供开发人员调试API功能
+
+按照对应容器（4.x），扫码调试页面二维码即可
+
+[//app.epoint.com.cn/ejs4mpdoc/showcase/showcase/ejs/debugapi/ejsdebugroom.html](//app.epoint.com.cn/ejs4mpdoc/showcase/showcase/ejs/debugapi/ejsdebugroom.html)
+
+请用`Chrome`等浏览器打开，未进行IE浏览器兼容
+
+## 截图
+
+![](images/room.png)
+
+<div class="special">
+![](images/client.jpg)
+<div>
+
+## 使用步骤
+
+- __step1:连接控制台__
+
+    打开调试页面后，待左上角的`连接成功`字段后才表示可以正常调试，`ejs`版本默认`4.x`
+
+- __step2:客户端连接__
+
+    一切就绪后，用客户端扫描左侧的二维码即可连接调试控制台
+
+    可以同时连接多个客户端（譬如Android，iOS，浏览器）
+
+- __step3:开始调试__
+
+    在代码执行窗口中，编写代码，点击执行后发送到手机端执行
+
+    注意⚠️，请确保`4.x`中只使用`4.x`的API。
+
+    另外，由于目前调试页面基于`M7`编写，因此`Util`的所有方法均可使用
+
+- __step4:其它__
+
+    点击`缓存数据`可以将当前调试的数据保存到`localstorage`中，下次加载页面时会自动使用缓存
+
+    下方的`执行状态`可以看到打印日志
+
+## 更多
+
+调试页面的底层是基于`socket.io`实现的，开发人员完全可以根据调试页面的代码，写出适合特定场景的调试页面，后台直接复用即可
+
+更多原理可以参考[基于socket.io打造hybrid调试页面](https://fe.epoint.com.cn/mfdoc/index/index.php#page=socket_hybriddebug)

package/docs/ejs-doc/guid_demodebug/guid_demodebug.md

@@ -0,0 +1,59 @@
+# Demo
+
+## EJS端调试Demo
+
+提供了一个在线Demo以及调试容器给开发提供方便，方便用来测试`EJS`的API与容器
+
+### PC调试页面
+
+PC端写代码，移动端执行
+
+[//app.epoint.com.cn/ejs4mpdoc/showcase/showcase/ejs/debugapi/ejsdebugroom.html](//app.epoint.com.cn/ejs4mpdoc/showcase/showcase/ejs/debugapi/ejsdebugroom.html)
+
+### 标准API示例
+
+[//app.epoint.com.cn/ejs4mpdoc/showcase/showcase/ejs/ejsv4/](//app.epoint.com.cn/ejs4mpdoc/showcase/showcase/ejsv4/)
+
+![](images/qr_demo.png)
+
+### 调试步骤
+
+- 手机上下载对应系统的调试容器
+
+- 打开扫一扫页面，并扫描Demo在线地址的二维码
+
+- 进入在线Demo查看效果，首先确保正常调用
+
+    - 如果调用出问题，可能是容器和Demo版本不匹配，可以反馈
+
+- 确保上述正常后，用调试容器扫一扫实际项目中需要测试的`EJS`页面
+
+    - 如果出现问题，证明页面可能存在逻辑错误，请检查代码
+
+    - 如果调试容器没问题，但是实际容器有问题，可能实际容器版本较低，请反馈
+
+    - 注意，调试容器的`token`和实际是不同的，无法混用，所以调试时请关闭`token`验证
+
+## Weex端调试Demo
+
+### 标准API示例
+
+注意，`ejs-weex`预览需要在`url`后面拼接`appid`字段，本示例展示出来的二维码拼接的`appid`字段只是一个示例值`weex-ybshome`。预览时建议复制以下链接自行修改`appid`，重新生成二维码预览。
+
+[//app.epoint.com.cn/ejs4mpdoc/showcase/weex-showcase/index.js?wsport=8080&_wx_tpl=//app.epoint.com.cn/ejs4mpdoc/showcase/weex-showcase/index.js&appid=weex-ybshome](//app.epoint.com.cn/ejs4mpdoc/showcase/weex-showcase/index.js?wsport=8080&_wx_tpl=//app.epoint.com.cn/ejs4mpdoc/showcase/weex-showcase/index.js&appid=weex-ybshome)
+
+![](images/qrcode-weex.png)
+
+### 调试步骤
+
+- 手机上下载支持weex的新点容器
+
+- 打开扫一扫页面，并扫描Demo在线地址的二维码
+
+- 进入在线Demo查看效果，首先确保正常调用
+
+    - 如果调用出问题，可能是容器和Demo版本不匹配，可以反馈
+
+- 确保上述正常后，用调试容器扫一扫实际项目中需要测试的`weex`页面
+
+    - 如果出现问题，证明页面可能存在逻辑错误，请检查代码

package/docs/ejs-doc/guid_errorcode/guid_errorcode.md

@@ -0,0 +1,27 @@
+### 错误码查询
+
+| 错误码 | 提示信息                                          | 说明                                                         |
+| ------ | ------------------------------------------------- | ------------------------------------------------------------ |
+| 1001   | 该API无法在当前OS下运行                           | api os错误 ；这个只是默认的提示，如果没有新的提示，就会采用默认的提示 |
+| 1002   | 不允许更改JSSDK的API                              | api modify错误                                               |
+| 1003   | 不允许更改JSSDK的模块                             | module modify错误                                            |
+| 1004   | 调用了不存在的api                                 | api 不存在                                                   |
+| 1005   | 调用错误，该组件api对应的proto不存在              | 组件api对应的proto不存在                                     |
+| 1006   | 非容器下无法调用自定义组件API                     | 非容器环境下无法调用自定义组件API                            |
+| 1007   | 对应的event事件在该环境下不存在                   | 对应的event事件在该环境下不存在                              |
+| 1008   | 初始化版本号错误，请检查容器api的实现情况         | 初始化版本号错误，请检查容器api的实现情况                    |
+| 1009   | 当前API需要更高版本的容器支持                     | 当前容器版本不支持API                                        |
+| 2001   | ready回调不允许多次设置                           | ready modify错误-ready回调正常只允许定义一个                 |
+| 2002   | config不允许多次调用                              | config modify错误-正常一个页面只允许config一次               |
+| 2003   | config校验错误                                    | config 鉴权错误                                              |
+| 2004   | 不支持当前容器版本，请确保容器与前端库版本匹配    | version not support                                          |
+| 2005   | 当前JSSDK库小于容器版本，请将前端库升级到最新版本 | version not support                                          |
+| 3000   | 捕获到一处原生容器错误                            | 原生错误(非API错误)，原生捕获到的错误都会通知J5              |
+| 3001   | 原生调用H5时参数不对                              | 原生调用h5错误  原生通过JSBridge调用h5错误，可能是参数不对   |
+| 9999   | 未知错误                                          | 其它未知错误                                                 |
+
+**示例**
+
+下图所示错误码为2003，根据上表可知此为config鉴权错误
+
+![5d38937fec5107c38502c3ee38ba5b2c](images\5d38937fec5107c38502c3ee38ba5b2c.png)