@bnfe/wx-utils

@bnfe/wx-utils

这是一个集成wx和企微jssdk

安装

``sh
pnpm install @bnfe/wx-utils -S
`

引入

`js
import wxSDK from "@bnfe/wx-utils";
`

使用

$3

> 参考文档

公众号授权流程

开放平台授权流程

公众号JS-SDK

| 事件名称 | 说明 | 回调参数 |
| :------------: | :--------------------------: | :--------: |
| wxAuth | 发起公众号授权 | - |
| thirdLogin | 开放平台代公众号发起网页授权 | - |
| injectWxConfig | 微信注入权限验证配置 | 授权结果 |

`js
/**
* 发起公众号授权
* @param {string} env 环境变量，可选值为 'dev' 或 'prod'
* @param {string} appId 应用的appId
* @param {string} scope 需要授权的范围，可选值为'snsapi_userinfo'或'snsapi_base'，默认snsapi_base
* @return
*/
wxSDK.wxAuth(env, appId, scope);
`

`js
/**
* 开放平台代公众号发起网页授权
* @param {string} env 环境变量
* @param {string} appId 应用的appId
* @param {string} scope 需要授权的范围,可选值为'snsapi_userinfo'或'snsapi_base'，默认snsapi_base
* @return
*/
wxSDK.thirdLogin(env, appId, scope);
`

`js
/**
* 微信注入权限验证配置
* @param {string} env 环境变量，可选值为 'dev' 或 'prod'
* @param {string} appId 企微应用的appId
* @param {string[]} jsApiList 需要注入的权限
*/
wxSDK.injectWxConfig(env, appId, jsApiList);
`

$3

> 参考文档

构造企业微信授权链接

企业微信JS-SDK

| 事件名称 | 说明 | 回调参数 |
| :-------------------: | :------------------: | :----------: |
| workWxAuth | 发起企业微信授权 | - |
| getWorkWxUserId | 获取企业微信用户id | 企微用户id |
| getWorkWxAuthLink | 获取企微授权链接 | 授权链接 |
| injectWorkWxConfig | 企信注入权限验证配置 | 授权结果 |
| getCurExternalContact | 获取外部联系人id | 外部联系人id |

`js
/**
* 发起企业微信授权
* @param {string} env 环境变量，可选值为 'dev' 或 'prod'
* @param {string} appId 企微的corpId
* @param {string} agentId 企微应用的appId
*/
wxSDK.workWxAuth(env, appId, agentId);
`

`js
/**
* 企微授权获取企微用户id
* @param {string} env 环境变量，可选值为 'dev' 或 'prod'
* @param {string} appId 企微的corpId
* @param {string} agentId 企微应用的appId
*/
wxSDK.getWorkWxUserId(env, appId, agentId);
`

`js
/**
* 企微授权链接（一般在设置应用主页、配置到聊天工具栏、消息推送时使用，可避免页面重复跳转）
* @param {string} env 环境变量，可选值为 'dev' 或 'prod'
* @param {string} appId 企微的corpId
* @param {string} agentId 企微应用的appId
*/
wxSDK.getWorkWxAuthLink(env, appId, agentId);
`

`js
/*
* 企微注入
* @param {string} env 环境变量，可选值为 'dev' 或 'prod'
* @param {string} appId 企微corpId
* @param {string} agentId 企微应用的id 例如：1000144
* @param {string[]} jsApiList 需要注入的权限
* @returns
/
wxSDK.injectWorkWxConfig(env, appId, agentId, jsApiList);
`

`js
/**
* 获取外部联系人id（getContext获取入口环境，getCurExternalContact获取外部联系人id）
* 从某些入口进入页面时，可调用该接口获取当前客户的userid（也即external_userid)，目前支持的入口有联系人详情页、外部单聊工具栏
* @param {string} env 环境变量
* @param {string} appId 企微corpId
* @param {string} agentId 企微应用的id 例如：1000144
* @returns
/
wxSDK.getCurExternalContact(env, appId, agentId);
``