build: ship docs/oauth-scopes.md in the npm package [PLT-107543]#605
Merged
Conversation
ninja-shreyash
requested review from
Raina451,
swati354 and
vnaren23
as code owners
July 15, 2026 13:56
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
vnaren23
approved these changes
Jul 16, 2026
swati354
approved these changes
Jul 16, 2026
OAuth scopes are enforced server-side and appear nowhere in the shipped types — code with missing scopes compiles cleanly and 403s at runtime. Shipping the per-method scope table with the package gives developers, IDEs, and coding agents a version-exact scope reference at node_modules/@uipath/uipath-typescript/docs/oauth-scopes.md, next to the .d.ts they already read. Verified via npm pack --dry-run (+10.2kB). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
ninja-shreyash
force-pushed
the
build/ship-oauth-scopes-in-package
branch
from
July 16, 2026 10:12
f92cb8b to
d64c262
Compare
ninja-shreyash
changed the title
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Ships
docs/oauth-scopes.mdinside the npm package by adding it to thefilesfield inpackage.json. One line, no code change.Why
OAuth scopes are enforced server-side and appear nowhere in the shipped TypeScript types. Code that requests the wrong scopes compiles cleanly and then fails at runtime with a 401/403. Today the per-method scope reference (
docs/oauth-scopes.md) exists in the repo but is not part of the published package, so consumers of the installed SDK (developers, IDEs, and AI coding agents) have no version-exact scope reference on disk. They have to know the GitHub URL and fetch it separately.Adding the file to the package gives every install a scope reference that matches the installed version exactly, sitting right next to the
.d.tsthat developers already read atnode_modules/@uipath/uipath-typescript/.Impact
npm pack --dry-run.Context
This unblocks a companion change in the uipath/skills repo (PR #1907), which slims the coded-apps skill's hand-maintained SDK docs and instead routes agents to the installed package. Per-method scopes are the one piece the package does not ship today; this closes that gap.