SDK 概览

mini-sdk 是 MiniDev Studio 的核心 SDK，提供小程序运行时所需的全部客户端 API。开发者通过默认导出的 woo 对象调用所有能力。

安装与导入

SDK 已内置于 MiniDev Studio 运行时，无需额外安装。直接导入即可：

import woo from 'mini-sdk'

// 或按命名空间导入
import { router, network, storage, ui, lifecycle } from 'mini-sdk'

API 分类总览

命名空间	说明	常用方法
Router	页面路由导航	navigateTo navigateBack reLaunch
Network	网络请求	request request.get request.post
Storage	本地数据存储	setStorage getStorage removeStorage
UI	界面交互反馈	showToast showDialog showLoading
Lifecycle	页面生命周期	onLoad onShow onHide onUnload
Clipboard	剪贴板操作	setClipboard getClipboard
Device	设备能力	getSystemInfo scanCode getLocation
Auth	认证鉴权	requestSSOLogin getUserProfile
Analytics	数据分析	recordEvent enableAutoAnalytics
Vehicle	车辆信息	getCurrentVehicleProfile getCurrentVehicleStatus
Map	地图操作	createMapContext
Component	组件操控	createVideoContext createSelectorQuery
App	应用级 API	getLaunchOptionsSync onAppShow

调用模式

所有 API 同时支持 Promise 和 Callback 两种调用方式：

Promise 模式（推荐）

try {
  const result = await woo.getStorage({ key: 'userToken' })
  console.log(result.data)
} catch (err) {
  console.error('获取失败：', err.message)
}

Callback 模式

woo.getStorage({
  key: 'userToken',
  success(result) {
    console.log(result.data)
  },
  fail(err) {
    console.error('获取失败：', err.message)
  },
  complete() {
    console.log('请求完成')
  },
})

ApiCallbacks 类型定义

interface ApiCallbacks<T = unknown> {
  success?: (res: T) => void
  fail?: (err: BridgeError) => void
  complete?: () => void
}

woo 全局对象

woo 是一个扁平对象，聚合了所有命名空间的方法。以下两种写法等价：

// 通过 woo 调用
woo.navigateTo({ url: '/pages/detail/index' })

// 通过命名空间调用
import { router } from 'mini-sdk'
router.navigateTo({ url: '/pages/detail/index' })

核心导出

除了 API 方法，SDK 还导出以下核心能力：

// Bridge 实例与构造器
export { bridge, Bridge } from 'mini-sdk'

// 环境检测
export { detectEnv, isSimulator, isNative } from 'mini-sdk'

// Transport 层
export { createTransport } from 'mini-sdk'

// 错误处理
export { setErrorHandler, getErrorMessage, BridgeErrorCode } from 'mini-sdk'

类型导出

SDK 完整导出所有 TypeScript 类型，便于类型安全开发：

import type {
  BridgeEnvelope,
  BridgeError,
  BridgeType,
  ApiCallbacks,
  NavigateToOptions,
  RequestOptions,
  RequestResult,
  // ... 更多类型
} from 'mini-sdk'