@informedai/react 0.1.0

package/README.md

@@ -0,0 +1,133 @@
+# @informedai/react
+
+React SDK for [InformedAI Assistant](https://informedassistant.ai) - AI-powered content creation widget informed by your knowledge base.
+
+## Installation
+
+```bash
+npm install @informedai/react
+```
+
+## Quick Start
+
+```tsx
+import { InformedAssistant } from '@informedai/react';
+
+function App() {
+  return (
+    <InformedAssistant
+      apiKey="wsk_..."
+      documentId="doc_123"
+      onFieldApply={(field, value) => {
+        console.log(`Applied ${value} to ${field}`);
+      }}
+    />
+  );
+}
+```
+
+## Features
+
+- **AI-Powered Widget** - Embeddable chat widget for content creation
+- **Knowledge-Informed** - Responses powered by your domain knowledge
+- **Real-time Streaming** - SSE streaming for instant AI responses
+- **Pending Values** - Preview suggestions before applying
+- **Customizable Theme** - Match your brand colors
+- **TypeScript Support** - Full type definitions included
+
+## Props
+
+| Prop | Type | Required | Description |
+|------|------|----------|-------------|
+| `apiKey` | `string` | Yes | Your workspace API key |
+| `documentId` | `string` | Yes | Document to work with |
+| `apiUrl` | `string` | No | Custom API URL (default: production) |
+| `sessionId` | `string` | No | Resume existing session |
+| `onFieldApply` | `(field, value) => void` | No | Called when value is applied |
+| `onSessionChange` | `(session) => void` | No | Called on session state change |
+| `onError` | `(error) => void` | No | Called on errors |
+| `theme` | `WidgetTheme` | No | Custom theme colors |
+| `position` | `'inline' \| 'bottom-right' \| 'bottom-left'` | No | Widget position |
+| `defaultCollapsed` | `boolean` | No | Start collapsed (floating only) |
+
+## Theming
+
+```tsx
+<InformedAssistant
+  apiKey="wsk_..."
+  documentId="doc_123"
+  theme={{
+    primaryColor: '#3b82f6',
+    backgroundColor: '#ffffff',
+    textColor: '#1f2937',
+    borderRadius: '16px',
+    fontFamily: 'Inter, sans-serif',
+  }}
+/>
+```
+
+## Advanced Usage
+
+### Using Hooks
+
+For custom UI implementations:
+
+```tsx
+import { useSession, useDocument } from '@informedai/react';
+
+function CustomWidget() {
+  const { session, sendMessage, applyPendingValue, isStreaming } = useSession({
+    apiKey: 'wsk_...',
+    documentId: 'doc_123',
+  });
+
+  const { document, documentType } = useDocument({
+    apiKey: 'wsk_...',
+    documentId: 'doc_123',
+  });
+
+  // Build your own UI
+}
+```
+
+### Using Context Provider
+
+For shared state across components:
+
+```tsx
+import { InformedAIProvider, useInformedAI } from '@informedai/react';
+
+function App() {
+  return (
+    <InformedAIProvider
+      config={{
+        apiKey: 'wsk_...',
+        documentId: 'doc_123',
+      }}
+    >
+      <CustomWidget />
+      <FieldPreviews />
+    </InformedAIProvider>
+  );
+}
+
+function CustomWidget() {
+  const { session, sendMessage, isStreaming } = useInformedAI();
+  // ...
+}
+```
+
+## Requirements
+
+- React 18+
+- An InformedAI workspace with API key
+
+## Links
+
+- [Documentation](https://informedassistant.ai/docs)
+- [Dashboard](https://informedassistant.ai/dashboard)
+- [GitHub](https://github.com/marolence/informedai-assistant-react-sdk)
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,234 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+
+/**
+ * InformedAI React SDK Types
+ */
+interface Session {
+    id: string;
+    documentId: string;
+    widgetMessages: WidgetMessage[];
+    taskStates: Record<string, TaskState>;
+    activeTask: string | null;
+    aiConversations: Record<string, ChatMessage[]>;
+}
+interface WidgetMessage {
+    id: string;
+    role: 'user' | 'assistant' | 'system';
+    content: string;
+    type: 'text' | 'quick_actions' | 'task_intro' | 'pending_preview';
+    quickActions?: QuickAction[];
+    timestamp: string;
+}
+interface QuickAction {
+    id: string;
+    label: string;
+    action: string;
+    payload?: Record<string, unknown>;
+}
+interface TaskState {
+    status: 'pending' | 'active' | 'paused' | 'completed' | 'skipped';
+    pendingValue?: unknown;
+}
+interface ChatMessage {
+    role: 'system' | 'user' | 'assistant';
+    content: string;
+}
+interface FieldDefinition {
+    type: 'string' | 'number' | 'boolean' | 'richtext' | 'array' | 'image';
+    label: string;
+    description?: string;
+}
+interface DocumentTypeSchema {
+    fields: Record<string, FieldDefinition>;
+}
+interface DocumentType {
+    id: string;
+    workspaceId: string;
+    name: string;
+    displayName: string;
+    schema: DocumentTypeSchema;
+    taskConfigs: Record<string, TaskConfig>;
+    createdAt: string;
+    updatedAt: string;
+}
+interface TaskConfig {
+    templateId?: string;
+    enabled?: boolean;
+}
+interface Document {
+    id: string;
+    documentTypeId: string;
+    data: Record<string, unknown>;
+    version: number;
+    createdAt: string;
+    updatedAt: string;
+    documentType?: {
+        id?: string;
+        name: string;
+        displayName: string;
+        schema?: DocumentTypeSchema;
+    };
+}
+interface InformedAssistantConfig {
+    /** API key for authentication (wsk_...) */
+    apiKey: string;
+    /** API base URL (defaults to https://api.informedassistant.ai/api/v1) */
+    apiUrl?: string;
+    /** Document ID to work with */
+    documentId: string;
+    /** Optional: Existing session ID to resume */
+    sessionId?: string;
+    /** Callback when a field value is applied */
+    onFieldApply?: (fieldName: string, value: unknown) => void;
+    /** Callback when session state changes */
+    onSessionChange?: (session: Session) => void;
+    /** Callback when an error occurs */
+    onError?: (error: Error) => void;
+    /** Custom theme overrides */
+    theme?: Partial<WidgetTheme>;
+    /** Position of the widget (for floating mode) */
+    position?: 'bottom-right' | 'bottom-left' | 'inline';
+    /** Initial collapsed state */
+    defaultCollapsed?: boolean;
+}
+interface WidgetTheme {
+    /** Primary accent color */
+    primaryColor: string;
+    /** Background color */
+    backgroundColor: string;
+    /** Text color */
+    textColor: string;
+    /** Border radius */
+    borderRadius: string;
+    /** Font family */
+    fontFamily: string;
+}
+interface SSEEvent {
+    type: 'content' | 'done' | 'error' | 'session_update';
+    content?: string;
+    session?: Session;
+    error?: string;
+}
+interface UseSessionReturn {
+    session: Session | null;
+    isLoading: boolean;
+    error: Error | null;
+    sendMessage: (message: string) => Promise<void>;
+    sendQuickAction: (action: string, payload?: Record<string, unknown>) => Promise<void>;
+    applyPendingValue: () => Promise<void>;
+    skipTask: () => Promise<void>;
+}
+interface UseDocumentReturn {
+    document: Document | null;
+    documentType: DocumentType | null;
+    isLoading: boolean;
+    error: Error | null;
+    updateField: (fieldName: string, value: unknown) => Promise<void>;
+    refetch: () => Promise<void>;
+}
+
+interface InformedAssistantProps extends InformedAssistantConfig {
+    /** Additional CSS class name */
+    className?: string;
+}
+/**
+ * InformedAssistant - AI-powered content assistant widget
+ *
+ * @example
+ * ```tsx
+ * <InformedAssistant
+ *   apiKey="wsk_..."
+ *   documentId="doc_123"
+ *   onFieldApply={(field, value) => updateForm(field, value)}
+ * />
+ * ```
+ */
+declare function InformedAssistant({ className, ...config }: InformedAssistantProps): react_jsx_runtime.JSX.Element;
+
+interface InformedAIContextValue {
+    session: Session | null;
+    document: Document | null;
+    documentType: DocumentType | null;
+    isLoading: boolean;
+    isStreaming: boolean;
+    error: Error | null;
+    streamingContent: string;
+    sendMessage: (message: string) => Promise<void>;
+    sendQuickAction: (action: string, payload?: Record<string, unknown>) => Promise<void>;
+    applyPendingValue: () => Promise<void>;
+    skipTask: () => Promise<void>;
+    clearError: () => void;
+}
+declare function useInformedAI(): InformedAIContextValue;
+interface InformedAIProviderProps {
+    config: InformedAssistantConfig;
+    children: React.ReactNode;
+}
+declare function InformedAIProvider({ config, children }: InformedAIProviderProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * useSession Hook
+ * For developers who want direct access to session management
+ */
+
+interface UseSessionOptions {
+    apiKey: string;
+    apiUrl?: string;
+    documentId: string;
+    sessionId?: string;
+    onSessionChange?: (session: Session) => void;
+    onError?: (error: Error) => void;
+}
+declare function useSession(options: UseSessionOptions): UseSessionReturn;
+
+/**
+ * useDocument Hook
+ * For developers who want direct access to document management
+ */
+
+interface UseDocumentOptions {
+    apiKey: string;
+    apiUrl?: string;
+    documentId: string;
+    onError?: (error: Error) => void;
+}
+declare function useDocument(options: UseDocumentOptions): UseDocumentReturn;
+
+/**
+ * InformedAI API Client
+ * Handles all communication with the InformedAI backend
+ */
+
+declare class InformedAIClient {
+    private apiKey;
+    private apiUrl;
+    constructor(apiKey: string, apiUrl?: string);
+    private getHeaders;
+    private request;
+    getDocument(id: string): Promise<Document>;
+    getDocumentType(id: string): Promise<DocumentType>;
+    updateDocumentField(documentId: string, field: string, value: unknown): Promise<Document>;
+    createSession(documentId: string): Promise<Session>;
+    getSession(id: string): Promise<Session>;
+    deleteSession(id: string): Promise<void>;
+    /**
+     * Send a message to the session with SSE streaming
+     */
+    sendMessage(sessionId: string, message: string, onEvent: (event: SSEEvent) => void): Promise<void>;
+    /**
+     * Send a quick action to the session with SSE streaming
+     */
+    sendQuickAction(sessionId: string, action: string, payload?: Record<string, unknown>, onEvent?: (event: SSEEvent) => void): Promise<Session>;
+    /**
+     * Apply the pending value for the active task
+     */
+    applyPendingValue(sessionId: string): Promise<Session>;
+    /**
+     * Skip the active task
+     */
+    skipTask(sessionId: string): Promise<Session>;
+    private processSSEStream;
+}
+
+export { type ChatMessage, type Document, type DocumentType, type DocumentTypeSchema, type FieldDefinition, InformedAIClient, InformedAIProvider, InformedAssistant, type InformedAssistantConfig, type QuickAction, type SSEEvent, type Session, type TaskConfig, type TaskState, type UseDocumentReturn, type UseSessionReturn, type WidgetMessage, type WidgetTheme, useDocument, useInformedAI, useSession };

package/dist/index.d.ts

@@ -0,0 +1,234 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+
+/**
+ * InformedAI React SDK Types
+ */
+interface Session {
+    id: string;
+    documentId: string;
+    widgetMessages: WidgetMessage[];
+    taskStates: Record<string, TaskState>;
+    activeTask: string | null;
+    aiConversations: Record<string, ChatMessage[]>;
+}
+interface WidgetMessage {
+    id: string;
+    role: 'user' | 'assistant' | 'system';
+    content: string;
+    type: 'text' | 'quick_actions' | 'task_intro' | 'pending_preview';
+    quickActions?: QuickAction[];
+    timestamp: string;
+}
+interface QuickAction {
+    id: string;
+    label: string;
+    action: string;
+    payload?: Record<string, unknown>;
+}
+interface TaskState {
+    status: 'pending' | 'active' | 'paused' | 'completed' | 'skipped';
+    pendingValue?: unknown;
+}
+interface ChatMessage {
+    role: 'system' | 'user' | 'assistant';
+    content: string;
+}
+interface FieldDefinition {
+    type: 'string' | 'number' | 'boolean' | 'richtext' | 'array' | 'image';
+    label: string;
+    description?: string;
+}
+interface DocumentTypeSchema {
+    fields: Record<string, FieldDefinition>;
+}
+interface DocumentType {
+    id: string;
+    workspaceId: string;
+    name: string;
+    displayName: string;
+    schema: DocumentTypeSchema;
+    taskConfigs: Record<string, TaskConfig>;
+    createdAt: string;
+    updatedAt: string;
+}
+interface TaskConfig {
+    templateId?: string;
+    enabled?: boolean;
+}
+interface Document {
+    id: string;
+    documentTypeId: string;
+    data: Record<string, unknown>;
+    version: number;
+    createdAt: string;
+    updatedAt: string;
+    documentType?: {
+        id?: string;
+        name: string;
+        displayName: string;
+        schema?: DocumentTypeSchema;
+    };
+}
+interface InformedAssistantConfig {
+    /** API key for authentication (wsk_...) */
+    apiKey: string;
+    /** API base URL (defaults to https://api.informedassistant.ai/api/v1) */
+    apiUrl?: string;
+    /** Document ID to work with */
+    documentId: string;
+    /** Optional: Existing session ID to resume */
+    sessionId?: string;
+    /** Callback when a field value is applied */
+    onFieldApply?: (fieldName: string, value: unknown) => void;
+    /** Callback when session state changes */
+    onSessionChange?: (session: Session) => void;
+    /** Callback when an error occurs */
+    onError?: (error: Error) => void;
+    /** Custom theme overrides */
+    theme?: Partial<WidgetTheme>;
+    /** Position of the widget (for floating mode) */
+    position?: 'bottom-right' | 'bottom-left' | 'inline';
+    /** Initial collapsed state */
+    defaultCollapsed?: boolean;
+}
+interface WidgetTheme {
+    /** Primary accent color */
+    primaryColor: string;
+    /** Background color */
+    backgroundColor: string;
+    /** Text color */
+    textColor: string;
+    /** Border radius */
+    borderRadius: string;
+    /** Font family */
+    fontFamily: string;
+}
+interface SSEEvent {
+    type: 'content' | 'done' | 'error' | 'session_update';
+    content?: string;
+    session?: Session;
+    error?: string;
+}
+interface UseSessionReturn {
+    session: Session | null;
+    isLoading: boolean;
+    error: Error | null;
+    sendMessage: (message: string) => Promise<void>;
+    sendQuickAction: (action: string, payload?: Record<string, unknown>) => Promise<void>;
+    applyPendingValue: () => Promise<void>;
+    skipTask: () => Promise<void>;
+}
+interface UseDocumentReturn {
+    document: Document | null;
+    documentType: DocumentType | null;
+    isLoading: boolean;
+    error: Error | null;
+    updateField: (fieldName: string, value: unknown) => Promise<void>;
+    refetch: () => Promise<void>;
+}
+
+interface InformedAssistantProps extends InformedAssistantConfig {
+    /** Additional CSS class name */
+    className?: string;
+}
+/**
+ * InformedAssistant - AI-powered content assistant widget
+ *
+ * @example
+ * ```tsx
+ * <InformedAssistant
+ *   apiKey="wsk_..."
+ *   documentId="doc_123"
+ *   onFieldApply={(field, value) => updateForm(field, value)}
+ * />
+ * ```
+ */
+declare function InformedAssistant({ className, ...config }: InformedAssistantProps): react_jsx_runtime.JSX.Element;
+
+interface InformedAIContextValue {
+    session: Session | null;
+    document: Document | null;
+    documentType: DocumentType | null;
+    isLoading: boolean;
+    isStreaming: boolean;
+    error: Error | null;
+    streamingContent: string;
+    sendMessage: (message: string) => Promise<void>;
+    sendQuickAction: (action: string, payload?: Record<string, unknown>) => Promise<void>;
+    applyPendingValue: () => Promise<void>;
+    skipTask: () => Promise<void>;
+    clearError: () => void;
+}
+declare function useInformedAI(): InformedAIContextValue;
+interface InformedAIProviderProps {
+    config: InformedAssistantConfig;
+    children: React.ReactNode;
+}
+declare function InformedAIProvider({ config, children }: InformedAIProviderProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * useSession Hook
+ * For developers who want direct access to session management
+ */
+
+interface UseSessionOptions {
+    apiKey: string;
+    apiUrl?: string;
+    documentId: string;
+    sessionId?: string;
+    onSessionChange?: (session: Session) => void;
+    onError?: (error: Error) => void;
+}
+declare function useSession(options: UseSessionOptions): UseSessionReturn;
+
+/**
+ * useDocument Hook
+ * For developers who want direct access to document management
+ */
+
+interface UseDocumentOptions {
+    apiKey: string;
+    apiUrl?: string;
+    documentId: string;
+    onError?: (error: Error) => void;
+}
+declare function useDocument(options: UseDocumentOptions): UseDocumentReturn;
+
+/**
+ * InformedAI API Client
+ * Handles all communication with the InformedAI backend
+ */
+
+declare class InformedAIClient {
+    private apiKey;
+    private apiUrl;
+    constructor(apiKey: string, apiUrl?: string);
+    private getHeaders;
+    private request;
+    getDocument(id: string): Promise<Document>;
+    getDocumentType(id: string): Promise<DocumentType>;
+    updateDocumentField(documentId: string, field: string, value: unknown): Promise<Document>;
+    createSession(documentId: string): Promise<Session>;
+    getSession(id: string): Promise<Session>;
+    deleteSession(id: string): Promise<void>;
+    /**
+     * Send a message to the session with SSE streaming
+     */
+    sendMessage(sessionId: string, message: string, onEvent: (event: SSEEvent) => void): Promise<void>;
+    /**
+     * Send a quick action to the session with SSE streaming
+     */
+    sendQuickAction(sessionId: string, action: string, payload?: Record<string, unknown>, onEvent?: (event: SSEEvent) => void): Promise<Session>;
+    /**
+     * Apply the pending value for the active task
+     */
+    applyPendingValue(sessionId: string): Promise<Session>;
+    /**
+     * Skip the active task
+     */
+    skipTask(sessionId: string): Promise<Session>;
+    private processSSEStream;
+}
+
+export { type ChatMessage, type Document, type DocumentType, type DocumentTypeSchema, type FieldDefinition, InformedAIClient, InformedAIProvider, InformedAssistant, type InformedAssistantConfig, type QuickAction, type SSEEvent, type Session, type TaskConfig, type TaskState, type UseDocumentReturn, type UseSessionReturn, type WidgetMessage, type WidgetTheme, useDocument, useInformedAI, useSession };