@aleph-alpha/chat-kit 0.5.1 → 0.5.2

package/README.md

@@ -1,6 +1,6 @@
 # @aleph-alpha/chat-kit
 
-Chat kit for building chat interfaces with Vue. Provides pre-built components, composables, and services for conversational experiences.
+Chat kit for building chat interfaces with Vue. Ships components, handlers (message tree via `useMessageHandler`, markdown, labels — from the package root or `@aleph-alpha/chat-kit/handlers`), a composables entry for `useChat` _(under development)_, and a services layer for backends _(under development)_.
 
 > Part of the [frontend-hub](https://github.com/Aleph-Alpha/frontend-hub) monorepo.
 
@@ -12,13 +12,13 @@ pnpm add @aleph-alpha/chat-kit
 
 ## Architecture
 
-This package follows a three-layer architecture:
+Chat Kit is organised into **three layers**:
 
-1. **Services Layer** — Interfaces and abstract classes for chat service implementations
-2. **Composables Layer** — Reactive state management via Vue Composition API
-3. **Components Layer** — Pre-built Vue 3 components for chat UI
+1. **Components** — Pre-built Vue 3 components for chat UIs, split into **base** (presentational) and **composed** (opinionated patterns).
+2. **Handlers** — Reactive utilities for chat state management: `useMessageHandler` (conversation tree), `useMarkdownParser` (markdown pipeline), `useChatKitLabels` (i18n).
+3. **Services** _(under development)_ — Abstract `ChatService` / `IChatService` for backend communication and streaming. Not ready for production use.
 
-Dependencies flow: Components → Composables → Services
+`useChat` _(under development)_ lives in `composables/` as a planned high-level orchestrator that composes handlers and services into a single API.
 
 ## Usage
 
@@ -28,6 +28,9 @@ Import from specific entry points for tree-shaking:
 // Services only
 import { ChatService, type IChatService } from '@aleph-alpha/chat-kit/services';
 
+// Handlers only
+import { useMessageHandler } from '@aleph-alpha/chat-kit/handlers';
+
 // Composables only
 import { useChat } from '@aleph-alpha/chat-kit/composables';
 
@@ -60,8 +63,9 @@ pnpm nx run chat-kit:storybook
 ## Documentation
 
 - [Overview](./docs/overview.md) — Architecture and features
-- [Integration](./docs/integration.md) — Setup and configuration
-- [API Reference](./docs/reference.md) — Components, composables, and services
+- [Quick Start](./docs/quick-start.md) — Install and minimal chat UI
+- [Handlers and Services](./docs/handlers-and-services.md) — Message state, markdown, labels, services
+- [API Reference](./docs/reference.md) — Public exports (components, handlers, composables, services, types)
 - [CI/CD Flow](../../.github/documentation/GITHUB_CI_FLOW.md) — Release process and PR checks
 - [Storybook Deployment](../../.github/documentation/STORYBOOK_DEPLOYMENT.md) — Preview and production Storybook
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aleph-alpha/chat-kit",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "Chat kit package for building chat interfaces with Vue",
   "type": "module",
   "main": "./dist/index.js",