@copilotz/chat-adapter 0.4.0 → 0.5.0

package/README.md

@@ -101,7 +101,7 @@ VITE_COPILOTZ_API_KEY=your-api-key
 
 ### Real-Time Streaming
 
-Messages stream token-by-token with a thinking indicator while waiting for the first token. No configuration needed — it just works.
+Messages stream token-by-token with a unified assistant activity model. No extra configuration is needed for live lifecycle parsing — it just works.
 
 ```tsx
 <CopilotzChat userId="user-123" />
@@ -111,30 +111,24 @@ Messages stream token-by-token with a thinking indicator while waiting for the f
 
 From `0.4.0` onward, the adapter treats the Copilotz live stream as a lifecycle-native contract:
 
-- `TOKEN` streams partial assistant text and reasoning
-- `TOOL_CALL` starts or updates the tool execution UI
-- `TOOL_RESULT` completes the tool execution UI
+- `TOKEN` streams partial assistant text and internal reasoning state
+- `TOOL_CALL` starts or updates assistant activity
+- `TOOL_RESULT` completes tool activity state
 - `LLM_RESULT` finalizes the active assistant turn
 - `ASSET_CREATED` remains an optional live artifact event
 - `NEW_MESSAGE` is treated as a history/artifact event, not the primary live completion signal
 
 If you stream Copilotz events through a custom bridge, keep those event names intact.
 
-### Tool Calls with Live Status
+### Assistant Activity Modes
 
-When your agent calls tools, the UI shows real-time status updates:
-
-1. **Pending** — Tool call received
-2. **Running** — Tool is executing
-3. **Completed/Failed** — Result displayed with execution time
-
-All automatic. Just enable tool display in config:
+When your agent thinks or calls tools, the adapter normalizes those lifecycle events into one activity model for the UI. Configure the surface with `activityDisplay`:
 
 ```tsx
 <CopilotzChat
   userId="user-123"
   config={{
-    features: { enableToolCallsDisplay: true },
+    features: { activityDisplay: 'summary' },
   }}
 />
 ```
@@ -371,7 +365,7 @@ function CustomChat() {
 
 ## Services
 
-### copilotzService
+### Direct API Helpers
 
 Low-level API client for direct backend communication:
 
@@ -401,7 +395,7 @@ const threads = await fetchThreads('user-123');
 const messages = await fetchThreadMessages('thread-456');
 ```
 
-### assetsService
+### Asset Helpers
 
 Resolve asset references to data URLs:
 
@@ -425,16 +419,15 @@ export { CopilotzChat } from './CopilotzChat';
 
 // Hooks
 export { useCopilotz } from './useCopilotzChat';
-export { useUrlState } from './useUrlState';
 
 // Services
 export { 
+  CopilotzRequestError,
   runCopilotzStream, 
   fetchThreads, 
   fetchThreadMessages, 
   updateThread, 
   deleteThread,
-  copilotzService,
 } from './copilotzService';
 
 export { 
@@ -452,14 +445,6 @@ export type {
   MediaAttachment, 
   MemoryItem,
 } from '@copilotz/chat-ui';
-
-// URL state types
-export type { 
-  UrlSyncConfig, 
-  UrlParamsConfig, 
-  UrlState, 
-  UseUrlStateReturn,
-} from './useUrlState';
 ```
 
 ---
@@ -501,7 +486,7 @@ function App() {
           subtitle: 'We typically reply in a few seconds',
         },
         features: {
-          enableToolCallsDisplay: true,
+          activityDisplay: 'full',
           enableFileUpload: true,
           enableAudioRecording: true,
         },

package/dist/index.d.ts

@@ -49,10 +49,6 @@ type RestMessagePageInfo = {
     oldestMessageId: string | null;
     newestMessageId: string | null;
 };
-type RestMessagePage = {
-    data: RestMessage[];
-    pageInfo: RestMessagePageInfo;
-};
 type StreamCallbacks = {
     onToken?: (token: string, isComplete: boolean, raw?: any, options?: {
         isReasoning?: boolean;
@@ -104,19 +100,8 @@ declare class CopilotzRequestError extends Error {
 declare function runCopilotzStream(options: RunOptions): Promise<CopilotzStreamResult>;
 declare function fetchThreads(userId: string, getRequestHeaders?: RequestHeadersProvider): Promise<RestThread[]>;
 declare function fetchThreadMessages(threadId: string, getRequestHeaders?: RequestHeadersProvider): Promise<RestMessage[]>;
-declare function fetchThreadMessagesPage(threadId: string, options?: {
-    limit?: number;
-    before?: string | null;
-}, getRequestHeaders?: RequestHeadersProvider): Promise<RestMessagePage>;
 declare function updateThread(threadId: string, updates: Partial<RestThread>, getRequestHeaders?: RequestHeadersProvider): Promise<any>;
 declare function deleteThread(threadId: string, getRequestHeaders?: RequestHeadersProvider): Promise<boolean>;
-declare const copilotzService: {
-    runCopilotzStream: typeof runCopilotzStream;
-    fetchThreads: typeof fetchThreads;
-    fetchThreadMessages: typeof fetchThreadMessages;
-    updateThread: typeof updateThread;
-    deleteThread: typeof deleteThread;
-};
 
 interface CopilotzChatProps {
     userId: string;
@@ -221,72 +206,6 @@ declare function useCopilotz({ userId, initialContext, bootstrap, defaultThreadN
     reset: () => void;
 };
 
-/**
- * Configuration for URL parameter names
- */
-interface UrlParamsConfig {
-    /** URL param name for thread ID (default: 'thread') */
-    thread?: string;
-    /** URL param name for agent ID (default: 'agent') */
-    agent?: string;
-    /** URL param name for initial prompt (default: 'prompt') */
-    prompt?: string;
-}
-/**
- * URL sync behavior configuration
- */
-interface UrlSyncConfig {
-    /** Enable/disable URL sync (default: true) */
-    enabled?: boolean;
-    /**
-     * How to update the URL when state changes:
-     * - 'push': Creates browser history entries (back button works)
-     * - 'replace': Updates URL without history entries (default)
-     * - 'read-only': Only reads from URL, never writes
-     */
-    mode?: 'push' | 'replace' | 'read-only';
-    /** Custom parameter names */
-    params?: UrlParamsConfig;
-    /**
-     * Behavior for the prompt parameter:
-     * - 'prefill': Pre-fills the input field (default)
-     * - 'auto-send': Automatically sends the message on load
-     */
-    promptBehavior?: 'prefill' | 'auto-send';
-    /**
-     * Whether to clear the prompt param from URL after reading
-     * Prevents re-sending on refresh (default: true)
-     */
-    clearPromptAfterRead?: boolean;
-}
-/**
- * State values parsed from URL
- */
-interface UrlState {
-    threadId: string | null;
-    agentId: string | null;
-    prompt: string | null;
-}
-/**
- * Return type of useUrlState hook
- */
-interface UseUrlStateReturn {
-    /** Current state parsed from URL */
-    state: UrlState;
-    /** Update thread ID in URL */
-    setThreadId: (threadId: string | null) => void;
-    /** Update agent ID in URL */
-    setAgentId: (agentId: string | null) => void;
-    /** Clear prompt from URL (call after consuming it) */
-    clearPrompt: () => void;
-    /** Whether URL sync is enabled */
-    isEnabled: boolean;
-}
-/**
- * Hook to manage chat state persistence via URL parameters.
- */
-declare function useUrlState(config?: UrlSyncConfig): UseUrlStateReturn;
-
 declare function getAssetDataUrl(refOrId: string): Promise<{
     dataUrl: string;
     mime?: string;
@@ -297,4 +216,4 @@ type WithMetadata = {
 };
 declare function resolveAssetsInMessages<T extends WithMetadata>(messages: T[]): Promise<T[]>;
 
-export { CopilotzChat, CopilotzRequestError, type CopilotzStreamResult, type EventInterceptor, type EventInterceptorResult, type RenderSpecialState, type RequestHeadersProvider, type RestMessagePage, type RestMessagePageInfo, type RunErrorInterceptor, type SpecialChatState, type SpecialStateControls, type UrlParamsConfig, type UrlState, type UseUrlStateReturn, copilotzService, deleteThread, fetchThreadMessages, fetchThreadMessagesPage, fetchThreads, getAssetDataUrl, resolveAssetsInMessages, runCopilotzStream, updateThread, useCopilotz, useUrlState };
+export { CopilotzChat, CopilotzRequestError, type EventInterceptor, type EventInterceptorResult, type RenderSpecialState, type RequestHeadersProvider, type RunErrorInterceptor, type SpecialChatState, type SpecialStateControls, deleteThread, fetchThreadMessages, fetchThreads, getAssetDataUrl, resolveAssetsInMessages, runCopilotzStream, updateThread, useCopilotz };