@doubao-apps/ai 0.0.34 → 0.0.35

package/README.md

@@ -2,6 +2,8 @@
 
 Doubao Apps SDK AI 工具，为 AI coding agents 提供 skills 管理。
 
+该包随发布产物携带 `packages/ai` 编译出的 public skill profile；安装命令不会在本地再做文档 rewrite。
+
 ## 安装
 
 ```bash

package/dist/cli.js

@@ -1,2 +1,2 @@
-import"node:module";import{__webpack_require__ as o}from"./rslib-runtime.js";import"./733.js";(0,o("../../ai/dist/cli.js").runCli)({commandName:"doubao-cli",preferBundledAssets:!0});
+import"node:module";import{runCli as o}from"./index.js";o({commandName:"doubao-cli"});
 //# sourceMappingURL=cli.js.map

package/dist/index.d.ts

@@ -1,7 +1,10 @@
 export declare function runCli(options?: RunCliOptions): void;
 
-declare interface RunCliOptions {
+export declare interface RunCliOptions {
     commandName?: string;
+    profile?: SkillProfile;
 }
 
+declare type SkillProfile = 'internal' | 'public';
+
 export { }

package/dist/index.js

@@ -1 +1,33 @@
-import"node:module";import{__webpack_require__ as _}from"./rslib-runtime.js";import"./733.js";var i=_("../../ai/dist/cli.js").runCli;export{i as runCli};
+import{createRequire as l}from"node:module";import{__webpack_require__ as o}from"./rslib-runtime.js";import{fileURLToPath as e}from"node:url";import{dirname as s}from"node:path";let t=l(import.meta.url);o.add({"node:fs"(l){l.exports=t("node:fs")},"node:path"(l){l.exports=t("node:path")},"../../ai/dist/cli.js"(l,o,t){var i=s(e(import.meta.url));let a=t("node:fs"),n=t("node:path"),r=new Set(["internal","public"]),c={amp:{projectPath:".agents/skills/",globalPath:"~/.config/agents/skills/"},"kimi-cli":{projectPath:".agents/skills/",globalPath:"~/.config/agents/skills/"},replit:{projectPath:".agents/skills/",globalPath:"~/.config/agents/skills/"},universal:{projectPath:".agents/skills/",globalPath:"~/.config/agents/skills/"},antigravity:{projectPath:".agent/skills/",globalPath:"~/.gemini/antigravity/skills/"},augment:{projectPath:".augment/skills/",globalPath:"~/.augment/skills/"},claude:{projectPath:".claude/skills/",globalPath:"~/.claude/skills/"},"claude-code":{projectPath:".claude/skills/",globalPath:"~/.claude/skills/"},openclaw:{projectPath:"skills/",globalPath:"~/.openclaw/skills/"},cline:{projectPath:".agents/skills/",globalPath:"~/.agents/skills/"},codebuddy:{projectPath:".codebuddy/skills/",globalPath:"~/.codebuddy/skills/"},codex:{projectPath:".agents/skills/",globalPath:"~/.codex/skills/"},"command-code":{projectPath:".commandcode/skills/",globalPath:"~/.commandcode/skills/"},continue:{projectPath:".continue/skills/",globalPath:"~/.continue/skills/"},cortex:{projectPath:".cortex/skills/",globalPath:"~/.snowflake/cortex/skills/"},crush:{projectPath:".crush/skills/",globalPath:"~/.config/crush/skills/"},cursor:{projectPath:".agents/skills/",globalPath:"~/.cursor/skills/"},droid:{projectPath:".factory/skills/",globalPath:"~/.factory/skills/"},"gemini-cli":{projectPath:".agents/skills/",globalPath:"~/.gemini/skills/"},"github-copilot":{projectPath:".agents/skills/",globalPath:"~/.copilot/skills/"},goose:{projectPath:".goose/skills/",globalPath:"~/.config/goose/skills/"},junie:{projectPath:".junie/skills/",globalPath:"~/.junie/skills/"},"iflow-cli":{projectPath:".iflow/skills/",globalPath:"~/.iflow/skills/"},kilo:{projectPath:".kilocode/skills/",globalPath:"~/.kilocode/skills/"},"kiro-cli":{projectPath:".kiro/skills/",globalPath:"~/.kiro/skills/"},kode:{projectPath:".kode/skills/",globalPath:"~/.kode/skills/"},mcpjam:{projectPath:".mcpjam/skills/",globalPath:"~/.mcpjam/skills/"},"mistral-vibe":{projectPath:".vibe/skills/",globalPath:"~/.vibe/skills/"},mux:{projectPath:".mux/skills/",globalPath:"~/.mux/skills/"},opencode:{projectPath:".agents/skills/",globalPath:"~/.config/opencode/skills/"},openhands:{projectPath:".openhands/skills/",globalPath:"~/.openhands/skills/"},pi:{projectPath:".pi/skills/",globalPath:"~/.pi/agent/skills/"},qoder:{projectPath:".qoder/skills/",globalPath:"~/.qoder/skills/"},"qwen-code":{projectPath:".qwen/skills/",globalPath:"~/.qwen/skills/"},roo:{projectPath:".roo/skills/",globalPath:"~/.roo/skills/"},trae:{projectPath:".trae/skills/",globalPath:"~/.trae/skills/"},"trae-cn":{projectPath:".trae/skills/",globalPath:"~/.trae-cn/skills/"},windsurf:{projectPath:".windsurf/skills/",globalPath:"~/.codeium/windsurf/skills/"},zencoder:{projectPath:".zencoder/skills/",globalPath:"~/.zencoder/skills/"},neovate:{projectPath:".neovate/skills/",globalPath:"~/.neovate/skills/"},pochi:{projectPath:".pochi/skills/",globalPath:"~/.pochi/skills/"},adal:{projectPath:".adal/skills/",globalPath:"~/.adal/skills/"}};function d(l){return n.join(n.join(i,"..","dist"),l,"skills")}function k(l){return l.startsWith("~/")?n.join(process.env.HOME||process.env.USERPROFILE||"",l.slice(2)):l}function g(l,o){a.copyFileSync(l,o),a.chmodSync(o,a.statSync(l).mode)}function p(l){let o={agent:null,global:!1};for(let e=0;e<l.length;e++)("--agent"===l[e]||"-a"===l[e])&&l[e+1]?o.agent=l[++e]:("--global"===l[e]||"-g"===l[e])&&(o.global=!0);return o}function h(l,o,e,s){if(!c[o])throw Error(`Unknown agent: "${o}". Supported agents: ${Object.keys(c).join(", ")}`);let t=n.join(d(s),l);if(!a.existsSync(t)){let o=d(s),e=a.existsSync(o)?a.readdirSync(o).join(", "):"(none)";throw Error(`Skill "${l}" not found in profile "${s}". Available skills: ${e}`)}let i=c[o],r=e?i.globalPath:i.projectPath,p=e?n.join(k(r),l):n.join(process.cwd(),r,l);for(let e of(console.log(`Installing skill "${l}" for ${o}...`),console.log(`  Target: ${p}`),a.existsSync(p)&&a.rmSync(p,{recursive:!0,force:!0}),a.mkdirSync(p,{recursive:!0}),a.readdirSync(t,{withFileTypes:!0}))){let l=n.join(t,e.name),o=n.join(p,e.name);e.isDirectory()?(!function l(o,e){if(!a.existsSync(o))throw Error(`Source directory not found: ${o}`);for(let s of(a.mkdirSync(e,{recursive:!0}),a.readdirSync(o,{withFileTypes:!0}))){let t=n.join(o,s.name),i=n.join(e,s.name);s.isDirectory()?l(t,i):g(t,i)}}(l,o),console.log(`  ✓ ${e.name}/`)):(g(l,o),console.log(`  ✓ ${e.name}`))}console.log("  ✓ Done")}l.exports={runCli:function(l={}){let o=l.commandName||"doubao-ai",e=l.profile||"internal";if(!r.has(e))throw Error(`Unknown skill profile: "${e}". Supported profiles: ${[...r].join(", ")}`);let[s,...t]=process.argv.slice(2);if(!s||"--help"===s||"-h"===s)return void console.log(`
+${o} - Doubao Apps SDK AI 工具
+
+用法：
+  ${o} skills add <skill1> [skill2...] --agent <agent>  安装一个或多个 skill 到指定 Agent
+  ${o} skills list                         查看可用 skills
+  ${o} skills update [--global]            更新所有已安装的 skills
+
+选项：
+  --agent <agent>    指定 AI Agent（如 claude-code、opencode、cursor）
+  --global, -g       全局安装（用户目录而非项目目录）
+
+示例：
+  # 安装一个或多个 skill 到 Claude Code
+  ${o} skills add doubao-apps-dev quality-gate --agent claude-code
+
+  # 安装 skill 到 opencode
+  ${o} skills add doubao-apps-dev --agent opencode
+
+  # 全局安装 skill
+  ${o} skills add doubao-apps-dev --agent claude-code --global
+
+  # 查看可用 skills
+  ${o} skills list
+
+  # 更新所有已安装的 skills
+  ${o} skills update
+
+支持的 Agents：
+  ${Object.keys(c).join(", ")}
+`);if("skills"===s){let[l,...s]=t;if("list"===l)return void function(l){let o=d(l);if(!a.existsSync(o))return console.log(`No skills available for profile "${l}". Run build first.`);let e=a.readdirSync(o,{withFileTypes:!0}).filter(l=>l.isDirectory()).map(l=>l.name);if(0===e.length)return console.log("No skills available.");for(let l of(console.log("Available skills:"),e)){let e=n.join(o,l,"SKILL.md");console.log(`  - ${l}${a.existsSync(e)?"":" (not built)"}`)}}(e);if("add"===l){let{agent:l,global:t}=p(s),i=[];for(let l=0;l<s.length;l++){let o=s[l];"--agent"===o||"-a"===o?l++:"--global"!==o&&"-g"!==o&&i.push(o)}for(let s of(0===i.length&&(console.error(`Usage: ${o} skills add <skill-name>... --agent <agent>`),process.exit(1)),l||(console.error(`--agent is required. Example: ${o} skills add doubao-apps-dev --agent claude-code`),process.exit(1)),i))h(s,l,t,e);return}if("update"===l){let{global:l}=p(s);!function(l,o){let e=d(o);if(!a.existsSync(e))return console.log(`No skills to update for profile "${o}". Run build first.`);let s=a.readdirSync(e,{withFileTypes:!0}).filter(l=>l.isDirectory()).map(l=>l.name),t=0;for(let[e,i]of Object.entries(c)){let r=l?i.globalPath:i.projectPath,c=l?k(r):n.join(process.cwd(),r);for(let i of s)a.existsSync(n.join(c,i))&&(h(i,e,l,o),t++)}0===t?console.log("No installed skills found to update."):console.log(`
+Updated ${t} skill installation(s).`)}(l,e);return}console.error(`Unknown skills subcommand: "${l}". Use: add, list, update`),process.exit(1)}console.error(`Unknown command: "${s}". Run \`${o} --help\` for usage.`),process.exit(1)}}}});let i=o("../../ai/dist/cli.js");function a(l={}){return(0,i.runCli)({...l,profile:"public"})}export{a as runCli};
+//# sourceMappingURL=index.js.map

package/dist/{manifest.json → public/manifest.json}

@@ -1,13 +1,18 @@
 {
   "packageName": "@doubao-apps/ai",
-  "version": "0.0.34",
-  "generatedAt": "2026-06-10T12:55:28.312Z",
+  "version": "0.0.35",
+  "generatedAt": "2026-06-17T07:08:33.375Z",
   "skills": [
     {
       "name": "doubao-apps-dev",
       "entry": "skills/doubao-apps-dev/SKILL.md",
       "hasAiDir": true
     },
+    {
+      "name": "doubao-components-api",
+      "entry": "skills/doubao-components-api/SKILL.md",
+      "hasAiDir": true
+    },
     {
       "name": "douyin-to-doubao",
       "entry": "skills/douyin-to-doubao/SKILL.md",

package/dist/{skills → public/skills}/doubao-apps-dev/SKILL.md

@@ -34,14 +34,11 @@ Doubao Apps SDK 是豆包应用开发框架，基于 React Lynx 框架提供完
 
 ### 3. 创建项目
 
-
-**外网创建：**
-
 ```bash
 # 使用 create 创建一个名为 my-doubao-app 的 starter 工程
-npm create @doubao-apps my-doubao-app -- --template starter -y
+pnpm create @doubao-apps my-doubao-app --template starter -y
 # 如果预期就地创建工程，使用 . 作为目录名
-# npm create @doubao-apps . -- --template starter -y
+# pnpm create @doubao-apps . --template starter -y
 
 # 进入项目目录 (如果就地创建工程，则不需要执行 cd)
 cd my-doubao-app
@@ -50,6 +47,7 @@ cd my-doubao-app
 pnpm install
 ```
 
+
 ### 4. 项目结构
 
 ```
@@ -82,7 +80,7 @@ my-doubao-app/
 - **TypeScript 类型**：所有 Page / Widget 默认使用 `getViewData<T>()`，为 viewData、props 和 state 提供明确类型；不要使用裸 `getViewData()`、`getViewData<any>()`、`: any`
 - **Open API 导入**：`request`、`getLocation`、`showToast`、`navigateTo` 等端能力从 `@doubao-apps/framework/api` 导入；参数和返回值以 [Framework API 快速参考](references/reference/framework-api-quick-ref.md) / [Open API 目录](references/reference/open-api/README.md) 为准
 - **异步状态**：Open API 和异步请求必须在 `useEffect`、生命周期钩子或事件处理函数中调用，并包含 loading、error、success 状态
-- **内置组件**：`button`、`switch`、`slider` 等直接使用小写标签，不要从组件包 import；`button` 点击使用 `onClick`，不要使用 `onTap` / `bindtap`；事件和 props 先查 [组件库快速参考](references/reference/components-quick-ref.md)
+- **内置组件**：`button`、`switch`、`slider` 等直接使用小写标签，不要从组件包 import；`button` 点击使用 `onClick`，不要使用 `onTap` / `bindtap`；`switch.onChange` 直接接收 `boolean`，`slider.onChange` 直接接收 `number`，`slider` 不支持 `step` / `defaultValue`；事件和 props 先查 `doubao-components-api` skill
 - **Framework Hooks**：`useState`、`useEffect` 等 Hooks 必须从 `@doubao-apps/framework` 导入，不要从 `react` 导入
 - **错误处理**：处理边界情况和错误状态
 
@@ -92,6 +90,7 @@ my-doubao-app/
 - **不在 render 中请求**：不要在 `render()` 中直接调用 `request`、`getLocation`、`showToast`、`navigateTo`、`fetch` 等异步或系统 API
 - **不过度嵌套**：保持组件层级扁平化
 - **不忽略类型**：避免使用 `any` 类型
+- **先查文档再使用 API**：使用任何 API 前先查文档，确认参数、返回值、调用时机和使用限制
 
 ### Page / Widget 推荐入口模板
 
@@ -141,6 +140,8 @@ export default defineAppConfig({
 端能力参数/返回值和内置组件 props 的高风险细节维护在 reference 子文档中；生成前优先查对应小节，不要在主流程里临时扩展字段。
 如果需求里混入 `fetch`、`window`、`document`、`localStorage`、`style={{}}` 等 Web/H5 写法，先按文档导航里的“Web 写法纠偏”确认替代写法，再实现。
 
+查看 reference 时，以当前 `SKILL.md` 所在目录为基准解析相对链接；组件事件细节见 `doubao-components-api` skill。
+
 ### ⚠️ 文件命名约束
 
 页面/卡片目录下的入口文件必须命名为 **`index.tsx`**，样式文件为 **`index.scss`**。
@@ -182,7 +183,7 @@ export default defineAppConfig({
 });
 ```
 
-详细 Page / Widget 生命周期、布局、metadata、boxType 和 viewData 示例见 [组件开发指南](references/guides/component-development.md)，基础示例对比见 [component-basics.md](references/examples/component-basics.md)。
+详细 Page / Widget 生命周期、布局、metadata、boxType 和 viewData 示例见 [组件开发指南](references/guides/component-development.md)，基础示例对比见 [page-widget-basics.md](references/examples/page-widget-basics.md)。
 
 ---
 
@@ -197,10 +198,10 @@ export default defineAppConfig({
 | Web 写法纠偏 | [dos-and-donts.md](references/rules/dos-and-donts.md)、[common-patterns.md](references/examples/common-patterns.md)、[open-api-recipes.md](references/examples/open-api-recipes.md) | 需求出现 `fetch`、`window`、`document`、`localStorage`、内联 `style` 等 Web/H5 写法时 |
 | API 集成和状态 | [common-patterns.md](references/examples/common-patterns.md) | 异步调用结构、错误处理、状态管理、导航 |
 | Open API 使用配方 | [open-api-recipes.md](references/examples/open-api-recipes.md) | 参考 `getLocation`、Storage 等端能力和 Page / Widget 的组合写法 |
-| 内置组件使用配方 | [component-recipes.md](references/examples/component-recipes.md) | 参考 `button`、`switch`、`slider` 等组件和状态的组合写法 |
+| Page/Widget 组件配方 | [page-widget-recipes.md](references/examples/page-widget-recipes.md) | 参考 `button`、`switch`、`slider` 等组件在 Page/Widget 中的状态组合写法 |
 | Framework API | [framework-api-quick-ref.md](references/reference/framework-api-quick-ref.md) | 查 `definePage`、`defineWidget`、Hooks、viewData、常用端能力签名 |
 | Open API 详情 | [open-api/README.md](references/reference/open-api/README.md) | 查系统能力 API 的完整参数和返回值 |
-| 内置组件 | [components-quick-ref.md](references/reference/components-quick-ref.md) | 使用 `button`、`switch`、`slider`、`swiper` 等全局小写组件 |
+| 内置组件 API | `doubao-components-api` skill | 查询 `button`、`switch`、`slider`、`swiper` 等所有内置组件的完整 props 和事件 |
 | 最佳实践 | [best-practices.md](references/guides/best-practices.md) | 代码组织、错误处理、可维护性 |
 | 性能优化 | [performance-optimization.md](references/guides/performance-optimization.md) | 渲染、列表、资源和内存优化 |
 | 问题排查 | [troubleshooting.md](references/guides/troubleshooting.md) | 编译、运行、样式、API 调用异常 |
@@ -211,4 +212,4 @@ export default defineAppConfig({
 - **端能力 API**：`@doubao-apps/framework/api` - 网络、存储、位置、导航、Toast 等系统能力
 - **Kit**：`@doubao-apps/kit` - `defineAppConfig` 和构建配置能力
 
-Lynx 组件库完整参考：<https://lynxjs.org/zh/>
+Lynx 组件库完整参考：<https://lynxjs.org/llms.txt>

package/dist/{skills → public/skills}/doubao-apps-dev/references/examples/common-patterns.md

@@ -595,9 +595,9 @@ export default definePage({
 
 ## 📚 延伸阅读
 
-- **组件基础** → [./component-basics.md](./component-basics.md)
+- **Page/Widget 基础** → [./page-widget-basics.md](./page-widget-basics.md)
 - **组件开发完整指南** → [../guides/component-development.md](../guides/component-development.md)
 - **Open API 使用配方** → [./open-api-recipes.md](./open-api-recipes.md)
-- **内置组件使用配方** → [./component-recipes.md](./component-recipes.md)
+- **Page/Widget 组件配方** → [./page-widget-recipes.md](./page-widget-recipes.md)
 - **API 参考** → [../reference/framework-api-quick-ref.md](../reference/framework-api-quick-ref.md)
 - **最佳实践** → [../guides/best-practices.md](../guides/best-practices.md)

package/dist/{skills/doubao-apps-dev/references/examples/component-basics.md → public/skills/doubao-apps-dev/references/examples/page-widget-basics.md}

@@ -543,5 +543,5 @@ export default defineWidget({
 - **组件开发完整指南** → [../guides/component-development.md](../guides/component-development.md)
 - **常用开发模式** → [./common-patterns.md](./common-patterns.md)
 - **Open API 使用配方** → [./open-api-recipes.md](./open-api-recipes.md)
-- **内置组件使用配方** → [./component-recipes.md](./component-recipes.md)
+- **Page/Widget 组件配方** → [./page-widget-recipes.md](./page-widget-recipes.md)
 - **API 参考** → [../reference/framework-api-quick-ref.md](../reference/framework-api-quick-ref.md)

package/dist/{skills/doubao-apps-dev/references/examples/component-recipes.md → public/skills/doubao-apps-dev/references/examples/page-widget-recipes.md}

@@ -1,7 +1,6 @@
-# 内置组件使用配方
+# Page/Widget 组件配方
 
-本文件放内置组件和 Page / Widget 状态组合的示例。组件的完整 props 和事件签名以
-[组件库快速参考](../reference/components-quick-ref.md) 为准；这里重点展示受控状态、事件处理和保存态如何组合。
+本文件放内置组件和 Page / Widget 状态组合的示例。组件的完整 props 和事件签名见 `doubao-components-api` skill；这里重点展示受控状态、事件处理和保存态如何组合。
 
 ---
 

package/dist/{skills → public/skills}/doubao-apps-dev/references/guides/component-development.md

@@ -903,12 +903,12 @@ useEffect(() => {
 
 ## 📚 延伸阅读
 
-- **组件示例** → [../examples/component-basics.md](../examples/component-basics.md)
+- **Page/Widget 基础示例** → [../examples/page-widget-basics.md](../examples/page-widget-basics.md)
 - **常用模式** → [../examples/common-patterns.md](../examples/common-patterns.md)
 - **MCP UI 约定入口** → [mcp-ui.md](./mcp-ui.md)
 - **失效卡片** → [expired-widget.md](./expired-widget.md)
 - **Open API 使用配方** → [../examples/open-api-recipes.md](../examples/open-api-recipes.md)
-- **内置组件使用配方** → [../examples/component-recipes.md](../examples/component-recipes.md)
+- **Page/Widget 组件配方** → [../examples/page-widget-recipes.md](../examples/page-widget-recipes.md)
 - **最佳实践** → [best-practices.md](./best-practices.md)
 - **性能优化** → [performance-optimization.md](./performance-optimization.md)
 - **故障排查** → [troubleshooting.md](./troubleshooting.md)

package/dist/public/skills/doubao-apps-dev/references/reference/open-api/01-/345/237/272/347/241/200.md

@@ -0,0 +1,270 @@
+# Open API: 基础
+
+账号、授权、宿主基础信息、窗口信息和能力可用性。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getAccountInfo](#getaccountinfo) | 异步获取账号信息。 |
+| [getAccountInfoSync](#getaccountinfosync) | 同步获取账号信息。<br><br>同步 API。 |
+| [authorize](#authorize) | 初始化授权。 |
+| [canIUse](#caniuse) | 检测当前宿主是否支持指定 API 或能力。 |
+| [getPackageInfo](#getpackageinfo) | 获取当前 package 信息。 |
+| [getPackageInfoSync](#getpackageinfosync) | 同步获取当前 package 信息。<br><br>同步 API。 |
+
+## API 详情
+
+<a id="getaccountinfo"></a>
+### getAccountInfo()
+
+异步获取账号信息。
+
+## 代码示例
+
+```typescript
+import { getAccountInfo } from '@doubao-apps/framework/api';
+
+const result = await getAccountInfo();
+console.log(result.miniProgram.appId);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<GetAccountInfoResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|miniProgram|`DoubaoAppAccountInfo`|豆包 App账号信息|
+|miniProgram.appId|`string`|豆包 App appId|
+|miniProgram.envVersion|`"develop" | "trial" | "release"`|豆包 App 运行环境。<br><br>- develop: 开发版<br>- trial: 体验版<br>- release: 正式版|
+|miniProgram.version|`string`|线上豆包 App 版本号。|
+|plugin|`PluginAccountInfo`|插件账号信息（仅在插件中调用时包含）|
+|plugin.appId|`string`|插件 appId|
+|plugin.version|`string`|插件版本号，'a.b.c' 形式|
+
+<a id="getaccountinfosync"></a>
+### getAccountInfoSync()
+
+同步获取账号信息。
+
+## 代码示例
+
+```typescript
+import { getAccountInfoSync } from '@doubao-apps/framework/api';
+
+const result = getAccountInfoSync();
+console.log(result.miniProgram.appId, result.miniProgram.envVersion, result.miniProgram.version);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `GetAccountInfoResult`。
+
+|字段名|类型|说明|
+|---|---|---|
+|miniProgram|`DoubaoAppAccountInfo`|豆包 App账号信息|
+|miniProgram.appId|`string`|豆包 App appId|
+|miniProgram.envVersion|`"develop" | "trial" | "release"`|豆包 App 运行环境。<br><br>- develop: 开发版<br>- trial: 体验版<br>- release: 正式版|
+|miniProgram.version|`string`|线上豆包 App 版本号。|
+|plugin|`PluginAccountInfo`|插件账号信息（仅在插件中调用时包含）|
+|plugin.appId|`string`|插件 appId|
+|plugin.version|`string`|插件版本号，'a.b.c' 形式|
+
+<a id="authorize"></a>
+### authorize()
+
+初始化授权
+
+## 代码示例
+
+```typescript
+import { authorize } from '@doubao-apps/framework/api';
+
+await authorize({ scope: 'scope.userLocation' });
+```
+
+## 注意事项
+
+按 scope 申请授权。
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|scope|`Scope`|是|授权范围|
+
+**类型说明**
+
+- `Scope`: `"scope.userLocation" | "scope.userFuzzyLocation" | "scope.userLocationBackground" | "scope.payment" | "scope.record" | "scope.bluetooth" | "scope.camera" | "scope.addPhoneContact" | "scope.addPhoneCalendar"`
+
+## 返回值
+
+Promise 对象，授权成功时会返回授权结果
+
+<a id="caniuse"></a>
+### canIUse()
+
+检测当前宿主是否支持指定 API 或能力。
+
+## 代码示例
+
+```typescript
+import { canIUse } from '@doubao-apps/framework/api';
+
+const { result } = await canIUse({ schema: 'doubao.getLocation' });
+
+console.log(result);
+```
+
+## 注意事项
+
+用于兼容性判断。
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|schema|`string`|是|-|
+
+## 返回值
+
+返回 `Promise<CanIUseResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|result|`boolean`|-|
+
+<a id="getpackageinfo"></a>
+### getPackageInfo()
+
+获取当前 package 信息。
+
+## 代码示例
+
+```typescript
+import { getPackageInfo } from '@doubao-apps/framework/api';
+
+const result = await getPackageInfo();
+
+console.log(result.appId, result.name, result.iconSrc);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回当前 package 的 appId、展示名称和展示图标地址，见 GetPackageInfoResult。
+
+|字段名|类型|说明|
+|---|---|---|
+|appId|`string`|当前 package 的 appId。|
+|iconSrc|`string`|当前 package 的展示图标地址。|
+|name|`string`|当前 package 的展示名称。|
+
+<a id="getpackageinfosync"></a>
+### getPackageInfoSync()
+
+同步获取当前 package 信息。
+
+## 代码示例
+
+```typescript
+import { getPackageInfoSync } from '@doubao-apps/framework/api';
+
+const result = getPackageInfoSync();
+
+console.log(result.appId, result.name, result.iconSrc);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回当前 package 的 appId、展示名称和展示图标地址，见 GetPackageInfoResult。
+
+|字段名|类型|说明|
+|---|---|---|
+|appId|`string`|当前 package 的 appId。|
+|iconSrc|`string`|当前 package 的展示图标地址。|
+|name|`string`|当前 package 的展示名称。|
+
+## 相关类型
+
+<a id="doubaoappaccountinfo"></a>
+### DoubaoAppAccountInfo
+
+豆包 App 账号信息。
+
+#### Properties
+
+• **appId**: `string` - 豆包 App appId
+• **envVersion**: `'develop' | 'trial' | 'release'` - 豆包 App 运行环境。 - develop: 开发版 - trial: 体验版 - release: 正式版
+• **version**: `string` - 线上豆包 App 版本号
+
+<a id="pluginaccountinfo"></a>
+### PluginAccountInfo
+
+插件账号信息（仅在插件中调用时包含）。
+
+#### Properties
+
+• **appId**: `string` - 插件 appId
+• **version**: `string` - 插件版本号，'a.b.c' 形式
+
+<a id="getaccountinforesult"></a>
+### GetAccountInfoResult
+
+获取当前账号信息。
+
+#### Properties
+
+• **miniProgram**: `DoubaoAppAccountInfo` - 豆包 App账号信息
+• **plugin?**: `PluginAccountInfo` - 插件账号信息（仅在插件中调用时包含）
+
+<a id="scope"></a>
+### Scope
+
+#### Type
+
+`| 'scope.userLocation'
+  | 'scope.userFuzzyLocation'
+  | 'scope.userLocationBackground'
+  | 'scope.payment'
+  | 'scope.record'
+  | 'scope.bluetooth'
+  | 'scope.camera'
+  | 'scope.addPhoneContact'
+  | 'scope.addPhoneCalendar'`
+
+<a id="caniuseresult"></a>
+### CanIUseResult
+
+#### Properties
+
+• **result**: `boolean`
+
+<a id="getpackageinforesult"></a>
+### GetPackageInfoResult
+
+当前 package 信息。
+
+#### Properties
+
+• **appId**: `string` - 当前 package 的 appId
+• **name**: `string` - 当前 package 的展示名称
+• **iconSrc?**: `string` - 当前 package 的展示图标地址