Skip to content

Commit cf6bbb6

Browse files
anubra266anubra266
authored
docs: update chat component docs to use @inkeep/agents-ui-cloud (#2789)
* docs: update chat component docs to use @inkeep/agents-ui-cloud * fix: regenerate lockfile with @inkeep/agents-ui-cloud resolution * fix: use @inkeep/agents-ui/types in AutoTypeTable (cloud package missing dist types declarations) * fix: revert AutoTypeTable type= attrs to @inkeep/agents-ui (cloud package missing type declarations) * fix: correct JS CDN package name to @inkeep/agents-ui-js-cloud
1 parent 1ea02eb commit cf6bbb6

16 files changed

Lines changed: 99 additions & 70 deletions

‎agents-docs/content/guides/upgrading.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The Inkeep Agent Framework is composed of several npm packages:
1414
- [`@inkeep/agents-core`](https://www.npmjs.com/package/@inkeep/agents-core): The core shared functionality of the agent framework.
1515
- [`@inkeep/agents-sdk`](https://www.npmjs.com/package/@inkeep/agents-sdk): The TypeScript SDK for building multi-agent systems.
1616
- [`@inkeep/agents-cli`](https://www.npmjs.com/package/@inkeep/agents-cli): The CLI for managing and interacting with the agent framework.
17-
- [`@inkeep/agents-ui`](https://www.npmjs.com/package/@inkeep/agents-ui): The UI library containing chat widget components.
17+
- [`@inkeep/agents-ui-cloud`](https://www.npmjs.com/package/@inkeep/agents-ui-cloud): The UI library containing chat widget components.
1818

1919
## Upgrading the quickstart template
2020

‎agents-docs/content/talk-to-your-agents/(chat-components)/index.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ The Inkeep chat components provide pre-built UI elements to quickly integrate co
2020

2121
<CodeGroup>
2222
```bash title="npm"
23-
npm install @inkeep/agents-ui
23+
npm install @inkeep/agents-ui-cloud
2424
```
2525

2626
```bash title="yarn"
27-
yarn add @inkeep/agents-ui
27+
yarn add @inkeep/agents-ui-cloud
2828
```
2929

3030
```bash title="pnpm"
31-
pnpm add @inkeep/agents-ui
31+
pnpm add @inkeep/agents-ui-cloud
3232
```
3333

3434
</CodeGroup>
@@ -108,8 +108,8 @@ The user is currently viewing {{headers.x-current-url}}.
108108

109109
<CodeGroup>
110110
```tsx title="React"
111-
import { InkeepChatButton } from '@inkeep/agents-ui'
112-
import type { InkeepAIChatSettings } from '@inkeep/agents-ui/types'
111+
import { InkeepChatButton } from '@inkeep/agents-ui-cloud'
112+
import type { InkeepAIChatSettings } from '@inkeep/agents-ui-cloud/types'
113113
import { useState, useEffect } from 'react'
114114

115115
export default function ChatButton() {

‎agents-docs/content/talk-to-your-agents/(chat-components)/javascript/chat-button.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The chat button component is a simple way to trigger the Inkeep chat bubble in y
1515
```html
1616
<script
1717
type="module"
18-
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-js@0.15/dist/embed.js"
18+
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-js-cloud@0.15/dist/embed.js"
1919
defer
2020
></script>
2121
```

‎agents-docs/content/talk-to-your-agents/(chat-components)/javascript/custom-trigger.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Custom triggers give you complete control over how users open Inkeep modals in y
1818
```html
1919
<script
2020
type="module"
21-
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-js@0.15/dist/embed.js"
21+
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-js-cloud@0.15/dist/embed.js"
2222
defer
2323
></script>
2424
```

‎agents-docs/content/talk-to-your-agents/(chat-components)/javascript/embedded-chat.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The EmbeddedChat widget provides a fully embedded chat interface that you can in
1616
```html
1717
<script
1818
type="module"
19-
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-js@0.15/dist/embed.js"
19+
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-js-cloud@0.15/dist/embed.js"
2020
defer
2121

2222
> </script>

‎agents-docs/content/talk-to-your-agents/(chat-components)/javascript/side-bar-chat.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The SidebarChat widget provides a slide-out panel interface for conversing with
1616
```html
1717
<script
1818
type="module"
19-
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-js@0.15/dist/embed.js"
19+
src="https://cdn.jsdelivr.net/npm/@inkeep/agents-ui-js-cloud@0.15/dist/embed.js"
2020
defer
2121

2222
> </script>

‎agents-docs/content/talk-to-your-agents/(chat-components)/nextjs/chat-button.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ The chat button component is a simple way to trigger the Inkeep chat bubble. In
1616

1717
<CodeGroup>
1818
```bash title="npm"
19-
npm install @inkeep/agents-ui
19+
npm install @inkeep/agents-ui-cloud
2020
```
2121

2222
```bash title="yarn"
23-
yarn add @inkeep/agents-ui
23+
yarn add @inkeep/agents-ui-cloud
2424
```
2525

2626
```bash title="pnpm"
27-
pnpm add @inkeep/agents-ui
27+
pnpm add @inkeep/agents-ui-cloud
2828
```
2929

3030
</CodeGroup>
@@ -40,10 +40,10 @@ pnpm add @inkeep/agents-ui
4040
'use client';
4141

4242
import dynamic from 'next/dynamic';
43-
import type { InkeepChatButtonProps } from '@inkeep/agents-ui';
43+
import type { InkeepChatButtonProps } from '@inkeep/agents-ui-cloud';
4444

4545
const InkeepChatButton = dynamic(
46-
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepChatButton),
46+
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepChatButton),
4747
{ ssr: false },
4848
);
4949

@@ -75,10 +75,10 @@ pnpm add @inkeep/agents-ui
7575
'use client';
7676

7777
import dynamic from 'next/dynamic';
78-
import type { InkeepChatButtonProps } from '@inkeep/agents-ui';
78+
import type { InkeepChatButtonProps } from '@inkeep/agents-ui-cloud';
7979

8080
const InkeepChatButton = dynamic(
81-
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepChatButton),
81+
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepChatButton),
8282
{ ssr: false },
8383
);
8484

‎agents-docs/content/talk-to-your-agents/(chat-components)/nextjs/custom-trigger.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ Custom triggers give you complete control over how users open Inkeep modals in y
1616

1717
<CodeGroup>
1818
```bash title="npm"
19-
npm install @inkeep/agents-ui
19+
npm install @inkeep/agents-ui-cloud
2020
```
2121

2222
```bash title="yarn"
23-
yarn add @inkeep/agents-ui
23+
yarn add @inkeep/agents-ui-cloud
2424
```
2525

2626
```bash title="pnpm"
27-
pnpm add @inkeep/agents-ui
27+
pnpm add @inkeep/agents-ui-cloud
2828
```
2929

3030
</CodeGroup>
@@ -41,10 +41,10 @@ pnpm add @inkeep/agents-ui
4141

4242
import { useState } from 'react';
4343
import dynamic from 'next/dynamic';
44-
import type { InkeepModalChatProps } from '@inkeep/agents-ui';
44+
import type { InkeepModalChatProps } from '@inkeep/agents-ui-cloud';
4545

4646
const InkeepModalChat = dynamic(
47-
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepModalChat),
47+
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepModalChat),
4848
{ ssr: false },
4949
);
5050

@@ -90,10 +90,10 @@ pnpm add @inkeep/agents-ui
9090

9191
import { useState } from 'react';
9292
import dynamic from 'next/dynamic';
93-
import type { InkeepModalChatProps } from '@inkeep/agents-ui';
93+
import type { InkeepModalChatProps } from '@inkeep/agents-ui-cloud';
9494

9595
const InkeepModalChat = dynamic(
96-
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepModalChat),
96+
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepModalChat),
9797
{ ssr: false },
9898
);
9999

‎agents-docs/content/talk-to-your-agents/(chat-components)/nextjs/embedded-chat.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ The InkeepEmbeddedChat component provides a fully embedded chat interface. In Ne
1616

1717
<CodeGroup>
1818
```bash title="npm"
19-
npm install @inkeep/agents-ui
19+
npm install @inkeep/agents-ui-cloud
2020
```
2121

2222
```bash title="yarn"
23-
yarn add @inkeep/agents-ui
23+
yarn add @inkeep/agents-ui-cloud
2424
```
2525

2626
```bash title="pnpm"
27-
pnpm add @inkeep/agents-ui
27+
pnpm add @inkeep/agents-ui-cloud
2828
```
2929

3030
</CodeGroup>
@@ -40,10 +40,10 @@ pnpm add @inkeep/agents-ui
4040
'use client';
4141

4242
import dynamic from 'next/dynamic';
43-
import type { InkeepEmbeddedChatProps } from '@inkeep/agents-ui';
43+
import type { InkeepEmbeddedChatProps } from '@inkeep/agents-ui-cloud';
4444

4545
const InkeepEmbeddedChat = dynamic(
46-
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepEmbeddedChat),
46+
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepEmbeddedChat),
4747
{ ssr: false },
4848
);
4949

@@ -75,10 +75,10 @@ pnpm add @inkeep/agents-ui
7575
'use client';
7676

7777
import dynamic from 'next/dynamic';
78-
import type { InkeepEmbeddedChatProps } from '@inkeep/agents-ui';
78+
import type { InkeepEmbeddedChatProps } from '@inkeep/agents-ui-cloud';
7979

8080
const InkeepEmbeddedChat = dynamic(
81-
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepEmbeddedChat),
81+
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepEmbeddedChat),
8282
{ ssr: false },
8383
);
8484

‎agents-docs/content/talk-to-your-agents/(chat-components)/nextjs/side-bar-chat.mdx‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ The InkeepSidebarChat component provides a slide-out panel for conversing with y
1616

1717
<CodeGroup>
1818
```bash title="npm"
19-
npm install @inkeep/agents-ui
19+
npm install @inkeep/agents-ui-cloud
2020
```
2121

2222
```bash title="yarn"
23-
yarn add @inkeep/agents-ui
23+
yarn add @inkeep/agents-ui-cloud
2424
```
2525

2626
```bash title="pnpm"
27-
pnpm add @inkeep/agents-ui
27+
pnpm add @inkeep/agents-ui-cloud
2828
```
2929

3030
</CodeGroup>
@@ -43,10 +43,10 @@ pnpm add @inkeep/agents-ui
4343

4444
import { useState } from 'react';
4545
import dynamic from 'next/dynamic';
46-
import type { InkeepSidebarChatProps } from '@inkeep/agents-ui';
46+
import type { InkeepSidebarChatProps } from '@inkeep/agents-ui-cloud';
4747

4848
const InkeepSidebarChat = dynamic(
49-
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepSidebarChat),
49+
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepSidebarChat),
5050
{ ssr: false },
5151
);
5252

@@ -82,10 +82,10 @@ pnpm add @inkeep/agents-ui
8282
'use client';
8383

8484
import dynamic from 'next/dynamic';
85-
import type { InkeepSidebarChatProps } from '@inkeep/agents-ui';
85+
import type { InkeepSidebarChatProps } from '@inkeep/agents-ui-cloud';
8686

8787
const InkeepSidebarChat = dynamic(
88-
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepSidebarChat),
88+
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepSidebarChat),
8989
{ ssr: false },
9090
);
9191

@@ -128,10 +128,10 @@ pnpm add @inkeep/agents-ui
128128

129129
import { useState } from 'react';
130130
import dynamic from 'next/dynamic';
131-
import type { InkeepSidebarChatProps } from '@inkeep/agents-ui';
131+
import type { InkeepSidebarChatProps } from '@inkeep/agents-ui-cloud';
132132

133133
const InkeepSidebarChat = dynamic(
134-
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepSidebarChat),
134+
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepSidebarChat),
135135
{ ssr: false },
136136
);
137137

@@ -167,10 +167,10 @@ pnpm add @inkeep/agents-ui
167167
'use client';
168168

169169
import dynamic from 'next/dynamic';
170-
import type { InkeepSidebarChatProps } from '@inkeep/agents-ui';
170+
import type { InkeepSidebarChatProps } from '@inkeep/agents-ui-cloud';
171171

172172
const InkeepSidebarChat = dynamic(
173-
() => import('@inkeep/agents-ui').then((mod) => mod.InkeepSidebarChat),
173+
() => import('@inkeep/agents-ui-cloud').then((mod) => mod.InkeepSidebarChat),
174174
{ ssr: false },
175175
);
176176

0 commit comments

Comments
 (0)