Bump agents-ui, add example for authed users in widget#2903
Bump agents-ui, add example for authed users in widget#2903sarah-inkeep merged 8 commits intomainfrom
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
TL;DR — Bumps Key changes
Summary | 5 files | 7 commits | base: Authenticated widget usage examples
The React example imports
|
There was a problem hiding this comment.
Clean PR. The @inkeep/agents-ui bump to ^0.15.23 is consistent across all three consumers (agents-docs, agents-manage-ui, agents-ui-demo), and the new getAuthToken code examples in the auth docs are correct — matching both the existing InkeepBaseSettings type interface and the pattern already used in agents-manage-ui/src/components/agent/playground/chat-widget.tsx. Lockfile changes are mechanical.
Claude Opus | 𝕏
There was a problem hiding this comment.
PR Review Summary
(3) Total Issues | Risk: Low
🟠⚠️ Major (1) 🟠⚠️
Inline Comments:
- 🟠 Major:
app-credentials.mdx:93-96Configuration structure differs from existing patterns —appIdinbaseSettingsvsaiChatSettings
🟡 Minor (2) 🟡
Inline Comments:
- 🟡 Minor:
app-credentials.mdx:94Placeholder'your_app_id'should be uppercase'YOUR_APP_ID' - 🟡 Minor:
app-credentials.mdx:111Same placeholder casing issue
💭 Consider (1) 💭
💭 1) agents-manage-ui/package.json Missing changeset for dependency bump
Issue: The @inkeep/agents-ui dependency bump from ^0.15.21 to ^0.15.23 in agents-manage-ui doesn't have an accompanying changeset.
Why: Per AGENTS.md, dependency updates that may include bug fixes or new features affecting runtime behavior should have a changeset. The changeset-bot flagged this PR has no changesets.
Fix: If the agents-ui update includes user-facing changes, consider adding: pnpm bump patch --pkg agents-manage-ui "Update @inkeep/agents-ui to 0.15.23". If this is purely a transitive dependency sync with no user-facing changes, this can be skipped.
💡 APPROVE WITH SUGGESTIONS
Summary: Good enhancement adding code examples for authenticated widget usage. The main thing to verify is whether the appId placement in baseSettings (vs aiChatSettings) is intentional for the getAuthToken use case or should align with existing patterns. The placeholder casing fixes are quick 1-click applies. 🎉
Discarded (1)
| Location | Issue | Reason Discarded |
|---|---|---|
app-credentials.mdx:82-98 |
React example imports from @inkeep/agents-ui but embedded-chat.mdx uses @inkeep/agents-ui-cloud |
After investigation, the manage-ui code generator templates at snippets/react-component.ts also use @inkeep/agents-ui, so this is consistent with internal patterns for authenticated sessions. The public docs use the cloud wrapper for simplicity but direct package usage is valid. |
Reviewers (3)
| Reviewer | Returned | Main Findings | Consider | While You're Here | Inline Comments | Pending Recs | Discarded |
|---|---|---|---|---|---|---|---|
pr-review-docs |
3 | 0 | 0 | 0 | 3 | 0 | 1 |
pr-review-devops |
2 | 0 | 1 | 0 | 0 | 0 | 0 |
pr-review-standards |
0 | 0 | 0 | 0 | 0 | 0 | 0 |
| Total | 5 | 0 | 1 | 0 | 3 | 0 | 1 |
|
|
||
| export function AuthenticatedChat() { | ||
| const baseSettings: InkeepBaseSettings = { | ||
| appId: 'your_app_id', |
There was a problem hiding this comment.
🟡 Minor Placeholder uses lowercase, inconsistent with existing examples
Issue: The placeholder 'your_app_id' uses lowercase snake_case.
Why: Existing examples in this docs section use 'YOUR_APP_ID' (uppercase) which is the conventional style for placeholder values that users need to replace.
Fix: (1-click apply)
| appId: 'your_app_id', | |
| appId: 'YOUR_APP_ID', |
Refs:
|
|
||
| Inkeep.EmbeddedChat('#chat-target', { | ||
| baseSettings: { | ||
| appId: 'your_app_id', |
There was a problem hiding this comment.
🟡 Minor Placeholder uses lowercase, inconsistent with existing examples
Issue: Same as above — the placeholder 'your_app_id' should be uppercase.
Fix: (1-click apply)
| appId: 'your_app_id', | |
| appId: 'YOUR_APP_ID', |
There was a problem hiding this comment.
PR Review Summary
(1) Total Issues | Risk: Medium
🟠⚠️ Major (1) 🟠⚠️
Inline Comments:
- 🟠 Major:
app-credentials.mdx:99aiChatSettingsdefined but never passed toInkeepEmbeddedChat
🕐 Pending Recommendations (1)
- 💭
agents-manage-ui/package.jsonMissing changeset for dependency bump (still applicable if agents-ui update includes user-facing changes)
🚫 REQUEST CHANGES
Summary: The fixes from the previous review (appId placement, placeholder casing, import path) were all addressed — nice work! 🎉 However, the fix introduced a new bug: the React example defines aiChatSettings but never passes it to the component, so the appId would be silently ignored. This is a quick 1-click fix in the inline comment. Once that's applied, this should be good to go!
Reviewers (1)
| Reviewer | Returned | Main Findings | Consider | While You're Here | Inline Comments | Pending Recs | Discarded |
|---|---|---|---|---|---|---|---|
orchestrator |
1 | 0 | 0 | 0 | 1 | 0 | 0 |
| Total | 1 | 0 | 0 | 0 | 1 | 0 | 0 |
Note: Re-review scoped to delta — only 1 file changed since last review. Prior issues (appId placement, placeholder casing, import path) were all addressed.
| getAuthToken, | ||
| }; | ||
|
|
||
| return <InkeepEmbeddedChat baseSettings={baseSettings} />; |
There was a problem hiding this comment.
🟠 MAJOR aiChatSettings defined but never passed to component
Issue: The aiChatSettings object containing appId is defined on lines 92-94 but never passed to InkeepEmbeddedChat. The component only receives baseSettings.
Why: This example won't work as written — the appId configuration will be silently ignored, and users following this documentation will get errors or unexpected behavior.
Fix: (1-click apply)
| return <InkeepEmbeddedChat baseSettings={baseSettings} />; | |
| return <InkeepEmbeddedChat baseSettings={baseSettings} aiChatSettings={aiChatSettings} />; |
Refs:
- chat-widget.tsx:153-300 — existing pattern passing both props
- embedded-chat.mdx:44 — uses spread
{...embeddedChatProps}which includes both
There was a problem hiding this comment.
PR Review Summary
(0) Total Issues | Risk: Low
All previous issues have been addressed:
- ✅
aiChatSettingsis now passed toInkeepEmbeddedChat(commit77739ec1f) - ✅ Props reordered for consistency between React and JavaScript examples (commit
cc7c9b9c5)
🕐 Pending Recommendations (1)
- 💭
agents-manage-ui/package.jsonMissing changeset for dependency bump — still applicable if the@inkeep/agents-uiupdate includes user-facing changes. Consider:pnpm bump patch --pkg agents-manage-ui "Update @inkeep/agents-ui to 0.15.23"
✅ APPROVE
Summary: Great work addressing all the feedback from previous reviews! The React example now correctly passes both baseSettings and aiChatSettings to the component, and the prop ordering is consistent between the React and JavaScript examples. This PR is ready to ship — the changeset is a minor consideration if the agents-ui update has user-facing implications. 🚀
Reviewers (1)
| Reviewer | Returned | Main Findings | Consider | While You're Here | Inline Comments | Pending Recs | Discarded |
|---|---|---|---|---|---|---|---|
orchestrator |
0 | 0 | 0 | 0 | 0 | 1 | 0 |
| Total | 0 | 0 | 0 | 0 | 0 | 1 | 0 |
Note: Re-review scoped to delta — 2 commits since last review. All prior issues addressed.
There was a problem hiding this comment.
PR Review Summary
(0) Total Issues | Risk: Low
Re-review Scope
This re-review is scoped to the delta since the last automated review (commit cc7c9b9c5). The delta consists of:
- Merge from main (commit
0a05c426): Brought in CI workflow improvements and version releases - No changes to PR content: The documentation (
app-credentials.mdx) and dependency bumps (@inkeep/agents-uito^0.15.23) are unchanged
The only file in the PR's scope that changed is agents-manage-ui/package.json, which received a mechanical version bump (0.62.1 → 0.62.2) from the release process — not a PR-specific change.
Prior Issues Status
All issues from previous reviews have been addressed:
- ✅
aiChatSettingsnow passed toInkeepEmbeddedChatcomponent - ✅ Props ordered consistently between React and JavaScript examples
- ✅ Placeholder uses uppercase
'YOUR_APP_ID' - ✅ Import from
@inkeep/agents-ui-cloud(correct package)
🕐 Pending Recommendations (1)
- 💭
agents-manage-ui/package.jsonMissing changeset for dependency bump — still applicable if the@inkeep/agents-uiupdate includes user-facing changes. Consider:pnpm bump patch --pkg agents-manage-ui "Update @inkeep/agents-ui to 0.15.23"
✅ APPROVE
Summary: The merge from main introduced no issues. All previous feedback was addressed and the PR is ready to ship! The authenticated widget examples are well-written and follow existing patterns. 🚀
Reviewers (1)
| Reviewer | Returned | Main Findings | Consider | While You're Here | Inline Comments | Pending Recs | Discarded |
|---|---|---|---|---|---|---|---|
orchestrator |
0 | 0 | 0 | 0 | 0 | 1 | 0 |
| Total | 0 | 0 | 0 | 0 | 0 | 1 | 0 |
Note: Re-review scoped to delta. Merge from main contained CI improvements and version releases — no changes to PR content.
There was a problem hiding this comment.
PR Review Summary
(0) Total Issues | Risk: Low
Re-review Scope
This re-review is scoped to the delta since the last automated review (commit 0a05c4261d5c). The delta consists of:
- Merge from main (commits
691fb505f,24a6ba45b): Brought in 16 commits including Skills nested files feature, CSP fixes, CI improvements, and version releases - No changes to PR content: The documentation (
app-credentials.mdx) and dependency bumps remain identical
The only file in the PR's scope that changed is agents-manage-ui/package.json, which received a mechanical version bump (0.62.2 → 0.63.1) from the release process — not a PR-specific change.
Prior Issues Status
All issues from previous reviews have been addressed:
- ✅
aiChatSettingsnow passed toInkeepEmbeddedChatcomponent - ✅ Props ordered consistently between React and JavaScript examples
- ✅ Placeholder uses uppercase
'YOUR_APP_ID' - ✅ Import from
@inkeep/agents-ui-cloud(correct package)
🕐 Pending Recommendations (1)
- 💭
agents-manage-ui/package.jsonMissing changeset for dependency bump — still applicable if the@inkeep/agents-uiupdate includes user-facing changes. Consider:pnpm bump patch --pkg agents-manage-ui "Update @inkeep/agents-ui to 0.15.23"
✅ APPROVE
Summary: The merge from main introduced no issues to the PR's scope. All previous feedback was addressed and the authenticated widget examples are well-written. Ready to ship! 🚀
Reviewers (1)
| Reviewer | Returned | Main Findings | Consider | While You're Here | Inline Comments | Pending Recs | Discarded |
|---|---|---|---|---|---|---|---|
orchestrator |
0 | 0 | 0 | 0 | 0 | 1 | 0 |
| Total | 0 | 0 | 0 | 0 | 0 | 1 | 0 |
Note: Re-review scoped to delta. No substantive changes to PR content since last approval — merge from main contained CI/release commits only.
|
No additional documentation updates needed — the docs for |
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Inkeep Agent Framework Docs' |
* Bump agents-ui, add example for authed users in widget * Fix example * Fix style inconsistency * Pass aichatsettings to component in react example * Reorder props for consistency:
No description provided.