Skip to content

Bump agents-ui, add example for authed users in widget#2903

Merged
sarah-inkeep merged 8 commits intomainfrom
prd-6390
Mar 30, 2026
Merged

Bump agents-ui, add example for authed users in widget#2903
sarah-inkeep merged 8 commits intomainfrom
prd-6390

Conversation

@sarah-inkeep
Copy link
Copy Markdown
Contributor

No description provided.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Mar 30, 2026

⚠️ No Changeset found

Latest commit: 24a6ba4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Copy Markdown

vercel Bot commented Mar 30, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
agents-api Ready Ready Preview, Comment Mar 30, 2026 10:15pm
agents-docs Ready Ready Preview, Comment Mar 30, 2026 10:15pm
agents-manage-ui Ready Ready Preview, Comment Mar 30, 2026 10:15pm

Request Review

@pullfrog
Copy link
Copy Markdown
Contributor

pullfrog Bot commented Mar 30, 2026

TL;DR — Bumps @inkeep/agents-ui to ^0.15.23 across three packages and adds client-side code examples (React + vanilla JS) showing how to pass getAuthToken for authenticated chat sessions in the widget docs.

Key changes

  • Bump @inkeep/agents-ui to ^0.15.23 — Updates the dependency in agents-docs, agents-manage-ui, and agents-ui-demo.
  • Add authenticated widget usage examples — Expands the app-credentials.mdx doc step with React and JavaScript snippets demonstrating the getAuthToken pattern via baseSettings.

Summary | 5 files | 7 commits | base: mainprd-6390


Authenticated widget usage examples

Before: The "Widget sends the signed JWT" step only described the behavior in prose — no code shown.
After: A CodeGroup with React and vanilla JS examples demonstrates how to wire getAuthToken into baseSettings so the widget automatically fetches and attaches a Bearer token.

The React example imports InkeepEmbeddedChat from @inkeep/agents-ui-cloud and passes baseSettings (with getAuthToken) and aiChatSettings (with appId). The vanilla JS example uses Inkeep.EmbeddedChat with the same pattern. Both show a minimal getAuthToken function that calls a backend /api/inkeep-token route.

app-credentials.mdx · agents-docs/package.json · agents-manage-ui/package.json · agents-ui-demo/package.json

Pullfrog  | View workflow run | Triggered by Pullfrog | Using Claude Opus𝕏

Copy link
Copy Markdown
Contributor

@pullfrog pullfrog Bot left a comment

Choose a reason for hiding this comment

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

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.

Pullfrog  | View workflow run | Using Claude Opus𝕏

Copy link
Copy Markdown
Contributor

@claude claude Bot left a comment

Choose a reason for hiding this comment

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

PR Review Summary

(3) Total Issues | Risk: Low

🟠⚠️ Major (1) 🟠⚠️

Inline Comments:

  • 🟠 Major: app-credentials.mdx:93-96 Configuration structure differs from existing patterns — appId in baseSettings vs aiChatSettings

🟡 Minor (2) 🟡

Inline Comments:

  • 🟡 Minor: app-credentials.mdx:94 Placeholder 'your_app_id' should be uppercase 'YOUR_APP_ID'
  • 🟡 Minor: app-credentials.mdx:111 Same 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',
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 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)

Suggested change
appId: 'your_app_id',
appId: 'YOUR_APP_ID',

Refs:


Inkeep.EmbeddedChat('#chat-target', {
baseSettings: {
appId: 'your_app_id',
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Minor Placeholder uses lowercase, inconsistent with existing examples

Issue: Same as above — the placeholder 'your_app_id' should be uppercase.

Fix: (1-click apply)

Suggested change
appId: 'your_app_id',
appId: 'YOUR_APP_ID',

@github-actions github-actions Bot deleted a comment from claude Bot Mar 30, 2026
Copy link
Copy Markdown
Contributor

@claude claude Bot left a comment

Choose a reason for hiding this comment

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

PR Review Summary

(1) Total Issues | Risk: Medium

🟠⚠️ Major (1) 🟠⚠️

Inline Comments:

  • 🟠 Major: app-credentials.mdx:99 aiChatSettings defined but never passed to InkeepEmbeddedChat

🕐 Pending Recommendations (1)


🚫 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} />;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟠 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)

Suggested change
return <InkeepEmbeddedChat baseSettings={baseSettings} />;
return <InkeepEmbeddedChat baseSettings={baseSettings} aiChatSettings={aiChatSettings} />;

Refs:

Copy link
Copy Markdown
Contributor

@claude claude Bot left a comment

Choose a reason for hiding this comment

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

PR Review Summary

(0) Total Issues | Risk: Low

All previous issues have been addressed:

  • aiChatSettings is now passed to InkeepEmbeddedChat (commit 77739ec1f)
  • ✅ Props reordered for consistency between React and JavaScript examples (commit cc7c9b9c5)

🕐 Pending Recommendations (1)

  • 💭 agents-manage-ui/package.json Missing changeset for dependency bump — still applicable if the @inkeep/agents-ui update 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.

Copy link
Copy Markdown
Contributor

@claude claude Bot left a comment

Choose a reason for hiding this comment

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

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-ui to ^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.10.62.2) from the release process — not a PR-specific change.

Prior Issues Status

All issues from previous reviews have been addressed:

  • aiChatSettings now passed to InkeepEmbeddedChat component
  • ✅ 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.json Missing changeset for dependency bump — still applicable if the @inkeep/agents-ui update 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.

Copy link
Copy Markdown
Contributor

@claude claude Bot left a comment

Choose a reason for hiding this comment

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

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.20.63.1) from the release process — not a PR-specific change.

Prior Issues Status

All issues from previous reviews have been addressed:

  • aiChatSettings now passed to InkeepEmbeddedChat component
  • ✅ 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.json Missing changeset for dependency bump — still applicable if the @inkeep/agents-ui update 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.

@github-actions github-actions Bot deleted a comment from claude Bot Mar 30, 2026
@sarah-inkeep sarah-inkeep added this pull request to the merge queue Mar 30, 2026
Merged via the queue into main with commit a8fe920 Mar 30, 2026
23 checks passed
@sarah-inkeep sarah-inkeep deleted the prd-6390 branch March 30, 2026 22:40
@inkeep
Copy link
Copy Markdown
Contributor

inkeep Bot commented Mar 30, 2026

No additional documentation updates needed — the docs for getAuthToken were included in this PR. 🎉

@github-actions
Copy link
Copy Markdown
Contributor

🔎💬 Inkeep AI search and chat service is syncing content for source 'Inkeep Agent Framework Docs'

tim-inkeep pushed a commit that referenced this pull request Mar 31, 2026
* 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:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant