@doubao-apps/ai 0.0.33 → 0.0.34

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

@@ -0,0 +1,284 @@
+# 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()
+
+将数据写入本地缓存。
+
+## 代码示例
+
+```typescript
+import { setStorage } from '@doubao-apps/framework/api';
+
+await setStorage({
+  key: 'profile',
+  data: { name: 'Tom', age: 18 },
+});
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|data|`TData`|是|待存储的数据|
+|key|`string`|是|本地缓存键名|
+
+## 返回值
+
+返回一个 Promise，写入完成后 resolve。
+
+<a id="setstoragesync"></a>
+### setStorageSync()
+
+将数据写入本地缓存。
+
+## 代码示例
+
+```typescript
+import { setStorageSync } from '@doubao-apps/framework/api';
+
+setStorageSync({
+  key: 'profile',
+  data: { name: 'Tom', age: 18 },
+});
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|data|`TData`|是|待存储的数据|
+|key|`string`|是|本地缓存键名|
+
+## 返回值
+
+同步写入完成后返回。
+
+<a id="getstorage"></a>
+### getStorage()
+
+从本地缓存读取数据。
+
+## 代码示例
+
+```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);
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|key|`string`|是|本地缓存键名|
+
+## 返回值
+
+返回一个 Promise，解析为 GetStorageResult。
+
+|字段名|类型|说明|
+|---|---|---|
+|data|`TData`|key 对应的数据|
+
+<a id="getstoragesync"></a>
+### getStorageSync()
+
+从本地缓存同步读取数据。
+
+## 代码示例
+
+```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);
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|key|`string`|是|本地缓存键名|
+
+## 返回值
+
+返回 GetStorageResult。
+
+|字段名|类型|说明|
+|---|---|---|
+|data|`TData`|key 对应的数据|
+
+<a id="removestorage"></a>
+### removeStorage()
+
+删除本地缓存中指定 key 的数据。
+
+## 代码示例
+
+```typescript
+import { removeStorage } from '@doubao-apps/framework/api';
+
+await removeStorage({ key: 'profile' });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|key|`string`|是|本地缓存键名|
+
+## 返回值
+
+返回一个 Promise，删除完成后 resolve。
+
+<a id="removestoragesync"></a>
+### removeStorageSync()
+
+删除本地缓存中指定 key 的数据。
+
+## 代码示例
+
+```typescript
+import { removeStorageSync } from '@doubao-apps/framework/api';
+
+removeStorageSync({ key: 'profile' });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|key|`string`|否|本地缓存键名|
+
+## 返回值
+
+同步删除完成后返回。
+
+<a id="clearstorage"></a>
+### clearStorage()
+
+清空本地缓存。
+
+## 代码示例
+
+```typescript
+import { clearStorage } from '@doubao-apps/framework/api';
+
+await clearStorage();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回一个 Promise，清空完成后 resolve。
+
+<a id="clearstoragesync"></a>
+### clearStorageSync()
+
+清空本地缓存。
+
+## 代码示例
+
+```typescript
+import { clearStorageSync } from '@doubao-apps/framework/api';
+
+clearStorageSync();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+同步清空完成后返回。
+
+<a id="getstorageinfo"></a>
+### getStorageInfo()
+
+获取本地缓存信息。
+
+## 代码示例
+
+```typescript
+import { getStorageInfo } from '@doubao-apps/framework/api';
+
+const result = await getStorageInfo();
+
+console.log(result.keys, result.currentSize, result.limitSize);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回一个 Promise，解析为 GetStorageInfoResult。
+
+|字段名|类型|说明|
+|---|---|---|
+|currentSize|`number`|当前占用的空间大小，单位 KB|
+|keys|`string[]`|当前 storage 中所有的 key|
+|limitSize|`number`|限制的空间大小，单位 KB|
+
+<a id="getstorageinfosync"></a>
+### getStorageInfoSync()
+
+同步获取本地缓存信息。
+
+## 代码示例
+
+```typescript
+import { getStorageInfoSync } from '@doubao-apps/framework/api';
+
+const result = getStorageInfoSync();
+
+console.log(result.keys, result.currentSize, result.limitSize);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 GetStorageInfoResult。
+
+|字段名|类型|说明|
+|---|---|---|
+|currentSize|`number`|当前占用的空间大小，单位 KB|
+|keys|`string[]`|当前 storage 中所有的 key|
+|limitSize|`number`|限制的空间大小，单位 KB|

package/dist/skills/doubao-apps-dev/references/reference/open-api/05-/350/267/257/347/224/261.md

@@ -0,0 +1,162 @@
+# Open API: 路由
+
+应用内页面跳转、返回、退出和关闭。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [navigateTo](#navigateto) | 保留当前页面，跳转到应用内的某个页面。 |
+| [redirectTo](#redirectto) | 关闭当前页面，跳转到应用内的某个页面。 |
+| [reLaunch](#relaunch) | 关闭所有页面并跳转到应用内页面。 |
+| [navigateBack](#navigateback) | 关闭当前页面，返回上一页面或多级页面。 |
+| [exitApp](#exitapp) | 退出当前所有页面。 |
+| [close](#close) | 关闭栈顶页面。 |
+
+## API 详情
+
+<a id="navigateto"></a>
+### navigateTo()
+
+保留当前页面，跳转到应用内的某个页面。
+
+## 代码示例
+
+```typescript
+import { navigateTo } from '@doubao-apps/framework/api';
+
+await navigateTo({ url: '/pages/detail/index?id=1' });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|url|`string`|是|跳转的页面的路径，如 'path?key=value&key2=value2'|
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="redirectto"></a>
+### redirectTo()
+
+关闭当前页面，跳转到应用内的某个页面。
+
+## 代码示例
+
+```typescript
+import { redirectTo } from '@doubao-apps/framework/api';
+
+await redirectTo({ url: '/pages/result/index' });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|url|`string`|是|跳转的页面的路径，如 'path?key=value&key2=value2'|
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="relaunch"></a>
+### reLaunch()
+
+关闭所有页面并跳转到应用内页面。
+
+## 代码示例
+
+```typescript
+import { reLaunch } from '@doubao-apps/framework/api';
+
+await reLaunch({ url: '/pages/home/index' });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|url|`string`|是|跳转的页面的路径，如 'path?key=value&key2=value2'|
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="navigateback"></a>
+### navigateBack()
+
+关闭当前页面，返回上一页面或多级页面。
+
+## 代码示例
+
+```typescript
+import { navigateBack } from '@doubao-apps/framework/api';
+
+await navigateBack({ delta: 1 });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|delta|`number`|否|返回的页面数，如果 delta 大于现有页面数，则返回到页面栈中只剩一个页面为止。|
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="exitapp"></a>
+### exitApp()
+
+退出当前所有页面。
+
+## 代码示例
+
+```typescript
+import { exitApp } from '@doubao-apps/framework/api';
+
+await exitApp();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="close"></a>
+### close()
+
+关闭栈顶页面。
+
+## 代码示例
+
+```typescript
+import { close } from '@doubao-apps/framework/api';
+
+async function closeTopPage() {
+  try {
+    await close();
+  } catch (e) {
+    console.error('关闭页面失败', e);
+  }
+}
+
+closeTopPage();
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|containerID|`string`|否|指定一个要关闭的页面|
+
+## 返回值
+
+返回一个 Promise，在关闭操作成功发起时解析

package/dist/skills/doubao-apps-dev/references/reference/open-api/06-/344/272/244/344/272/222.md

@@ -0,0 +1,290 @@
+# Open API: 交互
+
+Toast、Loading、Modal、ActionSheet 和返回前提醒。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [showModal](#showmodal) | 显示模态对话框。 |
+| [showLoading](#showloading) | 显示 loading 提示框。 |
+| [hideToast](#hidetoast) | 隐藏当前 Toast。 |
+| [hideLoading](#hideloading) | 隐藏当前 loading。 |
+| [showActionSheet](#showactionsheet) | 显示操作菜单。 |
+| [getMenuButtonBoundingClientRect](#getmenubuttonboundingclientrect) | 获取菜单按钮的布局位置信息。 |
+| [enableAlertBeforeUnload](#enablealertbeforeunload) | 开启页面返回前提醒。 |
+| [disableAlertBeforeUnload](#disablealertbeforeunload) | 关闭页面返回前提醒。 |
+| [showToast](#showtoast) | 显示 Toast 提示。 |
+
+## API 详情
+
+<a id="showmodal"></a>
+### showModal()
+
+显示模态对话框。
+
+## 代码示例
+
+```ts
+import { showModal } from '@doubao-apps/framework/api';
+
+const result = await showModal({
+  title: '提示',
+  content: '确认删除这条记录吗？',
+  confirmText: '删除',
+  cancelText: '取消'
+});
+
+if (result.action === 'confirm') {
+  console.log('用户确认删除');
+}
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|cancelText|`string`|否|取消按钮的文字。|
+|confirmText|`string`|否|确认按钮的文字。|
+|content|`string`|是|模态对话框的内容。|
+|showCancel|`boolean`|否|是否显示取消按钮，默认 `true`。|
+|tapMaskToDismiss|`boolean`|否|是否允许点击蒙层关闭对话框，默认 `false`。|
+|title|`string`|否|模态对话框的标题。|
+
+## 返回值
+
+返回 `Promise<ShowModalResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|action|`"confirm" \| "cancel" \| "mask"`|用户点击的动作。|
+
+<a id="showloading"></a>
+### showLoading()
+
+显示 loading 提示框。
+
+## 代码示例
+
+```typescript
+import { hideLoading, showLoading } from '@doubao-apps/framework/api';
+
+await showLoading();
+await hideLoading();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="hidetoast"></a>
+### hideToast()
+
+隐藏当前 Toast。
+
+## 代码示例
+
+```typescript
+import { hideToast } from '@doubao-apps/framework/api';
+
+await hideToast();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="hideloading"></a>
+### hideLoading()
+
+隐藏当前 loading。
+
+## 代码示例
+
+```typescript
+import { hideLoading } from '@doubao-apps/framework/api';
+
+await hideLoading();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="showactionsheet"></a>
+### showActionSheet()
+
+显示操作菜单。
+
+## 代码示例
+
+```ts
+import { showActionSheet } from '@doubao-apps/framework/api';
+
+const result = await showActionSheet({
+  itemList: ['编辑', '删除']
+});
+
+console.log(result.tapIndex);
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|itemColor|`string`|否|按钮文字颜色。|
+|itemList|`string[]`|是|按钮文字数组。|
+|title|`string`|否|标题|
+
+## 返回值
+
+返回 `Promise<ShowActionSheetResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|tapIndex|`number`|用户点击的按钮序号，从 0 开始。|
+
+<a id="getmenubuttonboundingclientrect"></a>
+### getMenuButtonBoundingClientRect()
+
+获取菜单按钮的布局位置信息。
+
+## 代码示例
+
+```ts
+import { getMenuButtonBoundingClientRect } from '@doubao-apps/framework/api';
+
+const rect = getMenuButtonBoundingClientRect();
+
+console.log(rect.width, rect.height);
+console.log(rect.top, rect.right, rect.bottom, rect.left);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回菜单按钮相对屏幕左上角的坐标和尺寸，字段见 MenuButtonBoundingClientRect。
+
+|字段名|类型|说明|
+|---|---|---|
+|bottom|`number`|下边界坐标，单位 px。|
+|height|`number`|高度，单位 px。|
+|left|`number`|左边界坐标，单位 px。|
+|right|`number`|右边界坐标，单位 px。|
+|top|`number`|上边界坐标，单位 px。|
+|width|`number`|宽度，单位 px。|
+
+<a id="enablealertbeforeunload"></a>
+### enableAlertBeforeUnload()
+
+开启页面返回前提醒。
+当用户在小程序非最底层页面点击左上角返回按钮、左上角首页按钮或 Android 系统 back 键时,弹起询问弹窗
+
+返回询问对话框只会对调用的当前页面生效，通过手势滑动返回时不会弹起询问对话框
+
+## 代码示例
+
+```typescript
+import { enableAlertBeforeUnload } from '@doubao-apps/framework/api';
+
+await enableAlertBeforeUnload({ message: '确定离开当前页面吗？' });
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|message|`string`|是|返回前确认弹窗的文案。|
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="disablealertbeforeunload"></a>
+### disableAlertBeforeUnload()
+
+关闭页面返回前提醒。
+
+## 代码示例
+
+```typescript
+import { disableAlertBeforeUnload } from '@doubao-apps/framework/api';
+
+await disableAlertBeforeUnload();
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|params|`Record<string, never>`|否|-|
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="showtoast"></a>
+### showToast()
+
+显示 Toast 提示。
+
+参数 `options` 包含以下字段：
+- `message`: 提示的内容。
+- `type`: Toast 的类型，可选值为 'default'、'success'、'error' 或 'warning'。
+- `duration`: 提示的延迟时间，单位毫秒，默认为 2000。
+- `icon`: 图标，可选值为 'success', 'error', 'warn'。
+- `customIcon`: 自定义图标的 URL 或 base64 字符串。
+
+## 代码示例
+
+```typescript
+import { showToast } from '@doubao-apps/framework/api';
+
+// 显示一个成功的 Toast
+showToast({
+  message: '操作成功',
+  type: 'success',
+  icon: 'success',
+  duration: 1500
+}).then(() => {
+  console.log('Toast 显示完毕');
+});
+
+// 显示一个错误的 Toast
+showToast({
+  message: '网络错误',
+  type: 'error',
+  icon: 'error'
+});
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|customIcon|`string`|否|-|
+|duration|`number`|否|-|
+|icon|`"success" \| "error" \| "warn"`|否|-|
+|message|`string`|是|-|
+|type|`"default" \| "success" \| "error" \| "warning"`|否|-|
+
+## 返回值
+
+返回一个 Promise，在 Toast 显示结束时 resolve。