@xagent-ai/cli 1.2.2 → 1.3.1

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 (602) hide show
  1. package/.github/ISSUE_TEMPLATE/bug_report.md +38 -38
  2. package/.github/ISSUE_TEMPLATE/feature_request.md +20 -20
  3. package/.github/release.yml +76 -0
  4. package/.github/workflows/ci.yml +75 -0
  5. package/.github/workflows/release.yml +103 -0
  6. package/.gitmodules +3 -3
  7. package/README.md +326 -280
  8. package/README_CN.md +325 -279
  9. package/dist/agents.d.ts.map +1 -1
  10. package/dist/agents.js +7 -3
  11. package/dist/agents.js.map +1 -1
  12. package/dist/ai-client/factory.d.ts +40 -0
  13. package/dist/ai-client/factory.d.ts.map +1 -0
  14. package/dist/ai-client/factory.js +100 -0
  15. package/dist/ai-client/factory.js.map +1 -0
  16. package/dist/ai-client/index.d.ts +20 -0
  17. package/dist/ai-client/index.d.ts.map +1 -0
  18. package/dist/ai-client/index.js +49 -0
  19. package/dist/ai-client/index.js.map +1 -0
  20. package/dist/ai-client/providers/anthropic.d.ts +57 -0
  21. package/dist/ai-client/providers/anthropic.d.ts.map +1 -0
  22. package/dist/ai-client/providers/anthropic.js +406 -0
  23. package/dist/ai-client/providers/anthropic.js.map +1 -0
  24. package/dist/ai-client/providers/openai.d.ts +57 -0
  25. package/dist/ai-client/providers/openai.d.ts.map +1 -0
  26. package/dist/ai-client/providers/openai.js +290 -0
  27. package/dist/ai-client/providers/openai.js.map +1 -0
  28. package/dist/ai-client/providers/remote.d.ts +110 -0
  29. package/dist/ai-client/providers/remote.d.ts.map +1 -0
  30. package/dist/ai-client/providers/remote.js +352 -0
  31. package/dist/ai-client/providers/remote.js.map +1 -0
  32. package/dist/ai-client/registry.d.ts +51 -0
  33. package/dist/ai-client/registry.d.ts.map +1 -0
  34. package/dist/ai-client/registry.js +81 -0
  35. package/dist/ai-client/registry.js.map +1 -0
  36. package/dist/ai-client/types.d.ts +274 -0
  37. package/dist/ai-client/types.d.ts.map +1 -0
  38. package/dist/ai-client/types.js +90 -0
  39. package/dist/ai-client/types.js.map +1 -0
  40. package/dist/ai-client-factory.d.ts +62 -0
  41. package/dist/ai-client-factory.d.ts.map +1 -0
  42. package/dist/ai-client-factory.js +157 -0
  43. package/dist/ai-client-factory.js.map +1 -0
  44. package/dist/auth.d.ts +23 -1
  45. package/dist/auth.d.ts.map +1 -1
  46. package/dist/auth.js +164 -174
  47. package/dist/auth.js.map +1 -1
  48. package/dist/cancellation.d.ts +5 -4
  49. package/dist/cancellation.d.ts.map +1 -1
  50. package/dist/cancellation.js +53 -32
  51. package/dist/cancellation.js.map +1 -1
  52. package/dist/checkpoint.d.ts +2 -1
  53. package/dist/checkpoint.d.ts.map +1 -1
  54. package/dist/checkpoint.js +39 -6
  55. package/dist/checkpoint.js.map +1 -1
  56. package/dist/cli.js +742 -29
  57. package/dist/cli.js.map +1 -1
  58. package/dist/config.d.ts +10 -4
  59. package/dist/config.d.ts.map +1 -1
  60. package/dist/config.js +62 -25
  61. package/dist/config.js.map +1 -1
  62. package/dist/context-compressor.d.ts +82 -18
  63. package/dist/context-compressor.d.ts.map +1 -1
  64. package/dist/context-compressor.js +718 -154
  65. package/dist/context-compressor.js.map +1 -1
  66. package/dist/conversation.d.ts +1 -1
  67. package/dist/conversation.d.ts.map +1 -1
  68. package/dist/conversation.js +8 -7
  69. package/dist/conversation.js.map +1 -1
  70. package/dist/gui-subagent/action-parser/actionParser.d.ts.map +1 -1
  71. package/dist/gui-subagent/action-parser/actionParser.js +6 -4
  72. package/dist/gui-subagent/action-parser/actionParser.js.map +1 -1
  73. package/dist/gui-subagent/agent/gui-agent.d.ts +39 -2
  74. package/dist/gui-subagent/agent/gui-agent.d.ts.map +1 -1
  75. package/dist/gui-subagent/agent/gui-agent.js +189 -74
  76. package/dist/gui-subagent/agent/gui-agent.js.map +1 -1
  77. package/dist/gui-subagent/index.d.ts +23 -1
  78. package/dist/gui-subagent/index.d.ts.map +1 -1
  79. package/dist/gui-subagent/index.js +6 -0
  80. package/dist/gui-subagent/index.js.map +1 -1
  81. package/dist/gui-subagent/operator/base-operator.d.ts.map +1 -1
  82. package/dist/gui-subagent/operator/base-operator.js +0 -1
  83. package/dist/gui-subagent/operator/base-operator.js.map +1 -1
  84. package/dist/gui-subagent/operator/computer-operator.d.ts.map +1 -1
  85. package/dist/gui-subagent/operator/computer-operator.js +31 -8
  86. package/dist/gui-subagent/operator/computer-operator.js.map +1 -1
  87. package/dist/gui-subagent/types/actions.d.ts +1 -1
  88. package/dist/gui-subagent/types/actions.d.ts.map +1 -1
  89. package/dist/gui-subagent/types/actions.js +0 -1
  90. package/dist/gui-subagent/types/actions.js.map +1 -1
  91. package/dist/gui-subagent/types/operator.d.ts +1 -1
  92. package/dist/gui-subagent/types/operator.d.ts.map +1 -1
  93. package/dist/index.d.ts +1 -2
  94. package/dist/index.d.ts.map +1 -1
  95. package/dist/index.js +1 -2
  96. package/dist/index.js.map +1 -1
  97. package/dist/input-processor.d.ts.map +1 -1
  98. package/dist/input-processor.js +8 -5
  99. package/dist/input-processor.js.map +1 -1
  100. package/dist/logger.d.ts.map +1 -1
  101. package/dist/logger.js +1 -1
  102. package/dist/logger.js.map +1 -1
  103. package/dist/mcp.d.ts +7 -1
  104. package/dist/mcp.d.ts.map +1 -1
  105. package/dist/mcp.js +157 -49
  106. package/dist/mcp.js.map +1 -1
  107. package/dist/memory.d.ts.map +1 -1
  108. package/dist/memory.js +3 -3
  109. package/dist/memory.js.map +1 -1
  110. package/dist/output-util.d.ts +27 -0
  111. package/dist/output-util.d.ts.map +1 -0
  112. package/dist/output-util.js +74 -0
  113. package/dist/output-util.js.map +1 -0
  114. package/dist/retry.js +1 -1
  115. package/dist/retry.js.map +1 -1
  116. package/dist/ripgrep.d.ts +29 -0
  117. package/dist/ripgrep.d.ts.map +1 -0
  118. package/dist/ripgrep.js +294 -0
  119. package/dist/ripgrep.js.map +1 -0
  120. package/dist/sdk-output-adapter.d.ts +34 -1
  121. package/dist/sdk-output-adapter.d.ts.map +1 -1
  122. package/dist/sdk-output-adapter.js +67 -2
  123. package/dist/sdk-output-adapter.js.map +1 -1
  124. package/dist/sdk-session.d.ts.map +1 -1
  125. package/dist/sdk-session.js +2 -0
  126. package/dist/sdk-session.js.map +1 -1
  127. package/dist/session-manager.js +3 -3
  128. package/dist/session-manager.js.map +1 -1
  129. package/dist/session.d.ts +116 -6
  130. package/dist/session.d.ts.map +1 -1
  131. package/dist/session.js +1416 -448
  132. package/dist/session.js.map +1 -1
  133. package/dist/shell.d.ts +33 -0
  134. package/dist/shell.d.ts.map +1 -0
  135. package/dist/shell.js +126 -0
  136. package/dist/shell.js.map +1 -0
  137. package/dist/skill-installer.d.ts +38 -0
  138. package/dist/skill-installer.d.ts.map +1 -0
  139. package/dist/skill-installer.js +447 -0
  140. package/dist/skill-installer.js.map +1 -0
  141. package/dist/skill-invoker.d.ts +8 -2
  142. package/dist/skill-invoker.d.ts.map +1 -1
  143. package/dist/skill-invoker.js +36 -15
  144. package/dist/skill-invoker.js.map +1 -1
  145. package/dist/skill-loader.d.ts +8 -3
  146. package/dist/skill-loader.d.ts.map +1 -1
  147. package/dist/skill-loader.js +51 -48
  148. package/dist/skill-loader.js.map +1 -1
  149. package/dist/skill-manager.d.ts +85 -0
  150. package/dist/skill-manager.d.ts.map +1 -0
  151. package/dist/skill-manager.js +341 -0
  152. package/dist/skill-manager.js.map +1 -0
  153. package/dist/slash-commands.d.ts +39 -2
  154. package/dist/slash-commands.d.ts.map +1 -1
  155. package/dist/slash-commands.js +934 -305
  156. package/dist/slash-commands.js.map +1 -1
  157. package/dist/smart-approval.d.ts +20 -1
  158. package/dist/smart-approval.d.ts.map +1 -1
  159. package/dist/smart-approval.js +125 -56
  160. package/dist/smart-approval.js.map +1 -1
  161. package/dist/system-prompt-generator.d.ts +6 -0
  162. package/dist/system-prompt-generator.d.ts.map +1 -1
  163. package/dist/system-prompt-generator.js +86 -36
  164. package/dist/system-prompt-generator.js.map +1 -1
  165. package/dist/terminal.d.ts +28 -0
  166. package/dist/terminal.d.ts.map +1 -0
  167. package/dist/terminal.js +82 -0
  168. package/dist/terminal.js.map +1 -0
  169. package/dist/theme.d.ts.map +1 -1
  170. package/dist/theme.js +8 -7
  171. package/dist/theme.js.map +1 -1
  172. package/dist/tools.d.ts +38 -7
  173. package/dist/tools.d.ts.map +1 -1
  174. package/dist/tools.js +1249 -617
  175. package/dist/tools.js.map +1 -1
  176. package/dist/truncate.d.ts +55 -0
  177. package/dist/truncate.d.ts.map +1 -0
  178. package/dist/truncate.js +130 -0
  179. package/dist/truncate.js.map +1 -0
  180. package/dist/types.d.ts +84 -9
  181. package/dist/types.d.ts.map +1 -1
  182. package/dist/types.js +49 -0
  183. package/dist/types.js.map +1 -1
  184. package/dist/update.d.ts.map +1 -1
  185. package/dist/update.js +28 -36
  186. package/dist/update.js.map +1 -1
  187. package/dist/workflow.d.ts +5 -1
  188. package/dist/workflow.d.ts.map +1 -1
  189. package/dist/workflow.js +61 -49
  190. package/dist/workflow.js.map +1 -1
  191. package/docs/architecture/mcp-integration-guide.md +304 -194
  192. package/docs/architecture/overview.md +169 -169
  193. package/docs/architecture/tool-system-design.md +134 -134
  194. package/docs/cli/commands.md +349 -238
  195. package/docs/smart-mode.md +281 -281
  196. package/docs/third-party-models.md +440 -439
  197. package/find-skills/SKILL.md +133 -0
  198. package/package.json +91 -90
  199. package/scripts/install-ripgrep.js +241 -0
  200. package/src/agents.ts +7 -3
  201. package/src/ai-client/factory.ts +116 -0
  202. package/src/ai-client/index.ts +61 -0
  203. package/src/ai-client/providers/anthropic.ts +475 -0
  204. package/src/ai-client/providers/openai.ts +348 -0
  205. package/src/ai-client/providers/remote.ts +439 -0
  206. package/src/ai-client/registry.ts +97 -0
  207. package/src/ai-client/types.ts +364 -0
  208. package/src/ai-client-factory.ts +204 -0
  209. package/src/auth.ts +661 -614
  210. package/src/cancellation.ts +202 -176
  211. package/src/checkpoint.ts +255 -219
  212. package/src/cli.ts +1523 -743
  213. package/src/config.ts +341 -297
  214. package/src/context-compressor.ts +987 -290
  215. package/src/conversation.ts +290 -288
  216. package/src/gui-subagent/action-parser/actionParser.ts +318 -315
  217. package/src/gui-subagent/action-parser/constants.ts +14 -14
  218. package/src/gui-subagent/action-parser/index.ts +8 -8
  219. package/src/gui-subagent/action-parser/types.ts +31 -31
  220. package/src/gui-subagent/agent/gui-agent.ts +1234 -1089
  221. package/src/gui-subagent/agent/index.ts +5 -5
  222. package/src/gui-subagent/index.ts +185 -163
  223. package/src/gui-subagent/operator/base-operator.ts +244 -245
  224. package/src/gui-subagent/operator/computer-operator.ts +541 -520
  225. package/src/gui-subagent/operator/index.ts +6 -6
  226. package/src/gui-subagent/types/actions.ts +260 -262
  227. package/src/gui-subagent/types/index.ts +6 -6
  228. package/src/gui-subagent/types/operator.ts +106 -106
  229. package/src/gui-subagent/utils.ts +51 -51
  230. package/src/index.ts +17 -18
  231. package/src/input-processor.ts +8 -5
  232. package/src/logger.ts +436 -438
  233. package/src/mcp.ts +793 -682
  234. package/src/memory.ts +343 -344
  235. package/src/output-util.ts +80 -0
  236. package/src/retry.ts +1 -1
  237. package/src/ripgrep.ts +370 -0
  238. package/src/sdk-output-adapter.ts +842 -0
  239. package/src/sdk-session.ts +62 -0
  240. package/src/session-manager.ts +308 -308
  241. package/src/session.ts +1775 -573
  242. package/src/shell.ts +134 -0
  243. package/src/skill-installer.ts +518 -0
  244. package/src/skill-invoker.ts +959 -935
  245. package/src/skill-loader.ts +501 -496
  246. package/src/skill-manager.ts +385 -0
  247. package/src/slash-commands.ts +2189 -1389
  248. package/src/smart-approval.ts +193 -74
  249. package/src/system-prompt-generator.ts +91 -36
  250. package/src/terminal.ts +96 -0
  251. package/src/theme.ts +739 -738
  252. package/src/tools.ts +1790 -931
  253. package/src/truncate.ts +173 -0
  254. package/src/types.ts +337 -198
  255. package/src/update.ts +33 -40
  256. package/src/workflow.ts +521 -508
  257. package/test/cli-launch.test.ts +279 -0
  258. package/tsconfig.json +22 -22
  259. package/vitest.config.ts +21 -19
  260. package/dist/ai-client.d.ts +0 -86
  261. package/dist/ai-client.d.ts.map +0 -1
  262. package/dist/ai-client.js +0 -1372
  263. package/dist/ai-client.js.map +0 -1
  264. package/dist/gui-subagent/operator/browser-operator.d.ts +0 -36
  265. package/dist/gui-subagent/operator/browser-operator.d.ts.map +0 -1
  266. package/dist/gui-subagent/operator/browser-operator.js +0 -306
  267. package/dist/gui-subagent/operator/browser-operator.js.map +0 -1
  268. package/dist/gui-subagent/operator/desktop-operator.d.ts +0 -55
  269. package/dist/gui-subagent/operator/desktop-operator.d.ts.map +0 -1
  270. package/dist/gui-subagent/operator/desktop-operator.js +0 -527
  271. package/dist/gui-subagent/operator/desktop-operator.js.map +0 -1
  272. package/dist/hook.d.ts +0 -73
  273. package/dist/hook.d.ts.map +0 -1
  274. package/dist/hook.js +0 -156
  275. package/dist/hook.js.map +0 -1
  276. package/dist/input-history.d.ts +0 -24
  277. package/dist/input-history.d.ts.map +0 -1
  278. package/dist/input-history.js +0 -94
  279. package/dist/input-history.js.map +0 -1
  280. package/dist/keyboard-manager.d.ts +0 -151
  281. package/dist/keyboard-manager.d.ts.map +0 -1
  282. package/dist/keyboard-manager.js +0 -396
  283. package/dist/keyboard-manager.js.map +0 -1
  284. package/dist/print-system-prompt.d.ts +0 -2
  285. package/dist/print-system-prompt.d.ts.map +0 -1
  286. package/dist/print-system-prompt.js +0 -40
  287. package/dist/print-system-prompt.js.map +0 -1
  288. package/dist/remote-ai-client.d.ts +0 -104
  289. package/dist/remote-ai-client.d.ts.map +0 -1
  290. package/dist/remote-ai-client.js +0 -552
  291. package/dist/remote-ai-client.js.map +0 -1
  292. package/dist/sdk-session-v2.d.ts +0 -13
  293. package/dist/sdk-session-v2.d.ts.map +0 -1
  294. package/dist/sdk-session-v2.js +0 -46
  295. package/dist/sdk-session-v2.js.map +0 -1
  296. package/dist/test-boundary-conditions.d.ts.map +0 -1
  297. package/dist/test-boundary-conditions.js.map +0 -1
  298. package/dist/test-cancellation-fix.d.ts.map +0 -1
  299. package/dist/test-cancellation-fix.js.map +0 -1
  300. package/dist/test-input-history.d.ts.map +0 -1
  301. package/dist/test-input-history.js.map +0 -1
  302. package/dist/test-interaction-flow.d.ts.map +0 -1
  303. package/dist/test-interaction-flow.js.map +0 -1
  304. package/dist/test-quick.d.ts.map +0 -1
  305. package/dist/test-quick.js.map +0 -1
  306. package/dist/test-user-interaction.d.ts.map +0 -1
  307. package/dist/test-user-interaction.js.map +0 -1
  308. package/dist/tools/edit-diff.d.ts +0 -32
  309. package/dist/tools/edit-diff.d.ts.map +0 -1
  310. package/dist/tools/edit-diff.js +0 -185
  311. package/dist/tools/edit-diff.js.map +0 -1
  312. package/dist/tools/edit.d.ts +0 -11
  313. package/dist/tools/edit.d.ts.map +0 -1
  314. package/dist/tools/edit.js +0 -129
  315. package/dist/tools/edit.js.map +0 -1
  316. package/dist/unified-session.d.ts +0 -42
  317. package/dist/unified-session.d.ts.map +0 -1
  318. package/dist/unified-session.js +0 -271
  319. package/dist/unified-session.js.map +0 -1
  320. package/skills/.claude-plugin/marketplace.json +0 -45
  321. package/skills/README.md +0 -94
  322. package/skills/THIRD_PARTY_NOTICES.md +0 -405
  323. package/skills/skills/algorithmic-art/LICENSE.txt +0 -202
  324. package/skills/skills/algorithmic-art/SKILL.md +0 -405
  325. package/skills/skills/algorithmic-art/templates/generator_template.js +0 -223
  326. package/skills/skills/algorithmic-art/templates/viewer.html +0 -599
  327. package/skills/skills/brand-guidelines/LICENSE.txt +0 -202
  328. package/skills/skills/brand-guidelines/SKILL.md +0 -73
  329. package/skills/skills/canvas-design/LICENSE.txt +0 -202
  330. package/skills/skills/canvas-design/SKILL.md +0 -130
  331. package/skills/skills/canvas-design/canvas-fonts/ArsenalSC-OFL.txt +0 -93
  332. package/skills/skills/canvas-design/canvas-fonts/ArsenalSC-Regular.ttf +0 -0
  333. package/skills/skills/canvas-design/canvas-fonts/BigShoulders-Bold.ttf +0 -0
  334. package/skills/skills/canvas-design/canvas-fonts/BigShoulders-OFL.txt +0 -93
  335. package/skills/skills/canvas-design/canvas-fonts/BigShoulders-Regular.ttf +0 -0
  336. package/skills/skills/canvas-design/canvas-fonts/Boldonse-OFL.txt +0 -93
  337. package/skills/skills/canvas-design/canvas-fonts/Boldonse-Regular.ttf +0 -0
  338. package/skills/skills/canvas-design/canvas-fonts/BricolageGrotesque-Bold.ttf +0 -0
  339. package/skills/skills/canvas-design/canvas-fonts/BricolageGrotesque-OFL.txt +0 -93
  340. package/skills/skills/canvas-design/canvas-fonts/BricolageGrotesque-Regular.ttf +0 -0
  341. package/skills/skills/canvas-design/canvas-fonts/CrimsonPro-Bold.ttf +0 -0
  342. package/skills/skills/canvas-design/canvas-fonts/CrimsonPro-Italic.ttf +0 -0
  343. package/skills/skills/canvas-design/canvas-fonts/CrimsonPro-OFL.txt +0 -93
  344. package/skills/skills/canvas-design/canvas-fonts/CrimsonPro-Regular.ttf +0 -0
  345. package/skills/skills/canvas-design/canvas-fonts/DMMono-OFL.txt +0 -93
  346. package/skills/skills/canvas-design/canvas-fonts/DMMono-Regular.ttf +0 -0
  347. package/skills/skills/canvas-design/canvas-fonts/EricaOne-OFL.txt +0 -94
  348. package/skills/skills/canvas-design/canvas-fonts/EricaOne-Regular.ttf +0 -0
  349. package/skills/skills/canvas-design/canvas-fonts/GeistMono-Bold.ttf +0 -0
  350. package/skills/skills/canvas-design/canvas-fonts/GeistMono-OFL.txt +0 -93
  351. package/skills/skills/canvas-design/canvas-fonts/GeistMono-Regular.ttf +0 -0
  352. package/skills/skills/canvas-design/canvas-fonts/Gloock-OFL.txt +0 -93
  353. package/skills/skills/canvas-design/canvas-fonts/Gloock-Regular.ttf +0 -0
  354. package/skills/skills/canvas-design/canvas-fonts/IBMPlexMono-Bold.ttf +0 -0
  355. package/skills/skills/canvas-design/canvas-fonts/IBMPlexMono-OFL.txt +0 -93
  356. package/skills/skills/canvas-design/canvas-fonts/IBMPlexMono-Regular.ttf +0 -0
  357. package/skills/skills/canvas-design/canvas-fonts/IBMPlexSerif-Bold.ttf +0 -0
  358. package/skills/skills/canvas-design/canvas-fonts/IBMPlexSerif-BoldItalic.ttf +0 -0
  359. package/skills/skills/canvas-design/canvas-fonts/IBMPlexSerif-Italic.ttf +0 -0
  360. package/skills/skills/canvas-design/canvas-fonts/IBMPlexSerif-Regular.ttf +0 -0
  361. package/skills/skills/canvas-design/canvas-fonts/InstrumentSans-Bold.ttf +0 -0
  362. package/skills/skills/canvas-design/canvas-fonts/InstrumentSans-BoldItalic.ttf +0 -0
  363. package/skills/skills/canvas-design/canvas-fonts/InstrumentSans-Italic.ttf +0 -0
  364. package/skills/skills/canvas-design/canvas-fonts/InstrumentSans-OFL.txt +0 -93
  365. package/skills/skills/canvas-design/canvas-fonts/InstrumentSans-Regular.ttf +0 -0
  366. package/skills/skills/canvas-design/canvas-fonts/InstrumentSerif-Italic.ttf +0 -0
  367. package/skills/skills/canvas-design/canvas-fonts/InstrumentSerif-Regular.ttf +0 -0
  368. package/skills/skills/canvas-design/canvas-fonts/Italiana-OFL.txt +0 -93
  369. package/skills/skills/canvas-design/canvas-fonts/Italiana-Regular.ttf +0 -0
  370. package/skills/skills/canvas-design/canvas-fonts/JetBrainsMono-Bold.ttf +0 -0
  371. package/skills/skills/canvas-design/canvas-fonts/JetBrainsMono-OFL.txt +0 -93
  372. package/skills/skills/canvas-design/canvas-fonts/JetBrainsMono-Regular.ttf +0 -0
  373. package/skills/skills/canvas-design/canvas-fonts/Jura-Light.ttf +0 -0
  374. package/skills/skills/canvas-design/canvas-fonts/Jura-Medium.ttf +0 -0
  375. package/skills/skills/canvas-design/canvas-fonts/Jura-OFL.txt +0 -93
  376. package/skills/skills/canvas-design/canvas-fonts/LibreBaskerville-OFL.txt +0 -93
  377. package/skills/skills/canvas-design/canvas-fonts/LibreBaskerville-Regular.ttf +0 -0
  378. package/skills/skills/canvas-design/canvas-fonts/Lora-Bold.ttf +0 -0
  379. package/skills/skills/canvas-design/canvas-fonts/Lora-BoldItalic.ttf +0 -0
  380. package/skills/skills/canvas-design/canvas-fonts/Lora-Italic.ttf +0 -0
  381. package/skills/skills/canvas-design/canvas-fonts/Lora-OFL.txt +0 -93
  382. package/skills/skills/canvas-design/canvas-fonts/Lora-Regular.ttf +0 -0
  383. package/skills/skills/canvas-design/canvas-fonts/NationalPark-Bold.ttf +0 -0
  384. package/skills/skills/canvas-design/canvas-fonts/NationalPark-OFL.txt +0 -93
  385. package/skills/skills/canvas-design/canvas-fonts/NationalPark-Regular.ttf +0 -0
  386. package/skills/skills/canvas-design/canvas-fonts/NothingYouCouldDo-OFL.txt +0 -93
  387. package/skills/skills/canvas-design/canvas-fonts/NothingYouCouldDo-Regular.ttf +0 -0
  388. package/skills/skills/canvas-design/canvas-fonts/Outfit-Bold.ttf +0 -0
  389. package/skills/skills/canvas-design/canvas-fonts/Outfit-OFL.txt +0 -93
  390. package/skills/skills/canvas-design/canvas-fonts/Outfit-Regular.ttf +0 -0
  391. package/skills/skills/canvas-design/canvas-fonts/PixelifySans-Medium.ttf +0 -0
  392. package/skills/skills/canvas-design/canvas-fonts/PixelifySans-OFL.txt +0 -93
  393. package/skills/skills/canvas-design/canvas-fonts/PoiretOne-OFL.txt +0 -93
  394. package/skills/skills/canvas-design/canvas-fonts/PoiretOne-Regular.ttf +0 -0
  395. package/skills/skills/canvas-design/canvas-fonts/RedHatMono-Bold.ttf +0 -0
  396. package/skills/skills/canvas-design/canvas-fonts/RedHatMono-OFL.txt +0 -93
  397. package/skills/skills/canvas-design/canvas-fonts/RedHatMono-Regular.ttf +0 -0
  398. package/skills/skills/canvas-design/canvas-fonts/Silkscreen-OFL.txt +0 -93
  399. package/skills/skills/canvas-design/canvas-fonts/Silkscreen-Regular.ttf +0 -0
  400. package/skills/skills/canvas-design/canvas-fonts/SmoochSans-Medium.ttf +0 -0
  401. package/skills/skills/canvas-design/canvas-fonts/SmoochSans-OFL.txt +0 -93
  402. package/skills/skills/canvas-design/canvas-fonts/Tektur-Medium.ttf +0 -0
  403. package/skills/skills/canvas-design/canvas-fonts/Tektur-OFL.txt +0 -93
  404. package/skills/skills/canvas-design/canvas-fonts/Tektur-Regular.ttf +0 -0
  405. package/skills/skills/canvas-design/canvas-fonts/WorkSans-Bold.ttf +0 -0
  406. package/skills/skills/canvas-design/canvas-fonts/WorkSans-BoldItalic.ttf +0 -0
  407. package/skills/skills/canvas-design/canvas-fonts/WorkSans-Italic.ttf +0 -0
  408. package/skills/skills/canvas-design/canvas-fonts/WorkSans-OFL.txt +0 -93
  409. package/skills/skills/canvas-design/canvas-fonts/WorkSans-Regular.ttf +0 -0
  410. package/skills/skills/canvas-design/canvas-fonts/YoungSerif-OFL.txt +0 -93
  411. package/skills/skills/canvas-design/canvas-fonts/YoungSerif-Regular.ttf +0 -0
  412. package/skills/skills/doc-coauthoring/SKILL.md +0 -375
  413. package/skills/skills/docx/LICENSE.txt +0 -30
  414. package/skills/skills/docx/SKILL.md +0 -197
  415. package/skills/skills/docx/docx-js.md +0 -350
  416. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +0 -1499
  417. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +0 -146
  418. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +0 -1085
  419. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +0 -11
  420. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +0 -3081
  421. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +0 -23
  422. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +0 -185
  423. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +0 -287
  424. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +0 -1676
  425. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +0 -28
  426. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +0 -144
  427. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +0 -174
  428. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +0 -25
  429. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +0 -18
  430. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +0 -59
  431. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +0 -56
  432. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +0 -195
  433. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +0 -582
  434. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +0 -25
  435. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +0 -4439
  436. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +0 -570
  437. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +0 -509
  438. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +0 -12
  439. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +0 -108
  440. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +0 -96
  441. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +0 -3646
  442. package/skills/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +0 -116
  443. package/skills/skills/docx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +0 -42
  444. package/skills/skills/docx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +0 -50
  445. package/skills/skills/docx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +0 -49
  446. package/skills/skills/docx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +0 -33
  447. package/skills/skills/docx/ooxml/schemas/mce/mc.xsd +0 -75
  448. package/skills/skills/docx/ooxml/schemas/microsoft/wml-2010.xsd +0 -560
  449. package/skills/skills/docx/ooxml/schemas/microsoft/wml-2012.xsd +0 -67
  450. package/skills/skills/docx/ooxml/schemas/microsoft/wml-2018.xsd +0 -14
  451. package/skills/skills/docx/ooxml/schemas/microsoft/wml-cex-2018.xsd +0 -20
  452. package/skills/skills/docx/ooxml/schemas/microsoft/wml-cid-2016.xsd +0 -13
  453. package/skills/skills/docx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +0 -4
  454. package/skills/skills/docx/ooxml/schemas/microsoft/wml-symex-2015.xsd +0 -8
  455. package/skills/skills/docx/ooxml/scripts/pack.py +0 -159
  456. package/skills/skills/docx/ooxml/scripts/unpack.py +0 -29
  457. package/skills/skills/docx/ooxml/scripts/validate.py +0 -69
  458. package/skills/skills/docx/ooxml/scripts/validation/__init__.py +0 -15
  459. package/skills/skills/docx/ooxml/scripts/validation/base.py +0 -951
  460. package/skills/skills/docx/ooxml/scripts/validation/docx.py +0 -274
  461. package/skills/skills/docx/ooxml/scripts/validation/pptx.py +0 -315
  462. package/skills/skills/docx/ooxml/scripts/validation/redlining.py +0 -279
  463. package/skills/skills/docx/ooxml.md +0 -610
  464. package/skills/skills/docx/scripts/__init__.py +0 -1
  465. package/skills/skills/docx/scripts/document.py +0 -1276
  466. package/skills/skills/docx/scripts/templates/comments.xml +0 -3
  467. package/skills/skills/docx/scripts/templates/commentsExtended.xml +0 -3
  468. package/skills/skills/docx/scripts/templates/commentsExtensible.xml +0 -3
  469. package/skills/skills/docx/scripts/templates/commentsIds.xml +0 -3
  470. package/skills/skills/docx/scripts/templates/people.xml +0 -3
  471. package/skills/skills/docx/scripts/utilities.py +0 -374
  472. package/skills/skills/frontend-design/LICENSE.txt +0 -177
  473. package/skills/skills/frontend-design/SKILL.md +0 -42
  474. package/skills/skills/internal-comms/LICENSE.txt +0 -202
  475. package/skills/skills/internal-comms/SKILL.md +0 -32
  476. package/skills/skills/internal-comms/examples/3p-updates.md +0 -47
  477. package/skills/skills/internal-comms/examples/company-newsletter.md +0 -65
  478. package/skills/skills/internal-comms/examples/faq-answers.md +0 -30
  479. package/skills/skills/internal-comms/examples/general-comms.md +0 -16
  480. package/skills/skills/mcp-builder/LICENSE.txt +0 -202
  481. package/skills/skills/mcp-builder/SKILL.md +0 -236
  482. package/skills/skills/mcp-builder/reference/evaluation.md +0 -602
  483. package/skills/skills/mcp-builder/reference/mcp_best_practices.md +0 -249
  484. package/skills/skills/mcp-builder/reference/node_mcp_server.md +0 -970
  485. package/skills/skills/mcp-builder/reference/python_mcp_server.md +0 -719
  486. package/skills/skills/mcp-builder/scripts/connections.py +0 -151
  487. package/skills/skills/mcp-builder/scripts/evaluation.py +0 -373
  488. package/skills/skills/mcp-builder/scripts/example_evaluation.xml +0 -22
  489. package/skills/skills/mcp-builder/scripts/requirements.txt +0 -2
  490. package/skills/skills/pdf/LICENSE.txt +0 -30
  491. package/skills/skills/pdf/SKILL.md +0 -294
  492. package/skills/skills/pdf/forms.md +0 -205
  493. package/skills/skills/pdf/reference.md +0 -612
  494. package/skills/skills/pdf/scripts/check_bounding_boxes.py +0 -70
  495. package/skills/skills/pdf/scripts/check_bounding_boxes_test.py +0 -226
  496. package/skills/skills/pdf/scripts/check_fillable_fields.py +0 -12
  497. package/skills/skills/pdf/scripts/convert_pdf_to_images.py +0 -35
  498. package/skills/skills/pdf/scripts/create_validation_image.py +0 -41
  499. package/skills/skills/pdf/scripts/extract_form_field_info.py +0 -152
  500. package/skills/skills/pdf/scripts/fill_fillable_fields.py +0 -114
  501. package/skills/skills/pdf/scripts/fill_pdf_form_with_annotations.py +0 -108
  502. package/skills/skills/pptx/LICENSE.txt +0 -30
  503. package/skills/skills/pptx/SKILL.md +0 -484
  504. package/skills/skills/pptx/html2pptx.md +0 -625
  505. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +0 -1499
  506. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +0 -146
  507. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +0 -1085
  508. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +0 -11
  509. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +0 -3081
  510. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +0 -23
  511. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +0 -185
  512. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +0 -287
  513. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +0 -1676
  514. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +0 -28
  515. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +0 -144
  516. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +0 -174
  517. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +0 -25
  518. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +0 -18
  519. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +0 -59
  520. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +0 -56
  521. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +0 -195
  522. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +0 -582
  523. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +0 -25
  524. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +0 -4439
  525. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +0 -570
  526. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +0 -509
  527. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +0 -12
  528. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +0 -108
  529. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +0 -96
  530. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +0 -3646
  531. package/skills/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +0 -116
  532. package/skills/skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +0 -42
  533. package/skills/skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +0 -50
  534. package/skills/skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +0 -49
  535. package/skills/skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +0 -33
  536. package/skills/skills/pptx/ooxml/schemas/mce/mc.xsd +0 -75
  537. package/skills/skills/pptx/ooxml/schemas/microsoft/wml-2010.xsd +0 -560
  538. package/skills/skills/pptx/ooxml/schemas/microsoft/wml-2012.xsd +0 -67
  539. package/skills/skills/pptx/ooxml/schemas/microsoft/wml-2018.xsd +0 -14
  540. package/skills/skills/pptx/ooxml/schemas/microsoft/wml-cex-2018.xsd +0 -20
  541. package/skills/skills/pptx/ooxml/schemas/microsoft/wml-cid-2016.xsd +0 -13
  542. package/skills/skills/pptx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +0 -4
  543. package/skills/skills/pptx/ooxml/schemas/microsoft/wml-symex-2015.xsd +0 -8
  544. package/skills/skills/pptx/ooxml/scripts/pack.py +0 -159
  545. package/skills/skills/pptx/ooxml/scripts/unpack.py +0 -29
  546. package/skills/skills/pptx/ooxml/scripts/validate.py +0 -69
  547. package/skills/skills/pptx/ooxml/scripts/validation/__init__.py +0 -15
  548. package/skills/skills/pptx/ooxml/scripts/validation/base.py +0 -951
  549. package/skills/skills/pptx/ooxml/scripts/validation/docx.py +0 -274
  550. package/skills/skills/pptx/ooxml/scripts/validation/pptx.py +0 -315
  551. package/skills/skills/pptx/ooxml/scripts/validation/redlining.py +0 -279
  552. package/skills/skills/pptx/ooxml.md +0 -427
  553. package/skills/skills/pptx/scripts/html2pptx.js +0 -979
  554. package/skills/skills/pptx/scripts/inventory.py +0 -1020
  555. package/skills/skills/pptx/scripts/rearrange.py +0 -231
  556. package/skills/skills/pptx/scripts/replace.py +0 -385
  557. package/skills/skills/pptx/scripts/thumbnail.py +0 -450
  558. package/skills/skills/skill-creator/LICENSE.txt +0 -202
  559. package/skills/skills/skill-creator/SKILL.md +0 -356
  560. package/skills/skills/skill-creator/references/output-patterns.md +0 -82
  561. package/skills/skills/skill-creator/references/workflows.md +0 -28
  562. package/skills/skills/skill-creator/scripts/init_skill.py +0 -303
  563. package/skills/skills/skill-creator/scripts/package_skill.py +0 -110
  564. package/skills/skills/skill-creator/scripts/quick_validate.py +0 -95
  565. package/skills/skills/slack-gif-creator/LICENSE.txt +0 -202
  566. package/skills/skills/slack-gif-creator/SKILL.md +0 -254
  567. package/skills/skills/slack-gif-creator/core/easing.py +0 -234
  568. package/skills/skills/slack-gif-creator/core/frame_composer.py +0 -176
  569. package/skills/skills/slack-gif-creator/core/gif_builder.py +0 -269
  570. package/skills/skills/slack-gif-creator/core/validators.py +0 -136
  571. package/skills/skills/slack-gif-creator/requirements.txt +0 -4
  572. package/skills/skills/theme-factory/LICENSE.txt +0 -202
  573. package/skills/skills/theme-factory/SKILL.md +0 -59
  574. package/skills/skills/theme-factory/theme-showcase.pdf +0 -0
  575. package/skills/skills/theme-factory/themes/arctic-frost.md +0 -19
  576. package/skills/skills/theme-factory/themes/botanical-garden.md +0 -19
  577. package/skills/skills/theme-factory/themes/desert-rose.md +0 -19
  578. package/skills/skills/theme-factory/themes/forest-canopy.md +0 -19
  579. package/skills/skills/theme-factory/themes/golden-hour.md +0 -19
  580. package/skills/skills/theme-factory/themes/midnight-galaxy.md +0 -19
  581. package/skills/skills/theme-factory/themes/modern-minimalist.md +0 -19
  582. package/skills/skills/theme-factory/themes/ocean-depths.md +0 -19
  583. package/skills/skills/theme-factory/themes/sunset-boulevard.md +0 -19
  584. package/skills/skills/theme-factory/themes/tech-innovation.md +0 -19
  585. package/skills/skills/web-artifacts-builder/LICENSE.txt +0 -202
  586. package/skills/skills/web-artifacts-builder/SKILL.md +0 -74
  587. package/skills/skills/web-artifacts-builder/scripts/bundle-artifact.sh +0 -54
  588. package/skills/skills/web-artifacts-builder/scripts/init-artifact.sh +0 -322
  589. package/skills/skills/webapp-testing/LICENSE.txt +0 -202
  590. package/skills/skills/webapp-testing/SKILL.md +0 -96
  591. package/skills/skills/webapp-testing/examples/console_logging.py +0 -35
  592. package/skills/skills/webapp-testing/examples/element_discovery.py +0 -40
  593. package/skills/skills/webapp-testing/examples/static_html_automation.py +0 -33
  594. package/skills/skills/webapp-testing/scripts/with_server.py +0 -106
  595. package/skills/skills/xlsx/LICENSE.txt +0 -30
  596. package/skills/skills/xlsx/SKILL.md +0 -289
  597. package/skills/skills/xlsx/recalc.py +0 -178
  598. package/skills/spec/agent-skills-spec.md +0 -3
  599. package/skills/template/SKILL.md +0 -6
  600. package/src/ai-client.ts +0 -1560
  601. package/src/remote-ai-client.ts +0 -664
  602. /package/{.eslintrc.js → .eslintrc.cjs} +0 -0
@@ -1,610 +0,0 @@
1
- # Office Open XML Technical Reference
2
-
3
- **Important: Read this entire document before starting.** This document covers:
4
- - [Technical Guidelines](#technical-guidelines) - Schema compliance rules and validation requirements
5
- - [Document Content Patterns](#document-content-patterns) - XML patterns for headings, lists, tables, formatting, etc.
6
- - [Document Library (Python)](#document-library-python) - Recommended approach for OOXML manipulation with automatic infrastructure setup
7
- - [Tracked Changes (Redlining)](#tracked-changes-redlining) - XML patterns for implementing tracked changes
8
-
9
- ## Technical Guidelines
10
-
11
- ### Schema Compliance
12
- - **Element ordering in `<w:pPr>`**: `<w:pStyle>`, `<w:numPr>`, `<w:spacing>`, `<w:ind>`, `<w:jc>`
13
- - **Whitespace**: Add `xml:space='preserve'` to `<w:t>` elements with leading/trailing spaces
14
- - **Unicode**: Escape characters in ASCII content: `"` becomes `&#8220;`
15
- - **Character encoding reference**: Curly quotes `""` become `&#8220;&#8221;`, apostrophe `'` becomes `&#8217;`, em-dash `—` becomes `&#8212;`
16
- - **Tracked changes**: Use `<w:del>` and `<w:ins>` tags with `w:author="Claude"` outside `<w:r>` elements
17
- - **Critical**: `<w:ins>` closes with `</w:ins>`, `<w:del>` closes with `</w:del>` - never mix
18
- - **RSIDs must be 8-digit hex**: Use values like `00AB1234` (only 0-9, A-F characters)
19
- - **trackRevisions placement**: Add `<w:trackRevisions/>` after `<w:proofState>` in settings.xml
20
- - **Images**: Add to `word/media/`, reference in `document.xml`, set dimensions to prevent overflow
21
-
22
- ## Document Content Patterns
23
-
24
- ### Basic Structure
25
- ```xml
26
- <w:p>
27
- <w:r><w:t>Text content</w:t></w:r>
28
- </w:p>
29
- ```
30
-
31
- ### Headings and Styles
32
- ```xml
33
- <w:p>
34
- <w:pPr>
35
- <w:pStyle w:val="Title"/>
36
- <w:jc w:val="center"/>
37
- </w:pPr>
38
- <w:r><w:t>Document Title</w:t></w:r>
39
- </w:p>
40
-
41
- <w:p>
42
- <w:pPr><w:pStyle w:val="Heading2"/></w:pPr>
43
- <w:r><w:t>Section Heading</w:t></w:r>
44
- </w:p>
45
- ```
46
-
47
- ### Text Formatting
48
- ```xml
49
- <!-- Bold -->
50
- <w:r><w:rPr><w:b/><w:bCs/></w:rPr><w:t>Bold</w:t></w:r>
51
- <!-- Italic -->
52
- <w:r><w:rPr><w:i/><w:iCs/></w:rPr><w:t>Italic</w:t></w:r>
53
- <!-- Underline -->
54
- <w:r><w:rPr><w:u w:val="single"/></w:rPr><w:t>Underlined</w:t></w:r>
55
- <!-- Highlight -->
56
- <w:r><w:rPr><w:highlight w:val="yellow"/></w:rPr><w:t>Highlighted</w:t></w:r>
57
- ```
58
-
59
- ### Lists
60
- ```xml
61
- <!-- Numbered list -->
62
- <w:p>
63
- <w:pPr>
64
- <w:pStyle w:val="ListParagraph"/>
65
- <w:numPr><w:ilvl w:val="0"/><w:numId w:val="1"/></w:numPr>
66
- <w:spacing w:before="240"/>
67
- </w:pPr>
68
- <w:r><w:t>First item</w:t></w:r>
69
- </w:p>
70
-
71
- <!-- Restart numbered list at 1 - use different numId -->
72
- <w:p>
73
- <w:pPr>
74
- <w:pStyle w:val="ListParagraph"/>
75
- <w:numPr><w:ilvl w:val="0"/><w:numId w:val="2"/></w:numPr>
76
- <w:spacing w:before="240"/>
77
- </w:pPr>
78
- <w:r><w:t>New list item 1</w:t></w:r>
79
- </w:p>
80
-
81
- <!-- Bullet list (level 2) -->
82
- <w:p>
83
- <w:pPr>
84
- <w:pStyle w:val="ListParagraph"/>
85
- <w:numPr><w:ilvl w:val="1"/><w:numId w:val="1"/></w:numPr>
86
- <w:spacing w:before="240"/>
87
- <w:ind w:left="900"/>
88
- </w:pPr>
89
- <w:r><w:t>Bullet item</w:t></w:r>
90
- </w:p>
91
- ```
92
-
93
- ### Tables
94
- ```xml
95
- <w:tbl>
96
- <w:tblPr>
97
- <w:tblStyle w:val="TableGrid"/>
98
- <w:tblW w:w="0" w:type="auto"/>
99
- </w:tblPr>
100
- <w:tblGrid>
101
- <w:gridCol w:w="4675"/><w:gridCol w:w="4675"/>
102
- </w:tblGrid>
103
- <w:tr>
104
- <w:tc>
105
- <w:tcPr><w:tcW w:w="4675" w:type="dxa"/></w:tcPr>
106
- <w:p><w:r><w:t>Cell 1</w:t></w:r></w:p>
107
- </w:tc>
108
- <w:tc>
109
- <w:tcPr><w:tcW w:w="4675" w:type="dxa"/></w:tcPr>
110
- <w:p><w:r><w:t>Cell 2</w:t></w:r></w:p>
111
- </w:tc>
112
- </w:tr>
113
- </w:tbl>
114
- ```
115
-
116
- ### Layout
117
- ```xml
118
- <!-- Page break before new section (common pattern) -->
119
- <w:p>
120
- <w:r>
121
- <w:br w:type="page"/>
122
- </w:r>
123
- </w:p>
124
- <w:p>
125
- <w:pPr>
126
- <w:pStyle w:val="Heading1"/>
127
- </w:pPr>
128
- <w:r>
129
- <w:t>New Section Title</w:t>
130
- </w:r>
131
- </w:p>
132
-
133
- <!-- Centered paragraph -->
134
- <w:p>
135
- <w:pPr>
136
- <w:spacing w:before="240" w:after="0"/>
137
- <w:jc w:val="center"/>
138
- </w:pPr>
139
- <w:r><w:t>Centered text</w:t></w:r>
140
- </w:p>
141
-
142
- <!-- Font change - paragraph level (applies to all runs) -->
143
- <w:p>
144
- <w:pPr>
145
- <w:rPr><w:rFonts w:ascii="Courier New" w:hAnsi="Courier New"/></w:rPr>
146
- </w:pPr>
147
- <w:r><w:t>Monospace text</w:t></w:r>
148
- </w:p>
149
-
150
- <!-- Font change - run level (specific to this text) -->
151
- <w:p>
152
- <w:r>
153
- <w:rPr><w:rFonts w:ascii="Courier New" w:hAnsi="Courier New"/></w:rPr>
154
- <w:t>This text is Courier New</w:t>
155
- </w:r>
156
- <w:r><w:t> and this text uses default font</w:t></w:r>
157
- </w:p>
158
- ```
159
-
160
- ## File Updates
161
-
162
- When adding content, update these files:
163
-
164
- **`word/_rels/document.xml.rels`:**
165
- ```xml
166
- <Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering" Target="numbering.xml"/>
167
- <Relationship Id="rId5" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" Target="media/image1.png"/>
168
- ```
169
-
170
- **`[Content_Types].xml`:**
171
- ```xml
172
- <Default Extension="png" ContentType="image/png"/>
173
- <Override PartName="/word/numbering.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.numbering+xml"/>
174
- ```
175
-
176
- ### Images
177
- **CRITICAL**: Calculate dimensions to prevent page overflow and maintain aspect ratio.
178
-
179
- ```xml
180
- <!-- Minimal required structure -->
181
- <w:p>
182
- <w:r>
183
- <w:drawing>
184
- <wp:inline>
185
- <wp:extent cx="2743200" cy="1828800"/>
186
- <wp:docPr id="1" name="Picture 1"/>
187
- <a:graphic xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main">
188
- <a:graphicData uri="http://schemas.openxmlformats.org/drawingml/2006/picture">
189
- <pic:pic xmlns:pic="http://schemas.openxmlformats.org/drawingml/2006/picture">
190
- <pic:nvPicPr>
191
- <pic:cNvPr id="0" name="image1.png"/>
192
- <pic:cNvPicPr/>
193
- </pic:nvPicPr>
194
- <pic:blipFill>
195
- <a:blip r:embed="rId5"/>
196
- <!-- Add for stretch fill with aspect ratio preservation -->
197
- <a:stretch>
198
- <a:fillRect/>
199
- </a:stretch>
200
- </pic:blipFill>
201
- <pic:spPr>
202
- <a:xfrm>
203
- <a:ext cx="2743200" cy="1828800"/>
204
- </a:xfrm>
205
- <a:prstGeom prst="rect"/>
206
- </pic:spPr>
207
- </pic:pic>
208
- </a:graphicData>
209
- </a:graphic>
210
- </wp:inline>
211
- </w:drawing>
212
- </w:r>
213
- </w:p>
214
- ```
215
-
216
- ### Links (Hyperlinks)
217
-
218
- **IMPORTANT**: All hyperlinks (both internal and external) require the Hyperlink style to be defined in styles.xml. Without this style, links will look like regular text instead of blue underlined clickable links.
219
-
220
- **External Links:**
221
- ```xml
222
- <!-- In document.xml -->
223
- <w:hyperlink r:id="rId5">
224
- <w:r>
225
- <w:rPr><w:rStyle w:val="Hyperlink"/></w:rPr>
226
- <w:t>Link Text</w:t>
227
- </w:r>
228
- </w:hyperlink>
229
-
230
- <!-- In word/_rels/document.xml.rels -->
231
- <Relationship Id="rId5" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"
232
- Target="https://www.example.com/" TargetMode="External"/>
233
- ```
234
-
235
- **Internal Links:**
236
-
237
- ```xml
238
- <!-- Link to bookmark -->
239
- <w:hyperlink w:anchor="myBookmark">
240
- <w:r>
241
- <w:rPr><w:rStyle w:val="Hyperlink"/></w:rPr>
242
- <w:t>Link Text</w:t>
243
- </w:r>
244
- </w:hyperlink>
245
-
246
- <!-- Bookmark target -->
247
- <w:bookmarkStart w:id="0" w:name="myBookmark"/>
248
- <w:r><w:t>Target content</w:t></w:r>
249
- <w:bookmarkEnd w:id="0"/>
250
- ```
251
-
252
- **Hyperlink Style (required in styles.xml):**
253
- ```xml
254
- <w:style w:type="character" w:styleId="Hyperlink">
255
- <w:name w:val="Hyperlink"/>
256
- <w:basedOn w:val="DefaultParagraphFont"/>
257
- <w:uiPriority w:val="99"/>
258
- <w:unhideWhenUsed/>
259
- <w:rPr>
260
- <w:color w:val="467886" w:themeColor="hyperlink"/>
261
- <w:u w:val="single"/>
262
- </w:rPr>
263
- </w:style>
264
- ```
265
-
266
- ## Document Library (Python)
267
-
268
- Use the Document class from `scripts/document.py` for all tracked changes and comments. It automatically handles infrastructure setup (people.xml, RSIDs, settings.xml, comment files, relationships, content types). Only use direct XML manipulation for complex scenarios not supported by the library.
269
-
270
- **Working with Unicode and Entities:**
271
- - **Searching**: Both entity notation and Unicode characters work - `contains="&#8220;Company"` and `contains="\u201cCompany"` find the same text
272
- - **Replacing**: Use either entities (`&#8220;`) or Unicode (`\u201c`) - both work and will be converted appropriately based on the file's encoding (ascii → entities, utf-8 → Unicode)
273
-
274
- ### Initialization
275
-
276
- **Find the docx skill root** (directory containing `scripts/` and `ooxml/`):
277
- ```bash
278
- # Search for document.py to locate the skill root
279
- # Note: /mnt/skills is used here as an example; check your context for the actual location
280
- find /mnt/skills -name "document.py" -path "*/docx/scripts/*" 2>/dev/null | head -1
281
- # Example output: /mnt/skills/docx/scripts/document.py
282
- # Skill root is: /mnt/skills/docx
283
- ```
284
-
285
- **Run your script with PYTHONPATH** set to the docx skill root:
286
- ```bash
287
- PYTHONPATH=/mnt/skills/docx python your_script.py
288
- ```
289
-
290
- **In your script**, import from the skill root:
291
- ```python
292
- from scripts.document import Document, DocxXMLEditor
293
-
294
- # Basic initialization (automatically creates temp copy and sets up infrastructure)
295
- doc = Document('unpacked')
296
-
297
- # Customize author and initials
298
- doc = Document('unpacked', author="John Doe", initials="JD")
299
-
300
- # Enable track revisions mode
301
- doc = Document('unpacked', track_revisions=True)
302
-
303
- # Specify custom RSID (auto-generated if not provided)
304
- doc = Document('unpacked', rsid="07DC5ECB")
305
- ```
306
-
307
- ### Creating Tracked Changes
308
-
309
- **CRITICAL**: Only mark text that actually changes. Keep ALL unchanged text outside `<w:del>`/`<w:ins>` tags. Marking unchanged text makes edits unprofessional and harder to review.
310
-
311
- **Attribute Handling**: The Document class auto-injects attributes (w:id, w:date, w:rsidR, w:rsidDel, w16du:dateUtc, xml:space) into new elements. When preserving unchanged text from the original document, copy the original `<w:r>` element with its existing attributes to maintain document integrity.
312
-
313
- **Method Selection Guide**:
314
- - **Adding your own changes to regular text**: Use `replace_node()` with `<w:del>`/`<w:ins>` tags, or `suggest_deletion()` for removing entire `<w:r>` or `<w:p>` elements
315
- - **Partially modifying another author's tracked change**: Use `replace_node()` to nest your changes inside their `<w:ins>`/`<w:del>`
316
- - **Completely rejecting another author's insertion**: Use `revert_insertion()` on the `<w:ins>` element (NOT `suggest_deletion()`)
317
- - **Completely rejecting another author's deletion**: Use `revert_deletion()` on the `<w:del>` element to restore deleted content using tracked changes
318
-
319
- ```python
320
- # Minimal edit - change one word: "The report is monthly" → "The report is quarterly"
321
- # Original: <w:r w:rsidR="00AB12CD"><w:rPr><w:rFonts w:ascii="Calibri"/></w:rPr><w:t>The report is monthly</w:t></w:r>
322
- node = doc["word/document.xml"].get_node(tag="w:r", contains="The report is monthly")
323
- rpr = tags[0].toxml() if (tags := node.getElementsByTagName("w:rPr")) else ""
324
- replacement = f'<w:r w:rsidR="00AB12CD">{rpr}<w:t>The report is </w:t></w:r><w:del><w:r>{rpr}<w:delText>monthly</w:delText></w:r></w:del><w:ins><w:r>{rpr}<w:t>quarterly</w:t></w:r></w:ins>'
325
- doc["word/document.xml"].replace_node(node, replacement)
326
-
327
- # Minimal edit - change number: "within 30 days" → "within 45 days"
328
- # Original: <w:r w:rsidR="00XYZ789"><w:rPr><w:rFonts w:ascii="Calibri"/></w:rPr><w:t>within 30 days</w:t></w:r>
329
- node = doc["word/document.xml"].get_node(tag="w:r", contains="within 30 days")
330
- rpr = tags[0].toxml() if (tags := node.getElementsByTagName("w:rPr")) else ""
331
- replacement = f'<w:r w:rsidR="00XYZ789">{rpr}<w:t>within </w:t></w:r><w:del><w:r>{rpr}<w:delText>30</w:delText></w:r></w:del><w:ins><w:r>{rpr}<w:t>45</w:t></w:r></w:ins><w:r w:rsidR="00XYZ789">{rpr}<w:t> days</w:t></w:r>'
332
- doc["word/document.xml"].replace_node(node, replacement)
333
-
334
- # Complete replacement - preserve formatting even when replacing all text
335
- node = doc["word/document.xml"].get_node(tag="w:r", contains="apple")
336
- rpr = tags[0].toxml() if (tags := node.getElementsByTagName("w:rPr")) else ""
337
- replacement = f'<w:del><w:r>{rpr}<w:delText>apple</w:delText></w:r></w:del><w:ins><w:r>{rpr}<w:t>banana orange</w:t></w:r></w:ins>'
338
- doc["word/document.xml"].replace_node(node, replacement)
339
-
340
- # Insert new content (no attributes needed - auto-injected)
341
- node = doc["word/document.xml"].get_node(tag="w:r", contains="existing text")
342
- doc["word/document.xml"].insert_after(node, '<w:ins><w:r><w:t>new text</w:t></w:r></w:ins>')
343
-
344
- # Partially delete another author's insertion
345
- # Original: <w:ins w:author="Jane Smith" w:date="..."><w:r><w:t>quarterly financial report</w:t></w:r></w:ins>
346
- # Goal: Delete only "financial" to make it "quarterly report"
347
- node = doc["word/document.xml"].get_node(tag="w:ins", attrs={"w:id": "5"})
348
- # IMPORTANT: Preserve w:author="Jane Smith" on the outer <w:ins> to maintain authorship
349
- replacement = '''<w:ins w:author="Jane Smith" w:date="2025-01-15T10:00:00Z">
350
- <w:r><w:t>quarterly </w:t></w:r>
351
- <w:del><w:r><w:delText>financial </w:delText></w:r></w:del>
352
- <w:r><w:t>report</w:t></w:r>
353
- </w:ins>'''
354
- doc["word/document.xml"].replace_node(node, replacement)
355
-
356
- # Change part of another author's insertion
357
- # Original: <w:ins w:author="Jane Smith"><w:r><w:t>in silence, safe and sound</w:t></w:r></w:ins>
358
- # Goal: Change "safe and sound" to "soft and unbound"
359
- node = doc["word/document.xml"].get_node(tag="w:ins", attrs={"w:id": "8"})
360
- replacement = f'''<w:ins w:author="Jane Smith" w:date="2025-01-15T10:00:00Z">
361
- <w:r><w:t>in silence, </w:t></w:r>
362
- </w:ins>
363
- <w:ins>
364
- <w:r><w:t>soft and unbound</w:t></w:r>
365
- </w:ins>
366
- <w:ins w:author="Jane Smith" w:date="2025-01-15T10:00:00Z">
367
- <w:del><w:r><w:delText>safe and sound</w:delText></w:r></w:del>
368
- </w:ins>'''
369
- doc["word/document.xml"].replace_node(node, replacement)
370
-
371
- # Delete entire run (use only when deleting all content; use replace_node for partial deletions)
372
- node = doc["word/document.xml"].get_node(tag="w:r", contains="text to delete")
373
- doc["word/document.xml"].suggest_deletion(node)
374
-
375
- # Delete entire paragraph (in-place, handles both regular and numbered list paragraphs)
376
- para = doc["word/document.xml"].get_node(tag="w:p", contains="paragraph to delete")
377
- doc["word/document.xml"].suggest_deletion(para)
378
-
379
- # Add new numbered list item
380
- target_para = doc["word/document.xml"].get_node(tag="w:p", contains="existing list item")
381
- pPr = tags[0].toxml() if (tags := target_para.getElementsByTagName("w:pPr")) else ""
382
- new_item = f'<w:p>{pPr}<w:r><w:t>New item</w:t></w:r></w:p>'
383
- tracked_para = DocxXMLEditor.suggest_paragraph(new_item)
384
- doc["word/document.xml"].insert_after(target_para, tracked_para)
385
- # Optional: add spacing paragraph before content for better visual separation
386
- # spacing = DocxXMLEditor.suggest_paragraph('<w:p><w:pPr><w:pStyle w:val="ListParagraph"/></w:pPr></w:p>')
387
- # doc["word/document.xml"].insert_after(target_para, spacing + tracked_para)
388
- ```
389
-
390
- ### Adding Comments
391
-
392
- ```python
393
- # Add comment spanning two existing tracked changes
394
- # Note: w:id is auto-generated. Only search by w:id if you know it from XML inspection
395
- start_node = doc["word/document.xml"].get_node(tag="w:del", attrs={"w:id": "1"})
396
- end_node = doc["word/document.xml"].get_node(tag="w:ins", attrs={"w:id": "2"})
397
- doc.add_comment(start=start_node, end=end_node, text="Explanation of this change")
398
-
399
- # Add comment on a paragraph
400
- para = doc["word/document.xml"].get_node(tag="w:p", contains="paragraph text")
401
- doc.add_comment(start=para, end=para, text="Comment on this paragraph")
402
-
403
- # Add comment on newly created tracked change
404
- # First create the tracked change
405
- node = doc["word/document.xml"].get_node(tag="w:r", contains="old")
406
- new_nodes = doc["word/document.xml"].replace_node(
407
- node,
408
- '<w:del><w:r><w:delText>old</w:delText></w:r></w:del><w:ins><w:r><w:t>new</w:t></w:r></w:ins>'
409
- )
410
- # Then add comment on the newly created elements
411
- # new_nodes[0] is the <w:del>, new_nodes[1] is the <w:ins>
412
- doc.add_comment(start=new_nodes[0], end=new_nodes[1], text="Changed old to new per requirements")
413
-
414
- # Reply to existing comment
415
- doc.reply_to_comment(parent_comment_id=0, text="I agree with this change")
416
- ```
417
-
418
- ### Rejecting Tracked Changes
419
-
420
- **IMPORTANT**: Use `revert_insertion()` to reject insertions and `revert_deletion()` to restore deletions using tracked changes. Use `suggest_deletion()` only for regular unmarked content.
421
-
422
- ```python
423
- # Reject insertion (wraps it in deletion)
424
- # Use this when another author inserted text that you want to delete
425
- ins = doc["word/document.xml"].get_node(tag="w:ins", attrs={"w:id": "5"})
426
- nodes = doc["word/document.xml"].revert_insertion(ins) # Returns [ins]
427
-
428
- # Reject deletion (creates insertion to restore deleted content)
429
- # Use this when another author deleted text that you want to restore
430
- del_elem = doc["word/document.xml"].get_node(tag="w:del", attrs={"w:id": "3"})
431
- nodes = doc["word/document.xml"].revert_deletion(del_elem) # Returns [del_elem, new_ins]
432
-
433
- # Reject all insertions in a paragraph
434
- para = doc["word/document.xml"].get_node(tag="w:p", contains="paragraph text")
435
- nodes = doc["word/document.xml"].revert_insertion(para) # Returns [para]
436
-
437
- # Reject all deletions in a paragraph
438
- para = doc["word/document.xml"].get_node(tag="w:p", contains="paragraph text")
439
- nodes = doc["word/document.xml"].revert_deletion(para) # Returns [para]
440
- ```
441
-
442
- ### Inserting Images
443
-
444
- **CRITICAL**: The Document class works with a temporary copy at `doc.unpacked_path`. Always copy images to this temp directory, not the original unpacked folder.
445
-
446
- ```python
447
- from PIL import Image
448
- import shutil, os
449
-
450
- # Initialize document first
451
- doc = Document('unpacked')
452
-
453
- # Copy image and calculate full-width dimensions with aspect ratio
454
- media_dir = os.path.join(doc.unpacked_path, 'word/media')
455
- os.makedirs(media_dir, exist_ok=True)
456
- shutil.copy('image.png', os.path.join(media_dir, 'image1.png'))
457
- img = Image.open(os.path.join(media_dir, 'image1.png'))
458
- width_emus = int(6.5 * 914400) # 6.5" usable width, 914400 EMUs/inch
459
- height_emus = int(width_emus * img.size[1] / img.size[0])
460
-
461
- # Add relationship and content type
462
- rels_editor = doc['word/_rels/document.xml.rels']
463
- next_rid = rels_editor.get_next_rid()
464
- rels_editor.append_to(rels_editor.dom.documentElement,
465
- f'<Relationship Id="{next_rid}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" Target="media/image1.png"/>')
466
- doc['[Content_Types].xml'].append_to(doc['[Content_Types].xml'].dom.documentElement,
467
- '<Default Extension="png" ContentType="image/png"/>')
468
-
469
- # Insert image
470
- node = doc["word/document.xml"].get_node(tag="w:p", line_number=100)
471
- doc["word/document.xml"].insert_after(node, f'''<w:p>
472
- <w:r>
473
- <w:drawing>
474
- <wp:inline distT="0" distB="0" distL="0" distR="0">
475
- <wp:extent cx="{width_emus}" cy="{height_emus}"/>
476
- <wp:docPr id="1" name="Picture 1"/>
477
- <a:graphic xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main">
478
- <a:graphicData uri="http://schemas.openxmlformats.org/drawingml/2006/picture">
479
- <pic:pic xmlns:pic="http://schemas.openxmlformats.org/drawingml/2006/picture">
480
- <pic:nvPicPr><pic:cNvPr id="1" name="image1.png"/><pic:cNvPicPr/></pic:nvPicPr>
481
- <pic:blipFill><a:blip r:embed="{next_rid}"/><a:stretch><a:fillRect/></a:stretch></pic:blipFill>
482
- <pic:spPr><a:xfrm><a:ext cx="{width_emus}" cy="{height_emus}"/></a:xfrm><a:prstGeom prst="rect"><a:avLst/></a:prstGeom></pic:spPr>
483
- </pic:pic>
484
- </a:graphicData>
485
- </a:graphic>
486
- </wp:inline>
487
- </w:drawing>
488
- </w:r>
489
- </w:p>''')
490
- ```
491
-
492
- ### Getting Nodes
493
-
494
- ```python
495
- # By text content
496
- node = doc["word/document.xml"].get_node(tag="w:p", contains="specific text")
497
-
498
- # By line range
499
- para = doc["word/document.xml"].get_node(tag="w:p", line_number=range(100, 150))
500
-
501
- # By attributes
502
- node = doc["word/document.xml"].get_node(tag="w:del", attrs={"w:id": "1"})
503
-
504
- # By exact line number (must be line number where tag opens)
505
- para = doc["word/document.xml"].get_node(tag="w:p", line_number=42)
506
-
507
- # Combine filters
508
- node = doc["word/document.xml"].get_node(tag="w:r", line_number=range(40, 60), contains="text")
509
-
510
- # Disambiguate when text appears multiple times - add line_number range
511
- node = doc["word/document.xml"].get_node(tag="w:r", contains="Section", line_number=range(2400, 2500))
512
- ```
513
-
514
- ### Saving
515
-
516
- ```python
517
- # Save with automatic validation (copies back to original directory)
518
- doc.save() # Validates by default, raises error if validation fails
519
-
520
- # Save to different location
521
- doc.save('modified-unpacked')
522
-
523
- # Skip validation (debugging only - needing this in production indicates XML issues)
524
- doc.save(validate=False)
525
- ```
526
-
527
- ### Direct DOM Manipulation
528
-
529
- For complex scenarios not covered by the library:
530
-
531
- ```python
532
- # Access any XML file
533
- editor = doc["word/document.xml"]
534
- editor = doc["word/comments.xml"]
535
-
536
- # Direct DOM access (defusedxml.minidom.Document)
537
- node = doc["word/document.xml"].get_node(tag="w:p", line_number=5)
538
- parent = node.parentNode
539
- parent.removeChild(node)
540
- parent.appendChild(node) # Move to end
541
-
542
- # General document manipulation (without tracked changes)
543
- old_node = doc["word/document.xml"].get_node(tag="w:p", contains="original text")
544
- doc["word/document.xml"].replace_node(old_node, "<w:p><w:r><w:t>replacement text</w:t></w:r></w:p>")
545
-
546
- # Multiple insertions - use return value to maintain order
547
- node = doc["word/document.xml"].get_node(tag="w:r", line_number=100)
548
- nodes = doc["word/document.xml"].insert_after(node, "<w:r><w:t>A</w:t></w:r>")
549
- nodes = doc["word/document.xml"].insert_after(nodes[-1], "<w:r><w:t>B</w:t></w:r>")
550
- nodes = doc["word/document.xml"].insert_after(nodes[-1], "<w:r><w:t>C</w:t></w:r>")
551
- # Results in: original_node, A, B, C
552
- ```
553
-
554
- ## Tracked Changes (Redlining)
555
-
556
- **Use the Document class above for all tracked changes.** The patterns below are for reference when constructing replacement XML strings.
557
-
558
- ### Validation Rules
559
- The validator checks that the document text matches the original after reverting Claude's changes. This means:
560
- - **NEVER modify text inside another author's `<w:ins>` or `<w:del>` tags**
561
- - **ALWAYS use nested deletions** to remove another author's insertions
562
- - **Every edit must be properly tracked** with `<w:ins>` or `<w:del>` tags
563
-
564
- ### Tracked Change Patterns
565
-
566
- **CRITICAL RULES**:
567
- 1. Never modify the content inside another author's tracked changes. Always use nested deletions.
568
- 2. **XML Structure**: Always place `<w:del>` and `<w:ins>` at paragraph level containing complete `<w:r>` elements. Never nest inside `<w:r>` elements - this creates invalid XML that breaks document processing.
569
-
570
- **Text Insertion:**
571
- ```xml
572
- <w:ins w:id="1" w:author="Claude" w:date="2025-07-30T23:05:00Z" w16du:dateUtc="2025-07-31T06:05:00Z">
573
- <w:r w:rsidR="00792858">
574
- <w:t>inserted text</w:t>
575
- </w:r>
576
- </w:ins>
577
- ```
578
-
579
- **Text Deletion:**
580
- ```xml
581
- <w:del w:id="2" w:author="Claude" w:date="2025-07-30T23:05:00Z" w16du:dateUtc="2025-07-31T06:05:00Z">
582
- <w:r w:rsidDel="00792858">
583
- <w:delText>deleted text</w:delText>
584
- </w:r>
585
- </w:del>
586
- ```
587
-
588
- **Deleting Another Author's Insertion (MUST use nested structure):**
589
- ```xml
590
- <!-- Nest deletion inside the original insertion -->
591
- <w:ins w:author="Jane Smith" w:id="16">
592
- <w:del w:author="Claude" w:id="40">
593
- <w:r><w:delText>monthly</w:delText></w:r>
594
- </w:del>
595
- </w:ins>
596
- <w:ins w:author="Claude" w:id="41">
597
- <w:r><w:t>weekly</w:t></w:r>
598
- </w:ins>
599
- ```
600
-
601
- **Restoring Another Author's Deletion:**
602
- ```xml
603
- <!-- Leave their deletion unchanged, add new insertion after it -->
604
- <w:del w:author="Jane Smith" w:id="50">
605
- <w:r><w:delText>within 30 days</w:delText></w:r>
606
- </w:del>
607
- <w:ins w:author="Claude" w:id="51">
608
- <w:r><w:t>within 30 days</w:t></w:r>
609
- </w:ins>
610
- ```
@@ -1 +0,0 @@
1
- # Make scripts directory a package for relative imports in tests