@uipath/delegate-sdk 1.203.0 → 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,747 @@
|
|
|
1
|
+
# Basic Operations
|
|
2
|
+
|
|
3
|
+
Essential endpoints for every Excel task: workbook management, sheets, data, formatting, and data analysis.
|
|
4
|
+
|
|
5
|
+
**Contents:**
|
|
6
|
+
1. [Workbook Operations](#workbook-operations) — list, open, create, info, save, close, export
|
|
7
|
+
2. [Sheet Operations](#sheet-operations) — select, create-sheets (macOS only), delete, rename, set-tab-color (macOS only), dimensions
|
|
8
|
+
3. [Data Operations](#data-operations) — read, write, write-ranges-batch, append, clear, copy-paste, find-replace, reorder-columns, delete-columns
|
|
9
|
+
4. [Formula Operations](#formula-operations) — write-formula, write-formulas-batch, cross-sheet references
|
|
10
|
+
5. [Formatting](#formatting) — format-range, auto-fit-columns, freeze-panes
|
|
11
|
+
6. [Data Analysis](#data-analysis) — sort-range, filter-range (auto-filter)
|
|
12
|
+
7. [Health Check](#health-check) — get-status response schema
|
|
13
|
+
8. [Undo](#undo) — undo recent operations
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Workbook Operations
|
|
18
|
+
|
|
19
|
+
### /excel/list-open-workbooks
|
|
20
|
+
|
|
21
|
+
Lists all open workbooks.
|
|
22
|
+
|
|
23
|
+
**Parameters:** None
|
|
24
|
+
|
|
25
|
+
**Response:**
|
|
26
|
+
- `workbooks[]` - Array with `workbookId`, `filePath`, `workbookName`, `activeSheetName`, `sheetCount`, `isDirty`
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
### /excel/open-or-attach-workbook
|
|
31
|
+
|
|
32
|
+
Opens file or attaches to already-open workbook.
|
|
33
|
+
|
|
34
|
+
| Parameter | Type | Required | Description |
|
|
35
|
+
|-----------|------|----------|-------------|
|
|
36
|
+
| filePath | string | Yes | Full path to Excel file |
|
|
37
|
+
| visible | bool | No | **Windows only.** Defaults to false: Excel is not put on screen. Pass `true` ONLY when the user asked to see the workbook, or before driving Excel with computer use — see "Excel stays off screen" in SKILL.md |
|
|
38
|
+
|
|
39
|
+
**Response:** `workbookId`, `filePath`, `sheets[]`, `currentSheetName`
|
|
40
|
+
|
|
41
|
+
`visible: false` does not hide anything that is already on screen — a workbook the user has open stays open. On macOS the flag is ignored.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
### /excel/create-workbook
|
|
46
|
+
|
|
47
|
+
| Parameter | Type | Required | Default | Description |
|
|
48
|
+
|-----------|------|----------|---------|-------------|
|
|
49
|
+
| filePath | string | Yes | - | Full path for new file |
|
|
50
|
+
| createDirectories | boolean | No | false | Create parent folders |
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
### /excel/get-workbook-info
|
|
55
|
+
|
|
56
|
+
Quick info query (faster than get-status).
|
|
57
|
+
|
|
58
|
+
| Parameter | Type | Required | Description |
|
|
59
|
+
|-----------|------|----------|-------------|
|
|
60
|
+
| workbookId | number | No | Workbook ID |
|
|
61
|
+
| filePath | string | No | OR file path |
|
|
62
|
+
|
|
63
|
+
**Response:** `workbookName`, `activeSheetName`, `sheetCount`, `sheets[]`
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
### /excel/save-workbook
|
|
68
|
+
|
|
69
|
+
| Parameter | Type | Required | Description |
|
|
70
|
+
|-----------|------|----------|-------------|
|
|
71
|
+
| workbookId | number | No | Workbook ID |
|
|
72
|
+
| filePath | string | No | OR file path |
|
|
73
|
+
| saveAsPath | string | No | New path for "Save As" |
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
### /excel/close-workbook
|
|
78
|
+
|
|
79
|
+
| Parameter | Type | Required | Default | Description |
|
|
80
|
+
|-----------|------|----------|---------|-------------|
|
|
81
|
+
| workbookId | number | No | - | Workbook ID |
|
|
82
|
+
| filePath | string | No | - | OR file path |
|
|
83
|
+
| saveBeforeClose | boolean | No | true | Save before closing; `false` discards unsaved changes |
|
|
84
|
+
|
|
85
|
+
Omitting `saveBeforeClose` saves the workbook on both Windows and macOS. Pass explicit `saveBeforeClose: true` or `saveBeforeClose: false` whenever persistence intent matters: `true` saves before closing; `false` discards unsaved changes.
|
|
86
|
+
|
|
87
|
+
Naming neither works only while a single workbook is open. With several open the call
|
|
88
|
+
fails asking for a `workbookId` rather than closing one at random — pass the id you got
|
|
89
|
+
from the open.
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
### /excel/export-pdf (Windows only)
|
|
94
|
+
|
|
95
|
+
Exports the workbook (or a single sheet) to a PDF file.
|
|
96
|
+
|
|
97
|
+
| Parameter | Type | Required | Default | Description |
|
|
98
|
+
|-----------|------|----------|---------|-------------|
|
|
99
|
+
| workbookId | number | No | - | Workbook ID |
|
|
100
|
+
| filePath | string | No | - | OR file path |
|
|
101
|
+
| outputPath | string | Yes | - | Full path for the output PDF (e.g., `"C:\Output\report.pdf"`) |
|
|
102
|
+
| fitToPage | boolean | No | false | Fit entire content to one page wide × one page tall |
|
|
103
|
+
| sheetName | string | No | - | Export a single sheet only; if omitted, exports the entire workbook |
|
|
104
|
+
|
|
105
|
+
**Example — Export active workbook to PDF, fit on one page:**
|
|
106
|
+
```json
|
|
107
|
+
{"outputPath": "C:\\Reports\\summary.pdf", "fitToPage": true}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
**Example — Export a single sheet:**
|
|
111
|
+
```json
|
|
112
|
+
{"outputPath": "C:\\Reports\\sheet1.pdf", "sheetName": "Sheet1", "fitToPage": true}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
### /excel/export-csv (Windows only)
|
|
118
|
+
|
|
119
|
+
Exports a sheet to a CSV file. **Does NOT modify the original workbook** — uses a temporary copy internally.
|
|
120
|
+
|
|
121
|
+
| Parameter | Type | Required | Default | Description |
|
|
122
|
+
|-----------|------|----------|---------|-------------|
|
|
123
|
+
| workbookId | number | No | - | Workbook ID |
|
|
124
|
+
| filePath | string | No | - | OR file path |
|
|
125
|
+
| outputPath | string | Yes | - | Full path for the output CSV (e.g., `"C:\Output\data.csv"`) |
|
|
126
|
+
| sheetName | string | No | Active sheet | Sheet to export; if omitted, exports the active sheet |
|
|
127
|
+
|
|
128
|
+
**Example — Export active sheet to CSV:**
|
|
129
|
+
```json
|
|
130
|
+
{"outputPath": "C:\\Output\\data.csv"}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
**Example — Export a specific sheet:**
|
|
134
|
+
```json
|
|
135
|
+
{"outputPath": "C:\\Output\\Sheet1.csv", "sheetName": "Sheet1"}
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
---
|
|
139
|
+
|
|
140
|
+
## Sheet Operations
|
|
141
|
+
|
|
142
|
+
### /excel/select-sheet
|
|
143
|
+
|
|
144
|
+
Selects sheet, optionally creates if missing. On macOS, `/excel/create-sheets` below creates several at once; Windows has no equivalent (see its section).
|
|
145
|
+
|
|
146
|
+
| Parameter | Type | Required | Default | Description |
|
|
147
|
+
|-----------|------|----------|---------|-------------|
|
|
148
|
+
| workbookId | number | No | - | Workbook ID |
|
|
149
|
+
| filePath | string | No | - | OR file path |
|
|
150
|
+
| sheetName | string | Yes | - | Sheet name |
|
|
151
|
+
| createNew | boolean | No | false | Create if missing |
|
|
152
|
+
|
|
153
|
+
**Response:** `sheets[]`, `usedRange`, `lastRow`, `lastColumn`
|
|
154
|
+
|
|
155
|
+
**Example — Create a new sheet:**
|
|
156
|
+
```json
|
|
157
|
+
{"sheetName": "Sheet2", "createNew": true}
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
|
|
162
|
+
### /excel/create-sheets (macOS only)
|
|
163
|
+
|
|
164
|
+
**Windows has no create-sheets endpoint** (the call returns 404). Build new sheets with `/excel/build-sheet` (existing workbook) or `build-workbook` (new workbook) (SKILL.windows.md); for an empty sheet, call `/excel/select-sheet` with `createNew: true`.
|
|
165
|
+
|
|
166
|
+
Creates one or more sheets in a single call. Sheets that already exist are reported in `skipped`; invalid names (over 31 chars, or containing `\ / ? * [ ] :`) are reported in `errors`.
|
|
167
|
+
|
|
168
|
+
| Parameter | Type | Required | Description |
|
|
169
|
+
|-----------|------|----------|-------------|
|
|
170
|
+
| sheetNames | string[] | Yes | Names of the sheets to create, in order |
|
|
171
|
+
|
|
172
|
+
**Response:** `created[]`, `skipped[]`, `errors[]`, `total`
|
|
173
|
+
|
|
174
|
+
**Example — Create three sheets:**
|
|
175
|
+
```json
|
|
176
|
+
{"sheetNames": ["Data", "Summary", "README"]}
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
### /excel/delete-sheet
|
|
182
|
+
|
|
183
|
+
| Parameter | Type | Required | Description |
|
|
184
|
+
|-----------|------|----------|-------------|
|
|
185
|
+
| sheetName | string | Yes | Sheet to delete |
|
|
186
|
+
|
|
187
|
+
⚠️ Cannot be undone!
|
|
188
|
+
|
|
189
|
+
---
|
|
190
|
+
|
|
191
|
+
### /excel/rename-sheet
|
|
192
|
+
|
|
193
|
+
| Parameter | Type | Required | Description |
|
|
194
|
+
|-----------|------|----------|-------------|
|
|
195
|
+
| sheetName | string | Yes | Current name |
|
|
196
|
+
| newSheetName | string | Yes | New name (max 31 chars) |
|
|
197
|
+
|
|
198
|
+
**Batch mode** — rename multiple sheets in one call:
|
|
199
|
+
|
|
200
|
+
| Parameter | Type | Required | Description |
|
|
201
|
+
|-----------|------|----------|-------------|
|
|
202
|
+
| batch | array | Yes | Array of `{oldName, newName}` objects |
|
|
203
|
+
|
|
204
|
+
```json
|
|
205
|
+
{"batch": [{"oldName": "Sheet1", "newName": "Data"}, {"oldName": "Sheet2", "newName": "Summary"}]}
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
---
|
|
209
|
+
|
|
210
|
+
### /excel/set-tab-color (macOS only)
|
|
211
|
+
|
|
212
|
+
Colors a sheet tab, or clears it. **Windows has no tab-color endpoint** — there is
|
|
213
|
+
no way to set a tab color there, so keep this out of cross-platform flows.
|
|
214
|
+
|
|
215
|
+
Tab color is editing-only: the generator never colors tabs (every shipped theme is
|
|
216
|
+
formal), so generate the workbook first and set tab colors afterwards.
|
|
217
|
+
|
|
218
|
+
| Parameter | Type | Required | Description |
|
|
219
|
+
|-----------|------|----------|-------------|
|
|
220
|
+
| sheetName | string | Yes | Sheet whose tab to color |
|
|
221
|
+
| tabColor | string \| null | Yes | `"#RRGGBB"` (or `"RRGGBB"`); `"none"` or `null` clears the color |
|
|
222
|
+
|
|
223
|
+
**Response:** `success`, `sheetName`, `tabColor` (the applied hex, or `null` when cleared)
|
|
224
|
+
|
|
225
|
+
**Example — color a tab:**
|
|
226
|
+
```json
|
|
227
|
+
{"sheetName": "Summary", "tabColor": "#1F4E79"}
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
**Example — clear a tab color:**
|
|
231
|
+
```json
|
|
232
|
+
{"sheetName": "Summary", "tabColor": "none"}
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
---
|
|
236
|
+
|
|
237
|
+
### /excel/get-sheet-dimensions
|
|
238
|
+
|
|
239
|
+
**CALL FIRST** before read/write to know data bounds.
|
|
240
|
+
|
|
241
|
+
| Parameter | Type | Required | Description |
|
|
242
|
+
|-----------|------|----------|-------------|
|
|
243
|
+
| filePath | string | No | Workbook path. If the workbook is not already open and the file is `.xlsx`/`.xlsm`, dimensions can be soft-loaded from package metadata without launching Excel. |
|
|
244
|
+
| sheetName | string | Yes | Sheet name |
|
|
245
|
+
|
|
246
|
+
**Response:** `usedRange` (e.g., "A1:D100"), `lastRow`, `lastColumn`
|
|
247
|
+
|
|
248
|
+
For large sheets the response can also include `rowCount`, `columnCount`, `cellCount`, `isLargeRange`, `isSoftLoaded`, `recommendedPreviewRange`, and `warning`. If `isLargeRange` is true, do not pass `usedRange` directly to `/excel/read-range`; start with `recommendedPreviewRange` and read additional row chunks only when the user explicitly needs body values.
|
|
249
|
+
|
|
250
|
+
For formula-writing tasks, this endpoint is the last-row discovery step. `lastRow` plus `recommended.fillStartRow` / `recommended.fillRowCount` are authoritative. Do not follow this with probing reads such as `F100:F150` or `F1000:F1050` to "find the last data row"; those reads waste time and memory and are unnecessary for formula fills.
|
|
251
|
+
|
|
252
|
+
If `isSoftLoaded` is true, the dimensions came from XLSX package metadata and Excel was not opened. Treat this as preflight metadata only; open or attach the workbook before reads that need cell values or any edit/save operation.
|
|
253
|
+
|
|
254
|
+
The response also returns a `recommended` block (also returned by `/excel/open-or-attach-workbook`) with bounded, pre-computed call shapes:
|
|
255
|
+
|
|
256
|
+
```json
|
|
257
|
+
"recommended": {
|
|
258
|
+
"headerRange": "A1:H1",
|
|
259
|
+
"sampleRange": "A1:H51",
|
|
260
|
+
"spotVerifyRows": [2, 30000, 59999],
|
|
261
|
+
"fillStartRow": 2,
|
|
262
|
+
"fillRowCount": 59999,
|
|
263
|
+
"readChunkSize": 1000,
|
|
264
|
+
"isLargeRange": true
|
|
265
|
+
}
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
Use these directly instead of inventing values:
|
|
269
|
+
- **`headerRange`** — 1-row range for column-name → letter mapping. Always cheap.
|
|
270
|
+
- **`sampleRange`** — header + up to 50 data rows. Read this before any write to validate column types (numeric vs text-with-symbols, date vs string, blanks, sentinels). Always bounded; never grows with file size. If the sample stops at row 51, that is the sample cap, not the end of data.
|
|
271
|
+
- **`spotVerifyRows`** — first / middle / last data-row indices. After a derived-column write, read these rows in your target column with `returnFormulas:true` to spot-check the template + bounds without scanning the body. Agent prepends the column letter to each row number.
|
|
272
|
+
- **`fillStartRow`** — default 2 (assumes single-row header). Verify against `headerRange` if the file has a multi-row header.
|
|
273
|
+
- **`fillRowCount`** — computed by the service for the recommended fill span. Pass this directly to `/excel/write-formula` or `/excel/write-formulas-batch` with `fillStartRow`. Do not chunk into 1000-row batches; both endpoints accept large fills as long as the start row plus row count stays within Excel's row limit.
|
|
274
|
+
- **`readChunkSize`** — chunk size for body scans when full-sheet reads are required. Almost never needed for derived-column tasks (the formula does the math; you don't need to read the data).
|
|
275
|
+
- **`isLargeRange`** — true means full UsedRange reads are unsafe (will hit timeouts or be rejected by `/excel/read-range`).
|
|
276
|
+
|
|
277
|
+
---
|
|
278
|
+
|
|
279
|
+
## Data Operations
|
|
280
|
+
|
|
281
|
+
### /excel/read-range
|
|
282
|
+
|
|
283
|
+
| Parameter | Type | Required | Description |
|
|
284
|
+
|-----------|------|----------|-------------|
|
|
285
|
+
| sheetName | string | Yes | Sheet name |
|
|
286
|
+
| range | string | Yes | A1 notation (e.g., "A1:D100") |
|
|
287
|
+
| useFormattedText | boolean | No | When `true`, returns formatted display text (e.g., "$1,234.56", "44.68%", "1/15/2024") instead of raw values ("1234.56", "0.4468", "45307"). Use this when you need to read values exactly as they appear in Excel. |
|
|
288
|
+
| returnFormulas | boolean | No | When `true`, returns formula strings (e.g., "=SUM(A1:A10)") instead of computed values. Cells without formulas return their plain value. Use this to inspect or copy formula patterns. |
|
|
289
|
+
|
|
290
|
+
**Response:** `data[]` — each entry has `values[]` (string array of cell values)
|
|
291
|
+
|
|
292
|
+
⚠️ Never use entire columns like "A:A" or huge full-sheet ranges - causes timeout. `/excel/read-range` rejects ranges over 10,000 rows or 150,000 cells; use `/excel/get-sheet-dimensions` first and, for large sheets, read `recommendedPreviewRange` or explicit row chunks only when body values are required. Do not use `/excel/read-range` to find the last data row before writing formulas; dimensions already answered that.
|
|
293
|
+
|
|
294
|
+
---
|
|
295
|
+
|
|
296
|
+
### /excel/write-range
|
|
297
|
+
|
|
298
|
+
**BATCH ALL ROWS IN ONE CALL!**
|
|
299
|
+
|
|
300
|
+
| Parameter | Type | Required | Default | Description |
|
|
301
|
+
|-----------|------|----------|---------|-------------|
|
|
302
|
+
| sheetName | string | Yes | - | Sheet name |
|
|
303
|
+
| range | string | Yes | - | Starting cell (e.g., "A1") |
|
|
304
|
+
| data | array | Yes | - | Rows to write |
|
|
305
|
+
| firstRowIsHeader | boolean | No | false | Format first row as header |
|
|
306
|
+
| forceText | boolean | No | false | Write all values as literal text strings — prevents numeric parsing. Use when values contain commas or special chars that Excel would misinterpret (e.g., `"0,1"` → stores as text `0,1` not number `1`). |
|
|
307
|
+
|
|
308
|
+
**Data Schema:**
|
|
309
|
+
```
|
|
310
|
+
data: [
|
|
311
|
+
{ values: ["Header1", "Header2", "Header3"] },
|
|
312
|
+
{ values: ["Value1", 123, "=SUM(B2:C2)"] }
|
|
313
|
+
]
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
**Example — Write comma-decimal values as text:**
|
|
317
|
+
```json
|
|
318
|
+
{"sheetName": "Sheet1", "range": "A2", "forceText": true, "data": [
|
|
319
|
+
{"values": ["0,1", "0,2"]},
|
|
320
|
+
{"values": ["1,0", "1,1"]}
|
|
321
|
+
]}
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
---
|
|
325
|
+
|
|
326
|
+
### /excel/write-ranges-batch (Windows only)
|
|
327
|
+
|
|
328
|
+
**Writes data to multiple non-contiguous ranges in ONE call.** Much faster than calling write-range multiple times.
|
|
329
|
+
|
|
330
|
+
| Parameter | Type | Required | Description |
|
|
331
|
+
|-----------|------|----------|-------------|
|
|
332
|
+
| sheetName | string | Yes | Sheet name |
|
|
333
|
+
| writes | array | Yes | Array of range-data pairs |
|
|
334
|
+
|
|
335
|
+
**Schema:**
|
|
336
|
+
```json
|
|
337
|
+
{
|
|
338
|
+
"sheetName": "Sheet1",
|
|
339
|
+
"writes": [
|
|
340
|
+
{ "range": "A1", "data": [{ "values": ["Name", "Age"] }] },
|
|
341
|
+
{ "range": "A2", "data": [{ "values": ["Alice", 30] }, { "values": ["Bob", 25] }] },
|
|
342
|
+
{ "range": "D1", "data": [{ "values": ["Score"] }] },
|
|
343
|
+
{ "range": "D2", "data": [{ "values": [95] }, { "values": [87] }] }
|
|
344
|
+
]
|
|
345
|
+
}
|
|
346
|
+
```
|
|
347
|
+
|
|
348
|
+
⚠️ **Use this instead of multiple write-range calls** when writing to scattered cells/ranges.
|
|
349
|
+
|
|
350
|
+
---
|
|
351
|
+
|
|
352
|
+
### /excel/append-rows
|
|
353
|
+
|
|
354
|
+
Appends data after last used row.
|
|
355
|
+
|
|
356
|
+
| Parameter | Type | Required | Default | Description |
|
|
357
|
+
|-----------|------|----------|---------|-------------|
|
|
358
|
+
| sheetName | string | Yes | - | Sheet name |
|
|
359
|
+
| startColumn | string | No | "A" | Start column |
|
|
360
|
+
| data | array | Yes | - | Same schema as write-range |
|
|
361
|
+
|
|
362
|
+
---
|
|
363
|
+
|
|
364
|
+
### /excel/clear-range
|
|
365
|
+
|
|
366
|
+
| Parameter | Type | Required | Default | Description |
|
|
367
|
+
|-----------|------|----------|---------|-------------|
|
|
368
|
+
| sheetName | string | No | Active | Sheet name |
|
|
369
|
+
| range | string | Yes | - | Range to clear |
|
|
370
|
+
| clearContents | boolean | No | true | Clear cell values |
|
|
371
|
+
| clearFormats | boolean | No | false | Clear formatting |
|
|
372
|
+
|
|
373
|
+
---
|
|
374
|
+
|
|
375
|
+
### /excel/copy-paste
|
|
376
|
+
|
|
377
|
+
| Parameter | Type | Required | Default | Description |
|
|
378
|
+
|-----------|------|----------|---------|-------------|
|
|
379
|
+
| sourceSheetName | string | No | Active | Source sheet |
|
|
380
|
+
| sourceRange | string | Yes | - | Source range |
|
|
381
|
+
| targetSheetName | string | No | Same | Target sheet |
|
|
382
|
+
| targetRange | string | Yes | - | Target top-left cell (also accepted as `targetStartCell`) |
|
|
383
|
+
| pasteType | string | No | "all" | "all", "values", "formulas", "formats", "valuesAndFormats" |
|
|
384
|
+
| transpose | boolean | No | false | Swap rows and columns during paste |
|
|
385
|
+
| copyVisibleOnly | boolean | No | false | Copy only visible cells (useful after filtering) |
|
|
386
|
+
| cutInsteadOfCopy | boolean | No | false | Move instead of copy (not supported cross-workbook) |
|
|
387
|
+
|
|
388
|
+
---
|
|
389
|
+
|
|
390
|
+
### /excel/find-replace
|
|
391
|
+
|
|
392
|
+
| Parameter | Type | Required | Default | Description |
|
|
393
|
+
|-----------|------|----------|---------|-------------|
|
|
394
|
+
| sheetName | string | No | All sheets | Specific sheet |
|
|
395
|
+
| findWhat | string | Yes | - | Text to find |
|
|
396
|
+
| replaceWith | string | Yes | - | Replacement text |
|
|
397
|
+
| matchCase | boolean | No | false | Case-sensitive |
|
|
398
|
+
|
|
399
|
+
**Batch mode** — multiple find/replace operations in one call:
|
|
400
|
+
|
|
401
|
+
| Parameter | Type | Required | Description |
|
|
402
|
+
|-----------|------|----------|-------------|
|
|
403
|
+
| batch | array | Yes | Array of `{findWhat, replaceWith, sheetName?, range?}` objects |
|
|
404
|
+
|
|
405
|
+
```json
|
|
406
|
+
{"batch": [
|
|
407
|
+
{"findWhat": "Draft", "replaceWith": "Final", "sheetName": "Sheet1"},
|
|
408
|
+
{"findWhat": "TBD", "replaceWith": "N/A", "sheetName": "Sheet1"}
|
|
409
|
+
]}
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
---
|
|
413
|
+
|
|
414
|
+
### /excel/reorder-columns (Windows only)
|
|
415
|
+
|
|
416
|
+
Rearranges columns in a sheet to a new order. All columns must be listed exactly once.
|
|
417
|
+
|
|
418
|
+
| Parameter | Type | Required | Default | Description |
|
|
419
|
+
|-----------|------|----------|---------|-------------|
|
|
420
|
+
| sheetName | string | Yes | - | Sheet name |
|
|
421
|
+
| columnOrder | string[] | Yes | - | New column order as **original** column letters (e.g., ["C", "A", "B", "D"]) |
|
|
422
|
+
| range | string | No | Used range | Specific range to reorder within |
|
|
423
|
+
|
|
424
|
+
**Key behavior:**
|
|
425
|
+
- `columnOrder` uses **original column letters** — specify where each column currently lives, in the desired output order
|
|
426
|
+
- Only operates on the actual data range (first non-empty to last non-empty column). **Blank columns outside that range are preserved untouched** — do NOT include them in `columnOrder`
|
|
427
|
+
- All columns in the data range must appear exactly once
|
|
428
|
+
|
|
429
|
+
**Example 1:** Data in A:D, move column C before A and B:
|
|
430
|
+
```json
|
|
431
|
+
{ "sheetName": "Sheet1", "columnOrder": ["C", "A", "B", "D"] }
|
|
432
|
+
```
|
|
433
|
+
|
|
434
|
+
**Example 2:** Data starts at column B (column A is blank). Reorder B:F to [Date=E, FirstName=B, LastName=D, OrderId=C, Sales=F]:
|
|
435
|
+
```json
|
|
436
|
+
{ "sheetName": "Sheet1", "columnOrder": ["E", "B", "D", "C", "F"] }
|
|
437
|
+
```
|
|
438
|
+
Column A stays blank — do NOT include it in `columnOrder`.
|
|
439
|
+
|
|
440
|
+
⚠️ Call `/excel/get-sheet-dimensions` first to confirm which columns contain data.
|
|
441
|
+
|
|
442
|
+
---
|
|
443
|
+
|
|
444
|
+
### /excel/delete-columns (Windows only)
|
|
445
|
+
|
|
446
|
+
Deletes one or more whole columns from a sheet. Remaining columns shift left.
|
|
447
|
+
|
|
448
|
+
| Parameter | Type | Required | Description |
|
|
449
|
+
|-----------|------|----------|-------------|
|
|
450
|
+
| sheetName | string | Yes | Sheet name |
|
|
451
|
+
| columns | string | Yes | Single column (`"J"`), range (`"J:K"`), or comma list (`"B,D,F"`) |
|
|
452
|
+
|
|
453
|
+
**Use this** when the user asks to delete/drop/remove a column. Do NOT click the Excel ribbon or right-click menu via UIA — that's the monkey path.
|
|
454
|
+
|
|
455
|
+
**Examples:**
|
|
456
|
+
```json
|
|
457
|
+
{"sheetName": "Sheet1", "columns": "J"}
|
|
458
|
+
{"sheetName": "Sheet1", "columns": "J:L"}
|
|
459
|
+
{"sheetName": "Sheet1", "columns": "B,D,F"}
|
|
460
|
+
```
|
|
461
|
+
|
|
462
|
+
Comma lists are deleted right-to-left internally so earlier deletes don't shift later targets.
|
|
463
|
+
|
|
464
|
+
---
|
|
465
|
+
|
|
466
|
+
## Formula Operations
|
|
467
|
+
|
|
468
|
+
### /excel/write-formula
|
|
469
|
+
|
|
470
|
+
| Parameter | Type | Required | Default | Description |
|
|
471
|
+
|-----------|------|----------|---------|-------------|
|
|
472
|
+
| sheetName | string | Yes | - | Sheet name |
|
|
473
|
+
| startCell | string | Yes | - | Starting cell (e.g., "D2") |
|
|
474
|
+
| formulaTemplate | string | Yes | - | Formula with `{row}` placeholder |
|
|
475
|
+
| rowCount | number | No | 1 | Number of rows to fill |
|
|
476
|
+
|
|
477
|
+
**Template:** `=SUM(B{row}:C{row})` becomes `=SUM(B2:C2)`, `=SUM(B3:C3)`, etc.
|
|
478
|
+
|
|
479
|
+
**Example — Write =A/B formula in C2:C25 (24 rows):**
|
|
480
|
+
```json
|
|
481
|
+
{"sheetName": "Sheet1", "startCell": "C2", "formulaTemplate": "=A{row}/B{row}", "rowCount": 24}
|
|
482
|
+
```
|
|
483
|
+
|
|
484
|
+
⚠️ **Primary parameter names:** `startCell`, `formulaTemplate`, `rowCount`. Aliases `range`/`cell`, `formula`/`template`, and `fillDown` also work. **`value` does NOT work** — using `value` instead of `formulaTemplate`/`formula` causes "Formula is required and cannot be empty" error.
|
|
485
|
+
|
|
486
|
+
`rowCount` accepts large fills as long as `startCell` plus `rowCount` stays within Excel's worksheet row limit (1,048,576). Use `recommended.fillStartRow` + `recommended.fillRowCount` when filling a derived column. Do NOT manually batch into chunks of 1000 — pass the full count in a single call; the interop layer handles safe internal chunks.
|
|
487
|
+
|
|
488
|
+
---
|
|
489
|
+
|
|
490
|
+
### /excel/write-formulas-batch
|
|
491
|
+
|
|
492
|
+
**Preferred for formula column fills, including one-column fills.** Much faster for multiple columns.
|
|
493
|
+
|
|
494
|
+
| Parameter | Type | Required | Default | Description |
|
|
495
|
+
|-----------|------|----------|---------|-------------|
|
|
496
|
+
| sheetName | string | Yes | - | Sheet name |
|
|
497
|
+
| startRow | number | No | 2 | Starting row |
|
|
498
|
+
| rowCount | number | No | 1 | Number of rows |
|
|
499
|
+
| formulas | array | Yes | - | Formula definitions |
|
|
500
|
+
|
|
501
|
+
**Schema:**
|
|
502
|
+
```
|
|
503
|
+
formulas: [
|
|
504
|
+
{ column: "D", template: "=SUM(B{row}:C{row})" },
|
|
505
|
+
{ column: "E", template: "=D{row}/B{row}*100" }
|
|
506
|
+
]
|
|
507
|
+
```
|
|
508
|
+
|
|
509
|
+
### Cross-Sheet References (IMPORTANT)
|
|
510
|
+
|
|
511
|
+
**When a cell's value comes from another sheet, ALWAYS write a cross-sheet formula (e.g., `=Data!B2`) instead of reading the source value and writing it as a static number.** Cross-sheet formulas keep the workbook dynamic — when the source data changes, the dependent cells update automatically. Static copies break this link and produce stale data.
|
|
512
|
+
|
|
513
|
+
All formula endpoints support cross-sheet references using `SheetName!CellRef` syntax. Quote sheet names with spaces: `'Q1 Sales'!B{row}`.
|
|
514
|
+
|
|
515
|
+
**write-range — pull values from another sheet:**
|
|
516
|
+
```json
|
|
517
|
+
{
|
|
518
|
+
"sheetName": "Summary",
|
|
519
|
+
"range": "A1",
|
|
520
|
+
"data": [
|
|
521
|
+
{"values": ["Region", "Q1 Sales", "Q2 Sales", "Total"]},
|
|
522
|
+
{"values": ["North", "=Data!B2", "=Data!C2", "=SUM(B2:C2)"]},
|
|
523
|
+
{"values": ["South", "=Data!B3", "=Data!C3", "=SUM(B3:C3)"]}
|
|
524
|
+
]
|
|
525
|
+
}
|
|
526
|
+
```
|
|
527
|
+
|
|
528
|
+
**write-formulas-batch — VLOOKUP and SUMIF across sheets:**
|
|
529
|
+
```json
|
|
530
|
+
{
|
|
531
|
+
"sheetName": "Summary",
|
|
532
|
+
"startRow": 2,
|
|
533
|
+
"rowCount": 50,
|
|
534
|
+
"formulas": [
|
|
535
|
+
{"column": "B", "template": "=VLOOKUP(A{row},Data!$A:$C,2,FALSE)"},
|
|
536
|
+
{"column": "C", "template": "=SUMIF(Transactions!$A:$A,A{row},Transactions!$D:$D)"},
|
|
537
|
+
{"column": "D", "template": "='Q1 Sales'!B{row}+'Q2 Sales'!B{row}"}
|
|
538
|
+
]
|
|
539
|
+
}
|
|
540
|
+
```
|
|
541
|
+
|
|
542
|
+
---
|
|
543
|
+
|
|
544
|
+
## Formatting
|
|
545
|
+
|
|
546
|
+
### /excel/format-range
|
|
547
|
+
|
|
548
|
+
| Parameter | Type | Required | Description |
|
|
549
|
+
|-----------|------|----------|-------------|
|
|
550
|
+
| sheetName | string | Yes | Sheet name |
|
|
551
|
+
| range | string | Yes | Range to format |
|
|
552
|
+
|
|
553
|
+
**Font Options:**
|
|
554
|
+
| Parameter | Type | Description |
|
|
555
|
+
|-----------|------|-------------|
|
|
556
|
+
| bold | boolean | Bold text |
|
|
557
|
+
| italic | boolean | Italic text |
|
|
558
|
+
| fontSize | number | Size (8-72) |
|
|
559
|
+
| fontName | string | Font name (e.g., "Calibri") |
|
|
560
|
+
| fontColorHtml | string | Color (#RRGGBB) |
|
|
561
|
+
|
|
562
|
+
**Cell Options:**
|
|
563
|
+
| Parameter | Type | Description |
|
|
564
|
+
|-----------|------|-------------|
|
|
565
|
+
| interiorColorHtml | string | Background (#RRGGBB) |
|
|
566
|
+
| numberFormat | string | Excel format code |
|
|
567
|
+
| horizontalAlignment | string | "left", "center", "right" |
|
|
568
|
+
| applyThinBorders | boolean | Add thin borders |
|
|
569
|
+
| wrapText | boolean | Wrap text |
|
|
570
|
+
| underline | boolean | Underline text |
|
|
571
|
+
| verticalAlignment | string | "top", "center", "bottom" |
|
|
572
|
+
| autoFit | boolean | Auto-fit columns in range after formatting |
|
|
573
|
+
| mergeCells | boolean | Merge the cells in range |
|
|
574
|
+
| unmergeCells | boolean | Unmerge previously merged cells |
|
|
575
|
+
|
|
576
|
+
**Number format codes:** See `reference/guides.md` §3 for format codes and formatting rules.
|
|
577
|
+
|
|
578
|
+
**Batch mode** — apply multiple formatting operations in one call using the `formatting` array. Each entry uses the same flat properties as a single format-range call:
|
|
579
|
+
|
|
580
|
+
```json
|
|
581
|
+
{
|
|
582
|
+
"sheetName": "Sheet1",
|
|
583
|
+
"formatting": [
|
|
584
|
+
{"range": "A1:D1", "bold": true, "interiorColorHtml": "#4472C4", "fontColorHtml": "#FFFFFF"},
|
|
585
|
+
{"range": "A2:D10", "applyThinBorders": true},
|
|
586
|
+
{"range": "B2:D10", "numberFormat": "$#,##0.00"}
|
|
587
|
+
]
|
|
588
|
+
}
|
|
589
|
+
```
|
|
590
|
+
|
|
591
|
+
Each entry in `formatting` supports these properties: `bold`, `italic`, `fontSize`, `fontName`, `fontColorHtml`, `interiorColorHtml`, `numberFormat`, `horizontalAlignment`, `applyThinBorders`, `wrapText`. The `sheetName` from the parent request is inherited by all entries.
|
|
592
|
+
|
|
593
|
+
**Not supported in batch mode:** `underline`, `verticalAlignment`, `autoFit`, `mergeCells`, `unmergeCells`. Use separate single `format-range` or `merge-cells` calls for these.
|
|
594
|
+
|
|
595
|
+
---
|
|
596
|
+
|
|
597
|
+
### /excel/auto-fit-columns
|
|
598
|
+
|
|
599
|
+
| Parameter | Type | Required | Default | Description |
|
|
600
|
+
|-----------|------|----------|---------|-------------|
|
|
601
|
+
| sheetName | string | Yes | - | Sheet name |
|
|
602
|
+
| columns | string | No | UsedRange | Column range (column letters only, no row numbers). Examples: "A:D" (columns A through D), "A:A" (single column A), "B:F" (columns B through F). Omit to auto-fit all used columns. |
|
|
603
|
+
|
|
604
|
+
---
|
|
605
|
+
|
|
606
|
+
### /excel/freeze-panes
|
|
607
|
+
|
|
608
|
+
| Parameter | Type | Required | Default | Description |
|
|
609
|
+
|-----------|------|----------|---------|-------------|
|
|
610
|
+
| sheetName | string | Yes | - | Sheet name |
|
|
611
|
+
| freezeRows | number | No | 0 | Rows to freeze |
|
|
612
|
+
| freezeColumns | number | No | 0 | Columns to freeze |
|
|
613
|
+
|
|
614
|
+
Examples: `freezeRows: 1` (header), `freezeRows: 1, freezeColumns: 1` (both)
|
|
615
|
+
|
|
616
|
+
---
|
|
617
|
+
|
|
618
|
+
## Data Analysis
|
|
619
|
+
|
|
620
|
+
### /excel/sort-range
|
|
621
|
+
|
|
622
|
+
| Parameter | Type | Required | Default | Description |
|
|
623
|
+
|-----------|------|----------|---------|-------------|
|
|
624
|
+
| sheetName | string | Yes | - | Sheet name |
|
|
625
|
+
| range | string | No | UsedRange | Range to sort |
|
|
626
|
+
| keyColumnIndex | number | No | 1 | ⚠️ **1-BASED!** Column 1 = first column in range |
|
|
627
|
+
| descending | boolean | No | true | Descending order (use `ascending: true` for A→Z) |
|
|
628
|
+
| hasHeader | boolean | No | true | First row is header |
|
|
629
|
+
|
|
630
|
+
⚠️ **CRITICAL - keyColumnIndex is 1-BASED:**
|
|
631
|
+
- Column A (first column) = `keyColumnIndex: 1` ✅
|
|
632
|
+
- Column A (first column) = `keyColumnIndex: 0` ❌ WRONG! Will fail!
|
|
633
|
+
- Column B (second column) = `keyColumnIndex: 2`
|
|
634
|
+
- Column D (fourth column) = `keyColumnIndex: 4`
|
|
635
|
+
|
|
636
|
+
⚠️ **Parameter names are exact:** use `keyColumnIndex` (NOT `columnIndex`, `sortColumns`, `sortBy`, or `column`), `ascending` (NOT nested inside another object), `hasHeader` (NOT `hasHeaders`)
|
|
637
|
+
|
|
638
|
+
**Example - Sort by Amount in column D, ascending:**
|
|
639
|
+
```json
|
|
640
|
+
{"sheetName": "Sheet1", "range": "A1:D100", "keyColumnIndex": 4, "ascending": true, "hasHeader": true}
|
|
641
|
+
```
|
|
642
|
+
|
|
643
|
+
---
|
|
644
|
+
|
|
645
|
+
### /excel/filter-range
|
|
646
|
+
|
|
647
|
+
This is the **auto-filter** endpoint — `action: "apply"` adds Excel's filter dropdown arrows on the header row. With `column` + `filterType` + `criteria` you can also apply a specific filter condition.
|
|
648
|
+
|
|
649
|
+
| Parameter | Type | Required | Default | Description |
|
|
650
|
+
|-----------|------|----------|---------|-------------|
|
|
651
|
+
| sheetName | string | No | Active | Sheet name |
|
|
652
|
+
| range | string | No | UsedRange | Data range (include header row) |
|
|
653
|
+
| action | string | No | "apply" | "apply" or "clear" |
|
|
654
|
+
| column | string | No | - | Column ("A" or 1) |
|
|
655
|
+
| filterType | string | No | - | Filter type |
|
|
656
|
+
| criteria | string | No | - | Filter value |
|
|
657
|
+
|
|
658
|
+
**Filter Types:** `equals`, `contains`, `greaterThan`, `lessThan`, `between`, `top10`
|
|
659
|
+
|
|
660
|
+
**Example — Add auto-filter dropdowns to header row:**
|
|
661
|
+
```json
|
|
662
|
+
{"sheetName": "Stores", "range": "A1:J1", "action": "apply"}
|
|
663
|
+
```
|
|
664
|
+
|
|
665
|
+
---
|
|
666
|
+
|
|
667
|
+
## Health Check
|
|
668
|
+
|
|
669
|
+
### /excel/get-status
|
|
670
|
+
|
|
671
|
+
Returns workbook health: cell errors, chart overlaps, anomalies, and sheet summary.
|
|
672
|
+
|
|
673
|
+
**Parameters:**
|
|
674
|
+
|
|
675
|
+
| Parameter | Type | Required | Description |
|
|
676
|
+
|-----------|------|----------|-------------|
|
|
677
|
+
| workbookId | number | No | Workbook ID |
|
|
678
|
+
| filePath | string | No | OR file path |
|
|
679
|
+
| sheetName | string | No | Specific sheet to scan (omit to scan active sheet) |
|
|
680
|
+
|
|
681
|
+
**Response:**
|
|
682
|
+
|
|
683
|
+
| Field | Type | Description |
|
|
684
|
+
|-------|------|-------------|
|
|
685
|
+
| workbookName | string | Name of the workbook |
|
|
686
|
+
| activeSheetName | string | Currently active sheet |
|
|
687
|
+
| sheetCount | number | Total sheets in workbook |
|
|
688
|
+
| sheets | array | All sheet names |
|
|
689
|
+
| usedRange | string | Used range of scanned sheet |
|
|
690
|
+
| hasErrors | boolean | Whether cell errors were detected |
|
|
691
|
+
| hasChartOverlaps | boolean | Whether chart overlaps detected |
|
|
692
|
+
| hasAnomalies | boolean | Whether data anomalies found |
|
|
693
|
+
| isHealthy | boolean | Overall health flag (no errors, no overlaps, no anomalies) |
|
|
694
|
+
| cellErrors | array | Cells with formula errors (see below) |
|
|
695
|
+
| chartOverlaps | array | Chart overlap issues (see below) |
|
|
696
|
+
| anomalies | array | Data anomalies detected (see below) |
|
|
697
|
+
| healthSummary | string | LLM-friendly summary of issues |
|
|
698
|
+
|
|
699
|
+
**cellErrors entry:** `{ cellAddress, errorType, formula, description }`
|
|
700
|
+
|
|
701
|
+
Error types: `#REF!`, `#DIV/0!`, `#VALUE!`, `#N/A`, `#NAME?`, `#NULL!`, `#NUM!`
|
|
702
|
+
|
|
703
|
+
**chartOverlaps entry:** `{ chartName, overlapType, details, chartPosition }`
|
|
704
|
+
|
|
705
|
+
Overlap types: `"data"`, `"chart"`, `"object"`
|
|
706
|
+
|
|
707
|
+
**anomalies entry:** `{ type, location, description, severity }`
|
|
708
|
+
|
|
709
|
+
Anomaly types: `empty_cells_in_data`, `inconsistent_formatting`, `hidden_rows`, `merged_cells`, `very_wide_columns`, `health_check_timeout`, `health_check_error`. Severity: `"low"`, `"medium"`, `"high"`.
|
|
710
|
+
|
|
711
|
+
**Example response:**
|
|
712
|
+
```json
|
|
713
|
+
{
|
|
714
|
+
"workbookName": "Report.xlsx",
|
|
715
|
+
"activeSheetName": "Sheet1",
|
|
716
|
+
"sheetCount": 1,
|
|
717
|
+
"sheets": ["Sheet1"],
|
|
718
|
+
"usedRange": "A1:D50",
|
|
719
|
+
"hasErrors": true,
|
|
720
|
+
"isHealthy": false,
|
|
721
|
+
"cellErrors": [{"cellAddress": "D5", "errorType": "#REF!", "formula": "=C5/B5", "description": "#REF! error in D5"}],
|
|
722
|
+
"chartOverlaps": [],
|
|
723
|
+
"anomalies": [],
|
|
724
|
+
"healthSummary": "1 formula error found"
|
|
725
|
+
}
|
|
726
|
+
```
|
|
727
|
+
|
|
728
|
+
---
|
|
729
|
+
|
|
730
|
+
## Undo
|
|
731
|
+
|
|
732
|
+
### /excel/undo
|
|
733
|
+
|
|
734
|
+
Undoes the user's most recent MANUAL edits (typed/clicked in Excel's UI).
|
|
735
|
+
|
|
736
|
+
**`/excel/undo` works ONLY for user actions.** It never reverts changes made through the API (`write-range`, `write-formula`, `format-range`, sort, etc.) — API changes don't enter Excel's undo stack, so the call returns `success` without reverting anything. To revert an API change, write the previous value back (or `clear-range`), then confirm with `read-range`.
|
|
737
|
+
|
|
738
|
+
| Parameter | Type | Required | Default | Description |
|
|
739
|
+
|-----------|------|----------|---------|-------------|
|
|
740
|
+
| steps | number | No | 1 | Number of recent user actions to undo |
|
|
741
|
+
|
|
742
|
+
**Response:** `{ success, stepsUndone }`
|
|
743
|
+
|
|
744
|
+
**Example — Undo the user's last two manual edits:**
|
|
745
|
+
```json
|
|
746
|
+
{"steps": 2}
|
|
747
|
+
```
|