szyd-child-sdk

数字盐电专用子系统接入 SDK，提供与父系统通信所需的 messageBus、request、userInfo 获取、wx 桥接四个模块。

安装

npm install szyd-child-sdk

快速开始

在子系统入口文件（如 main.ts）中初始化：

import { messageBus, createRequest, initFetchUserInfo, initWxBridge } from 'szyd-child-sdk'

// 1. 配置父系统 origin（开发联调时指定，生产同域可省略）
messageBus.config({ parentOrigin: 'http://localhost:8000' })

// 2. 创建 request 实例
export const request = createRequest({ appSecretId: import.meta.env.VITE_APP_SECRET_ID })

// 3. 初始化 userInfo 获取（一次性，收到响应后自动卸载）
initFetchUserInfo({
  onUserInfo: (userInfo) => {
    // 在此处理用户信息，如存入 store、跳转路由等
    store.setUserInfo(userInfo)
    router.push('/home')
  }
})

// 4. 初始化 wx 桥接（调用一次，之后全局可直接使用 wx.xxx()）
initWxBridge()

API

messageBus

全局唯一的 postMessage 消息总线，各模块内部使用，通常无需直接调用。

// 配置允许的父系统 origin
messageBus.config({ parentOrigin: 'http://localhost:8000' })

// 订阅消息
messageBus.on('SOME_TYPE', (event) => { ... })

// 取消订阅
messageBus.off('SOME_TYPE', handler)

createRequest(options)

创建通过父系统代理的 request 实例，子系统所有网络请求均走此链路。

| 参数 | 类型 | 说明 | | ----------------------- | ---------- | --------------------------- | | options.appSecretId | string | 子系统鉴权 ID，由父系统分配 |

const request = createRequest({ appSecretId: 'your-app-secret-id' })

// 使用方式与 axios 一致
const res = await request<UserInfo>({ url: '/api/user', method: 'get' })

// 强制走父系统 API 实例
const res = await request({ url: '/api/data', method: 'post', isParentApi: true, data: { ... } })

initFetchUserInfo(options)

向父系统请求用户信息，通过回调返回结果。收到一次响应后自动卸载监听，无需手动清理。

| 参数 | 类型 | 说明 | | ---------------------- | --------------------------------------- | -------------------- | | options.onUserInfo | (userInfo: UserInfo \| null) => void | 收到用户信息时的回调 |

initFetchUserInfo({
  onUserInfo: (userInfo) => {
    if (userInfo) {
      store.setUserInfo(userInfo)
    }
  }
})

initWxBridge()

替换全局 window.wx 为代理对象，之后业务代码中可直接使用原生 wx.xxx() 调用方式，内部自动通过 postMessage 代理到父系统执行。

在入口处调用一次即可：

initWxBridge()

之后正常使用：

wx.startRecord()

wx.stopRecord({
  success: async (res) => {
    const localId = res.localId
    wx.translateVoice({
      localId,
      isShowProgressTips: 1,
      success: (res) => {
        console.log(res.translateResult)
      },
    })
  },
})