Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 | 23x 8x 8x 8x 8x 8x 8x 5x 33x 33x 33x 33x 33x 33x 7x 7x 7x 7x 7x 5x 5x 26x 33x 33x 1x 1x 2x 2x 2x 2x 12x 12x 1x 8x 1x 1x 2x 1x 1x 1x 1x 3x 1x 26x 26x 26x 26x 26x 26x 7x 7x 26x 26x 1x 25x | import { mapValues, noop } from 'lodash-uni'
import { EventBus, EventBusOffListener } from './EventBus'
import { asyncLimit } from './asyncLimit'
import { LoadResourceUrlType, loadResource } from './loadResource'
declare const wx: any
/**
* 微信 JSSDK 支持的 API。
*
* @public
*/
export type WechatJsApi =
| 'checkJsApi'
| 'updateAppMessageShareData'
| 'updateTimelineShareData'
| 'onMenuShareTimeline'
| 'onMenuShareAppMessage'
| 'onMenuShareQQ'
| 'onMenuShareQZone'
| 'startRecord'
| 'stopRecord'
| 'onVoiceRecordEnd'
| 'playVoice'
| 'pauseVoice'
| 'stopVoice'
| 'onVoicePlayEnd'
| 'uploadVoice'
| 'downloadVoice'
| 'chooseImage'
| 'previewImage'
| 'uploadImage'
| 'downloadImage'
| 'translateVoice'
| 'getNetworkType'
| 'openLocation'
| 'getLocation'
| 'hideOptionMenu'
| 'showOptionMenu'
| 'hideMenuItems'
| 'showMenuItems'
| 'hideAllNonBaseMenuItem'
| 'showAllNonBaseMenuItem'
| 'closeWindow'
| 'scanQRCode'
| 'chooseWXPay'
| 'openProductSpecificView'
| 'addCard'
| 'chooseCard'
| 'openCard'
| 'getLocalImgData'
/**
* @public
*/
export interface WechatConfigParams {
/**
* 开启调试模式。
*
* 调用的所有api的返回值会在客户端 alert 出来，
* 若要查看传入的参数，可以在 pc 端打开，
* 参数信息会通过 log 打出，仅在 pc 端时才会打印。
*
* @default false
*/
debug?: boolean
/**
* 公众号的唯一标识。
*/
appId: string
/**
* 生成签名的时间戳。
*/
timestamp: number | string
/**
* 生成签名的随机串。
*/
nonceStr: string
/**
* 签名。
*/
signature: string
/**
* 需要使用的JS接口列表。
*
* @default []
*/
jsApiList?: WechatJsApi[]
/**
* 是否可分享。
*
* 设置为 `true` 将把分享系列接口自动加入 `jsApiList`。
*
* @default true
*/
sharable?: boolean
/**
* 当全局变量 `wx` 不存在时，自动引入微信 JSSDK。
*
* - 设为 `false` 可禁止自动引入；
* - 设为版本号表示引入特定版本的 JSSDK；
* - 设为链接表示通过该链接引入 JSSDK。
*
* @default '1.4.0'
*/
autoLoadJSSDK?: false | string
}
/**
* @public
*/
export type WechatErrorCallback = (err: any) => void
/**
* @public
*/
export interface WechatUpdateShareDataParams {
/** 分享标题 */
title?: string | (() => string)
/** 分享描述 */
desc?: string | (() => string)
/** 分享链接，该链接域名或路径必须与当前页面对应的公众号 JS 安全域名一致 */
link?: string | (() => string)
/** 分享图标地址 */
imgUrl?: string | (() => string)
}
/**
* @public
*/
export interface WechatChooseImageParams {
/**
* 选择图片数量。
*
* @default 9
*/
count?: number
/**
* 图片质量，可以指定是原图还是压缩图。
*
* @default ['original', 'compressed']
*/
sizeType?: Array<'original' | 'compressed'>
/**
* 选择来源，可以指定是相册还是相机。
*
* @default ['album', 'camera']
*/
sourceType?: Array<'album' | 'camera'>
}
/**
* @public
*/
export type WechatChooseImageResult = Array<{
/** 本地 ID，用于上传 */
localId: string
/** 预览链接，已兼容 iOS WKWebview */
previewUrl: string
}>
/**
* @public
*/
export interface WechatPreviewImageParams {
/**
* 当前显示图片的链接。
*
* @default urls[0]
*/
current?: string
/**
* 需要预览的图片链接列表。
*/
urls: string[]
}
/**
* @public
*/
export interface WechatUploadImageParams {
/**
* 需要上传的图片的本地 ID，由 chooseImage 接口获得。
*/
localId: string
/**
* 是否显示进度提示。
*
* @default false
*/
isShowProgressTips?: boolean
}
/**
* @public
*/
export interface WechatUploadImageResult {
/**
* 图片的服务器 ID，即临时素材 ID。
*/
serverId: string
}
/**
* @public
*/
export interface WechatGetLocationParams {
/**
* 默认为 wgs84 的 gps 坐标，如果要返回直接给 openLocation 用的火星坐标，可传入 gcj02。
*/
type?: 'wgs84' | 'gcj02'
}
/**
* @public
*/
export interface WechatGetLocationResult {
/**
* 纬度，浮点数，范围为90 ~ -90。
*/
latitude: number
/**
* 经度，浮点数，范围为180 ~ -180。
*/
longitude: number
/**
* 速度，以米/每秒计。
*/
speed: number
/**
* 位置精度。
*/
accuracy: number
}
/**
* @public
*/
export interface WechatOpenLocationParams {
/**
* 纬度，浮点数，范围为 90 ~ -90。
*/
latitude: number
/**
* 经度，浮点数，范围为 180 ~ -180。
*/
longitude: number
/**
* 位置名。
*/
name: string
/**
* 地址详情说明。
*/
address?: string
/**
* 地图缩放级别，整形值，范围从 1 ~ 28。
*
* @default 28
*/
scale?: number
/**
* 在查看位置界面底部显示的超链接，可点击跳转。
*/
infoUrl?: string
}
export interface WechatRequestPaymentParams {
/**
* 支付签名时间戳。
*/
timestamp: number
/**
* 支付签名随机串。
*/
nonceStr: string
/**
* 统一支付接口返回的 prepay_id 参数值，如：`prepay_id=xxx`。
*/
package: string
/**
* 签名方式。
*/
signType: string
/**
* 支付签名。
*/
paySign: string
}
/**
* 微信内网页的非基础菜单列表。
*
* @public
*/
export type WechatNonBaseMenuItem =
| 'menuItem:share:appMessage'
| 'menuItem:share:timeline'
| 'menuItem:share:qq'
| 'menuItem:share:weiboApp'
| 'menuItem:favorite'
| 'menuItem:share:facebook'
| 'menuItem:share:QZone'
| 'menuItem:editTag'
| 'menuItem:delete'
| 'menuItem:copyUrl'
| 'menuItem:originPage'
| 'menuItem:readMode'
| 'menuItem:openWithQQBrowser'
| 'menuItem:openWithSafari'
| 'menuItem:share:email'
| 'menuItem:share:brand'
/**
* 微信 JSSDK 支持的分享 API 列表。
*/
const shareJsApiList: WechatJsApi[] = [
'updateAppMessageShareData',
'updateTimelineShareData',
'onMenuShareAppMessage',
'onMenuShareTimeline',
'onMenuShareQQ',
'onMenuShareQZone',
]
export type WechatBeforeInvokeCallback = (
jsApi: WechatJsApi,
params: Record<string, any>,
) => any
/**
* 对微信 JSSDK 的封装。
*
* @public
* @example
* ```typescript
* const wechat = new Wechat()
* getWechatConfigAsync().then(config => {
* wechat.config(config)
* })
* wechat.updateShareData({
* title: '分享标题',
* desc: '分享描述',
* link: '分享链接',
* imgUrl: '缩略图地址',
* })
* wechat.invoke('scanQRCode').then(res => {
* // => API 调用结果
* })
* ```
*/
export class Wechat {
/**
* 微信 JSSDK 是否已准备完成。
*/
private ready = false
/**
* 消息巴士。
*/
private bus = new EventBus<{
/**
* 微信 JSSDK 准备完成时触发。
*/
ready: () => void
/**
* 调用微信 JSSDK 出错时时触发。
*/
error: WechatErrorCallback
}>()
/**
* 上一次设置分享时的参数。
*/
private prevShareParams: WechatUpdateShareDataParams = {}
private beforeInvokeCallbacks: WechatBeforeInvokeCallback[] = []
/**
* 注入微信 `JSSDK` 的权限验证配置参数。
*/
public configParams: WechatConfigParams = {} as any
/**
* 构造函数。
*
* @param params 注入微信 `JSSDK` 的权限验证配置参数
*/
constructor(params?: WechatConfigParams) {
if (params) {
this.config(params)
}
}
/**
* 注入微信 `JSSDK` 的权限验证配置。
*
* @param params 配置参数
*/
config(params: WechatConfigParams = this.configParams): Promise<void> {
return new Promise<void>((resolve, reject) => {
this.configParams = params
const config = () => {
const sharable =
typeof params.sharable === 'boolean' ? params.sharable : true
wx.config({
...params,
jsApiList: [
...(params.jsApiList || []),
...(sharable ? shareJsApiList : []),
],
})
if (!this.ready) {
wx.ready(() => {
this.ready = true
this.bus.emit('ready')
resolve()
})
wx.error((err: any) => {
this.bus.emit('error', err)
reject(err)
})
} else {
resolve()
}
}
if (typeof wx !== 'undefined') {
config()
} else E{
const autoLoadJSSDK =
params.autoLoadJSSDK == null ? '1.6.0' : params.autoLoadJSSDK
if (autoLoadJSSDK !== false) {
const jssdkUrl = /^[0-9.]+$/.test(autoLoadJSSDK)
? `https://res.wx.qq.com/open/js/jweixin-${autoLoadJSSDK}.js`
: autoLoadJSSDK
const alternateJssdkUrl = jssdkUrl.replace(
/^https:\/\/res\.wx\.qq\.com\//,
'https://res2.wx.qq.com/',
)
loadResource({
type: LoadResourceUrlType.js,
path: jssdkUrl,
alternatePath: alternateJssdkUrl,
})
.then(([scriptEl]) => {
scriptEl.parentNode?.removeChild(scriptEl)
}, noop)
.then(() => {
if (typeof wx === 'undefined') {
reject('微信 JSSDK 加载失败')
} else {
config()
}
})
} else {
if (typeof wx === 'undefined') {
reject('请先引入微信 JSSDK')
} else {
config()
}
}
}
})
}
/**
* 微信 JSSDK 是否准备好可用。
*/
isReady() {
return this.ready
}
/**
* 判断当前客户端版本是否支持指定 JS 接口。
*
* @param jsApiList 需要检测的 JS 接口列表
* @returns 以键值对的形式返回，可用的 `api` 值 `true`，不可用为 `false`
*/
checkJsApi<T extends WechatJsApi>(
jsApiList: T[],
): Promise<Record<T, boolean>> {
return this.invoke<
{
jsApiList: T[]
},
{
checkResult: Record<T, boolean>
}
>('checkJsApi', { jsApiList }).then(res => res.checkResult)
}
/**
* 设置分享数据。
*
* **注意**：每次分享的数据会和上次分享的数据合并作为最终分享的数据，因此，可以设置全局的分享数据。
*
* @param params 分享数据
*/
updateShareData(params: WechatUpdateShareDataParams): Promise<void> {
params = {
...this.prevShareParams,
...params,
}
this.prevShareParams = params
params = mapValues(params, value =>
typeof value === 'function' ? value() : value,
)
return shareJsApiList.reduce<Promise<any>>((prev, jsApi) => {
const next = () => this.invoke<WechatUpdateShareDataParams>(jsApi, params)
return prev.then(next, next)
}, Promise.resolve())
}
/**
* 选择图片。
*
* @param params 参数
* @returns 选定照片的本地 ID 列表，它们可以作为 img 标签的 src 属性显示图片
*/
chooseImage(
params?: WechatChooseImageParams,
): Promise<WechatChooseImageResult> {
return this.invoke<
WechatChooseImageParams,
{
localIds: string[]
}
>('chooseImage', params).then(res => {
// @ts-ignore
if (window.__wxjs_is_wkwebview) {
return Promise.all(
res.localIds.map(localId =>
this.invoke<
{
localId: string
},
{
localData: string
}
>('getLocalImgData', { localId }).then(res => ({
localId: localId,
previewUrl: res.localData,
})),
),
)
}
return res.localIds.map(localId => ({
localId: localId,
previewUrl: localId,
}))
})
}
/**
* 预览图片。
*
* @param params 参数
*/
previewImage(params: WechatPreviewImageParams): Promise<any> {
return this.invoke<WechatPreviewImageParams>('previewImage', {
urls: params.urls,
current: params.current || params.urls[0],
})
}
/**
* 上传图片。
*
* 内部已作处理保证同时只能有一个图片在上传。
*
* **备注：** 上传图片有效期3天，
* 可用微信多媒体接口下载图片到自己的服务器，
* 此处获得的服务器端 ID 即 `media_id`。
*
* @param params 参数
*/
uploadImage = asyncLimit(
(params: WechatUploadImageParams): Promise<WechatUploadImageResult> => {
return this.invoke<
{
localId: string
isShowProgressTips: 0 | 1
},
{
serverId: string
}
>('uploadImage', {
localId: params.localId,
isShowProgressTips: params.isShowProgressTips ? 1 : 0,
})
},
{
// https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html
// 附录5-常见错误及解决方法
// 9.uploadImage怎么传多图（目前只支持一次上传一张，多张图片需等前一张图片上传之后再调用该接口）
concurrency: 1,
},
)
/**
* 获取地理位置接口。
*
* @param params 参数
*/
getLocation(
params?: WechatGetLocationParams,
): Promise<WechatGetLocationResult> {
return this.invoke<WechatGetLocationParams>('getLocation', params || {})
}
/**
* 使用微信内置地图查看位置。
*
* @param params 参数
*/
openLocation(params: WechatOpenLocationParams): Promise<any> {
return this.invoke<WechatOpenLocationParams>('openLocation', params)
}
/**
* 关闭当前网页窗口。
*/
closeWindow(): Promise<any> {
return this.invoke('closeWindow')
}
/**
* 批量隐藏非基础菜单项。
*
* @param menuList 要隐藏的非基础菜单项列表
*/
hideNonBaseMenuItems(menuList: WechatNonBaseMenuItem[]): Promise<any> {
return this.invoke<{
menuList: WechatNonBaseMenuItem[]
}>('hideMenuItems', { menuList })
}
/**
* 批量显示非基础菜单项。
*
* @param menuList 要显示的非基础菜单项列表
*/
showNonBaseMenuItems(menuList: WechatNonBaseMenuItem[]): Promise<any> {
return this.invoke<{
menuList: WechatNonBaseMenuItem[]
}>('showMenuItems', { menuList })
}
/**
* 隐藏所有的非基础菜单项。
*/
hideAllNonBaseMenuItems(): Promise<any> {
return this.invoke('hideAllNonBaseMenuItem')
}
/**
* 显示所有的非基础菜单项。
*/
showAllNonBaseMenuItems(): Promise<any> {
return this.invoke('showAllNonBaseMenuItem')
}
/**
* 发起微信支付。
*
* @param params 参数
*/
requestPayment(params: WechatRequestPaymentParams): Promise<any> {
return this.invoke('chooseWXPay', params)
}
/**
* 错误处理。
*
* @param callback 出错时的回调函数
*/
onError(callback: WechatErrorCallback): EventBusOffListener {
return this.bus.on('error', callback)
}
beforeInvoke(cb: WechatBeforeInvokeCallback) {
this.beforeInvokeCallbacks.push(cb)
}
/**
* 调用 JSSDK 的 API 方法。
*
* @param jsApi 要调用的 API 名称
* @param params 传给 API 的参数
* @returns 调用结果
*/
invoke<P extends Record<string, any> = Record<string, any>, T = any>(
jsApi: WechatJsApi,
params: P = {} as any,
): Promise<T> {
return new Promise((resolve, reject) => {
const invoke = async () => {
Iif (!wx[jsApi]) return reject(`wx.${jsApi} 不可用`)
try {
this.config()
if (this.beforeInvokeCallbacks.length) {
await Promise.all(
this.beforeInvokeCallbacks.map(cb => cb(jsApi, params)),
)
}
wx[jsApi]({
...params,
success: resolve,
fail: reject,
cancel: reject,
})
} catch (err) {
reject(err)
}
}
if (typeof wx === 'undefined' || !this.ready) {
this.bus.once('ready', invoke)
} else {
invoke()
}
})
}
}
|