@uipath/skills 1.199.0 → 1.200.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (345) hide show
  1. package/.claude-plugin/marketplace.json +1 -1
  2. package/.claude-plugin/plugin.json +1 -1
  3. package/CODEOWNERS +14 -8
  4. package/README.md +18 -3
  5. package/assets/skill-status.json +9 -1
  6. package/assets/uip-catalog-snapshot.json +227 -21
  7. package/package.json +11 -2
  8. package/scripts/npm-package-lifecycle.mjs +46 -0
  9. package/skills/uipath-admin/SKILL.md +5 -1
  10. package/skills/uipath-admin/references/audit-commands.md +1 -1
  11. package/skills/uipath-admin/references/audit-workflow-guide.md +9 -0
  12. package/skills/uipath-agents/SKILL.md +2 -2
  13. package/skills/uipath-agents/references/lowcode/capabilities/context/index.md +7 -0
  14. package/skills/uipath-agents/references/lowcode/capabilities/integration-service/integration-service.md +5 -6
  15. package/skills/uipath-agents/references/lowcode/critical-rules/critical-rules.md +1 -1
  16. package/skills/uipath-agents/references/lowcode/evaluations/evaluation-sets.md +5 -0
  17. package/skills/uipath-agents/references/lowcode/project-lifecycle.md +3 -3
  18. package/skills/uipath-agents/references/lowcode/prompting/autonomous-agent-prompting-guide.md +3 -2
  19. package/skills/uipath-api-workflow/SKILL.md +2 -1
  20. package/skills/uipath-api-workflow/references/cli-reference.md +3 -3
  21. package/skills/uipath-coded-apps/SKILL.md +3 -2
  22. package/skills/uipath-coded-apps/assets/fixtures/governance-dashboard-starter-kit.tar.gz +0 -0
  23. package/skills/uipath-coded-apps/assets/templates/web-app-template.md +1 -1
  24. package/skills/uipath-coded-apps/references/create-web-app.md +60 -48
  25. package/skills/uipath-coded-apps/references/dashboards/CAPABILITY.md +2 -2
  26. package/skills/uipath-coded-apps/references/dashboards/plugins/build/impl.md +2 -2
  27. package/skills/uipath-coded-apps/references/dashboards/primitives/tier-resolution.md +16 -16
  28. package/skills/uipath-coded-apps/references/oauth-scopes.md +28 -272
  29. package/skills/uipath-coded-apps/references/sdk/action-center.md +26 -243
  30. package/skills/uipath-coded-apps/references/sdk/agents.md +20 -130
  31. package/skills/uipath-coded-apps/references/sdk/conversational-agent.md +52 -706
  32. package/skills/uipath-coded-apps/references/sdk/data-fabric.md +20 -237
  33. package/skills/uipath-coded-apps/references/sdk/feedback.md +4 -139
  34. package/skills/uipath-coded-apps/references/sdk/governance-traces.md +7 -55
  35. package/skills/uipath-coded-apps/references/sdk/governance.md +4 -44
  36. package/skills/uipath-coded-apps/references/sdk/imports.md +77 -35
  37. package/skills/uipath-coded-apps/references/sdk/maestro.md +29 -406
  38. package/skills/uipath-coded-apps/references/sdk/orchestrator.md +30 -324
  39. package/skills/uipath-coded-apps/references/sdk/pagination.md +9 -67
  40. package/skills/uipath-coded-apps/references/sdk/traces.md +8 -43
  41. package/skills/uipath-functions/SKILL.md +23 -23
  42. package/skills/uipath-governance/SKILL.md +5 -4
  43. package/skills/uipath-governance/references/cli-cheatsheet.md +2 -1
  44. package/skills/uipath-governance/references/compliance-pack/coverage/impl.md +143 -58
  45. package/skills/uipath-governance/references/compliance-pack/restore/impl.md +61 -0
  46. package/skills/uipath-human-in-the-loop/SKILL.md +4 -2
  47. package/skills/uipath-insights/SKILL.md +17 -18
  48. package/skills/uipath-ixp/SKILL.md +12 -7
  49. package/skills/uipath-ixp/references/cli-reference.md +71 -9
  50. package/skills/uipath-ixp/references/improve-prompts-guide.md +23 -9
  51. package/skills/uipath-ixp/references/label-documents-guide.md +33 -5
  52. package/skills/uipath-maestro-bpmn/SKILL.md +15 -14
  53. package/skills/uipath-maestro-bpmn/references/cli-conventions.md +15 -6
  54. package/skills/uipath-maestro-bpmn/references/structural-bpmn.md +18 -17
  55. package/skills/uipath-maestro-case/SKILL.md +46 -33
  56. package/skills/uipath-maestro-case/assets/templates/sdd-template.md +77 -37
  57. package/skills/uipath-maestro-case/assets/templates/sdd-viewer.html +0 -2
  58. package/skills/uipath-maestro-case/references/bindings-and-expressions.md +3 -1
  59. package/skills/uipath-maestro-case/references/bindings-v2-sync.md +2 -2
  60. package/skills/uipath-maestro-case/references/brownfield.md +15 -5
  61. package/skills/uipath-maestro-case/references/case-commands.md +19 -3
  62. package/skills/uipath-maestro-case/references/case-editing-operations.md +24 -21
  63. package/skills/uipath-maestro-case/references/case-schema.md +38 -16
  64. package/skills/uipath-maestro-case/references/connector-trigger-common.md +15 -8
  65. package/skills/uipath-maestro-case/references/evals/evals.json +35 -18
  66. package/skills/uipath-maestro-case/references/implementation.md +86 -71
  67. package/skills/uipath-maestro-case/references/phase-0-interview.md +92 -23
  68. package/skills/uipath-maestro-case/references/phased-execution.md +70 -55
  69. package/skills/uipath-maestro-case/references/placeholder-tasks.md +5 -5
  70. package/skills/uipath-maestro-case/references/planning.md +57 -9
  71. package/skills/uipath-maestro-case/references/plugins/case/impl-json.md +7 -5
  72. package/skills/uipath-maestro-case/references/plugins/case/planning.md +1 -1
  73. package/skills/uipath-maestro-case/references/plugins/conditions/case-exit-conditions/impl-json.md +5 -5
  74. package/skills/uipath-maestro-case/references/plugins/conditions/stage-entry-conditions/impl-json.md +41 -5
  75. package/skills/uipath-maestro-case/references/plugins/conditions/stage-entry-conditions/planning.md +27 -3
  76. package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/impl-json.md +6 -6
  77. package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/planning.md +3 -1
  78. package/skills/uipath-maestro-case/references/plugins/conditions/task-entry-conditions/impl-json.md +20 -7
  79. package/skills/uipath-maestro-case/references/plugins/conditions/task-entry-conditions/planning.md +37 -4
  80. package/skills/uipath-maestro-case/references/plugins/sla/impl-json.md +24 -13
  81. package/skills/uipath-maestro-case/references/plugins/sla/planning.md +9 -3
  82. package/skills/uipath-maestro-case/references/plugins/stages/impl-json.md +4 -0
  83. package/skills/uipath-maestro-case/references/plugins/stages/planning.md +4 -1
  84. package/skills/uipath-maestro-case/references/plugins/tasks/action/impl-json.md +3 -1
  85. package/skills/uipath-maestro-case/references/plugins/tasks/action/planning.md +2 -0
  86. package/skills/uipath-maestro-case/references/plugins/tasks/agent/impl-json.md +3 -2
  87. package/skills/uipath-maestro-case/references/plugins/tasks/agent/planning.md +4 -2
  88. package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/impl-json.md +3 -2
  89. package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/planning.md +4 -2
  90. package/skills/uipath-maestro-case/references/plugins/tasks/case-management/impl-json.md +3 -2
  91. package/skills/uipath-maestro-case/references/plugins/tasks/case-management/planning.md +4 -2
  92. package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/impl-json.md +1 -1
  93. package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/planning.md +2 -0
  94. package/skills/uipath-maestro-case/references/plugins/tasks/connector-trigger/impl-json.md +1 -1
  95. package/skills/uipath-maestro-case/references/plugins/tasks/connector-trigger/planning.md +2 -0
  96. package/skills/uipath-maestro-case/references/plugins/tasks/create-inline-common.md +1 -1
  97. package/skills/uipath-maestro-case/references/plugins/tasks/process/impl-json.md +3 -2
  98. package/skills/uipath-maestro-case/references/plugins/tasks/process/planning.md +6 -4
  99. package/skills/uipath-maestro-case/references/plugins/tasks/rpa/impl-json.md +3 -2
  100. package/skills/uipath-maestro-case/references/plugins/tasks/rpa/planning.md +4 -2
  101. package/skills/uipath-maestro-case/references/plugins/tasks/wait-for-timer/impl-json.md +4 -3
  102. package/skills/uipath-maestro-case/references/plugins/tasks/wait-for-timer/planning.md +4 -0
  103. package/skills/uipath-maestro-case/references/plugins/triggers/event/impl-json.md +17 -14
  104. package/skills/uipath-maestro-case/references/plugins/triggers/event/planning.md +1 -1
  105. package/skills/uipath-maestro-case/references/plugins/triggers/manual/impl-json.md +13 -10
  106. package/skills/uipath-maestro-case/references/plugins/triggers/timer/impl-json.md +18 -16
  107. package/skills/uipath-maestro-case/references/plugins/triggers/timer/planning.md +2 -2
  108. package/skills/uipath-maestro-case/references/plugins/variables/bindings/impl-json.md +1 -1
  109. package/skills/uipath-maestro-case/references/plugins/variables/global-vars/impl-json.md +11 -9
  110. package/skills/uipath-maestro-case/references/plugins/variables/io-binding/impl-json.md +6 -2
  111. package/skills/uipath-maestro-case/references/plugins/variables/io-binding/planning.md +19 -1
  112. package/skills/uipath-maestro-case/references/registry-discovery.md +3 -3
  113. package/skills/uipath-maestro-case/references/sdd-generation-rules.md +155 -51
  114. package/skills/uipath-maestro-case/references/sla-response-shapes.md +74 -0
  115. package/skills/uipath-maestro-flow/SKILL.md +4 -3
  116. package/skills/uipath-maestro-flow/references/author/CAPABILITY.md +3 -0
  117. package/skills/uipath-maestro-flow/references/author/references/editing-operations-json.md +10 -17
  118. package/skills/uipath-maestro-flow/references/author/references/editing-operations.md +1 -1
  119. package/skills/uipath-maestro-flow/references/author/references/greenfield.md +8 -6
  120. package/skills/uipath-maestro-flow/references/author/references/planning-impl.md +1 -1
  121. package/skills/uipath-maestro-flow/references/author/references/plugins/agent/impl.md +4 -9
  122. package/skills/uipath-maestro-flow/references/author/references/plugins/agentic-process/impl.md +3 -7
  123. package/skills/uipath-maestro-flow/references/author/references/plugins/api-workflow/impl.md +5 -8
  124. package/skills/uipath-maestro-flow/references/author/references/plugins/connector/impl.md +11 -4
  125. package/skills/uipath-maestro-flow/references/author/references/plugins/flow/impl.md +3 -7
  126. package/skills/uipath-maestro-flow/references/author/references/plugins/inline-agent/impl.md +14 -17
  127. package/skills/uipath-maestro-flow/references/author/references/plugins/ixp/impl.md +60 -13
  128. package/skills/uipath-maestro-flow/references/author/references/plugins/queue/impl.md +2 -14
  129. package/skills/uipath-maestro-flow/references/author/references/plugins/rpa/impl.md +4 -9
  130. package/skills/uipath-maestro-flow/references/author/references/plugins/script/impl.md +3 -0
  131. package/skills/uipath-maestro-flow/references/author/references/plugins/subflow/impl.md +5 -9
  132. package/skills/uipath-maestro-flow/references/author/references/plugins/transform/impl.md +13 -0
  133. package/skills/uipath-maestro-flow/references/shared/action-nodes.md +2 -2
  134. package/skills/uipath-maestro-flow/references/shared/file-format.md +16 -12
  135. package/skills/uipath-maestro-flow/references/shared/variables-and-expressions.md +3 -3
  136. package/skills/uipath-planner/SKILL.md +1 -1
  137. package/skills/uipath-planner/references/non-pdd-lane-guide.md +1 -1
  138. package/skills/uipath-platform/SKILL.md +1 -1
  139. package/skills/uipath-platform/references/data-fabric/bulk-import.md +10 -27
  140. package/skills/uipath-platform/references/data-fabric/choice-sets.md +7 -64
  141. package/skills/uipath-platform/references/data-fabric/data-fabric.md +76 -267
  142. package/skills/uipath-platform/references/data-fabric/entity-schema.md +23 -99
  143. package/skills/uipath-platform/references/data-fabric/file-attachments.md +5 -28
  144. package/skills/uipath-platform/references/data-fabric/filter-platform-contract.md +2 -2
  145. package/skills/uipath-platform/references/data-fabric/records-query.md +11 -32
  146. package/skills/uipath-platform/references/integration-service/reference-resolution.md +6 -2
  147. package/skills/uipath-platform/references/licensing/consumables-report.md +18 -0
  148. package/skills/uipath-platform/references/licensing/licensing.md +1 -1
  149. package/skills/uipath-platform/references/orchestrator/run-jobs.md +9 -2
  150. package/skills/uipath-platform/references/orchestrator/setup-environment.md +9 -0
  151. package/skills/uipath-platform/references/traces/feedback.md +4 -1
  152. package/skills/uipath-process-mining/SKILL.md +97 -0
  153. package/skills/uipath-process-mining/references/app-types.md +66 -0
  154. package/skills/uipath-process-mining/references/data-model.md +130 -0
  155. package/skills/uipath-process-mining/references/lifecycle-and-rbac.md +67 -0
  156. package/skills/uipath-process-mining/references/model-editing.md +112 -0
  157. package/skills/uipath-process-mining/references/pre-flight.md +119 -0
  158. package/skills/uipath-process-mining/references/querying.md +66 -0
  159. package/skills/uipath-process-mining/references/transformations.md +80 -0
  160. package/skills/uipath-process-mining/references/uip-pm-cli.md +145 -0
  161. package/skills/uipath-review/SKILL.md +23 -18
  162. package/skills/uipath-review/references/agents/agent-grading-rubric.md +1 -1
  163. package/skills/uipath-review/references/agents/agent-review-checklist.md +0 -4
  164. package/skills/uipath-review/references/agents/agents-coded-rules.md +1 -10
  165. package/skills/uipath-review/references/agents/agents-lowcode-rules.md +3 -6
  166. package/skills/uipath-review/references/agents/guardrails/coded-guardrails-review.md +62 -14
  167. package/skills/uipath-review/references/agents/guardrails/guardrails-review.md +60 -4
  168. package/skills/uipath-review/references/review-workflow-guide.md +3 -2
  169. package/skills/uipath-review/references/rule-catalog-workflow.md +4 -5
  170. package/skills/uipath-rpa/.maintenance/pattern-card-maintenance.md +20 -0
  171. package/skills/uipath-rpa/SKILL.md +57 -55
  172. package/skills/uipath-rpa/agents/uipath-project-discovery-agent.md +75 -19
  173. package/skills/uipath-rpa/assets/codedworkflow-template.md +245 -11
  174. package/skills/uipath-rpa/references/cli-reference.md +229 -6
  175. package/skills/uipath-rpa/references/coded/codedworkflow-reference.md +158 -2
  176. package/skills/uipath-rpa/references/coded/integration-service-guide.md +6 -5
  177. package/skills/uipath-rpa/references/coded/operations-guide.md +273 -5
  178. package/skills/uipath-rpa/references/coded-vs-xaml-guide.md +3 -3
  179. package/skills/uipath-rpa/references/common-pattern-card.md +303 -0
  180. package/skills/uipath-rpa/references/data-manipulation-guide.md +18 -3
  181. package/skills/uipath-rpa/references/debugging.md +0 -2
  182. package/skills/uipath-rpa/references/environment-setup.md +309 -1
  183. package/skills/uipath-rpa/references/error-handling-guide.md +1 -1
  184. package/skills/uipath-rpa/references/execution-maps-guide.md +110 -0
  185. package/skills/uipath-rpa/references/is-connector-xaml-guide.md +58 -4
  186. package/skills/uipath-rpa/references/legacy/activity-docs/Excel.md +1 -1
  187. package/skills/uipath-rpa/references/legacy/activity-docs/_DU-PROCESS.md +0 -2
  188. package/skills/uipath-rpa/references/legacy/activity-docs/_INDEX.md +2 -2
  189. package/skills/uipath-rpa/references/legacy/activity-docs/_PATTERNS.md +1 -1
  190. package/skills/uipath-rpa/references/legacy/activity-docs/_REFRAMEWORK.md +2 -7
  191. package/skills/uipath-rpa/references/legacy/cli-reference.md +599 -0
  192. package/skills/uipath-rpa/references/legacy/error-handling-guide.md +2 -2
  193. package/skills/uipath-rpa/references/legacy/legacy-mode-guide.md +16 -16
  194. package/skills/uipath-rpa/references/legacy/project-organization-guide.md +2 -2
  195. package/skills/uipath-rpa/references/legacy/selector-guide.md +163 -1
  196. package/skills/uipath-rpa/references/legacy/testing-guide.md +246 -3
  197. package/skills/uipath-rpa/references/legacy/xaml-basics-and-rules.md +267 -2
  198. package/skills/uipath-rpa/references/library-authoring-guide.md +4 -3
  199. package/skills/uipath-rpa/references/testing-guide.md +2 -28
  200. package/skills/uipath-rpa/references/trigger-pattern-guide.md +1 -1
  201. package/skills/uipath-rpa/references/xaml/canvas-layout-guide.md +140 -33
  202. package/skills/uipath-rpa/references/xaml/common-pitfalls.md +57 -240
  203. package/skills/uipath-rpa/references/xaml/csharp-activity-binding-guide.md +42 -2
  204. package/skills/uipath-rpa/references/xaml/long-running-workflow-guide.md +1 -1
  205. package/skills/uipath-rpa/references/xaml/xaml-basics-and-rules.md +194 -228
  206. package/skills/uipath-solution/references/activate-and-manage.md +22 -0
  207. package/skills/uipath-solution/references/develop-solution.md +26 -2
  208. package/skills/uipath-solution/references/pack-and-deploy.md +43 -9
  209. package/skills/uipath-test/SKILL.md +4 -4
  210. package/skills/uipath-test/references/playwright-first-mile-guide.md +5 -4
  211. package/skills/uipath-test/references/publish-and-link-guide.md +2 -2
  212. package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/click-silent-no-op.md +5 -5
  213. package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/queue-operation-failed.md +20 -4
  214. package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/summary.md +1 -1
  215. package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/read-csv-file-not-found.md +12 -0
  216. package/skills/uipath-troubleshoot/references/activity-packages/mail-activities/playbooks/send-outlook-mail-failures.md +12 -1
  217. package/skills/uipath-troubleshoot/references/activity-packages/system-activities/playbooks/get-asset-activity-bug-silent-failure.md +2 -1
  218. package/skills/uipath-troubleshoot/references/activity-packages/terminal-activities/playbooks/terminal-session-connection-failed.md +5 -1
  219. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/click-silent-no-op.md +5 -5
  220. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/dependency-version-conflict.md +27 -6
  221. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/napplicationcard-view-generation-failed.md +10 -0
  222. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/scope-container-wrong-page.md +1 -1
  223. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/summary.md +1 -1
  224. package/skills/uipath-troubleshoot/references/activity-packages/web-activities/overview.md +4 -0
  225. package/skills/uipath-troubleshoot/references/activity-packages/web-activities/playbooks/http-request-auth-401-403.md +44 -0
  226. package/skills/uipath-troubleshoot/references/activity-packages/web-activities/playbooks/http-request-connection-failure.md +2 -1
  227. package/skills/uipath-troubleshoot/references/activity-packages/web-activities/playbooks/http-request-content-type-rejected.md +37 -0
  228. package/skills/uipath-troubleshoot/references/activity-packages/web-activities/playbooks/http-request-proxy-blocked.md +39 -0
  229. package/skills/uipath-troubleshoot/references/activity-packages/web-activities/playbooks/package-version-mismatch.md +42 -0
  230. package/skills/uipath-troubleshoot/references/activity-packages/web-activities/playbooks/securestring-misuse-analyzer.md +41 -0
  231. package/skills/uipath-troubleshoot/references/activity-packages/web-activities/summary.md +5 -0
  232. package/skills/uipath-troubleshoot/references/products/integration-service/playbooks/connector-null-reference.md +14 -1
  233. package/skills/uipath-troubleshoot/references/products/integration-service/playbooks/connector-runtime-exception.md +2 -0
  234. package/skills/uipath-troubleshoot/references/products/integration-service/playbooks/is-activities-prerelease-not-found.md +39 -0
  235. package/skills/uipath-troubleshoot/references/products/integration-service/playbooks/response-content-too-large.md +41 -0
  236. package/skills/uipath-troubleshoot/references/products/integration-service/summary.md +9 -0
  237. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/console-conflict-login-to-console.md +40 -0
  238. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/credential-store-unavailable.md +42 -0
  239. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/executor-start-transient-rerun.md +49 -0
  240. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-consecutive-system-exceptions.md +47 -0
  241. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-faulted-session-timeout.md +19 -19
  242. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-output-too-large.md +47 -0
  243. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-stopped-generic-exit-code.md +55 -0
  244. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/known-issue-robot-defect.md +40 -0
  245. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/platform-incident-correlation.md +45 -0
  246. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/screen-capture-handle-invalid.md +43 -0
  247. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/serverless-license-quota.md +43 -0
  248. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/serverless-time-limit-exceeded.md +34 -0
  249. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/workstation-in-use-machine-slots.md +40 -0
  250. package/skills/uipath-troubleshoot/references/products/orchestrator/summary.md +13 -1
  251. package/version-manifest.json +2 -2
  252. package/skills/uipath-maestro-bpmn/validator/README.md +0 -224
  253. package/skills/uipath-maestro-bpmn/validator/model.mjs +0 -419
  254. package/skills/uipath-maestro-bpmn/validator/package.json +0 -17
  255. package/skills/uipath-maestro-bpmn/validator/rules.mjs +0 -1403
  256. package/skills/uipath-maestro-bpmn/validator/samples/invalid-conditional-and-variable.bpmn +0 -25
  257. package/skills/uipath-maestro-bpmn/validator/samples/valid-baseline.bpmn +0 -52
  258. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/A.2.0.bpmn +0 -157
  259. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/A.2.1.bpmn +0 -333
  260. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/B.1.0.bpmn +0 -598
  261. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/B.2.0.bpmn +0 -1709
  262. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/C.2.0.bpmn +0 -564
  263. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/C.3.0.bpmn +0 -671
  264. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/C.4.0.bpmn +0 -1045
  265. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/C.5.0.bpmn +0 -1176
  266. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/C.6.0.bpmn +0 -670
  267. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/C.7.0.bpmn +0 -466
  268. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/Can_Parse_Complex_Process_With_Task_Gateway_BoundaryEvent_etc.bpmn +0 -74
  269. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/ExclusiveGatewayDefaultFlow.bpmn +0 -32
  270. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/ExternalAgentWorkflow.bpmn +0 -62
  271. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/Golden_Scenario.initial.bpmn +0 -361
  272. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/InclusiveJoinRouteAwayBranch.bpmn +0 -62
  273. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/Parse_AsyncExecution_And_Create_CorrectModel.bpmn +0 -74
  274. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/Parse_IXP_ExtractionValidation_And_Create_CorrectModel.bpmn +0 -35
  275. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/Parse_IXP_Extraction_FileUpload_And_Create_CorrectModel.bpmn +0 -33
  276. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/Parse_IXP_Extraction_JobAttachment_And_Create_CorrectModel.bpmn +0 -35
  277. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/Parse_SubProcess_With_Multiple_Element_Types.bpmn +0 -76
  278. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/StartEventWithOutputs.bpmn +0 -36
  279. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/StartGatewayEnd.bpmn +0 -44
  280. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/all elements.bpmn +0 -516
  281. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/all_sequence_flow_types.bpmn +0 -173
  282. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/demo.bpmn +0 -181
  283. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/subprocess-example-001-collapsed.bpmn +0 -126
  284. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/subprocess-example-001-expanded.bpmn +0 -122
  285. package/skills/uipath-maestro-bpmn/validator/test/fixtures/expected-findings/subprocess-example-003-collapsed_deeply-nested.bpmn +0 -438
  286. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/A.1.0.bpmn +0 -87
  287. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/A.3.0.bpmn +0 -165
  288. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/ApiWorkflow.bpmn +0 -39
  289. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/BpmnNestedSubProcessTests.bpmn +0 -102
  290. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/BpmnTimerBoundaryEvents.bpmn +0 -160
  291. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/BpmnXmlWithCatchAllErrorEventSubProcess.bpmn +0 -45
  292. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/BpmnXmlWithSpecificErrorEventSubProcess.bpmn +0 -46
  293. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/CaseManagementWithConstantIdentifier.bpmn +0 -218
  294. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/ErrorBoundary.bpmn +0 -78
  295. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/ErrorPropagationInEventSubprocess.bpmn +0 -340
  296. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/EventBasedGatewayFirstCatcherWins.bpmn +0 -56
  297. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/Example-EventBasedGateway.bpmn +0 -117
  298. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/ExclusiveGatewayConditional.bpmn +0 -45
  299. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/ExclusiveGatewaySharedEndEvent.bpmn +0 -45
  300. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/ExclusiveWithParallelGateway.bpmn +0 -68
  301. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/FourScriptTasks.bpmn +0 -84
  302. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/HitlTaskOnly.bpmn +0 -55
  303. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/InclusiveGatewayForkJoin.bpmn +0 -69
  304. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/Parse_BPMN_Elements_And_Create_CorrectModel.bpmn +0 -20
  305. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/Parse_HttpRequest_ServiceTask_And_Create_Correct_Model.bpmn +0 -34
  306. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/Parse_MessageBoundaryEvent_And_Create_CorrectModel.bpmn +0 -87
  307. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/Parse_Script_Task_V2_And_Create_Correct_Model.bpmn +0 -31
  308. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/Parse_Sets_Containers_Properly.bpmn +0 -129
  309. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/ScriptWritesVariableThenGatewayBranches.bpmn +0 -59
  310. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/boundaryevent.bpmn +0 -30
  311. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/collapsed-subprocess.bpmn +0 -83
  312. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/connectable-types.bpmn +0 -85
  313. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/extensions-orchestrator-start-job.bpmn +0 -80
  314. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/multiparticipantpool.bpmn +0 -77
  315. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/nestedsubprocess.bpmn +0 -36
  316. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/simple.bpmn +0 -59
  317. package/skills/uipath-maestro-bpmn/validator/test/integration.test.mjs +0 -146
  318. package/skills/uipath-maestro-bpmn/validator/test/model-helpers.mjs +0 -42
  319. package/skills/uipath-maestro-bpmn/validator/test/ported-rule-tests.mjs +0 -983
  320. package/skills/uipath-maestro-bpmn/validator/test/run-tests.mjs +0 -530
  321. package/skills/uipath-maestro-bpmn/validator/uipath-moddle.v1.json +0 -715
  322. package/skills/uipath-maestro-bpmn/validator/validate-bpmn.mjs +0 -164
  323. package/skills/uipath-review/references/agents/agents-common-rules.md +0 -32
  324. package/skills/uipath-rpa/assets/before-after-hooks-template.md +0 -115
  325. package/skills/uipath-rpa/assets/helper-utility-template.md +0 -22
  326. package/skills/uipath-rpa/assets/testcase-template.md +0 -92
  327. package/skills/uipath-rpa/references/coded/coding-guidelines.md +0 -255
  328. package/skills/uipath-rpa/references/coded/inspect-package-guide.md +0 -80
  329. package/skills/uipath-rpa/references/coded/third-party-packages-guide.md +0 -67
  330. package/skills/uipath-rpa/references/connector-capabilities.md +0 -79
  331. package/skills/uipath-rpa/references/legacy/activity-docs/Testing.md +0 -95
  332. package/skills/uipath-rpa/references/legacy/activity-docs/UIAutomation.md +0 -159
  333. package/skills/uipath-rpa/references/legacy/common-pitfalls.md +0 -318
  334. package/skills/uipath-rpa/references/legacy/discovery-workflow.md +0 -147
  335. package/skills/uipath-rpa/references/legacy/environment-setup.md +0 -78
  336. package/skills/uipath-rpa/references/legacy/project-structure.md +0 -206
  337. package/skills/uipath-rpa/references/legacy/test-data-guide.md +0 -142
  338. package/skills/uipath-rpa/references/legacy/validation-and-fixing.md +0 -154
  339. package/skills/uipath-rpa/references/project-structure-guide.md +0 -168
  340. package/skills/uipath-rpa/references/project-structure.md +0 -135
  341. package/skills/uipath-rpa/references/publishing-guide.md +0 -80
  342. package/skills/uipath-rpa/references/validation-guide.md +0 -170
  343. package/skills/uipath-rpa/references/xaml/csharp-expression-pitfalls.md +0 -43
  344. package/skills/uipath-rpa/references/xaml/flowchart-guide.md +0 -113
  345. package/skills/uipath-rpa/references/xaml/workflow-guide.md +0 -258
@@ -1,6 +1,6 @@
1
1
  # OAuth Scopes Reference
2
2
 
3
- Required OAuth scopes for each `@uipath/uipath-typescript` SDK service and method.
3
+ Which OAuth scopes a Coded App needs, and where to look them up.
4
4
 
5
5
  Use this reference to:
6
6
  1. Determine which scopes to include in the `scope` field of `uipath.json`
@@ -8,231 +8,44 @@ Use this reference to:
8
8
 
9
9
  **Note:** Broader scopes cover granular ones (e.g., `OR.Assets` covers `OR.Assets.Read`). Use the most specific scope that satisfies the operations the app performs.
10
10
 
11
- > **Update scopes WHEN you add the feature.** Any new service call — a write op (`insertRecordById`, `updateRecordById`, `deleteRecordById`), an action-causing method (`Jobs.stop`/`resume`/`restart`, `Tasks.complete`/`assign`, `ProcessInstances.cancel`, `Exchanges.createFeedback`, etc.), or a call to a service the app hasn't used before — may need a scope broader than what the current `scope` field in `uipath.json` carries. Check the tables below before shipping the feature. The External Application registration must also allow the scope; if not, the token request is rejected entirely (see [oauth-client-setup.md](oauth-client-setup.md)).
11
+ > **Update scopes WHEN you add the feature.** Any new service call — a write op, an action-causing method (`Jobs.stop`/`resume`/`restart`, `Tasks.complete`/`assign`, `ProcessInstances.cancel`, `Exchanges.createFeedback`, etc.), or a call to a service the app hasn't used before — may need a scope broader than what the current `scope` field in `uipath.json` carries. Look up the method's scope (below) before shipping the feature. The External Application registration must also allow the scope; if not, the token request is rejected entirely (see [oauth-client-setup.md](oauth-client-setup.md)).
12
12
 
13
- ---
13
+ ## Per-method scope lookup
14
14
 
15
- ## Assets
15
+ The per-method scope table ships **inside the SDK package**. Read the installed copy — it is version-exact and offline:
16
16
 
17
- | Method | Required Scope |
18
- |--------|----------------|
19
- | `getAll()` | `OR.Assets` or `OR.Assets.Read` |
20
- | `getById()` | `OR.Assets` or `OR.Assets.Read` |
21
- | `getByName()` | `OR.Assets` or `OR.Assets.Read` |
17
+ `node_modules/@uipath/uipath-typescript/docs/oauth-scopes.md`
22
18
 
23
- ---
19
+ Required scopes can change between SDK versions, so read the installed copy rather than a CDN `@latest` that may not match the installed version. If the installed SDK predates the file, upgrade the SDK. This skill deliberately does NOT duplicate the per-method table.
24
20
 
25
- ## Jobs
21
+ What the shipped table does NOT cover (skill knowledge, below): widget scopes and the task-level bundles.
26
22
 
27
- | Method | Required Scope |
28
- |--------|----------------|
29
- | `getAll()` | `OR.Jobs` or `OR.Jobs.Read` |
30
- | `getById()` | `OR.Jobs` or `OR.Jobs.Read` |
31
- | `getOutput()` | `OR.Jobs` or `OR.Jobs.Read` **plus** `OR.Folders` or `OR.Folders.Read` (required because `getOutput` internally calls the Attachments API to resolve file-type output arguments) |
32
- | `stop()` | `OR.Jobs` |
33
- | `resume()` | `OR.Jobs` or `OR.Jobs.Write` |
34
- | `restart()` | `OR.Jobs` |
35
-
36
- ---
37
-
38
- ## Attachments
39
-
40
- | Method | Required Scope |
41
- |--------|----------------|
42
- | `getById()` | `OR.Folders` or `OR.Folders.Read` |
43
-
44
- ---
45
-
46
- ## Buckets
47
-
48
- | Method | Required Scope |
49
- |--------|----------------|
50
- | `getAll()` | `OR.Buckets` or `OR.Buckets.Read` |
51
- | `getById()` | `OR.Buckets` or `OR.Buckets.Read` |
52
- | `getByName()` | `OR.Buckets` or `OR.Buckets.Read` |
53
- | `getFiles()` | `OR.Buckets` or `OR.Buckets.Read` |
54
- | `getFileMetaData()` | `OR.Buckets` or `OR.Buckets.Read` |
55
- | `getReadUri()` | `OR.Buckets` or `OR.Buckets.Read` |
56
- | `uploadFile()` | `OR.Buckets` |
57
- | `deleteFile()` | `OR.Buckets` or `OR.Buckets.Write` |
58
-
59
- ---
60
-
61
- ## Entities (Data Fabric)
62
-
63
- | Method | Required Scope |
64
- |--------|----------------|
65
- | `getAll()` | `DataFabric.Schema.Read` |
66
- | `getById()` | `DataFabric.Schema.Read` |
67
- | `getAllRecords()` | `DataFabric.Data.Read` |
68
- | `getRecordById()` / `getRecord()` | `DataFabric.Data.Read` |
69
- | `insertRecordById()` / `insertRecord()` | `DataFabric.Data.Write` |
70
- | `insertRecordsById()` / `insertRecords()` | `DataFabric.Data.Write` |
71
- | `deleteRecordsById()` / `deleteRecords()` | `DataFabric.Data.Write` |
72
- | `deleteRecordById()` / `deleteRecord()` | `DataFabric.Data.Write` |
73
- | `updateRecordById()` / `updateRecord()` | `DataFabric.Data.Write` |
74
- | `updateRecordsById()` / `updateRecords()` | `DataFabric.Data.Write` |
75
- | `queryRecordsById()` / `queryRecords()` | `DataFabric.Data.Read` |
76
- | `downloadAttachment()` | `DataFabric.Data.Read` |
77
- | `uploadAttachment()` | `DataFabric.Data.Write` |
78
- | `deleteAttachment()` | `DataFabric.Data.Write` |
79
-
80
- ---
81
-
82
- ## ChoiceSets (Data Fabric)
83
-
84
- | Method | Required Scope |
85
- |--------|----------------|
86
- | `getAll()` | `DataFabric.Schema.Read` |
87
- | `getById()` | `DataFabric.Data.Read` |
88
-
89
- ---
90
-
91
- ## Processes
92
-
93
- | Method | Required Scope |
94
- |--------|----------------|
95
- | `getAll()` | `OR.Execution` or `OR.Execution.Read` |
96
- | `getById()` | `OR.Execution` or `OR.Execution.Read` |
97
- | `getByName()` | `OR.Execution` or `OR.Execution.Read` |
98
- | `start()` | `OR.Jobs` or `OR.Jobs.Write` |
99
-
100
- ---
101
-
102
- ## Queues
103
-
104
- | Method | Required Scope |
105
- |--------|----------------|
106
- | `getAll()` | `OR.Queues` or `OR.Queues.Read` |
107
- | `getById()` | `OR.Queues` or `OR.Queues.Read` |
108
-
109
- ---
110
-
111
- ## Tasks (Orchestrator)
112
-
113
- | Method | Required Scope |
114
- |--------|----------------|
115
- | `getAll()` | `OR.Tasks` or `OR.Tasks.Read` |
116
- | `getById()` | `OR.Tasks` or `OR.Tasks.Read` |
117
- | `getUsers()` | `OR.Tasks` or `OR.Tasks.Read` |
118
- | `create()` | `OR.Tasks` or `OR.Tasks.Write` |
119
- | `assign()` / `reassign()` / `unassign()` | `OR.Tasks` or `OR.Tasks.Write` |
120
- | `complete()` | `OR.Tasks` or `OR.Tasks.Write` |
121
-
122
- ---
123
-
124
- ## Maestro Process Instances
125
-
126
- | Method | Required Scope |
127
- |--------|----------------|
128
- | `getAll()` | `PIMS` |
129
- | `getById()` | `PIMS` |
130
- | `getExecutionHistory()` | `PIMS` |
131
- | `getBpmn()` | `OR.Execution.Read` |
132
- | `getVariables()` | `PIMS` |
133
- | `getIncidents()` | `PIMS` |
134
- | `cancel()` / `pause()` / `resume()` | `PIMS` |
135
-
136
- ## Maestro Processes
137
-
138
- | Method | Required Scope |
139
- |--------|----------------|
140
- | `getAll()` | `PIMS` |
141
- | `getIncidents()` | `PIMS` |
142
- | `getInstanceStatusTimeline()` | `Insights.RealTimeData Insights OR.Folders.Read` |
143
- | `getTopRunCount()` / `getTopFaultedCount()` / `getTopExecutionDuration()` | `Insights.RealTimeData Insights OR.Folders.Read` |
144
-
145
- ## Maestro Process Incidents (standalone)
146
-
147
- | Method | Required Scope |
148
- |--------|----------------|
149
- | `ProcessIncidents.getAll()` | `PIMS` |
150
-
151
- ---
152
-
153
- ## Cases
154
-
155
- | Method | Required Scope |
156
- |--------|----------------|
157
- | `getAll()` | `PIMS` |
158
- | `getInstanceStatusTimeline()` | `Insights.RealTimeData Insights OR.Folders.Read` |
159
- | `getTopRunCount()` / `getTopFaultedCount()` / `getTopExecutionDuration()` | `Insights.RealTimeData Insights OR.Folders.Read` |
160
-
161
- ## Case Instances
162
-
163
- | Method | Required Scope |
164
- |--------|----------------|
165
- | `getAll()` | `PIMS` and `OR.Execution.Read` |
166
- | `getById()` | `PIMS` and `OR.Execution.Read` |
167
- | `getStages()` | `PIMS` and `OR.Execution.Read` |
168
- | `close()` / `pause()` / `resume()` / `reopen()` | `PIMS` |
169
- | `getExecutionHistory()` | `PIMS` |
170
- | `getActionTasks()` | `OR.Tasks` or `OR.Tasks.Read` |
171
- | `getSlaSummary()` / `getStagesSlaSummary()` | `Insights.RealTimeData Insights OR.Folders.Read PIMS` |
172
-
173
- ---
174
-
175
- ## Conversational Agent
176
-
177
- Combined scopes required: `OR.Execution` · `OR.Folders` · `OR.Jobs` · `ConversationalAgents` · `Traces.Api`
178
-
179
- ### Agents
180
-
181
- | Method | Required Scope |
182
- |--------|----------------|
183
- | `getAll()` | `OR.Execution` or `OR.Execution.Read` |
184
- | `getById()` | `OR.Execution` or `OR.Execution.Read` |
185
-
186
- ### Conversations
187
-
188
- | Method | Required Scope |
189
- |--------|----------------|
190
- | `create()` | `OR.Execution`, `OR.Folders`, `OR.Jobs` |
191
- | `getAll()` / `getById()` | `OR.Execution.Read`, `OR.Jobs.Read` |
192
- | `updateById()` / `deleteById()` | `OR.Execution`, `OR.Jobs` |
193
- | `startSession()` | `OR.Execution`, `OR.Jobs`, `ConversationalAgents` |
194
- | `uploadAttachment()` / `getAttachmentUploadUri()` | `OR.Execution`, `OR.Jobs` |
195
-
196
- ### Exchanges
197
-
198
- | Method | Required Scope |
199
- |--------|----------------|
200
- | `getAll()` / `getById()` | `OR.Execution.Read`, `OR.Jobs.Read` |
201
- | `createFeedback()` | `OR.Execution`, `OR.Jobs`, `Traces.Api` |
202
-
203
- ### Messages
204
-
205
- | Method | Required Scope |
206
- |--------|----------------|
207
- | `getById()` / `getContentPartById()` | `OR.Execution.Read`, `OR.Jobs.Read` |
208
-
209
- ### User Settings (`conversationalAgent.user`)
210
-
211
- | Method | Required Scope |
212
- |--------|----------------|
213
- | `getSettings()` | `OR.Users` or `OR.Users.Read` |
214
- | `updateSettings()` | `OR.Users` |
215
-
216
- ---
217
-
218
- ## Agent Feedback
23
+ ## Common Scope Bundles
219
24
 
220
- | Method | Required Scope |
221
- |--------|----------------|
222
- | `getAll()` | `Traces.Api` |
223
- | `getById()` | `Traces.Api` |
224
- | `getCategories()` | `Traces.Api` |
225
- | `submit()` | `Traces.Api` |
226
- | `updateById()` | `Traces.Api` |
227
- | `deleteById()` | `Traces.Api` |
228
- | `createCategory()` | `Traces.Api` |
229
- | `deleteCategory()` | `Traces.Api` |
25
+ Task-level bundles what to put in the `uipath.json` `scope` field for a given feature set. Start here; consult the per-method table for methods outside these bundles.
230
26
 
231
- ---
27
+ | App uses... | Minimum scopes needed |
28
+ |---|---|
29
+ | Orchestrator Assets (read) | `OR.Assets.Read` (`OR.Assets` to also write asset values) |
30
+ | Orchestrator Queues (read) | `OR.Queues.Read` |
31
+ | Orchestrator Buckets (read + upload) | `OR.Buckets` (read-only browsing: `OR.Buckets.Read`) |
32
+ | Orchestrator Attachments (read) | `OR.Folders.Read` |
33
+ | Orchestrator Tasks (read + complete) | `OR.Tasks` |
34
+ | Orchestrator Processes (list + start) | `OR.Execution OR.Jobs` |
35
+ | Orchestrator Jobs (list + read output) | `OR.Jobs.Read OR.Folders.Read` (add `OR.Folders.Read` so `Jobs.getOutput()` can resolve file-type output arguments via Attachments) |
36
+ | Data Fabric (read-only) | `DataFabric.Schema.Read DataFabric.Data.Read` |
37
+ | Data Fabric (read + write) | `DataFabric.Schema.Read DataFabric.Data.Read DataFabric.Data.Write` |
38
+ | Maestro full access | `PIMS OR.Execution.Read` |
39
+ | Maestro analytics / insights dashboards (top run/fault/duration counts, status timelines, SLA) | add `Insights.RealTimeData Insights OR.Folders.Read` (SLA summaries also need `PIMS`) |
40
+ | Conversational Agent | `OR.Execution OR.Folders OR.Jobs ConversationalAgents Traces.Api` (add `OR.Users` for user-settings read/write) |
41
+ | Agent Feedback | `Traces.Api` (every method) |
42
+ | Insights RTM (Agents, Agent Traces, Agent Memory, Governance, Maestro Insights) | `Insights Insights.RealTimeData OR.Folders.Read` |
43
+ | Maestro SLA (CaseInstances SLA summary) | `Insights Insights.RealTimeData OR.Folders.Read PIMS` |
44
+ | Generic trace spans (`Traces.getById` / `getSpansByIds`) | `Traces.Api` (+ `Insights Insights.RealTimeData`) |
232
45
 
233
46
  ## Widgets
234
47
 
235
- Scopes required by `@uipath/ui-widgets-*` React components. The widget's own runtime API calls are listed here — add scopes from the sections above for any additional SDK calls the host app makes.
48
+ Scopes required by `@uipath/ui-widgets-*` React components. The widget's own runtime API calls are listed here — add scopes from the per-method table for any additional SDK calls the host app makes.
236
49
 
237
50
  ### Validation Station (`@uipath/ui-widgets-validation-station`)
238
51
 
@@ -247,60 +60,3 @@ See [widgets/validation-station.md](widgets/validation-station.md) for the full
247
60
  > - `@uipath/ui-widgets-conversational-agent-chat`
248
61
  > - `@uipath/ui-widgets-datatable`
249
62
  > - `@uipath/ui-widgets-multi-file-upload`
250
-
251
- ---
252
-
253
- ## Agents — Insights RTM (SDK ≥ 1.4.1)
254
-
255
- | Method | Required Scope |
256
- |--------|----------------|
257
- | `Agents.getAll()` / `getErrors()` | `Insights` and `Insights.RealTimeData` |
258
- | `Agents.getErrorsTimeline()` / `getConsumptionTimeline()` / `getLatencyTimeline()` | `Insights` and `Insights.RealTimeData` |
259
-
260
- ## Agent Traces (SDK ≥ 1.4.1)
261
-
262
- | Method | Required Scope |
263
- |--------|----------------|
264
- | `AgentTraces.getErrorsTimeline()` / `getLatencyTimeline()` / `getUnitConsumption()` | `Insights` and `Insights.RealTimeData` |
265
- | `AgentTraces.getSpansByTraceId()` / `getSpansByReference()` | `Insights` and `Insights.RealTimeData` |
266
- | `Traces.getById()` / `getSpansByIds()` (generic spans — governance traces) | `Traces.Api` (+ `Insights` and `Insights.RealTimeData`) |
267
-
268
- ## Agent Memory (SDK ≥ 1.4.1)
269
-
270
- | Method | Required Scope |
271
- |--------|----------------|
272
- | `AgentMemory.getTimeline()` / `getCallsTimeline()` / `getTopSpaces()` | `Insights` and `Insights.RealTimeData` |
273
-
274
- ## Governance (SDK ≥ 1.4.1)
275
-
276
- | Method | Required Scope |
277
- |--------|----------------|
278
- | `Governance.getPolicyTraces()` / `getOperationSummary()` | `Insights` and `Insights.RealTimeData` — caller needs elevated (org-admin) access; `fullOrganization: true` returns 403 without org-admin |
279
-
280
- ## Maestro Insights — RTM (SDK ≥ 1.4.x)
281
-
282
- These use the Insights RTM host (`INSIGHTS_RTM_BASE`). The SLA methods also touch PIMS-backed case data and require `PIMS` on top of the Insights scopes.
283
-
284
- | Method | Required Scope |
285
- |--------|----------------|
286
- | `Cases` / `MaestroProcesses` `.getTopRunCount()` / `getTopFaultedCount()` / `getTopExecutionDuration()` / `getTopElementFailedCount()` / `getInstanceStatusTimeline()` / `getElementStats()` | `Insights` · `Insights.RealTimeData` · `OR.Folders.Read` |
287
- | `CaseInstances.getSlaSummary()` / `getStagesSlaSummary()` | `Insights` · `Insights.RealTimeData` · `OR.Folders.Read` · **`PIMS`** |
288
-
289
- > All Insights RTM methods (Agents, Agent Traces, Agent Memory, Governance, Maestro Insights above) also require `OR.Folders.Read` — covered by the granted `OR.Folders`. `Cases.getAll` / `CaseInstances.getAll` (PIMS host, not Insights) require `PIMS` — see the Maestro sections above.
290
-
291
- ---
292
-
293
- ## Common Scope Bundles
294
-
295
- | App uses... | Minimum scopes needed |
296
- |---|---|
297
- | Data Fabric (read-only) | `DataFabric.Schema.Read DataFabric.Data.Read` |
298
- | Data Fabric (read + write) | `DataFabric.Schema.Read DataFabric.Data.Read DataFabric.Data.Write` |
299
- | Orchestrator Tasks (read + complete) | `OR.Tasks` |
300
- | Orchestrator Processes (list + start) | `OR.Execution OR.Jobs` |
301
- | Orchestrator Jobs (list + read output) | `OR.Jobs.Read OR.Folders.Read` (add `OR.Folders.Read` so `Jobs.getOutput()` can resolve file-type output arguments via Attachments) |
302
- | Maestro full access | `PIMS OR.Execution.Read` |
303
- | Maestro analytics / insights dashboards (top run/fault/duration counts, status timelines, SLA) | add `Insights.RealTimeData Insights OR.Folders.Read` (SLA summaries also need `PIMS`) |
304
- | Conversational Agent | `OR.Execution OR.Folders OR.Jobs ConversationalAgents Traces.Api` (add `OR.Users` for user-settings read/write) |
305
- | Insights RTM (Agents, Agent Traces, Agent Memory, Governance, Maestro Insights) | `Insights Insights.RealTimeData OR.Folders.Read` |
306
- | Maestro SLA (CaseInstances SLA summary) | `Insights Insights.RealTimeData OR.Folders.Read PIMS` |
@@ -1,135 +1,48 @@
1
- # Action Center Reference
1
+ # Action Center (Tasks) — Traps & Server Behavior
2
2
 
3
- ## Import
3
+ Signatures/params/examples: `dist/tasks/index.d.ts`. Per-method scopes: shipped `docs/oauth-scopes.md`. This file covers only what neither can express.
4
4
 
5
- ```typescript
6
- import { Tasks } from '@uipath/uipath-typescript/tasks';
7
- ```
8
-
9
- ## Scopes
10
-
11
- - Read: `OR.Tasks` or `OR.Tasks.Read`
12
- - Write: `OR.Tasks` or `OR.Tasks.Write`
13
-
14
- ## Types to Import
15
-
16
- ```typescript
17
- import type {
18
- TaskGetResponse,
19
- RawTaskGetResponse,
20
- TaskCreateResponse,
21
- RawTaskCreateResponse,
22
- TaskMethods,
23
- TaskCreateOptions,
24
- TaskGetAllOptions,
25
- TaskGetByIdOptions,
26
- TaskGetUsersOptions,
27
- TaskAssignOptions,
28
- TaskAssignmentOptions,
29
- TaskAssignmentResponse,
30
- TaskCompleteOptions,
31
- TaskCompletionOptions,
32
- UserLoginInfo,
33
- TaskSlaDetail,
34
- TaskAssignment,
35
- TaskActivity,
36
- Tag,
37
- TaskSource,
38
- } from '@uipath/uipath-typescript/tasks';
39
- ```
40
-
41
- ## Enums
42
-
43
- ```typescript
44
- import {
45
- TaskType, // Form, External, App, DocumentValidation, DocumentClassification, DataLabeling
46
- TaskPriority, // Low, Medium, High, Critical
47
- TaskStatus, // Unassigned, Pending, Completed
48
- TaskSlaStatus, // OverdueLater, OverdueSoon, Overdue, CompletedInTime
49
- TaskSlaCriteria, // TaskCreated, TaskAssigned, TaskCompleted
50
- TaskActivityType, // Created, Assigned, Reassigned, Unassigned, Saved, Forwarded, Completed, Commented, Deleted, BulkSaved, BulkCompleted, FirstOpened
51
- TaskSourceName, // Agent, Workflow, Maestro, Default
52
- } from '@uipath/uipath-typescript/tasks';
53
- ```
5
+ ## Traps
54
6
 
55
- `TaskType` string values:
7
+ ### `create()` only makes External tasks
56
8
 
57
- | Member | API string | Notes |
58
- |--------|------------|-------|
59
- | `TaskType.Form` | `'FormTask'` | Renders a UiPath form layout |
60
- | `TaskType.External` | `'ExternalTask'` | Externally managed task |
61
- | `TaskType.App` | `'AppTask'` | Powered by a UiPath App |
62
- | `TaskType.DocumentValidation` | `'DocumentValidationTask'` | DU validation — owned by the Validation Station widget. See [../widgets/validation-station.md](../widgets/validation-station.md) |
63
- | `TaskType.DocumentClassification` | `'DocumentClassificationTask'` | DU classification task |
64
- | `TaskType.DataLabeling` | `'DataLabelingTask'` | Training-data annotation task |
9
+ The server accepts only `TaskType.External` from `create()`. Form and App tasks are created by the system through workflows.
65
10
 
66
- ## Tasks Service
11
+ ### Form task hydration
67
12
 
68
- ### create(options: TaskCreateOptions, folderId: number)
13
+ When `getById` hits the Form-specific endpoint (`taskType: TaskType.Form`), the SDK silently adds `expandOnFormLayout: true` so `formLayout` is populated — you don't pass it yourself.
69
14
 
70
- Returns `Promise<TaskCreateResponse>` (task data with attached methods). Options: `{ title: string, data?: Record<string, unknown>, priority?: TaskPriority }`. The `folderId` is required.
15
+ ### OData filtering server-side field names
71
16
 
72
- **Note:** `create()` only supports creating External tasks (`TaskType.External`). Form tasks and App tasks are created by the system through workflows.
73
-
74
- ### getAll(options?: TaskGetAllOptions)
75
-
76
- Returns `NonPaginatedResponse<TaskGetResponse>` or `PaginatedResponse<TaskGetResponse>`. Options extend `RequestOptions & PaginationOptions & { folderId?: number, asTaskAdmin?: boolean }`. Supports `filter`, `orderby`, `expand`, `select`, pagination.
77
-
78
- ### getById(id: number, options?: TaskGetByIdOptions, folderId?: number)
79
-
80
- Returns `Promise<TaskGetResponse>` with attached methods.
81
-
82
- `TaskGetByIdOptions.taskType` is an optimization. Without it, the SDK issues a generic GET, inspects `type`, then issues a second type-specific GET. With it, the SDK skips the discovery call and goes straight to the type-specific endpoint — **`folderId` then becomes required** (throws `ValidationError` otherwise). Use for any non-`External` task when you already know the type:
83
-
84
- ```typescript
85
- // Faster — single round-trip. Required pattern for Validation Station hydration.
86
- const dvTask = await tasks.getById(taskId, { taskType: TaskType.DocumentValidation }, folderId);
87
- ```
88
-
89
- For `TaskType.Form`, the SDK auto-adds `expandOnFormLayout: true` so `formLayout` is populated.
90
-
91
- `TaskGetResponse` key fields: `id`, `title`, `status`, `type`, `priority`, `folderId`, `key`, `data`, `isDeleted`, `isCompleted`, `createdTime`, `assignedToUser`, `formLayout` (form tasks), `taskAssignments`, `activities`, `tags`, `taskSource`, `parentOperationId`, `externalTag`.
92
-
93
- **OData filtering:** `TaskGetAllOptions` supports `filter` (OData `$filter` string) and `orderby` for server-side filtering and sorting. Examples:
17
+ `filter` / `orderby` take raw server-side field names (not derivable from the `filter?: string` type):
94
18
  - Pending tasks only: `filter: "Status ne 'Completed'"`
95
19
  - By external tag: `filter: "ExternalTag eq 'some-value'"`
96
20
  - Combined: `filter: "Status ne 'Completed' and ExternalTag eq 'some-value'"`
97
21
 
98
- ### getUsers(folderId: number, options?: TaskGetUsersOptions)
99
-
100
- Returns `NonPaginatedResponse<UserLoginInfo>` or `PaginatedResponse<UserLoginInfo>`. Each user has: `name`, `surname`, `userName`, `emailAddress`, `displayName`, `id`.
22
+ ### Completing tasks
101
23
 
102
- ### assign(options: TaskAssignmentOptions | TaskAssignmentOptions[])
24
+ When you already hold a `TaskGetResponse`, use the task-attached `task.complete(...)` over the service `tasks.complete(...)` — no `taskId` / `folderId` to thread through.
103
25
 
104
- Returns `Promise<OperationResponse<TaskAssignmentOptions[] | TaskAssignmentResponse[]>>`. Each assignment requires `taskId` and either `userId` or `userNameOrEmail`.
26
+ **`TaskCompleteOptions` is a discriminated union on `type` NEVER use conditional spread.** TypeScript cannot narrow the union through `...(condition ? { data: {} } : {})` (TS2345). Always branch explicitly:
105
27
 
106
- ### reassign(options: TaskAssignmentOptions | TaskAssignmentOptions[])
107
-
108
- Same signature as assign. Reassigns tasks to new users.
109
-
110
- ### unassign(taskId: number | number[])
111
-
112
- Returns `Promise<OperationResponse<{ taskId: number }[] | TaskAssignmentResponse[]>>`. Accepts single ID or array.
113
-
114
- ### complete(options: TaskCompletionOptions, folderId: number)
115
-
116
- Returns `Promise<OperationResponse<TaskCompletionOptions>>`. The `folderId` is required.
117
-
118
- `TaskCompletionOptions` is a discriminated union on `type`:
119
- - `External`, `DocumentValidation`, `DocumentClassification`, `DataLabeling`: `{ type, taskId, data?, action? }` — both `data` and `action` optional. Routes to the generic complete endpoint.
120
- - `Form`: `{ type: TaskType.Form, taskId, data, action }` — both required. Routes to the form-task endpoint.
121
- - `App`: `{ type: TaskType.App, taskId, data, action }` — both required. Routes to the app-task endpoint.
28
+ ```typescript
29
+ const handleTaskAction = async (task: TaskGetResponse, action: 'approve' | 'reject') => {
30
+ const actionLabel = action === 'approve' ? 'Approve' : 'Reject';
122
31
 
123
- ## Task-Attached Methods (TaskMethods)
32
+ if (task.type === TaskType.External) {
33
+ await task.complete({ type: TaskType.External, action: actionLabel });
34
+ } else {
35
+ // Form and App tasks require data and action
36
+ await task.complete({ type: task.type, action: actionLabel, data: {} });
37
+ }
38
+ };
39
+ ```
124
40
 
125
- Returned by `getAll()`, `getById()`, and `create()` on each task:
41
+ ### Action strings
126
42
 
127
- - `task.assign(options: TaskAssignOptions)` -> requires `{ userId }` or `{ userNameOrEmail }`
128
- - `task.reassign(options: TaskAssignOptions)` -> same options as assign
129
- - `task.unassign()` -> no arguments needed, uses the task's own ID
130
- - `task.complete(options: TaskCompleteOptions)` -> `{ type, data?, action? }` (no taskId needed, uses own ID)
43
+ `action` is free-form and must match what the workflow designer configured. If `task.action` is set, that's the expected string. Common patterns: `'Approve'` / `'Reject'`, `'Submit'`. Maestro HITL tasks are typically `TaskType.App` or `TaskType.External`; pass `data: {}` for App tasks with no form data.
131
44
 
132
- `TaskAssignOptions` type: `{ userId: number } | { userNameOrEmail: string }` (mutually exclusive).
45
+ For `TaskType.DocumentValidation`, the Validation Station widget owns the data contract — call `task.complete({ type: TaskType.DocumentValidation, action: 'Completed' })` from `onSaveComplete`. Do NOT pass `data` yourself; the widget already uploaded the validated payload to the bucket before firing the callback. See [../widgets/validation-station.md](../widgets/validation-station.md).
133
46
 
134
47
  ## Linking Tasks to Maestro Process Instances
135
48
 
@@ -155,92 +68,6 @@ const pendingTask = result.items.find(t => !t.isCompleted) ?? null;
155
68
 
156
69
  **IMPORTANT:** There is NO shortcut from `latestRunStatus` — a process waiting on HITL still shows as `"Running"`. Always use `getVariables()` + `getBpmn()` to detect HITL first, then use the `CreatorJobKey` filter to get the task details.
157
70
 
158
- ## Completing Tasks — Detailed Patterns
159
-
160
- ### Prefer task-attached `complete()` over service `complete()`
161
-
162
- When you already have a `TaskGetResponse` from `getAll()` or `getById()`, **always use the task-attached method** — it's simpler because it doesn't need `taskId` or `folderId`:
163
-
164
- ```typescript
165
- // PREFERRED — task-attached method (no taskId, no folderId needed)
166
- await task.complete({ type: task.type as TaskType, action: 'Approve', data: {} });
167
-
168
- // AVOID — service method (requires both taskId and folderId)
169
- await tasks.complete({ type: TaskType.External, taskId: task.id, action: 'Approve' }, folderId);
170
- ```
171
-
172
- ### Task type discrimination — use the enum, don't compare strings
173
-
174
- The `task.type` field on `TaskGetResponse` is a `TaskType` enum value. **Always use the enum for comparison and when passing to `complete()`:**
175
-
176
- ```typescript
177
- import { TaskType } from '@uipath/uipath-typescript/tasks';
178
-
179
- // CORRECT — use the enum directly from the task
180
- await task.complete({
181
- type: task.type as TaskType, // Already a TaskType value
182
- action: actionLabel,
183
- data: task.type === TaskType.External ? undefined : {},
184
- });
185
-
186
- // WRONG — comparing against string literals
187
- if (task.type === 'FormTask') { ... } // Don't do this
188
- ```
189
-
190
- ### `TaskCompleteOptions` discriminated union
191
-
192
- The `type` field determines which other fields are required:
193
-
194
- | Task Type | `data` | `action` | Example |
195
- |-----------|--------|----------|---------|
196
- | `TaskType.External` | Optional | Optional | `{ type: TaskType.External, action: 'Approve' }` |
197
- | `TaskType.DocumentValidation` | Optional | Optional | `{ type: TaskType.DocumentValidation, action: 'Completed' }` |
198
- | `TaskType.DocumentClassification` | Optional | Optional | `{ type: TaskType.DocumentClassification, action: 'Completed' }` |
199
- | `TaskType.DataLabeling` | Optional | Optional | `{ type: TaskType.DataLabeling, action: 'Completed' }` |
200
- | `TaskType.Form` | **Required** | **Required** | `{ type: TaskType.Form, action: 'Submit', data: formData }` |
201
- | `TaskType.App` | **Required** | **Required** | `{ type: TaskType.App, action: 'Approve', data: {} }` |
202
-
203
- For Maestro HITL tasks (approve/reject flows), tasks are typically `TaskType.App` or `TaskType.External`. Pass `data: {}` (empty object) for App tasks when there's no form data to submit.
204
-
205
- For `TaskType.DocumentValidation`, the Validation Station widget owns the data contract — call `task.complete({ type: TaskType.DocumentValidation, action: 'Completed' })` from `onSaveComplete`. Do NOT pass `data` yourself; the widget already uploaded the validated payload to the bucket before firing the callback. See [../widgets/validation-station.md](../widgets/validation-station.md).
206
-
207
- ### Action strings
208
-
209
- The `action` parameter is a free-form string that maps to the workflow's expected action. Common patterns:
210
- - **Approve/Reject**: `action: 'Approve'` or `action: 'Reject'`
211
- - **Submit**: `action: 'Submit'`
212
- - **Custom**: whatever the workflow designer configured
213
-
214
- If the task has an `action` field set (`task.action`), that's the expected action string. For tasks with multiple possible actions (approve/reject), pass the action corresponding to the user's choice.
215
-
216
- ### Complete pattern for HITL approve/reject
217
-
218
- **IMPORTANT:** `TaskCompleteOptions` is a discriminated union on `type`. TypeScript cannot narrow the union when you use conditional spreads like `...(condition ? { data: {} } : {})`. **Always use explicit if/else branching:**
219
-
220
- ```typescript
221
- const handleTaskAction = async (task: TaskGetResponse, action: 'approve' | 'reject') => {
222
- const actionLabel = action === 'approve' ? 'Approve' : 'Reject';
223
-
224
- // Branch by type — TypeScript narrows the discriminated union correctly
225
- if (task.type === TaskType.External) {
226
- await task.complete({ type: TaskType.External, action: actionLabel });
227
- } else {
228
- // Form and App tasks require data and action
229
- await task.complete({ type: task.type, action: actionLabel, data: {} });
230
- }
231
- };
232
- ```
233
-
234
- **NEVER use conditional spread for discriminated unions:**
235
- ```typescript
236
- // WRONG — TS2345: TypeScript can't narrow the union through a spread
237
- await task.complete({
238
- type: task.type as TaskType,
239
- action: actionLabel,
240
- ...(task.type !== TaskType.External ? { data: {} } : {}), // Breaks type narrowing
241
- });
242
- ```
243
-
244
71
  ### If no task is found — show an error, don't widen the search
245
72
 
246
73
  **NEVER fall back to "pick the first pending task" or "pick any Maestro task" if the `CreatorJobKey` filter returns no results.** This risks completing the wrong task. Instead:
@@ -258,47 +85,3 @@ if (!pendingTask) {
258
85
  return;
259
86
  }
260
87
  ```
261
-
262
- ## Usage Example
263
-
264
- ```typescript
265
- import { useMemo, useEffect, useState } from 'react';
266
- import { useAuth } from '../hooks/useAuth';
267
- import { Tasks } from '@uipath/uipath-typescript/tasks';
268
- import { TaskType, TaskPriority } from '@uipath/uipath-typescript/tasks';
269
- import type { TaskGetResponse } from '@uipath/uipath-typescript/tasks';
270
-
271
- function TaskInbox({ folderId }: { folderId: number }) {
272
- const { sdk } = useAuth();
273
- const tasks = useMemo(() => new Tasks(sdk), [sdk]);
274
- const [taskList, setTaskList] = useState<TaskGetResponse[]>([]);
275
-
276
- useEffect(() => {
277
- const load = async () => {
278
- const result = await tasks.getAll({ folderId, pageSize: 20 });
279
- setTaskList(result.items);
280
- };
281
- load();
282
- }, [tasks, folderId]);
283
-
284
- // Use task-attached complete — no taskId or folderId needed
285
- const handleComplete = async (task: TaskGetResponse, action: string) => {
286
- if (task.type === TaskType.External) {
287
- await task.complete({ type: TaskType.External, action });
288
- } else {
289
- await task.complete({ type: task.type, action, data: {} });
290
- }
291
- };
292
-
293
- const handleAssign = async (task: TaskGetResponse, userId: number) => {
294
- await task.assign({ userId });
295
- };
296
-
297
- const handleCreate = async () => {
298
- const newTask = await tasks.create({
299
- title: 'Review document',
300
- priority: TaskPriority.Medium,
301
- }, folderId);
302
- };
303
- }
304
- ```