@sofastapp/api
v0.0.3
Published
Sofast SDK for building plugins and integrations.
Readme
@sofastapp/api
Sofast 插件/集成开发 SDK。提供基础类型与最小工具函数,帮助插件在 view(no-view 后续扩展) 模式下与宿主交互。
安装
在工作区中(建议使用 pnpm workspace 管理),将本包作为依赖添加:
npx pnpm -w add @sofastapp/api注意:本仓库内该包为源码包,首次需要在包目录下安装开发依赖并构建。
开发
# 在本包目录下(extensions/packages/api)
npx pnpm i
npx pnpm buildAPI 概览
inSofastIframe():检测是否处于 Sofast 的 iframe 环境getCurrentCommand():获取当前 URL 上的cmd参数getSessionId():获取当前 URL 上的sid参数loadManifest(pkg):从package.json的sofast字段读取并校验 ManifestpostToHost(message):向宿主发送消息(postMessage)subscribeHostMessage(handler):订阅来自宿主的消息
构建
使用 tsup 生成 ESM + CJS + 类型声明:
npx pnpm build