@doubao-apps/ai 0.0.26 → 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;
 }
 ```
 

package/dist/skills/doubao-apps-dev/.ai/reference/open-api/01-/345/237/272/347/241/200-/350/264/246/345/217/267-/347/263/273/347/273/237.md

@@ -6,19 +6,19 @@
 
 ## 速查
 
-| API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
-| --- | --- | --- | --- | --- | --- |
-| [`getAccountInfo`](#getaccountinfo) | `getAccountInfo(params?): Promise<GetAccountInfoResult>` | 异步获取账号信息 | `params?` | `Promise<GetAccountInfoResult>` | - |
-| [`getAccountInfoSync`](#getaccountinfosync) | `getAccountInfoSync(params?): GetAccountInfoResult` | 同步获取账号信息 | `params?` | `GetAccountInfoResult` | 同步 API |
-| [`authorize`](#authorize) | `authorize(params): Promise<object>` | 初始化授权 | `params: AuthorizeRequest` | `Promise<object>` | 按 scope 申请授权 |
-| [`canIUse`](#caniuse) | `canIUse(params): Promise<CanIUseResult>` | 检测当前宿主是否支持指定 API 或能力 | `params: CanIUseParams` | `Promise<CanIUseResult>` | 用于兼容性判断 |
-| [`getLocation`](#getlocation) | `getLocation(params?): Promise<GetLocationResponse>` | 获取设备当前的地理位置信息 | `params?: GetLocationParams` | `Promise<GetLocationResponse>` | 可能涉及定位授权 |
-| [`login`](#login) | `login(params?): Promise<LoginResult>` | 发起登录并获取登录凭证 | `params?: LoginRequest` | `Promise<LoginResult>` | - |
-| [`getWindowInfoSync`](#getwindowinfosync) | `getWindowInfoSync(_param?): GetWindowInfoResult` | 获取窗口信息 | `_param?` | `GetWindowInfoResult` | 同步 API |
-| [`getSystemSetting`](#getsystemsetting) | `getSystemSetting(params?): GetSystemSettingResult` | 获取设备设置 | `params?` | `GetSystemSettingResult` | - |
-| [`getAppBaseInfoSync`](#getappbaseinfosync) | `getAppBaseInfoSync(_params?): GetAppBaseInfoResult` | 获取应用基础信息 | `_params?` | `GetAppBaseInfoResult` | 同步 API |
-| [`getWindowInfo`](#getwindowinfo) | `getWindowInfo(_params?): Promise<GetWindowInfoResult>` | 获取窗口信息 | `_params?` | `Promise<GetWindowInfoResult>` | - |
-| [`getAppBaseInfo`](#getappbaseinfo) | `getAppBaseInfo(params?): Promise<GetAppBaseInfoResult>` | 获取应用基础信息 | `params?` | `Promise<GetAppBaseInfoResult>` | - |
+| API | 说明 |
+| --- | --- |
+| [getAccountInfo](#getaccountinfo) | 异步获取账号信息。 |
+| [getAccountInfoSync](#getaccountinfosync) | 同步获取账号信息。<br><br>同步 API。 |
+| [authorize](#authorize) | 初始化授权。<br><br>按 scope 申请授权。 |
+| [canIUse](#caniuse) | 检测当前宿主是否支持指定 API 或能力。<br><br>用于兼容性判断。 |
+| [getLocation](#getlocation) | 获取设备当前的地理位置信息。<br><br>可能涉及定位授权。 |
+| [login](#login) | 发起登录并获取登录凭证。 |
+| [getWindowInfoSync](#getwindowinfosync) | 获取窗口信息。<br><br>同步 API。 |
+| [getSystemSetting](#getsystemsetting) | 获取设备设置。 |
+| [getAppBaseInfoSync](#getappbaseinfosync) | 获取应用基础信息。<br><br>同步 API。 |
+| [getWindowInfo](#getwindowinfo) | 获取窗口信息。 |
+| [getAppBaseInfo](#getappbaseinfo) | 获取应用基础信息。 |
 
 ## API 详情
 

package/dist/skills/doubao-apps-dev/.ai/reference/open-api/02-/345/255/230/345/202/250.md

@@ -0,0 +1,409 @@
+# Open API: 存储
+
+本地缓存；带 Sync 后缀的是同步 API。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [setStorage](#setstorage) | 将数据写入本地缓存。 |
+| [setStorageSync](#setstoragesync) | 将数据写入本地缓存。<br><br>同步 API。 |
+| [getStorage](#getstorage) | 从本地缓存读取数据。 |
+| [getStorageSync](#getstoragesync) | 从本地缓存同步读取数据。<br><br>同步 API。 |
+| [removeStorage](#removestorage) | 删除本地缓存中指定 key 的数据。 |
+| [removeStorageSync](#removestoragesync) | 删除本地缓存中指定 key 的数据。<br><br>同步 API。 |
+| [clearStorage](#clearstorage) | 清空本地缓存。 |
+| [clearStorageSync](#clearstoragesync) | 清空本地缓存。<br><br>同步 API。 |
+| [getStorageInfo](#getstorageinfo) | 获取本地缓存信息。 |
+| [getStorageInfoSync](#getstorageinfosync) | 同步获取本地缓存信息。<br><br>同步 API。 |
+
+## API 详情
+
+<a id="setstorage"></a>
+### setStorage()
+
+> **setStorage**\<`TData`\>(`params`): `Promise`\<`object`\>
+
+将数据写入本地缓存。
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Parameters
+
+• **params**: [`SetStorageParams`](#setstorageparamstdata)\<`TData`\>
+
+存储参数，字段见 [SetStorageParams](#setstorageparamstdata)。
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回一个 Promise，写入完成后 resolve。
+
+#### Remarks
+
+#### Example
+
+```typescript
+import { setStorage } from '@doubao-apps/framework/api';
+
+await setStorage({
+  key: 'profile',
+  data: { name: 'Tom', age: 18 },
+});
+```
+
+<a id="setstoragesync"></a>
+### setStorageSync()
+
+> **setStorageSync**\<`TData`\>(`params`): `object`
+
+将数据写入本地缓存。
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Parameters
+
+• **params**: [`SetStorageParams`](#setstorageparamstdata)\<`TData`\>
+
+存储参数，字段见 [SetStorageParams](#setstorageparamstdata)。
+
+#### Returns
+
+`object`
+
+同步写入完成后返回。
+
+#### Remarks
+
+#### Example
+
+```typescript
+import { setStorageSync } from '@doubao-apps/framework/api';
+
+setStorageSync({
+  key: 'profile',
+  data: { name: 'Tom', age: 18 },
+});
+```
+
+<a id="getstorage"></a>
+### getStorage()
+
+> **getStorage**\<`TData`\>(`params`): `Promise`\<[`GetStorageResult`](#getstorageresulttdata)\<`TData`\>\>
+
+从本地缓存读取数据。
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Parameters
+
+• **params**: [`GetStorageParams`](#getstorageparams)
+
+查询参数，字段见 [GetStorageParams](#getstorageparams)。
+
+#### Returns
+
+`Promise`\<[`GetStorageResult`](#getstorageresulttdata)\<`TData`\>\>
+
+返回一个 Promise，解析为 [GetStorageResult](#getstorageresulttdata)。
+
+#### Remarks
+
+#### Example
+
+```typescript
+import { getStorage } from '@doubao-apps/framework/api';
+
+const result = await getStorage<{ name: string; age: number }>({
+  key: 'profile',
+});
+
+console.log(result.data.name, result.data.age);
+```
+
+<a id="getstoragesync"></a>
+### getStorageSync()
+
+> **getStorageSync**\<`TData`\>(`params`): [`GetStorageResult`](#getstorageresulttdata)\<`TData`\>
+
+从本地缓存同步读取数据。
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Parameters
+
+• **params**: [`GetStorageParams`](#getstorageparams)
+
+查询参数，字段见 [GetStorageParams](#getstorageparams)。
+
+#### Returns
+
+[`GetStorageResult`](#getstorageresulttdata)\<`TData`\>
+
+返回 [GetStorageResult](#getstorageresulttdata)。
+
+#### Remarks
+
+#### Example
+
+```typescript
+import { getStorageSync } from '@doubao-apps/framework/api';
+
+const result = getStorageSync<{ name: string; age: number }>({
+  key: 'profile',
+});
+
+console.log(result.data.name, result.data.age);
+```
+
+<a id="removestorage"></a>
+### removeStorage()
+
+> **removeStorage**(`params`): `Promise`\<`object`\>
+
+删除本地缓存中指定 key 的数据。
+
+#### Parameters
+
+• **params**: [`RemoveStorageParams`](#removestorageparams)
+
+删除参数，字段见 [RemoveStorageParams](#removestorageparams)。
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回一个 Promise，删除完成后 resolve。
+
+#### Example
+
+```typescript
+import { removeStorage } from '@doubao-apps/framework/api';
+
+await removeStorage({ key: 'profile' });
+```
+
+<a id="removestoragesync"></a>
+### removeStorageSync()
+
+> **removeStorageSync**(`params`?): `object`
+
+删除本地缓存中指定 key 的数据。
+
+#### Parameters
+
+• **params?**: [`RemoveStorageParams`](#removestorageparams)
+
+删除参数，字段见 [RemoveStorageParams](#removestorageparams)。
+
+#### Returns
+
+`object`
+
+同步删除完成后返回。
+
+#### Example
+
+```typescript
+import { removeStorageSync } from '@doubao-apps/framework/api';
+
+removeStorageSync({ key: 'profile' });
+```
+
+<a id="clearstorage"></a>
+### clearStorage()
+
+> **clearStorage**(`params`?): `Promise`\<`object`\>
+
+清空本地缓存。
+
+#### Parameters
+
+• **params?**: `object`
+
+#### Returns
+
+`Promise`\<`object`\>
+
+返回一个 Promise，清空完成后 resolve。
+
+#### Example
+
+```typescript
+import { clearStorage } from '@doubao-apps/framework/api';
+
+await clearStorage();
+```
+
+<a id="clearstoragesync"></a>
+### clearStorageSync()
+
+> **clearStorageSync**(`params`?): `object`
+
+清空本地缓存。
+
+#### Parameters
+
+• **params?**: `object`
+
+#### Returns
+
+`object`
+
+同步清空完成后返回。
+
+#### Example
+
+```typescript
+import { clearStorageSync } from '@doubao-apps/framework/api';
+
+clearStorageSync();
+```
+
+<a id="getstorageinfo"></a>
+### getStorageInfo()
+
+> **getStorageInfo**(`params`?): `Promise`\<[`GetStorageInfoResult`](#getstorageinforesult)\>
+
+获取本地缓存信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetStorageInfoResult`](#getstorageinforesult)\>
+
+返回一个 Promise，解析为 [GetStorageInfoResult](#getstorageinforesult)。
+
+#### Example
+
+```typescript
+import { getStorageInfo } from '@doubao-apps/framework/api';
+
+const result = await getStorageInfo();
+
+console.log(result.keys, result.currentSize, result.limitSize);
+```
+
+<a id="getstorageinfosync"></a>
+### getStorageInfoSync()
+
+> **getStorageInfoSync**(`params`?): [`GetStorageInfoResult`](#getstorageinforesult)
+
+同步获取本地缓存信息。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+[`GetStorageInfoResult`](#getstorageinforesult)
+
+返回 [GetStorageInfoResult](#getstorageinforesult)。
+
+#### Example
+
+```typescript
+import { getStorageInfoSync } from '@doubao-apps/framework/api';
+
+const result = getStorageInfoSync();
+
+console.log(result.keys, result.currentSize, result.limitSize);
+```
+
+## 相关类型
+
+<a id="setstorageparamstdata"></a>
+### SetStorageParams<TData>
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Properties
+
+##### data
+
+> **data**: `TData`
+
+待存储的数据
+
+##### key
+
+> **key**: `string`
+
+本地缓存键名
+
+<a id="getstorageparams"></a>
+### GetStorageParams
+
+#### Properties
+
+##### key
+
+> **key**: `string`
+
+本地缓存键名
+
+<a id="getstorageresulttdata"></a>
+### GetStorageResult<TData>
+
+#### Type parameters
+
+• **TData** = `unknown`
+
+#### Properties
+
+##### data
+
+> **data**: `TData`
+
+key 对应的数据
+
+<a id="removestorageparams"></a>
+### RemoveStorageParams
+
+#### Properties
+
+##### key
+
+> **key**: `string`
+
+本地缓存键名
+
+<a id="getstorageinforesult"></a>
+### GetStorageInfoResult
+
+#### Properties
+
+##### currentSize
+
+> **currentSize**: `number`
+
+当前占用的空间大小，单位 KB
+
+##### keys
+
+> **keys**: `string`[]
+
+当前 storage 中所有的 key
+
+##### limitSize
+
+> **limitSize**: `number`
+
+限制的空间大小，单位 KB