@agenthippo-ai/agenthippo 1.110.11 → 1.110.19

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 (534) hide show
  1. package/out/agentpack/types.js +2 -5
  2. package/out/analytics/dashboard/artifactManager.js +2 -439
  3. package/out/analytics/dashboard/fleetDisplayUtils.js +2 -162
  4. package/out/analytics/dashboard/fleetOrchestrator.js +3 -142
  5. package/out/analytics/dashboard/fleetRegistry.js +2 -79
  6. package/out/analytics/dashboard/fleetRowDefaults.js +2 -87
  7. package/out/analytics/dashboard/fleetScriptAdapter.js +2 -146
  8. package/out/analytics/dashboard/fleetTypes.js +2 -29
  9. package/out/analytics/dashboard/index.js +2 -17
  10. package/out/analytics/dashboard/indexingService.js +2 -422
  11. package/out/analytics/dashboard/localFleetAdapter.js +2 -302
  12. package/out/analytics/dashboard/performanceMonitor.js +5 -76
  13. package/out/analytics/dashboard/processManager.js +2 -209
  14. package/out/analytics/dashboard/provider.js +38 -3817
  15. package/out/analytics/dashboard/queryRunner.js +62 -750
  16. package/out/analytics/dashboard/scheduledFleetStorage.js +2 -241
  17. package/out/analytics/dashboard/sessionJsonlFleet.js +3 -204
  18. package/out/analytics/dashboard/teamViewDiscovery.js +2 -106
  19. package/out/analytics/dashboard/webview/panel.js +34 -2318
  20. package/out/analytics/dashboard/webview/runtime-bridge.js +2 -82
  21. package/out/analytics/lifecycle.js +2 -43
  22. package/out/analytics/service.js +8 -1283
  23. package/out/auth/authBaseUrl.js +2 -59
  24. package/out/auth/bootstrapApply.js +2 -71
  25. package/out/auth/brokerClient.js +2 -160
  26. package/out/auth/callbackUri.js +2 -59
  27. package/out/auth/githubStoreGate.js +2 -70
  28. package/out/auth/loopbackAuthServer.js +4 -159
  29. package/out/auth/onboardingPrompt.js +2 -112
  30. package/out/auth/pkce.js +2 -9
  31. package/out/auth/provider.js +2 -226
  32. package/out/auth/sessionStore.js +2 -156
  33. package/out/auth/signInFlow.js +2 -183
  34. package/out/cli/index.js +617 -564
  35. package/out/cli/run-custom-engine-runner.js +3 -318
  36. package/out/cli/vscode-shim.js +2 -86
  37. package/out/engines/factory.js +2 -45
  38. package/out/engines/types.js +2 -17
  39. package/out/examples/run-headless-repl.js +6 -286
  40. package/out/examples/run-headless.js +2 -187
  41. package/out/extension.js +32 -4473
  42. package/out/gateway/gatewayRouteIndex.js +6 -371
  43. package/out/gateway/gatewaySessionStore.js +3 -243
  44. package/out/gateway/index.js +2 -31
  45. package/out/gateway/resetMappings.js +2 -52
  46. package/out/gateway/service.js +5 -1249
  47. package/out/mcp/publish.js +2 -143
  48. package/out/remote/handleRemoteChat.js +2 -169
  49. package/out/remote/remotePackStatusBar.js +3 -103
  50. package/out/remote/remoteTrust.js +6 -277
  51. package/out/remote/serveClient.js +4 -277
  52. package/out/remoteSkills.js +3 -191
  53. package/out/runtime/index.js +2 -32
  54. package/out/runtime/vscode/index.js +2 -20
  55. package/out/runtime/vscode/vscode-config-provider.js +2 -77
  56. package/out/runtime/vscode/vscode-edit-tracker.js +2 -122
  57. package/out/runtime/vscode/vscode-logger.js +2 -30
  58. package/out/runtime/vscode/vscode-permission-handler.js +2 -72
  59. package/out/scripts/agentide-litellm.sh +0 -1
  60. package/out/scripts/agentide_litellm_hooks_v1.py +127 -459
  61. package/out/scripts/analytics/agent-fleet-widget.js +18 -257
  62. package/out/scripts/analytics/agentide-litellm-otel.config.yaml +0 -4
  63. package/out/scripts/analytics/duckdbLocator.js +2 -28
  64. package/out/scripts/analytics/generate-default-charts.py +43 -323
  65. package/out/scripts/analytics/hotspot-analysis-widget.js +4 -430
  66. package/out/scripts/analytics/index-traces.py +78 -1036
  67. package/out/scripts/analytics/session-comparison-widget.js +26 -472
  68. package/out/scripts/analytics/session-timeline-widget.js +25 -846
  69. package/out/scripts/analytics/token-cost-flamegraph-widget.js +4 -461
  70. package/out/scripts/analytics/token-cost-trend-widget.js +4 -534
  71. package/out/scripts/analytics/workflows-collector.cjs +4 -314
  72. package/out/scripts/analytics/workflows-daemon.mjs +9 -185
  73. package/out/scripts/analytics/workflows-widget.cjs +15 -159
  74. package/out/scripts/analytics/wow-model-widget.js +10 -120
  75. package/out/scripts/vendor-tools.mjs +2 -233
  76. package/out/skills/publish.js +3 -178
  77. package/out/store/github/setup.js +7 -212
  78. package/out/store/oramaIndex.js +2 -884
  79. package/out/sync.js +26 -1829
  80. package/out/terminalLogger.js +5 -358
  81. package/out/utils/pathSafety.js +2 -60
  82. package/out/utils/pythonRunner.js +4 -258
  83. package/out/utils/toolPath.js +2 -83
  84. package/out/workspaceFolders.js +2 -59
  85. package/package.json +1 -1
  86. package/out/agentpack/github.js +0 -547
  87. package/out/agentpack/index.js +0 -69
  88. package/out/agentpack/install.js +0 -297
  89. package/out/agentpack/manager.js +0 -441
  90. package/out/agentpack/manifest.js +0 -135
  91. package/out/agentpack/paths.js +0 -521
  92. package/out/agentpack/publish.js +0 -248
  93. package/out/agentpack/stores.js +0 -554
  94. package/out/analytics/dashboard/fleetStatusUtils.js +0 -30
  95. package/out/analytics/dashboard/fleetTitleUtils.js +0 -68
  96. package/out/analytics/dashboard/refreshPolicy.js +0 -16
  97. package/out/analytics/dashboard/scheduledFleetFingerprint.js +0 -22
  98. package/out/analytics/dashboard/scheduledFleetUtils.js +0 -22
  99. package/out/analytics/dashboard/sessionEventFleetStats.js +0 -118
  100. package/out/analytics/dashboard/viewsConfigMerge.js +0 -221
  101. package/out/analytics/dashboard/webview/codicon.ttf +0 -0
  102. package/out/analytics/identity.js +0 -0
  103. package/out/analytics/sessionEvents.js +0 -324
  104. package/out/auth/callbackUriParse.js +0 -59
  105. package/out/auth/types.js +0 -12
  106. package/out/auth-broker/config.js +0 -112
  107. package/out/auth-broker/jwt.js +0 -105
  108. package/out/auth-broker/pkce.js +0 -59
  109. package/out/auth-broker/server.js +0 -681
  110. package/out/auth-broker/store.js +0 -275
  111. package/out/authority/warrant.js +0 -206
  112. package/out/base-prompts/mcp-servers/.mcp.json +0 -13
  113. package/out/base-prompts/mcp-servers/langfuse-analytics/README.md +0 -142
  114. package/out/base-prompts/mcp-servers/langfuse-analytics/mcp.json +0 -13
  115. package/out/base-prompts/mcp-servers/langfuse-analytics/package-lock.json +0 -1192
  116. package/out/base-prompts/mcp-servers/langfuse-analytics/package.json +0 -23
  117. package/out/base-prompts/mcp-servers/langfuse-analytics/scripts/run-with-env.sh +0 -12
  118. package/out/base-prompts/mcp-servers/langfuse-analytics/scripts/sdk-test.js +0 -102
  119. package/out/base-prompts/mcp-servers/langfuse-analytics/scripts/simple-test.js +0 -137
  120. package/out/base-prompts/mcp-servers/langfuse-analytics/scripts/test-client.js +0 -118
  121. package/out/base-prompts/mcp-servers/langfuse-analytics/scripts/test-server.js +0 -209
  122. package/out/base-prompts/mcp-servers/langfuse-analytics/src/client.ts +0 -431
  123. package/out/base-prompts/mcp-servers/langfuse-analytics/src/index.ts +0 -270
  124. package/out/base-prompts/mcp-servers/langfuse-analytics/tsconfig.json +0 -18
  125. package/out/base-prompts/rules/AGENTS.md +0 -204
  126. package/out/base-prompts/skills/agent-browser/SKILL.md +0 -102
  127. package/out/base-prompts/skills/agent-builder/SKILL.md +0 -73
  128. package/out/base-prompts/skills/agent-builder/references/agent-pack.md +0 -63
  129. package/out/base-prompts/skills/agent-builder/references/crewai.md +0 -66
  130. package/out/base-prompts/skills/agent-builder/references/langchain.md +0 -60
  131. package/out/base-prompts/skills/agent-builder/references/raw-sdk.md +0 -73
  132. package/out/base-prompts/skills/agent-engine-creator/SKILL.md +0 -586
  133. package/out/base-prompts/skills/agent-engine-installer/SKILL.md +0 -106
  134. package/out/base-prompts/skills/agent-engine-installer/scripts/install-engine.mjs +0 -259
  135. package/out/base-prompts/skills/agent-engine-installer/scripts/install-engine.ps1 +0 -189
  136. package/out/base-prompts/skills/agenthippo-cli/SKILL.md +0 -69
  137. package/out/base-prompts/skills/agenthippo-cli/scripts/install.sh +0 -63
  138. package/out/base-prompts/skills/agentpack-creator/SKILL.md +0 -375
  139. package/out/base-prompts/skills/agentpack-creator/references/agent-templates.md +0 -261
  140. package/out/base-prompts/skills/agentpack-creator/references/agents-md-guide.md +0 -195
  141. package/out/base-prompts/skills/agentpack-creator/scripts/init_pack.py +0 -391
  142. package/out/base-prompts/skills/agentpack-creator/scripts/init_pack_test.py +0 -294
  143. package/out/base-prompts/skills/agentpack-testbench/SKILL.md +0 -135
  144. package/out/base-prompts/skills/algorithmic-art/LICENSE.txt +0 -202
  145. package/out/base-prompts/skills/algorithmic-art/SKILL.md +0 -405
  146. package/out/base-prompts/skills/algorithmic-art/templates/generator_template.js +0 -223
  147. package/out/base-prompts/skills/algorithmic-art/templates/viewer.html +0 -599
  148. package/out/base-prompts/skills/debug-agent/SKILL.md +0 -83
  149. package/out/base-prompts/skills/desktop-automation/SKILL.md +0 -166
  150. package/out/base-prompts/skills/desktop-automation/references/agenthippo-ui-recipes.md +0 -441
  151. package/out/base-prompts/skills/desktop-automation/scripts/windows-desktop-uia.psm1 +0 -280
  152. package/out/base-prompts/skills/docx/LICENSE.txt +0 -30
  153. package/out/base-prompts/skills/docx/SKILL.md +0 -197
  154. package/out/base-prompts/skills/docx/docx-js.md +0 -350
  155. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +0 -1499
  156. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +0 -146
  157. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +0 -1085
  158. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +0 -11
  159. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +0 -3081
  160. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +0 -23
  161. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +0 -185
  162. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +0 -287
  163. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +0 -1676
  164. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +0 -28
  165. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +0 -144
  166. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +0 -174
  167. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +0 -25
  168. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +0 -18
  169. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +0 -59
  170. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +0 -56
  171. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +0 -195
  172. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +0 -582
  173. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +0 -25
  174. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +0 -4439
  175. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +0 -570
  176. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +0 -509
  177. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +0 -12
  178. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +0 -108
  179. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +0 -96
  180. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +0 -3646
  181. package/out/base-prompts/skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +0 -116
  182. package/out/base-prompts/skills/docx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +0 -42
  183. package/out/base-prompts/skills/docx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +0 -50
  184. package/out/base-prompts/skills/docx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +0 -49
  185. package/out/base-prompts/skills/docx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +0 -33
  186. package/out/base-prompts/skills/docx/ooxml/schemas/mce/mc.xsd +0 -75
  187. package/out/base-prompts/skills/docx/ooxml/schemas/microsoft/wml-2010.xsd +0 -560
  188. package/out/base-prompts/skills/docx/ooxml/schemas/microsoft/wml-2012.xsd +0 -67
  189. package/out/base-prompts/skills/docx/ooxml/schemas/microsoft/wml-2018.xsd +0 -14
  190. package/out/base-prompts/skills/docx/ooxml/schemas/microsoft/wml-cex-2018.xsd +0 -20
  191. package/out/base-prompts/skills/docx/ooxml/schemas/microsoft/wml-cid-2016.xsd +0 -13
  192. package/out/base-prompts/skills/docx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +0 -4
  193. package/out/base-prompts/skills/docx/ooxml/schemas/microsoft/wml-symex-2015.xsd +0 -8
  194. package/out/base-prompts/skills/docx/ooxml/scripts/pack.py +0 -159
  195. package/out/base-prompts/skills/docx/ooxml/scripts/unpack.py +0 -29
  196. package/out/base-prompts/skills/docx/ooxml/scripts/validate.py +0 -69
  197. package/out/base-prompts/skills/docx/ooxml/scripts/validation/__init__.py +0 -15
  198. package/out/base-prompts/skills/docx/ooxml/scripts/validation/base.py +0 -951
  199. package/out/base-prompts/skills/docx/ooxml/scripts/validation/docx.py +0 -274
  200. package/out/base-prompts/skills/docx/ooxml/scripts/validation/pptx.py +0 -315
  201. package/out/base-prompts/skills/docx/ooxml/scripts/validation/redlining.py +0 -279
  202. package/out/base-prompts/skills/docx/ooxml.md +0 -610
  203. package/out/base-prompts/skills/docx/scripts/__init__.py +0 -1
  204. package/out/base-prompts/skills/docx/scripts/document.py +0 -1276
  205. package/out/base-prompts/skills/docx/scripts/templates/comments.xml +0 -3
  206. package/out/base-prompts/skills/docx/scripts/templates/commentsExtended.xml +0 -3
  207. package/out/base-prompts/skills/docx/scripts/templates/commentsExtensible.xml +0 -3
  208. package/out/base-prompts/skills/docx/scripts/templates/commentsIds.xml +0 -3
  209. package/out/base-prompts/skills/docx/scripts/templates/people.xml +0 -3
  210. package/out/base-prompts/skills/docx/scripts/utilities.py +0 -374
  211. package/out/base-prompts/skills/gateway-outbound/SKILL.md +0 -136
  212. package/out/base-prompts/skills/mcp-builder/LICENSE.txt +0 -202
  213. package/out/base-prompts/skills/mcp-builder/SKILL.md +0 -328
  214. package/out/base-prompts/skills/mcp-builder/reference/evaluation.md +0 -602
  215. package/out/base-prompts/skills/mcp-builder/reference/mcp_best_practices.md +0 -249
  216. package/out/base-prompts/skills/mcp-builder/reference/node_mcp_server.md +0 -970
  217. package/out/base-prompts/skills/mcp-builder/reference/python_mcp_server.md +0 -719
  218. package/out/base-prompts/skills/mcp-builder/scripts/connections.py +0 -151
  219. package/out/base-prompts/skills/mcp-builder/scripts/evaluation.py +0 -373
  220. package/out/base-prompts/skills/mcp-builder/scripts/example_evaluation.xml +0 -22
  221. package/out/base-prompts/skills/mcp-builder/scripts/requirements.txt +0 -2
  222. package/out/base-prompts/skills/openclaw/SKILL.md +0 -406
  223. package/out/base-prompts/skills/openclaw/scripts/run-smoke.sh +0 -61
  224. package/out/base-prompts/skills/pdf/LICENSE.txt +0 -30
  225. package/out/base-prompts/skills/pdf/SKILL.md +0 -294
  226. package/out/base-prompts/skills/pdf/forms.md +0 -205
  227. package/out/base-prompts/skills/pdf/reference.md +0 -612
  228. package/out/base-prompts/skills/pdf/scripts/check_bounding_boxes.py +0 -70
  229. package/out/base-prompts/skills/pdf/scripts/check_bounding_boxes_test.py +0 -226
  230. package/out/base-prompts/skills/pdf/scripts/check_fillable_fields.py +0 -12
  231. package/out/base-prompts/skills/pdf/scripts/convert_pdf_to_images.py +0 -35
  232. package/out/base-prompts/skills/pdf/scripts/create_validation_image.py +0 -41
  233. package/out/base-prompts/skills/pdf/scripts/extract_form_field_info.py +0 -152
  234. package/out/base-prompts/skills/pdf/scripts/fill_fillable_fields.py +0 -114
  235. package/out/base-prompts/skills/pdf/scripts/fill_pdf_form_with_annotations.py +0 -108
  236. package/out/base-prompts/skills/pptx/LICENSE.txt +0 -30
  237. package/out/base-prompts/skills/pptx/SKILL.md +0 -484
  238. package/out/base-prompts/skills/pptx/html2pptx.md +0 -625
  239. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +0 -1499
  240. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +0 -146
  241. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +0 -1085
  242. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +0 -11
  243. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +0 -3081
  244. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +0 -23
  245. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +0 -185
  246. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +0 -287
  247. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +0 -1676
  248. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +0 -28
  249. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +0 -144
  250. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +0 -174
  251. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +0 -25
  252. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +0 -18
  253. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +0 -59
  254. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +0 -56
  255. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +0 -195
  256. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +0 -582
  257. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +0 -25
  258. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +0 -4439
  259. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +0 -570
  260. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +0 -509
  261. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +0 -12
  262. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +0 -108
  263. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +0 -96
  264. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +0 -3646
  265. package/out/base-prompts/skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +0 -116
  266. package/out/base-prompts/skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +0 -42
  267. package/out/base-prompts/skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +0 -50
  268. package/out/base-prompts/skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +0 -49
  269. package/out/base-prompts/skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +0 -33
  270. package/out/base-prompts/skills/pptx/ooxml/schemas/mce/mc.xsd +0 -75
  271. package/out/base-prompts/skills/pptx/ooxml/schemas/microsoft/wml-2010.xsd +0 -560
  272. package/out/base-prompts/skills/pptx/ooxml/schemas/microsoft/wml-2012.xsd +0 -67
  273. package/out/base-prompts/skills/pptx/ooxml/schemas/microsoft/wml-2018.xsd +0 -14
  274. package/out/base-prompts/skills/pptx/ooxml/schemas/microsoft/wml-cex-2018.xsd +0 -20
  275. package/out/base-prompts/skills/pptx/ooxml/schemas/microsoft/wml-cid-2016.xsd +0 -13
  276. package/out/base-prompts/skills/pptx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +0 -4
  277. package/out/base-prompts/skills/pptx/ooxml/schemas/microsoft/wml-symex-2015.xsd +0 -8
  278. package/out/base-prompts/skills/pptx/ooxml/scripts/pack.py +0 -159
  279. package/out/base-prompts/skills/pptx/ooxml/scripts/unpack.py +0 -29
  280. package/out/base-prompts/skills/pptx/ooxml/scripts/validate.py +0 -69
  281. package/out/base-prompts/skills/pptx/ooxml/scripts/validation/__init__.py +0 -15
  282. package/out/base-prompts/skills/pptx/ooxml/scripts/validation/base.py +0 -951
  283. package/out/base-prompts/skills/pptx/ooxml/scripts/validation/docx.py +0 -274
  284. package/out/base-prompts/skills/pptx/ooxml/scripts/validation/pptx.py +0 -315
  285. package/out/base-prompts/skills/pptx/ooxml/scripts/validation/redlining.py +0 -279
  286. package/out/base-prompts/skills/pptx/ooxml.md +0 -427
  287. package/out/base-prompts/skills/pptx/scripts/html2pptx.js +0 -984
  288. package/out/base-prompts/skills/pptx/scripts/inventory.py +0 -1020
  289. package/out/base-prompts/skills/pptx/scripts/rearrange.py +0 -231
  290. package/out/base-prompts/skills/pptx/scripts/replace.py +0 -385
  291. package/out/base-prompts/skills/pptx/scripts/thumbnail.py +0 -450
  292. package/out/base-prompts/skills/prompt-lab/SKILL.md +0 -149
  293. package/out/base-prompts/skills/prompt-lab/scripts/query-analytics.sh +0 -2551
  294. package/out/base-prompts/skills/skill-creator/LICENSE.txt +0 -202
  295. package/out/base-prompts/skills/skill-creator/SKILL.md +0 -371
  296. package/out/base-prompts/skills/skill-creator/references/output-patterns.md +0 -82
  297. package/out/base-prompts/skills/skill-creator/references/workflows.md +0 -28
  298. package/out/base-prompts/skills/skill-creator/scripts/init_skill.py +0 -303
  299. package/out/base-prompts/skills/skill-creator/scripts/package_skill.py +0 -110
  300. package/out/base-prompts/skills/skill-creator/scripts/quick_validate.py +0 -95
  301. package/out/base-prompts/skills/skill-installer/SKILL.md +0 -251
  302. package/out/base-prompts/skills/skill-installer/references/store-api.md +0 -219
  303. package/out/base-prompts/skills/spotlight-dashboard/SKILL.md +0 -83
  304. package/out/base-prompts/skills/spotlight-insights/SKILL.md +0 -101
  305. package/out/base-prompts/skills/spotlight-optimize/SKILL.md +0 -93
  306. package/out/base-prompts/skills/spotlight-optimize/scripts/query-analytics.sh +0 -2551
  307. package/out/base-prompts/skills/spotlight-query/SKILL.md +0 -314
  308. package/out/base-prompts/skills/spotlight-query/references/otel-schema.md +0 -163
  309. package/out/base-prompts/skills/spotlight-query/scripts/query-analytics.sh +0 -2551
  310. package/out/base-prompts/skills/spotlight-query/scripts/query-analytics.test.sh +0 -744
  311. package/out/base-prompts/skills/spotlight-query/scripts/test-fixtures/analytics/sessions/sess-test-1.jsonl +0 -14
  312. package/out/base-prompts/skills/spotlight-query/scripts/test-fixtures/analytics/traces/.duckdb-index.json +0 -7
  313. package/out/base-prompts/skills/spotlight-query/scripts/test-fixtures/analytics/traces/sample.jsonl +0 -5
  314. package/out/base-prompts/skills/spotlight-report/SKILL.md +0 -86
  315. package/out/base-prompts/skills/spotlight-visualize/SKILL.md +0 -92
  316. package/out/base-prompts/skills/spotlight-visualize/scripts/query-analytics.sh +0 -2551
  317. package/out/base-prompts/skills/xlsx/LICENSE.txt +0 -30
  318. package/out/base-prompts/skills/xlsx/SKILL.md +0 -289
  319. package/out/base-prompts/skills/xlsx/recalc.py +0 -178
  320. package/out/branding.js +0 -49
  321. package/out/cli/commands/anywhere.js +0 -66
  322. package/out/cli/commands/ask.js +0 -246
  323. package/out/cli/commands/auth-broker.js +0 -24
  324. package/out/cli/commands/auth.js +0 -219
  325. package/out/cli/commands/chat.js +0 -357
  326. package/out/cli/commands/conformance.js +0 -249
  327. package/out/cli/commands/data-plane.js +0 -151
  328. package/out/cli/commands/deploy.js +0 -263
  329. package/out/cli/commands/gateway.js +0 -218
  330. package/out/cli/commands/idp.js +0 -85
  331. package/out/cli/commands/pack.js +0 -399
  332. package/out/cli/commands/probe-custom-engine.js +0 -82
  333. package/out/cli/commands/sandbox.js +0 -351
  334. package/out/cli/commands/serve.js +0 -1950
  335. package/out/cli/commands/store.js +0 -927
  336. package/out/cli/credential-context.js +0 -108
  337. package/out/cli/data-plane/broker.js +0 -78
  338. package/out/cli/data-plane/connector-host.js +0 -121
  339. package/out/cli/data-plane/egress.js +0 -189
  340. package/out/cli/data-plane/gateway.js +0 -218
  341. package/out/cli/data-plane/index.js +0 -153
  342. package/out/cli/data-plane/registry.js +0 -89
  343. package/out/cli/data-plane/remote.js +0 -106
  344. package/out/cli/data-plane/sidecar.js +0 -225
  345. package/out/cli/deploy/blueprints/registry.js +0 -84
  346. package/out/cli/deploy/layers/identity.js +0 -175
  347. package/out/cli/deploy-init.js +0 -3023
  348. package/out/cli/deps.js +0 -342
  349. package/out/cli/idp-init.js +0 -338
  350. package/out/cli/pack-install-ref.js +0 -15
  351. package/out/cli/pack-loader.js +0 -418
  352. package/out/cli/pack-runtime.js +0 -61
  353. package/out/cli/runtime.js +0 -450
  354. package/out/cli/serve-hardening.js +0 -776
  355. package/out/cli/state-sync.js +0 -424
  356. package/out/cli/utils.js +0 -231
  357. package/out/engines/base.js +0 -188
  358. package/out/engines/claude.js +0 -1254
  359. package/out/engines/codex.js +0 -862
  360. package/out/engines/custom.js +0 -680
  361. package/out/engines/customEngineIpc.js +0 -95
  362. package/out/engines/customEngineRunnerEmbed.js +0 -107
  363. package/out/engines/customRegistry.js +0 -274
  364. package/out/engines/embeddedCustomEngineRunner.generated.js +0 -9
  365. package/out/engines/engineApiKey.js +0 -138
  366. package/out/engines/install.js +0 -372
  367. package/out/engines/persistentEngineWorker.js +0 -320
  368. package/out/engines/publish.js +0 -341
  369. package/out/evidence/sessionShip.js +0 -643
  370. package/out/gateway/bridge.js +0 -843
  371. package/out/gateway/cli-agent-id.js +0 -36
  372. package/out/gateway/client.js +0 -336
  373. package/out/gateway/client.test.js +0 -395
  374. package/out/gateway/gateway-scope-errors.js +0 -14
  375. package/out/gateway/gatewayBackup.js +0 -76
  376. package/out/gateway/installSource.js +0 -68
  377. package/out/gateway/lifecycle.js +0 -3190
  378. package/out/gateway/openclaw-channel-routing.js +0 -317
  379. package/out/gateway/outboundHandles.js +0 -373
  380. package/out/gateway/outboundPaths.js +0 -75
  381. package/out/gateway/outboundSend.js +0 -254
  382. package/out/gateway/protocol.js +0 -48
  383. package/out/gateway/secretsPreflight.js +0 -90
  384. package/out/gateway/sessionRouting.js +0 -77
  385. package/out/headless/index.js +0 -546
  386. package/out/headless/sync.js +0 -473
  387. package/out/live-e2e/mcp-demo/server.mjs +0 -32
  388. package/out/live-probe/connector.mjs +0 -8
  389. package/out/live-probe/env-report.mjs +0 -8
  390. package/out/mcp.js +0 -654
  391. package/out/pack/caps.js +0 -271
  392. package/out/pack/governor.js +0 -326
  393. package/out/pack/lease-schema.js +0 -273
  394. package/out/pack/lease.js +0 -682
  395. package/out/pack/reconcile.js +0 -217
  396. package/out/pack/signature.js +0 -839
  397. package/out/permissions.js +0 -108
  398. package/out/permissions.mapping.yaml +0 -68
  399. package/out/registry/index.js +0 -332
  400. package/out/runner/host.js +0 -141
  401. package/out/runner/protocol.js +0 -128
  402. package/out/runner/remoteEngine.js +0 -166
  403. package/out/runtime/interfaces/config-provider.js +0 -32
  404. package/out/runtime/interfaces/edit-tracker.js +0 -24
  405. package/out/runtime/interfaces/index.js +0 -29
  406. package/out/runtime/interfaces/logger.js +0 -40
  407. package/out/runtime/interfaces/permission-handler.js +0 -66
  408. package/out/runtime/interfaces/session-store.js +0 -342
  409. package/out/runtime/vscode/vscode-session-store.js +0 -22
  410. package/out/sandbox/containerDriver.js +0 -572
  411. package/out/sandbox/processDriver.js +0 -318
  412. package/out/sandbox/sandboxRunner.js +0 -303
  413. package/out/sandbox/support.js +0 -301
  414. package/out/sandbox/types.js +0 -55
  415. package/out/scripts/analytics/fleet-local-adapter.js +0 -246
  416. package/out/scripts/analytics/live-fleet-4-collector.cjs +0 -315
  417. package/out/scripts/analytics/live-fleet-4-daemon.mjs +0 -134
  418. package/out/scripts/analytics/live-fleet-4-widget.cjs +0 -433
  419. package/out/scripts/gateway/Dockerfile.serve +0 -45
  420. package/out/scripts/gateway/docker-serve.sh +0 -248
  421. package/out/scripts/gateway/setup-gateway-server.ps1 +0 -953
  422. package/out/scripts/gateway/setup-gateway-server.sh +0 -935
  423. package/out/session.js +0 -272
  424. package/out/shared/agentEngines.js +0 -170
  425. package/out/shared/index.js +0 -109
  426. package/out/shared/models.js +0 -136
  427. package/out/shared/providers.js +0 -205
  428. package/out/spotlight/install.js +0 -345
  429. package/out/spotlight/publish.js +0 -544
  430. package/out/spotlight/yaml.js +0 -31
  431. package/out/store/index.js +0 -786
  432. package/out/store/shared.js +0 -241
  433. package/out/test/agentEnvFile.test.js +0 -97
  434. package/out/test/agentYaml.test.js +0 -373
  435. package/out/test/agentpack.test.js +0 -639
  436. package/out/test/analytics-lifecycle.test.js +0 -174
  437. package/out/test/analytics.test.js +0 -756
  438. package/out/test/auth-baseurl.test.js +0 -132
  439. package/out/test/auth-bootstrapApply.test.js +0 -123
  440. package/out/test/auth-broker-hardening.test.js +0 -227
  441. package/out/test/auth-broker.test.js +0 -541
  442. package/out/test/auth-callback.test.js +0 -62
  443. package/out/test/blueprint-registry.test.js +0 -105
  444. package/out/test/branding.test.js +0 -242
  445. package/out/test/caps-governor.test.js +0 -460
  446. package/out/test/cli-agent-id.test.js +0 -55
  447. package/out/test/codex-new-file-survival.test.js +0 -119
  448. package/out/test/configuration-scopes.test.js +0 -131
  449. package/out/test/credential-context.test.js +0 -160
  450. package/out/test/custom-env-layering.test.js +0 -151
  451. package/out/test/customEngineInstall.test.js +0 -100
  452. package/out/test/customRegistry.test.js +0 -122
  453. package/out/test/data-plane-engine-wiring.test.js +0 -282
  454. package/out/test/data-plane.test.js +0 -624
  455. package/out/test/deploy-init.test.js +0 -860
  456. package/out/test/deps-auto-install.test.js +0 -81
  457. package/out/test/egress-broker.test.js +0 -172
  458. package/out/test/engine-integration.test.js +0 -297
  459. package/out/test/enginePaths.test.js +0 -195
  460. package/out/test/enginePublish.test.js +0 -82
  461. package/out/test/fleetDisplayUtils.test.js +0 -100
  462. package/out/test/gateway-client.test.js +0 -409
  463. package/out/test/gateway-install-source.test.js +0 -111
  464. package/out/test/gateway-lifecycle.test.js +0 -608
  465. package/out/test/gateway-outbound.test.js +0 -538
  466. package/out/test/gateway-reset-mappings.test.js +0 -221
  467. package/out/test/gateway-route-index.test.js +0 -235
  468. package/out/test/gateway-secrets-preflight.test.js +0 -127
  469. package/out/test/gateway-session-routing.test.js +0 -65
  470. package/out/test/gateway-session-store.test.js +0 -216
  471. package/out/test/github.test.js +0 -232
  472. package/out/test/governor-hardening.test.js +0 -222
  473. package/out/test/headless-sync.test.js +0 -301
  474. package/out/test/helpers/manifest-fixtures.js +0 -27
  475. package/out/test/idp-init.test.js +0 -151
  476. package/out/test/lease-signature.test.js +0 -357
  477. package/out/test/lease-trust-root.test.js +0 -273
  478. package/out/test/lease-validation.test.js +0 -224
  479. package/out/test/lease.test.js +0 -114
  480. package/out/test/localFleetAdapter.test.js +0 -91
  481. package/out/test/mcp-obo.test.js +0 -107
  482. package/out/test/mcp.test.js +0 -389
  483. package/out/test/model-routing.test.js +0 -133
  484. package/out/test/openclaw-channel-routing.test.js +0 -191
  485. package/out/test/pack-admission.test.js +0 -216
  486. package/out/test/pack-digest-parity.test.js +0 -140
  487. package/out/test/pack-reconcile.test.js +0 -183
  488. package/out/test/pack-signature-artifact.test.js +0 -103
  489. package/out/test/pack-signature.test.js +0 -176
  490. package/out/test/pack-trust-root.test.js +0 -202
  491. package/out/test/pathSafety.test.js +0 -63
  492. package/out/test/permissions.test.js +0 -175
  493. package/out/test/persistent-engine-worker.test.js +0 -220
  494. package/out/test/refreshPolicy.test.js +0 -60
  495. package/out/test/registry.test.js +0 -351
  496. package/out/test/remote-trust.test.js +0 -242
  497. package/out/test/runner-protocol.test.js +0 -249
  498. package/out/test/runtime.test.js +0 -349
  499. package/out/test/sandbox-driver.test.js +0 -553
  500. package/out/test/sandbox-hardening.test.js +0 -406
  501. package/out/test/sandbox-runner.test.js +0 -343
  502. package/out/test/sandbox-scope.test.js +0 -449
  503. package/out/test/scheduledFleetStorage.test.js +0 -72
  504. package/out/test/serve-cron-acceptance.test.js +0 -370
  505. package/out/test/serve-gateway-turn.test.js +0 -389
  506. package/out/test/serve-hardening.test.js +0 -591
  507. package/out/test/serveClient.test.js +0 -209
  508. package/out/test/sessionJsonlFleet.test.js +0 -78
  509. package/out/test/sessionShip.test.js +0 -618
  510. package/out/test/shared.test.js +0 -173
  511. package/out/test/skills-mcp.test.js +0 -299
  512. package/out/test/spotlightPublish.test.js +0 -327
  513. package/out/test/spotlightYaml.test.js +0 -58
  514. package/out/test/state-sync-peer.test.js +0 -156
  515. package/out/test/store-install-safe.test.js +0 -69
  516. package/out/test/store.test.js +0 -331
  517. package/out/test/stores.test.js +0 -504
  518. package/out/test/sync-switch.test.js +0 -251
  519. package/out/test/teamViewDiscovery.test.js +0 -90
  520. package/out/test/tls-bypass.test.js +0 -90
  521. package/out/test/toolPath.test.js +0 -120
  522. package/out/test/utils.test.js +0 -308
  523. package/out/test/viewsConfigMerge.test.js +0 -180
  524. package/out/test/warrant.test.js +0 -138
  525. package/out/test/windows-command-line.test.js +0 -75
  526. package/out/utils/agentEnvFile.js +0 -131
  527. package/out/utils/binary.js +0 -175
  528. package/out/utils/index.js +0 -37
  529. package/out/utils/network.js +0 -74
  530. package/out/utils/paths.js +0 -116
  531. package/out/utils/pid.js +0 -180
  532. package/out/utils/resolveNodeBinary.js +0 -168
  533. package/out/utils/windowsCommandLine.js +0 -29
  534. package/out/utils.js +0 -968
@@ -1,1276 +0,0 @@
1
- #!/usr/bin/env python3
2
- """
3
- Library for working with Word documents: comments, tracked changes, and editing.
4
-
5
- Usage:
6
- from skills.docx.scripts.document import Document
7
-
8
- # Initialize
9
- doc = Document('workspace/unpacked')
10
- doc = Document('workspace/unpacked', author="John Doe", initials="JD")
11
-
12
- # Find nodes
13
- node = doc["word/document.xml"].get_node(tag="w:del", attrs={"w:id": "1"})
14
- node = doc["word/document.xml"].get_node(tag="w:p", line_number=10)
15
-
16
- # Add comments
17
- doc.add_comment(start=node, end=node, text="Comment text")
18
- doc.reply_to_comment(parent_comment_id=0, text="Reply text")
19
-
20
- # Suggest tracked changes
21
- doc["word/document.xml"].suggest_deletion(node) # Delete content
22
- doc["word/document.xml"].revert_insertion(ins_node) # Reject insertion
23
- doc["word/document.xml"].revert_deletion(del_node) # Reject deletion
24
-
25
- # Save
26
- doc.save()
27
- """
28
-
29
- import html
30
- import random
31
- import shutil
32
- import tempfile
33
- from datetime import datetime, timezone
34
- from pathlib import Path
35
-
36
- from defusedxml import minidom
37
- from ooxml.scripts.pack import pack_document
38
- from ooxml.scripts.validation.docx import DOCXSchemaValidator
39
- from ooxml.scripts.validation.redlining import RedliningValidator
40
-
41
- from .utilities import XMLEditor
42
-
43
- # Path to template files
44
- TEMPLATE_DIR = Path(__file__).parent / "templates"
45
-
46
-
47
- class DocxXMLEditor(XMLEditor):
48
- """XMLEditor that automatically applies RSID, author, and date to new elements.
49
-
50
- Automatically adds attributes to elements that support them when inserting new content:
51
- - w:rsidR, w:rsidRDefault, w:rsidP (for w:p and w:r elements)
52
- - w:author and w:date (for w:ins, w:del, w:comment elements)
53
- - w:id (for w:ins and w:del elements)
54
-
55
- Attributes:
56
- dom (defusedxml.minidom.Document): The DOM document for direct manipulation
57
- """
58
-
59
- def __init__(
60
- self, xml_path, rsid: str, author: str = "Claude", initials: str = "C"
61
- ):
62
- """Initialize with required RSID and optional author.
63
-
64
- Args:
65
- xml_path: Path to XML file to edit
66
- rsid: RSID to automatically apply to new elements
67
- author: Author name for tracked changes and comments (default: "Claude")
68
- initials: Author initials (default: "C")
69
- """
70
- super().__init__(xml_path)
71
- self.rsid = rsid
72
- self.author = author
73
- self.initials = initials
74
-
75
- def _get_next_change_id(self):
76
- """Get the next available change ID by checking all tracked change elements."""
77
- max_id = -1
78
- for tag in ("w:ins", "w:del"):
79
- elements = self.dom.getElementsByTagName(tag)
80
- for elem in elements:
81
- change_id = elem.getAttribute("w:id")
82
- if change_id:
83
- try:
84
- max_id = max(max_id, int(change_id))
85
- except ValueError:
86
- pass
87
- return max_id + 1
88
-
89
- def _ensure_w16du_namespace(self):
90
- """Ensure w16du namespace is declared on the root element."""
91
- root = self.dom.documentElement
92
- if not root.hasAttribute("xmlns:w16du"): # type: ignore
93
- root.setAttribute( # type: ignore
94
- "xmlns:w16du",
95
- "http://schemas.microsoft.com/office/word/2023/wordml/word16du",
96
- )
97
-
98
- def _ensure_w16cex_namespace(self):
99
- """Ensure w16cex namespace is declared on the root element."""
100
- root = self.dom.documentElement
101
- if not root.hasAttribute("xmlns:w16cex"): # type: ignore
102
- root.setAttribute( # type: ignore
103
- "xmlns:w16cex",
104
- "http://schemas.microsoft.com/office/word/2018/wordml/cex",
105
- )
106
-
107
- def _ensure_w14_namespace(self):
108
- """Ensure w14 namespace is declared on the root element."""
109
- root = self.dom.documentElement
110
- if not root.hasAttribute("xmlns:w14"): # type: ignore
111
- root.setAttribute( # type: ignore
112
- "xmlns:w14",
113
- "http://schemas.microsoft.com/office/word/2010/wordml",
114
- )
115
-
116
- def _inject_attributes_to_nodes(self, nodes):
117
- """Inject RSID, author, and date attributes into DOM nodes where applicable.
118
-
119
- Adds attributes to elements that support them:
120
- - w:r: gets w:rsidR (or w:rsidDel if inside w:del)
121
- - w:p: gets w:rsidR, w:rsidRDefault, w:rsidP, w14:paraId, w14:textId
122
- - w:t: gets xml:space="preserve" if text has leading/trailing whitespace
123
- - w:ins, w:del: get w:id, w:author, w:date, w16du:dateUtc
124
- - w:comment: gets w:author, w:date, w:initials
125
- - w16cex:commentExtensible: gets w16cex:dateUtc
126
-
127
- Args:
128
- nodes: List of DOM nodes to process
129
- """
130
- from datetime import datetime, timezone
131
-
132
- timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
133
-
134
- def is_inside_deletion(elem):
135
- """Check if element is inside a w:del element."""
136
- parent = elem.parentNode
137
- while parent:
138
- if parent.nodeType == parent.ELEMENT_NODE and parent.tagName == "w:del":
139
- return True
140
- parent = parent.parentNode
141
- return False
142
-
143
- def add_rsid_to_p(elem):
144
- if not elem.hasAttribute("w:rsidR"):
145
- elem.setAttribute("w:rsidR", self.rsid)
146
- if not elem.hasAttribute("w:rsidRDefault"):
147
- elem.setAttribute("w:rsidRDefault", self.rsid)
148
- if not elem.hasAttribute("w:rsidP"):
149
- elem.setAttribute("w:rsidP", self.rsid)
150
- # Add w14:paraId and w14:textId if not present
151
- if not elem.hasAttribute("w14:paraId"):
152
- self._ensure_w14_namespace()
153
- elem.setAttribute("w14:paraId", _generate_hex_id())
154
- if not elem.hasAttribute("w14:textId"):
155
- self._ensure_w14_namespace()
156
- elem.setAttribute("w14:textId", _generate_hex_id())
157
-
158
- def add_rsid_to_r(elem):
159
- # Use w:rsidDel for <w:r> inside <w:del>, otherwise w:rsidR
160
- if is_inside_deletion(elem):
161
- if not elem.hasAttribute("w:rsidDel"):
162
- elem.setAttribute("w:rsidDel", self.rsid)
163
- else:
164
- if not elem.hasAttribute("w:rsidR"):
165
- elem.setAttribute("w:rsidR", self.rsid)
166
-
167
- def add_tracked_change_attrs(elem):
168
- # Auto-assign w:id if not present
169
- if not elem.hasAttribute("w:id"):
170
- elem.setAttribute("w:id", str(self._get_next_change_id()))
171
- if not elem.hasAttribute("w:author"):
172
- elem.setAttribute("w:author", self.author)
173
- if not elem.hasAttribute("w:date"):
174
- elem.setAttribute("w:date", timestamp)
175
- # Add w16du:dateUtc for tracked changes (same as w:date since we generate UTC timestamps)
176
- if elem.tagName in ("w:ins", "w:del") and not elem.hasAttribute(
177
- "w16du:dateUtc"
178
- ):
179
- self._ensure_w16du_namespace()
180
- elem.setAttribute("w16du:dateUtc", timestamp)
181
-
182
- def add_comment_attrs(elem):
183
- if not elem.hasAttribute("w:author"):
184
- elem.setAttribute("w:author", self.author)
185
- if not elem.hasAttribute("w:date"):
186
- elem.setAttribute("w:date", timestamp)
187
- if not elem.hasAttribute("w:initials"):
188
- elem.setAttribute("w:initials", self.initials)
189
-
190
- def add_comment_extensible_date(elem):
191
- # Add w16cex:dateUtc for comment extensible elements
192
- if not elem.hasAttribute("w16cex:dateUtc"):
193
- self._ensure_w16cex_namespace()
194
- elem.setAttribute("w16cex:dateUtc", timestamp)
195
-
196
- def add_xml_space_to_t(elem):
197
- # Add xml:space="preserve" to w:t if text has leading/trailing whitespace
198
- if (
199
- elem.firstChild
200
- and elem.firstChild.nodeType == elem.firstChild.TEXT_NODE
201
- ):
202
- text = elem.firstChild.data
203
- if text and (text[0].isspace() or text[-1].isspace()):
204
- if not elem.hasAttribute("xml:space"):
205
- elem.setAttribute("xml:space", "preserve")
206
-
207
- for node in nodes:
208
- if node.nodeType != node.ELEMENT_NODE:
209
- continue
210
-
211
- # Handle the node itself
212
- if node.tagName == "w:p":
213
- add_rsid_to_p(node)
214
- elif node.tagName == "w:r":
215
- add_rsid_to_r(node)
216
- elif node.tagName == "w:t":
217
- add_xml_space_to_t(node)
218
- elif node.tagName in ("w:ins", "w:del"):
219
- add_tracked_change_attrs(node)
220
- elif node.tagName == "w:comment":
221
- add_comment_attrs(node)
222
- elif node.tagName == "w16cex:commentExtensible":
223
- add_comment_extensible_date(node)
224
-
225
- # Process descendants (getElementsByTagName doesn't return the element itself)
226
- for elem in node.getElementsByTagName("w:p"):
227
- add_rsid_to_p(elem)
228
- for elem in node.getElementsByTagName("w:r"):
229
- add_rsid_to_r(elem)
230
- for elem in node.getElementsByTagName("w:t"):
231
- add_xml_space_to_t(elem)
232
- for tag in ("w:ins", "w:del"):
233
- for elem in node.getElementsByTagName(tag):
234
- add_tracked_change_attrs(elem)
235
- for elem in node.getElementsByTagName("w:comment"):
236
- add_comment_attrs(elem)
237
- for elem in node.getElementsByTagName("w16cex:commentExtensible"):
238
- add_comment_extensible_date(elem)
239
-
240
- def replace_node(self, elem, new_content):
241
- """Replace node with automatic attribute injection."""
242
- nodes = super().replace_node(elem, new_content)
243
- self._inject_attributes_to_nodes(nodes)
244
- return nodes
245
-
246
- def insert_after(self, elem, xml_content):
247
- """Insert after with automatic attribute injection."""
248
- nodes = super().insert_after(elem, xml_content)
249
- self._inject_attributes_to_nodes(nodes)
250
- return nodes
251
-
252
- def insert_before(self, elem, xml_content):
253
- """Insert before with automatic attribute injection."""
254
- nodes = super().insert_before(elem, xml_content)
255
- self._inject_attributes_to_nodes(nodes)
256
- return nodes
257
-
258
- def append_to(self, elem, xml_content):
259
- """Append to with automatic attribute injection."""
260
- nodes = super().append_to(elem, xml_content)
261
- self._inject_attributes_to_nodes(nodes)
262
- return nodes
263
-
264
- def revert_insertion(self, elem):
265
- """Reject an insertion by wrapping its content in a deletion.
266
-
267
- Wraps all runs inside w:ins in w:del, converting w:t to w:delText.
268
- Can process a single w:ins element or a container element with multiple w:ins.
269
-
270
- Args:
271
- elem: Element to process (w:ins, w:p, w:body, etc.)
272
-
273
- Returns:
274
- list: List containing the processed element(s)
275
-
276
- Raises:
277
- ValueError: If the element contains no w:ins elements
278
-
279
- Example:
280
- # Reject a single insertion
281
- ins = doc["word/document.xml"].get_node(tag="w:ins", attrs={"w:id": "5"})
282
- doc["word/document.xml"].revert_insertion(ins)
283
-
284
- # Reject all insertions in a paragraph
285
- para = doc["word/document.xml"].get_node(tag="w:p", line_number=42)
286
- doc["word/document.xml"].revert_insertion(para)
287
- """
288
- # Collect insertions
289
- ins_elements = []
290
- if elem.tagName == "w:ins":
291
- ins_elements.append(elem)
292
- else:
293
- ins_elements.extend(elem.getElementsByTagName("w:ins"))
294
-
295
- # Validate that there are insertions to reject
296
- if not ins_elements:
297
- raise ValueError(
298
- f"revert_insertion requires w:ins elements. "
299
- f"The provided element <{elem.tagName}> contains no insertions. "
300
- )
301
-
302
- # Process all insertions - wrap all children in w:del
303
- for ins_elem in ins_elements:
304
- runs = list(ins_elem.getElementsByTagName("w:r"))
305
- if not runs:
306
- continue
307
-
308
- # Create deletion wrapper
309
- del_wrapper = self.dom.createElement("w:del")
310
-
311
- # Process each run
312
- for run in runs:
313
- # Convert w:t → w:delText and w:rsidR → w:rsidDel
314
- if run.hasAttribute("w:rsidR"):
315
- run.setAttribute("w:rsidDel", run.getAttribute("w:rsidR"))
316
- run.removeAttribute("w:rsidR")
317
- elif not run.hasAttribute("w:rsidDel"):
318
- run.setAttribute("w:rsidDel", self.rsid)
319
-
320
- for t_elem in list(run.getElementsByTagName("w:t")):
321
- del_text = self.dom.createElement("w:delText")
322
- # Copy ALL child nodes (not just firstChild) to handle entities
323
- while t_elem.firstChild:
324
- del_text.appendChild(t_elem.firstChild)
325
- for i in range(t_elem.attributes.length):
326
- attr = t_elem.attributes.item(i)
327
- del_text.setAttribute(attr.name, attr.value)
328
- t_elem.parentNode.replaceChild(del_text, t_elem)
329
-
330
- # Move all children from ins to del wrapper
331
- while ins_elem.firstChild:
332
- del_wrapper.appendChild(ins_elem.firstChild)
333
-
334
- # Add del wrapper back to ins
335
- ins_elem.appendChild(del_wrapper)
336
-
337
- # Inject attributes to the deletion wrapper
338
- self._inject_attributes_to_nodes([del_wrapper])
339
-
340
- return [elem]
341
-
342
- def revert_deletion(self, elem):
343
- """Reject a deletion by re-inserting the deleted content.
344
-
345
- Creates w:ins elements after each w:del, copying deleted content and
346
- converting w:delText back to w:t.
347
- Can process a single w:del element or a container element with multiple w:del.
348
-
349
- Args:
350
- elem: Element to process (w:del, w:p, w:body, etc.)
351
-
352
- Returns:
353
- list: If elem is w:del, returns [elem, new_ins]. Otherwise returns [elem].
354
-
355
- Raises:
356
- ValueError: If the element contains no w:del elements
357
-
358
- Example:
359
- # Reject a single deletion - returns [w:del, w:ins]
360
- del_elem = doc["word/document.xml"].get_node(tag="w:del", attrs={"w:id": "3"})
361
- nodes = doc["word/document.xml"].revert_deletion(del_elem)
362
-
363
- # Reject all deletions in a paragraph - returns [para]
364
- para = doc["word/document.xml"].get_node(tag="w:p", line_number=42)
365
- nodes = doc["word/document.xml"].revert_deletion(para)
366
- """
367
- # Collect deletions FIRST - before we modify the DOM
368
- del_elements = []
369
- is_single_del = elem.tagName == "w:del"
370
-
371
- if is_single_del:
372
- del_elements.append(elem)
373
- else:
374
- del_elements.extend(elem.getElementsByTagName("w:del"))
375
-
376
- # Validate that there are deletions to reject
377
- if not del_elements:
378
- raise ValueError(
379
- f"revert_deletion requires w:del elements. "
380
- f"The provided element <{elem.tagName}> contains no deletions. "
381
- )
382
-
383
- # Track created insertion (only relevant if elem is a single w:del)
384
- created_insertion = None
385
-
386
- # Process all deletions - create insertions that copy the deleted content
387
- for del_elem in del_elements:
388
- # Clone the deleted runs and convert them to insertions
389
- runs = list(del_elem.getElementsByTagName("w:r"))
390
- if not runs:
391
- continue
392
-
393
- # Create insertion wrapper
394
- ins_elem = self.dom.createElement("w:ins")
395
-
396
- for run in runs:
397
- # Clone the run
398
- new_run = run.cloneNode(True)
399
-
400
- # Convert w:delText → w:t
401
- for del_text in list(new_run.getElementsByTagName("w:delText")):
402
- t_elem = self.dom.createElement("w:t")
403
- # Copy ALL child nodes (not just firstChild) to handle entities
404
- while del_text.firstChild:
405
- t_elem.appendChild(del_text.firstChild)
406
- for i in range(del_text.attributes.length):
407
- attr = del_text.attributes.item(i)
408
- t_elem.setAttribute(attr.name, attr.value)
409
- del_text.parentNode.replaceChild(t_elem, del_text)
410
-
411
- # Update run attributes: w:rsidDel → w:rsidR
412
- if new_run.hasAttribute("w:rsidDel"):
413
- new_run.setAttribute("w:rsidR", new_run.getAttribute("w:rsidDel"))
414
- new_run.removeAttribute("w:rsidDel")
415
- elif not new_run.hasAttribute("w:rsidR"):
416
- new_run.setAttribute("w:rsidR", self.rsid)
417
-
418
- ins_elem.appendChild(new_run)
419
-
420
- # Insert the new insertion after the deletion
421
- nodes = self.insert_after(del_elem, ins_elem.toxml())
422
-
423
- # If processing a single w:del, track the created insertion
424
- if is_single_del and nodes:
425
- created_insertion = nodes[0]
426
-
427
- # Return based on input type
428
- if is_single_del and created_insertion:
429
- return [elem, created_insertion]
430
- else:
431
- return [elem]
432
-
433
- @staticmethod
434
- def suggest_paragraph(xml_content: str) -> str:
435
- """Transform paragraph XML to add tracked change wrapping for insertion.
436
-
437
- Wraps runs in <w:ins> and adds <w:ins/> to w:rPr in w:pPr for numbered lists.
438
-
439
- Args:
440
- xml_content: XML string containing a <w:p> element
441
-
442
- Returns:
443
- str: Transformed XML with tracked change wrapping
444
- """
445
- wrapper = f'<root xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">{xml_content}</root>'
446
- doc = minidom.parseString(wrapper)
447
- para = doc.getElementsByTagName("w:p")[0]
448
-
449
- # Ensure w:pPr exists
450
- pPr_list = para.getElementsByTagName("w:pPr")
451
- if not pPr_list:
452
- pPr = doc.createElement("w:pPr")
453
- para.insertBefore(
454
- pPr, para.firstChild
455
- ) if para.firstChild else para.appendChild(pPr)
456
- else:
457
- pPr = pPr_list[0]
458
-
459
- # Ensure w:rPr exists in w:pPr
460
- rPr_list = pPr.getElementsByTagName("w:rPr")
461
- if not rPr_list:
462
- rPr = doc.createElement("w:rPr")
463
- pPr.appendChild(rPr)
464
- else:
465
- rPr = rPr_list[0]
466
-
467
- # Add <w:ins/> to w:rPr
468
- ins_marker = doc.createElement("w:ins")
469
- rPr.insertBefore(
470
- ins_marker, rPr.firstChild
471
- ) if rPr.firstChild else rPr.appendChild(ins_marker)
472
-
473
- # Wrap all non-pPr children in <w:ins>
474
- ins_wrapper = doc.createElement("w:ins")
475
- for child in [c for c in para.childNodes if c.nodeName != "w:pPr"]:
476
- para.removeChild(child)
477
- ins_wrapper.appendChild(child)
478
- para.appendChild(ins_wrapper)
479
-
480
- return para.toxml()
481
-
482
- def suggest_deletion(self, elem):
483
- """Mark a w:r or w:p element as deleted with tracked changes (in-place DOM manipulation).
484
-
485
- For w:r: wraps in <w:del>, converts <w:t> to <w:delText>, preserves w:rPr
486
- For w:p (regular): wraps content in <w:del>, converts <w:t> to <w:delText>
487
- For w:p (numbered list): adds <w:del/> to w:rPr in w:pPr, wraps content in <w:del>
488
-
489
- Args:
490
- elem: A w:r or w:p DOM element without existing tracked changes
491
-
492
- Returns:
493
- Element: The modified element
494
-
495
- Raises:
496
- ValueError: If element has existing tracked changes or invalid structure
497
- """
498
- if elem.nodeName == "w:r":
499
- # Check for existing w:delText
500
- if elem.getElementsByTagName("w:delText"):
501
- raise ValueError("w:r element already contains w:delText")
502
-
503
- # Convert w:t → w:delText
504
- for t_elem in list(elem.getElementsByTagName("w:t")):
505
- del_text = self.dom.createElement("w:delText")
506
- # Copy ALL child nodes (not just firstChild) to handle entities
507
- while t_elem.firstChild:
508
- del_text.appendChild(t_elem.firstChild)
509
- # Preserve attributes like xml:space
510
- for i in range(t_elem.attributes.length):
511
- attr = t_elem.attributes.item(i)
512
- del_text.setAttribute(attr.name, attr.value)
513
- t_elem.parentNode.replaceChild(del_text, t_elem)
514
-
515
- # Update run attributes: w:rsidR → w:rsidDel
516
- if elem.hasAttribute("w:rsidR"):
517
- elem.setAttribute("w:rsidDel", elem.getAttribute("w:rsidR"))
518
- elem.removeAttribute("w:rsidR")
519
- elif not elem.hasAttribute("w:rsidDel"):
520
- elem.setAttribute("w:rsidDel", self.rsid)
521
-
522
- # Wrap in w:del
523
- del_wrapper = self.dom.createElement("w:del")
524
- parent = elem.parentNode
525
- parent.insertBefore(del_wrapper, elem)
526
- parent.removeChild(elem)
527
- del_wrapper.appendChild(elem)
528
-
529
- # Inject attributes to the deletion wrapper
530
- self._inject_attributes_to_nodes([del_wrapper])
531
-
532
- return del_wrapper
533
-
534
- elif elem.nodeName == "w:p":
535
- # Check for existing tracked changes
536
- if elem.getElementsByTagName("w:ins") or elem.getElementsByTagName("w:del"):
537
- raise ValueError("w:p element already contains tracked changes")
538
-
539
- # Check if it's a numbered list item
540
- pPr_list = elem.getElementsByTagName("w:pPr")
541
- is_numbered = pPr_list and pPr_list[0].getElementsByTagName("w:numPr")
542
-
543
- if is_numbered:
544
- # Add <w:del/> to w:rPr in w:pPr
545
- pPr = pPr_list[0]
546
- rPr_list = pPr.getElementsByTagName("w:rPr")
547
-
548
- if not rPr_list:
549
- rPr = self.dom.createElement("w:rPr")
550
- pPr.appendChild(rPr)
551
- else:
552
- rPr = rPr_list[0]
553
-
554
- # Add <w:del/> marker
555
- del_marker = self.dom.createElement("w:del")
556
- rPr.insertBefore(
557
- del_marker, rPr.firstChild
558
- ) if rPr.firstChild else rPr.appendChild(del_marker)
559
-
560
- # Convert w:t → w:delText in all runs
561
- for t_elem in list(elem.getElementsByTagName("w:t")):
562
- del_text = self.dom.createElement("w:delText")
563
- # Copy ALL child nodes (not just firstChild) to handle entities
564
- while t_elem.firstChild:
565
- del_text.appendChild(t_elem.firstChild)
566
- # Preserve attributes like xml:space
567
- for i in range(t_elem.attributes.length):
568
- attr = t_elem.attributes.item(i)
569
- del_text.setAttribute(attr.name, attr.value)
570
- t_elem.parentNode.replaceChild(del_text, t_elem)
571
-
572
- # Update run attributes: w:rsidR → w:rsidDel
573
- for run in elem.getElementsByTagName("w:r"):
574
- if run.hasAttribute("w:rsidR"):
575
- run.setAttribute("w:rsidDel", run.getAttribute("w:rsidR"))
576
- run.removeAttribute("w:rsidR")
577
- elif not run.hasAttribute("w:rsidDel"):
578
- run.setAttribute("w:rsidDel", self.rsid)
579
-
580
- # Wrap all non-pPr children in <w:del>
581
- del_wrapper = self.dom.createElement("w:del")
582
- for child in [c for c in elem.childNodes if c.nodeName != "w:pPr"]:
583
- elem.removeChild(child)
584
- del_wrapper.appendChild(child)
585
- elem.appendChild(del_wrapper)
586
-
587
- # Inject attributes to the deletion wrapper
588
- self._inject_attributes_to_nodes([del_wrapper])
589
-
590
- return elem
591
-
592
- else:
593
- raise ValueError(f"Element must be w:r or w:p, got {elem.nodeName}")
594
-
595
-
596
- def _generate_hex_id() -> str:
597
- """Generate random 8-character hex ID for para/durable IDs.
598
-
599
- Values are constrained to be less than 0x7FFFFFFF per OOXML spec:
600
- - paraId must be < 0x80000000
601
- - durableId must be < 0x7FFFFFFF
602
- We use the stricter constraint (0x7FFFFFFF) for both.
603
- """
604
- return f"{random.randint(1, 0x7FFFFFFE):08X}"
605
-
606
-
607
- def _generate_rsid() -> str:
608
- """Generate random 8-character hex RSID."""
609
- return "".join(random.choices("0123456789ABCDEF", k=8))
610
-
611
-
612
- class Document:
613
- """Manages comments in unpacked Word documents."""
614
-
615
- def __init__(
616
- self,
617
- unpacked_dir,
618
- rsid=None,
619
- track_revisions=False,
620
- author="Claude",
621
- initials="C",
622
- ):
623
- """
624
- Initialize with path to unpacked Word document directory.
625
- Automatically sets up comment infrastructure (people.xml, RSIDs).
626
-
627
- Args:
628
- unpacked_dir: Path to unpacked DOCX directory (must contain word/ subdirectory)
629
- rsid: Optional RSID to use for all comment elements. If not provided, one will be generated.
630
- track_revisions: If True, enables track revisions in settings.xml (default: False)
631
- author: Default author name for comments (default: "Claude")
632
- initials: Default author initials for comments (default: "C")
633
- """
634
- self.original_path = Path(unpacked_dir)
635
-
636
- if not self.original_path.exists() or not self.original_path.is_dir():
637
- raise ValueError(f"Directory not found: {unpacked_dir}")
638
-
639
- # Create temporary directory with subdirectories for unpacked content and baseline
640
- self.temp_dir = tempfile.mkdtemp(prefix="docx_")
641
- self.unpacked_path = Path(self.temp_dir) / "unpacked"
642
- shutil.copytree(self.original_path, self.unpacked_path)
643
-
644
- # Pack original directory into temporary .docx for validation baseline (outside unpacked dir)
645
- self.original_docx = Path(self.temp_dir) / "original.docx"
646
- pack_document(self.original_path, self.original_docx, validate=False)
647
-
648
- self.word_path = self.unpacked_path / "word"
649
-
650
- # Generate RSID if not provided
651
- self.rsid = rsid if rsid else _generate_rsid()
652
- print(f"Using RSID: {self.rsid}")
653
-
654
- # Set default author and initials
655
- self.author = author
656
- self.initials = initials
657
-
658
- # Cache for lazy-loaded editors
659
- self._editors = {}
660
-
661
- # Comment file paths
662
- self.comments_path = self.word_path / "comments.xml"
663
- self.comments_extended_path = self.word_path / "commentsExtended.xml"
664
- self.comments_ids_path = self.word_path / "commentsIds.xml"
665
- self.comments_extensible_path = self.word_path / "commentsExtensible.xml"
666
-
667
- # Load existing comments and determine next ID (before setup modifies files)
668
- self.existing_comments = self._load_existing_comments()
669
- self.next_comment_id = self._get_next_comment_id()
670
-
671
- # Convenient access to document.xml editor (semi-private)
672
- self._document = self["word/document.xml"]
673
-
674
- # Setup tracked changes infrastructure
675
- self._setup_tracking(track_revisions=track_revisions)
676
-
677
- # Add author to people.xml
678
- self._add_author_to_people(author)
679
-
680
- def __getitem__(self, xml_path: str) -> DocxXMLEditor:
681
- """
682
- Get or create a DocxXMLEditor for the specified XML file.
683
-
684
- Enables lazy-loaded editors with bracket notation:
685
- node = doc["word/document.xml"].get_node(tag="w:p", line_number=42)
686
-
687
- Args:
688
- xml_path: Relative path to XML file (e.g., "word/document.xml", "word/comments.xml")
689
-
690
- Returns:
691
- DocxXMLEditor instance for the specified file
692
-
693
- Raises:
694
- ValueError: If the file does not exist
695
-
696
- Example:
697
- # Get node from document.xml
698
- node = doc["word/document.xml"].get_node(tag="w:del", attrs={"w:id": "1"})
699
-
700
- # Get node from comments.xml
701
- comment = doc["word/comments.xml"].get_node(tag="w:comment", attrs={"w:id": "0"})
702
- """
703
- if xml_path not in self._editors:
704
- file_path = self.unpacked_path / xml_path
705
- if not file_path.exists():
706
- raise ValueError(f"XML file not found: {xml_path}")
707
- # Use DocxXMLEditor with RSID, author, and initials for all editors
708
- self._editors[xml_path] = DocxXMLEditor(
709
- file_path, rsid=self.rsid, author=self.author, initials=self.initials
710
- )
711
- return self._editors[xml_path]
712
-
713
- def add_comment(self, start, end, text: str) -> int:
714
- """
715
- Add a comment spanning from one element to another.
716
-
717
- Args:
718
- start: DOM element for the starting point
719
- end: DOM element for the ending point
720
- text: Comment content
721
-
722
- Returns:
723
- The comment ID that was created
724
-
725
- Example:
726
- start_node = cm.get_document_node(tag="w:del", id="1")
727
- end_node = cm.get_document_node(tag="w:ins", id="2")
728
- cm.add_comment(start=start_node, end=end_node, text="Explanation")
729
- """
730
- comment_id = self.next_comment_id
731
- para_id = _generate_hex_id()
732
- durable_id = _generate_hex_id()
733
- timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
734
-
735
- # Add comment ranges to document.xml immediately
736
- self._document.insert_before(start, self._comment_range_start_xml(comment_id))
737
-
738
- # If end node is a paragraph, append comment markup inside it
739
- # Otherwise insert after it (for run-level anchors)
740
- if end.tagName == "w:p":
741
- self._document.append_to(end, self._comment_range_end_xml(comment_id))
742
- else:
743
- self._document.insert_after(end, self._comment_range_end_xml(comment_id))
744
-
745
- # Add to comments.xml immediately
746
- self._add_to_comments_xml(
747
- comment_id, para_id, text, self.author, self.initials, timestamp
748
- )
749
-
750
- # Add to commentsExtended.xml immediately
751
- self._add_to_comments_extended_xml(para_id, parent_para_id=None)
752
-
753
- # Add to commentsIds.xml immediately
754
- self._add_to_comments_ids_xml(para_id, durable_id)
755
-
756
- # Add to commentsExtensible.xml immediately
757
- self._add_to_comments_extensible_xml(durable_id)
758
-
759
- # Update existing_comments so replies work
760
- self.existing_comments[comment_id] = {"para_id": para_id}
761
-
762
- self.next_comment_id += 1
763
- return comment_id
764
-
765
- def reply_to_comment(
766
- self,
767
- parent_comment_id: int,
768
- text: str,
769
- ) -> int:
770
- """
771
- Add a reply to an existing comment.
772
-
773
- Args:
774
- parent_comment_id: The w:id of the parent comment to reply to
775
- text: Reply text
776
-
777
- Returns:
778
- The comment ID that was created for the reply
779
-
780
- Example:
781
- cm.reply_to_comment(parent_comment_id=0, text="I agree with this change")
782
- """
783
- if parent_comment_id not in self.existing_comments:
784
- raise ValueError(f"Parent comment with id={parent_comment_id} not found")
785
-
786
- parent_info = self.existing_comments[parent_comment_id]
787
- comment_id = self.next_comment_id
788
- para_id = _generate_hex_id()
789
- durable_id = _generate_hex_id()
790
- timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
791
-
792
- # Add comment ranges to document.xml immediately
793
- parent_start_elem = self._document.get_node(
794
- tag="w:commentRangeStart", attrs={"w:id": str(parent_comment_id)}
795
- )
796
- parent_ref_elem = self._document.get_node(
797
- tag="w:commentReference", attrs={"w:id": str(parent_comment_id)}
798
- )
799
-
800
- self._document.insert_after(
801
- parent_start_elem, self._comment_range_start_xml(comment_id)
802
- )
803
- parent_ref_run = parent_ref_elem.parentNode
804
- self._document.insert_after(
805
- parent_ref_run, f'<w:commentRangeEnd w:id="{comment_id}"/>'
806
- )
807
- self._document.insert_after(
808
- parent_ref_run, self._comment_ref_run_xml(comment_id)
809
- )
810
-
811
- # Add to comments.xml immediately
812
- self._add_to_comments_xml(
813
- comment_id, para_id, text, self.author, self.initials, timestamp
814
- )
815
-
816
- # Add to commentsExtended.xml immediately (with parent)
817
- self._add_to_comments_extended_xml(
818
- para_id, parent_para_id=parent_info["para_id"]
819
- )
820
-
821
- # Add to commentsIds.xml immediately
822
- self._add_to_comments_ids_xml(para_id, durable_id)
823
-
824
- # Add to commentsExtensible.xml immediately
825
- self._add_to_comments_extensible_xml(durable_id)
826
-
827
- # Update existing_comments so replies work
828
- self.existing_comments[comment_id] = {"para_id": para_id}
829
-
830
- self.next_comment_id += 1
831
- return comment_id
832
-
833
- def __del__(self):
834
- """Clean up temporary directory on deletion."""
835
- if hasattr(self, "temp_dir") and Path(self.temp_dir).exists():
836
- shutil.rmtree(self.temp_dir)
837
-
838
- def validate(self) -> None:
839
- """
840
- Validate the document against XSD schema and redlining rules.
841
-
842
- Raises:
843
- ValueError: If validation fails.
844
- """
845
- # Create validators with current state
846
- schema_validator = DOCXSchemaValidator(
847
- self.unpacked_path, self.original_docx, verbose=False
848
- )
849
- redlining_validator = RedliningValidator(
850
- self.unpacked_path, self.original_docx, verbose=False
851
- )
852
-
853
- # Run validations
854
- if not schema_validator.validate():
855
- raise ValueError("Schema validation failed")
856
- if not redlining_validator.validate():
857
- raise ValueError("Redlining validation failed")
858
-
859
- def save(self, destination=None, validate=True) -> None:
860
- """
861
- Save all modified XML files to disk and copy to destination directory.
862
-
863
- This persists all changes made via add_comment() and reply_to_comment().
864
-
865
- Args:
866
- destination: Optional path to save to. If None, saves back to original directory.
867
- validate: If True, validates document before saving (default: True).
868
- """
869
- # Only ensure comment relationships and content types if comment files exist
870
- if self.comments_path.exists():
871
- self._ensure_comment_relationships()
872
- self._ensure_comment_content_types()
873
-
874
- # Save all modified XML files in temp directory
875
- for editor in self._editors.values():
876
- editor.save()
877
-
878
- # Validate by default
879
- if validate:
880
- self.validate()
881
-
882
- # Copy contents from temp directory to destination (or original directory)
883
- target_path = Path(destination) if destination else self.original_path
884
- shutil.copytree(self.unpacked_path, target_path, dirs_exist_ok=True)
885
-
886
- # ==================== Private: Initialization ====================
887
-
888
- def _get_next_comment_id(self):
889
- """Get the next available comment ID."""
890
- if not self.comments_path.exists():
891
- return 0
892
-
893
- editor = self["word/comments.xml"]
894
- max_id = -1
895
- for comment_elem in editor.dom.getElementsByTagName("w:comment"):
896
- comment_id = comment_elem.getAttribute("w:id")
897
- if comment_id:
898
- try:
899
- max_id = max(max_id, int(comment_id))
900
- except ValueError:
901
- pass
902
- return max_id + 1
903
-
904
- def _load_existing_comments(self):
905
- """Load existing comments from files to enable replies."""
906
- if not self.comments_path.exists():
907
- return {}
908
-
909
- editor = self["word/comments.xml"]
910
- existing = {}
911
-
912
- for comment_elem in editor.dom.getElementsByTagName("w:comment"):
913
- comment_id = comment_elem.getAttribute("w:id")
914
- if not comment_id:
915
- continue
916
-
917
- # Find para_id from the w:p element within the comment
918
- para_id = None
919
- for p_elem in comment_elem.getElementsByTagName("w:p"):
920
- para_id = p_elem.getAttribute("w14:paraId")
921
- if para_id:
922
- break
923
-
924
- if not para_id:
925
- continue
926
-
927
- existing[int(comment_id)] = {"para_id": para_id}
928
-
929
- return existing
930
-
931
- # ==================== Private: Setup Methods ====================
932
-
933
- def _setup_tracking(self, track_revisions=False):
934
- """Set up comment infrastructure in unpacked directory.
935
-
936
- Args:
937
- track_revisions: If True, enables track revisions in settings.xml
938
- """
939
- # Create or update word/people.xml
940
- people_file = self.word_path / "people.xml"
941
- self._update_people_xml(people_file)
942
-
943
- # Update XML files
944
- self._add_content_type_for_people(self.unpacked_path / "[Content_Types].xml")
945
- self._add_relationship_for_people(
946
- self.word_path / "_rels" / "document.xml.rels"
947
- )
948
-
949
- # Always add RSID to settings.xml, optionally enable trackRevisions
950
- self._update_settings(
951
- self.word_path / "settings.xml", track_revisions=track_revisions
952
- )
953
-
954
- def _update_people_xml(self, path):
955
- """Create people.xml if it doesn't exist."""
956
- if not path.exists():
957
- # Copy from template
958
- shutil.copy(TEMPLATE_DIR / "people.xml", path)
959
-
960
- def _add_content_type_for_people(self, path):
961
- """Add people.xml content type to [Content_Types].xml if not already present."""
962
- editor = self["[Content_Types].xml"]
963
-
964
- if self._has_override(editor, "/word/people.xml"):
965
- return
966
-
967
- # Add Override element
968
- root = editor.dom.documentElement
969
- override_xml = '<Override PartName="/word/people.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.people+xml"/>'
970
- editor.append_to(root, override_xml)
971
-
972
- def _add_relationship_for_people(self, path):
973
- """Add people.xml relationship to document.xml.rels if not already present."""
974
- editor = self["word/_rels/document.xml.rels"]
975
-
976
- if self._has_relationship(editor, "people.xml"):
977
- return
978
-
979
- root = editor.dom.documentElement
980
- root_tag = root.tagName # type: ignore
981
- prefix = root_tag.split(":")[0] + ":" if ":" in root_tag else ""
982
- next_rid = editor.get_next_rid()
983
-
984
- # Create the relationship entry
985
- rel_xml = f'<{prefix}Relationship Id="{next_rid}" Type="http://schemas.microsoft.com/office/2011/relationships/people" Target="people.xml"/>'
986
- editor.append_to(root, rel_xml)
987
-
988
- def _update_settings(self, path, track_revisions=False):
989
- """Add RSID and optionally enable track revisions in settings.xml.
990
-
991
- Args:
992
- path: Path to settings.xml
993
- track_revisions: If True, adds trackRevisions element
994
-
995
- Places elements per OOXML schema order:
996
- - trackRevisions: early (before defaultTabStop)
997
- - rsids: late (after compat)
998
- """
999
- editor = self["word/settings.xml"]
1000
- root = editor.get_node(tag="w:settings")
1001
- prefix = root.tagName.split(":")[0] if ":" in root.tagName else "w"
1002
-
1003
- # Conditionally add trackRevisions if requested
1004
- if track_revisions:
1005
- track_revisions_exists = any(
1006
- elem.tagName == f"{prefix}:trackRevisions"
1007
- for elem in editor.dom.getElementsByTagName(f"{prefix}:trackRevisions")
1008
- )
1009
-
1010
- if not track_revisions_exists:
1011
- track_rev_xml = f"<{prefix}:trackRevisions/>"
1012
- # Try to insert before documentProtection, defaultTabStop, or at start
1013
- inserted = False
1014
- for tag in [f"{prefix}:documentProtection", f"{prefix}:defaultTabStop"]:
1015
- elements = editor.dom.getElementsByTagName(tag)
1016
- if elements:
1017
- editor.insert_before(elements[0], track_rev_xml)
1018
- inserted = True
1019
- break
1020
- if not inserted:
1021
- # Insert as first child of settings
1022
- if root.firstChild:
1023
- editor.insert_before(root.firstChild, track_rev_xml)
1024
- else:
1025
- editor.append_to(root, track_rev_xml)
1026
-
1027
- # Always check if rsids section exists
1028
- rsids_elements = editor.dom.getElementsByTagName(f"{prefix}:rsids")
1029
-
1030
- if not rsids_elements:
1031
- # Add new rsids section
1032
- rsids_xml = f'''<{prefix}:rsids>
1033
- <{prefix}:rsidRoot {prefix}:val="{self.rsid}"/>
1034
- <{prefix}:rsid {prefix}:val="{self.rsid}"/>
1035
- </{prefix}:rsids>'''
1036
-
1037
- # Try to insert after compat, before clrSchemeMapping, or before closing tag
1038
- inserted = False
1039
- compat_elements = editor.dom.getElementsByTagName(f"{prefix}:compat")
1040
- if compat_elements:
1041
- editor.insert_after(compat_elements[0], rsids_xml)
1042
- inserted = True
1043
-
1044
- if not inserted:
1045
- clr_elements = editor.dom.getElementsByTagName(
1046
- f"{prefix}:clrSchemeMapping"
1047
- )
1048
- if clr_elements:
1049
- editor.insert_before(clr_elements[0], rsids_xml)
1050
- inserted = True
1051
-
1052
- if not inserted:
1053
- editor.append_to(root, rsids_xml)
1054
- else:
1055
- # Check if this rsid already exists
1056
- rsids_elem = rsids_elements[0]
1057
- rsid_exists = any(
1058
- elem.getAttribute(f"{prefix}:val") == self.rsid
1059
- for elem in rsids_elem.getElementsByTagName(f"{prefix}:rsid")
1060
- )
1061
-
1062
- if not rsid_exists:
1063
- rsid_xml = f'<{prefix}:rsid {prefix}:val="{self.rsid}"/>'
1064
- editor.append_to(rsids_elem, rsid_xml)
1065
-
1066
- # ==================== Private: XML File Creation ====================
1067
-
1068
- def _add_to_comments_xml(
1069
- self, comment_id, para_id, text, author, initials, timestamp
1070
- ):
1071
- """Add a single comment to comments.xml."""
1072
- if not self.comments_path.exists():
1073
- shutil.copy(TEMPLATE_DIR / "comments.xml", self.comments_path)
1074
-
1075
- editor = self["word/comments.xml"]
1076
- root = editor.get_node(tag="w:comments")
1077
-
1078
- escaped_text = (
1079
- text.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;")
1080
- )
1081
- # Note: w:rsidR, w:rsidRDefault, w:rsidP on w:p, w:rsidR on w:r,
1082
- # and w:author, w:date, w:initials on w:comment are automatically added by DocxXMLEditor
1083
- comment_xml = f'''<w:comment w:id="{comment_id}">
1084
- <w:p w14:paraId="{para_id}" w14:textId="77777777">
1085
- <w:r><w:rPr><w:rStyle w:val="CommentReference"/></w:rPr><w:annotationRef/></w:r>
1086
- <w:r><w:rPr><w:color w:val="000000"/><w:sz w:val="20"/><w:szCs w:val="20"/></w:rPr><w:t>{escaped_text}</w:t></w:r>
1087
- </w:p>
1088
- </w:comment>'''
1089
- editor.append_to(root, comment_xml)
1090
-
1091
- def _add_to_comments_extended_xml(self, para_id, parent_para_id):
1092
- """Add a single comment to commentsExtended.xml."""
1093
- if not self.comments_extended_path.exists():
1094
- shutil.copy(
1095
- TEMPLATE_DIR / "commentsExtended.xml", self.comments_extended_path
1096
- )
1097
-
1098
- editor = self["word/commentsExtended.xml"]
1099
- root = editor.get_node(tag="w15:commentsEx")
1100
-
1101
- if parent_para_id:
1102
- xml = f'<w15:commentEx w15:paraId="{para_id}" w15:paraIdParent="{parent_para_id}" w15:done="0"/>'
1103
- else:
1104
- xml = f'<w15:commentEx w15:paraId="{para_id}" w15:done="0"/>'
1105
- editor.append_to(root, xml)
1106
-
1107
- def _add_to_comments_ids_xml(self, para_id, durable_id):
1108
- """Add a single comment to commentsIds.xml."""
1109
- if not self.comments_ids_path.exists():
1110
- shutil.copy(TEMPLATE_DIR / "commentsIds.xml", self.comments_ids_path)
1111
-
1112
- editor = self["word/commentsIds.xml"]
1113
- root = editor.get_node(tag="w16cid:commentsIds")
1114
-
1115
- xml = f'<w16cid:commentId w16cid:paraId="{para_id}" w16cid:durableId="{durable_id}"/>'
1116
- editor.append_to(root, xml)
1117
-
1118
- def _add_to_comments_extensible_xml(self, durable_id):
1119
- """Add a single comment to commentsExtensible.xml."""
1120
- if not self.comments_extensible_path.exists():
1121
- shutil.copy(
1122
- TEMPLATE_DIR / "commentsExtensible.xml", self.comments_extensible_path
1123
- )
1124
-
1125
- editor = self["word/commentsExtensible.xml"]
1126
- root = editor.get_node(tag="w16cex:commentsExtensible")
1127
-
1128
- xml = f'<w16cex:commentExtensible w16cex:durableId="{durable_id}"/>'
1129
- editor.append_to(root, xml)
1130
-
1131
- # ==================== Private: XML Fragments ====================
1132
-
1133
- def _comment_range_start_xml(self, comment_id):
1134
- """Generate XML for comment range start."""
1135
- return f'<w:commentRangeStart w:id="{comment_id}"/>'
1136
-
1137
- def _comment_range_end_xml(self, comment_id):
1138
- """Generate XML for comment range end with reference run.
1139
-
1140
- Note: w:rsidR is automatically added by DocxXMLEditor.
1141
- """
1142
- return f'''<w:commentRangeEnd w:id="{comment_id}"/>
1143
- <w:r>
1144
- <w:rPr><w:rStyle w:val="CommentReference"/></w:rPr>
1145
- <w:commentReference w:id="{comment_id}"/>
1146
- </w:r>'''
1147
-
1148
- def _comment_ref_run_xml(self, comment_id):
1149
- """Generate XML for comment reference run.
1150
-
1151
- Note: w:rsidR is automatically added by DocxXMLEditor.
1152
- """
1153
- return f'''<w:r>
1154
- <w:rPr><w:rStyle w:val="CommentReference"/></w:rPr>
1155
- <w:commentReference w:id="{comment_id}"/>
1156
- </w:r>'''
1157
-
1158
- # ==================== Private: Metadata Updates ====================
1159
-
1160
- def _has_relationship(self, editor, target):
1161
- """Check if a relationship with given target exists."""
1162
- for rel_elem in editor.dom.getElementsByTagName("Relationship"):
1163
- if rel_elem.getAttribute("Target") == target:
1164
- return True
1165
- return False
1166
-
1167
- def _has_override(self, editor, part_name):
1168
- """Check if an override with given part name exists."""
1169
- for override_elem in editor.dom.getElementsByTagName("Override"):
1170
- if override_elem.getAttribute("PartName") == part_name:
1171
- return True
1172
- return False
1173
-
1174
- def _has_author(self, editor, author):
1175
- """Check if an author already exists in people.xml."""
1176
- for person_elem in editor.dom.getElementsByTagName("w15:person"):
1177
- if person_elem.getAttribute("w15:author") == author:
1178
- return True
1179
- return False
1180
-
1181
- def _add_author_to_people(self, author):
1182
- """Add author to people.xml (called during initialization)."""
1183
- people_path = self.word_path / "people.xml"
1184
-
1185
- # people.xml should already exist from _setup_tracking
1186
- if not people_path.exists():
1187
- raise ValueError("people.xml should exist after _setup_tracking")
1188
-
1189
- editor = self["word/people.xml"]
1190
- root = editor.get_node(tag="w15:people")
1191
-
1192
- # Check if author already exists
1193
- if self._has_author(editor, author):
1194
- return
1195
-
1196
- # Add author with proper XML escaping to prevent injection
1197
- escaped_author = html.escape(author, quote=True)
1198
- person_xml = f'''<w15:person w15:author="{escaped_author}">
1199
- <w15:presenceInfo w15:providerId="None" w15:userId="{escaped_author}"/>
1200
- </w15:person>'''
1201
- editor.append_to(root, person_xml)
1202
-
1203
- def _ensure_comment_relationships(self):
1204
- """Ensure word/_rels/document.xml.rels has comment relationships."""
1205
- editor = self["word/_rels/document.xml.rels"]
1206
-
1207
- if self._has_relationship(editor, "comments.xml"):
1208
- return
1209
-
1210
- root = editor.dom.documentElement
1211
- root_tag = root.tagName # type: ignore
1212
- prefix = root_tag.split(":")[0] + ":" if ":" in root_tag else ""
1213
- next_rid_num = int(editor.get_next_rid()[3:])
1214
-
1215
- # Add relationship elements
1216
- rels = [
1217
- (
1218
- next_rid_num,
1219
- "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments",
1220
- "comments.xml",
1221
- ),
1222
- (
1223
- next_rid_num + 1,
1224
- "http://schemas.microsoft.com/office/2011/relationships/commentsExtended",
1225
- "commentsExtended.xml",
1226
- ),
1227
- (
1228
- next_rid_num + 2,
1229
- "http://schemas.microsoft.com/office/2016/09/relationships/commentsIds",
1230
- "commentsIds.xml",
1231
- ),
1232
- (
1233
- next_rid_num + 3,
1234
- "http://schemas.microsoft.com/office/2018/08/relationships/commentsExtensible",
1235
- "commentsExtensible.xml",
1236
- ),
1237
- ]
1238
-
1239
- for rel_id, rel_type, target in rels:
1240
- rel_xml = f'<{prefix}Relationship Id="rId{rel_id}" Type="{rel_type}" Target="{target}"/>'
1241
- editor.append_to(root, rel_xml)
1242
-
1243
- def _ensure_comment_content_types(self):
1244
- """Ensure [Content_Types].xml has comment content types."""
1245
- editor = self["[Content_Types].xml"]
1246
-
1247
- if self._has_override(editor, "/word/comments.xml"):
1248
- return
1249
-
1250
- root = editor.dom.documentElement
1251
-
1252
- # Add Override elements
1253
- overrides = [
1254
- (
1255
- "/word/comments.xml",
1256
- "application/vnd.openxmlformats-officedocument.wordprocessingml.comments+xml",
1257
- ),
1258
- (
1259
- "/word/commentsExtended.xml",
1260
- "application/vnd.openxmlformats-officedocument.wordprocessingml.commentsExtended+xml",
1261
- ),
1262
- (
1263
- "/word/commentsIds.xml",
1264
- "application/vnd.openxmlformats-officedocument.wordprocessingml.commentsIds+xml",
1265
- ),
1266
- (
1267
- "/word/commentsExtensible.xml",
1268
- "application/vnd.openxmlformats-officedocument.wordprocessingml.commentsExtensible+xml",
1269
- ),
1270
- ]
1271
-
1272
- for part_name, content_type in overrides:
1273
- override_xml = (
1274
- f'<Override PartName="{part_name}" ContentType="{content_type}"/>'
1275
- )
1276
- editor.append_to(root, override_xml)