@gengage/assistant-fe 0.1.2 → 0.1.3

package/README.md

@@ -20,6 +20,9 @@ contextual Q&A buttons, and a similar-products grid.
 | **QNA** | `@gengage/assistant-fe/qna` | Contextual action buttons for product pages |
 | **SimRel** | `@gengage/assistant-fe/simrel` | Similar / related product grid |
 
+> **`middlewareUrl` is required.** Set it in your initialization script to point to your
+> Gengage backend. The SDK has no built-in default — you must always provide it explicitly.
+
 ---
 
 ## Quick Start (CDN embed)
@@ -132,6 +135,10 @@ gengage-assistant-fe/
 │   ├── react/             # React CDN + IIFE bundles
 │   ├── nextjs/            # Next.js integration guide
 │   └── native/            # Mobile WebView overlay
+├── catalog/                # Visual component catalog (no backend needed)
+│   ├── index.html          # SPA shell
+│   ├── vite.config.ts      # Resolves @gengage/assistant-fe → dist/
+│   └── src/                # Router, layout, mock data, sections
 ├── scripts/
 │   └── dev.ts             # Dev server entry point (npm run dev)
 ├── docs/
@@ -158,6 +165,7 @@ gengage-assistant-fe/
 | `npm run lint` | ESLint `src/` |
 | `npm run test` | Vitest unit tests |
 | `npm run test:e2e` | Playwright smoke tests |
+| `npm run catalog` | Visual component catalog at `http://localhost:3002` |
 | `npm run docs:dev` | VitePress docs server |
 
 ### `npm run dev` — Local Widget Test Server
@@ -192,6 +200,28 @@ HMR is active — editing `src/` files updates the page without a full reload.
 > The dev server serves the account's demo page from `demos/<accountId>/index.html`,
 > generating fresh session/user/view IDs on each start.
 
+### Component Catalog (`npm run catalog`)
+
+A visual catalog that renders every component with mock data — no backend needed.
+Imports from `dist/` (validates the npm package as consumers would see it).
+
+```bash
+npm run build && npm run catalog    # Build first, then serve at :3002
+```
+
+Open `http://localhost:3002` to see:
+
+- **25+ components** grouped by widget (Chat, QNA, SimRel) in realistic frames
+- **Global theme selector** — switch between 12 merchant color presets (Koçtaş, n11, Hepsiburada, Trendyol, etc.)
+- **Chat components** shown inside a chat-drawer frame (dark header, avatar, message area)
+- **QNA components** shown inside a PDP-like frame (product title, price)
+- **SimRel components** shown inside a product section frame ("Benzer Ürünler" header)
+- **Full Widgets** section with mock fetch backend (NDJSON interception)
+- **Theme Comparison** — same component rendered across all 12 merchant themes
+- **Responsive Preview** — mobile / tablet / desktop viewport frames
+
+The catalog lives in `catalog/` and is excluded from npm publish (`files: ["dist/"]`).
+
 ---
 
 ## Customization

package/dist/chat/session-persistence.d.ts

@@ -33,7 +33,7 @@ export declare class SessionPersistence {
      * Sends an 'openURLInNewTab' bridge message so the host page can intercept
      * (e.g. for SPA routing), then navigates directly as fallback.
      *
-     * Legacy compatibility: robot-engine-lean navigated via window.location.href
+     * Legacy compatibility: the prior engine navigated via window.location.href
      * after posting saveSessionAndOpenURL to the iframe. The clean-room runs in
      * the same window (Shadow DOM, not iframe), so it navigates directly.
      */

package/dist/chat/types.d.ts

@@ -77,7 +77,7 @@ export interface ChatWidgetConfig extends BaseWidgetConfig {
     voiceEnabled?: boolean;
     /**
      * Backend type:
-     *   - 'v1'   : micro-abilities backend (default) — /chat/process_action
+     *   - 'v1'   : standard backend (default) — /chat/process_action
      *   - 'acap' : ACAP platform backend — /api/chat/:siteId/message
      */
     backendType?: import('../common/api-paths.js').BackendType;