@doubao-apps/create 0.0.26 → 0.0.27

package/dist/template-starter/.ai/reference/open-api/{07-media.md → 07-/345/252/222/344/275/223.md}

@@ -1,4 +1,4 @@
-# Open API: Media
+# Open API: 媒体
 
 图片选择、预览、保存、压缩和信息读取。
 
@@ -6,13 +6,13 @@
 
 ## 速查
 
-| API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
-| --- | --- | --- | --- | --- | --- |
-| [`saveImageToPhotosAlbum`](#saveimagetophotosalbum) | `saveImageToPhotosAlbum(params): Promise<object>` | 保存图片到系统相册 | `params: SaveImageToPhotosAlbumParams` | `Promise<object>` | - |
-| [`previewImage`](#previewimage) | `previewImage(params): Promise<object>` | 预览图片 | `params: PreviewImageParams` | `Promise<object>` | - |
-| [`getImageInfo`](#getimageinfo) | `getImageInfo(params): Promise<GetImageInfoResult>` | 获取图片信息 | `params: GetImageInfoParams` | `Promise<GetImageInfoResult>` | - |
-| [`chooseImage`](#chooseimage) | `chooseImage(params?): Promise<ChooseImageResult>` | 选择图片 | `params?: ChooseImageParams` | `Promise<ChooseImageResult>` | - |
-| [`compressImage`](#compressimage) | `compressImage(params): Promise<CompressImageResult>` | 压缩图片 | `params: CompressImageParams` | `Promise<CompressImageResult>` | - |
+| API | 说明 |
+| --- | --- |
+| [saveImageToPhotosAlbum](#saveimagetophotosalbum) | 保存图片到系统相册。 |
+| [previewImage](#previewimage) | 预览图片。 |
+| [getImageInfo](#getimageinfo) | 获取图片信息。 |
+| [chooseImage](#chooseimage) | 选择图片。 |
+| [compressImage](#compressimage) | 压缩图片。 |
 
 ## API 详情
 

package/dist/template-starter/.ai/reference/open-api/{08-open- → 08-/345/274/200/346/224/276/350/203/275/345/212/233-}/344/270/232/345/212/241/350/203/275/345/212/233.md

@@ -1,4 +1,4 @@
-# Open API: Open / 业务能力
+# Open API: 开放能力 / 业务能力
 
 开放业务能力、支付、隐私设置、上下文和外部应用打开。
 
@@ -6,19 +6,20 @@
 
 ## 速查
 
-| API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
-| --- | --- | --- | --- | --- | --- |
-| [`getOrderPayment`](#getorderpayment) | `getOrderPayment(params): Promise<GetOrderPaymentResult>` | 查询订单支付结果 | `params: GetOrderPaymentParams` | `Promise<GetOrderPaymentResult>` | - |
-| [`postLoginResult`](#postloginresult) | `postLoginResult(params): Promise<object>` | 回传 MCP 授权登录凭证 | `params: PostLoginResultRequest` | `Promise<object>` | - |
-| [`getPrivacySetting`](#getprivacysetting) | `getPrivacySetting(params?): Promise<PrivacySettingResult>` | 获取隐私设置状态 | `params?` | `Promise<PrivacySettingResult>` | - |
-| [`requestOrder`](#requestorder) | `requestOrder(params): Promise<RequestOrderResult>` | 发起订单支付流程 | `params: RequestOrderParams` | `Promise<RequestOrderResult>` | - |
-| [`loginWithDoubaoWidget`](#loginwithdoubaowidget) | `loginWithDoubaoWidget(params): Promise<LoginWithWidgetResult>` | 发起豆包 Widget 登录 | `params: LoginWithWidgetRequest` | `Promise<LoginWithWidgetResult>` | - |
-| [`sendQueryMessage`](#sendquerymessage) | `sendQueryMessage(params): void` | 以用户身份发送一条消息 | `params: SendQueryMessageParams` | `void` | 返回 void，不是 Promise |
-| [`updateModelContext`](#updatemodelcontext) | `updateModelContext(params?): Promise<object>` | 向 Agent 捐赠上下文 | `params?: UpdateModelContextParams` | `Promise<object>` | - |
-| [`setAdditionalContext`](#setadditionalcontext) | `setAdditionalContext(params): Promise<object>` | 设置全局上下文供大模型理解 | `params: SetAdditionalContextParams` | `Promise<object>` | 设置全局上下文 |
-| [`dispatchActionDirective`](#dispatchactiondirective) | `dispatchActionDirective(params): Promise<object>` | 描述用户行为，约束模型行为及指定执行路径 | `params: DispatchActionDirectiveParams` | `Promise<object>` | - |
-| [`updateWidget`](#updatewidget) | `updateWidget(params): Promise<object>` | 更新指定卡片 | `params: UpdateWidgetParams` | `Promise<object>` | - |
-| [`openApp`](#openapp) | `openApp(params): Promise<OpenAppResult>` | 通过 deep link 等方式打开外部应用 | `params: OpenAppRequest` | `Promise<OpenAppResult>` | - |
+| API | 说明 |
+| --- | --- |
+| [getOrderPayment](#getorderpayment) | 查询订单支付结果。 |
+| [postLoginResult](#postloginresult) | 回传 MCP 授权登录凭证。 |
+| [getPrivacySetting](#getprivacysetting) | 获取隐私设置状态。 |
+| [requestOrder](#requestorder) | 发起订单支付流程。 |
+| [loginWithDoubaoWidget](#loginwithdoubaowidget) | 发起豆包 Widget 登录。 |
+| [sendQueryMessage](#sendquerymessage) | 以用户身份发送一条消息。<br><br>返回 void，不是 Promise。 |
+| [updateModelContext](#updatemodelcontext) | 向 Agent 捐赠上下文。 |
+| [setAdditionalContext](#setadditionalcontext) | 设置全局上下文供大模型理解。<br><br>设置全局上下文。 |
+| [dispatchActionDirective](#dispatchactiondirective) | 描述用户行为，约束模型行为及指定执行路径。 |
+| [updateWidget](#updatewidget) | 更新指定卡片。 |
+| [expiredWidget](#expiredwidget) | 更新过期的 widget 为固定卡片。 |
+| [openApp](#openapp) | 通过 deep link 等方式打开外部应用。 |
 
 ## API 详情
 
@@ -202,6 +203,34 @@ await sendQueryMessage({ content: '订阅消息', type: 'text' })
 
 `Promise`\<`object`\>
 
+<a id="expiredwidget"></a>
+### expiredWidget()
+
+> **expiredWidget**(`__namedParameters`): `Promise`\<`object`\>
+
+更新过期的 widget 为固定卡片
+
+#### Parameters
+
+• **\_\_namedParameters**: [`ExpiredWidgetParams`](#expiredwidgetparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Description
+
+用于将状态已经过期的 widget 实例转换为固定的卡片
+
+#### Example
+
+```ts
+expiredWidget({
+  widgetInstanceId: 'instance_123',
+  schema: '${pageId}?key=value'
+});
+```
+
 <a id="openapp"></a>
 ### openApp()
 
@@ -414,6 +443,29 @@ Widget 登录类型。
 
 会话消息关联的卡片ID
 
+<a id="actiondirectivetype"></a>
+### ActionDirectiveType
+
+#### Enumeration Members
+
+##### BUTTON\_CLICK
+
+> **BUTTON\_CLICK**: `"button_click"`
+
+按钮点击
+
+##### FORM\_SUBMIT
+
+> **FORM\_SUBMIT**: `"form_submit"`
+
+表单提交（复杂的信息提交场景）
+
+##### OPTION\_SELECT
+
+> **OPTION\_SELECT**: `"option_select"`
+
+选择（下拉列表场景）
+
 <a id="updatewidgetparams"></a>
 ### UpdateWidgetParams
 
@@ -437,6 +489,23 @@ Widget 登录类型。
 
 需要更新的widget 实例 ID
 
+<a id="expiredwidgetparams"></a>
+### ExpiredWidgetParams
+
+#### Properties
+
+##### schema?
+
+> `optional` **schema**: `string`
+
+点击失效卡要跳转的页面 schema，格式与 navigateTo 的 url 相同
+
+##### widgetInstanceId
+
+> **widgetInstanceId**: `string`
+
+卡片实例 ID，在卡片环境通过getWidgetInstanceId来获取，其他环境（比如页面）需要通过传参或通信的方式传递过去
+
 <a id="openapprequest"></a>
 ### OpenAppRequest
 

package/dist/{template-empty/.ai/reference/open-api/09-device-bluetooth.md → template-starter/.ai/reference/open-api/09-/350/256/276/345/244/207-/350/223/235/347/211/231.md}

@@ -1,4 +1,4 @@
-# Open API: Device / Bluetooth
+# Open API: 设备 / 蓝牙
 
 蓝牙和 BLE 能力；通常先打开适配器，再扫描、连接和读写。
 
@@ -6,27 +6,27 @@
 
 ## 速查
 
-| API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
-| --- | --- | --- | --- | --- | --- |
-| [`openBluetoothAdapter`](#openbluetoothadapter) | `openBluetoothAdapter(params?): Promise<object>` | 打开蓝牙适配器 | `params?: OpenBluetoothAdapterParams` | `Promise<object>` | 蓝牙流程入口 |
-| [`startBluetoothDevicesDiscovery`](#startbluetoothdevicesdiscovery) | `startBluetoothDevicesDiscovery(params?): Promise<object>` | 开始搜索附近的蓝牙设备 | `params?: StartBluetoothDevicesDiscoveryParams` | `Promise<object>` | 通常先调用 openBluetoothAdapter |
-| [`stopBluetoothDevicesDiscovery`](#stopbluetoothdevicesdiscovery) | `stopBluetoothDevicesDiscovery(params?): Promise<object>` | 停止搜索附近的蓝牙设备 | `params?` | `Promise<object>` | - |
-| [`getBluetoothAdapterState`](#getbluetoothadapterstate) | `getBluetoothAdapterState(params?): Promise<GetBluetoothAdapterStateResult>` | 获取蓝牙适配器状态 | `params?` | `Promise<GetBluetoothAdapterStateResult>` | - |
-| [`getBluetoothDevices`](#getbluetoothdevices) | `getBluetoothDevices(params?): Promise<GetBluetoothDevicesResult>` | 获取当前蓝牙模块发现的设备列表 | `params?` | `Promise<GetBluetoothDevicesResult>` | 通常先调用 startBluetoothDevicesDiscovery |
-| [`getConnectedBluetoothDevices`](#getconnectedbluetoothdevices) | `getConnectedBluetoothDevices(params): Promise<GetConnectedBluetoothDevicesResult>` | 获取已连接的蓝牙设备列表 | `params: GetConnectedBluetoothDevicesParams` | `Promise<GetConnectedBluetoothDevicesResult>` | - |
-| [`makeBluetoothPair`](#makebluetoothpair) | `makeBluetoothPair(params): Promise<object>` | 发起蓝牙配对 | `params: MakeBluetoothPairParams` | `Promise<object>` | - |
-| [`isBluetoothDevicePaired`](#isbluetoothdevicepaired) | `isBluetoothDevicePaired(params): Promise<object>` | 查询蓝牙设备是否已经配对 | `params: IsBluetoothDevicePairedParams` | `Promise<object>` | - |
-| [`closeBluetoothAdapter`](#closebluetoothadapter) | `closeBluetoothAdapter(params?): Promise<object>` | 关闭蓝牙适配器 | `params?` | `Promise<object>` | 会关闭蓝牙模块 |
-| [`createBLEConnection`](#createbleconnection) | `createBLEConnection(params): Promise<object>` | 创建 BLE 连接 | `params: CreateBLEConnectionParams` | `Promise<object>` | 需要传入 deviceId |
-| [`closeBLEConnection`](#closebleconnection) | `closeBLEConnection(params): Promise<object>` | 关闭 BLE 连接 | `params: CloseBLEConnectionParams` | `Promise<object>` | - |
-| [`getBLEDeviceServices`](#getbledeviceservices) | `getBLEDeviceServices(params): Promise<GetBLEDeviceServicesResult>` | 获取 BLE 服务列表 | `params: GetBLEDeviceServicesParams` | `Promise<GetBLEDeviceServicesResult>` | 通常先调用 createBLEConnection |
-| [`getBLEDeviceCharacteristics`](#getbledevicecharacteristics) | `getBLEDeviceCharacteristics(params): Promise<GetBLEDeviceCharacteristicsResult>` | 获取 BLE 特征值列表 | `params: GetBLEDeviceCharacteristicsParams` | `Promise<GetBLEDeviceCharacteristicsResult>` | 通常先获取 BLE 服务列表 |
-| [`getBLEDeviceRSSI`](#getbledevicerssi) | `getBLEDeviceRSSI(params): Promise<GetBLEDeviceRSSIResult>` | 获取 BLE 设备 RSSI | `params: GetBLEDeviceRSSIParams` | `Promise<GetBLEDeviceRSSIResult>` | - |
-| [`getBLEMTU`](#getblemtu) | `getBLEMTU(params): Promise<GetBLEMTUResult>` | 获取 BLE MTU | `params: GetBLEMTUParams` | `Promise<GetBLEMTUResult>` | - |
-| [`notifyBLECharacteristicValueChange`](#notifyblecharacteristicvaluechange) | `notifyBLECharacteristicValueChange(params): Promise<object>` | 订阅 BLE 特征值变化 | `params: NotifyBLECharacteristicValueChangeParams` | `Promise<object>` | 订阅指定特征值变化 |
-| [`readBLECharacteristicValue`](#readblecharacteristicvalue) | `readBLECharacteristicValue(params): Promise<object>` | 读取 BLE 特征值 | `params: ReadBLECharacteristicValueParams` | `Promise<object>` | 需要传入 serviceId 和 characteristicId |
-| [`setBLEMTU`](#setblemtu) | `setBLEMTU(params): Promise<SetBLEMTUResult>` | 设置 BLE MTU | `params: SetBLEMTUParams` | `Promise<SetBLEMTUResult>` | - |
-| [`writeBLECharacteristicValue`](#writeblecharacteristicvalue) | `writeBLECharacteristicValue(params): Promise<object>` | 写入 BLE 特征值 | `params: WriteBLECharacteristicValueParams` | `Promise<object>` | value 需要是 ArrayBuffer。 ## Enumerations ### ActionDirectiveType |
+| API | 说明 |
+| --- | --- |
+| [openBluetoothAdapter](#openbluetoothadapter) | 打开蓝牙适配器。<br><br>蓝牙流程入口。 |
+| [startBluetoothDevicesDiscovery](#startbluetoothdevicesdiscovery) | 开始搜索附近的蓝牙设备。<br><br>通常先调用 openBluetoothAdapter。 |
+| [stopBluetoothDevicesDiscovery](#stopbluetoothdevicesdiscovery) | 停止搜索附近的蓝牙设备。 |
+| [getBluetoothAdapterState](#getbluetoothadapterstate) | 获取蓝牙适配器状态。 |
+| [getBluetoothDevices](#getbluetoothdevices) | 获取当前蓝牙模块发现的设备列表。<br><br>通常先调用 startBluetoothDevicesDiscovery。 |
+| [getConnectedBluetoothDevices](#getconnectedbluetoothdevices) | 获取已连接的蓝牙设备列表。 |
+| [makeBluetoothPair](#makebluetoothpair) | 发起蓝牙配对。 |
+| [isBluetoothDevicePaired](#isbluetoothdevicepaired) | 查询蓝牙设备是否已经配对。 |
+| [closeBluetoothAdapter](#closebluetoothadapter) | 关闭蓝牙适配器。<br><br>会关闭蓝牙模块。 |
+| [createBLEConnection](#createbleconnection) | 创建 BLE 连接。<br><br>需要传入 deviceId。 |
+| [closeBLEConnection](#closebleconnection) | 关闭 BLE 连接。 |
+| [getBLEDeviceServices](#getbledeviceservices) | 获取 BLE 服务列表。<br><br>通常先调用 createBLEConnection。 |
+| [getBLEDeviceCharacteristics](#getbledevicecharacteristics) | 获取 BLE 特征值列表。<br><br>通常先获取 BLE 服务列表。 |
+| [getBLEDeviceRSSI](#getbledevicerssi) | 获取 BLE 设备 RSSI。 |
+| [getBLEMTU](#getblemtu) | 获取 BLE MTU。 |
+| [notifyBLECharacteristicValueChange](#notifyblecharacteristicvaluechange) | 订阅 BLE 特征值变化。<br><br>订阅指定特征值变化。 |
+| [readBLECharacteristicValue](#readblecharacteristicvalue) | 读取 BLE 特征值。<br><br>需要传入 serviceId 和 characteristicId。 |
+| [setBLEMTU](#setblemtu) | 设置 BLE MTU。 |
+| [writeBLECharacteristicValue](#writeblecharacteristicvalue) | 写入 BLE 特征值。<br><br>value 需要是 ArrayBuffer。 |
 
 ## API 详情
 
@@ -355,30 +355,6 @@
 
 value 需要是 ArrayBuffer。
 
-## Enumerations
-
-### ActionDirectiveType
-
-#### Enumeration Members
-
-##### BUTTON\_CLICK
-
-> **BUTTON\_CLICK**: `"button_click"`
-
-按钮点击
-
-##### FORM\_SUBMIT
-
-> **FORM\_SUBMIT**: `"form_submit"`
-
-表单提交（复杂的信息提交场景）
-
-##### OPTION\_SELECT
-
-> **OPTION\_SELECT**: `"option_select"`
-
-选择（下拉列表场景）
-
 ## 相关类型
 
 <a id="openbluetoothadapterparams"></a>

package/dist/{template-empty/.ai/reference/open-api/10-device-wi-fi.md → template-starter/.ai/reference/open-api/10-/350/256/276/345/244/207-wi-fi.md}

@@ -1,4 +1,4 @@
-# Open API: Device / Wi-Fi
+# Open API: 设备 / Wi-Fi
 
 Wi-Fi 模块能力；通常先 startWifi，再获取列表或连接。
 
@@ -6,14 +6,14 @@ Wi-Fi 模块能力；通常先 startWifi，再获取列表或连接。
 
 ## 速查
 
-| API | 签名 | 用途 | 参数类型 | 结果类型 | 注意点 |
-| --- | --- | --- | --- | --- | --- |
-| [`startWifi`](#startwifi) | `startWifi(params?): Promise<object>` | 初始化 Wi-Fi 模块 | `params?` | `Promise<object>` | Wi-Fi 流程入口 |
-| [`stopWifi`](#stopwifi) | `stopWifi(params?): Promise<object>` | 关闭 Wi-Fi 模块 | `params?` | `Promise<object>` | - |
-| [`setWifiList`](#setwifilist) | `setWifiList(params): Promise<object>` | 设置 Wi-Fi 预设列表 | `params: SetWifiListParams` | `Promise<object>` | 用于预设 Wi-Fi 列表 |
-| [`connectWifi`](#connectwifi) | `connectWifi(params): Promise<object>` | 连接指定 Wi-Fi | `params: ConnectWifiParams` | `Promise<object>` | 通常先调用 startWifi |
-| [`getConnectedWifi`](#getconnectedwifi) | `getConnectedWifi(params?): Promise<GetConnectedWifiResult>` | 获取当前已连接 Wi-Fi 信息 | `params?: GetConnectedWifiParams` | `Promise<GetConnectedWifiResult>` | - |
-| [`getWifiList`](#getwifilist) | `getWifiList(params?): Promise<GetWifiListResult>` | 获取 Wi-Fi 列表 | `params?` | `Promise<GetWifiListResult>` | 通常先调用 startWifi |
+| API | 说明 |
+| --- | --- |
+| [startWifi](#startwifi) | 初始化 Wi-Fi 模块。<br><br>Wi-Fi 流程入口。 |
+| [stopWifi](#stopwifi) | 关闭 Wi-Fi 模块。 |
+| [setWifiList](#setwifilist) | 设置 Wi-Fi 预设列表。<br><br>用于预设 Wi-Fi 列表。 |
+| [connectWifi](#connectwifi) | 连接指定 Wi-Fi。<br><br>通常先调用 startWifi。 |
+| [getConnectedWifi](#getconnectedwifi) | 获取当前已连接 Wi-Fi 信息。 |
+| [getWifiList](#getwifilist) | 获取 Wi-Fi 列表。<br><br>通常先调用 startWifi。 |
 
 ## API 详情
 

package/dist/template-starter/.ai/reference/open-api/11-/350/256/276/345/244/207-/345/212/240/351/200/237/345/272/246/350/256/241.md

@@ -0,0 +1,104 @@
+# Open API: 设备 / 加速度计
+
+加速度计监听能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startAccelerometer](#startaccelerometer) | 开始监听加速度。<br><br>需配对调用 stopAccelerometer。 |
+| [stopAccelerometer](#stopaccelerometer) | 停止监听加速度。 |
+| [onAccelerometerChange](#onaccelerometerchange) | 监听加速度数据变化事件。<br><br>返回取消监听函数。 |
+
+## API 详情
+
+<a id="startaccelerometer"></a>
+### startAccelerometer()
+
+> **startAccelerometer**(`params`?): `Promise`\<`object`\>
+
+开始监听加速度。
+
+#### Parameters
+
+• **params?**: [`StartAccelerometerParams`](#startaccelerometerparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+需配对调用 stopAccelerometer。
+
+<a id="stopaccelerometer"></a>
+### stopAccelerometer()
+
+> **stopAccelerometer**(`params`?): `Promise`\<`object`\>
+
+停止监听加速度。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="onaccelerometerchange"></a>
+### onAccelerometerChange()
+
+> **onAccelerometerChange**(`handler`): () => `void`
+
+监听加速度数据变化事件。
+
+#### Parameters
+
+• **handler**
+
+#### Returns
+
+`Function`
+
+返回取消当前监听函数的函数。
+
+##### Returns
+
+`void`
+
+#### Example
+
+```ts
+import { onAccelerometerChange } from '@doubao-apps/framework/api';
+
+const off = onAccelerometerChange(({ x, y, z, timestamp }) => {
+  console.log(x, y, z, timestamp);
+});
+
+off();
+```
+
+## 相关类型
+
+<a id="startaccelerometerparams"></a>
+### StartAccelerometerParams
+
+开始监听加速度的请求参数。
+
+#### Properties
+
+##### interval?
+
+> `optional` **interval**: [`SensorInterval`](#sensorinterval)
+
+监听频率。
+
+<a id="sensorinterval"></a>
+### SensorInterval
+
+> **SensorInterval**: `"game"` \| `"ui"` \| `"normal"`
+
+传感器监听频率。

package/dist/template-starter/.ai/reference/open-api/12-/350/256/276/345/244/207-ibeacon.md

@@ -0,0 +1,148 @@
+# Open API: 设备 / iBeacon
+
+iBeacon 搜索和结果读取能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startBeaconDiscovery](#startbeacondiscovery) | 开始搜索附近的 iBeacon。<br><br>需配对调用 stopBeaconDiscovery。 |
+| [stopBeaconDiscovery](#stopbeacondiscovery) | 停止搜索附近的 iBeacon。 |
+| [getBeacons](#getbeacons) | 获取已搜索到的 iBeacon 列表。 |
+
+## API 详情
+
+<a id="startbeacondiscovery"></a>
+### startBeaconDiscovery()
+
+> **startBeaconDiscovery**(`params`): `Promise`\<`object`\>
+
+开始搜索附近的 iBeacon。
+
+#### Parameters
+
+• **params**: [`StartBeaconDiscoveryParams`](#startbeacondiscoveryparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+需配对调用 stopBeaconDiscovery。
+
+<a id="stopbeacondiscovery"></a>
+### stopBeaconDiscovery()
+
+> **stopBeaconDiscovery**(`params`?): `Promise`\<`object`\>
+
+停止搜索附近的 iBeacon。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="getbeacons"></a>
+### getBeacons()
+
+> **getBeacons**(`params`?): `Promise`\<[`GetBeaconsResult`](#getbeaconsresult)\>
+
+获取已搜索到的 iBeacon 列表。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<[`GetBeaconsResult`](#getbeaconsresult)\>
+
+## 相关类型
+
+<a id="startbeacondiscoveryparams"></a>
+### StartBeaconDiscoveryParams
+
+开始搜索 iBeacon 的请求参数。
+
+#### Properties
+
+##### ignoreBluetoothAvailable?
+
+> `optional` **ignoreBluetoothAvailable**: `boolean`
+
+iOS 下是否忽略蓝牙可用性校验。
+
+##### uuids
+
+> **uuids**: `string`[]
+
+要搜索的 iBeacon UUID 列表。
+
+<a id="getbeaconsresult"></a>
+### GetBeaconsResult
+
+获取 iBeacon 列表的返回结果。
+
+#### Properties
+
+##### beacons
+
+> **beacons**: [`BeaconInfo`](#beaconinfo)[]
+
+当前搜到的 iBeacon 列表。
+
+<a id="beaconinfo"></a>
+### BeaconInfo
+
+iBeacon 设备信息。
+
+#### Properties
+
+##### accuracy
+
+> **accuracy**: `number`
+
+距离，单位米。
+
+##### major
+
+> **major**: `string`
+
+主 ID。
+
+##### minor
+
+> **minor**: `string`
+
+次 ID。
+
+##### proximity
+
+> **proximity**: [`BeaconProximity`](#beaconproximity)
+
+距离等级。
+
+##### rssi
+
+> **rssi**: `number`
+
+RSSI 信号强度，单位 dBm。
+
+##### uuid
+
+> **uuid**: `string`
+
+Beacon UUID。
+
+<a id="beaconproximity"></a>
+### BeaconProximity
+
+> **BeaconProximity**: `0` \| `1` \| `2` \| `3`
+
+iBeacon 距离等级。

package/dist/template-starter/.ai/reference/open-api/13-/350/256/276/345/244/207-/347/275/227/347/233/230.md

@@ -0,0 +1,82 @@
+# Open API: 设备 / 罗盘
+
+罗盘监听能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startCompass](#startcompass) | 开始监听罗盘。<br><br>需配对调用 stopCompass。 |
+| [stopCompass](#stopcompass) | 停止监听罗盘。 |
+| [onCompassChange](#oncompasschange) | 监听罗盘数据变化事件。<br><br>返回取消监听函数。 |
+
+## API 详情
+
+<a id="startcompass"></a>
+### startCompass()
+
+> **startCompass**(`params`?): `Promise`\<`object`\>
+
+开始监听罗盘。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+需配对调用 stopCompass。
+
+<a id="stopcompass"></a>
+### stopCompass()
+
+> **stopCompass**(`params`?): `Promise`\<`object`\>
+
+停止监听罗盘。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+<a id="oncompasschange"></a>
+### onCompassChange()
+
+> **onCompassChange**(`handler`): () => `void`
+
+监听罗盘数据变化事件。
+
+#### Parameters
+
+• **handler**
+
+#### Returns
+
+`Function`
+
+返回取消当前监听函数的函数。
+
+##### Returns
+
+`void`
+
+#### Example
+
+```ts
+import { onCompassChange } from '@doubao-apps/framework/api';
+
+const off = onCompassChange(({ direction }) => {
+  console.log(direction);
+});
+
+off();
+```

package/dist/template-starter/.ai/reference/open-api/14-/350/256/276/345/244/207-/350/256/276/345/244/207/346/226/271/345/220/221.md

@@ -0,0 +1,70 @@
+# Open API: 设备 / 设备方向
+
+设备方向监听能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startDeviceMotionListening](#startdevicemotionlistening) | 开始监听设备方向变化。<br><br>需配对调用 stopDeviceMotionListening。 |
+| [stopDeviceMotionListening](#stopdevicemotionlistening) | 停止监听设备方向变化。 |
+
+## API 详情
+
+<a id="startdevicemotionlistening"></a>
+### startDeviceMotionListening()
+
+> **startDeviceMotionListening**(`params`?): `Promise`\<`object`\>
+
+开始监听设备方向变化。
+
+#### Parameters
+
+• **params?**: [`StartDeviceMotionListeningParams`](#startdevicemotionlisteningparams)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+#### Remarks
+
+需配对调用 stopDeviceMotionListening。
+
+<a id="stopdevicemotionlistening"></a>
+### stopDeviceMotionListening()
+
+> **stopDeviceMotionListening**(`params`?): `Promise`\<`object`\>
+
+停止监听设备方向变化。
+
+#### Parameters
+
+• **params?**
+
+#### Returns
+
+`Promise`\<`object`\>
+
+## 相关类型
+
+<a id="startdevicemotionlisteningparams"></a>
+### StartDeviceMotionListeningParams
+
+开始监听设备方向变化的请求参数。
+
+#### Properties
+
+##### interval?
+
+> `optional` **interval**: [`SensorInterval`](#sensorinterval)
+
+监听频率。
+
+<a id="sensorinterval"></a>
+### SensorInterval
+
+> **SensorInterval**: `"game"` \| `"ui"` \| `"normal"`
+
+传感器监听频率。