@uipath/delegate-sdk 1.203.1 → 1.203.2
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.
- package/README.md +41 -3
- package/dist/index.mjs +2 -2
- package/dist/skills/business-analysis/SKILL.md +722 -0
- package/dist/skills/business-analysis/as-is-capture.md +440 -0
- package/dist/skills/business-analysis/assets/progress.yaml +19 -0
- package/dist/skills/business-analysis/assets/task-list.md +34 -0
- package/dist/skills/business-analysis/automation-hub-publishing.md +47 -0
- package/dist/skills/business-analysis/bpmn-to-be-design.md +274 -0
- package/dist/skills/business-analysis/case-to-be-design.md +223 -0
- package/dist/skills/business-analysis/diagram-authoring.md +215 -0
- package/dist/skills/business-analysis/industry-gaps.md +134 -0
- package/dist/skills/business-analysis/interview-spine.md +297 -0
- package/dist/skills/business-analysis/locales/de.json +54 -0
- package/dist/skills/business-analysis/locales/en.json +54 -0
- package/dist/skills/business-analysis/locales/es-MX.json +54 -0
- package/dist/skills/business-analysis/locales/es.json +54 -0
- package/dist/skills/business-analysis/locales/fr.json +54 -0
- package/dist/skills/business-analysis/locales/ja.json +54 -0
- package/dist/skills/business-analysis/locales/ko.json +54 -0
- package/dist/skills/business-analysis/locales/pt-BR.json +54 -0
- package/dist/skills/business-analysis/locales/pt.json +54 -0
- package/dist/skills/business-analysis/locales/ro.json +54 -0
- package/dist/skills/business-analysis/locales/tr.json +54 -0
- package/dist/skills/business-analysis/locales/zh-CN.json +54 -0
- package/dist/skills/business-analysis/locales/zh-TW.json +54 -0
- package/dist/skills/business-analysis/pdd-generation.md +204 -0
- package/dist/skills/business-analysis/pdd-template.md +562 -0
- package/dist/skills/business-analysis/progress-presentation.json +13 -0
- package/dist/skills/business-analysis/recording-first.md +19 -0
- package/dist/skills/business-analysis/recording-processing.md +152 -0
- package/dist/skills/business-analysis/references/automation-hub-open-api.md +57 -0
- package/dist/skills/business-analysis/references/case-definition-spec.md +90 -0
- package/dist/skills/business-analysis/references/case-design-patterns/loan-origination-spec.md +86 -0
- package/dist/skills/business-analysis/references/component-type-mapping.md +52 -0
- package/dist/skills/business-analysis/references/uipath-products/case-management-schema.md +62 -0
- package/dist/skills/business-analysis/references/uipath-products/maestro-case-framework.md +65 -0
- package/dist/skills/business-analysis/references/uipath-products/maestro-case-management.md +49 -0
- package/dist/skills/business-analysis/research-offer.md +104 -0
- package/dist/skills/business-analysis/research-pass.md +149 -0
- package/dist/skills/business-analysis/scripts/assemble-pdd.ps1 +294 -0
- package/dist/skills/business-analysis/scripts/assemble-pdd.sh +453 -0
- package/dist/skills/business-analysis/scripts/check-phase-ready.ps1 +72 -0
- package/dist/skills/business-analysis/scripts/check-phase-ready.sh +98 -0
- package/dist/skills/business-analysis/scripts/lint-diagram.ps1 +524 -0
- package/dist/skills/business-analysis/scripts/lint-diagram.sh +519 -0
- package/dist/skills/business-analysis/scripts/stamp-pages.ps1 +363 -0
- package/dist/skills/business-analysis/scripts/stamp-pages.sh +360 -0
- package/dist/skills/business-analysis/to-be-design.md +199 -0
- package/dist/skills/confluence/SKILL.md +386 -0
- package/dist/skills/doc-coauthoring/SKILL.md +295 -0
- package/dist/skills/excel-architect/SKILL.macos.md +161 -0
- package/dist/skills/excel-architect/SKILL.md +180 -0
- package/dist/skills/excel-architect/SKILL.windows.md +61 -0
- package/dist/skills/excel-architect/archetypes/01-financial-model-advanced.md +332 -0
- package/dist/skills/excel-architect/archetypes/01-financial-model.md +248 -0
- package/dist/skills/excel-architect/archetypes/02-data-analysis.md +171 -0
- package/dist/skills/excel-architect/archetypes/03-tracking-dashboard.md +160 -0
- package/dist/skills/excel-architect/archetypes/04-project-planning.md +193 -0
- package/dist/skills/excel-architect/archetypes/05-simple-table.md +111 -0
- package/dist/skills/excel-architect/building.md +279 -0
- package/dist/skills/excel-architect/create.md +64 -0
- package/dist/skills/excel-architect/data-and-formulas.md +186 -0
- package/dist/skills/excel-architect/generator.md +272 -0
- package/dist/skills/excel-architect/macos/scripts/add-data-validation.applescript +242 -0
- package/dist/skills/excel-architect/macos/scripts/append-rows.applescript +310 -0
- package/dist/skills/excel-architect/macos/scripts/apply-conditional-format.applescript +565 -0
- package/dist/skills/excel-architect/macos/scripts/autofit-columns.applescript +79 -0
- package/dist/skills/excel-architect/macos/scripts/benchmark.sh +135 -0
- package/dist/skills/excel-architect/macos/scripts/check-compile.sh +30 -0
- package/dist/skills/excel-architect/macos/scripts/clear-range.applescript +152 -0
- package/dist/skills/excel-architect/macos/scripts/copy-paste.applescript +179 -0
- package/dist/skills/excel-architect/macos/scripts/create-chart.applescript +531 -0
- package/dist/skills/excel-architect/macos/scripts/create-pivot.applescript +443 -0
- package/dist/skills/excel-architect/macos/scripts/create-sheets.applescript +264 -0
- package/dist/skills/excel-architect/macos/scripts/create-workbook.applescript +92 -0
- package/dist/skills/excel-architect/macos/scripts/delete-chart.applescript +105 -0
- package/dist/skills/excel-architect/macos/scripts/delete-sheet.applescript +127 -0
- package/dist/skills/excel-architect/macos/scripts/filter-data.applescript +213 -0
- package/dist/skills/excel-architect/macos/scripts/find-replace.applescript +238 -0
- package/dist/skills/excel-architect/macos/scripts/format-range.applescript +531 -0
- package/dist/skills/excel-architect/macos/scripts/freeze-panes.applescript +133 -0
- package/dist/skills/excel-architect/macos/scripts/get-current-file.applescript +24 -0
- package/dist/skills/excel-architect/macos/scripts/get-sheet-dimensions.applescript +115 -0
- package/dist/skills/excel-architect/macos/scripts/health-check.applescript +704 -0
- package/dist/skills/excel-architect/macos/scripts/list-open-workbooks.applescript +80 -0
- package/dist/skills/excel-architect/macos/scripts/maximize-window.applescript +47 -0
- package/dist/skills/excel-architect/macos/scripts/merge-cells.applescript +227 -0
- package/dist/skills/excel-architect/macos/scripts/open-workbook.applescript +139 -0
- package/dist/skills/excel-architect/macos/scripts/read-range.applescript +267 -0
- package/dist/skills/excel-architect/macos/scripts/rename-sheet.applescript +231 -0
- package/dist/skills/excel-architect/macos/scripts/select-sheet.applescript +133 -0
- package/dist/skills/excel-architect/macos/scripts/set-tab-color.applescript +109 -0
- package/dist/skills/excel-architect/macos/scripts/sort-data.applescript +136 -0
- package/dist/skills/excel-architect/macos/scripts/undo.applescript +59 -0
- package/dist/skills/excel-architect/macos/scripts/workbook-lifecycle.applescript +149 -0
- package/dist/skills/excel-architect/macos/scripts/write-formula.applescript +225 -0
- package/dist/skills/excel-architect/macos/scripts/write-range.applescript +351 -0
- package/dist/skills/excel-architect/reference/api/advanced.md +381 -0
- package/dist/skills/excel-architect/reference/api/basic.md +747 -0
- package/dist/skills/excel-architect/reference/guides.md +348 -0
- package/dist/skills/excel-architect/reference/repair.md +174 -0
- package/dist/skills/excel-architect/reference/troubleshooting.md +46 -0
- package/dist/skills/excel-architect/scripting.md +266 -0
- package/dist/skills/excel-architect/styling-and-features.md +433 -0
- package/dist/skills/excel-architect/windows/api/composites.md +337 -0
- package/dist/skills/excel-architect/windows/api/scripting.md +139 -0
- package/dist/skills/excel-architect/windows/examples/level-1-workflows.md +485 -0
- package/dist/skills/excel-architect/windows/examples/level-2-advanced.md +690 -0
- package/dist/skills/excel-architect/windows/examples/level-3-scripting.md +337 -0
- package/dist/skills/github/SKILL.md +446 -0
- package/dist/skills/github/recipes/add-comment.md +85 -0
- package/dist/skills/github/recipes/check-pr-status.md +122 -0
- package/dist/skills/github/recipes/compare-branches.md +79 -0
- package/dist/skills/github/recipes/create-issue.md +103 -0
- package/dist/skills/github/recipes/create-pr.md +97 -0
- package/dist/skills/github/recipes/get-file-contents.md +76 -0
- package/dist/skills/github/recipes/get-last-commit.md +128 -0
- package/dist/skills/github/recipes/list-my-open-prs.md +105 -0
- package/dist/skills/github/recipes/list-recent-commits.md +84 -0
- package/dist/skills/github/recipes/search-issues.md +115 -0
- package/dist/skills/google-workspace/SKILL.md +217 -0
- package/dist/skills/google-workspace/services/calendar.md +311 -0
- package/dist/skills/google-workspace/services/docs.md +426 -0
- package/dist/skills/google-workspace/services/drive.md +504 -0
- package/dist/skills/google-workspace/services/gmail.md +466 -0
- package/dist/skills/google-workspace/services/sheets.md +370 -0
- package/dist/skills/internal-comms/SKILL.md +35 -0
- package/dist/skills/internal-comms/examples/3p-updates.md +47 -0
- package/dist/skills/internal-comms/examples/company-newsletter.md +65 -0
- package/dist/skills/internal-comms/examples/faq-answers.md +30 -0
- package/dist/skills/internal-comms/examples/general-comms.md +15 -0
- package/dist/skills/jira/SKILL.md +397 -0
- package/dist/skills/jira/recipes/add-comment.md +123 -0
- package/dist/skills/jira/recipes/assign-issue.md +157 -0
- package/dist/skills/jira/recipes/create-issue.md +274 -0
- package/dist/skills/jira/recipes/get-issue-details.md +154 -0
- package/dist/skills/jira/recipes/list-projects.md +151 -0
- package/dist/skills/jira/recipes/my-issues.md +180 -0
- package/dist/skills/jira/recipes/search-issues.md +215 -0
- package/dist/skills/jira/recipes/transition-issue.md +154 -0
- package/dist/skills/jira/recipes/troubleshooting.md +387 -0
- package/dist/skills/knowledge-base/SKILL.md +289 -0
- package/dist/skills/media-tools/SKILL.md +204 -0
- package/dist/skills/media-tools/references/encode-runbook.md +24 -0
- package/dist/skills/media-tools/references/resolve-binaries.md +81 -0
- package/dist/skills/media-tools/scripts/macos/ff-launch.sh +22 -0
- package/dist/skills/media-tools/scripts/macos/ff-poll.sh +10 -0
- package/dist/skills/media-tools/scripts/windows/ff-launch.ps1 +34 -0
- package/dist/skills/media-tools/scripts/windows/ff-poll.ps1 +20 -0
- package/dist/skills/office-download/SKILL.md +161 -0
- package/dist/skills/outlook-365/SKILL.macos.md +331 -0
- package/dist/skills/outlook-365/SKILL.md +171 -0
- package/dist/skills/outlook-365/SKILL.windows.md +124 -0
- package/dist/skills/outlook-365/api/bulk-email-operations.md +178 -0
- package/dist/skills/outlook-365/api/check-availability.md +87 -0
- package/dist/skills/outlook-365/api/create-inbox-rule.md +182 -0
- package/dist/skills/outlook-365/api/download-attachments.md +149 -0
- package/dist/skills/outlook-365/api/find-and-email-contact.md +185 -0
- package/dist/skills/outlook-365/api/manage-calendar-events.md +189 -0
- package/dist/skills/outlook-365/api/organize-with-folders.md +178 -0
- package/dist/skills/outlook-365/api/reply-to-conversation.md +68 -0
- package/dist/skills/outlook-365/api/schedule-meeting.md +73 -0
- package/dist/skills/outlook-365/api/search-and-read-email.md +93 -0
- package/dist/skills/outlook-365/api/send-email-with-attachments.md +94 -0
- package/dist/skills/outlook-365/api/send-email.md +396 -0
- package/dist/skills/outlook-365/api/set-out-of-office.md +196 -0
- package/dist/skills/outlook-365/macos/scripts/bulk-operations.applescript +429 -0
- package/dist/skills/outlook-365/macos/scripts/calendar.applescript +642 -0
- package/dist/skills/outlook-365/macos/scripts/contacts.applescript +635 -0
- package/dist/skills/outlook-365/macos/scripts/helpers.applescript +227 -0
- package/dist/skills/outlook-365/macos/scripts/read-emails.applescript +299 -0
- package/dist/skills/outlook-365/macos/scripts/search-emails.applescript +339 -0
- package/dist/skills/outlook-365/macos/scripts/send-email.applescript +245 -0
- package/dist/skills/outlook-365/uia/BASIC_OPERATIONS.md +278 -0
- package/dist/skills/outlook-365/uia/CALENDAR_OPERATIONS.md +386 -0
- package/dist/skills/outlook-365/uia/COMPOSE_EMAIL.md +426 -0
- package/dist/skills/outlook-365/uia/README.md +75 -0
- package/dist/skills/outlook-365/windows/com/bulk-operations.ps1 +241 -0
- package/dist/skills/outlook-365/windows/com/calendar.ps1 +227 -0
- package/dist/skills/outlook-365/windows/com/contacts.ps1 +270 -0
- package/dist/skills/outlook-365/windows/com/helpers.ps1 +158 -0
- package/dist/skills/outlook-365/windows/com/read-emails.ps1 +115 -0
- package/dist/skills/outlook-365/windows/com/search-emails.ps1 +141 -0
- package/dist/skills/outlook-365/windows/com/send-email.ps1 +121 -0
- package/dist/skills/pdf-architect/SKILL.md +640 -0
- package/dist/skills/powerpoint-architect/SKILL.macos.md +271 -0
- package/dist/skills/powerpoint-architect/SKILL.md +853 -0
- package/dist/skills/powerpoint-architect/SKILL.windows.md +458 -0
- package/dist/skills/powerpoint-architect/custom_themes.md +141 -0
- package/dist/skills/powerpoint-architect/editing-guide.md +424 -0
- package/dist/skills/powerpoint-architect/generator-reference.md +668 -0
- package/dist/skills/powerpoint-architect/images-guide.md +207 -0
- package/dist/skills/powerpoint-architect/issue-fix-mapping.md +768 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-html-to-slide.applescript +389 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-slide.applescript +255 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-speaker-notes.applescript +132 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-text.applescript +245 -0
- package/dist/skills/powerpoint-architect/macos/scripts/apply-slide-layout.applescript +80 -0
- package/dist/skills/powerpoint-architect/macos/scripts/apply-theme.applescript +122 -0
- package/dist/skills/powerpoint-architect/macos/scripts/autofit-placeholders.applescript +62 -0
- package/dist/skills/powerpoint-architect/macos/scripts/close-presentation.applescript +24 -0
- package/dist/skills/powerpoint-architect/macos/scripts/copy-slides.applescript +303 -0
- package/dist/skills/powerpoint-architect/macos/scripts/create-chart-with-data.applescript +305 -0
- package/dist/skills/powerpoint-architect/macos/scripts/create-with-theme.applescript +56 -0
- package/dist/skills/powerpoint-architect/macos/scripts/delete-slides.applescript +137 -0
- package/dist/skills/powerpoint-architect/macos/scripts/export-presentation.applescript +100 -0
- package/dist/skills/powerpoint-architect/macos/scripts/extract-slide-data.applescript +138 -0
- package/dist/skills/powerpoint-architect/macos/scripts/format-shape.applescript +192 -0
- package/dist/skills/powerpoint-architect/macos/scripts/format-slide-content.applescript +336 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-current-slide-number.applescript +38 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-file-path.applescript +94 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-layout-elements.applescript +141 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-layouts.applescript +58 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-opened-files.applescript +50 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-presentation-info.applescript +150 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-recent-files.applescript +68 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-slide-count.applescript +37 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-slide-info.applescript +105 -0
- package/dist/skills/powerpoint-architect/macos/scripts/health-check.applescript +690 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-shape.applescript +188 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-table.applescript +112 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-text-box.applescript +225 -0
- package/dist/skills/powerpoint-architect/macos/scripts/manage-image.applescript +486 -0
- package/dist/skills/powerpoint-architect/macos/scripts/maximize-window.applescript +48 -0
- package/dist/skills/powerpoint-architect/macos/scripts/navigate-to-slide.applescript +84 -0
- package/dist/skills/powerpoint-architect/macos/scripts/open-presentation.applescript +38 -0
- package/dist/skills/powerpoint-architect/macos/scripts/reorder-slides.applescript +106 -0
- package/dist/skills/powerpoint-architect/macos/scripts/replace-text.applescript +193 -0
- package/dist/skills/powerpoint-architect/macos/scripts/save-presentation.applescript +54 -0
- package/dist/skills/powerpoint-architect/macos/scripts/set-animation.applescript +203 -0
- package/dist/skills/powerpoint-architect/macos/scripts/set-transition.applescript +130 -0
- package/dist/skills/powerpoint-architect/visual-styling-guide.md +206 -0
- package/dist/skills/powerpoint-architect/windows/api/advanced.md +317 -0
- package/dist/skills/powerpoint-architect/windows/api/basic.md +392 -0
- package/dist/skills/powerpoint-architect/windows/examples/10-slide-presentation.md +140 -0
- package/dist/skills/powerpoint-architect/windows/examples/custom-theme-workflow.md +219 -0
- package/dist/skills/powerpoint-architect/windows/examples/level-1-workflows.md +531 -0
- package/dist/skills/powerpoint-architect/windows/examples/level-2-scripting.md +239 -0
- package/dist/skills/powerpoint-architect/windows/scripts/create-with-theme.ps1 +81 -0
- package/dist/skills/project-task-list/SKILL.md +174 -0
- package/dist/skills/slack-operation/SKILL.md +97 -0
- package/dist/skills/slack-operation/api/advanced-api/GUIDE.md +277 -0
- package/dist/skills/slack-operation/api/search-and-read/EXAMPLE.md +75 -0
- package/dist/skills/slack-operation/api/search-and-read/GUIDE.md +108 -0
- package/dist/skills/slack-operation/api/send-message/EXAMPLE.md +112 -0
- package/dist/skills/slack-operation/api/send-message/GUIDE.md +63 -0
- package/dist/skills/slack-operation/api/share-files/EXAMPLE.md +94 -0
- package/dist/skills/slack-operation/api/share-files/GUIDE.md +63 -0
- package/dist/skills/slack-operation/ui/desktop-automation/GUIDE.md +55 -0
- package/dist/skills/system-diagnostics/SKILL.md +263 -0
- package/dist/skills/teams-operation/SKILL.md +79 -0
- package/dist/skills/teams-operation/api/advanced-api/GUIDE.md +234 -0
- package/dist/skills/teams-operation/api/meetings/EXAMPLE.md +63 -0
- package/dist/skills/teams-operation/api/meetings/GUIDE.md +52 -0
- package/dist/skills/teams-operation/api/search-and-read/EXAMPLE.md +72 -0
- package/dist/skills/teams-operation/api/search-and-read/GUIDE.md +54 -0
- package/dist/skills/teams-operation/api/send-message/EXAMPLE.md +92 -0
- package/dist/skills/teams-operation/api/send-message/GUIDE.md +60 -0
- package/dist/skills/teams-operation/ui/desktop-automation/GUIDE.md +66 -0
- package/dist/skills/transcribe-media/SKILL.md +142 -0
- package/dist/skills/uipath-integrations/SKILL.md +370 -0
- package/dist/skills/uipath-integrations/reference/connectors.md +331 -0
- package/dist/skills/uipath-integrations/reference/endpoints.md +220 -0
- package/dist/skills/uipath-integrations/reference/errors.md +211 -0
- package/dist/skills/uipath-integrations/reference/metadata.md +317 -0
- package/dist/skills/uipath-integrations/reference/operations.md +297 -0
- package/dist/skills/uipath-orchestrator/SKILL.md +312 -0
- package/dist/skills/uipath-orchestrator/recipes/assets.md +282 -0
- package/dist/skills/uipath-orchestrator/recipes/audit-logs.md +215 -0
- package/dist/skills/uipath-orchestrator/recipes/buckets.md +205 -0
- package/dist/skills/uipath-orchestrator/recipes/jobs.md +286 -0
- package/dist/skills/uipath-orchestrator/recipes/list-folders.md +207 -0
- package/dist/skills/uipath-orchestrator/recipes/queue-items.md +292 -0
- package/dist/skills/uipath-orchestrator/recipes/queues.md +232 -0
- package/dist/skills/uipath-orchestrator/recipes/releases.md +212 -0
- package/dist/skills/uipath-orchestrator/recipes/robots-sessions.md +274 -0
- package/dist/skills/uipath-orchestrator/recipes/schedules.md +280 -0
- package/dist/skills/uipath-orchestrator/reference/endpoints.md +85 -0
- package/dist/skills/uipath-orchestrator/reference/schemas.md +153 -0
- package/dist/skills/uipath-taskautomation/SKILL.md +310 -0
- package/dist/skills/uipath-taskautomation/assets/CodedWorkflow.template.cs +98 -0
- package/dist/skills/uipath-taskautomation/assets/ExampleWorkflow.cs +146 -0
- package/dist/skills/uipath-taskautomation/references/action-activity-map.json +32 -0
- package/dist/skills/uipath-taskautomation/references/action-activity-map.md +44 -0
- package/dist/skills/uipath-taskautomation/references/app-profiles.md +63 -0
- package/dist/skills/uipath-taskautomation/references/automation-spec.md +88 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/before-after-hooks-template.md +115 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/codedworkflow-template.md +186 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/helper-utility-template.md +22 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/json-template.md +91 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/testcase-template.md +92 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/cli-reference.md +249 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/codedworkflow-reference.md +275 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/coding-guidelines.md +229 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/inspect-package-guide.md +81 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/integration-service-guide.md +507 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/operations-guide.md +410 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/third-party-packages-guide.md +67 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/data-manipulation-guide.md +110 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/environment-setup.md +194 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/error-handling-guide.md +195 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/powershell-interop-guide.md +57 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/project-structure-guide.md +114 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/project-structure.md +126 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/uia-elements-interaction-guide.md +109 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/validation-guide.md +147 -0
- package/dist/skills/uipath-taskautomation/references/coded-workflow-authoring.md +219 -0
- package/dist/skills/uipath-taskautomation/references/profiling-output.md +80 -0
- package/dist/skills/uipath-taskautomation/references/reliability-guide.md +83 -0
- package/dist/skills/uipath-taskautomation/references/task-automation-cheatsheet.md +272 -0
- package/dist/skills/uipath-taskautomation/references/template-preflight.md +17 -0
- package/dist/skills/uipath-workflow-documenter/SKILL.md +430 -0
- package/dist/skills/uipath-workflow-documenter/layouts/pdd-template.md +265 -0
- package/dist/skills/uipath-workflow-documenter/routines/from-orchestrator.md +11 -0
- package/dist/skills/uipath-workflow-documenter/routines/from-workflow.md +11 -0
- package/dist/skills/word-architect/SKILL.macos.md +147 -0
- package/dist/skills/word-architect/SKILL.md +502 -0
- package/dist/skills/word-architect/SKILL.windows.md +55 -0
- package/dist/skills/word-architect/api/advanced.md +522 -0
- package/dist/skills/word-architect/api/basic.md +378 -0
- package/dist/skills/word-architect/api/expert.md +302 -0
- package/dist/skills/word-architect/generation.md +308 -0
- package/dist/skills/word-architect/layouts/01-professional.md +168 -0
- package/dist/skills/word-architect/layouts/02-educational-kids.md +354 -0
- package/dist/skills/word-architect/layouts/03-academic.md +83 -0
- package/dist/skills/word-architect/layouts/04-creative.md +242 -0
- package/dist/skills/word-architect/layouts/05-operational.md +94 -0
- package/dist/skills/word-architect/macos/scripts/apply-heading-style.applescript +215 -0
- package/dist/skills/word-architect/macos/scripts/apply-style.applescript +272 -0
- package/dist/skills/word-architect/macos/scripts/autofit-tables.applescript +53 -0
- package/dist/skills/word-architect/macos/scripts/close-document.applescript +287 -0
- package/dist/skills/word-architect/macos/scripts/create-chart-with-data.applescript +379 -0
- package/dist/skills/word-architect/macos/scripts/create-chart.applescript +191 -0
- package/dist/skills/word-architect/macos/scripts/delete-selection.applescript +223 -0
- package/dist/skills/word-architect/macos/scripts/export-document.applescript +167 -0
- package/dist/skills/word-architect/macos/scripts/extract-table.applescript +168 -0
- package/dist/skills/word-architect/macos/scripts/find-by-style.applescript +173 -0
- package/dist/skills/word-architect/macos/scripts/find-text.applescript +199 -0
- package/dist/skills/word-architect/macos/scripts/format-table.applescript +234 -0
- package/dist/skills/word-architect/macos/scripts/format-text.applescript +431 -0
- package/dist/skills/word-architect/macos/scripts/get-document-properties.applescript +95 -0
- package/dist/skills/word-architect/macos/scripts/get-document-structure.applescript +371 -0
- package/dist/skills/word-architect/macos/scripts/get-header-footer-text.applescript +106 -0
- package/dist/skills/word-architect/macos/scripts/get-images.applescript +166 -0
- package/dist/skills/word-architect/macos/scripts/get-opened-files.applescript +103 -0
- package/dist/skills/word-architect/macos/scripts/get-paragraph-bounds.applescript +133 -0
- package/dist/skills/word-architect/macos/scripts/get-paragraph-format.applescript +134 -0
- package/dist/skills/word-architect/macos/scripts/get-recent-files.applescript +82 -0
- package/dist/skills/word-architect/macos/scripts/get-styled-text.applescript +256 -0
- package/dist/skills/word-architect/macos/scripts/get-tables.applescript +126 -0
- package/dist/skills/word-architect/macos/scripts/get-text-formatting.applescript +224 -0
- package/dist/skills/word-architect/macos/scripts/get-text.applescript +383 -0
- package/dist/skills/word-architect/macos/scripts/get-theme-colors.applescript +123 -0
- package/dist/skills/word-architect/macos/scripts/health-check.applescript +606 -0
- package/dist/skills/word-architect/macos/scripts/insert-cover-page.applescript +77 -0
- package/dist/skills/word-architect/macos/scripts/insert-header-footer.applescript +87 -0
- package/dist/skills/word-architect/macos/scripts/insert-horizontal-line.applescript +112 -0
- package/dist/skills/word-architect/macos/scripts/insert-html.applescript +440 -0
- package/dist/skills/word-architect/macos/scripts/insert-hyperlink.applescript +191 -0
- package/dist/skills/word-architect/macos/scripts/insert-image.applescript +320 -0
- package/dist/skills/word-architect/macos/scripts/insert-list.applescript +317 -0
- package/dist/skills/word-architect/macos/scripts/insert-pagebreak.applescript +181 -0
- package/dist/skills/word-architect/macos/scripts/insert-smartart.applescript +104 -0
- package/dist/skills/word-architect/macos/scripts/insert-table.applescript +238 -0
- package/dist/skills/word-architect/macos/scripts/insert-text.applescript +677 -0
- package/dist/skills/word-architect/macos/scripts/insert-textbox.applescript +261 -0
- package/dist/skills/word-architect/macos/scripts/maximize-window.applescript +67 -0
- package/dist/skills/word-architect/macos/scripts/normalize-formatting.applescript +56 -0
- package/dist/skills/word-architect/macos/scripts/open-document.applescript +222 -0
- package/dist/skills/word-architect/macos/scripts/replace-text.applescript +390 -0
- package/dist/skills/word-architect/macos/scripts/save-document.applescript +230 -0
- package/dist/skills/word-architect/macos/scripts/select-range.applescript +142 -0
- package/dist/skills/word-architect/macos/scripts/set-document-properties.applescript +195 -0
- package/dist/skills/word-architect/macos/scripts/set-page-layout.applescript +273 -0
- package/dist/skills/word-architect/macos/scripts/set-theme-colors.applescript +264 -0
- package/dist/skills/word-architect/macos/scripts/undo-redo.applescript +61 -0
- package/dist/skills/word-architect/macos/scripts/update-toc.applescript +112 -0
- package/dist/skills/word-architect/reference/formatting.md +119 -0
- package/dist/skills/word-architect/reference/html-layouts/01-executive-summary-box.md +36 -0
- package/dist/skills/word-architect/reference/html-layouts/02-kpi-summary-table.md +68 -0
- package/dist/skills/word-architect/reference/html-layouts/03-comparison-table.md +63 -0
- package/dist/skills/word-architect/reference/html-layouts/04-pros-cons-table.md +86 -0
- package/dist/skills/word-architect/reference/html-layouts/05-timeline-table.md +114 -0
- package/dist/skills/word-architect/reference/html-layouts/06-raci-matrix.md +95 -0
- package/dist/skills/word-architect/reference/html-layouts/07-data-table-alternating.md +84 -0
- package/dist/skills/word-architect/reference/html-layouts/08-callout-box.md +102 -0
- package/dist/skills/word-architect/reference/html-layouts/09-vertical-milestone.md +100 -0
- package/dist/skills/word-architect/reference/quality-assurance.md +102 -0
- package/dist/skills/word-architect/reference/tables.md +62 -0
- package/dist/skills/word-architect/reference/tracked-changes.md +34 -0
- package/dist/skills/word-architect/reference/uia-fallback.md +231 -0
- package/dist/skills/word-architect/reference/visual-elements.md +82 -0
- package/dist/skills/word-architect/windows/scripts/apply-heading-style.ps1 +190 -0
- package/dist/skills/word-architect/windows/scripts/autofit-tables.ps1 +64 -0
- package/dist/skills/word-architect/windows/scripts/create-chart-with-data.ps1 +133 -0
- package/dist/skills/word-architect/windows/scripts/create-chart.ps1 +73 -0
- package/dist/skills/word-architect/windows/scripts/export-document.ps1 +86 -0
- package/dist/skills/word-architect/windows/scripts/get-current-file.ps1 +27 -0
- package/dist/skills/word-architect/windows/scripts/insert-cover-page.ps1 +79 -0
- package/dist/skills/word-architect/windows/scripts/insert-horizontal-line.ps1 +74 -0
- package/dist/skills/word-architect/windows/scripts/insert-image.ps1 +98 -0
- package/dist/skills/word-architect/windows/scripts/insert-smartart.ps1 +118 -0
- package/dist/skills/word-architect/windows/scripts/insert-text-box.ps1 +90 -0
- package/dist/skills/word-architect/windows/scripts/normalize-formatting.ps1 +63 -0
- package/package.json +5 -4
|
@@ -0,0 +1,522 @@
|
|
|
1
|
+
# Word API — Advanced
|
|
2
|
+
|
|
3
|
+
Load when your task needs tables, images, charts, headers/footers, page layout, or other specialized operations. Assumes you've already loaded `basic.md`.
|
|
4
|
+
|
|
5
|
+
Position Object and Range Object are defined in `basic.md` — refer there for anchors, contextBefore/contextAfter rules, and ␍ placement.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Tables
|
|
10
|
+
|
|
11
|
+
### Get Tables
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
endpoint: "/word/get/tables"
|
|
15
|
+
body: { "filePath": "..." }
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Returns: array of tables with `index`, `rowCount`, `columnCount`, `startPosition`, `endPosition`, `firstRowPreview`.
|
|
19
|
+
|
|
20
|
+
### Insert Table
|
|
21
|
+
|
|
22
|
+
```
|
|
23
|
+
endpoint: "/word/insert/table"
|
|
24
|
+
body: {
|
|
25
|
+
"filePath": "...",
|
|
26
|
+
"dataTable": [
|
|
27
|
+
["Name", "Age", "City"],
|
|
28
|
+
["John", "30", "New York"],
|
|
29
|
+
["Jane", "25", "Los Angeles"]
|
|
30
|
+
],
|
|
31
|
+
"position": { "anchor": "paragraphEnd", "paragraph": 2, "contextBefore": "...", "contextAfter": "␍..." }
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
| Parameter | Required | Description |
|
|
36
|
+
|-----------|----------|-------------|
|
|
37
|
+
| `dataTable` | Yes | 2D array: `[["Header1", "Header2"], ["Cell1", "Cell2"]]` |
|
|
38
|
+
| `position` | Yes | Position Object |
|
|
39
|
+
|
|
40
|
+
### Format Table
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
endpoint: "/word/format/table"
|
|
44
|
+
body: {
|
|
45
|
+
"filePath": "...",
|
|
46
|
+
"tableIndex": 1,
|
|
47
|
+
"borderStyle": "Single",
|
|
48
|
+
"borderWidth": 4,
|
|
49
|
+
"borderColorHex": "000000",
|
|
50
|
+
"headerBackgroundColorHex": "4472C4",
|
|
51
|
+
"headerTextColorHex": "FFFFFF"
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
| Parameter | Description |
|
|
56
|
+
|-----------|-------------|
|
|
57
|
+
| `tableIndex` | 1-based (from `get/tables`) |
|
|
58
|
+
| `borderStyle` | `None`, `Single`, `Double`, `Dashed`, `Dotted` |
|
|
59
|
+
| `borderWidth` | Points: 2, 4, 6, 8, 12, 18, 24, 36, 48 |
|
|
60
|
+
| `headerBackgroundColorHex` | Header row bg (hex, no #) |
|
|
61
|
+
| `headerTextColorHex` | Header row text (hex) |
|
|
62
|
+
|
|
63
|
+
### Extract Table Data
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
endpoint: "/word/extract/table"
|
|
67
|
+
body: { "filePath": "...", "tableIndex": 1, "includeFormatting": false }
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Returns: `rows` as 2D array. With `includeFormatting: true`: each cell includes `bold`, `italic`, `backgroundColor`.
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## Images
|
|
75
|
+
|
|
76
|
+
### Get Images
|
|
77
|
+
|
|
78
|
+
```
|
|
79
|
+
endpoint: "/word/get/images"
|
|
80
|
+
body: { "filePath": "..." }
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Returns: array with `index`, `width`, `height` (points), `altText`, `position`, `paragraphNumber`. Images appear as `/` in text.
|
|
84
|
+
|
|
85
|
+
### Insert Picture
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
endpoint: "/word/insert/picture"
|
|
89
|
+
body: {
|
|
90
|
+
"filePath": "...",
|
|
91
|
+
"path": "C:\\Images\\chart.png",
|
|
92
|
+
"position": { "anchor": "paragraphEnd", "paragraph": 3, "contextBefore": "...", "contextAfter": "␍..." },
|
|
93
|
+
"width": 400,
|
|
94
|
+
"alignment": "Center",
|
|
95
|
+
"textWrapping": "Inline"
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
| Parameter | Description |
|
|
100
|
+
|-----------|-------------|
|
|
101
|
+
| `path` | Image file path |
|
|
102
|
+
| `width` / `height` | Points (72pt = 1 inch). Full width = 468pt. |
|
|
103
|
+
| `maintainAspectRatio` | Default `true` |
|
|
104
|
+
| `alignment` | `Left`, `Center`, `Right` |
|
|
105
|
+
| `textWrapping` | `Inline` (default), `Square`, `Tight`, `Behind`, `InFront` |
|
|
106
|
+
|
|
107
|
+
**Always add blank lines** (`"␍"`) before and after images.
|
|
108
|
+
|
|
109
|
+
### Insert Diagram
|
|
110
|
+
|
|
111
|
+
To insert a diagram (flowchart, sequence, ER, state, etc.) into an existing document, use a two-step process:
|
|
112
|
+
|
|
113
|
+
**Step 1: Render diagram to PNG file**
|
|
114
|
+
|
|
115
|
+
```
|
|
116
|
+
endpoint: "/diagram/render-mermaid"
|
|
117
|
+
body: {
|
|
118
|
+
"code": "graph TD\n A[Web Client] --> B[API Gateway]\n B --> C[Auth Service]\n B --> D[Database]"
|
|
119
|
+
}
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
Returns: `{ "success": true, "imagePath": "C:\\...\\word-diagram-123.png", "width": 800, "height": 600 }`
|
|
123
|
+
|
|
124
|
+
**Step 2: Insert the PNG into the document**
|
|
125
|
+
|
|
126
|
+
Use `/word/insert/picture`. The position MUST include `contextBefore` and `contextAfter` (required by the API). Read the document structure first to get accurate context.
|
|
127
|
+
|
|
128
|
+
Insert at a specific paragraph:
|
|
129
|
+
```
|
|
130
|
+
endpoint: "/word/insert/picture"
|
|
131
|
+
body: {
|
|
132
|
+
"filePath": "C:\\...\\document.docx",
|
|
133
|
+
"path": "<imagePath from step 1>",
|
|
134
|
+
"position": {
|
|
135
|
+
"anchor": "paragraphEnd",
|
|
136
|
+
"value": 5,
|
|
137
|
+
"contextBefore": "text before insertion point",
|
|
138
|
+
"contextAfter": "␍text after insertion point"
|
|
139
|
+
},
|
|
140
|
+
"width": 468,
|
|
141
|
+
"alignment": "Center"
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Insert at end of document:
|
|
146
|
+
```
|
|
147
|
+
endpoint: "/word/insert/picture"
|
|
148
|
+
body: {
|
|
149
|
+
"filePath": "C:\\...\\document.docx",
|
|
150
|
+
"path": "<imagePath from step 1>",
|
|
151
|
+
"position": {
|
|
152
|
+
"anchor": "documentEnd",
|
|
153
|
+
"contextBefore": "last few words of document",
|
|
154
|
+
"contextAfter": ""
|
|
155
|
+
},
|
|
156
|
+
"width": 468,
|
|
157
|
+
"alignment": "Center"
|
|
158
|
+
}
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
**Workflow:** Always call `/word/get/document-structure` first to find the right paragraph number and context text for positioning.
|
|
162
|
+
|
|
163
|
+
Supported diagram types: `graph`/`flowchart`, `sequenceDiagram`, `stateDiagram-v2`, `classDiagram`, `erDiagram`, `gantt`, `mindmap`, `timeline`.
|
|
164
|
+
|
|
165
|
+
**Do NOT** attempt to create diagrams by inserting shapes one by one via UIA. Always use `/diagram/render-mermaid`.
|
|
166
|
+
|
|
167
|
+
---
|
|
168
|
+
|
|
169
|
+
## Insert List
|
|
170
|
+
|
|
171
|
+
```
|
|
172
|
+
endpoint: "/word/insert/list"
|
|
173
|
+
body: {
|
|
174
|
+
"filePath": "...",
|
|
175
|
+
"listType": "Bullet",
|
|
176
|
+
"items": ["First item", "Second item", "Third item"],
|
|
177
|
+
"indentLevel": 0,
|
|
178
|
+
"position": { "anchor": "paragraphEnd", "paragraph": 5, "contextBefore": "...", "contextAfter": "␍..." }
|
|
179
|
+
}
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
| Parameter | Description |
|
|
183
|
+
|-----------|-------------|
|
|
184
|
+
| `listType` | `Bullet` or `Numbered` |
|
|
185
|
+
| `items` | Array of text strings |
|
|
186
|
+
| `indentLevel` | 0 = top level |
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
## Insert Chart
|
|
191
|
+
|
|
192
|
+
```
|
|
193
|
+
endpoint: "/word/insert/chart"
|
|
194
|
+
body: {
|
|
195
|
+
"filePath": "...",
|
|
196
|
+
"chartType": "Column",
|
|
197
|
+
"chartTitle": "Q4 Sales by Region",
|
|
198
|
+
"categories": ["North", "South", "East", "West"],
|
|
199
|
+
"series": [
|
|
200
|
+
{ "name": "2023", "values": [120, 85, 95, 110] },
|
|
201
|
+
{ "name": "2024", "values": [140, 90, 105, 125] }
|
|
202
|
+
],
|
|
203
|
+
"position": { "anchor": "paragraphEnd", "paragraph": 5, "contextBefore": "...", "contextAfter": "␍..." },
|
|
204
|
+
"width": 400,
|
|
205
|
+
"height": 300
|
|
206
|
+
}
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
| Parameter | Description |
|
|
210
|
+
|-----------|-------------|
|
|
211
|
+
| `chartType` | `Column`, `Bar`, `Line`, `Pie`, `Area`, `Doughnut`, `Scatter` |
|
|
212
|
+
| `categories` | X-axis labels (strings) |
|
|
213
|
+
| `series` | `[{ "name": "...", "values": [...] }]` — values count must match categories |
|
|
214
|
+
| `width` / `height` | Points |
|
|
215
|
+
|
|
216
|
+
See [reference/visual-elements.md](../reference/visual-elements.md) for chart design best practices and sizing.
|
|
217
|
+
|
|
218
|
+
---
|
|
219
|
+
|
|
220
|
+
## Insert Hyperlink
|
|
221
|
+
|
|
222
|
+
```
|
|
223
|
+
endpoint: "/word/insert/hyperlink"
|
|
224
|
+
body: {
|
|
225
|
+
"filePath": "...",
|
|
226
|
+
"address": "https://example.com",
|
|
227
|
+
"textToDisplay": "Click here",
|
|
228
|
+
"range": {
|
|
229
|
+
"start": { "anchor": "characterIndex", "index": 150 },
|
|
230
|
+
"end": { "anchor": "characterIndex", "index": 160 },
|
|
231
|
+
"expectedText": "Click here"
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
Converts existing text in range to a hyperlink.
|
|
237
|
+
|
|
238
|
+
---
|
|
239
|
+
|
|
240
|
+
## Insert Text Box
|
|
241
|
+
|
|
242
|
+
```
|
|
243
|
+
endpoint: "/word/insert/textbox"
|
|
244
|
+
body: {
|
|
245
|
+
"filePath": "...",
|
|
246
|
+
"text": "Important Notice",
|
|
247
|
+
"position": { ... },
|
|
248
|
+
"width": 200,
|
|
249
|
+
"height": 100,
|
|
250
|
+
"borderColorHex": "4472C4",
|
|
251
|
+
"borderWidth": 2,
|
|
252
|
+
"backgroundColorHex": "E6F0FF",
|
|
253
|
+
"alignment": "Center"
|
|
254
|
+
}
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
| Parameter | Description |
|
|
258
|
+
|-----------|-------------|
|
|
259
|
+
| `text` | Content (supports `\n` for line breaks) |
|
|
260
|
+
| `width` / `height` | Points |
|
|
261
|
+
| `borderColorHex` / `borderWidth` | Border styling |
|
|
262
|
+
| `backgroundColorHex` | Fill color |
|
|
263
|
+
| `alignment` | Text alignment inside box |
|
|
264
|
+
| `rotation` | Degrees (0-360) |
|
|
265
|
+
|
|
266
|
+
For advanced text box management (naming, listing, deleting by name), see `expert.md` C# scripting.
|
|
267
|
+
|
|
268
|
+
---
|
|
269
|
+
|
|
270
|
+
## Header / Footer
|
|
271
|
+
|
|
272
|
+
### Insert
|
|
273
|
+
|
|
274
|
+
```
|
|
275
|
+
endpoint: "/word/insert/headerfooter"
|
|
276
|
+
body: { "filePath": "...", "type": "Header", "text": "Report Title", "alignment": "Center" }
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
`type`: `Header` or `Footer`. `alignment`: `Left`, `Center`, `Right`.
|
|
280
|
+
|
|
281
|
+
**`text` is required**, even when you also pass `includePageNumber: true`. For a page-number-only footer, pass an empty string: `{ "type": "Footer", "text": "", "includePageNumber": true }`.
|
|
282
|
+
|
|
283
|
+
### Read
|
|
284
|
+
|
|
285
|
+
```
|
|
286
|
+
endpoint: "/word/get/headerfootertext"
|
|
287
|
+
body: { "filePath": "...", "type": "Header" }
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
---
|
|
291
|
+
|
|
292
|
+
## Page Layout
|
|
293
|
+
|
|
294
|
+
```
|
|
295
|
+
endpoint: "/word/set/page-layout"
|
|
296
|
+
body: {
|
|
297
|
+
"filePath": "...",
|
|
298
|
+
"orientation": "Portrait",
|
|
299
|
+
"pageSize": "Letter",
|
|
300
|
+
"topMargin": 1.0,
|
|
301
|
+
"bottomMargin": 1.0,
|
|
302
|
+
"leftMargin": 1.0,
|
|
303
|
+
"rightMargin": 1.0
|
|
304
|
+
}
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
| Parameter | Description |
|
|
308
|
+
|-----------|-------------|
|
|
309
|
+
| `orientation` | `Portrait` or `Landscape` |
|
|
310
|
+
| `pageSize` | `Letter`, `A4`, `Legal`, `Custom` |
|
|
311
|
+
| `width` / `height` | If Custom (inches) |
|
|
312
|
+
| Margins | All in inches |
|
|
313
|
+
| `borderStyle` / `borderWidth` / `borderColorHex` | Page border |
|
|
314
|
+
| `pageBackgroundColorHex` | Page background |
|
|
315
|
+
|
|
316
|
+
---
|
|
317
|
+
|
|
318
|
+
## Document Properties
|
|
319
|
+
|
|
320
|
+
**Endpoint spelling differs by platform.** Windows registers only the unhyphenated routes
|
|
321
|
+
(`/word/set/documentproperties`, `/word/get/documentproperties`); the hyphenated form does not
|
|
322
|
+
exist there and returns 404. macOS accepts both. **Use the unhyphenated form — it is the only
|
|
323
|
+
one that works on both platforms.**
|
|
324
|
+
|
|
325
|
+
### Set
|
|
326
|
+
|
|
327
|
+
```
|
|
328
|
+
endpoint: "/word/set/documentproperties"
|
|
329
|
+
body: {
|
|
330
|
+
"filePath": "...",
|
|
331
|
+
"title": "Q4 Report",
|
|
332
|
+
"author": "Finance Team",
|
|
333
|
+
"subject": "Quarterly Analysis",
|
|
334
|
+
"keywords": "finance, Q4",
|
|
335
|
+
"company": "Acme Corp"
|
|
336
|
+
}
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
Also: `comments`, `appendKeywords` (bool), `appendComments` (bool).
|
|
340
|
+
|
|
341
|
+
macOS-only alias: `/word/set/document-properties` (hyphenated) also works there.
|
|
342
|
+
|
|
343
|
+
### Get
|
|
344
|
+
|
|
345
|
+
```
|
|
346
|
+
endpoint: "/word/get/documentproperties"
|
|
347
|
+
body: { "filePath": "..." }
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
macOS-only alias: `/word/get/document-properties` (hyphenated) also works there.
|
|
351
|
+
|
|
352
|
+
---
|
|
353
|
+
|
|
354
|
+
## Theme Colors
|
|
355
|
+
|
|
356
|
+
### Set
|
|
357
|
+
|
|
358
|
+
```
|
|
359
|
+
endpoint: "/word/set/theme-colors"
|
|
360
|
+
body: {
|
|
361
|
+
"filePath": "...",
|
|
362
|
+
"accent1ColorHex": "4472C4",
|
|
363
|
+
"text1ColorHex": "000000",
|
|
364
|
+
"background1ColorHex": "FFFFFF"
|
|
365
|
+
}
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
Available: `text1`/`text2`, `background1`/`background2`, `accent1`-`accent6`, `hyperlinkColorHex`, `followedHyperlinkColorHex`.
|
|
369
|
+
|
|
370
|
+
### Get
|
|
371
|
+
|
|
372
|
+
```
|
|
373
|
+
endpoint: "/word/get/theme-colors"
|
|
374
|
+
body: { "filePath": "..." }
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
---
|
|
378
|
+
|
|
379
|
+
## Export to PDF
|
|
380
|
+
|
|
381
|
+
```
|
|
382
|
+
endpoint: "/word/export-to-pdf"
|
|
383
|
+
body: {
|
|
384
|
+
"filePath": "...",
|
|
385
|
+
"pdfFilePath": "C:\\Documents\\report.pdf",
|
|
386
|
+
"startPage": 1,
|
|
387
|
+
"endPage": 3
|
|
388
|
+
}
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
`startPage`/`endPage` optional — omit for full document.
|
|
392
|
+
|
|
393
|
+
**⚠️ When multiple documents are open**, always use the exact `filePath` returned by `/word/open-attach` — do not guess or use a path from a different document.
|
|
394
|
+
|
|
395
|
+
---
|
|
396
|
+
|
|
397
|
+
## Undo / Redo
|
|
398
|
+
|
|
399
|
+
```
|
|
400
|
+
endpoint: "/word/undo"
|
|
401
|
+
body: { "filePath": "..." }
|
|
402
|
+
```
|
|
403
|
+
|
|
404
|
+
```
|
|
405
|
+
endpoint: "/word/redo"
|
|
406
|
+
body: { "filePath": "..." }
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
---
|
|
410
|
+
|
|
411
|
+
## Additional Read Operations
|
|
412
|
+
|
|
413
|
+
### Get Styled Text
|
|
414
|
+
|
|
415
|
+
```
|
|
416
|
+
endpoint: "/word/get/styledtext"
|
|
417
|
+
body: { "filePath": "...", "pageStart": 1, "pageEnd": 2, "format": "Html" }
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
Also accepts `paragraphNumber` or `selectionStart`/`selectionEnd`. Format: `Html` (default) or `Rtf`. Optional `maxChars` caps returned characters; default 8,000 on Windows, 2,000 on macOS (kept low because the per-character styled-run scan is slow via AppleScript). Clamped to [100, 50,000]. macOS truncates above the cap; Windows returns an error pointing at the cap.
|
|
421
|
+
|
|
422
|
+
### Find by Style
|
|
423
|
+
|
|
424
|
+
```
|
|
425
|
+
endpoint: "/word/find/by-style"
|
|
426
|
+
body: { "filePath": "...", "styleName": "Heading 1", "maxResults": 100 }
|
|
427
|
+
```
|
|
428
|
+
|
|
429
|
+
Returns: matches with `text`, `paragraphNumber`, `paragraphStart`, `paragraphEnd`.
|
|
430
|
+
|
|
431
|
+
### Get Text Formatting
|
|
432
|
+
|
|
433
|
+
```
|
|
434
|
+
endpoint: "/word/get/textformatting"
|
|
435
|
+
body: { "filePath": "...", "paragraphNumber": 1 }
|
|
436
|
+
```
|
|
437
|
+
|
|
438
|
+
Returns: `fontName`, `fontSize`, `bold`, `italic`, `underline`, `textColor`, `highlightColor`, `alignment`.
|
|
439
|
+
|
|
440
|
+
### Get Paragraph Format
|
|
441
|
+
|
|
442
|
+
```
|
|
443
|
+
endpoint: "/word/get/paragraph-format"
|
|
444
|
+
body: { "filePath": "...", "paragraphNumber": 2 }
|
|
445
|
+
```
|
|
446
|
+
|
|
447
|
+
Returns: `alignment`, `lineSpacing`, `spaceBefore`, `spaceAfter`, `firstLineIndent`, `leftIndent`, `rightIndent`.
|
|
448
|
+
|
|
449
|
+
---
|
|
450
|
+
|
|
451
|
+
## Batch Operations
|
|
452
|
+
|
|
453
|
+
**macOS only.** Normal DOCX replace, insert, format, and apply style operations support `batch` mode. Windows has no batch endpoint for any of them — send sequential single calls.
|
|
454
|
+
|
|
455
|
+
Batch items accept either character offsets (`range: {start, end}`) or `paragraphStart`/`paragraphEnd` anchors — anchors are resolved before dispatch, sharing one lookup per paragraph across the batch. Cheapest source of offsets for a multi-paragraph batch: `/word/get/document-structure { includeParagraphBounds: true }`, which returns `paragraphBounds: [{paragraphNumber, paragraphStart, paragraphEnd}, ...]` for every paragraph in one call.
|
|
456
|
+
|
|
457
|
+
`range` is required per item for format and apply-style; `replace/text` keeps it optional and defaults to the whole document, as its single-call path does. Each item also needs its own operation field — `styleName` for apply-style, `oldText` for replace-text — as a non-empty string; a batch missing one is rejected before any script runs.
|
|
458
|
+
|
|
459
|
+
`expectedText` is honoured inside a batch — an item carrying it is verified before dispatch, so a stale offset fails instead of formatting the wrong span. **It costs one extra native call per item that carries it**: a 50-item batch with `expectedText` on every item is 51 calls, against 1 for the same batch without it (2 when ranges use paragraph anchors). Put it on the items whose positions might have moved, not reflexively on all of them; inside a single batch built from a fresh structure read, styling and formatting do not shift offsets.
|
|
460
|
+
|
|
461
|
+
A batch that applies nothing returns `success:false` with `operationsCompleted:0`, `requested:<n>`, `doNotRetry:true`, and the script's `errorDetails` naming the cause (a missing style, text that was not found). Fix that cause; re-read the document and rebuild the batch only when the details point at stale positions. Never replay the payload.
|
|
462
|
+
|
|
463
|
+
### Insert Text Batch
|
|
464
|
+
|
|
465
|
+
Every `/word/insert/text` batch item uses the insert schema: `text`, `insertMode`, and `position`. For batch items, `position` uses only the anchor-specific location fields below; do not add single-call `contextBefore` or `contextAfter` fields.
|
|
466
|
+
|
|
467
|
+
Each batch uses one coordinate system:
|
|
468
|
+
|
|
469
|
+
- Document coordinates: `documentStart`, `documentEnd`, and `characterIndex`. These may mix and run from the document end toward the start.
|
|
470
|
+
- Paragraph coordinates: `paragraphStart` and `paragraphEnd`. These may mix and run by descending paragraph number; `paragraphEnd` runs before `paragraphStart` for the same paragraph.
|
|
471
|
+
|
|
472
|
+
Do not mix document and paragraph coordinates in one batch. Re-read the document and recompute remaining positions before sending a later batch in the other coordinate system.
|
|
473
|
+
|
|
474
|
+
```
|
|
475
|
+
endpoint: "/word/insert/text"
|
|
476
|
+
body: {
|
|
477
|
+
"filePath": "...",
|
|
478
|
+
"batch": [
|
|
479
|
+
{
|
|
480
|
+
"text": "New section",
|
|
481
|
+
"insertMode": "NewParagraph",
|
|
482
|
+
"position": { "anchor": "paragraphEnd", "paragraphNumber": 5 }
|
|
483
|
+
},
|
|
484
|
+
{
|
|
485
|
+
"text": "Opening text",
|
|
486
|
+
"insertMode": "NewParagraph",
|
|
487
|
+
"position": { "anchor": "paragraphStart", "paragraphNumber": 1 }
|
|
488
|
+
}
|
|
489
|
+
]
|
|
490
|
+
}
|
|
491
|
+
```
|
|
492
|
+
|
|
493
|
+
| `position.anchor` | Additional position field |
|
|
494
|
+
|-------------------|---------------------------|
|
|
495
|
+
| `documentStart` | None |
|
|
496
|
+
| `documentEnd` | None |
|
|
497
|
+
| `paragraphStart` | `paragraphNumber` (1-based) |
|
|
498
|
+
| `paragraphEnd` | `paragraphNumber` (1-based) |
|
|
499
|
+
| `characterIndex` | `index` (0-based) |
|
|
500
|
+
|
|
501
|
+
**Never put a `range` object in an insert batch item.** `range` belongs to replace, format, and apply-style operations, not insert.
|
|
502
|
+
|
|
503
|
+
**Compatibility Mode rejects insert batches.** It accepts only `documentStart` and `documentEnd` insert anchors, sent as separate sequential calls. Wait for each response before sending the next call.
|
|
504
|
+
|
|
505
|
+
### Replace, Format, and Apply Style Batches
|
|
506
|
+
|
|
507
|
+
Range-based operations use their own batch item schema. For example:
|
|
508
|
+
|
|
509
|
+
```
|
|
510
|
+
endpoint: "/word/replace/text"
|
|
511
|
+
body: {
|
|
512
|
+
"filePath": "...",
|
|
513
|
+
"batch": [
|
|
514
|
+
{ "oldText": "Draft", "newText": "Final", "range": { "start": 0, "end": 100 } },
|
|
515
|
+
{ "oldText": "2023", "newText": "2024", "range": { "start": 150, "end": 200 } }
|
|
516
|
+
]
|
|
517
|
+
}
|
|
518
|
+
```
|
|
519
|
+
|
|
520
|
+
The same range-based pattern applies to `/word/format/text` and `/word/apply/style`.
|
|
521
|
+
|
|
522
|
+
**⚠️ Range-based batch schemas differ from their single-call schemas.** Single calls use position objects with `anchor` keys (`paragraphStart`, `characterIndex`, etc.); range-based batch entries use the legacy plain-integer pair (`{ "start": <int>, "end": <int> }`) shown above. If any batch call is rejected with a validation error, **fall back to sequential single-call invocations** using the position-object form.
|