@doubao-apps/create 0.0.27 → 0.0.28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/dist/36.js +1 -1
  2. package/dist/cli.js +10 -10
  3. package/dist/template-empty/AGENTS.md +20 -20
  4. package/dist/template-empty/package.json +2 -2
  5. package/dist/template-empty/references/reference/open-api/01-/345/237/272/347/241/200-/350/264/246/345/217/267-/347/263/273/347/273/237.md +2943 -0
  6. package/dist/template-empty/references/reference/open-api/02-/350/267/257/347/224/261.md +63 -0
  7. package/dist/template-empty/{.ai/reference/open-api/05- → references/reference/open-api/03-}/347/225/214/351/235/242-/350/276/223/345/205/245.md +30 -0
  8. package/dist/template-empty/references/reference/open-api/04-/346/225/260/346/215/256/345/210/206/346/236/220.md +67 -0
  9. package/dist/{template-starter/.ai/reference/open-api/16-ui- → template-empty/references/reference/open-api/12-ui-}/350/276/223/345/205/245.md +0 -16
  10. package/dist/template-empty/references/reference/open-api/README.md +32 -0
  11. package/dist/template-empty/{.ai → references}/reference/open-api.md +420 -10
  12. package/dist/template-starter/AGENTS.md +20 -20
  13. package/dist/template-starter/README.md +48 -33
  14. package/dist/template-starter/package.json +2 -2
  15. package/dist/template-starter/references/reference/open-api/01-/345/237/272/347/241/200-/350/264/246/345/217/267-/347/263/273/347/273/237.md +2943 -0
  16. package/dist/template-starter/references/reference/open-api/02-/350/267/257/347/224/261.md +63 -0
  17. package/dist/template-starter/{.ai/reference/open-api/05- → references/reference/open-api/03-}/347/225/214/351/235/242-/350/276/223/345/205/245.md +30 -0
  18. package/dist/template-starter/references/reference/open-api/04-/346/225/260/346/215/256/345/210/206/346/236/220.md +67 -0
  19. package/dist/{template-empty/.ai/reference/open-api/16-ui- → template-starter/references/reference/open-api/12-ui-}/350/276/223/345/205/245.md +0 -16
  20. package/dist/template-starter/references/reference/open-api/README.md +32 -0
  21. package/dist/template-starter/{.ai → references}/reference/open-api.md +420 -10
  22. package/package.json +1 -1
  23. package/dist/template-empty/.ai/guides/system-prompt.md +0 -331
  24. package/dist/template-empty/.ai/reference/open-api/01-/345/237/272/347/241/200-/350/264/246/345/217/267-/347/263/273/347/273/237.md +0 -699
  25. package/dist/template-empty/.ai/reference/open-api/02-/345/255/230/345/202/250.md +0 -409
  26. package/dist/template-empty/.ai/reference/open-api/03-/350/267/257/347/224/261.md +0 -165
  27. package/dist/template-empty/.ai/reference/open-api/04-/347/225/214/351/235/242-/344/272/244/344/272/222.md +0 -432
  28. package/dist/template-empty/.ai/reference/open-api/06-/347/275/221/347/273/234.md +0 -148
  29. package/dist/template-empty/.ai/reference/open-api/07-/345/252/222/344/275/223.md +0 -346
  30. package/dist/template-empty/.ai/reference/open-api/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 +0 -546
  31. package/dist/template-empty/.ai/reference/open-api/README.md +0 -36
  32. package/dist/template-starter/.ai/guides/system-prompt.md +0 -331
  33. package/dist/template-starter/.ai/reference/open-api/01-/345/237/272/347/241/200-/350/264/246/345/217/267-/347/263/273/347/273/237.md +0 -699
  34. package/dist/template-starter/.ai/reference/open-api/02-/345/255/230/345/202/250.md +0 -409
  35. package/dist/template-starter/.ai/reference/open-api/03-/350/267/257/347/224/261.md +0 -165
  36. package/dist/template-starter/.ai/reference/open-api/04-/347/225/214/351/235/242-/344/272/244/344/272/222.md +0 -432
  37. package/dist/template-starter/.ai/reference/open-api/06-/347/275/221/347/273/234.md +0 -148
  38. package/dist/template-starter/.ai/reference/open-api/07-/345/252/222/344/275/223.md +0 -346
  39. package/dist/template-starter/.ai/reference/open-api/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 +0 -546
  40. package/dist/template-starter/.ai/reference/open-api/README.md +0 -36
  41. /package/dist/template-empty/{.ai → references}/examples/common-patterns.md +0 -0
  42. /package/dist/template-empty/{.ai → references}/examples/component-basics.md +0 -0
  43. /package/dist/template-empty/{.ai → references}/guides/best-practices.md +0 -0
  44. /package/dist/template-empty/{.ai → references}/guides/component-development.md +0 -0
  45. /package/dist/template-empty/{.ai → references}/guides/performance-optimization.md +0 -0
  46. /package/dist/template-empty/{.ai → references}/guides/troubleshooting.md +0 -0
  47. /package/dist/template-empty/{.ai → references}/reference/components-quick-ref.md +0 -0
  48. /package/dist/template-empty/{.ai → references}/reference/framework-api-quick-ref.md +0 -0
  49. /package/dist/template-empty/{.ai/reference/open-api/09- → references/reference/open-api/05-}/350/256/276/345/244/207-/350/223/235/347/211/231.md" +0 -0
  50. /package/dist/template-empty/{.ai/reference/open-api/10- → references/reference/open-api/06-}/350/256/276/345/244/207-wi-fi.md" +0 -0
  51. /package/dist/template-empty/{.ai/reference/open-api/11- → references/reference/open-api/07-}/350/256/276/345/244/207-/345/212/240/351/200/237/345/272/246/350/256/241.md" +0 -0
  52. /package/dist/template-empty/{.ai/reference/open-api/12- → references/reference/open-api/08-}/350/256/276/345/244/207-ibeacon.md" +0 -0
  53. /package/dist/template-empty/{.ai/reference/open-api/13- → references/reference/open-api/09-}/350/256/276/345/244/207-/347/275/227/347/233/230.md" +0 -0
  54. /package/dist/template-empty/{.ai/reference/open-api/14- → references/reference/open-api/10-}/350/256/276/345/244/207-/350/256/276/345/244/207/346/226/271/345/220/221.md" +0 -0
  55. /package/dist/template-empty/{.ai/reference/open-api/15- → references/reference/open-api/11-}/350/256/276/345/244/207-/351/231/200/350/236/272/344/273/252.md" +0 -0
  56. /package/dist/template-empty/{.ai/reference/open-api/17- → references/reference/open-api/13-}/350/256/276/345/244/207-/347/275/221/347/273/234.md" +0 -0
  57. /package/dist/template-empty/{.ai/reference/open-api/18- → references/reference/open-api/14-}/350/256/276/345/244/207-/347/237/255/344/277/241.md" +0 -0
  58. /package/dist/template-empty/{.ai/reference/open-api/19- → references/reference/open-api/15-}/350/256/276/345/244/207-/346/227/240/351/232/234/347/242/215.md" +0 -0
  59. /package/dist/template-empty/{.ai/reference/open-api/20- → references/reference/open-api/16-}/350/256/276/345/244/207-/347/224/265/346/261/240.md" +0 -0
  60. /package/dist/template-empty/{.ai/reference/open-api/21- → references/reference/open-api/17-}/350/256/276/345/244/207-/346/227/245/345/216/206.md" +0 -0
  61. /package/dist/template-empty/{.ai/reference/open-api/22- → references/reference/open-api/18-}/350/256/276/345/244/207-/345/211/252/350/264/264/346/235/277.md" +0 -0
  62. /package/dist/template-empty/{.ai/reference/open-api/23- → references/reference/open-api/19-}/350/256/276/345/244/207-/350/201/224/347/263/273/344/272/272.md" +0 -0
  63. /package/dist/template-empty/{.ai/reference/open-api/24- → references/reference/open-api/20-}/350/256/276/345/244/207-/345/212/240/345/257/206.md" +0 -0
  64. /package/dist/template-empty/{.ai/reference/open-api/25- → references/reference/open-api/21-}/350/256/276/345/244/207-/347/224/265/350/257/235.md" +0 -0
  65. /package/dist/template-empty/{.ai/reference/open-api/26- → references/reference/open-api/22-}/350/256/276/345/244/207-/346/211/253/347/240/201.md" +0 -0
  66. /package/dist/template-empty/{.ai/reference/open-api/27- → references/reference/open-api/23-}/350/256/276/345/244/207-/345/261/217/345/271/225.md" +0 -0
  67. /package/dist/template-empty/{.ai/reference/open-api/28- → references/reference/open-api/24-}/350/256/276/345/244/207-/351/234/207/345/212/250.md" +0 -0
  68. /package/dist/template-empty/{.ai → references}/rules/dos-and-donts.md +0 -0
  69. /package/dist/template-starter/{.ai → references}/examples/common-patterns.md +0 -0
  70. /package/dist/template-starter/{.ai → references}/examples/component-basics.md +0 -0
  71. /package/dist/template-starter/{.ai → references}/guides/best-practices.md +0 -0
  72. /package/dist/template-starter/{.ai → references}/guides/component-development.md +0 -0
  73. /package/dist/template-starter/{.ai → references}/guides/performance-optimization.md +0 -0
  74. /package/dist/template-starter/{.ai → references}/guides/troubleshooting.md +0 -0
  75. /package/dist/template-starter/{.ai → references}/reference/components-quick-ref.md +0 -0
  76. /package/dist/template-starter/{.ai → references}/reference/framework-api-quick-ref.md +0 -0
  77. /package/dist/template-starter/{.ai/reference/open-api/09- → references/reference/open-api/05-}/350/256/276/345/244/207-/350/223/235/347/211/231.md" +0 -0
  78. /package/dist/template-starter/{.ai/reference/open-api/10- → references/reference/open-api/06-}/350/256/276/345/244/207-wi-fi.md" +0 -0
  79. /package/dist/template-starter/{.ai/reference/open-api/11- → references/reference/open-api/07-}/350/256/276/345/244/207-/345/212/240/351/200/237/345/272/246/350/256/241.md" +0 -0
  80. /package/dist/template-starter/{.ai/reference/open-api/12- → references/reference/open-api/08-}/350/256/276/345/244/207-ibeacon.md" +0 -0
  81. /package/dist/template-starter/{.ai/reference/open-api/13- → references/reference/open-api/09-}/350/256/276/345/244/207-/347/275/227/347/233/230.md" +0 -0
  82. /package/dist/template-starter/{.ai/reference/open-api/14- → references/reference/open-api/10-}/350/256/276/345/244/207-/350/256/276/345/244/207/346/226/271/345/220/221.md" +0 -0
  83. /package/dist/template-starter/{.ai/reference/open-api/15- → references/reference/open-api/11-}/350/256/276/345/244/207-/351/231/200/350/236/272/344/273/252.md" +0 -0
  84. /package/dist/template-starter/{.ai/reference/open-api/17- → references/reference/open-api/13-}/350/256/276/345/244/207-/347/275/221/347/273/234.md" +0 -0
  85. /package/dist/template-starter/{.ai/reference/open-api/18- → references/reference/open-api/14-}/350/256/276/345/244/207-/347/237/255/344/277/241.md" +0 -0
  86. /package/dist/template-starter/{.ai/reference/open-api/19- → references/reference/open-api/15-}/350/256/276/345/244/207-/346/227/240/351/232/234/347/242/215.md" +0 -0
  87. /package/dist/template-starter/{.ai/reference/open-api/20- → references/reference/open-api/16-}/350/256/276/345/244/207-/347/224/265/346/261/240.md" +0 -0
  88. /package/dist/template-starter/{.ai/reference/open-api/21- → references/reference/open-api/17-}/350/256/276/345/244/207-/346/227/245/345/216/206.md" +0 -0
  89. /package/dist/template-starter/{.ai/reference/open-api/22- → references/reference/open-api/18-}/350/256/276/345/244/207-/345/211/252/350/264/264/346/235/277.md" +0 -0
  90. /package/dist/template-starter/{.ai/reference/open-api/23- → references/reference/open-api/19-}/350/256/276/345/244/207-/350/201/224/347/263/273/344/272/272.md" +0 -0
  91. /package/dist/template-starter/{.ai/reference/open-api/24- → references/reference/open-api/20-}/350/256/276/345/244/207-/345/212/240/345/257/206.md" +0 -0
  92. /package/dist/template-starter/{.ai/reference/open-api/25- → references/reference/open-api/21-}/350/256/276/345/244/207-/347/224/265/350/257/235.md" +0 -0
  93. /package/dist/template-starter/{.ai/reference/open-api/26- → references/reference/open-api/22-}/350/256/276/345/244/207-/346/211/253/347/240/201.md" +0 -0
  94. /package/dist/template-starter/{.ai/reference/open-api/27- → references/reference/open-api/23-}/350/256/276/345/244/207-/345/261/217/345/271/225.md" +0 -0
  95. /package/dist/template-starter/{.ai/reference/open-api/28- → references/reference/open-api/24-}/350/256/276/345/244/207-/351/234/207/345/212/250.md" +0 -0
  96. /package/dist/template-starter/{.ai → references}/rules/dos-and-donts.md +0 -0
@@ -0,0 +1,63 @@
1
+ # Open API: 路由
2
+
3
+ 应用内页面跳转和关闭。
4
+
5
+ [返回目录](./README.md) | [返回速查](../open-api.md)
6
+
7
+ ## 速查
8
+
9
+ | API | 说明 |
10
+ | --- | --- |
11
+ | [close](#close) | 关闭栈顶页面。<br><br>已废弃,使用 navigateBack。 |
12
+
13
+ ## API 详情
14
+
15
+ <a id="close"></a>
16
+ ### close()
17
+
18
+ > **close**(`params`?): `Promise`\<`object`\>
19
+
20
+ 关闭栈顶页面。
21
+
22
+ #### Parameters
23
+
24
+ • **params?**: [`CloseParams`](#closeparams)
25
+
26
+ #### Returns
27
+
28
+ `Promise`\<`object`\>
29
+
30
+ 返回一个 Promise,在关闭操作成功发起时解析
31
+
32
+ #### Deprecated
33
+
34
+ 使用 [navigateBack](#navigateback)
35
+
36
+ #### Example
37
+
38
+ ```typescript
39
+ import { close } from '@doubao-apps/framework/api';
40
+
41
+ async function closeTopPage() {
42
+ try {
43
+ await close();
44
+ } catch (e) {
45
+ console.error('关闭页面失败', e);
46
+ }
47
+ }
48
+
49
+ closePage();
50
+ ```
51
+
52
+ ## 相关类型
53
+
54
+ <a id="closeparams"></a>
55
+ ### CloseParams
56
+
57
+ #### Properties
58
+
59
+ ##### containerID?
60
+
61
+ > `optional` **containerID**: `string`
62
+
63
+ 指定一个要关闭的页面
@@ -8,10 +8,34 @@
8
8
 
9
9
  | API | 说明 |
10
10
  | --- | --- |
11
+ | [hideKeyboard](#hidekeyboard) | 收起当前键盘。 |
11
12
  | [onKeyboardHeightChange](#onkeyboardheightchange) | 监听键盘高度变化事件。<br><br>返回取消监听函数。 |
12
13
 
13
14
  ## API 详情
14
15
 
16
+ <a id="hidekeyboard"></a>
17
+ ### hideKeyboard()
18
+
19
+ > **hideKeyboard**(`params`?): `Promise`\<`object`\>
20
+
21
+ 收起当前键盘。
22
+
23
+ #### Parameters
24
+
25
+ • **params?**: [`HideKeyboardParam`](#hidekeyboardparam)
26
+
27
+ #### Returns
28
+
29
+ `Promise`\<`object`\>
30
+
31
+ #### Example
32
+
33
+ ```typescript
34
+ import { hideKeyboard } from '@doubao-apps/framework/api';
35
+
36
+ await hideKeyboard({});
37
+ ```
38
+
15
39
  <a id="onkeyboardheightchange"></a>
16
40
  ### onKeyboardHeightChange()
17
41
 
@@ -40,3 +64,9 @@ const unsubscribe = onKeyboardHeightChange(({ height }) => {
40
64
  console.log('Keyboard height change event:', { height });
41
65
  });
42
66
  ```
67
+
68
+ ## 相关类型
69
+
70
+ <a id="hidekeyboardparam"></a>
71
+ ### HideKeyboardParam
72
+
@@ -0,0 +1,67 @@
1
+ # Open API: 数据分析
2
+
3
+ 监控上报、事件和数据分析上报
4
+
5
+ [返回目录](./README.md) | [返回速查](../open-api.md)
6
+
7
+ ## 速查
8
+
9
+ | API | 说明 |
10
+ | --- | --- |
11
+ | [reportEvent](#reportevent) | 上报数据分析事件。 |
12
+
13
+ ## API 详情
14
+
15
+ <a id="reportevent"></a>
16
+ ### reportEvent()
17
+
18
+ > **reportEvent**(`params`): `Promise`\<`object`\>
19
+
20
+ 上报数据分析事件。
21
+
22
+ #### Parameters
23
+
24
+ • **params**: [`ReportEventParams`](#reporteventparams)
25
+
26
+ 数据分析事件上报参数。
27
+
28
+ #### Returns
29
+
30
+ `Promise`\<`object`\>
31
+
32
+ 返回一个 Promise,在事件上报请求成功发起时解析。
33
+
34
+ #### Example
35
+
36
+ ```typescript
37
+ import { reportEvent } from '@doubao-apps/framework/api';
38
+
39
+ await reportEvent({
40
+ eventName: 'page_view',
41
+ data: {
42
+ pageName: 'home',
43
+ source: 'feed'
44
+ }
45
+ });
46
+ ```
47
+
48
+ ## 相关类型
49
+
50
+ <a id="reporteventparams"></a>
51
+ ### ReportEventParams
52
+
53
+ 上报数据分析事件的请求参数。
54
+
55
+ #### Properties
56
+
57
+ ##### data
58
+
59
+ > **data**: `Record`\<`string`, `any`\>
60
+
61
+ 事件参数,会作为事件属性一并上报。
62
+
63
+ ##### eventName
64
+
65
+ > **eventName**: `string`
66
+
67
+ 事件名称。
@@ -8,26 +8,10 @@
8
8
 
9
9
  | API | 说明 |
10
10
  | --- | --- |
11
- | [hideKeyboard](#hidekeyboard) | 收起键盘。 |
12
11
  | [getSelectedTextRange](#getselectedtextrange) | 获取当前输入框的选区范围。 |
13
12
 
14
13
  ## API 详情
15
14
 
16
- <a id="hidekeyboard"></a>
17
- ### hideKeyboard()
18
-
19
- > **hideKeyboard**(`params`?): `Promise`\<`object`\>
20
-
21
- 收起键盘。
22
-
23
- #### Parameters
24
-
25
- • **params?**
26
-
27
- #### Returns
28
-
29
- `Promise`\<`object`\>
30
-
31
15
  <a id="getselectedtextrange"></a>
32
16
  ### getSelectedTextRange()
33
17
 
@@ -0,0 +1,32 @@
1
+ # Open API 目录
2
+
3
+ > 这里是系统能力 Open API 的分组目录。先用 [速查索引](../open-api.md) 找 API,再进入对应分组查看完整参数、返回值、示例和相关类型。
4
+
5
+ ## 分组
6
+
7
+ | 分组 | 说明 | API 数量 | 详细文档 |
8
+ | --- | --- | ---: | --- |
9
+ | 基础 / 账号 / 系统 | 账号、授权、宿主基础信息、窗口信息和定位。 | 57 | [查看](./01-基础-账号-系统.md) |
10
+ | 路由 | 应用内页面跳转和关闭。 | 1 | [查看](./02-路由.md) |
11
+ | 界面 / 输入 | 键盘和输入框选区能力。 | 2 | [查看](./03-界面-输入.md) |
12
+ | 数据分析 | 监控上报、事件和数据分析上报 | 1 | [查看](./04-数据分析.md) |
13
+ | 设备 / 蓝牙 | 蓝牙和 BLE 能力;通常先打开适配器,再扫描、连接和读写。 | 19 | [查看](./05-设备-蓝牙.md) |
14
+ | 设备 / Wi-Fi | Wi-Fi 模块能力;通常先 startWifi,再获取列表或连接。 | 6 | [查看](./06-设备-wi-fi.md) |
15
+ | 设备 / 加速度计 | 加速度计监听能力。 | 3 | [查看](./07-设备-加速度计.md) |
16
+ | 设备 / iBeacon | iBeacon 搜索和结果读取能力。 | 3 | [查看](./08-设备-ibeacon.md) |
17
+ | 设备 / 罗盘 | 罗盘监听能力。 | 3 | [查看](./09-设备-罗盘.md) |
18
+ | 设备 / 设备方向 | 设备方向监听能力。 | 2 | [查看](./10-设备-设备方向.md) |
19
+ | 设备 / 陀螺仪 | 陀螺仪监听能力。 | 3 | [查看](./11-设备-陀螺仪.md) |
20
+ | UI / 输入 | 键盘和输入框选区能力。 | 1 | [查看](./12-ui-输入.md) |
21
+ | 设备 / 网络 | 网络类型和本机局域网 IP。 | 3 | [查看](./13-设备-网络.md) |
22
+ | 设备 / 短信 | 拉起系统短信发送面板。 | 1 | [查看](./14-设备-短信.md) |
23
+ | 设备 / 无障碍 | 检测无障碍能力开关状态。 | 1 | [查看](./15-设备-无障碍.md) |
24
+ | 设备 / 电池 | 电池信息读取与变化监听。 | 2 | [查看](./16-设备-电池.md) |
25
+ | 设备 / 日历 | 向系统日历添加事件和重复事件。 | 2 | [查看](./17-设备-日历.md) |
26
+ | 设备 / 剪贴板 | 读取和设置系统剪贴板内容。 | 2 | [查看](./18-设备-剪贴板.md) |
27
+ | 设备 / 联系人 | 选择和添加手机联系人。 | 2 | [查看](./19-设备-联系人.md) |
28
+ | 设备 / 加密 | 安全随机数能力。 | 1 | [查看](./20-设备-加密.md) |
29
+ | 设备 / 电话 | 拨打电话。 | 1 | [查看](./21-设备-电话.md) |
30
+ | 设备 / 扫码 | 调起扫码并读取扫码结果。 | 1 | [查看](./22-设备-扫码.md) |
31
+ | 设备 / 屏幕 | 屏幕亮度、常亮和截屏/录屏相关能力。 | 5 | [查看](./23-设备-屏幕.md) |
32
+ | 设备 / 震动 | 触发短震动和长震动。 | 2 | [查看](./24-设备-震动.md) |