live-mp-tools

暴露的接口

AppId：
主干环境：wx0c3417205d9852a9
测试环境：wxb58a41ffda339bf5
正式环境：wx13a74d0d3ab0942e

暴露的环境名字段：ENV_NAME（环境）、LIVE_BASE_URL（请求域名）

ENV：inside. 主干环境 test. 测试环境 '' 正式环境

业务请求域名 https://applet-server.${ENV}xiaoeknow.com

live 对应鹅直播主干业务

player 对应h5直播间业务

需要在开发者工具手动缓存一个 storeId （店铺ID），若不设定默认店铺ID appmzd7lhrj6214。

* @description 网络请求发送
* @param {String} method 网络请求类型 get/post
* @param {String} url 网络请求地址
* @param {Object} params 请求传参
* @param {Boolean} [isNeedBiz=true] 是否需要在传参外层用 bizData 变量包裹。例如：传参为{a: 1}，用bizData包裹后为{bizData: {a: 1}}
* @param {Object} [config={}] 网络请求 header 扩展（非必传）
* @param {host} [host=''] host 自定义扩展（非必传）

``



// 请求示例

const http = require('live-mp-tools')



const url = "_alive/v2/base_info"

const param = {

  resource_id: 'l_617a430c60b219052d7eb94a',

  type: 12,

  app_id: 'appyhdtiy2a1818'

}

const isNeedBiz = false

const config = {} // header 扩展 （可不传） 

const host = 'captcha.xiaoeknow.com' （可不传） // 直接传现网业务域名，包内已作环境判断

const res = await http.player.get(url, param, isNeedBiz, config, host)







更新版本

1.2.6 更新内容：limitKoToken 限制接口请求标识，处理直播间 baseInfo 接口极限异常情况，标识后续接口不调取直接 return。



1.2.3 & 1.2.4 更新内容：utils 新增资源压缩加速方法。



1.2.2 更新内容：playerHttp 精准正则匹配条件添加请求头信息。



1.2.1 更新内容：对获取kotoken登录接口作处理，防止接口出错阻塞。



1.2.0 更新内容：1.将请求封装改成类的形式。 2.暴露请求域名。



1.1.9 更新内容：封装的请求接口增加重新登录次数限制（5次）。



1.1.8 更新内容：增加埋点封装。







开发



1. 安装依赖：



npm install





2. 执行命令：npm run dev

默认会在包根目录下生成 miniprogram\_dev 目录，src 中的源代码会被构建并生成到 miniprogram\_dev/components 目录下。如果需要监听文件变化动态构建，则可以执行命令：npm run watch





目录结构



以下为推荐使用的目录结构，如果有必要开发者也可以自行做一些调整:



|--miniprogram_dev // 开发环境构建目录

|--miniprogram_dist // 生产环境构建目录

|--src // 源码

|   |--components // 通用自定义组件

|   |--images // 图片资源

|   |

|   |--xxx.js/xxx.wxml/xxx.json/xxx.wxss // 暴露的 js 模块/自定义组件入口文件

|

|--test // 测试用例

|--tools // 构建相关代码

|   |--demo // demo 小程序目录，开发环境下会被拷贝生成到 miniprogram_dev 目录中

|   |--config.js // 构建相关配置文件

|

|--gulpfile.js





> PS：对外暴露的 js 模块/自定义组件请放在 src 目录下，不宜放置在过深的目录。另外新增的暴露模块需要在 tools/config.js 的 entry 字段中补充，不然不会进行构建。



其他命令

* 上传npm包：



npm run build



npm login



npm publish





* 清空 miniprogram_dist 目录：



npm run clean





* 清空 miniprogam_dev 目录：



npm run clean-dev

live-mp-tools

暴露的接口



// 请求示例

const http = require('live-mp-tools')



const url = "_alive/v2/base_info"

const param = {

  resource_id: 'l_617a430c60b219052d7eb94a',

  type: 12,

  app_id: 'appyhdtiy2a1818'

}

const isNeedBiz = false

const config = {} // header 扩展 （可不传） 

const host = 'captcha.xiaoeknow.com' （可不传） // 直接传现网业务域名，包内已作环境判断

const res = await http.player.get(url, param, isNeedBiz, config, host)







更新版本

1.2.6 更新内容：limitKoToken 限制接口请求标识，处理直播间 baseInfo 接口极限异常情况，标识后续接口不调取直接 return。



1.2.3 & 1.2.4 更新内容：utils 新增资源压缩加速方法。



1.2.2 更新内容：playerHttp 精准正则匹配条件添加请求头信息。



1.2.1 更新内容：对获取kotoken登录接口作处理，防止接口出错阻塞。



1.2.0 更新内容：1.将请求封装改成类的形式。 2.暴露请求域名。



1.1.9 更新内容：封装的请求接口增加重新登录次数限制（5次）。



1.1.8 更新内容：增加埋点封装。







开发



1. 安装依赖：



npm install





2. 执行命令：npm run dev

默认会在包根目录下生成 miniprogram\_dev 目录，src 中的源代码会被构建并生成到 miniprogram\_dev/components 目录下。如果需要监听文件变化动态构建，则可以执行命令：npm run watch





目录结构



以下为推荐使用的目录结构，如果有必要开发者也可以自行做一些调整:



|--miniprogram_dev // 开发环境构建目录

|--miniprogram_dist // 生产环境构建目录

|--src // 源码

|   |--components // 通用自定义组件

|   |--images // 图片资源

|   |

|   |--xxx.js/xxx.wxml/xxx.json/xxx.wxss // 暴露的 js 模块/自定义组件入口文件

|

|--test // 测试用例

|--tools // 构建相关代码

|   |--demo // demo 小程序目录，开发环境下会被拷贝生成到 miniprogram_dev 目录中

|   |--config.js // 构建相关配置文件

|

|--gulpfile.js





> PS：对外暴露的 js 模块/自定义组件请放在 src 目录下，不宜放置在过深的目录。另外新增的暴露模块需要在 tools/config.js 的 entry 字段中补充，不然不会进行构建。



其他命令

* 上传npm包：



npm run build



npm login



npm publish





* 清空 miniprogram_dist 目录：



npm run clean





* 清空 miniprogam_dev 目录：



npm run clean-dev