@amaster.ai/pi-lark 0.1.2-beta.41 → 0.1.2-beta.43

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 (92) hide show
  1. package/package.json +3 -3
  2. package/skills/lark-apps/SKILL.md +18 -10
  3. package/skills/lark-apps/references/lark-apps-access-scope-set.md +1 -1
  4. package/skills/lark-apps/references/lark-apps-automation.md +164 -0
  5. package/skills/lark-apps/references/lark-apps-db-execute.md +185 -1
  6. package/skills/lark-apps/references/lark-apps-db.md +1 -1
  7. package/skills/lark-apps/references/lark-apps-get.md +43 -0
  8. package/skills/lark-apps/references/lark-apps-html-publish.md +7 -2
  9. package/skills/lark-apps/references/lark-apps-init.md +1 -2
  10. package/skills/lark-apps/references/lark-apps-openapi-key.md +1 -1
  11. package/skills/lark-apps/references/lark-apps-release-create.md +3 -1
  12. package/skills/lark-apps/references/lark-apps-role.md +133 -0
  13. package/skills/lark-base/SKILL.md +2 -2
  14. package/skills/lark-base/references/dashboard-block-data-config.md +28 -2
  15. package/skills/lark-base/references/lark-base-cell-value.md +9 -4
  16. package/skills/lark-base/references/lark-base-dashboard-block-get-data.md +7 -7
  17. package/skills/lark-base/references/lark-base-dashboard.md +11 -2
  18. package/skills/lark-base/references/lark-base-data-query.md +9 -7
  19. package/skills/lark-base/references/lark-base-field-create.md +4 -2
  20. package/skills/lark-base/references/lark-base-field-json.md +52 -15
  21. package/skills/lark-base/references/lark-base-field-update.md +4 -2
  22. package/skills/lark-calendar/references/lark-calendar-create.md +1 -0
  23. package/skills/lark-doc/references/lark-doc-xml-extended-blocks.md +2 -1
  24. package/skills/lark-drive/SKILL.md +14 -6
  25. package/skills/lark-drive/references/lark-drive-comment-location.md +16 -4
  26. package/skills/lark-drive/references/lark-drive-comments-guide.md +16 -8
  27. package/skills/lark-drive/references/lark-drive-delete.md +23 -11
  28. package/skills/lark-drive/references/lark-drive-export.md +39 -10
  29. package/skills/lark-drive/references/lark-drive-list-comments.md +125 -0
  30. package/skills/lark-drive/references/lark-drive-member-add.md +1 -1
  31. package/skills/lark-drive/references/lark-drive-move.md +5 -3
  32. package/skills/lark-drive/references/lark-drive-pull.md +3 -3
  33. package/skills/lark-drive/references/lark-drive-push.md +1 -1
  34. package/skills/lark-drive/references/lark-drive-status.md +12 -14
  35. package/skills/lark-drive/references/lark-drive-task-result.md +58 -5
  36. package/skills/lark-im/SKILL.md +5 -4
  37. package/skills/lark-im/references/lark-im-messages-reply.md +1 -1
  38. package/skills/lark-im/references/lark-im-messages-send.md +1 -1
  39. package/skills/lark-minutes/SKILL.md +19 -4
  40. package/skills/lark-minutes/references/lark-minutes-todo.md +2 -2
  41. package/skills/lark-shared/SKILL.md +9 -9
  42. package/skills/lark-sheets/SKILL.md +98 -29
  43. package/skills/lark-sheets/references/lark-sheets-batch-update.md +18 -9
  44. package/skills/lark-sheets/references/lark-sheets-changeset.md +105 -0
  45. package/skills/lark-sheets/references/lark-sheets-chart.md +4 -2
  46. package/skills/lark-sheets/references/lark-sheets-conditional-format.md +2 -0
  47. package/skills/lark-sheets/references/lark-sheets-filter-view.md +1 -1
  48. package/skills/lark-sheets/references/lark-sheets-float-image.md +6 -6
  49. package/skills/lark-sheets/references/lark-sheets-formula-translation.md +12 -3
  50. package/skills/lark-sheets/references/lark-sheets-formula-verify.md +77 -0
  51. package/skills/lark-sheets/references/lark-sheets-history.md +93 -0
  52. package/skills/lark-sheets/references/lark-sheets-pivot-table.md +7 -2
  53. package/skills/lark-sheets/references/lark-sheets-range-operations.md +44 -14
  54. package/skills/lark-sheets/references/lark-sheets-read-data.md +3 -3
  55. package/skills/lark-sheets/references/lark-sheets-sheet-structure.md +4 -4
  56. package/skills/lark-sheets/references/lark-sheets-visual-standards.md +4 -4
  57. package/skills/lark-sheets/references/lark-sheets-workbook.md +29 -4
  58. package/skills/lark-sheets/references/lark-sheets-write-cells.md +21 -11
  59. package/skills/lark-slides/SKILL.md +29 -18
  60. package/skills/lark-slides/references/asset-planning.md +0 -1
  61. package/skills/lark-slides/references/examples.md +57 -227
  62. package/skills/lark-slides/references/iconpark.md +2 -2
  63. package/skills/lark-slides/references/lark-slides-create.md +21 -2
  64. package/skills/lark-slides/references/lark-slides-media-upload.md +0 -1
  65. package/skills/lark-slides/references/lark-slides-pptx-template-workflows.md +89 -0
  66. package/skills/lark-slides/references/lark-slides-replace-pages.md +1 -1
  67. package/skills/lark-slides/references/lark-slides-replace-slide.md +1 -1
  68. package/skills/lark-slides/references/lark-slides-screenshot.md +11 -8
  69. package/skills/lark-slides/references/lark-slides-xml-get.md +100 -0
  70. package/skills/lark-slides/references/lark-slides-xml-presentation-slide-delete.md +9 -7
  71. package/skills/lark-slides/references/lark-slides-xml-presentation-slide-get.md +4 -4
  72. package/skills/lark-slides/references/lark-slides-xml-presentation-slide-replace.md +12 -10
  73. package/skills/lark-slides/references/lark-slides-xml-presentations-get.md +14 -13
  74. package/skills/lark-slides/references/planning-layer.md +1 -1
  75. package/skills/lark-slides/references/slides_xml_schema_definition.xml +7 -2
  76. package/skills/lark-slides/references/troubleshooting.md +7 -25
  77. package/skills/lark-slides/references/validation-checklist.md +18 -9
  78. package/skills/lark-slides/references/visual-planning.md +4 -3
  79. package/skills/lark-slides/references/xml-format-guide.md +20 -0
  80. package/skills/lark-slides/references/xml-schema-quick-ref.md +6 -2
  81. package/skills/lark-slides/scripts/xml_text_overlap_lint.py +647 -52
  82. package/skills/lark-slides/scripts/xml_text_overlap_lint_test.py +529 -0
  83. package/skills/lark-task/SKILL.md +1 -0
  84. package/skills/lark-vc-agent/SKILL.md +11 -4
  85. package/skills/lark-vc-agent/references/lark-vc-agent-meeting-events.md +1 -1
  86. package/skills/lark-vc-agent/references/lark-vc-agent-meeting-leave.md +1 -1
  87. package/skills/lark-vc-agent/references/lark-vc-agent-meeting-list-active.md +2 -2
  88. package/skills/lark-wiki/SKILL.md +4 -2
  89. package/skills/lark-wiki/references/lark-wiki-move-to-drive.md +122 -0
  90. package/skills/lark-wiki/references/lark-wiki-move.md +5 -3
  91. package/skills/lark-sheets/references/lark-sheets-core-operations.md +0 -103
  92. package/skills/lark-slides/references/lark-slides-xml-presentation-slide-create.md +0 -220
@@ -0,0 +1,133 @@
1
+ # apps role 域命令(应用角色)
2
+
3
+ 管理妙搭应用内的平台角色、角色成员,以及查询某个用户命中的角色。运行时命令事实以 `lark-cli apps +<cmd> --help` 为准;身份、授权和高风险确认遵循本域 [`SKILL.md`](../SKILL.md)。
4
+
5
+ ## 何时用
6
+
7
+ 用户要列出、查看、创建、更新或删除某个妙搭应用内的平台角色,管理角色的用户、部门或群成员,或查询某个用户在应用中命中的角色时使用。多维表格 / Base 的角色与权限走 `lark-base`;设置谁能访问应用走 `+access-scope-*`,不要路由到本命令域。
8
+
9
+ ## 命令一览
10
+
11
+ | 命令 | 做什么 | 关键参数 |
12
+ |---|---|---|
13
+ | `+role-list` | 分页列出角色,或按名称筛选角色 | `--app-id`、`--name`、`--page-size`/`--page-token` |
14
+ | `+role-get` | 根据真实 `role_id` 读取角色详情 | `--app-id`、`--role-id` |
15
+ | `+role-match-list` | 查询指定用户命中的角色 | `--app-id`、`--user-id` |
16
+ | `+role-create` | 创建角色 | `--app-id`、`--name`、`--description`、`--role-id` |
17
+ | `+role-update` | 更新角色名称或描述 | `--app-id`、`--role-id`、`--name`/`--description` |
18
+ | `+role-delete` | 永久删除角色 | `--app-id`、`--role-id`、`--yes` |
19
+ | `+role-member-list` | 查询角色的用户、部门和群成员 | `--app-id`、`--role-id`、`--member-type` |
20
+ | `+role-member-add` | 向角色添加用户、部门或群成员 | `--app-id`、`--role-id`、`--users`/`--departments`/`--chats` |
21
+ | `+role-member-remove` | 定向移除或清空角色成员 | `--app-id`、`--role-id`、成员参数或 `--all`、`--yes` |
22
+
23
+ ## 约定(先读)
24
+
25
+ - `app_...` 标识的是妙搭应用,其角色和成员只使用 `apps +role-*` / `apps +role-member-*`;不要改走 Base 角色命令或裸 bitable API。
26
+ - 角色名称不是 `role_id`。只有名称时优先用 `+role-list --name` 精确解析;若已取得完整分页列表,也可从中证明精确名称唯一命中。0 条如实报告,多条让用户消歧,唯一命中后才使用返回的真实 ID。
27
+ - `+role-list` 返回 `has_more=true` 时,用本页 `page_token` 继续查询,直到 `has_more=false`;不要根据 `total` 补造条目。
28
+ - `+role-list`、`+role-get`、`+role-match-list` 的角色数据分别位于 `data.items`、`data.role`、`data.roles`,不要混用。
29
+ - 同一角色的写入及依赖该写入结果的操作必须串行。不同角色的独立操作只有在每次写入可单独追溯、失败不影响其它目标且分别验收时才可并行;否则保持串行。互不依赖的名称解析或只读查询可并行。
30
+
31
+ ## 各命令
32
+
33
+ ### 查询角色
34
+
35
+ ```bash
36
+ lark-cli apps +role-list --app-id <app_id> --page-size 100
37
+ lark-cli apps +role-list --app-id <app_id> --name '<exact_name>'
38
+ lark-cli apps +role-get --app-id <app_id> --role-id <role_id>
39
+ lark-cli apps +role-match-list --app-id <app_id> --user-id <ou_x>
40
+ ```
41
+
42
+ 整理角色列表时保留 `role_id`、`name` 和 `description`。不要猜测未知 `role_id`,也不要从同名候选中静默选择。
43
+ `items=[]` 时直接报告当前没有角色;不要为表格补造“无”或 `N/A` 占位行。
44
+ `+role-match-list --user-id` 只接受 `ou_...`;用户给的是姓名、邮箱或手机号时,先解析唯一 open ID,再查询命中角色。
45
+
46
+ ### 创建与更新
47
+
48
+ ```bash
49
+ lark-cli apps +role-create --app-id <app_id> --name '<name>' \
50
+ --description '<description>'
51
+
52
+ # 只修改名称
53
+ lark-cli apps +role-update --app-id <app_id> --role-id <role_id> \
54
+ --name '<new_name>' --as user --format json
55
+
56
+ # 只修改描述
57
+ lark-cli apps +role-update --app-id <app_id> --role-id <role_id> \
58
+ --description '<new_description>' --as user --format json
59
+ ```
60
+
61
+ - `--description` 和创建时的 `--role-id` 可选;仅在确实需要稳定 ID 时传 `--role-id`,创建后不能修改。
62
+ - 更新时只传用户明确要求变更的字段。
63
+ - 成功响应中的角色位于 `data.role`。只有用户要求独立验证,或结果将用于后续高风险操作时,才额外执行 `+role-get`。
64
+
65
+ ### 删除角色
66
+
67
+ 普通“删除某角色”请求只说明目标,**不等于不可逆确认**。如果用户尚未明确确认删除后果,本轮只能定位角色、读取完整成员并说明影响,最后请求确认;不得在同一轮自动追加 `--yes`。用户已明确确认不可逆删除时才继续。
68
+
69
+ 只有名称时仍按上述规则唯一解析,优先使用 `+role-list --name`。目标写前已不存在时立即停止,如实说明本次是 no-op、没有执行删除,不能把“当前不存在”表述为“删除成功”。
70
+
71
+ 删除前读取准确角色和完整成员范围,向用户说明 app、role、`users` / `departments` / `chats` 影响;得到不可逆删除确认后才使用 `--yes`:
72
+
73
+ ```bash
74
+ lark-cli apps +role-get --app-id <app_id> --role-id <role_id>
75
+ lark-cli apps +role-member-list --app-id <app_id> --role-id <role_id>
76
+ lark-cli apps +role-delete --app-id <app_id> --role-id <role_id> --yes
77
+ ```
78
+
79
+ 成功响应包含匹配的 `data.role_id` 和 `data.deleted=true`。只有用户明确要求独立验证删除结果时,才再用 `+role-list --name` 检查目标 ID 已不存在。
80
+
81
+ ### 成员 ID 解析
82
+
83
+ 成员 flags 只接受 open ID:用户 `ou_...`、部门 `od-...`、群 `oc_...`。用户已提供对应类型的合法 open ID 时直接使用;只有名称或邮箱时才解析。
84
+ 对象类型以用户语义为准,不能互换解析器:用户走通讯录用户搜索,部门走部门搜索,群走群搜索。
85
+
86
+ ```bash
87
+ # 用户:每个姓名或邮箱单独查询。
88
+ lark-cli contact +search-user --query '<姓名或邮箱>' \
89
+ --exclude-external-users --page-size 30
90
+
91
+ # 部门:拉完分页,只接受唯一的 open_department_id。
92
+ lark-cli api POST /open-apis/contact/v3/departments/search \
93
+ --params '{"user_id_type":"open_id","department_id_type":"open_department_id","page_size":50}' \
94
+ --data '{"query":"<部门名称>"}'
95
+
96
+ # 群:拉完分页,只接受名称精确匹配的唯一 chat_id。
97
+ lark-cli im +chat-search --query '<群名称>' --page-size 50
98
+ ```
99
+
100
+ - 只接受与输入姓名、邮箱或群名精确匹配的唯一结果;部门搜索只接受完整 query 的唯一 `od-...`。0 条、多条或分页未完成时停止写入并让用户补充或消歧。
101
+ - 多个对象逐个解析。全部解析成功且总数不超过 100 后,按类型放入一次成员写入;任一对象失败时不要部分写入,也不要自动拆批。
102
+
103
+ ### 成员操作
104
+
105
+ ```bash
106
+ # 省略 --member-type,返回完整 users / departments / chats。
107
+ lark-cli apps +role-member-list --app-id <app_id> --role-id <role_id>
108
+
109
+ lark-cli apps +role-member-add --app-id <app_id> --role-id <role_id> \
110
+ --users ou_x,ou_y --departments od-x --chats oc_x
111
+
112
+ lark-cli apps +role-member-remove --app-id <app_id> --role-id <role_id> \
113
+ --users ou_x --yes
114
+
115
+ # 清空成员,不删除角色。
116
+ lark-cli apps +role-member-remove --app-id <app_id> --role-id <role_id> \
117
+ --all --yes
118
+ ```
119
+
120
+ - `+role-member-list` 不分页;`--member-type` 只返回选中类型的字段,未返回的成员字段表示“未查询”而不是空。影响确认或完整比较时必须省略它。
121
+ - 汇总 `--member-type` 结果时明确这是过滤投影,不得据此断言角色没有其它类型成员。
122
+ - 用户要求 CLI 原生 table 时,直接执行 `+role-member-list --format table`;可原样转发或做事实摘要,不要先取 JSON 再手工重建一张替代表格。
123
+ - 写入和依赖其结果的回读不得放进同一个并发批次;必须等待写入完整返回成功后,再单独发起回读。误并发时只能以写入完成后的新回读作为结果证据。
124
+ - 添加前仅在用户要求独立证明或确认其他成员类型未变化时读取完整基线,并在写后完整回读;否则成功响应即可作为结果。
125
+ - 定向移除前确认准确成员及影响。若需要证明结果,写后完整回读;不要把过滤结果当作完整成员集合。
126
+ - `--all` 前读取完整成员范围并确认;成功后执行一次无过滤 `+role-member-list`,确认三个成员数组均为空。
127
+
128
+ ## 权限
129
+
130
+ | 操作 | 所需 scope |
131
+ |---|---|
132
+ | list / get / member-list / match-list | `spark:app:read` |
133
+ | create / update / delete / member-add / member-remove | `spark:app:write` |
@@ -85,7 +85,7 @@ metadata:
85
85
  ## 身份与权限降级
86
86
 
87
87
  - 默认显式使用 `--as user` 操作用户资源;只有用户明确要求应用身份时,才直接用 `--as bot`。
88
- - user 身份报 scope/授权不足,或错误中包含 `permission_violations` / `hint`,先转 `lark-shared` 做用户授权恢复,不要直接降级 bot。
88
+ - user 身份报 scope/授权不足,或错误中包含 `missing_scopes` / `hint`,先转 `lark-shared` 做用户授权恢复,不要直接降级 bot。
89
89
  - user 身份报资源级无访问且无授权恢复提示时,才可用 `--as bot` 重试一次;bot 仍失败就停止重试并按权限错误处理。
90
90
  - `91403` 或明确不可访问错误不要循环换身份重试。
91
91
  - `+base-create` / `+base-copy` 若用 bot 身份执行,关注返回中的 `permission_grant`,并把用户是否可打开新 Base 告知用户。
@@ -122,7 +122,7 @@ metadata:
122
122
 
123
123
  ## Dashboard / Workflow / Role
124
124
 
125
- - Dashboard 的复杂点是 block 的 `data_config`,不是 list/get/create/delete 命令参数。创建或更新 block 前先读 [dashboard-block-data-config.md](references/dashboard-block-data-config.md),组件必须串行创建;`+dashboard-arrange` 是服务端智能布局,只在用户明确要求重排/美化时执行。`+dashboard-block-get-data` 读取图表最终计算结果,不返回 block 名称、类型、布局或 `data_config`;需要元数据先用 `+dashboard-block-get`。
125
+ - Dashboard 的复杂点是 block 的 `data_config`,不是 list/get/create/delete 命令参数。创建或更新 block 前先读 [dashboard-block-data-config.md](references/dashboard-block-data-config.md),组件必须串行创建;`+dashboard-arrange` 是服务端智能布局,仅在用户明确要求重排/美化、或对本次会话从零新建的仪表盘做收尾整理时执行。`+dashboard-block-get-data` 读取图表最终计算结果,不返回 block 名称、类型、布局或 `data_config`;需要元数据先用 `+dashboard-block-get`。
126
126
  - Workflow 的复杂点是 `steps` 结构。创建、更新或解释完整 workflow 时读入口 [lark-base-workflow-guide.md](references/lark-base-workflow-guide.md) 和 steps JSON SSOT [lark-base-workflow-schema.md](references/lark-base-workflow-schema.md);enable/disable/list 只需确认 workflow ID、当前启停状态和用户意图。
127
127
  - Role 的复杂点是权限 JSON。角色操作先读入口 [lark-base-role-guide.md](references/lark-base-role-guide.md);`+role-create` 只支持自定义角色;`+role-update` 是 delta merge;角色 create/update 或解读完整配置时读权限 JSON SSOT [role-config.md](references/role-config.md)。`+role-delete` 只适用于自定义角色,系统角色不可删除;删除角色和关闭高级权限前必须确认目标和影响。
128
128
 
@@ -90,6 +90,10 @@ user / created_by / updated_by: is, isNot, isEmpty, isNotEmpty
90
90
 
91
91
  `sort.order`:`asc`(升序)/ `desc`(降序)
92
92
 
93
+ 只要写 `sort` 对象,就需要明确排序方向。CLI 会把 `sort.type` 为 `group` 或 `view` 且缺少 `order` 的情况规范化为 `order:"asc"`;`sort.type:"value"` 必须显式写 `order:"asc"` 或 `order:"desc"`,因为指标值排序方向会改变业务含义。
94
+
95
+ 如果表中行序就是业务顺序,首次创建 block 时就一次性设置 `sort:{"type":"view","order":"asc"}` 保留行序,避免创建后再二次更新排序条件。
96
+
93
97
  示例 — 柱状图按销售额降序:
94
98
 
95
99
  ```json
@@ -169,9 +173,10 @@ user / created_by / updated_by: is, isNot, isEmpty, isNotEmpty
169
173
  - 长度/结构
170
174
  - `group_by` 最多 2 个;每项 `field_name` 必填
171
175
  - `group_by[].sort.type` 取值 `group|value|view`;`order` 取值 `asc|desc`
172
- - 规范化(CLI 自动处理)
176
+ - 规范化(CLI 自动处理;`--no-validate` 时不生效,`data_config` 原样透传给后端)
173
177
  - `series[].rollup` 自动转成大写(如 `sum` → `SUM`)
174
178
  - `group_by[].sort.type/order` 自动转成小写
179
+ - `group_by[].sort.type` 为 `group` 或 `view` 且缺少 `order` 时,自动补 `order:"asc"`;`value` 排序不会自动补方向
175
180
  - 本地校验(可通过 `--no-validate` 跳过)
176
181
  - `+dashboard-block-create` 默认对 `data_config` 做轻量校验;失败会聚合错误并给出修复建议
177
182
  - `+dashboard-block-update` 不做强类型校验,由后端验证具体字段
@@ -264,14 +269,35 @@ user / created_by / updated_by: is, isNot, isEmpty, isNotEmpty
264
269
 
265
270
  漏斗图(流程转化):
266
271
 
272
+ 先判断用户要看的数值语义:
273
+
274
+ - **当前数量**:统计每个当前状态/阶段下有多少记录,例如“各环节当前数量”“当前阶段分布”。源表有状态/阶段字段时,直接用 `count_all:true` + `group_by`。
275
+ - **累计数量**:统计到达该阶段及其后续阶段(后缀和)的累计数量,例如“流程转化”“从 A 到 B 各环节转化”。此口径假设流程单向、无跳阶/回退、记录不删除;不满足时须用状态变更历史,不能对当前快照累加。如果表中已有累计数量字段或阶段汇总表,直接用该字段画漏斗图;否则先计算累计数量,创建并写入 helper 汇总表后再画图。
276
+
277
+ 当前数量:
278
+
267
279
  ```json
268
280
  {
269
281
  "table_name": "表名",
270
- "series": [{ "field_name": "数值字段", "rollup": "SUM" }],
282
+ "count_all": true,
271
283
  "group_by": [{ "field_name": "状态字段", "mode": "integrated" }]
272
284
  }
273
285
  ```
274
286
 
287
+ 累计数量:
288
+
289
+ ```json
290
+ {
291
+ "table_name": "流程汇总表名",
292
+ "series": [{ "field_name": "累计数量", "rollup": "SUM" }],
293
+ "group_by": [{ "field_name": "阶段字段", "mode": "integrated", "sort": {"type":"view","order":"asc"} }]
294
+ }
295
+ ```
296
+
297
+ 如果只有当前状态数据但用户要看流程转化,需要先按业务阶段顺序计算每个阶段的累计数量,再创建 helper 汇总表(如:阶段、累计数量),用 `+record-batch-create` 一次写入后,按“累计数量”模板创建漏斗图。helper 表行序就是业务顺序时,首次创建 block 时一次性设置好 `group_by.sort`。
298
+
299
+ > ⚠️ 注意:helper 汇总表仅用于源表无法直接聚合出目标形态的场景(如上面的累计数量漏斗图)。只要能在源表上直接用 `group_by` + `rollup`(含 `AVERAGE`)算出,就不需要新建 helper 表。
300
+
275
301
  词云(文本频率):
276
302
 
277
303
  ```json
@@ -16,15 +16,20 @@
16
16
 
17
17
  ## 2. 各类型 CellValue
18
18
 
19
- ### 2.1 text / phone / url
19
+ ### 2.1 text
20
20
 
21
- 用字符串。URL 字段也传 URL 字符串;普通文本里可以保留 Markdown 风格链接文本,平台会按字段类型处理。
21
+ text 字段的 `style.type` 影响单元格检查逻辑:
22
+ `type=plain` 传 Markdown 格式的字符串。
23
+ `type=url` 传一个带 title 的 Markdown 格式链接,或单独传一个链接。
24
+ `type=phone` 传合法电话号码。
25
+ `type=email` 传合法邮箱字符串。
22
26
 
23
27
  ```json
24
28
  {
25
- "标题": "Hello",
29
+ "标题": "Hello, [lark-cli](https://github.com/larksuite/cli)",
30
+ "官网": "[官网](https://example.com)",
26
31
  "联系电话": "1380000000000",
27
- "官网": "https://example.com"
32
+ "邮箱": "owner@example.com"
28
33
  }
29
34
  ```
30
35
 
@@ -98,21 +98,21 @@ lark-cli base +dashboard-block-get \
98
98
 
99
99
  ## 返回结构总览
100
100
 
101
- 服务端响应外层仍然是标准 OpenAPI 包装:
101
+ CLI 成功输出使用标准 `{ok, identity, data}` 信封:
102
102
 
103
103
  ```json
104
104
  {
105
- "code": 0,
106
- "msg": "success",
105
+ "ok": true,
106
+ "identity": "user",
107
107
  "data": {
108
- "dimensions": [...],
109
- "measures": [...],
110
- "main_data": [...]
108
+ "dimensions": [],
109
+ "measures": [],
110
+ "main_data": []
111
111
  }
112
112
  }
113
113
  ```
114
114
 
115
- 其中 `data` 就是 CLI 图表协议本体。不同图表类型的 `data` 结构略有不同:
115
+ 其中 `identity` 是本次调用实际使用的身份,`data` 是 CLI 图表协议本体。不同图表类型的 `data` 结构略有不同:
116
116
 
117
117
  | 图表类型 | 一定有 | 可能有 |
118
118
  |----------|--------|--------|
@@ -19,12 +19,19 @@ Dashboard 是 Base 中的数据可视化看板,可以把表格数据变成**
19
19
  | 修改组件 | `+dashboard-block-update` | 先读 block 现状,再读 [dashboard-block-data-config.md](dashboard-block-data-config.md) 决定替换哪些顶层 key |
20
20
  | 查看仪表盘有哪些组件 | `+dashboard-get` 或 `+dashboard-block-list` | 本页下方「查看仪表盘」 |
21
21
  | 读取图表计算结果 | `+dashboard-block-get-data` | 返回图表最终数据协议;需要 block 元数据先用 `+dashboard-block-get` |
22
- | 智能重排组件布局 | `+dashboard-arrange` | 只在用户明确要求重排时执行;无法指定精确位置 |
22
+ | 智能重排组件布局 | `+dashboard-arrange` | 用户明确要求重排,或本次会话新建仪表盘的收尾整理;无法指定精确位置 |
23
23
 
24
24
  ## 典型场景工作流
25
25
 
26
26
  ### 场景 1:从 0 到 1 创建仪表盘
27
27
 
28
+ 从 0 到 1 创建仪表盘时,按用户需求规划组件的类型和数量,并注意以下要点:
29
+
30
+ - 聚合方式:创建指标卡或分布图时优先把聚合写进 `data_config`,只有 Top N、字段取值探索、复杂筛选校验或 helper 汇总表场景才先用 `+data-query`。
31
+ - Dry-run 边界:已按模板构造的简单指标卡、分布图、趋势图不需要逐个 `--dry-run` 后再真实创建;只有在调试 JSON、检查请求体、复杂自造 `data_config` 或处理 API validation 错误时才 dry-run。
32
+ - 验证方式:通过创建接口返回值确认创建成功与否,只在结果不确定时用 `+dashboard-get` 或 `+dashboard-block-list` 确认仪表盘和组件存在,或调用 `+dashboard-block-get-data`读取计算结果验证。
33
+ - 布局方式:`+dashboard-arrange` 仅两种情况使用:① 用户明确要求美化/重排;② 本次会话中从零新建的仪表盘,建完组件后做一次性布局整理。不是创建成功的必要步骤。
34
+
28
35
  示例:搭建一个销售数据分析仪表盘
29
36
 
30
37
  ```bash
@@ -63,6 +70,7 @@ lark-cli base +dashboard-block-create \
63
70
 
64
71
  # 第 5 步:组件创建完成后,使用 arrange 命令智能重排布局(可选但推荐)
65
72
  # 默认布局可能不够美观,arrange 会根据组件数量和类型自动优化布局
73
+ # 若用户没有要求美化/重排,可先跳过此步骤;这不影响仪表盘和组件是否已创建成功
66
74
  lark-cli base +dashboard-arrange \
67
75
  --base-token xxx \
68
76
  --dashboard-id blk_xxx
@@ -125,11 +133,12 @@ lark-cli base +dashboard-block-update \
125
133
  --dashboard-id blk_xxx \
126
134
  --block-id chtxxxxxxxx \
127
135
  --data-config '{...}'
136
+
128
137
  ```
129
138
 
130
139
  ### 场景 4:重排仪表盘布局
131
140
 
132
- 当用户明确要求对已有仪表盘进行布局重排或美化时使用。
141
+ 当用户明确要求对已有仪表盘进行布局重排或美化时使用(对本次会话从零新建的仪表盘,可在建完组件后直接做一次性整理,见场景 1)。
133
142
 
134
143
  > [!CAUTION]
135
144
  > - 排列结果是**服务端智能推荐**,不一定完全符合用户预期
@@ -347,28 +347,30 @@ value 使用预定义关键字机制,第一个元素为字符串常量名称
347
347
  |------|------|------|------|
348
348
  | `format` | string | 是 | 固定为 `"flat"`,表示返回扁平化的对象数组 |
349
349
 
350
- ## API 出参详情
350
+ ## CLI 出参详情
351
+
352
+ CLI 输出标准信封 `{ok, identity, data}`(失败时为 `{ok:false, identity, error}`)。
351
353
 
352
354
  **成功时:**
353
355
 
354
356
  ```json
355
- {"code": 0, "data": {"main_data": [{"dim_city": {"value": "北京"}, "total_amount": {"value": 12345.00}}, ...]}, "msg": ""}
357
+ {"ok": true, "identity": "user", "data": {"main_data": [{"dim_city": {"value": "北京"}, "total_amount": {"value": 12345.00}}, ...]}}
356
358
  ```
357
359
 
358
360
  **失败时:**
359
361
 
360
362
  ```json
361
- {"code": 800004006, "data": {"error": {"code": 800004006, ...}}, "msg": "DSL validation failed"}
363
+ {"ok": false, "identity": "user", "error": {"type": "api", "subtype": "unknown", "code": 800004006, "message": "...does not exist in table schema", "hint": "...", "log_id": "..."}}
362
364
  ```
363
365
 
364
366
  **Response 字段:**
365
367
 
366
368
  | 字段 | 类型 | 说明 |
367
369
  |------|------|------|
368
- | `code` | int | 状态码,0 为成功 |
369
- | `msg` | string | 错误信息 |
370
- | `data.main_data` | []object | 查询结果数组,每个元素为一行数据 |
371
- | `data.error` | object | 失败时的错误详情 |
370
+ | `ok` | bool | 是否成功 |
371
+ | `identity` | string | 执行身份:`user` / `bot` |
372
+ | `data.main_data` | []object | 查询结果数组,每个元素为一行数据(成功时) |
373
+ | `error` | object | 失败时的 typed 错误,含 `type` / `subtype` / `code` / `message` / `hint` / `log_id` |
372
374
 
373
375
  每行数据的字段值封装在 CellValue 中:
374
376
 
@@ -23,12 +23,12 @@ lark-cli base +field-create \
23
23
  lark-cli base +field-create \
24
24
  --base-token <base_token> \
25
25
  --table-id <table_id> \
26
- --json '{"name":"状态","type":"select","multiple":false,"options":[{"name":"Todo","hue":"Blue","lightness":"Lighter"},{"name":"Done","hue":"Green","lightness":"Light"}]}'
26
+ --json '{"name":"状态","type":"select","multiple":false,"default_value":["Todo"],"options":[{"name":"Todo","hue":"Blue","lightness":"Lighter"},{"name":"Done","hue":"Green","lightness":"Light"}]}'
27
27
 
28
28
  lark-cli base +field-create \
29
29
  --base-token <base_token> \
30
30
  --table-id <table_id> \
31
- --json '{"name":"负责人","type":"user","multiple":false,"description":"用于标记记录的直接负责人;协作约定可参考[团队字段约定](https://example.com/field-spec)"}'
31
+ --json '{"name":"负责人","type":"user","multiple":false,"default_value":[{"$slot":"current_user"}],"description":"用于标记记录的直接负责人;协作约定可参考[团队字段约定](https://example.com/field-spec)"}'
32
32
  ```
33
33
 
34
34
  ## 参数
@@ -51,6 +51,7 @@ POST /open-apis/base/v3/bases/:base_token/tables/:table_id/fields
51
51
  - `--json` 必须是 **JSON 对象**,顶层直接传字段定义,不要再套一层。
52
52
  - 顶层最少包含:`name`、`type`。
53
53
  - 所有字段类型都支持可选 `description`;支持纯文本,也支持 Markdown 链接,如 `协作约定可参考[团队字段约定](https://example.com/field-spec)`。
54
+ - 需要字段默认值时传 `default_value`,直接使用字段对应 CellValue;`datetime` / `user` 的动态填充用 `$slot`。完整规则见 [lark-base-field-json.md](lark-base-field-json.md)。
54
55
  - `type` 不同,必填子字段不同:
55
56
  - `select`:`multiple` 控制是否多选,`options` 定义静态选项,`dynamic_options_source` 定义动态选项来源。静态与动态选项配置二选一,不能同时传。
56
57
  - `link`:必须有 `link_table`,可选 `bidirectional`、`bidirectional_link_field_name`。
@@ -64,6 +65,7 @@ POST /open-apis/base/v3/bases/:base_token/tables/:table_id/fields
64
65
  "name": "状态",
65
66
  "type": "select",
66
67
  "multiple": false,
68
+ "default_value": ["Todo"],
67
69
  "options": [
68
70
  { "name": "Todo", "hue": "Blue", "lightness": "Lighter" },
69
71
  { "name": "Done", "hue": "Green", "lightness": "Light" }
@@ -9,6 +9,7 @@
9
9
  - `--json` 必须是 JSON 对象。
10
10
  - 顶层统一使用:`type` + `name` + 类型特有字段。
11
11
  - 所有字段类型都支持可选 `description`;支持纯文本,也支持 Markdown 链接。
12
+ - 字段默认值使用 `default_value`,直接传对应 CellValue;支持范围只有 `text`、`number`、静态 `select`、`datetime`、`user`。清空默认值传 `null`;省略表示创建时不设置、更新时不修改。
12
13
  - 不要使用旧结构:`field_name`、`property`、`ui_type`、数字枚举 `type`。
13
14
  - `+field-update` 使用同样的字段 JSON 结构,但语义是 `PUT`;这是高风险写入操作,建议先 `+field-get` 再按目标状态全量提交,并带 `--yes`。
14
15
  - `type=formula` 或 `type=lookup` 创建/更新前,必须先读对应 guide。
@@ -27,12 +28,12 @@
27
28
 
28
29
  | 类型 | 最小必填字段 | 常见补充字段 |
29
30
  |------|--------------|-------------|
30
- | `text` | `type` `name` | `style.type` |
31
- | `number` | `type` `name` | `style` |
32
- | `select` | `type` `name` | `multiple` + `options`,或 `multiple` + `dynamic_options_source` |
33
- | `datetime` | `type` `name` | `style.format` |
31
+ | `text` | `type` `name` | `style.type` `default_value` |
32
+ | `number` | `type` `name` | `style` `default_value` |
33
+ | `select` | `type` `name` | `multiple` + `options` + 静态 `default_value`,或 `multiple` + `dynamic_options_source` |
34
+ | `datetime` | `type` `name` | `style.format` `default_value` |
34
35
  | `created_at` / `updated_at` | `type` `name` | `style.format` |
35
- | `user` / `group_chat` | `type` `name` | `multiple` |
36
+ | `user` / `group_chat` | `type` `name` | `multiple`;仅 `user` 支持 `default_value` |
36
37
  | `created_by` / `updated_by` | `type` `name` | 无 |
37
38
  | `link` | `type` `name` `link_table` | `bidirectional` `bidirectional_link_field_name` |
38
39
  | `formula` | `type` `name` `expression` | 无 |
@@ -47,31 +48,37 @@
47
48
  ### 3.1 text
48
49
 
49
50
  文本字段;电话、超链接、邮箱、条码也都属于 `text`,通过 `style.type` 区分。
51
+ 支持 `default_value`:静态 Markdown 文本字符串;`phone` style 必须是合法电话号码;`url` style 传一个 Markdown 链接或裸 URL;`email` style 必须是合法邮箱字符串,不要传 Markdown 链接或 `mailto:`。
50
52
 
51
53
  最小写法(默认 `style.type` 为 `plain`):
52
54
 
53
55
  ```json
54
56
  {
55
57
  "type": "text",
56
- "name": "标题"
58
+ "name": "标题",
59
+ "default_value": "默认标题"
57
60
  }
58
61
  ```
59
62
 
60
63
  常用写法:
61
64
 
65
+ 默认值可以是 Markdown 文本
62
66
  ```json
63
67
  {
64
68
  "type": "text",
65
69
  "name": "标题",
66
- "description": "主标题字段"
70
+ "description": "主标题字段",
71
+ "default_value": "未命名"
67
72
  }
68
73
  ```
69
74
 
75
+ `style.type=phone` 时默认值是合法电话号码字符串。
70
76
  ```json
71
77
  {
72
78
  "type": "text",
73
79
  "name": "联系电话",
74
- "style": { "type": "phone" }
80
+ "style": { "type": "phone" },
81
+ "default_value": "+8613800000000"
75
82
  }
76
83
  ```
77
84
 
@@ -79,7 +86,17 @@
79
86
  {
80
87
  "type": "text",
81
88
  "name": "官网",
82
- "style": { "type": "url" }
89
+ "style": { "type": "url" },
90
+ "default_value": "[官网](https://example.com)"
91
+ }
92
+ ```
93
+
94
+ ```json
95
+ {
96
+ "type": "text",
97
+ "name": "邮箱",
98
+ "style": { "type": "email" },
99
+ "default_value": "owner@example.com"
83
100
  }
84
101
  ```
85
102
 
@@ -88,13 +105,15 @@
88
105
  ### 3.2 number
89
106
 
90
107
  数字字段;货币、进度、评分都属于 `number`,通过 `style.type` 区分。
108
+ 支持 `default_value`:静态 JSON number;所有 number style 都按这个规则写。
91
109
 
92
110
  最小写法(默认 `style.type` 为 `plain`):
93
111
 
94
112
  ```json
95
113
  {
96
114
  "type": "number",
97
- "name": "工时"
115
+ "name": "工时",
116
+ "default_value": 8
98
117
  }
99
118
  ```
100
119
 
@@ -118,7 +137,8 @@
118
137
  "precision": 2,
119
138
  "percentage": false,
120
139
  "thousands_separator": true
121
- }
140
+ },
141
+ "default_value": 8
122
142
  }
123
143
  ```
124
144
 
@@ -151,7 +171,8 @@
151
171
  {
152
172
  "type": "number",
153
173
  "name": "完成度",
154
- "style": { "type": "progress", "percentage": true, "color": "Blue" }
174
+ "style": { "type": "progress", "percentage": true, "color": "Blue" },
175
+ "default_value": 0.65
155
176
  }
156
177
  ```
157
178
 
@@ -180,6 +201,7 @@
180
201
  #### 静态选项
181
202
 
182
203
  支持字段:`multiple`、`options`
204
+ 支持 `default_value`:静态选项名数组;即使 `multiple=false` 也写数组,如 `["Todo"]`。
183
205
 
184
206
  默认值 / 约束:
185
207
  - `multiple` 默认 `false`
@@ -189,12 +211,14 @@
189
211
  - `options[].hue` 可用:`Red`、`Orange`、`Yellow`、`Lime`、`Green`、`Turquoise`、`Wathet`、`Blue`、`Carmine`、`Purple`、`Gray` 缺省值为 `Blue`
190
212
  - `options[].lightness` 可用:`Lighter`、`Light`、`Standard`、`Dark`、`Darker` 缺省值为 `Lighter`
191
213
  - 选项里没有 `id`,只有 `name`。
214
+ - 支持 `default_value` 配置:填选项名数组。
192
215
 
193
216
  ```json
194
217
  {
195
218
  "type": "select",
196
219
  "name": "状态",
197
220
  "multiple": false,
221
+ "default_value": ["Todo"],
198
222
  "options": [
199
223
  { "name": "Todo", "hue": "Blue", "lightness": "Lighter" },
200
224
  { "name": "Done", "hue": "Green", "lightness": "Light" }
@@ -205,6 +229,7 @@
205
229
  #### 动态选项
206
230
 
207
231
  支持字段:`multiple`、`dynamic_options_source`
232
+ 动态选项不支持 `default_value`。
208
233
 
209
234
  默认值 / 约束:
210
235
  - `multiple` 默认 `false`
@@ -213,6 +238,7 @@
213
238
  - `dynamic_options_source.field_id` 填来源字段 id 或字段名
214
239
  - `dynamic_options_source` 仅创建支持;更新已有字段时不要传
215
240
  - 引用选项条件 / 级联筛选条件:这个功能在 Base 前端支持,属于 UI-only 属性,OpenAPI 里不支持,CLI 不能读取、创建或更新;不要根据接口返回缺失判断未配置
241
+ - 动态选项不支持配置 `default_value`。
216
242
 
217
243
  ```json
218
244
  {
@@ -229,13 +255,15 @@
229
255
  ### 3.4 datetime
230
256
 
231
257
  手动填写的日期/时间字段。系统时间用 `created_at` / `updated_at`。
258
+ 支持 `default_value`:静态时间字符串,或 `{ "$slot": "record_created_time" }`。`datetime + record_created_time` 是自动填充可编辑单元格;`created_at` 是只读创建时间元信息。
232
259
 
233
260
  最小写法:
234
261
 
235
262
  ```json
236
263
  {
237
264
  "type": "datetime",
238
- "name": "截止时间"
265
+ "name": "截止时间",
266
+ "default_value": "2026-03-24 10:00:00"
239
267
  }
240
268
  ```
241
269
 
@@ -251,7 +279,8 @@
251
279
  {
252
280
  "type": "datetime",
253
281
  "name": "截止时间",
254
- "style": { "format": "yyyy-MM-dd HH:mm" }
282
+ "style": { "format": "yyyy-MM-dd HH:mm" },
283
+ "default_value": { "$slot": "record_created_time" }
255
284
  }
256
285
  ```
257
286
 
@@ -276,12 +305,19 @@
276
305
  ### 3.6 user / group_chat
277
306
 
278
307
  人员字段和群字段都支持 `multiple`。
308
+ `user` 支持 `default_value`:人员 CellValue 数组,元素可用 `{ "id": "ou_xxx" }` 或 `{ "$slot": "current_user" }`;不要猜用户 ID。`group_chat` 不支持默认值。
279
309
 
280
310
  默认值 / 约束:
281
311
  - `multiple` 默认 `true`
312
+ - `user` 字段支持 `default_value` 配置,`group_chat` 字段不支持 `default_value` 配置。
282
313
 
283
314
  ```json
284
- { "type": "user", "name": "负责人", "multiple": true }
315
+ {
316
+ "type": "user",
317
+ "name": "负责人",
318
+ "multiple": true,
319
+ "default_value": [{ "$slot": "current_user" }, { "id": "ou_xxx" }]
320
+ }
285
321
  ```
286
322
 
287
323
  ```json
@@ -488,3 +524,4 @@ Object(对象字段)、Button(按钮字段)、Stage(流程字段)暂
488
524
  - `number` 的精度、货币、进度、评分配置都放在 `style` 下,不要写顶层 `precision`。
489
525
  - `datetime` 是手动日期字段;系统时间请改用 `created_at` / `updated_at`。
490
526
  - `formula` / `lookup` 没读 guide 前不要直接写。
527
+ - 只有 `text`、`number`、静态 `select`、`datetime`、`user` 支持 `default_value`;清空统一传 `"default_value": null`。其他字段类型不要配置默认值。
@@ -11,14 +11,14 @@ lark-cli base +field-update \
11
11
  --base-token <base_token> \
12
12
  --table-id <table_id> \
13
13
  --field-id <field_id> \
14
- --json '{"name":"状态","type":"select","multiple":false,"options":[{"name":"Todo","hue":"Blue","lightness":"Lighter"},{"name":"Doing","hue":"Orange","lightness":"Light"},{"name":"Done","hue":"Green","lightness":"Light"}]}' \
14
+ --json '{"name":"状态","type":"select","multiple":false,"default_value":["Doing"],"options":[{"name":"Todo","hue":"Blue","lightness":"Lighter"},{"name":"Doing","hue":"Orange","lightness":"Light"},{"name":"Done","hue":"Green","lightness":"Light"}]}' \
15
15
  --yes
16
16
 
17
17
  lark-cli base +field-update \
18
18
  --base-token <base_token> \
19
19
  --table-id <table_id> \
20
20
  --field-id <field_id> \
21
- --json '{"name":"负责人","type":"user","multiple":false,"description":"用于标记记录的直接负责人"}' \
21
+ --json '{"name":"负责人","type":"user","multiple":false,"default_value":null,"description":"用于标记记录的直接负责人"}' \
22
22
  --yes
23
23
  ```
24
24
 
@@ -47,6 +47,7 @@ PUT /open-apis/base/v3/bases/:base_token/tables/:table_id/fields/:field_id
47
47
  - `--json` 必须是 **JSON 对象**,顶层直接传字段定义。
48
48
  - 更新语义是 `PUT`(全量字段配置更新),不要只传零散片段;至少显式包含 `name`、`type`,并补齐该类型所需关键配置。
49
49
  - 所有字段类型都支持可选 `description`;支持纯文本,也支持 Markdown 链接。
50
+ - 需要字段默认值时传 `default_value`,直接使用字段对应 CellValue;传 `null` 清空,省略表示不修改现有默认值。完整规则见 [lark-base-field-json.md](lark-base-field-json.md)。
50
51
  - `select` 更新时:`options` 仍按对象数组传,避免混入无效字段。
51
52
  - `link` 更新限制:
52
53
  - 不能把非 `link` 字段改成 `link`,也不能把 `link` 改成非 `link`。
@@ -59,6 +60,7 @@ PUT /open-apis/base/v3/bases/:base_token/tables/:table_id/fields/:field_id
59
60
  "name": "状态",
60
61
  "type": "select",
61
62
  "multiple": false,
63
+ "default_value": ["Doing"],
62
64
  "options": [
63
65
  { "name": "Todo", "hue": "Blue", "lightness": "Lighter" },
64
66
  { "name": "Doing", "hue": "Orange", "lightness": "Light" },
@@ -63,6 +63,7 @@ lark-cli calendar event.attendees create \
63
63
  - 时间参数是 **Unix 秒字符串**(非 ISO 8601)。
64
64
  - 全天日程的开始日期和结束日期必须分别是日程开始的第一天和结束的最后一天;单日全天日程两者相同。
65
65
  - 手动拆成“创建日程 + 添加参会人”两步时,若第二步失败,建议删除刚创建的空日程,避免遗留无参会人的日程。
66
+ - 设置会议 owner:`+create` 不支持,需用完整 API 命令在 `vchat.meeting_settings.owner_id` 中设置,且必须同时设置 `vchat.vc_type` 为 `vc`(代表该日程为 VC 视频会议)。仅当以应用(bot)身份在应用日历上操作时生效;owner 必须为用户身份(`ou_` open_id),不能为非用户或外部租户用户。
66
67
 
67
68
  ## 参会人类型
68
69