@lark-apaas/miaoda-coding-sdk
v0.0.6
Published
CDN distribution of aPaaS Web SDK for no-build HTML — self-contained IIFE entries consumed via <script src>
Keywords
Readme
@lark-apaas/miaoda-coding-sdk
面向无编译 HTML 技术栈的 CDN 分发包。每个 entry 是一份自包含的 IIFE 产物,HTML 直接通过 <script src> 引入即用,挂载为独立的全局变量——无需任何构建步骤。
用法
按 unpkg 风格引用(CDN 域名待定,版本即 URL,建议精确 pin 版本):
<!-- 开发:未压缩、不自动上报(NODE_ENV=development),便于调试 -->
<script src="https://<cdn>/@lark-apaas/[email protected]/dist/runtime.dev.js"></script>
<!-- 生产:压缩、引入即自动上报一次页面浏览 VIEW(NODE_ENV=production) -->
<script src="https://<cdn>/@lark-apaas/[email protected]/dist/runtime.min.js"></script>
<script>
// 引入后挂载在 window.MiaodaRuntime
console.log(window.MiaodaRuntime.version);
// 手动上报自定义埋点事件
window.MiaodaRuntime.reportTeaEvent({ trackKey: 'my_event', trackParams: { foo: 'bar' } });
</script>每个 entry 出三份:
<name>.dev.js(development,未压缩)/<name>.js(production,未压缩)/<name>.min.js(production,压缩)。window.collectEvent(TEA 采集 SDK)由宿主注入,未注入时静默 no-op。
Entry 一览
| Entry | 文件 | 全局变量 | 状态 |
|---|---|---|---|
| runtime | dist/runtime.dev.js / .js / .min.js | window.MiaodaRuntime | ✅ TEA 埋点上报 |
| doubao-runtime | dist/doubao-runtime.dev.js / .js / .min.js | window.MiaodaRuntime | ✅ runtime + 豆包水印 |
runtime与doubao-runtime互斥引用:豆包来源应用引doubao-runtime.js(多注入右下角「由 豆包AI 生成」水印),其余引runtime.js。两者同一 API(window.MiaodaRuntime)。规划中(尚未实现):
performance/helm/desk等业务 entry,按需新增(ENTRIES 加一项 + 建src/<name>.ts)。
设计要点
- 每个 entry 自包含、互不依赖,依赖全部 inline,各占一个独立全局变量(不收口统一命名空间)。
- 纯 IIFE 产物,只走
<script>挂全局,不提供 ESM/CJS/UMD。 - 构建用
tsup(配置数组,每个 entry 独立globalName),每 entry 出.dev.js/.js/.min.js三份(process.env.NODE_ENV区分 dev/online);不生成 sourcemap(对外分发不暴露源码 map)。 - 新增 entry:在
tsup.config.ts的ENTRIES加一项 + 新建对应src/<name>.ts。
详见设计文档 docs/superpowers/specs/2026-06-05-miaoda-coding-sdk-design.md。
本地验证
yarn workspace @lark-apaas/miaoda-coding-sdk build
# 用浏览器打开 examples/runtime.html,控制台应打印 runtime 信息