@truefoundry/trueforge-ui 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,10 +1,21 @@
 # Changelog
 
+## 0.2.0
+
+### Minor Changes
+
+- 9a4d1a7: Add opt-in `withRouter` URL sync for shell places (`/`, `/agents/:agentName`, `/sessions/:sessionId`, `/settings`), with path customization via `routes` and `react-router-dom` as an optional peer. Serve the app shell for client-side deep links from the TrueForge server.
+
+### Patch Changes
+
+- Updated dependencies [5100c59]
+  - @truefoundry/trueforge-sdk@0.1.1
+
 ## 0.1.0
 
 ### Minor Changes
 
-- 2f08a99: Remember plain-draft composer choices (model, skills, MCP connectors, config) across New Chat and reloads via localStorage. Edit-flow and immutable library agents are unchanged. `TrueforgeUI` `layout` is optional and defaults to `"sidebar"`.
+- 2f08a99: Remember plain-draft composer choices (model, skills, MCP connectors, config) across New Chat and reloads via localStorage. Edit-flow and immutable library agents are unchanged. `TrueForgeUI` `layout` is optional and defaults to `"sidebar"`.
 - b56c003: Initial 0.1.0-rc.1 prerelease of all public packages.
 
 ### Patch Changes
@@ -20,7 +31,7 @@
 
 ### Minor Changes
 
-- 2f08a99: Remember plain-draft composer choices (model, skills, MCP connectors, config) across New Chat and reloads via localStorage. Edit-flow and immutable library agents are unchanged. `TrueforgeUI` `layout` is optional and defaults to `"sidebar"`.
+- 2f08a99: Remember plain-draft composer choices (model, skills, MCP connectors, config) across New Chat and reloads via localStorage. Edit-flow and immutable library agents are unchanged. `TrueForgeUI` `layout` is optional and defaults to `"sidebar"`.
 
 ### Patch Changes
 
@@ -83,8 +94,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   config choices are remembered (in-memory + `localStorage`) and seed the next
   New Chat after reload. Stale catalog entries are pruned once catalogs load.
   Edit-flow (`agentId` set) and immutable library agents are unchanged.
-- **Optional `layout`** — `<TrueforgeUI />` `layout` prop defaults to `"sidebar"`.
-- **`type: "trueforge"` built-in server** — `<TrueforgeUI server={{ type: 'trueforge', baseUrl?, token?, fetch? }} />`
+- **Optional `layout`** — `<TrueForgeUI />` `layout` prop defaults to `"sidebar"`.
+- **`type: "trueforge"` built-in server** — `<TrueForgeUI server={{ type: 'trueforge', baseUrl?, token?, fetch? }} />`
   resolves a full Harness `AgentUIServer` via
   `@truefoundry/trueforge-ui/plugins/trueforge-agent-server-adapter`
   (`createTrueForgeAgentUIServer`), including chat, builder, and default settings
@@ -164,9 +175,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   Save Agent / welcome chrome key off `isMutable`, not draft|named.
   Hosts that inspected `mode.type` must switch to `mode.status` /
   `mode.isMutable` (see `shellIsMutable`).
-- **Renamed `TrueFoundryAssistantUI` → `TrueforgeUI`** (props type
-  `TrueFoundryAssistantUIProps` → `TrueforgeUIProps`). Update imports and JSX.
-- **`TrueforgeUI` agent props** — replaced top-level `agentName` and
+- **Renamed `TrueFoundryAssistantUI` → `TrueForgeUI`** (props type
+  `TrueFoundryAssistantUIProps` → `TrueForgeUIProps`). Update imports and JSX.
+- **`TrueForgeUI` agent props** — replaced top-level `agentName` and
   `defaultAgentSpec` with a single discriminated `agentConfig`. There is no
   compat shim; hosts must update call sites.
 - **Icons use Lucide** (`lucide-react`) instead of Font Awesome. Default
@@ -220,10 +231,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   `CreateSandboxRequest`, `UpdateSandboxRequest`, `SandboxCatalogServer`.
   `apiKey` is never stored in the catalog and is optional on update (blank keeps
   the existing key).
-- `TrueforgeBuiltInServerConfig` exported for hosts that build the built-in
+- `TrueForgeBuiltInServerConfig` exported for hosts that build the built-in
   config separately.
 
-- **`agentConfig` shell modes** on `TrueforgeUI` /
+- **`agentConfig` shell modes** on `TrueForgeUI` /
   `ShellModeProvider`:
   - `SingleAgent` — locked named agent (`name` required)
   - `AgentLibrary` — Agents Library only; idle empty state until pick; no New Chat
@@ -259,8 +270,8 @@ import { TrueFoundryAssistantUI } from '@truefoundry/trueforge-ui';
 <TrueFoundryAssistantUI server={server} layout="sidebar" />;
 
 // After
-import { TrueforgeUI } from '@truefoundry/trueforge-ui';
-<TrueforgeUI server={server} layout="sidebar" />;
+import { TrueForgeUI } from '@truefoundry/trueforge-ui';
+<TrueForgeUI server={server} layout="sidebar" />;
 ```
 
 #### `agentConfig` (host must update)
@@ -282,12 +293,12 @@ import { TrueforgeUI } from '@truefoundry/trueforge-ui';
 />
 
 // After
-<TrueforgeUI
+<TrueForgeUI
   server={server}
   layout="sidebar"
   agentConfig={{ mode: "SingleAgent", name: "support-agent" }}
 />
-<TrueforgeUI
+<TrueForgeUI
   server={server}
   layout="sidebar"
   agentConfig={{
@@ -336,7 +347,7 @@ import { TrueforgeUI } from '@truefoundry/trueforge-ui';
 
 ### Added
 
-- `TrueforgeUI` quick-start component with `layout`: `sidebar` | `drawer` |
+- `TrueForgeUI` quick-start component with `layout`: `sidebar` | `drawer` |
   `dock` | `widget` (slots outside the chat provider so toast overrides apply).
 - Curated re-exports: `useAui`, `useAuiState`, `AssistantState` from the main
   barrel and `@truefoundry/trueforge-ui/assistant-ui`; `useTheme` from the main
@@ -368,7 +379,7 @@ import { TrueforgeUI } from '@truefoundry/trueforge-ui';
 - Font Awesome packages this SDK imports (`fontawesome-svg-core`,
   `free-solid-svg-icons`) moved to `dependencies`.
 - `SlotOverrides` is `Partial<AtomSlots>` only (no `Record<string, unknown>`).
-- `TrueforgeUI` lazy-layout `Suspense` fallback is a pulse skeleton
+- `TrueForgeUI` lazy-layout `Suspense` fallback is a pulse skeleton
   instead of blank.
 - README reordered: quick start (prefer `client`) before advanced sections.
 

package/README.md

@@ -12,7 +12,7 @@ Powered by [assistant-ui](https://www.assistant-ui.com/), it follows the familia
 
 - **Fully themeable** — Use built-in themes inspired by **TrueFoundry**, **ChatGPT**, **Claude**, and **Gemini**, or create your own brand identity.
 - **Composable by design** — Swap layouts, components, and interaction patterns to fit your product.
-- **Backend agnostic** — Connect to **TrueFoundry**, **TrueForge**, or any custom API via `TrueforgeServerConfig`.
+- **Backend agnostic** — Connect to **TrueFoundry**, **TrueForge**, or any custom API via `TrueForgeServerConfig`.
 - **Open source** — Extend, customize, and contribute without vendor lock-in.
 - **Built on assistant-ui** — Leverage a modern React foundation with seamless shadcn/ui and Tailwind CSS integration.
 - **Production ready** — Focus on your agents while the SDK handles the chat experience.
@@ -27,7 +27,7 @@ Bring your own **brand, colors, layout, components, and server**—the Agent SDK
 
 - [Installation](#installation)
 - [Getting started](#getting-started)
-- [`<TrueforgeUI />` props](#trueforgeui--props)
+- [`<TrueForgeUI />` props](#trueforgeui--props)
 - [Theming](#theming)
 - [Content classNames](#content-classnames)
 - [Brand / logo](#brand--logo)
@@ -60,7 +60,7 @@ and your app chrome work alongside the SDK. In the host stylesheet:
 @import 'tailwindcss';
 ```
 
-SDK styles (tokens, utilities, OpenUI) load automatically when `TrueforgeUI` /
+SDK styles (tokens, utilities, OpenUI) load automatically when `TrueForgeUI` /
 `ThemeProvider` mounts — you do **not** need to import the SDK stylesheet for
 client-only apps.
 
@@ -83,12 +83,12 @@ Zero-config path: the SDK builds the agent UI server from your API key and
 control plane URL (optional explicit gateway URL).
 
 ```tsx
-import { TrueforgeUI } from '@truefoundry/trueforge-ui';
+import { TrueForgeUI } from '@truefoundry/trueforge-ui';
 
 export default function App() {
   return (
     <div style={{ height: '100dvh' }}>
-      <TrueforgeUI
+      <TrueForgeUI
         server={{
           type: 'truefoundry',
           apiKey: process.env.TFY_API_KEY!,
@@ -118,12 +118,12 @@ pnpm add @truefoundry/trueforge-sdk
 **Bearer token (embeds / remote API):**
 
 ```tsx
-import { TrueforgeUI } from '@truefoundry/trueforge-ui';
+import { TrueForgeUI } from '@truefoundry/trueforge-ui';
 
 export default function App() {
   return (
     <div style={{ height: '100dvh' }}>
-      <TrueforgeUI
+      <TrueForgeUI
         server={{
           type: 'trueforge',
           baseUrl: process.env.TRUEFORGE_BASE_URL, // optional; default '/'
@@ -140,7 +140,7 @@ export default function App() {
 auth-aware wrapper that follows OIDC cookies):
 
 ```tsx
-<TrueforgeUI
+<TrueForgeUI
   server={{
     type: 'trueforge',
     baseUrl: '/',
@@ -157,7 +157,7 @@ auth-aware wrapper that follows OIDC cookies):
 Optional: pass `catalog` to override the built-in settings catalogs, or import
 `createTrueForgeAgentUIServer` from
 `@truefoundry/trueforge-ui/plugins/trueforge-agent-server-adapter` when you need
-the factory outside `<TrueforgeUI />`.
+the factory outside `<TrueForgeUI />`.
 
 **Custom** — bring your own `AgentUIServer`
 
@@ -165,7 +165,7 @@ Use this when you compose chat + builder yourself (e.g. chat-only gateway
 adapter + stub catalog, or a full host BFF). Pass the server object directly.
 
 ```tsx
-import { TrueforgeUI, createTrueFoundryServer } from '@truefoundry/trueforge-ui';
+import { TrueForgeUI, createTrueFoundryServer } from '@truefoundry/trueforge-ui';
 import { createTrueFoundryChatServer } from '@truefoundry/assistant-ui-runtime/plugins/truefoundry-agent-server-adapter';
 
 const chatServer = createTrueFoundryChatServer({
@@ -185,18 +185,18 @@ const server = createTrueFoundryServer({
 export default function App() {
   return (
     <div style={{ height: '100dvh' }}>
-      <TrueforgeUI server={server} layout="sidebar" />
+      <TrueForgeUI server={server} layout="sidebar" />
     </div>
   );
 }
 ```
 
-## `<TrueforgeUI />` props
+## `<TrueForgeUI />` props
 
-`<TrueforgeUI />` is the single entry point. Every capability is driven by a prop.
+`<TrueForgeUI />` is the single entry point. Every capability is driven by a prop.
 
 ```tsx
-<TrueforgeUI
+<TrueForgeUI
   server={{
     type: 'truefoundry',
     apiKey: process.env.TFY_API_KEY!,
@@ -218,7 +218,7 @@ export default function App() {
 
 | Prop               | Type                       | Required | Description                                                                                                        |
 | ------------------ | -------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
-| `server`           | `TrueforgeServerConfig`    | ✅       | Built-in config (`truefoundry` / `trueforge`) **or** a ready `AgentUIServer`.                                      |
+| `server`           | `TrueForgeServerConfig`    | ✅       | Built-in config (`truefoundry` / `trueforge`) **or** a ready `AgentUIServer`.                                      |
 | `layout`           | `LayoutProp`               | ✅       | Built-in layout string **or** a custom React component.                                                            |
 | `agentConfig`      | `AgentConfig`              | —        | Shell mode: SingleAgent / AgentLibrary / AgentComposer / AgentLibraryWithComposer. Defaults to library + composer. |
 | `theme`            | `ThemeConfig`              | —        | Preset, mode, tokens, brand, icons, **content `classNames`** (see [Theming](#theming)).                            |
@@ -227,7 +227,7 @@ export default function App() {
 | `initialSessionId` | `string`                   | —        | Resume a specific session.                                                                                         |
 | `onError`          | `(error: unknown) => void` | —        | Host error hook (runtime + server init).                                                                           |
 
-Later sections use `server` as a `TrueforgeServerConfig` (usually `type: "truefoundry"`). For a host-built port, pass the `AgentUIServer` directly.
+Later sections use `server` as a `TrueForgeServerConfig` (usually `type: "truefoundry"`). For a host-built port, pass the `AgentUIServer` directly.
 
 ---
 
@@ -242,7 +242,7 @@ const server = {
   controlPlaneURL: process.env.TFY_CONTROL_PLANE_URL!,
 };
 
-<TrueforgeUI
+<TrueForgeUI
   server={server}
   layout="sidebar"
   theme={{
@@ -280,11 +280,11 @@ See [docs/theming.md](./docs/theming.md) for presets, controlled vs uncontrolled
 ## Content classNames
 
 Style content renderers (markdown, code fences, OpenUI, Monaco) without swapping
-slots. Pass `theme.classNames` on `<TrueforgeUI />` — values merge onto the
+slots. Pass `theme.classNames` on `<TrueForgeUI />` — values merge onto the
 defaults via `cn()`:
 
 ```tsx
-<TrueforgeUI
+<TrueForgeUI
   server={server}
   layout="sidebar"
   theme={{
@@ -324,7 +324,7 @@ package). Host CSS on `.aui-markdown` / `.aui-syntax-highlighter` / `.aui-openui
 **Base layouts** — pass `theme.brand` and the SDK positions the mark + name in the default slots:
 
 ```tsx
-<TrueforgeUI
+<TrueForgeUI
   server={server}
   layout="sidebar"
   theme={{
@@ -340,7 +340,7 @@ package). Host CSS on `.aui-markdown` / `.aui-syntax-highlighter` / `.aui-openui
 the resolved mode. `href` wraps the logo in a same-tab link:
 
 ```tsx
-<TrueforgeUI
+<TrueForgeUI
   server={server}
   layout="sidebar"
   theme={{
@@ -358,7 +358,7 @@ Set only one mode and it is used for both. `name` labels the image, so no `alt`
 component, override the `BrandLogo` slot, the same way you replace any other atom:
 
 ```tsx
-<TrueforgeUI server={server} layout="sidebar" overrides={{ BrandLogo: MyMark }} />
+<TrueForgeUI server={server} layout="sidebar" overrides={{ BrandLogo: MyMark }} />
 ```
 
 **Custom layouts** — import `BrandLogo` and place it anywhere; pair it with `useBrandName()` when you also want the name as text (see [Custom layouts](#custom-layouts)).
@@ -384,22 +384,22 @@ In library modes, picking an agent from the Agents Library switches to a named c
 {
   /* Library + draft (default) */
 }
-<TrueforgeUI server={server} layout="sidebar" />;
+<TrueForgeUI server={server} layout="sidebar" />;
 
 {
   /* Named-only lock */
 }
-<TrueforgeUI server={server} layout="sidebar" agentConfig={{ mode: 'SingleAgent', name: 'support-agent' }} />;
+<TrueForgeUI server={server} layout="sidebar" agentConfig={{ mode: 'SingleAgent', name: 'support-agent' }} />;
 
 {
   /* Library only — select an agent to start */
 }
-<TrueforgeUI server={server} layout="sidebar" agentConfig={{ mode: 'AgentLibrary' }} />;
+<TrueForgeUI server={server} layout="sidebar" agentConfig={{ mode: 'AgentLibrary' }} />;
 
 {
   /* Composer only */
 }
-<TrueforgeUI
+<TrueForgeUI
   server={server}
   layout="sidebar"
   agentConfig={{
@@ -456,10 +456,10 @@ function Layout({ className }: { className?: string }) {
   );
 }
 
-<TrueforgeUI server={server} layout={Layout} />;
+<TrueForgeUI server={server} layout={Layout} />;
 ```
 
-For deeper composition without `TrueforgeUI`, nest `SlotsProvider` outside `TrueFoundryChatProvider` — see [docs/customization.md](./docs/customization.md).
+For deeper composition without `TrueForgeUI`, nest `SlotsProvider` outside `TrueFoundryChatProvider` — see [docs/customization.md](./docs/customization.md).
 
 > _Screenshot: a custom layout assembled from_ `BrandLogo`_,_ `ThreadListContainer`_, and_ `Thread`_._
 
@@ -470,7 +470,7 @@ For deeper composition without `TrueforgeUI`, nest `SlotsProvider` outside `True
 Every curated feature atom is overridable. Provide an `overrides` map to swap any single component while inheriting the rest.
 
 ```tsx
-import { TrueforgeUI, type AssistantMessageBubbleProps } from '@truefoundry/trueforge-ui';
+import { TrueForgeUI, type AssistantMessageBubbleProps } from '@truefoundry/trueforge-ui';
 
 function MyBubble({ children, error, actionBar, className }: AssistantMessageBubbleProps) {
   return (
@@ -482,7 +482,7 @@ function MyBubble({ children, error, actionBar, className }: AssistantMessageBub
   );
 }
 
-<TrueforgeUI
+<TrueForgeUI
   server={server}
   layout="sidebar"
   overrides={{
@@ -500,11 +500,11 @@ See [docs/customization.md](./docs/customization.md) for the full slot list.
 
 ## Server
 
-`<TrueforgeUI />` takes a **`TrueforgeServerConfig`**: built-in backends init
+`<TrueForgeUI />` takes a **`TrueForgeServerConfig`**: built-in backends init
 inside the component, or pass a ready `AgentUIServer` directly.
 
 ```ts
-type TrueforgeServerConfig =
+type TrueForgeServerConfig =
   | {
       type: 'truefoundry';
       apiKey: string;
@@ -539,7 +539,7 @@ host-owned: pass `token` and/or `fetch`.
 **Compose your own `AgentUIServer` (custom):**
 
 ```tsx
-import { TrueforgeUI, createTrueFoundryServer } from '@truefoundry/trueforge-ui';
+import { TrueForgeUI, createTrueFoundryServer } from '@truefoundry/trueforge-ui';
 import { createTrueFoundryChatServer } from '@truefoundry/assistant-ui-runtime/plugins/truefoundry-agent-server-adapter';
 
 const chatServer = createTrueFoundryChatServer({ apiKey, baseUrl });
@@ -552,13 +552,13 @@ const agentServer = createTrueFoundryServer({
   saveAgent,
 });
 
-<TrueforgeUI server={agentServer} layout="sidebar" />;
+<TrueForgeUI server={agentServer} layout="sidebar" />;
 ```
 
 **Implement `AgentUIServer` yourself:**
 
 ```tsx
-import { TrueforgeUI, type AgentUIServer } from '@truefoundry/trueforge-ui';
+import { TrueForgeUI, type AgentUIServer } from '@truefoundry/trueforge-ui';
 
 const agentServer: AgentUIServer = {
   // AgentChatServer methods…
@@ -576,7 +576,7 @@ const agentServer: AgentUIServer = {
   saveAgent: async ({ agentName, agentSpec }) => ({ ok: true }),
 };
 
-<TrueforgeUI server={agentServer} layout="sidebar" />;
+<TrueForgeUI server={agentServer} layout="sidebar" />;
 ```
 
 See [docs/server.md](./docs/server.md) for the full method list and BYO guidance.
@@ -587,8 +587,8 @@ See [docs/server.md](./docs/server.md) for the full method list and BYO guidance
 
 | Export                                                             | Kind       | Purpose                                                      |
 | ------------------------------------------------------------------ | ---------- | ------------------------------------------------------------ |
-| `TrueforgeUI`                                                      | Component  | Root component — accepts all props above                     |
-| `TrueforgeServerConfig`                                            | Type       | `server` prop: `truefoundry` / `trueforge` / `AgentUIServer` |
+| `TrueForgeUI`                                                      | Component  | Root component — accepts all props above                     |
+| `TrueForgeServerConfig`                                            | Type       | `server` prop: `truefoundry` / `trueforge` / `AgentUIServer` |
 | `createTrueFoundryServer`                                          | Function   | Compose chat + builder into `AgentUIServer`                  |
 | `Thread`, `ThreadListContainer`, `BrandLogo`                       | Components | Layout primitives for custom layouts                         |
 | Composer / message / tool atoms                                    | Components | Overridable, themeable building blocks                       |

package/dist/{ConnectorSettings-H37ZFC6Z.js → ConnectorSettings-4CYGRWPH.js}

@@ -7,12 +7,14 @@ import {
   auiInputClass,
   useMCPAuth,
   useToasterOptional
-} from "./chunk-QGNLP2EE.js";
+} from "./chunk-MIHHZQOQ.js";
 import {
   Icon,
-  getErrorMessage,
+  getErrorMessage
+} from "./chunk-EK6OUU24.js";
+import {
   useCatalogServer
-} from "./chunk-XAZ5HJXV.js";
+} from "./chunk-IDXUUOSM.js";
 import "./chunk-HT5HKQXE.js";
 import {
   cn
@@ -918,4 +920,4 @@ var ConnectorSettings_default = ConnectorSettings;
 export {
   ConnectorSettings_default as default
 };
-//# sourceMappingURL=ConnectorSettings-H37ZFC6Z.js.map
+//# sourceMappingURL=ConnectorSettings-4CYGRWPH.js.map