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/m8mpdoc-develop/006-Util/345/267/245/345/205/267/351/233/206/009-string.md DELETED Viewed

@@ -1,148 +0,0 @@
-# Util.string
-## 使用场景
-该工具类封装了一些常用的字符串验证操作，包括
-- 身份证验证，获取出生日期
-- 邮箱，手机等常见场景的验证
-- 过滤特殊字符等等
-**平台差异**
-|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
-| :---: | :--------: | :--------: | :----------: |
-|   √   |     √      |     √      |      √       |
-## 方法说明
-注：此工具集下的方法以 `Util.string` 为前缀进行调用
-### isInt(str)
-验证一个字符是否是整数
-```js
-Util.string.isInt('1234'); // true
-Util.string.isInt('1s34'); // false
-```
-### isFloat(str)
-判断一个字符串是否是 `数字`
-```js
-Util.string.isFloat('123'); // true
-Util.string.isFloat('123.321'); // true
-Util.string.isFloat('saber'); // false
-```
-### isMobile(str)
-判断一个字符串是不是 `手机号码`
-```js
-Util.string.isMobile('18962299766'); // true
-Util.string.isMobile('1896229976'); // false
-```
-### isTel(str)
-判断一个字符串是不是 `固定电话`
-```js
-Util.string.isTel('051258222222'); // true
-Util.string.isTel('1896229976'); // false
-```
-### isPhone(str)
-判断一个字符串是不是 `电话号码`
-```js
-Util.string.isPhone('18962299766'); // true
-Util.string.isPhone('051258222222'); // true
-Util.string.isPhone('1896229976'); // false
-```
-### isEmail(str)
-判断一个字符串是否是合法的 `EMAIL`
-```js
-Util.string.isEmail('abcd_s.ddf.ff-sss@vip.qq.com'); // true
-Util.string.isEmail('abc@qq.com'); // true
-Util.string.isEmail('abc@.com'); // false
-Util.string.isEmail('-abc@qq.com'); // false
-Util.string.isEmail('abc.@qq.com'); // false
-Util.string.isEmail('ab-.c@qq.com'); // false
-```
-### isPostCode(str)
-判断一个字符串是否是 `邮政编码`
-```js
-Util.string.isPostCode('215600'); // true
-Util.string.isPostCode('21560'); // false
-```
-### isOrgCode(str)
-判断一个字符串是否是 `组织机构代码`
-```js
-Util.string.isOrgCode('91320582704068740Y'); // true
-Util.string.isOrgCode('91320582704068740a'); // false
-```
-### isUrl(str)
-判断一个字符串是否是 `URL`
-```js
-Util.string.isUrl('https://fe.epoint.com.cn/ejs/'); // true
-Util.string.isUrl('https://app.epoint.com.cn/ejs/'); // true
-Util.string.isUrl('ftp://app.epoint.com.cn/'); // true
-Util.string.isUrl('//app.epoint.com.cn/'); // true
-Util.string.isUrl('page/html/api.html'); // false
-Util.string.isUrl('./page/html/api.html'); // false
-Util.string.isUrl('../page/html/api.html'); // false
-```
-### isIdCard(str)
-判断一个字符串是否是 `身份证`
-```js
-Util.string.isIdCard('320926195511175276'); // true
-Util.string.isIdCard('320582199566666614'); // false
-```
-### excludeSpecial(str, reg)
-过滤特殊字符与转义字符，默认大部分的特殊字符都被剔除了，如果不满意，可以传自定义的正则
-```js
-var test="<>?:？》《《《，<><<<<><<<<<<<<|\\\\}}{{{{{PPOTWWERTYUIOSDFGHJKLXCVBNM<)(887676555433222!!@@@##$$%%<<>>??????;;;;''’‘；，。。、。。、090-=-098776654112234567@@##￥%……&&**（（（）））））））！@#￥%……&*（））（&%￥￥#￥%……&**！@~~！！@#￥%……&*（：“：”；“”：：“《》》？？{}哈哈哈哈()~!@@##$%^^&&**(())___+[`!@#$%^&*()_!@#$%^&*()_!@#$%^&*()_+~!@#$^&*()=|{}':;',\\[\\].<>/?~！@#￥……&*（）——|{}【】‘；：”“'。，、？]";
-//  PPOTWWERTYUIOSDFGHJKLXCVBNM887676555433222090--098776654112234567哈哈哈哈______
-Util.string.excludeSpecial(test);
-const test2 = "sdfffjh@s#sk%jn";
-// 用自定义的正则提取，这里只剔除 @和# 结果为: sdfffjhssk%jn
-Util.string.excludeSpecial(test, /[@#]/g);
-```

package/docs/m8mpdoc-develop/006-Util/345/267/245/345/205/267/351/233/206/010-Util/346/211/251/345/261/225/346/214/207/345/215/227.md DELETED Viewed

@@ -1,76 +0,0 @@
-# Util 扩展指南
-<small class="text-muted">维护人：吴松泽</small>
-## 前言
-框架内置了 `Util` 工具类，同时提供了拓展方案，适用场景包括但不局限于
-- 参与框架代码贡献，拓展框架的 `Util`
-- 拓展一个某个项目通用的业务 `Util`
-## 扩展步骤
-以下是一个示例
-### Step1: 编写自己的工具类
-在 `src/utils` 目录下创建 `工具name.js` 文件
-```js
-/*
- * @Author: guotq
- * @Date: 2019-08-19 15:14:19
- * @Last Modified by: guotq
- * @Last Modified time: 2019-08-19 15:14:24
- * @Description: 工具类内容
- */
-const innerUtil = {
-  isDebug: false,
-  method1: function() {
-    console.log(this.attr1);
-  }
-};
-export default innerUtil;
-```
-你可以选择作为一个独立的功能，或者如果你想挂载在 `Util` 工具集下，则按如下方法操作
-打开 `utils/index.js` => 引入组件 => 通过 `export default` 导出
-```js
-import name from './name.js';
-export default {
-  name
-};
-```
-Step2：页面引入与使用工具类
-挂载在 `Util` 中时引入
-```js
-import Util from '@utils';
-// 调用
-Util.name.method();
-```
-作为独立功能引入
-```js
-import tools from '@utils/name';
-// 调用
-tools.method();
-```
-## 注意要点
-#### 头部注释
-上述示例中，一些头部注释没有重复举例，但是实际中需要依据 `代码规范` 添加

package/docs/m8mpdoc-develop/006-Util/345/267/245/345/205/267/351/233/206/011-cookie.md DELETED Viewed

@@ -1,59 +0,0 @@
-# Util.cookie
-## 使用场景
-**平台差异**
-|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
-| :---: | :--------: | :--------: | :----------: |
-|   √   |     √      |     X      |      X       |
-该工具类封装了一些常用的`cookie`操作，包括
-- 设置某个字段值存到`cookie`中
-- 获取`cookie`中的某个字段值
-- 移除`cookie`的某个字段值
-## 方法说明
-注：此工具集下的方法以 `Util.cookie` 为前缀进行调用
-### set(key, value, attributes)
-设置某个字段值存到`cookie`中，且返回设置的字段值和属性，方法默认的属性为：`path=/`。
-`cookie`可设置哪些属性可查看该文档：[cookie](https://developer.mozilla.org/zh-CN/docs/Web/API/Document/cookie)
-**注意**
-若设置的`expires`属性为一个数字，则代表天数。
-```js
-Util.cookie.set('key', 'value'); // “key=value;path=/”
-Util.cookie.set('key', 'value', { 'max-age': '30' }); // “key=value;path=/;max-age=30”
-```
-### get(key)
-获取`cookie`中的某个字段值
-```js
-Util.cookie.get('key');// value
-```
-### remove(key, attributes)
-移除`cookie`的某个字段值。
-**注意**
-若删除的`cookie`字段的属性不是默认属性，必须传递与设置该`cookie`字段时的完全相同的路径`path`和域`domain`属性，否则会删除失败。
-```js
-Util.cookie.remove('key'); // 使用的默认path和domain
-Util.cookie.remove('key', { path: '../' }); // 设置了自定义的path
-```

package/docs/m8mpdoc-develop/006-Util/345/267/245/345/205/267/351/233/206/012-util-sm.md DELETED Viewed

@@ -1,95 +0,0 @@
-# Util.sm
-## 使用场景
-需要使用国密 `sm` 加密的地方
-### sm2.encrypt
-对字符串进行sm2加密
-**平台差异**
-|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
-| :---: | :--------: | :--------: | :----------: |
-|   √   |     √      |     √      |      √       |
-__参数说明__
-| 参数 | 参数类型 | 说明 |
-| :------------- |:-------------:|:-------------|
-| str | String | 需要加密的字符串 |
-| pubkey | String | 公钥 |
-| cipherMode | Number | 加密模式，`0`: C1C2C3, `1`: C1C3C2 |
-**示例**
-```js
-Util.sm2.encrypt(str, pubkey, 0);
-```
-#### 默认公钥
-公司F9框架sm2加密分为`新模式`和`老模式`，对前端开发角度仅公钥不同。
-sm2属于非对称加密算法，即由一个私钥和一个公钥构成的密钥对，普遍通过公钥加密，私钥解密。其中，公钥可以公开，私钥必须保密。
-__老模式公钥__：
-```
-0452712EBA7FE2C9615F6DE59C6EF697F085BD52B25952597DD35014BB8F201987F8D818EFAE710DBEC08FE2E4C7E3E0113EEBAB4B0E8B044E1A3CC8B149D76BE7
-```
-__新模式公钥__：
-```
-04A2C5ABFE372540F0CFAB644776B1CEC911F21739042D9FDF8326324357790DBA3E3900338DE4FFDBA48204A176D444687904422180E0B1E3AF316C4CA09AA704
-```
-### sm2.decrypt
-对字符串进行sm2解密
-**平台差异**
-|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
-| :---: | :--------: | :--------: | :----------: |
-|   √   |     √      |     √      |      √       |
-__参数说明__
-| 参数 | 参数类型 | 说明 |
-| :------------- |:-------------:|:-------------|
-| str | String | 需要解密的字符串 |
-| prikey | String | 私钥 |
-| cipherMode | Number | 解密模式，`0`: C1C2C3, `1`: C1C3C2 |
-**示例**
-```js
-Util.sm2.decrypt(str, prikey, 0);
-```
-### sm3.encrypt
-对字符串进行sm3加密
-**平台差异**
-|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
-| :---: | :--------: | :--------: | :----------: |
-|   √   |     √      |     √      |      √       |
-__参数说明__
-| 参数 | 参数类型 | 说明 |
-| :------------- |:-------------:|:-------------|
-| str | String | 需要加密的字符串 |
-**示例**
-```js
-Util.sm3.encrypt(str);
-```

package/docs/m8mpdoc-develop/006-Util/345/267/245/345/205/267/351/233/206/013-1.baseapi.md DELETED Viewed

@@ -1,76 +0,0 @@
-# 扩展-基础API
-## 使用场景
-使用到涉及小程序扩展的API场景。
-### Util.getLaunchOptionsSync
-获取本次启动时的参数。返回值与App.onLaunch的回调参数一致
-**平台差异**
-|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
-| :---: | :--------: | :--------: | :----------: |
-|   x   |     x      |     √      |      √       |
-__返回参数说明__
-|参数名|类型|说明|平台差异说明|
-|:-|:-|:-|:-|
-|path|String|启动的路径(代码包路径)||
-|scene|Number|启动时的场景值，具体值含义请查看各平台文档说明。钉钉小程序在 IDE 恒为0000，真机不支持。||
-|query|Object|启动时的 query 参数||
-|referrerInfo|Object|来源信息。如果没有则返回 `{}`||
-|forwardMaterials|Array.\<Object\>|打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数|`微信小程序`|
-|chatType|number|打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数|`微信小程序`|
-|apiCategory|string|API 类别|`微信小程序(2.20.0)`|
-**Object referrerInfo**
-|属性|类型|说明|平台差异说明|
-|:-|:-|:-|:-|
-|appId|String|来源小程序 appId ||
-|extraData|Object|来源小程序传过来的数据||
-**示例**
-```js
-Util.getLaunchOptionsSync();
-```
-### Util.getEnterOptionsSync
-获取本次启动时的参数。返回值与App.onLaunch的回调参数一致
-**平台差异**
-|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
-| :---: | :--------: | :--------: | :----------: |
-|   x   |     x      |     √      |      √       |
-__返回参数说明__
-|参数名|类型|说明|平台差异说明|
-|:-|:-|:-|:-|
-|path|String|启动的路径(代码包路径)||
-|scene|Number|启动时的场景值，具体值含义请查看各平台文档说明||
-|query|Object|启动时的 query 参数||
-|referrerInfo|Object|来源信息。如果没有则返回 `{}`||
-|forwardMaterials|Array.\<Object\>|打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数|`微信小程序`|
-|chatType|number|打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数|`微信小程序`|
-|apiCategory|string|API 类别|`微信小程序(2.20.0)`|
-**Object referrerInfo**
-|属性|类型|说明|平台差异说明|
-|:-|:-|:-|:-|
-|appId|String|来源小程序 appId ||
-|extraData|Object|来源小程序传过来的数据。||
-**示例**
-```js
-Util.getEnterOptionsSync();
-```

package/docs/m8mpdoc-develop/006-Util/345/267/245/345/205/267/351/233/206/013-2.network.md DELETED Viewed

@@ -1,202 +0,0 @@
-# 扩展-网络API
-## 使用场景
-使用到涉及`webSocket`网络API场景。
-### Util.connectSocket(OBJECT)
-创建一个 [WebSocket](https://developer.mozilla.org/zh-CN/docs/Web/API/WebSocket) 连接。
-> 在各个小程序平台运行时，网络相关的 API 在使用前需要配置域名白名单。
-**OBJECT 参数说明**
-|参数名|类型|必填|说明|平台差异说明|
-|:-|:-|:-|:-|:-|
-|url|String|是|服务器接口地址|必须是 `wss://` 协议|
-|header|Object|否|HTTP Header , header 中不能设置 Referer|平台小程序|
-|method|String|否|默认是GET，有效值：OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT|仅微信小程序支持|
-|protocols|Array&lt;String&gt;|否|子协议数组|H5、微信小程序|
-|success|Function|否|接口调用成功的回调函数||
-|fail|Function|否|接口调用失败的回调函数||
-|complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）|&nbsp;|
-**示例代码**
-```javascript
-Util.connectSocket({
-	url: 'wss://www.example.com/socket',
-	data() {
-		return {
-			x: '',
-			y: ''
-		};
-	},
-	header: {
-		'content-type': 'application/json'
-	},
-	protocols: ['protocol1'],
-	method: 'GET'
-});
-```
-**返回值**
-如果希望返回一个 [socketTask](/api/request/socket-task) 对象，需要至少传入 success / fail / complete 参数中的一个。例如：
-```javascript
-var socketTask = Util.connectSocket({
-	url: 'wss://www.example.com/socket', //仅为示例，并非真实接口地址。
-	complete: ()=> {}
-});
-```
-如果没有传入 success / fail / complete 参数，则会返回封装后的 Promise 对象。
-**注意事项**
-- 网络请求的 ``超时时间`` 可以统一在 ``manifest.json`` 中配置。
-- 微信小程序平台1.7.0 及以上版本，最多可以同时存在5个WebSocket 连接。老版本只支持一个socket连接
-### Util.onSocketOpen(CALLBACK)
-监听WebSocket连接打开事件。
-**CALLBACK 返回参数**
-|属性|类型|说明|
-|:-|:-|:-|
-|header|Object|连接成功的 HTTP 响应 Header|
-**示例代码：**
-```javascript
-Util.connectSocket({
-  url: 'wss://www.example.com/socket'
-});
-Util.onSocketOpen(function (res) {
-  console.log('WebSocket连接已打开！');
-});
-```
-### Util.onSocketError(CALLBACK)
-监听WebSocket错误。
-**示例代码**
-```javascript
-Util.connectSocket({
-  url: 'wss://www.example.com/socket'
-});
-Util.onSocketOpen(function (res) {
-  console.log('WebSocket连接已打开！');
-});
-Util.onSocketError(function (res) {
-  console.log('WebSocket连接打开失败，请检查！');
-});
-```
-### Util.sendSocketMessage(OBJECT)
-通过 WebSocket 连接发送数据，需要先 [Util.connectSocket](#connectsocket)，并在 [Util.onSocketOpen](#onsocketopen) 回调之后才能发送。
-**OBJECT 参数说明：**
-|参数名|类型|必填|说明|
-|:-|:-|:-|:-|
-|data|String/ArrayBuffer|是|需要发送的内容|
-|success|Function|否|接口调用成功的回调函数|
-|fail|Function|否|接口调用失败的回调函数|
-|complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）|
-**示例代码**
-```javascript
-var socketOpen = false;
-var socketMsgQueue = [];
-Util.connectSocket({
-  url: 'wss://www.example.com/socket'
-});
-Util.onSocketOpen(function (res) {
-  socketOpen = true;
-  for (var i = 0; i < socketMsgQueue.length; i++) {
-    sendSocketMessage(socketMsgQueue[i]);
-  }
-  socketMsgQueue = [];
-});
-function sendSocketMessage(msg) {
-  if (socketOpen) {
-    Util.sendSocketMessage({
-      data: msg
-    });
-  } else {
-    socketMsgQueue.push(msg);
-  }
-}
-```
-### Util.onSocketMessage(CALLBACK)
-监听WebSocket接受到服务器的消息事件。
-**CALLBACK 返回参数**
-|参数|类型|说明|
-|:-|:-|:-|
-|data|String/ArrayBuffer|服务器返回的消息|
-**示例代码：**
-```javascript
-Util.connectSocket({
-  url: 'wss://www.example.com/socket'
-});
-Util.onSocketMessage(function (res) {
-  console.log('收到服务器内容：' + res.data);
-});
-```
-### Util.closeSocket(OBJECT)
-关闭 WebSocket 连接。
-**OBJECT 参数说明**
-|参数名|类型|必填|说明|
-|:-|:-|:-|:-|
-|code|Number|否|一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被指定，默认的取值是1000 （表示正常连接关闭）|
-|reason|String|否|一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本（不是字符）|
-|success|Function|否|接口调用成功的回调函数|
-|fail|Function|否|接口调用失败的回调函数|
-|complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）|
-### Util.onSocketClose(CALLBACK)
-监听WebSocket关闭。
-```javascript
-Util.connectSocket({
-  url: 'wss://www.example.com/socket'
-});
-// 注意这里有时序问题，
-// 如果 Util.connectSocket 还没回调 Util.onSocketOpen，而先调用 Util.closeSocket，那么就做不到关闭 WebSocket 的目的。
-// 必须在 WebSocket 打开期间调用 Util.closeSocket 才能关闭。
-Util.onSocketOpen(function () {
-  Util.closeSocket();
-});
-Util.onSocketClose(function (res) {
-  console.log('WebSocket 已关闭！');
-});
-```