npm - m8-framework-mcp - Versions diffs - 1.0.0 → 1.0.1 - Mend

m8-framework-mcp 1.0.0 → 1.0.1

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 (388) hide show

package/docs/ejs-doc/api_io/api_io.md DELETED Viewed

@@ -1,369 +0,0 @@
-# ejs.io
-## downloadFile
-下载文件
-EJS 默认下载地址`sdk路径/epointapp7/xxx`，H5 端为本地临时路径。
-在各个小程序平台运行时，网络相关的 API 在使用前需要配置域名白名单。在 h5 上是跨域的，用户需要处理好跨域问题。
-**平台差异**
-| ejs（H5 应用) | ejs（新点小程序） |      H5      | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :---------------: | :----------: | :----- | :--------- | :----------- |
-| 支持(3.1.2)   |    支持(3.1.2)    | 跨端框架支持 | 不支持 | 支持       | 支持         |
-**使用示例**
-```js
-ejs.io.downloadFile({
-    url: 'http://app.epoint.com.cn/staticResource/img_head.png',
-    fileName: 'img_head.png',
-    reDownloaded: 0,
-    success: function (result) {},
-    error: function (error) {}
-});
-```
-**参数说明**
-| 参数              |    参数类型     | 说明                                                                                                    |                                平台差异说明                                 |
-| :---------------- | :-------------: | :------------------------------------------------------------------------------------------------------ | :-------------------------------------------------------------------------: |
-| url               |     String      | `必填`，下载文件的地址                                                                                  |
-| fileName          |     String      | EJS 端`必填`，下载文件的名称                                                                            |                                 仅 ejs 支持                                 |
-| reDownloaded      | Number / String | 当已经下载过时，是否重新下载，为`0`代表已经存在时会直接打开，为`1`代表会重新下载文件并重命名，默认为`0` |                                 仅 ejs 支持                                 |
-| isBackground      | Number / String | 是否在后台下载，如果为`1`，则静默后台下载，否则为`0`时会专门跳到一个下载页面，默认为`1`                 |                                 仅 ejs 支持                                 |
-| openAfterComplete | Number / String | **仅在后台静默下载时有用**，请慎重使用，如果有参数(譬如为`1`)，代表下载后强制打开，默认请不要传递       |                                 仅 ejs 支持                                 |
-| autoStart         | Number / String | EJS`3.4.0`新增，是否自动打开下载文件，`1`自动打开，默认为`0`                                            | 仅 ejs、微信小程序、支付宝小程序支持，支付宝小程序仅支持打开图片和 pdf 文件 |
-| previewUrl        |     String      | 文件预览地址，若不传此参数，则不显示预览按钮                                                            |                                 仅 ejs 支持                                 |
-| filePath          |     String      | 指定文件下载后存储的路径 (本地路径)                                                                     |    仅微信小程序支持（IOS 小程序保存到相册需要添加此字段才可以正常保存）     |
-**返回说明**
-| 参数     | 参数类型 | 说明                                                                                                   |
-| :------- | :------: | :----------------------------------------------------------------------------------------------------- |
-| filePath |  String  | 返回的文件本地路径，H5 端为本地临时路径，注意`isBackground`为`0`时，会跳转下载页面，此时不会返回该参数 |
-## selectFile
-选择文件，主要用于选择非媒体文件。
-注：微信小程序不支持拉起本地文件目录，该 API 仅能获取微信聊天里的文件。
-**平台差异**
-| ejs（H5 应用) | ejs（新点小程序） |      H5      | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :---------------: | :----------: | :----- | :--------- | :----------- |
-| 支持(3.1.2)   |    支持(3.1.2)    | 跨端框架支持 | 不支持 | 支持       | 不支持       |
-**使用示例**
-```js
-ejs.io.selectFile({
-    multi: 0, // 是否为多选，ejs组件版本v3.2.7.e后支持
-    success: function (result) {
-        /**
-         * 选择文件后返回（非多选）默认保持原有API返回参数
-         * {
-                resultData: "/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg"
-           }
-         *
-         * 选择文件后返回（多选）
-         * {
-                resultData: ["/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg","/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg"]
-           }
-         *
-         */
-    },
-    error: function (error) {}
-});
-```
-![](images/util.selectfile.png)
-**参数说明**
-| 参数  |    参数类型     | 说明                                                                       |   平台差异说明   |
-| :---- | :-------------: | :------------------------------------------------------------------------- | :--------------: |
-| multi | Number / String | 是否为多选模式。 `1`：多选；`0`：单选（默认） ejs 组件版本 v3.2.7.e 后支持 |                  |
-| count | Number / String | 多选时，最大可选数量，默认 999                                             | 仅微信小程序支持 |
-**返回说明**
-| 参数       |       参数类型       | 说明               |                              平台差异说明                               |
-| :--------- | :------------------: | :----------------- | :---------------------------------------------------------------------: |
-| resultData | String/Array[String] | 返回文件的本地路径 |                         微信端返回的是临时路径                          |
-| tempFiles  |    Array[Object]     | 返回本地文件列表   | 仅 H5 端和微信端支持，H5 端每一项是一个 File 对象，微信端是一个普通对象 |
-## openFile
-打开本地文件
-**平台差异**
-| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
-| 支持(3.1.2)   |    支持(3.1.2)    | 不支持 | 不支持 | 支持       | 支持         |
-**使用示例**
-```js
-ejs.io.openFile({
-    path: '/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg',
-    success: function (result) {},
-    error: function (error) {}
-});
-```
-**参数说明**
-| 参数 | 参数类型 | 说明                                                   |         平台差异说明          |
-| :--- | :------: | :----------------------------------------------------- | :---------------------------: |
-| path |  String  | `必填`，需要被打开的本地文件路径，`/storage`开头的这种 | 支付宝端只支持打开 pdf 及图片 |
-## renameFile
-重命名文件
-**平台差异**
-| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
-| 支持(3.1.2)   |    支持(3.1.2)    | 不支持 | 不支持 | 不支持     | 不支持       |
-**使用示例**
-```js
-ejs.io.renameFile({
-    path: '/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg',
-    // 如果仅仅是想重命名名字，传newName即可
-    newName: 'IMG_20170703_133718',
-    // 如果想要重命名后缀，传后缀就可以了，没有后缀请不要传这个参数（即为undefined）
-    // 或者 'jpg'
-    newSuffix: 'jpg',
-    success: function (result) {},
-    error: function (error) {}
-});
-```
-**参数说明**
-| 参数      | 参数类型 | 说明                                                     |
-| :-------- | :------: | :------------------------------------------------------- |
-| path      |  String  | `必填`，需要被重命名的本地文件路径，`/storage`开头的这种 |
-| newName   |  String  | `必填`，新的名称，不包含后缀                             |
-| newSuffix |  String  | 新的后缀，注意，**如果不想改变后缀，请不要传这个参数**   |
-## copyFile
-复制一个文件到新路径，复制后原有文件会保留
-注意，前提是对原生路径比较熟悉，而且 Android 与 iOS 有差异
-**平台差异**
-| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
-| 支持(3.1.2)   |    支持(3.1.2)    | 不支持 | 不支持 | 不支持     | 不支持       |
-**使用示例**
-```js
-ejs.io.copyFile({
-    path: '/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg',
-    // 新的路径-注意，文件夹变了
-    newPath: '/storage/emulated/0/DCIM/Camera2/IMG_20170703_133717.jpg',
-    success: function (result) {},
-    error: function (error) {}
-});
-```
-**参数说明**
-| 参数    | 参数类型 | 说明                                                   |
-| :------ | :------: | :----------------------------------------------------- |
-| path    |  String  | `必填`，需要被复制的本地文件路径，`/storage`开头的这种 |
-| newPath |  String  | `必填`，新的路径地址，一样需要完整的路径               |
-## deleteFile
-删除一个本地文件
-微信和支付宝小程序端仅支持删除本地存储的文件
-**平台差异**
-| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
-| 支持(3.1.2)   |    支持(3.1.2)    | 不支持 | 不支持 | 支持       | 支持         |
-**使用示例**
-```js
-ejs.io.deleteFile({
-    path: '/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg',
-    success: function (result) {},
-    error: function (error) {}
-});
-```
-**参数说明**
-| 参数 | 参数类型 | 说明                             |
-| :--- | :------: | :------------------------------- |
-| path |  String  | `必填`，需要被删除的本地文件路径 |
-## getFileSize
-获取本地图片大小
-**平台差异**
-| ejs（H5 应用) | ejs（新点小程序） |      H5      | 钉钉         | 微信小程序 | 支付宝小程序 |
-| :------------ | :---------------: | :----------: | :----------- | :--------- | :----------- |
-| 支持(3.1.7)   |    支持(3.1.7)    | 跨端框架支持 | 跨端框架支持 | 支持       | 支持         |
-**使用示例**
-```js
-ejs.io.getFileSize({
-    path: '/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg',
-    success: function (result) {
-        /**
-         * 选择完图片后返回
-         * {
-                size: 4488 // 单位是b
-           }
-         */
-    },
-    error: function (error) {}
-});
-```
-**参数说明**
-| 参数 | 参数类型 | 说明                 |
-| :--- | :------: | :------------------- |
-| path |  String  | `必填`，本地图片路径 |
-**返回说明**
-| 参数 |    参数类型     | 说明                         |
-| :--- | :-------------: | :--------------------------- |
-| size | Number / String | 返回文件的大小，以字节为单位 |
-## screenShot
-截屏
-**平台差异**
-| ejs（H5 应用) |            ejs（新点小程序）            |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :-------------------------------------: | :----: | :----- | :--------- | :----------- |
-| 支持(3.2.5a)  | 支持(3.2.5a)<br>（ejs-weex 环境不支持） | 不支持 | 不支持 | 不支持     | 不支持       |
-**使用示例**
-```js
-ejs.io.screenShot({
-    captureType: 1,
-    success: function (result) {
-        /**
-         * 截屏后返回图片的本地路径
-         * {
-                picPath: ""
-           }
-         */
-    },
-    error: function (error) {}
-});
-```
-**参数说明**
-| 参数        |    参数类型     | 说明                                  |
-| :---------- | :-------------: | :------------------------------------ |
-| captureType | Number / String | 0：截当前屏幕，1：长截图 默认：长截图 |
-## report
-埋点统计
-**平台差异**
-| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
-| 支持(4.0.0)   |    支持(4.0.0)    | 不支持 | 不支持 | 不支持     | 不支持       |
-**使用示例**
-```js
-ejs.io.report({
-    // url地址
-    url: '',
-    // 响应时间(毫秒)
-    responsetime: '',
-    // 请求内容（请求出错才有）
-    request: '',
-    // 响应内容（请求出错才有）
-    response: '',
-    // 0容器，1小程序，2H5
-    belong: '',
-    // 成功或者失败标示，'0'失败，'1'成功
-    successorfail: '',
-    success: function (result) {},
-    error: function (error) {}
-});
-```
-**参数说明**
-| 参数          | 参数类型 | 说明                                                          |
-| :------------ | :------: | :------------------------------------------------------------ |
-| url           |  String  | url 地址                                                      |
-| responsetime  |  String  | 响应时间(毫秒)                                                |
-| request       |  String  | 请求内容（请求出错才有）                                      |
-| response      |  String  | 响应内容（请求出错才有）                                      |
-| belong        |  String  | 网络请求是来自小程序/H5/容器的标识, `0`容器，`1`小程序，`2`H5 |
-| successorfail |  String  | 成功或者失败标示，'0'失败，'1'成功                            |
-## record
-基座埋点统计
-**平台差异**
-| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
-| 支持(4.2.22)   |    支持(4.2.22)    | 不支持 | 不支持 | 不支持     | 不支持       |
-**使用示例**
-```js
-ejs.io.record({
-    // 按钮点击id，需产生点击行为
-    clickid: '',
-    // 按钮点击名称(如有)
-    clicktitle: '',
-    // 当前流程的标识
-    eventid: '',
-    // 流程中当前步骤的名称
-    eventname: '',
-    // 流程中当前步骤的详细日志说明
-    eventcontent: '',
-    success: function (result) {},
-    error: function (error) {}
-});
-```
-**参数说明**
-| 参数          | 参数类型 | 说明                                                          |
-| :------------ | :------: | :------------------------------------------------------------ |
-| clickid       |  String  | 按钮点击id，需产生点击行为                                    |
-| clicktitle    |  String  | 按钮点击名称(如有)                                            |
-| eventid       |  String  | 当前流程的标识                                              |
-| eventname     |  String  | 流程中当前步骤的名称                                        |
-| eventcontent  |  String  | 流程中当前步骤的详细日志说明                                |

package/docs/ejs-doc/api_miniH5/api_miniH5.md DELETED Viewed

@@ -1,279 +0,0 @@
-# ejs.miniH5
-## navigateTo
-打开小程序。
-在微信小程序平台中：
-1. 需要用户触发跳转，若用户未点击小程序页面任意位置，则开发者将无法调用此接口自动跳转至其他小程序。
-2. 需要用户确认跳转, 在跳转至其他小程序前，将统一增加弹窗，询问是否跳转，用户确认后才可以跳转其他小程序。如果用户点击取消，则回调 `fail cancel`
-**平台差异**
-| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
-| 支持          |    支持(3.4.1)    | 不支持 | 不支持 | 支持       | 支持         |
-**使用示例**
-```js
-ejs.miniH5.navigateTo({
-    // 新点小程序中跳转示例
-    appId: 'appcenter',
-    path: './index.html#/appcenter/edit',
-    // 为1保活状态关闭小程序，为0不保活,默认为0
-    alive: 0,
-    extraData: {}
-});
-```
-**参数说明**
-| 参数      |    参数类型     | 说明                                                           | 平台差异说明 |
-| :-------- | :-------------: | :------------------------------------------------------------- | :----------: |
-| appId     |     String      | `必填`，要打开的小程序 appId                                   |              |
-| path      |     String      | `选填`，打开指定的页面路径                                     |              |
-| alive     | Number / String | 为 1 保活状态关闭小程序，为 0 不保活，默认为 0，迅盟环境不支持 | 仅 ejs 支持  |
-| extraData |     Object      | `选填`，需要传递给小程序的额外参数                             |              |
-## navigateBack
-返回小程序上一页
-**平台差异**
-| ejs（H5 应用) |           ejs（新点小程序）            |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :------------------------------------: | :----: | :----- | :--------- | :----------- |
-| 不支持        | 支持(3.4.1)<br>（ejs-weex 环境不支持） | 不支持 | 不支持 | 支持       | 支持         |
-**使用示例**
-```js
-ejs.miniH5.navigateBack({
-    extraData: {},
-    useRouter: true
-});
-```
-**参数说明**
-| 参数      | 参数类型 | 说明                                                      | 平台差异说明 |
-| :-------- | :------: | :-------------------------------------------------------- | :----------: |
-| extraData |  Object  | `选填`，需要传递给上一个小程序的额外参数, 迅盟环境不支持  | 仅 ejs 支持  |
-| useRouter | Boolean  | `选填`, 是否是单页应用，关闭时使用路由返回，默认为`false` | 仅 ejs 支持  |
-## onNavigateBack
-返回小程序上一页的监听拦截
-**平台差异**
-| ejs（H5 应用) |           ejs（新点小程序）            |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :------------------------------------: | :----: | :----- | :--------- | :----------- |
-| 不支持        | 支持(3.4.1)<br>（ejs-weex 环境不支持） | 不支持 | 不支持 | 不支持     | 不支持       |
-**使用示例**
-```js
-ejs.miniH5.onNavigateBack({
-    success: function(){
-        ....
-    }
-});
-```
-## setNavigationBarColor
-设置导航栏的背景色、风格
-**平台差异**
-| ejs（H5 应用) |           ejs（新点小程序）            |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :------------------------------------: | :----: | :----- | :--------- | :----------- |
-| 不支持        | 支持(3.4.1)<br>（ejs-weex 环境不支持） | 不支持 | 不支持 | 支持       | 支持         |
-**使用示例**
-```js
-ejs.miniH5.setNavigationBarColor({
-    frontColor: 'blue',
-    backgroundColor: '#ff0000'
-});
-```
-**参数说明**
-| 参数            | 参数类型  | 说明                                         |                                           平台差异说明                                           |
-| :-------------- | :-------: | :------------------------------------------- | :----------------------------------------------------------------------------------------------: |
-| frontColor      |  String   | 前景色，支持设置胶囊按钮，标题，状态栏的风格 | 新点小程序仅支持`blue`、`white`，微信小程序平台仅支持 `#ffffff` 和 `#000000`，支付宝小程序不支持 |
-| backgroundColor | HexString | 导航栏背景色                                 |                                                                                                  |
-## setNavigationBarTitle
-设置导航栏的标题
-**平台差异**
-| ejs（H5 应用) |            ejs（新点小程序）            |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :-------------------------------------: | :----: | :----- | :--------- | :----------- |
-| 不支持        | 支持(3.4.1) <br>（ejs-weex 环境不支持） | 不支持 | 不支持 | 支持       | 支持         |
-**使用示例**
-```js
-ejs.miniH5.setNavigationBarTitle({
-    title: '标题'
-});
-```
-**参数说明**
-| 参数  | 参数类型 | 说明       |
-| :---- | :------: | :--------- |
-| title |  String  | 导航栏标题 |
-## getEpointCodeInfo
-获取应用 ID
-**平台差异**
-| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
-| 不支持        |    支持(3.4.1)    | 不支持 | 不支持 | 不支持     | 不支持       |
-**使用示例**
-```js
-ejs.miniH5.getEpointCodeInfo({
-    success: function (result) {
-        console.log(result);
-    }
-});
-```
-**返回参数说明**
-| 参数  | 参数类型 | 说明    |
-| :---- | :------: | :------ |
-| appId |  String  | 应用 ID |
-## close
-关闭小程序
-在微信和支付宝小程序平台中，必须要有点击行为才能成功调用。
-**平台差异**
-| ejs（H5 应用) |            ejs（新点小程序）            |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :-------------------------------------: | :----: | :----- | :--------- | :----------- |
-| 不支持        | 支持(4.0.0) <br>（ejs-weex 环境不支持） | 不支持 | 不支持 | 支持       | 支持         |
-**使用示例**
-```js
-ejs.miniH5.close({
-    // 为1保活状态关闭小程序，为0不保活，默认1
-    alive: 1,
-    extraData: {
-        key1: 'value1'
-    },
-    success: function () {}
-});
-```
-**参数说明**
-| 参数      |    参数类型     | 说明                                         | 平台差异说明 |
-| :-------- | :-------------: | :------------------------------------------- | :----------: |
-| alive     | Number / String | 为 1 保活状态关闭小程序，为 0 不保活，默认 1 | 仅 ejs 支持  |
-| extraData |     Object      | 关闭小程序时的回调参数                       | 仅 ejs 支持  |
-## checkForUpdate
-检测小程序是否已更新
-**平台差异**
-| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
-| 不支持        |    支持(4.0.2)    | 不支持 | 不支持 | 支持       | 支持         |
-**使用示例**
-```js
-ejs.miniH5.checkForUpdate({
-    success: function (result) {
-        /**
-         *{
-         *    hasUpdate: 1
-         *}
-         */
-    },
-    error: function (err) {}
-});
-```
-**返回说明**
-| 参数      |    参数类型     | 说明                                                       |
-| :-------- | :-------------: | :--------------------------------------------------------- |
-| hasUpdate | Number / String | 小程序是否已更新, `0`没有更新的小程序，`1`已有更新的小程序 |
-## applyUpdate
-小程序强制更新并重启
-**平台差异**
-| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
-| 不支持        |    支持(4.0.2)    | 不支持 | 不支持 | 支持       | 支持         |
-**使用示例**
-```js
-ejs.miniH5.applyUpdate({
-    success: function (result) {},
-    error: function (err) {}
-});
-```
-## applyCard
-小程序支持下载卡片资源
-**平台差异**
-| ejs（H5 应用) |             ejs（新点小程序）             |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
-| :------------ | :---------------------------------------: | :----: | :----- | :--------- | :----------- |
-| 不支持        | 支持(4.0.3-a) <br>（ejs-weex 环境不支持） | 不支持 | 不支持 | 不支持     | 不支持       |
-**使用示例**
-```js
-ejs.miniH5.applyCard({
-    // 支持配置强制更新 isforce 参数，1 不再执行判断逻辑、直接更新  0 正常更新
-    isforce: '0',
-    // 传入卡片 appkey、version、cardguid、isdebug
-    appkey: '',
-    version: '',
-    cardguid: '',
-    isdebug: '',
-    success: function (result) {},
-    error: function (err) {}
-});
-```
-**参数说明**
-| 参数     | 参数类型 | 说明                                               |
-| :------- | :------: | :------------------------------------------------- |
-| isforce  |  String  | 强制更新, 1 不再执行判断逻辑、直接更新, 0 正常更新 |
-| appkey   |  String  | 传入卡片 appkey                                    |
-| version  |  String  | 传入卡片版本                                       |
-| cardguid |  String  | 传入卡片 cardguid                                  |
-| isdebug  |  String  | 是否是调试卡片 isdebug                             |