@doubao-apps/ai 0.0.34 → 0.0.35

package/dist/skills/doubao-apps-dev/references/reference/open-api/02-/347/263/273/347/273/237.md

@@ -1,257 +0,0 @@
-# Open API: 系统
-
-宿主基础信息、窗口信息和系统设置。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [getWindowInfoSync](#getwindowinfosync) | 获取窗口信息。<br><br>同步 API。 |
-| [getSystemSetting](#getsystemsetting) | 获取设备设置。 |
-| [getAppBaseInfoSync](#getappbaseinfosync) | 获取应用基础信息。<br><br>同步 API。 |
-| [getWindowInfo](#getwindowinfo) | 获取窗口信息。 |
-| [getAppBaseInfo](#getappbaseinfo) | 获取应用基础信息。 |
-| [ThemeChangeListener](#themechangelistener) | 应用主题变化事件监听函数。<br><br>返回 void，不是 Promise。 |
-| [onThemeChange](#onthemechange) | 监听应用主题变化。 |
-
-## API 详情
-
-<a id="getwindowinfosync"></a>
-### getWindowInfoSync()
-
-获取窗口信息。
-
-## 代码示例
-
-```typescript
-import { getWindowInfoSync } from '@doubao-apps/framework/api';
-
-const result = getWindowInfoSync();
-
-console.log(result.windowWidth, result.windowHeight);
-console.log(result.safeArea?.top, result.screenTop);
-```
-
-## 入参
-
-无入参。
-
-## 返回值
-
-返回窗口尺寸、状态栏高度和安全区域等信息，字段见 GetWindowInfoResult。
-
-|字段名|类型|说明|
-|---|---|---|
-|pixelRatio|`number`|设备像素比|
-|safeArea|`WindowSafeArea`|安全区域|
-|safeArea.bottom|`number`|安全区域右下角纵坐标|
-|safeArea.height|`number`|安全区域高度|
-|safeArea.left|`number`|安全区域左上角横坐标|
-|safeArea.right|`number`|安全区域右下角横坐标|
-|safeArea.top|`number`|安全区域左上角纵坐标|
-|safeArea.width|`number`|安全区域宽度|
-|screenHeight|`number`|屏幕高度|
-|screenTop|`number`|窗口上边缘的 y 值|
-|screenWidth|`number`|屏幕宽度|
-|statusBarHeight|`number`|状态栏高度|
-|windowHeight|`number`|可使用窗口高度|
-|windowWidth|`number`|可使用窗口宽度|
-
-<a id="getsystemsetting"></a>
-### getSystemSetting()
-
-获取设备设置。
-
-## 代码示例
-
-```typescript
-import { getSystemSetting } from '@doubao-apps/framework/api';
-
-const result = getSystemSetting();
-
-console.log(result.bluetoothEnabled, result.locationEnabled);
-console.log(result.wifiEnabled, result.deviceOrientation);
-```
-
-## 入参
-
-无入参。
-
-## 返回值
-
-返回蓝牙、定位、Wi-Fi 系统开关和设备方向等字段，见 GetSystemSettingResult。
-
-|字段名|类型|说明|
-|---|---|---|
-|bluetoothEnabled|`boolean`|蓝牙的系统开关|
-|deviceOrientation|`DeviceOrientation`|设备方向|
-|locationEnabled|`boolean`|地理位置的系统开关|
-|wifiEnabled|`boolean`|Wi-Fi 的系统开关|
-
-**类型说明**
-
-- `DeviceOrientation`: `"portrait" | "landscape"`
-
-<a id="getappbaseinfosync"></a>
-### getAppBaseInfoSync()
-
-获取应用基础信息。
-
-## 代码示例
-
-```typescript
-import { getAppBaseInfoSync } from '@doubao-apps/framework/api';
-
-const result = getAppBaseInfoSync();
-
-console.log(result.language, result.SDKVersion, result.theme);
-console.log(result.host?.appId, result.enableDebug);
-```
-
-## 入参
-
-无入参。
-
-## 返回值
-
-返回 SDK 版本、调试开关、宿主信息、语言和主题等字段，见 GetAppBaseInfoResult。
-
-|字段名|类型|说明|
-|---|---|---|
-|enableDebug|`boolean`|是否已打开调试|
-|host|`AppBaseInfoHost`|当前豆包 App运行的宿主环境|
-|host.appId|`string`|宿主 app 对应的 appId|
-|language|`string`|当前语言|
-|SDKVersion|`string`|客户端基础库版本|
-|theme|`"light" \| "dark"`|当前主题|
-|version|`string`|宿主版本号|
-
-<a id="getwindowinfo"></a>
-### getWindowInfo()
-
-获取窗口信息。
-
-## 代码示例
-
-```typescript
-import { getWindowInfo } from '@doubao-apps/framework/api';
-
-const result = await getWindowInfo();
-
-console.log(result.windowWidth, result.windowHeight);
-console.log(result.safeArea?.top, result.screenTop);
-```
-
-## 入参
-
-无入参。
-
-## 返回值
-
-返回窗口尺寸、状态栏高度和安全区域等信息，字段见 GetWindowInfoResult。
-
-|字段名|类型|说明|
-|---|---|---|
-|pixelRatio|`number`|设备像素比|
-|safeArea|`WindowSafeArea`|安全区域|
-|safeArea.bottom|`number`|安全区域右下角纵坐标|
-|safeArea.height|`number`|安全区域高度|
-|safeArea.left|`number`|安全区域左上角横坐标|
-|safeArea.right|`number`|安全区域右下角横坐标|
-|safeArea.top|`number`|安全区域左上角纵坐标|
-|safeArea.width|`number`|安全区域宽度|
-|screenHeight|`number`|屏幕高度|
-|screenTop|`number`|窗口上边缘的 y 值|
-|screenWidth|`number`|屏幕宽度|
-|statusBarHeight|`number`|状态栏高度|
-|windowHeight|`number`|可使用窗口高度|
-|windowWidth|`number`|可使用窗口宽度|
-
-<a id="getappbaseinfo"></a>
-### getAppBaseInfo()
-
-获取应用基础信息。
-
-## 代码示例
-
-```typescript
-import { getAppBaseInfo } from '@doubao-apps/framework/api';
-
-const result = await getAppBaseInfo();
-
-console.log(result.language, result.SDKVersion, result.theme);
-console.log(result.host?.appId, result.enableDebug);
-```
-
-## 入参
-
-无入参。
-
-## 返回值
-
-返回 SDK 版本、调试开关、宿主信息、语言和主题等字段，见 GetAppBaseInfoResult。
-
-|字段名|类型|说明|
-|---|---|---|
-|enableDebug|`boolean`|是否已打开调试|
-|host|`AppBaseInfoHost`|当前豆包 App运行的宿主环境|
-|host.appId|`string`|宿主 app 对应的 appId|
-|language|`string`|当前语言|
-|SDKVersion|`string`|客户端基础库版本|
-|theme|`"light" \| "dark"`|当前主题|
-|version|`string`|宿主版本号|
-
-<a id="themechangelistener"></a>
-### ThemeChangeListener()
-
-应用主题变化事件监听函数。
-
-## 代码示例
-
-```typescript
-// 暂无代码示例
-```
-
-## 入参
-
-|参数名|类型|必填|说明|
-|---|---|---|---|
-|theme|`AppTheme`|是|切换后的应用主题|
-
-**类型说明**
-
-- `AppTheme`: `"light" | "dark"`
-
-## 返回值
-
-返回 `void`。
-
-<a id="onthemechange"></a>
-### onThemeChange()
-
-监听应用主题变化。
-
-当用户在系统设置或宿主内切换浅色、深色主题时触发。回调参数中的 `theme` 表示切换后的主题，可与
-getAppBaseInfo 返回的 `theme` 字段配合使用。
-
-## 代码示例
-
-```typescript
-import { onThemeChange } from '@doubao-apps/framework/api';
-
-const offThemeChange = onThemeChange(({ theme }) => {
-  console.log('当前主题:', theme);
-});
-
-offThemeChange();
-```
-
-## 入参
-
-无入参。
-
-## 返回值
-
-返回取消当前监听函数的函数。

package/dist/skills/doubao-apps-dev/references/reference/open-api/08-/347/275/221/347/273/234.md

@@ -1,124 +0,0 @@
-# Open API: 网络
-
-网络请求与 WebSocket。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [request](#request) | 发起网络请求。 |
-| [connectSocket](#connectsocket) | 创建一个 WebSocket 连接，并返回可操作该连接的 SocketTask。 |
-
-## API 详情
-
-<a id="request"></a>
-### request()
-
-发起网络请求。
-
-`request` 本身不接受泛型参数；如需业务数据类型，请读取 `result.data` 后再做类型收窄或断言。
-
-## 代码示例
-
-```typescript
-import { request } from '@doubao-apps/framework/api';
-
-const result = await request({
-  url: 'https://postman-echo.com/post',
-  method: 'POST',
-  dataType: 'json',
-  header: { 'content-type': 'application/json' },
-  data: { hello: 'world' }
-});
-
-console.log(result.statusCode, result.data);
-```
-
-## 入参
-
-|参数名|类型|必填|说明|
-|---|---|---|---|
-|data|`string \| Record<string, any> \| ArrayBuffer`|否|请求体数据。<br><br>传给服务器的数据最终会是 `String` 或 `ArrayBuffer`：<br>- 若 `data` 是 `string` 或 `ArrayBuffer`，直接使用；<br>- 若 `header['content-type']` 是 `application/x-www-form-urlencoded`，会被编码为 query string，例如：`encodeURIComponent(k)=encodeURIComponent(v)`；<br>- 若 `header['content-type']` 是 `application/json`，会执行 JSON 序列化；<br>- 若 `data` 是普通对象且未命中上述类型，也会执行 JSON 序列化；<br>- 其他类型会调用 `toString()`|
-|dataType|`"string" \| "json"`|否|期望返回的数据格式。<br>- `json`: 尝试按 JSON 解析；<br>- `string`: 按字符串返回。|
-|header|`Record<string, string>`|否|请求 Header。|
-|method|`RequestMethod`|否|请求方法。|
-|url|`string`|是|请求地址，需为完整的 **HTTPS** URL。|
-
-**类型说明**
-
-- `RequestMethod`: `"GET" | "POST" | "PUT" | "DELETE" | "HEAD" | "OPTIONS" | "TRACE" | "CONNECT"`
-
-## 返回值
-
-返回一个 Promise，解析为 RequestResponse。
-
-|字段名|类型|说明|
-|---|---|---|
-|data|`string \| Record<string, any> \| ArrayBuffer`|响应数据，类型由 `dataType` 决定。|
-|header|`Record<string, string>`|HTTP 响应头。|
-|statusCode|`number`|HTTP 状态码。|
-
-<a id="connectsocket"></a>
-### connectSocket()
-
-创建一个 WebSocket 连接，并返回可操作该连接的 SocketTask。
-
-该 API 会同步返回 `SocketTask`，但连接创建本身是异步过程。调用方应先在返回的
-`SocketTask` 上注册事件回调，再等待 `onOpen` 表示连接可用。后续发送消息使用
-`SocketTask.send`，关闭连接使用 `SocketTask.close`。
-
-## 代码示例
-
-```typescript
-import { connectSocket } from '@doubao-apps/framework/api';
-
-const socketTask = connectSocket({
-  url: 'wss://example.com/socket',
-  header: { authorization: 'Bearer token' },
-  protocols: ['chat.v1']
-});
-
-socketTask.onOpen(() => {
-  socketTask.send({ data: 'hello' });
-});
-
-socketTask.onMessage((event) => {
-  console.log(event.data);
-});
-
-socketTask.onClose((event) => {
-  console.log(event.code, event.reason);
-});
-
-socketTask.onError((event) => {
-  console.error(event.errMsg);
-});
-```
-
-## 入参
-
-|参数名|类型|必填|说明|
-|---|---|---|---|
-|header|`Record<string, string>`|否|WebSocket 握手阶段携带的 HTTP Header。<br><br>适合放置业务自定义 Header，例如鉴权 token、trace id、客户端能力标识等。<br>`referer` 由宿主侧统一生成和管理，不应依赖该字段被业务传入值覆盖。|
-|protocols|`string[]`|否|WebSocket 子协议数组。<br><br>会作为握手请求中的 `Sec-WebSocket-Protocol` 候选值传给服务端。<br>如果传入非空数组，服务端需要选择其中一个协议并在握手响应中返回；<br>服务端不支持或不返回匹配协议时，连接可能被宿主判定为创建失败。|
-|url|`string`|是|WebSocket 连接地址。<br><br>需要包含协议、域名、路径和可选 query，例如 `wss://example.com/socket?room=1`。<br>如果地址为空或不是字符串，本 API 会返回 `readyState` 为 `undefined` 的 SocketTask，<br>并异步触发 `onError`。|
-
-## 返回值
-
-当前 WebSocket 连接对应的 SocketTask。
-
-|字段名|类型|说明|
-|---|---|---|
-|CLOSED|`3`|表示 Socket 连接已关闭。<br><br>进入该状态后，该任务不会再收到新的消息，也不应继续调用 `send`。|
-|CLOSING|`2`|表示 Socket 连接关闭中。<br><br>调用 SocketTask.close 后、本地等待宿主侧完成关闭流程时通常处于该状态。|
-|CONNECTING|`0`|表示 Socket 正在连接。<br><br>`connectSocket` 刚返回且宿主尚未完成握手时通常处于该状态。|
-|OPEN|`1`|表示 Socket 连接已经打开。<br><br>进入该状态后可以调用 SocketTask.send 发送数据。|
-|readyState|`number \| undefined`|当前 Socket 连接状态 code。<br><br>可与 `CONNECTING`、`OPEN`、`CLOSING`、`CLOSED` 常量比较。<br>如果因为参数错误等原因导致连接请求没有被宿主成功创建，则为 `undefined`。|
-|close|`(params?: SocketTaskCloseParams) => void`|-|
-|onClose|`(callback: Function) => void`|-|
-|onError|`(callback: Function) => void`|-|
-|onMessage|`(callback: Function) => void`|-|
-|onOpen|`(callback: Function) => void`|-|
-|send|`(params: SocketTaskSendParams) => void`|-|

package/dist/skills/doubao-apps-dev/references/reference/open-api/16-/345/212/240/351/200/237/345/272/246/350/256/241.md

@@ -1,87 +0,0 @@
-# Open API: 加速度计
-
-加速度计监听能力。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [AccelerometerChangeListener](#accelerometerchangelistener) | 加速度数据变化事件监听函数。<br><br>返回 void，不是 Promise。 |
-| [startAccelerometer](#startaccelerometer) | 开始监听加速度。 |
-| [stopAccelerometer](#stopaccelerometer) | 停止监听加速度。 |
-
-## API 详情
-
-<a id="accelerometerchangelistener"></a>
-### AccelerometerChangeListener()
-
-加速度数据变化事件监听函数。
-
-## 代码示例
-
-```typescript
-// 暂无代码示例
-```
-
-## 入参
-
-|参数名|类型|必填|说明|
-|---|---|---|---|
-|timestamp|`number`|是|数据采集时间戳，单位纳秒。|
-|x|`number`|是|X 轴加速度，单位 m/s²。|
-|y|`number`|是|Y 轴加速度，单位 m/s²。|
-|z|`number`|是|Z 轴加速度，单位 m/s²。|
-
-## 返回值
-
-返回 `void`。
-
-<a id="startaccelerometer"></a>
-### startAccelerometer()
-
-开始监听加速度。
-
-## 代码示例
-
-```typescript
-import { startAccelerometer } from '@doubao-apps/framework/api';
-
-await startAccelerometer({ interval: 'normal' });
-```
-
-## 入参
-
-|参数名|类型|必填|说明|
-|---|---|---|---|
-|interval|`SensorInterval`|否|监听频率。|
-
-**类型说明**
-
-- `SensorInterval`: `"game" | "ui" | "normal"`
-
-## 返回值
-
-返回 `Promise<object>`。
-
-<a id="stopaccelerometer"></a>
-### stopAccelerometer()
-
-停止监听加速度。
-
-## 代码示例
-
-```typescript
-import { stopAccelerometer } from '@doubao-apps/framework/api';
-
-await stopAccelerometer();
-```
-
-## 入参
-
-无入参。
-
-## 返回值
-
-返回 `Promise<object>`。

package/dist/skills/doubao-apps-dev/references/reference/open-api/19-/350/256/276/345/244/207/346/226/271/345/220/221.md

@@ -1,86 +0,0 @@
-# Open API: 设备方向
-
-设备方向监听能力。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [DeviceMotionChangeListener](#devicemotionchangelistener) | 设备方向变化事件监听函数。<br><br>返回 void，不是 Promise。 |
-| [startDeviceMotionListening](#startdevicemotionlistening) | 开始监听设备方向变化。 |
-| [stopDeviceMotionListening](#stopdevicemotionlistening) | 停止监听设备方向变化。 |
-
-## API 详情
-
-<a id="devicemotionchangelistener"></a>
-### DeviceMotionChangeListener()
-
-设备方向变化事件监听函数。
-
-## 代码示例
-
-```typescript
-// 暂无代码示例
-```
-
-## 入参
-
-|参数名|类型|必填|说明|
-|---|---|---|---|
-|alpha|`number`|是|当手机坐标 X/Y 和地球坐标 X/Y 重合时，绕 Z 轴转动的夹角。<br>范围为 [0, 2π)，逆时针转动为正。|
-|beta|`number`|是|当手机坐标 Y/Z 和地球坐标 Y/Z 重合时，绕 X 轴转动的夹角。<br>范围为 [-π, π)。|
-|gamma|`number`|是|当手机坐标 X/Z 和地球坐标 X/Z 重合时，绕 Y 轴转动的夹角。<br>范围为 [-π/2, π/2)。|
-
-## 返回值
-
-返回 `void`。
-
-<a id="startdevicemotionlistening"></a>
-### startDeviceMotionListening()
-
-开始监听设备方向变化。
-
-## 代码示例
-
-```typescript
-import { startDeviceMotionListening } from '@doubao-apps/framework/api';
-
-await startDeviceMotionListening({ interval: 'normal' });
-```
-
-## 入参
-
-|参数名|类型|必填|说明|
-|---|---|---|---|
-|interval|`SensorInterval`|否|监听频率。|
-
-**类型说明**
-
-- `SensorInterval`: `"game" | "ui" | "normal"`
-
-## 返回值
-
-返回 `Promise<object>`。
-
-<a id="stopdevicemotionlistening"></a>
-### stopDeviceMotionListening()
-
-停止监听设备方向变化。
-
-## 代码示例
-
-```typescript
-import { stopDeviceMotionListening } from '@doubao-apps/framework/api';
-
-await stopDeviceMotionListening();
-```
-
-## 入参
-
-无入参。
-
-## 返回值
-
-返回 `Promise<object>`。

package/dist/skills/doubao-apps-dev/references/reference/open-api/20-/351/231/200/350/236/272/344/273/252.md

@@ -1,87 +0,0 @@
-# Open API: 陀螺仪
-
-陀螺仪监听能力。
-
-[返回目录](./README.md) | [返回速查](../open-api.md)
-
-## 速查
-
-| API | 说明 |
-| --- | --- |
-| [GyroscopeChangeListener](#gyroscopechangelistener) | 陀螺仪数据变化事件监听函数。<br><br>返回 void，不是 Promise。 |
-| [startGyroscope](#startgyroscope) | 开始监听陀螺仪。 |
-| [stopGyroscope](#stopgyroscope) | 停止监听陀螺仪。 |
-
-## API 详情
-
-<a id="gyroscopechangelistener"></a>
-### GyroscopeChangeListener()
-
-陀螺仪数据变化事件监听函数。
-
-## 代码示例
-
-```typescript
-// 暂无代码示例
-```
-
-## 入参
-
-|参数名|类型|必填|说明|
-|---|---|---|---|
-|timestamp|`number`|是|数据采集时间戳，单位纳秒。|
-|x|`number`|是|绕 X 轴旋转的角速度，单位 rad/s。|
-|y|`number`|是|绕 Y 轴旋转的角速度，单位 rad/s。|
-|z|`number`|是|绕 Z 轴旋转的角速度，单位 rad/s。|
-
-## 返回值
-
-返回 `void`。
-
-<a id="startgyroscope"></a>
-### startGyroscope()
-
-开始监听陀螺仪。
-
-## 代码示例
-
-```typescript
-import { startGyroscope } from '@doubao-apps/framework/api';
-
-await startGyroscope({ interval: 'normal' });
-```
-
-## 入参
-
-|参数名|类型|必填|说明|
-|---|---|---|---|
-|interval|`SensorInterval`|否|监听频率。|
-
-**类型说明**
-
-- `SensorInterval`: `"game" | "ui" | "normal"`
-
-## 返回值
-
-返回 `Promise<object>`。
-
-<a id="stopgyroscope"></a>
-### stopGyroscope()
-
-停止监听陀螺仪。
-
-## 代码示例
-
-```typescript
-import { stopGyroscope } from '@doubao-apps/framework/api';
-
-await stopGyroscope();
-```
-
-## 入参
-
-无入参。
-
-## 返回值
-
-返回 `Promise<object>`。