@amaster.ai/pi-lark 0.1.2-beta.53 → 0.1.2-beta.55

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 (105) hide show
  1. package/package.json +2 -2
  2. package/skills/lark-apps/SKILL.md +29 -2
  3. package/skills/lark-base/SKILL.md +4 -3
  4. package/skills/lark-base/references/lark-base-data-query-guide.md +8 -0
  5. package/skills/lark-base/references/lark-base-field-create.md +19 -8
  6. package/skills/lark-base/references/lark-base-field-json.md +3 -2
  7. package/skills/lark-doc/SKILL.md +25 -61
  8. package/skills/lark-doc/references/genres/business-analysis.md +30 -0
  9. package/skills/lark-doc/references/genres/data-report.md +32 -0
  10. package/skills/lark-doc/references/genres/email.md +38 -0
  11. package/skills/lark-doc/references/genres/execution-plan.md +27 -0
  12. package/skills/lark-doc/references/genres/formal-doc.md +37 -0
  13. package/skills/lark-doc/references/genres/meeting-minutes.md +24 -0
  14. package/skills/lark-doc/references/genres/memo-brief.md +25 -0
  15. package/skills/lark-doc/references/genres/official-redhead.md +73 -0
  16. package/skills/lark-doc/references/genres/prd.md +26 -0
  17. package/skills/lark-doc/references/genres/proposal.md +24 -0
  18. package/skills/lark-doc/references/genres/research-report.md +32 -0
  19. package/skills/lark-doc/references/genres/retrospective.md +25 -0
  20. package/skills/lark-doc/references/genres/route-consumer.md +37 -0
  21. package/skills/lark-doc/references/genres/route-creative.md +36 -0
  22. package/skills/lark-doc/references/genres/route-knowledge.md +39 -0
  23. package/skills/lark-doc/references/genres/route-marketing.md +40 -0
  24. package/skills/lark-doc/references/genres/route-media.md +36 -0
  25. package/skills/lark-doc/references/genres/route-opinion.md +38 -0
  26. package/skills/lark-doc/references/genres/route-personal-brand.md +36 -0
  27. package/skills/lark-doc/references/genres/route-platform.md +9 -0
  28. package/skills/lark-doc/references/genres/route-report.md +10 -0
  29. package/skills/lark-doc/references/genres/route-workplace.md +17 -0
  30. package/skills/lark-doc/references/genres/sop-tutorial.md +41 -0
  31. package/skills/lark-doc/references/genres/technical-doc.md +39 -0
  32. package/skills/lark-doc/references/genres/wechat.md +39 -0
  33. package/skills/lark-doc/references/genres/weekly-report.md +24 -0
  34. package/skills/lark-doc/references/genres/white-paper.md +32 -0
  35. package/skills/lark-doc/references/genres/xiaohongshu.md +38 -0
  36. package/skills/lark-doc/references/lark-doc-create-workflow.md +121 -0
  37. package/skills/lark-doc/references/lark-doc-create.md +22 -48
  38. package/skills/lark-doc/references/lark-doc-fetch.md +75 -92
  39. package/skills/lark-doc/references/lark-doc-history.md +3 -1
  40. package/skills/lark-doc/references/lark-doc-md.md +5 -1
  41. package/skills/lark-doc/references/lark-doc-media-download.md +2 -1
  42. package/skills/lark-doc/references/lark-doc-script.md +76 -0
  43. package/skills/lark-doc/references/lark-doc-update.md +70 -222
  44. package/skills/lark-doc/references/lark-doc-whiteboard.md +5 -9
  45. package/skills/lark-doc/references/lark-doc-xml-extended-blocks.md +17 -12
  46. package/skills/lark-doc/references/lark-doc-xml.md +38 -167
  47. package/skills/lark-drive/SKILL.md +1 -1
  48. package/skills/lark-drive/references/lark-drive-download.md +29 -2
  49. package/skills/lark-drive/references/lark-drive-preview.md +21 -2
  50. package/skills/lark-im/SKILL.md +3 -3
  51. package/skills/lark-im/references/lark-im-messages-resources-download.md +19 -25
  52. package/skills/lark-slides/SKILL.md +57 -59
  53. package/skills/lark-slides/references/cli/lark-slides-create.md +176 -0
  54. package/skills/lark-slides/references/cli/lark-slides-history.md +132 -0
  55. package/skills/lark-slides/references/cli/lark-slides-media-upload.md +104 -0
  56. package/skills/lark-slides/references/cli/lark-slides-replace-slide.md +258 -0
  57. package/skills/lark-slides/references/cli/lark-slides-screenshot.md +115 -0
  58. package/skills/lark-slides/references/cli/lark-slides-xml-presentation-slide-get.md +110 -0
  59. package/skills/lark-slides/references/cli/lark-slides-xml-presentation-slide-replace.md +188 -0
  60. package/skills/lark-slides/references/cli/lark-slides-xml-presentations-get.md +157 -0
  61. package/skills/lark-slides/references/iconpark-index.json +5 -41901
  62. package/skills/lark-slides/references/iconpark.md +3 -44
  63. package/skills/lark-slides/references/lark-slides-add-slide.md +3 -90
  64. package/skills/lark-slides/references/lark-slides-create.md +3 -143
  65. package/skills/lark-slides/references/lark-slides-delete-slide.md +3 -63
  66. package/skills/lark-slides/references/lark-slides-edit-workflows.md +3 -144
  67. package/skills/lark-slides/references/lark-slides-history.md +3 -130
  68. package/skills/lark-slides/references/lark-slides-media-upload.md +3 -102
  69. package/skills/lark-slides/references/lark-slides-pptx-template-workflows.md +3 -83
  70. package/skills/lark-slides/references/lark-slides-replace-slide.md +3 -256
  71. package/skills/lark-slides/references/lark-slides-screenshot.md +3 -113
  72. package/skills/lark-slides/references/lark-slides-update-slide.md +146 -0
  73. package/skills/lark-slides/references/lark-slides-xml-presentation-slide-get.md +3 -108
  74. package/skills/lark-slides/references/lark-slides-xml-presentation-slide-replace.md +3 -186
  75. package/skills/lark-slides/references/lark-slides-xml-presentations-get.md +3 -132
  76. package/skills/lark-slides/references/planning-layer.md +1 -1
  77. package/skills/lark-slides/references/slides_chart_demo.xml +5 -1416
  78. package/skills/lark-slides/references/slides_xml_schema_definition.xml +3 -3512
  79. package/skills/lark-slides/references/troubleshooting.md +3 -60
  80. package/skills/lark-slides/references/validation-checklist.md +3 -154
  81. package/skills/lark-slides/references/workflow/error-handling.md +62 -0
  82. package/skills/lark-slides/references/workflow/slides_editing.md +143 -0
  83. package/skills/lark-slides/references/workflow/template-editing.md +85 -0
  84. package/skills/lark-slides/references/workflow/validation-xml.md +156 -0
  85. package/skills/lark-slides/references/xml/iconpark-index.json +37458 -0
  86. package/skills/lark-slides/references/xml/iconpark.md +46 -0
  87. package/skills/lark-slides/references/xml/lark-slides-add-slide.md +92 -0
  88. package/skills/lark-slides/references/xml/lark-slides-delete-slide.md +65 -0
  89. package/skills/lark-slides/references/xml/slides_chart_demo.xml +1415 -0
  90. package/skills/lark-slides/references/xml/slides_xml_schema_definition.xml +3514 -0
  91. package/skills/lark-slides/references/xml/xml-schema-quick-ref.md +497 -0
  92. package/skills/lark-slides/references/xml-schema-quick-ref.md +3 -497
  93. package/skills/lark-slides/scripts/iconpark_tool.py +1 -1
  94. package/skills/lark-slides/scripts/xml_lint.py +2989 -0
  95. package/skills/lark-slides/scripts/xml_lint_test.py +4720 -0
  96. package/skills/lark-slides/scripts/xml_text_overlap_lint.py +3 -2975
  97. package/skills/lark-slides/scripts/xml_text_overlap_lint_test.py +5 -4712
  98. package/skills/lark-wiki/SKILL.md +3 -1
  99. package/skills/lark-wiki/references/lark-wiki-node-copy.md +4 -19
  100. package/skills/lark-doc/references/lark-doc-word-stat.md +0 -93
  101. package/skills/lark-doc/references/style/lark-doc-create-workflow.md +0 -47
  102. package/skills/lark-doc/references/style/lark-doc-style.md +0 -68
  103. package/skills/lark-doc/references/style/lark-doc-update-workflow.md +0 -48
  104. package/skills/lark-doc/scripts/doc_word_stat.py +0 -1243
  105. /package/skills/lark-slides/references/{lark-slides-replace-pages.md → cli/lark-slides-replace-pages.md} +0 -0
@@ -0,0 +1,146 @@
1
+ # slides +update-slide(整页更新已有页面)
2
+
3
+ 把一整页 XML 交给某个已有页面,页面变成 `--content` 描述的样子。`slide_id` 和页序都不变。
4
+
5
+ ## 命令
6
+
7
+ ```bash
8
+ # 标准用法:整页 XML 从文件读(推荐:避免 shell 转义和长参数截断)
9
+ lark-cli slides +update-slide --as user \
10
+ --presentation "https://xxx.larkoffice.com/slides/SCtZ...ynae" \
11
+ --slide-id "piy" \
12
+ --content @page.xml
13
+
14
+ # XML 从 stdin 读
15
+ cat page.xml | lark-cli slides +update-slide --as user \
16
+ --presentation "$PRES" --slide-id "$SLIDE" --content -
17
+
18
+ # wiki 链接直接传(CLI 自动解析并校验 obj_type=slides)
19
+ lark-cli slides +update-slide --as user \
20
+ --presentation "https://xxx.larkoffice.com/wiki/wikcn..." \
21
+ --slide-id "piy" --content @page.xml
22
+
23
+ # 预览请求,不实际写入
24
+ lark-cli slides +update-slide --as user \
25
+ --presentation "$PRES" --slide-id "$SLIDE" --content @page.xml --dry-run
26
+ ```
27
+
28
+ ## 参数
29
+
30
+ | 参数 | 必需 | 说明 |
31
+ |------|------|------|
32
+ | `--presentation` | 是 | `xml_presentation_id`、`/slides/` URL 或 `/wiki/` URL |
33
+ | `--slide-id` | 是 | 要整页替换的页面 `slide_id` |
34
+ | `--content` | 是 | 这一页的完整目标 XML,单一 `<slide>` 根;支持字面量、`@file`、stdin `-`。别名:`--xml` / `--slide-xml` / `--slide-content` / `--content-xml` |
35
+ | `--revision-id` | 否 | 默认 `-1`(最新)。它只选择服务端执行所基于的快照,不是“页面有新编辑就拒绝”的乐观锁;传旧版本号会以旧快照重建页面并丢弃其后的编辑 |
36
+ | `--tid` | 否 | 调用方提供的任务/事务标识,CLI 原样透传;用于关联同一编辑任务或重试,不等同于版本前置条件,不能单独保证并发冲突时拒绝写入。一般留空 |
37
+
38
+ `@file` 和 `+xml-get --output` 一样**只接受当前目录下的相对路径**,绝对路径会被拒。
39
+ 命令别名:`slides +update`(隐藏);服务别名:`lark-cli slide …` 等价于 `lark-cli slides …`。
40
+
41
+ 如果要求“从读取之后页面一旦变化就不再写入”,不能只传 `--revision-id` 或 `--tid`。写入前必须再次用 `+xml-get` 回读最新版,比较读取期间是否发生变化;有变化时先基于最新版重新合并本次修改,再执行整页写回。当前 shortcut 不提供严格的 compare-and-swap 保证。
42
+
43
+ ## 语义:`--content` 就是这一页的最终状态
44
+
45
+ **没写进 `--content` 的东西会从页面上消失。** 这不是补丁,是整页覆盖。
46
+
47
+ | 你在 `--content` 里怎么写 | 页面上的结果 |
48
+ |---|---|
49
+ | 元素带原来的 `id` | 按新 XML 更新这个元素 |
50
+ | 元素不带 `id` | 作为新元素插入到它所在的位置 |
51
+ | 原来有、`--content` 里没有的元素 | **删除** |
52
+ | `<style>` 改了 | 背景等页面样式跟着改 |
53
+ | 没写 `<note>` | 讲者备注被清空 |
54
+
55
+ 一次请求就能同时做完改样式、插入、删除、换备注、换背景——这是 `+replace-slide` 逐元素 part 做不到的(它没法寻址背景,也没有 move 操作)。
56
+
57
+ ## 标准读-改-写流程
58
+
59
+ ```bash
60
+ # 1. 读回当前页(拿到带 id 的完整 XML)
61
+ lark-cli slides +xml-get --as user \
62
+ --presentation "$PRES" --slide-id "$SLIDE" --output page.xml
63
+
64
+ # 2. 编辑 page.xml —— 保留想留下的元素的 id,删掉不要的整段,新元素不写 id
65
+
66
+ # 3. 整页写回
67
+ lark-cli slides +update-slide --as user \
68
+ --presentation "$PRES" --slide-id "$SLIDE" --content @page.xml
69
+ ```
70
+
71
+ 先 `--dry-run` 看请求,确认无误再执行。
72
+
73
+ > ⚠️ **第 1 步不要加 `--remove-attr-id`。** 那个参数会把所有元素的 `id` 去掉,再交给 `+update-slide` 的话,每个元素都会被当成新元素插入、原来的全部被删除——页面看起来一样,但所有元素换了新 id,锚在旧 id 上的评论和 block 直达链接全部失效,而且**不会有任何报错**。`--remove-attr-id` 只用于只读查看。
74
+
75
+ ## 命令校验与空页限制
76
+
77
+ | 情况 | 报错 |
78
+ |---|---|
79
+ | 根元素不是 `<slide>`(例如直接给了 `<shape>`) | `--content root must be <slide>` → 改单个元素请用 `+replace-slide` |
80
+ | 根 `id` 和 `--slide-id` 不一致 | 拒绝。这通常是 A 页的 XML 要写到 B 页 —— 会毁掉 B 页 |
81
+ | 根 `id` 缺失 | 自动补上 `--slide-id`,不报错 |
82
+ | 根标签带命名空间前缀(`<sml:slide>`) | 拒绝。页面 id 没法贴到带前缀的标签上;写成 `<slide>`,需要命名空间就用默认 `xmlns` |
83
+ | `<slide>` 之后还有第二个根元素或多余文本 | 拒绝。服务端解析会静默丢掉它们 |
84
+ | XML 不合法 | 拒绝,带上出错位置 |
85
+ | `<slide/>`(自闭合,空页) | 命令本身可以解析,但提交前的强制版式 lint 会报 `blank_slide`;按本 Skill 不得调用接口提交空页 |
86
+
87
+ 标为“拒绝”的情况由命令校验拦截,**不会发出任何请求**;空页则必须在调用命令前由强制版式 lint 拦截。
88
+
89
+ ## 什么时候不要用它
90
+
91
+ - **只改一个元素** → 用 [`+replace-slide`](cli/lark-slides-replace-slide.md),一条 `block_replace` part 更省,也不用带上整页
92
+ - **要改多个页面** → 对每一页各跑一次本命令
93
+ - **要新建页面** → `slides +create` 或 `xml_presentation.slide create`
94
+
95
+ ## 提交前与写入后验证
96
+
97
+ 和其他整页写入一样,把 `--content` 存成本地文件后先跑版式 lint。先取得当前已加载 `lark-slides/SKILL.md` 的父目录,记为 `<lark-slides-skill-dir>`;不要猜测全局安装路径:
98
+
99
+ ```bash
100
+ python3 "<lark-slides-skill-dir>/scripts/xml_lint.py" --input page.xml
101
+ ```
102
+
103
+ `summary.error_count` 必须为 0 才调接口;`warning_count > 0` 时写完要截图复核。
104
+
105
+ 写入成功后,必须回读整份演示文稿的最新 XML,而不是只相信写接口的成功响应:
106
+
107
+ ```bash
108
+ lark-cli slides +xml-get --as user \
109
+ --presentation "$PRES" --output readback.xml
110
+ ```
111
+
112
+ 按当前已加载 `lark-slides/SKILL.md` 指向的 [validation-xml.md](workflow/validation-xml.md) 完成验证:核对总页数、目标页和关键元素(包括需要保留的 ID、文本、背景与备注),并对回读 XML 运行同一版式 lint;发现差异时先停止后续写入并重新基于最新版处理。
113
+
114
+ ## 成功输出
115
+
116
+ ```json
117
+ {
118
+ "ok": true,
119
+ "identity": "user",
120
+ "data": {
121
+ "xml_presentation_id": "slides_example_presentation_id",
122
+ "slide_id": "piy",
123
+ "revision_id": 43
124
+ }
125
+ }
126
+ ```
127
+
128
+ | `data` 下的字段 | 说明 |
129
+ |------|------|
130
+ | `xml_presentation_id` | 实际写入的演示文稿 ID |
131
+ | `slide_id` | 与传入相同——整页覆盖不换页 id |
132
+ | `revision_id` | 写入后的新版本号 |
133
+
134
+ 服务端拒绝这次写入时(`failed_reason` 非空)**不会**返回成功输出,而是报错并带上原因——单个 part 承载整页,任何失败都意味着页面没被写入。
135
+
136
+ - 原因包含 `not found`:先检查 `--presentation` 和 `--slide-id`,再用 `slides +xml-get` 回读当前页面 ID。页面可能已删除,或 ID 来自另一份演示文稿。
137
+ - 其他 invalid-parameter 错误:检查 `--content` 中不支持的元素、缺少 `<content/>` 的 `<shape>`,以及超出 960×540 的坐标。
138
+
139
+ ## 常见错误
140
+
141
+ | 现象 | 原因 | 解决 |
142
+ |------|------|------|
143
+ | 3350001,原因包含 `not found` | `--presentation` 不匹配,或 `--slide-id` 对应的页面已被删除 | 检查 `--presentation` 和 `--slide-id`,再用 `slides +xml-get` 回读当前页面 ID |
144
+ | 3350001,其他 invalid param | `--content` 的 XML 结构有问题(如 `<shape>` 缺 `<content/>`、包含服务端不支持的元素) | 按 [error-handling.md](workflow/error-handling.md) 检查 `--content` 的 XML 结构 |
145
+ | 3350002 not found | `--revision-id` 传了不存在的版本号 | 用 `-1` 或真实存在的 `revision_id` |
146
+ | 1061004 / 403 | 当前身份对这份 PPT 没有编辑权限 | 检查是否拥有 `slides:presentation:update` 或 `slides:presentation:write_only` scope;wiki 链接另需 `wiki:node:read`;`--as bot` 还要求该 bot 对目标 PPT 有编辑权限 |
@@ -1,110 +1,5 @@
1
- # lark-slides xml_presentation.slide get
1
+ # lark-slides xml_presentation.slide get(兼容入口)
2
2
 
3
- ## 用途
3
+ 本文档已迁移至 [`cli/lark-slides-xml-presentation-slide-get.md`](cli/lark-slides-xml-presentation-slide-get.md)。
4
4
 
5
- 按 `slide_id` 拉取指定演示文稿单页的 XML 内容(可指定历史版本)。常用于"读-改-写"编辑闭环的第一步。
6
-
7
- ## 命令
8
-
9
- ```bash
10
- lark-cli slides xml_presentation.slide get --as user --params '<json_params>'
11
- ```
12
-
13
- ## 参数说明
14
-
15
- | 参数 | 类型 | 必需 | 说明 |
16
- |------|------|------|------|
17
- | `--params` | JSON string | 是 | 路径参数与查询参数 |
18
-
19
- ### params JSON 结构
20
-
21
- ```json
22
- {
23
- "xml_presentation_id": "slides_example_presentation_id",
24
- "slide_id": "slide_example_id",
25
- "revision_id": -1
26
- }
27
- ```
28
-
29
- | 字段 | 类型 | 必需 | 说明 |
30
- |------|------|------|------|
31
- | `xml_presentation_id` | string | 是 | 目标演示文稿唯一标识 |
32
- | `slide_id` | string | 是 | 目标页面唯一标识 |
33
- | `revision_id` | integer | 否 | 版本号,`-1` 表示最新版(默认)|
34
-
35
- ## 使用示例
36
-
37
- ### 读最新版本
38
-
39
- ```bash
40
- lark-cli slides xml_presentation.slide get --as user --params '{
41
- "xml_presentation_id": "slides_example_presentation_id",
42
- "slide_id": "slide_example_id"
43
- }'
44
- ```
45
-
46
- ### 只提取 XML 内容
47
-
48
- ```bash
49
- lark-cli slides xml_presentation.slide get --as user \
50
- --params '{"xml_presentation_id":"slides_example_presentation_id","slide_id":"slide_example_id"}' \
51
- | jq -r '.data.slide.content'
52
- ```
53
-
54
- ### 读指定历史版本
55
-
56
- ```bash
57
- lark-cli slides xml_presentation.slide get --as user --params '{
58
- "xml_presentation_id": "slides_example_presentation_id",
59
- "slide_id": "slide_example_id",
60
- "revision_id": 42
61
- }'
62
- ```
63
-
64
- ## 返回值
65
-
66
- ```json
67
- {
68
- "ok": true,
69
- "identity": "user",
70
- "data": {
71
- "slide": {
72
- "slide_id": "slide_example_id",
73
- "content": "<slide id=\"slide_example_id\"><style/><data>...</data></slide>"
74
- },
75
- "revision_id": 100
76
- }
77
- }
78
- ```
79
-
80
- | 字段 | 类型 | 说明 |
81
- |------|------|------|
82
- | `data.slide.slide_id` | string | 页面唯一标识 |
83
- | `data.slide.content` | string | 页面完整 XML(`<slide>` 根节点,不含 xmlns)|
84
- | `data.revision_id` | integer | 此次读到的版本号,可用于后续 replace 的乐观锁 |
85
-
86
- ## 常见错误
87
-
88
- | 错误码 | 含义 | 解决方案 |
89
- |--------|------|----------|
90
- | 404 | 演示文稿或页面不存在 | 检查 `xml_presentation_id` / `slide_id` |
91
- | 403 | 权限不足 | 需要 `slides:presentation:read` scope,并对该 PPT 有访问权限 |
92
- | 400 | `revision_id` 不存在 | 传了无效版本号,用 `-1` 或真实存在的版本号 |
93
-
94
- ## 注意事项
95
-
96
- 1. **执行前必做**:`lark-cli schema slides.xml_presentation.slide.get` 查看最新参数结构
97
- 2. **block_id 提取**:返回 XML 里每个顶层块(shape、img、table、chart 等)的 `id` 属性即为 `block_id`,通常是 3 字符短码,例如 `<shape id="bUn" ...>`。用以下命令列出当前页所有 block_id:
98
-
99
- ```bash
100
- lark-cli slides xml_presentation.slide get --as user \
101
- --params "{\"xml_presentation_id\":\"$PID\",\"slide_id\":\"$SID\"}" \
102
- | jq -r '.data.slide.content' | grep -oE 'id="[^"]+"' | sed 's/id="//;s/"//'
103
- ```
104
-
105
- ## 相关命令
106
-
107
- - [slides +replace-slide](lark-slides-replace-slide.md) — 块级替换 shortcut(推荐)
108
- - [xml_presentation.slide replace](lark-slides-xml-presentation-slide-replace.md) — 底层 replace API 参考
109
- - [slides +xml-get](lark-slides-xml-presentations-get.md) — 读整个 PPT 并保存到本地文件
110
- - [lark-slides-edit-workflows.md](lark-slides-edit-workflows.md) — 读-改-写闭环
5
+ 此文件仅保留旧路径兼容性;后续引用请使用新路径。
@@ -1,188 +1,5 @@
1
- # lark-slides xml_presentation.slide replace
1
+ # lark-slides xml_presentation.slide replace(兼容入口)
2
2
 
3
- ## 用途
3
+ 本文档已迁移至 [`cli/lark-slides-xml-presentation-slide-replace.md`](cli/lark-slides-xml-presentation-slide-replace.md)。
4
4
 
5
- 对单页做**块级局部替换**:不覆盖整页,按 patch 列表做 `block_replace`(整块替换)或 `block_insert`(整块插入)。适合"只想加 / 换一个元素、不动其他元素"的场景。
6
-
7
- > **推荐**:优先使用 [`+replace-slide`](lark-slides-replace-slide.md) Shortcut——它会自动注入 `id` 和 `<content/>`,直接调本 API 需自己处理这两个约束(见注意事项 5、6)。
8
-
9
- ## 命令
10
-
11
- ```bash
12
- lark-cli slides xml_presentation.slide replace --as user --params '<json_params>' --data '<json_data>'
13
- ```
14
-
15
- ## 参数说明
16
-
17
- | 参数 | 类型 | 必需 | 说明 |
18
- |------|------|------|------|
19
- | `--params` | JSON string | 是 | 路径参数与查询参数 |
20
- | `--data` | JSON string | 是 | patch 列表 |
21
-
22
- ### params JSON 结构
23
-
24
- ```json
25
- {
26
- "xml_presentation_id": "slides_example_presentation_id",
27
- "slide_id": "slide_example_id",
28
- "revision_id": -1,
29
- "tid": "idMock"
30
- }
31
- ```
32
-
33
- | 字段 | 类型 | 必需 | 说明 |
34
- |------|------|------|------|
35
- | `xml_presentation_id` | string | 是 | 演示文稿唯一标识 |
36
- | `slide_id` | string | 是 | 页面唯一标识 |
37
- | `revision_id` | integer | 否 | 默认 `-1`(以最新版为基准);传具体版本号做乐观锁 |
38
- | `tid` | string | 否 | 事务 ID,一般留空 |
39
-
40
- ### data JSON 结构
41
-
42
- ```json
43
- {
44
- "parts": [
45
- { "action": "block_replace", "block_id": "bab", "replacement": "<shape .../>" },
46
- { "action": "block_insert", "insertion": "<img .../>", "insert_before_block_id": "baa" }
47
- ]
48
- }
49
- ```
50
-
51
- | 字段 | 类型 | 必需 | 说明 |
52
- |------|------|------|------|
53
- | `parts` | array | 是 | patch 列表,长度 1~200,顺序执行 |
54
-
55
- ### parts[] 字段(按 action 不同)
56
-
57
- 本期 CLI 文档化两种 action:
58
-
59
- #### action = "block_replace" — 整块替换
60
-
61
- | 字段 | 必填 | 说明 |
62
- |------|------|------|
63
- | `action` | 是 | 固定 `block_replace` |
64
- | `block_id` | 是 | 目标块的 3 位 short element ID(从 `slide.get` 返回的 XML 里读到) |
65
- | `replacement` | 是 | 新 XML 片段,替换整个目标块 |
66
-
67
- #### action = "block_insert" — 整块插入
68
-
69
- | 字段 | 必填 | 说明 |
70
- |------|------|------|
71
- | `action` | 是 | 固定 `block_insert` |
72
- | `insertion` | 是 | 要插入的完整 XML 片段 |
73
- | `insert_before_block_id` | 否 | 插到这个块之前;省略则追加到页面末尾 |
74
-
75
- ## 使用示例
76
-
77
- ### block_replace:换一个 shape 的整体内容
78
-
79
- ```bash
80
- lark-cli slides xml_presentation.slide replace --as user --params '{
81
- "xml_presentation_id": "slides_example_presentation_id",
82
- "slide_id": "slide_example_id"
83
- }' --data '{
84
- "parts": [
85
- {
86
- "action": "block_replace",
87
- "block_id": "bab",
88
- "replacement": "<shape type=\"text\" topLeftX=\"80\" topLeftY=\"80\" width=\"800\" height=\"120\"><content textType=\"title\"><p>新标题</p></content></shape>"
89
- }
90
- ]
91
- }'
92
- ```
93
-
94
- ### block_insert:在已有页上加一张图
95
-
96
- ```bash
97
- # 先拿 file_token
98
- TOKEN=$(lark-cli slides +media-upload --file ./pic.png --presentation "$PID" --as user | jq -r '.data.file_token')
99
-
100
- lark-cli slides xml_presentation.slide replace --as user --params "{
101
- \"xml_presentation_id\": \"$PID\",
102
- \"slide_id\": \"$SID\"
103
- }" --data "$(jq -n --arg token "$TOKEN" '{
104
- parts: [
105
- {
106
- action: "block_insert",
107
- insertion: ("<img src=\"" + $token + "\" topLeftX=\"500\" topLeftY=\"100\" width=\"200\" height=\"150\"/>")
108
- }
109
- ]
110
- }')"
111
- ```
112
-
113
- ### 多条 parts 原子执行
114
-
115
- ```bash
116
- lark-cli slides xml_presentation.slide replace --as user --params '{
117
- "xml_presentation_id": "slides_example_presentation_id",
118
- "slide_id": "slide_example_id"
119
- }' --data '{
120
- "parts": [
121
- {"action":"block_replace","block_id":"bab","replacement":"<shape type=\"text\" topLeftX=\"80\" topLeftY=\"80\" width=\"800\" height=\"120\"><content textType=\"title\"><p>新标题</p></content></shape>"},
122
- {"action":"block_insert","insertion":"<img src=\"<file_token>\" topLeftX=\"700\" topLeftY=\"400\" width=\"180\" height=\"100\"/>"}
123
- ]
124
- }'
125
- ```
126
-
127
- ## 返回值
128
-
129
- ### 成功
130
-
131
- ```json
132
- {
133
- "ok": true,
134
- "identity": "user",
135
- "data": {
136
- "revision_id": 105
137
- }
138
- }
139
- ```
140
-
141
- ### 失败(任一 part 失败,整批不生效)
142
-
143
- 失败时命令以非零退出码结束,stderr 返回类型化错误信封(`error.code`(如 3350001)/ `error.message` / `error.hint`),stdout 不会打印后端原始响应:
144
-
145
- ```json
146
- {
147
- "ok": false,
148
- "identity": "user",
149
- "error": {
150
- "type": "api",
151
- "subtype": "...",
152
- "code": 3350001,
153
- "message": "...",
154
- "hint": "..."
155
- }
156
- }
157
- ```
158
-
159
- | 字段 | 类型 | 说明 |
160
- |------|------|------|
161
- | `data.revision_id` | integer | 成功时返回更新后最新版本号 |
162
-
163
- ## 常见错误
164
-
165
- | 错误码 | 含义 | 解决方案 |
166
- |--------|------|----------|
167
- | 3350001 | `block_id` 在当前页不存在,或 XML 格式 / 结构错误 | 重新 `slide.get` 拿最新 XML,确认 `block_id` 存在;检查 `replacement` / `insertion` 是否合法 XML |
168
- | 400 | `parts` 长度超过 200 | 拆多次调用 |
169
- | 3350002 | `revision_id` 不存在(超过当前版本号) | 用 `-1` 或实际存在的 `revision_id` |
170
- | 400 | XML 格式错误 | `replacement` / `insertion` 必须为合法的 XML 片段,标签闭合 + 属性引号 |
171
- | 403 | 权限不足 | 需要 `slides:presentation:update` 或 `slides:presentation:write_only` |
172
-
173
- ## 注意事项
174
-
175
- 1. **parts 原子事务**:任一条失败整批回滚,不会出现"前几条成功、后几条失败"的中间态。
176
- 2. **block_id 的获取**:`slide.get` 返回的 XML 里每个块(shape、img、table、chart 等)会带 3 位 short element ID,用这个值填 `block_id` / `insert_before_block_id`。
177
- 3. **`<img>` 必须用 file_token**:不能用外链 URL——先 [`slides +media-upload`](lark-slides-media-upload.md) 拿 token。
178
- 4. **不能字段级 patch**:要改一个块的某个属性(比如只改 `topLeftX`),得写整块新 XML 走 `block_replace`;API 不支持"只改一个字段"。
179
- 5. **`block_replace` 要求 `replacement` 根元素带 `id="<block_id>"`**:底层 API 的硬约束,缺失会返回 3350001。推荐走 shortcut [`+replace-slide`](lark-slides-replace-slide.md)——它会自动把 `id` 注入到 `replacement` 根元素上,用户写 XML 时不用自己加。
180
- 6. **`<shape>` 必须有 `<content/>` 子元素**:SML 2.0 schema 要求,缺失同样触发 3350001。shortcut [`+replace-slide`](lark-slides-replace-slide.md) 会自动注入 `<content/>`,直接调底层 API 需要自己加。
181
- 7. **执行前必做**:`lark-cli schema slides.xml_presentation.slide.replace` 查看最新参数结构。
182
-
183
- ## 相关命令
184
-
185
- - [slides +replace-slide](lark-slides-replace-slide.md) — 块级替换 shortcut(推荐,自动注入 id)
186
- - [xml_presentation.slide get](lark-slides-xml-presentation-slide-get.md) — 读原页拿 block short ID
187
- - [slides +media-upload](lark-slides-media-upload.md) — 上传图片拿 file_token
188
- - [lark-slides-edit-workflows.md](lark-slides-edit-workflows.md) — 读-改-写闭环 + 决策树
5
+ 此文件仅保留旧路径兼容性;后续引用请使用新路径。
@@ -1,134 +1,5 @@
1
- # lark-slides xml_presentations get
1
+ # lark-slides xml_presentations get(兼容入口)
2
2
 
3
- ## 用途
3
+ 本文档已迁移至 [`cli/lark-slides-xml-presentations-get.md`](cli/lark-slides-xml-presentations-get.md)。
4
4
 
5
- 读取飞书幻灯片(PPT)演示文稿的完整 XML 内容信息。
6
-
7
- ## Shortcut
8
-
9
- 使用 `slides +xml-get` shortcut,可以把 XML 保存到本地文件,避免终端输出被截断。
10
-
11
-
12
- ```bash
13
- lark-cli slides +xml-get --as user \
14
- --presentation "slides_example_presentation_id" \
15
- --output .lark-slides/plan/slides_example_presentation_id/readback.xml \
16
- --json
17
- ```
18
-
19
- ### 参数说明
20
-
21
- | 参数 | 类型 | 必需 | 说明 |
22
- |------|------|------|------|
23
- | `--presentation` | string | 是 | 演示文稿的唯一标识符 |
24
- | `--revision-id` | integer | 否 | 版本号,`-1` 表示最新版本 |
25
- | `--output` | string | 否 | XML 保存路径,必须使用相对路径;省略时 XML 在 stdout 的 JSON envelope 中返回 |
26
- | `--remove-attr-id` | flag | 否 | 移除 XML id 属性后读取 |
27
- | `--json` | flag | 否 | `--format json` 的简写,json 为默认输出格式 |
28
-
29
-
30
- ### 基础示例
31
-
32
- ```bash
33
- lark-cli slides +xml-get --as user \
34
- --presentation "slides_example_presentation_id" \
35
- --output .lark-slides/plan/slides_example_presentation_id/readback.xml \
36
- --json
37
- ```
38
-
39
- ### 指定版本读取
40
-
41
- ```bash
42
- lark-cli slides +xml-get --as user \
43
- --presentation "slides_example_presentation_id" \
44
- --revision-id 10 \
45
- --output .lark-slides/plan/slides_example_presentation_id/readback-r10.xml \
46
- --json
47
- ```
48
-
49
- ### 移除 XML id 属性后读取
50
-
51
- ```bash
52
- lark-cli slides +xml-get --as user \
53
- --presentation "slides_example_presentation_id" \
54
- --remove-attr-id \
55
- --output .lark-slides/plan/slides_example_presentation_id/readback-no-id.xml \
56
- --json
57
- ```
58
-
59
-
60
- ## 底层原生命令形态
61
-
62
- ```bash
63
- lark-cli slides xml_presentations get --as user --params '<json_params>'
64
- ```
65
-
66
- ### 参数说明
67
-
68
- | 参数 | 类型 | 必需 | 说明 |
69
- |------|------|------|------|
70
- | `--params` | JSON string | 是 | 路径参数与查询参数,结构以 schema 为准 |
71
-
72
- ### params JSON 结构
73
-
74
- ```json
75
- {
76
- "xml_presentation_id": "slides_example_presentation_id",
77
- "revision_id": -1
78
- }
79
- ```
80
-
81
- | 字段 | 类型 | 必需 | 说明 |
82
- |------|------|------|------|
83
- | `xml_presentation_id` | string | 是 | 演示文稿的唯一标识符 |
84
- | `revision_id` | integer | 否 | 版本号,`-1` 表示最新版本 |
85
-
86
-
87
- ### 返回值
88
-
89
- 成功时返回演示文稿的完整信息:
90
-
91
- ```json
92
- {
93
- "ok": true,
94
- "identity": "user",
95
- "data": {
96
- "xml_presentation": {
97
- "presentation_id": "slides_example_presentation_id",
98
- "revision_id": 1,
99
- "content": "<presentation xmlns=\"https://www.larkoffice.com/sml/2.0\" height=\"540\" width=\"960\">...</presentation>"
100
- }
101
- }
102
- }
103
- ```
104
-
105
- ### 返回字段说明
106
-
107
- | 字段 | 类型 | 说明 |
108
- |------|------|------|
109
- | `data.xml_presentation.presentation_id` | string | 演示文稿唯一标识 |
110
- | `data.xml_presentation.revision_id` | integer | 版本号 |
111
- | `data.xml_presentation.content` | string | XML 格式的完整内容 |
112
-
113
- ### 常见错误
114
-
115
- | 错误码 | 含义 | 解决方案 |
116
- |--------|------|----------|
117
- | 404 | 演示文稿不存在 | 检查 `xml_presentation_id` 是否正确 |
118
- | 403 | 权限不足 | 检查是否拥有 `slides:presentation:read` scope,或是否有访问权限 |
119
- | 400 | 参数格式错误 | 确保 `--params` 是合法的 JSON 字符串 |
120
-
121
-
122
- ### 注意事项
123
-
124
- 1. lark-slides 工作流默认使用 `slides +xml-get`;只有必须直接调底层 API 时,才使用
125
- 2. 直接调用底层 API 前,使用 `lark-cli schema slides.xml_presentations.get` 查看最新的参数结构
126
- 3. 返回的 XML 在 `data.xml_presentation.content` 字段中
127
- 4. 如果只需要部分信息,可以使用 `jq` 等工具过滤返回结果
128
- 5. 不要在普通工作流中把完整 XML 打到终端;用 `slides +xml-get --output` 保存文件
129
-
130
- ## 相关命令
131
-
132
- - [slides +create](lark-slides-create.md) - 创建空白 PPT
133
- - [slides +add-slide](lark-slides-add-slide.md) - 添加幻灯片页面
134
- - [slides +delete-slide](lark-slides-delete-slide.md) - 删除幻灯片页面
5
+ 此文件仅保留旧路径兼容性;后续引用请使用新路径。
@@ -10,7 +10,7 @@
10
10
  2. 选择唯一 plan 目录:`.lark-slides/plan/<deck-or-task-id>/`。
11
11
  3. 先创建目录:`mkdir -p .lark-slides/plan/<deck-or-task-id>`。
12
12
  4. 写入 `.lark-slides/plan/<deck-or-task-id>/slide_plan.json`。
13
- 5. 读取 `xml-schema-quick-ref.md`、`visual-planning.md` 和 `asset-planning.md`。
13
+ 5. 读取 `xml/xml-schema-quick-ref.md`、`visual-planning.md` 和 `asset-planning.md`。
14
14
  6. 按 plan、visual planning 和 asset planning 规则逐页生成 XML,把 `layout_type`、`visual_focus`、`text_density` 转成具体页面几何和文本量约束,并把缺失素材转成可执行兜底视觉。
15
15
  7. 创建 PPT 后用 `slides +xml-get` 回读,核对页面数量、关键元素和 plan 到 XML 的对应关系,空白 PPT 中没有 slide 元素。
16
16