@doubao-apps/ai 0.0.25 → 0.0.27

package/dist/skills/doubao-apps-dev/.ai/reference/framework-api-quick-ref.md

@@ -136,7 +136,7 @@ console.log(info.keys, info.currentSize, info.limitSize);
 ## 引入依赖
 
 ```ts
-import { getLocation, getPhoneNumber, openPage, request, showToast, setStorage, getStorage } from '@doubao-apps/framework/api';
+import { getLocation, getPhoneNumber, navigateTo, navigateBack, request, showToast, setStorage, getStorage } from '@doubao-apps/framework/api';
 ```
 
 ## 使用示例
@@ -144,7 +144,8 @@ import { getLocation, getPhoneNumber, openPage, request, showToast, setStorage,
 ```ts
 await showToast({ message: '保存成功' });
 
-const { viewId } = await openPage({ pageId: 'detail', context: {} });
+await navigateTo({ url: 'detail?id=123' });
+await navigateBack();
 
 const res = await request({ url: '/api/data', method: 'GET' });
 
@@ -155,85 +156,57 @@ const phone = await getPhoneNumber();
 
 以下为常用端能力 API 的节选，完整以 `@doubao-apps/framework/api` 类型定义为准。
 
-### openFloatingWindow
+### navigateTo
 
 **参数**:
 ```typescript
 {
-  /** 期望要打开的 page 的 id */
-  pageId: string;
-
-  /** 打开页面时传入的数据，运行时通过 getViewData 获取 */
-  pageData?: string;
-
-  /** view context 对象，在全页和卡片中通过 getViewContext() 获取 */
-  context: object;
-
-  /** 打开 Page 时配置页面参数 */
-  pageSettings?: {
-    /**
-     * 悬浮窗口在横向上的吸附位置
-     *
-     * @deprecated 最新的 Lynx 悬浮窗中已失效
-     */
-    align?: 'left' | 'right';
-    
-    /**
-     * 设置 Lynx 悬浮窗的宽度，单位是 `px`
-     */
-    width?: number;
-    
-    /**
-     *  设置 Lynx 悬浮窗的高度，单位是 `px`
-     */
-    height?: number;
-    
-    /**
-     * 优先级。越高代表优先级越高，取值-2~2
-     */
-    priority?: number;
-    
-    /**
-     * 是否自动恢复展示。在被高优悬浮窗打断时会发挥作用，只有为 true 才会得到恢复的机会，否则直接释放
-     */
-    autoReshow?: boolean;
-  };
+  /** 跳转目标，填写页面的 pageId，可拼接 query，如 'detail?id=123' */
+  url: string;
 }
 ```
 
-**返回值**:
+**返回值**: Promise
+
+### redirectTo
+
+**参数**:
 ```typescript
 {
-  /** 创建出的 view id */
-  viewId: string;
-  
-  /**
-   * 返回展示悬浮窗的结果
-   * 0: 展示失败
-   * 1: 展示成功
-   * 2: 排队中
-   */
-  floatingShowResult?: number;
+  /** 跳转目标，填写页面的 pageId，如 'settings' */
+  url: string;
 }
 ```
 
-### close
+**返回值**: Promise
+
+### reLaunch
 
 **参数**:
 ```typescript
 {
-  /** 要关闭的页面 id，留空(undefined) 为当前页面 */
-  viewID?: string;
-  /** 要关闭的多个页面 id */
-  viewIDs?: string[];
-  /**
-   * @default false
-   */
-  animated?: boolean;
+  /** 跳转目标，填写页面的 pageId，如 'home' */
+  url: string;
 }
 ```
 
-**返回值**: 无（空对象）
+**返回值**: Promise
+
+### navigateBack
+
+**参数**:
+```typescript
+{
+  /** 返回的页面数，默认为 1 */
+  delta?: number;
+}
+```
+
+**返回值**: Promise
+
+> `close()` 已废弃，公开路由场景请优先使用 `navigateBack()`。
+>
+> 常规页面跳转场景下，`url` 直接使用目标页面的 `pageId`，该值一般与页面的 `aiMeta.id` 一致；需要传参时可直接拼接 query string。
 
 ### showToast
 
@@ -413,7 +386,7 @@ const phone = await getPhoneNumber();
 
 | API | 功能 | 示例 |
 |-----|------|------|
-| `sendQueryMessage(params)` | 发送用户消息 | `sendQueryMessage({ content: '查询天气', type: 'text', context: {} })` |
+| `sendQueryMessage(params)` | 发送用户消息 | `sendQueryMessage({ content: '查询天气', type: 'text' })` |
 | `setAdditionalContext(params)` | 设置上下文 | `setAdditionalContext({ additionalContext: '...' })` |
 
 ### sendQueryMessage
@@ -426,12 +399,6 @@ const phone = await getPhoneNumber();
 
   /** 消息类型，目前仅支持 text */
   type: 'text';
-
-  /** Plugin tool 或 Page/Widget 携带的上下文信息 */
-  context: object;
-
-  /** 扩展信息 */
-  ext?: Record<string, string>;
 }
 ```
 
@@ -500,21 +467,7 @@ interface PageInput {
   [key: string]: any;  // URL 参数
 }
 
-// Widget Input Schema
-interface WidgetInputSchema {
-  type: 'object';
-  properties: {
-    [key: string]: {
-      type: 'string' | 'number' | 'boolean' | 'array' | 'object';
-      title: string;
-      description?: string;
-      default?: any;
-    };
-  };
-  required?: string[];
-}
-
-// aiMeta 配置
+// src/app.config.ts 中的 metadata 配置
 interface PageAIMeta {
   id: string;                      // 页面唯一标识
   title?: string;                  // 页面标题
@@ -526,7 +479,15 @@ interface WidgetAIMeta {
   name?: string;                   // 卡片名称
   description?: string;            // 卡片描述
   boxType?: 'inbox' | 'full_box';  // 卡片类型
-  input: WidgetInputSchema;        // 输入数据格式
+  border?: boolean;                // 是否显示边框
+  keywords?: string[];             // 搜索关键词
+  titleType?: 'none' | 'normal' | 'float';
+}
+
+// Widget 渲染数据类型
+interface WidgetViewData {
+  title: string;
+  content?: string;
 }
 ```