@papermap/papermap 1.0.2 → 1.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@papermap/papermap",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Embeddable AI chat bar and UI components from the Papermap data analytics platform",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/readme.md

@@ -4,22 +4,22 @@ Embeddable AI-powered components from the [Papermap](https://www.papermap.ai) da
 
 ## Main components
 
-- **`PapermapChat`** — Full AI chat assistant with streaming, conversation history, and chart generation.
-- **`PapermapChartCard`** — Standalone chart card with toolbar actions. Use `variant="streaming"` for an embedded chart + conversation dialog (without the floating assistant).
-- **`PapermapGridDashboard`** — Responsive grid layout of chart cards, toolbar (screenshot, generate dashboard, theme), optional chat assistant, and controlled or uncontrolled layouts.
+- **`PaperChat`** — Full AI chat assistant with streaming, conversation history, and chart generation.
+- **`PaperCard`** — Standalone chart card with toolbar actions. Use `variant="streaming"` for an embedded chart + conversation dialog (without the floating assistant).
+- **`PaperBoard`** — Responsive grid layout of chart cards, toolbar (screenshot, generate dashboard, theme), optional chat assistant, and controlled or uncontrolled layouts.
 
 ```tsx
-import { PapermapChat, PapermapChartCard, PapermapGridDashboard } from '@papermap/papermap'
+import { PaperChat, PaperCard, PaperBoard } from '@papermap/papermap'
 
 // AI chat assistant
-<PapermapChat
+<PaperChat
   token="your-base64-api-token"
   workspaceId="your-workspace-id"
   dashboardId="your-dashboard-id"
 />
 
 // Standalone chart card
-<PapermapChartCard
+<PaperCard
   token="your-base64-api-token"
   workspaceId="your-workspace-id"
   dashboardId="your-dashboard-id"
@@ -27,7 +27,7 @@ import { PapermapChat, PapermapChartCard, PapermapGridDashboard } from '@paperma
 />
 
 // Streaming chart card (embedded dialog + chat)
-<PapermapChartCard
+<PaperCard
   token="your-base64-api-token"
   workspaceId="your-workspace-id"
   dashboardId="your-dashboard-id"
@@ -35,8 +35,8 @@ import { PapermapChat, PapermapChartCard, PapermapGridDashboard } from '@paperma
   chartId="your-chart-id" // optional; card shows empty state if omitted
 />
 
-// Full grid dashboard (wraps chart cards + optional PapermapChat)
-<PapermapGridDashboard
+// Full grid dashboard (wraps chart cards + optional PaperChat)
+<PaperBoard
   token="..."
   workspaceId="..."
   dashboardId="..."
@@ -75,8 +75,8 @@ import '@papermap/papermap/styles.css'
 ```tsx
 import {
   PapermapConfigProvider,
-  PapermapChat,
-  PapermapChartCard,
+  PaperChat,
+  PaperCard,
 } from '@papermap/papermap'
 
 function App() {
@@ -87,8 +87,8 @@ function App() {
       dashboardId="your-dashboard-id"
       // optional: apiUrl="https://dataapi.papermap.ai"
     >
-      <PapermapChat />
-      <PapermapChartCard chartId="existing-chat-id" />
+      <PaperChat />
+      <PaperCard chartId="existing-chat-id" />
     </PapermapConfigProvider>
   )
 }
@@ -99,18 +99,18 @@ function App() {
 Pass `token`, `workspaceId`, and `dashboardId` on each component (or rely on an existing parent `PapermapProvider`).
 
 ```tsx
-import { PapermapChat, PapermapChartCard } from '@papermap/papermap'
+import { PaperChat, PaperCard } from '@papermap/papermap'
 
 function App() {
   return (
     <>
-      <PapermapChat
+      <PaperChat
         token="your-base64-api-token"
         workspaceId="your-workspace-id"
         dashboardId="your-dashboard-id"
       />
 
-      <PapermapChartCard
+      <PaperCard
         token="your-base64-api-token"
         workspaceId="your-workspace-id"
         dashboardId="your-dashboard-id"
@@ -123,7 +123,7 @@ function App() {
 
 ### 4. Props
 
-#### `PapermapChat` props
+#### `PaperChat` props
 
 | Prop          | Type                   | Required | Default                           | Description                          |
 | ------------- | ---------------------- | -------- | --------------------------------- | ------------------------------------ |
@@ -140,7 +140,7 @@ function App() {
 
 \*Omit on the component when values come from `PapermapConfigProvider` / `PapermapProvider`.
 
-#### `PapermapChartCard` props
+#### `PaperCard` props
 
 | Prop           | Type                                     | Required | Default                           | Description                                                           |
 | -------------- | ---------------------------------------- | -------- | --------------------------------- | --------------------------------------------------------------------- |
@@ -163,7 +163,7 @@ function App() {
 **Pre-loaded chart:**
 
 ```tsx
-import { PapermapChartCard } from '@papermap/papermap'
+import { PaperCard } from '@papermap/papermap'
 import type { TChartResponse } from '@papermap/papermap'
 
 const chart: TChartResponse = {
@@ -183,7 +183,7 @@ const chart: TChartResponse = {
   },
 }
 
-<PapermapChartCard
+<PaperCard
   token="..."
   workspaceId="..."
   dashboardId="..."
@@ -193,7 +193,7 @@ const chart: TChartResponse = {
 />
 ```
 
-#### `PapermapGridDashboard` props (high level)
+#### `PaperBoard` props (high level)
 
 | Prop | Notes |
 | ---- | ----- |
@@ -202,23 +202,23 @@ const chart: TChartResponse = {
 | `layouts` / `onLayoutsChange` | Controlled grid layouts per breakpoint. |
 | `isEditMode`, `editLayout`, `isViewer` | Edit vs view behavior. |
 | `showToolbar`, `showScreenshot`, `showGenerateDashboard`, `showHeader`, `showChatAssistant` | Feature toggles. |
-| `variant` | `'default' \| 'streaming'` for embedded chart cards (matches `PapermapChartCard`). |
+| `variant` | `'default' \| 'streaming'` for embedded chart cards (matches `PaperCard`). |
 | `dashboardTheme`, `onDashboardThemeChange`, `persistWorkspaceTheme`, `renderThemeModal` | Theming; built-in modal uses `ThemeCustomizationSettings`. |
 | Callbacks | `onEditChart`, `onDeleteChart`, `onPinChange`, `onGenerateDashboard`, `onTakeScreenshot`, `onThemeModalOpen`, etc. |
 
-See TypeScript types `PapermapGridDashboardProps` and Storybook stories for full detail.
+See TypeScript types `PaperBoardProps` and Storybook stories for full detail.
 
 ### Streaming chart card variant
 
 With `variant="streaming"`, the edit action opens an embedded expanded view with chart + conversation, SSE streaming, save-to-dashboard and maximize actions, and audit log on assistant messages.
 
 ```tsx
-import { PapermapChartCard } from '@papermap/papermap'
+import { PaperCard } from '@papermap/papermap'
 
 export function EmbeddedStreamingChart() {
   return (
     <div className="h-[420px] w-[520px]">
-      <PapermapChartCard
+      <PaperCard
         token="..."
         workspaceId="..."
         dashboardId="..."
@@ -255,7 +255,7 @@ For custom layouts, the package also exports subcomponents (for example `ChatAss
 
 - Set `apiUrl` on the provider or per component. Default is `https://dataapi.papermap.ai`.
 
-### Charts do not appear in `PapermapChartCard`
+### Charts do not appear in `PaperCard`
 
 - Pass a valid backend `chartId` (chat id), or supply preloaded `chart` data.
 
@@ -291,7 +291,7 @@ The library decodes it and sends these headers on API requests:
 3. SSE connects to `POST /api/v1/analytics/requests/stream` for live updates; HTTP remains a fallback.
 4. History: `GET /api/v1/analytics/chats/{id}/conversations`, dashboard recent chats, and full chart history per chat as needed.
 
-### What users see in `PapermapChat`
+### What users see in `PaperChat`
 
 - Floating input bar (portaled to `document.body`), Cmd/Ctrl+K to focus, Escape to dismiss.
 - Expanding input, backdrop, conversation panel, stop during load, new chat, scroll and history pagination.