Skip to content

fix(apollo-vertex)!: declare vs-core and react-db as peers, move Proteus to a subpath - #1409

Open
ruudandriessen wants to merge 7 commits into
mainfrom
fix/apollo-vertex-declare-optional-peers
Open

ruudandriessen wants to merge 7 commits into
mainfrom
fix/apollo-vertex-declare-optional-peers

Conversation

@ruudandriessen

Copy link
Copy Markdown
Collaborator

Why

@tanstack/react-db, @uipath/vs-core and @uipath/proteus-client were declared only in peerDependenciesMeta, yet the root barrel imports all three. An app that imports only Button could still fail to resolve them, for example in Vite dev. check-dist.mjs treated a meta-only entry as declared, so CI didn't catch it.

@uipath/vs-core is now on public npm (4.5.1), so it and react-db can be normal peers. @uipath/proteus-client still isn't public, so it gets a workaround.

What

  • @tanstack/react-db (^0.1.83) and @uipath/vs-core (^4.4.0) are now peerDependencies, and also dev dependencies. Their type stubs in types/optional-deps.d.ts are gone, so the package builds against the real types.
  • createProteusProvider, FlagMapping and ProteusFeatureFlagValues move to a new @uipath/apollo-vertex/proteus subpath. @uipath/proteus-client stays an optional peer (meta only), and the root entry no longer reaches it.
  • check-dist.mjs: the root entry may import only dependencies and peerDependencies. Meta-only peers are allowed only from subpaths.
  • Fixes required by the real types:
    • useGroupId and useGroupMembers passed a row type to useLiveQuery, which the real API doesn't accept. The collections are now inferred.
    • vs-core types solutionTests from the app's registered entities, which this package can't see. A new getSolutionTestCollection helper looks a collection up by name.
  • The dev dependencies are pinned to a matching set: react-db 0.1.83, query-db-collection 1.0.36 and db 0.6.5. Each TanStack DB package pins an exact @tanstack/db, and with open ranges pnpm picked two copies whose collections don't work together. The README, docs and setup skill now tell consumers to match these versions.
  • README, docs pages (getting started, feature flags, solution tests), the setup skill and knip.jsonc are updated.

Breaking

createProteusProvider and its types are no longer exported from the root. Import them from @uipath/apollo-vertex/proteus.

Verification

All of these pass locally against the published @uipath/vs-core@4.5.1: package and docs-app typecheck, lint, vitest (46 tests), build including check-dist, knip and format:check. check-dist fails as expected (.: imports undeclared package @uipath/vs-core) when vs-core is put back as a meta-only peer. I haven't run a build in a separate consumer app.

…eus to a subpath

BREAKING CHANGE: import createProteusProvider from @uipath/apollo-vertex/proteus.
Copilot AI balanced review requested due to automatic review settings October 19, 2026 11:39
@ruudandriessen
ruudandriessen requested a review from a team as a code owner October 19, 2026 11:39
@github-actions
github-actions Bot temporarily deployed to preview/apollo-vertex October 19, 2026 11:40 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-design October 19, 2026 11:40 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-landing October 19, 2026 11:40 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-docs October 19, 2026 11:40 Destroyed
@github-actions github-actions Bot added the size:L 100-499 changed lines. label Oct 19, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Dependency License Review

  • ✅ 1957 package(s) scanned
  • ✅ No license issues found
  • ⚠️ 2 package(s) excluded (see details below)
License distribution
License Packages
MIT 1721
ISC 91
Apache-2.0 57
BSD-3-Clause 28
BSD-2-Clause 23
BlueOak-1.0.0 8
MPL-2.0 4
CC0-1.0 4
MIT-0 3
MIT OR Apache-2.0 2
(MIT OR Apache-2.0) 2
Unlicense 2
LGPL-3.0-or-later 1
Python-2.0 1
CC-BY-4.0 1
(MPL-2.0 OR Apache-2.0) 1
Unknown 1
Artistic-2.0 1
(WTFPL OR MIT) 1
(BSD-2-Clause OR MIT OR Apache-2.0) 1
CC-BY-3.0 1
0BSD 1
(MIT OR CC0-1.0) 1
MIT AND ISC 1
Excluded packages
Package Version License Reason
@img/sharp-libvips-linux-x64 1.3.4 LGPL-3.0-or-later LGPL pre-built binary, not linked
khroma 2.1.0 Unknown MIT per GitHub repo, missing license field in package.json

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The breaking export relocation and changed peer dependency graph need isolated consumer validation before approval.

2 open issues
1 file not reviewed
  • pnpm-lock.yaml: Generated file
What changed in this PR

This PR corrects Apollo Vertex’s peer declarations and isolates the private Proteus adapter from root imports.

Changes:

  • Moves Proteus exports to /proteus.
  • Replaces dependency stubs with real types and updates collection access.
  • Tightens distribution checks and updates setup documentation.
File Description
pnpm-lock.yaml Records new dependency resolutions.
packages/​apollo-vertex/​types/​optional-deps.d.ts Removes React DB and vs-core stubs.
packages/​apollo-vertex/​skills/​setup/​SKILL.md Updates peer installation guidance.
packages/​apollo-vertex/​scripts/​check-dist.mjs Rejects meta-only root dependencies.
packages/​apollo-vertex/​registry/​solution-tests/​use-solution-tests.ts Uses the collection lookup helper.
packages/​apollo-vertex/​registry/​solution-tests/​use-solution-test-collection.ts Adds typed collection lookup.
packages/​apollo-vertex/​registry/​shell/​use-group-members.ts Infers query types.
packages/​apollo-vertex/​registry/​shell/​use-group-id.ts Infers query types.
packages/​apollo-vertex/​README.md Documents peers and Proteus imports.
packages/​apollo-vertex/​package.json Declares peers and Proteus subpath.
packages/​apollo-vertex/​entries/​proteus.ts Exports the isolated adapter.
packages/​apollo-vertex/​entries/​index.ts Removes root Proteus exports.
knip.jsonc Narrows ignored dependencies.
apps/​apollo-vertex/​content/​docs/​templates/​solution-tests.mdx Updates React DB installation guidance.
apps/​apollo-vertex/​content/​docs/​getting-started.mdx Revises peer setup instructions.
apps/​apollo-vertex/​content/​docs/​components/​feature-flags.mdx Uses Proteus subpath imports.

Review effort: Balanced

Comment thread apps/apollo-vertex/content/docs/templates/solution-tests.mdx
Comment thread pnpm-lock.yaml Outdated
Copilot AI balanced review requested due to automatic review settings October 19, 2026 11:44
@github-actions

github-actions Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

📊 Coverage + size by package

Per-package coverage and bundle size on this PR. New-line coverage = of the source lines this PR adds or changes, the % hit by tests.

Package Coverage New-line coverage Packed (gzip) Unpacked vs main
@uipath/apollo-core — — 42.02 MB 50.17 MB ±0
@uipath/apollo-react — — 7.99 MB 31.45 MB ±0
@uipath/apollo-ui-icons — — 2.86 MB 6.97 MB ±0
@uipath/apollo-vertex 71.2% — (39 untracked) 330.3 KB 1.86 MB +286 B
@uipath/apollo-wind — — 785.2 KB 4.55 MB ±0
@uipath/ap-chat — — 40.37 MB 45.58 MB ±0

"Coverage" is each package's own coverage.include scope (e.g. apollo-core instruments only scripts/). "Packed"/"Unpacked" come from npm pack --dry-run and only cover built packages — "—" means not measured this run (package not affected / not built). "vs main" is the packed (gzipped) delta against the last successful main build (the package-sizes artifact from the Release workflow); "—" there means no main baseline was available this run. The baseline is main's latest build, not this PR's exact merge-base, so it includes any drift since the branch diverged. Packages with no vitest config are omitted.

@github-actions
github-actions Bot temporarily deployed to preview/apollo-design October 19, 2026 11:45 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-docs October 19, 2026 11:45 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-landing October 19, 2026 11:45 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-vertex October 19, 2026 11:45 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-docs October 19, 2026 11:47 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-vertex October 19, 2026 11:47 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-landing October 19, 2026 11:47 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-design October 19, 2026 11:47 Destroyed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The breaking export migration and newly required peer dependency graph still need validation in an independent consumer build.

1 open issue
2 resolved since last review
1 file not reviewed
  • pnpm-lock.yaml: Generated file

Review effort: Balanced

Comment thread apps/apollo-vertex/content/docs/getting-started.mdx
Copilot AI balanced review requested due to automatic review settings October 19, 2026 11:47
@github-actions

github-actions Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Storybook visual diff

✅ No stories are affected by this PR's changes; nothing to compare. Logs

Updated (PT): Oct 19, 2026, 06:03:52 AM

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The breaking export migration and newly required peer dependencies still need standalone consumer validation and human review.

1 open issue
1 file not reviewed
  • pnpm-lock.yaml: Generated file

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 19, 2026 12:29
@github-actions github-actions Bot added the ci label Oct 19, 2026
@github-actions
github-actions Bot temporarily deployed to preview/apollo-docs October 19, 2026 12:29 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-design October 19, 2026 12:29 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-vertex October 19, 2026 12:29 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-landing October 19, 2026 12:29 Destroyed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The breaking export migration and coupled peer dependencies still need validation in a clean consumer app before maintainer approval.

No open issues 🎉

1 resolved since last review
1 file not reviewed
  • pnpm-lock.yaml: Generated file

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings October 19, 2026 12:43
@github-actions
github-actions Bot temporarily deployed to preview/apollo-docs October 19, 2026 12:44 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-design October 19, 2026 12:44 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-landing October 19, 2026 12:44 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-vertex October 19, 2026 12:44 Destroyed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Registry validation replaces the shipped React DB constraint with an excluded version, leaving consumer compatibility unvalidated.

1 open issue
1 file not reviewed
  • pnpm-lock.yaml: Generated file

Review effort: Balanced

Comment thread .github/scripts/test-registry/test-registry.ts

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The breaking export and dependency changes still need verification in a separate consumer application.

No open issues 🎉

1 resolved since last review
1 file not reviewed
  • pnpm-lock.yaml: Generated file

Review effort: Balanced

This branch was successfully deployed

4 active deployments
preview/apollo-design — 82bd1b8d Deployed Oct 19, 2026 by github-actions[bot]
preview/apollo-docs — 82bd1b8d Deployed Oct 19, 2026 by github-actions[bot]
preview/apollo-vertex — 82bd1b8d Deployed Oct 19, 2026 by github-actions[bot]
preview/apollo-landing — 82bd1b8d Deployed Oct 19, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

app:apollo-vertex ci size:L 100-499 changed lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants