@aleph-alpha/chat-kit 1.4.0 → 1.5.1

package/dist/index.d.ts

@@ -1,8 +1,7 @@
 export { type ChatConfig, type ChatMessage, type ChatResponse, type ConversationSummary, type HttpClient, type RawConversation, type RawConversationList, type StreamEvent, } from './services';
 export { useMessageHandler, useMarkdownParser, provideChatKitLabels, useChatKitLabels, defaultChatKitLabels, CHAT_KIT_LABELS, } from './handlers';
 export type { ChatKitLabels } from './handlers';
-export { useChat, useConversationSessions, useConversations, } from './composables';
-export type { ChatActions, ChatState, ConversationSession, CreateConversationInput, MessageHandler, MutationOptions, UseChatReturn, UseConversationSessionsReturn, UseConversationsOptions, UseConversationsReturn, } from './composables';
+export * from './composables';
 export { CkAgentMessage, CkConversation, CkConversationLayout, CkCopyMessageActionButton, CkFeedbackButton, CkHistory, CkHistoryItem, CkHistoryWrapper, CkInput, CkMarkdownRenderer, CkMessageActionButton, CkPromptActionButton, CkPromptStopButton, CkPromptInput, CkPromptInputDisclaimer, CkSendIcon, CkStopIcon, CkUserMessage, } from './components';
 export type { CkConversationLayoutProps, CkConversationProps, CkFeedbackButtonProps, CkFeedbackValue, CkHistoryEmits, CkHistoryItemEmits, CkHistoryItemProps, CkHistoryProps, CkHistoryWrapperProps, CkMarkdownElementClasses, CkMarkdownRendererProps, CkUserMessageProps, } from './components';
 export type { BaseMessage, Conversation, ConversationTree, MessageContent, MessageContentStatus, MessageReasoningContent, MessageRole, MessageStatus, MessageTextContent, MessageToolContent, TreeMessage, } from './types';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,WAAW,GACjB,MAAM,YAAY,CAAC;AASpB,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,oBAAoB,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAGhD,OAAO,EACL,OAAO,EACP,uBAAuB,EACvB,gBAAgB,GACjB,MAAM,eAAe,CAAC;AACvB,YAAY,EACV,WAAW,EACX,SAAS,EACT,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,EACd,eAAe,EACf,aAAa,EACb,6BAA6B,EAC7B,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,eAAe,CAAC;AAGvB,OAAO,EACL,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,yBAAyB,EACzB,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,gBAAgB,EAChB,OAAO,EACP,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,kBAAkB,EAClB,aAAa,EACb,uBAAuB,EACvB,UAAU,EACV,UAAU,EACV,aAAa,GACd,MAAM,cAAc,CAAC;AACtB,YAAY,EACV,yBAAyB,EACzB,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,qBAAqB,EACrB,wBAAwB,EACxB,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,cAAc,CAAC;AAGtB,YAAY,EACV,WAAW,EACX,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACpB,uBAAuB,EACvB,WAAW,EACX,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,WAAW,GACZ,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,WAAW,GACjB,MAAM,YAAY,CAAC;AASpB,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,oBAAoB,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAGhD,cAAc,eAAe,CAAC;AAG9B,OAAO,EACL,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,yBAAyB,EACzB,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,gBAAgB,EAChB,OAAO,EACP,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,kBAAkB,EAClB,aAAa,EACb,uBAAuB,EACvB,UAAU,EACV,UAAU,EACV,aAAa,GACd,MAAM,cAAc,CAAC;AACtB,YAAY,EACV,yBAAyB,EACzB,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,qBAAqB,EACrB,wBAAwB,EACxB,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,cAAc,CAAC;AAGtB,YAAY,EACV,WAAW,EACX,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACpB,uBAAuB,EACvB,WAAW,EACX,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,WAAW,GACZ,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -1,16 +1,16 @@
 import { u } from "./useMessageHandler-ZRC-gIOJ.js";
 import { C, d, p, u as u2, a } from "./useChatKitLabels-ftC52m7f.js";
-import { u as u3, a as a2, b } from "./useConversationSessions-GLZV_Ctr.js";
-import { _, a as a3, b as b2, C as C2, c, d as d2, e, f, g, h, i, j, k, l, m, n, o, p as p2 } from "./CkInput.vue_vue_type_script_setup_true_lang-C5C09u0z.js";
+import { c, d as d2, u as u3, a as a2, b, e } from "./index-BbTgIoYa.js";
+import { _, a as a3, b as b2, C as C2, c as c2, d as d3, e as e2, f, g, h, i, j, k, l, m, n, o, p as p2 } from "./CkInput.vue_vue_type_script_setup_true_lang-C5C09u0z.js";
 export {
   C as CHAT_KIT_LABELS,
   _ as CkAgentMessage,
   a3 as CkConversation,
   b2 as CkConversationLayout,
   C2 as CkCopyMessageActionButton,
-  c as CkFeedbackButton,
-  d2 as CkHistory,
-  e as CkHistoryItem,
+  c2 as CkFeedbackButton,
+  d3 as CkHistory,
+  e2 as CkHistoryItem,
   f as CkHistoryWrapper,
   g as CkInput,
   h as CkMarkdownRenderer,
@@ -22,12 +22,15 @@ export {
   n as CkSendIcon,
   o as CkStopIcon,
   p2 as CkUserMessage,
+  c as createDocumentUploadProvider,
   d as defaultChatKitLabels,
+  d2 as defaultDocumentUploadConfig,
   p as provideChatKitLabels,
   u3 as useChat,
   u2 as useChatKitLabels,
   a2 as useConversationSessions,
   b as useConversations,
+  e as useDocumentUploadWithDefaultConfig,
   a as useMarkdownParser,
   u as useMessageHandler
 };

package/package.json

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

package/src/composables/fileUpload/index.spec.ts

@@ -0,0 +1,213 @@
+import {
+  defaultDocumentUploadConfig,
+  createDocumentUploadProvider,
+} from './index';
+import type { DocumentUploadConfig } from './types';
+
+vi.mock('./useFileUploadWrapper', () => ({
+  createDocumentUploadProvider: vi.fn((config: DocumentUploadConfig) => ({
+    useDocumentUpload: vi.fn(() => ({
+      upload: {},
+      storeId: { value: '' },
+      fileInput: { value: null },
+      uploadFiles: vi.fn(),
+      unassignedFiles: { value: [] },
+      assignFilesToMessage: vi.fn(),
+      getFilesForMessage: vi.fn(() => []),
+      stampResponseId: vi.fn(),
+      purgeCompletedFiles: vi.fn(),
+      handleFilesSelected: vi.fn(),
+    })),
+    _config: config,
+  })),
+}));
+
+describe('fileUpload index', () => {
+  describe('defaultDocumentUploadConfig', () => {
+    it('uses the correct base URL', () => {
+      expect(defaultDocumentUploadConfig.baseUrl).toBe('/file-upload');
+    });
+
+    it('uses the correct userId', () => {
+      expect(defaultDocumentUploadConfig.userId).toBe('chat-user');
+    });
+
+    it('uses the correct workflowId', () => {
+      expect(defaultDocumentUploadConfig.workflowId).toBe('my-doc-ai');
+    });
+
+    it('configures searchStoreConfig with a dense model', () => {
+      const { searchStoreConfig } = defaultDocumentUploadConfig;
+      expect(searchStoreConfig.models).toHaveLength(1);
+      expect(searchStoreConfig.models[0]).toEqual({
+        type: 'dense',
+        dimension: 1024,
+        distance: 'cosine',
+        modality: 'text',
+        embedding_model: 'baai/bge-m3',
+      });
+    });
+
+    it('configures searchStoreConfig with rrf fusion strategy', () => {
+      expect(
+        defaultDocumentUploadConfig.searchStoreConfig.fusion_strategy,
+      ).toEqual({
+        type: 'rrf',
+      });
+    });
+
+    it('configures workflowConfig with the correct workflow name', () => {
+      const { workflowConfig } = defaultDocumentUploadConfig;
+      expect(workflowConfig.name).toBe('my-doc-ai');
+      expect(workflowConfig.workflow_name).toBe('DocumentAI');
+    });
+
+    it('configures workflowConfig definition', () => {
+      const { workflowConfig } = defaultDocumentUploadConfig;
+      expect(workflowConfig.definition).toEqual({
+        workflow_name: 'DocumentAI',
+      });
+    });
+
+    it('configures initialization parameters', () => {
+      const params = defaultDocumentUploadConfig.workflowConfig
+        .parameters as Record<string, unknown>;
+      expect(params.initialization).toEqual({
+        store: { batch_size: 10, pages_per_part: 25 },
+      });
+    });
+
+    it('configures all document extraction readers', () => {
+      const params = defaultDocumentUploadConfig.workflowConfig
+        .parameters as Record<string, unknown>;
+      const extraction = params.document_extraction as Record<string, unknown>;
+
+      expect(extraction.pdf_reader).toEqual({ kind: 'pypdf', batch_size: 10 });
+      expect(extraction.docx_reader).toEqual({
+        kind: 'docx',
+        batch_size: 10,
+        split_by_sections: false,
+      });
+      expect(extraction.pptx_reader).toEqual({
+        kind: 'pptx',
+        batch_size: 10,
+        include_notes: true,
+      });
+      expect(extraction.xlsx_reader).toEqual({
+        kind: 'xlsx',
+        batch_size: 10,
+        max_rows: 10000,
+        max_cols: 100,
+        include_empty_sheets: false,
+      });
+      expect(extraction.markdown_reader).toEqual({
+        kind: 'markdown',
+        batch_size: 10,
+      });
+      expect(extraction.plaintext_reader).toEqual({
+        kind: 'plaintext',
+        batch_size: 10,
+        max_content_size: 500000,
+        min_space_ratio: 0.02,
+      });
+    });
+
+    it('configures chunk extraction parameters', () => {
+      const params = defaultDocumentUploadConfig.workflowConfig
+        .parameters as Record<string, unknown>;
+      const chunkExtraction = params.chunk_extraction as Record<
+        string,
+        unknown
+      >;
+      expect(chunkExtraction.chunker).toEqual({
+        kind: 'naive',
+        batch_size: 1,
+        include_image_descriptions: false,
+        chunk_size: 200,
+      });
+    });
+
+    it('configures workflowConfig schema', () => {
+      const { workflowConfig } = defaultDocumentUploadConfig;
+      expect(workflowConfig.schema).toEqual({
+        type: 'object',
+        properties: {
+          source: {
+            description: 'Source path, connector URI, or list thereof',
+            anyOf: [
+              { type: 'string' },
+              { type: 'array', items: { type: 'string' } },
+            ],
+          },
+        },
+        additionalProperties: true,
+      });
+    });
+  });
+
+  describe('createDocumentUploadProvider', () => {
+    it('is re-exported from useFileUploadWrapper', () => {
+      expect(createDocumentUploadProvider).toBeDefined();
+      expect(typeof createDocumentUploadProvider).toBe('function');
+    });
+
+    it('returns a provider with useDocumentUpload', () => {
+      const provider = createDocumentUploadProvider(
+        defaultDocumentUploadConfig,
+      );
+      expect(provider).toHaveProperty('useDocumentUpload');
+      expect(typeof provider.useDocumentUpload).toBe('function');
+    });
+
+    it('passes the config to createDocumentUploadProvider', () => {
+      const customConfig: DocumentUploadConfig = {
+        baseUrl: '/custom-url',
+        userId: 'custom-user',
+        workflowId: 'custom-workflow',
+        searchStoreConfig: {
+          models: [
+            {
+              type: 'dense',
+              dimension: 512,
+              distance: 'euclidean',
+              modality: 'text',
+              embedding_model: 'custom-model',
+            },
+          ],
+          fusion_strategy: { type: 'custom' },
+        },
+        workflowConfig: { name: 'custom' },
+      };
+
+      const provider = createDocumentUploadProvider(
+        customConfig,
+      ) as unknown as {
+        useDocumentUpload: () => unknown;
+        _config: DocumentUploadConfig;
+      };
+      expect(provider._config).toBe(customConfig);
+    });
+  });
+
+  describe('useDocumentUploadWithDefaultConfig', () => {
+    it('is exported and callable', async () => {
+      const { useDocumentUploadWithDefaultConfig } = await import('./index');
+      expect(useDocumentUploadWithDefaultConfig).toBeDefined();
+      expect(typeof useDocumentUploadWithDefaultConfig).toBe('function');
+    });
+  });
+
+  describe('type exports', () => {
+    it('exports DocumentUploadConfig type', async () => {
+      const module = await import('./index');
+      expect('defaultDocumentUploadConfig' in module).toBe(true);
+    });
+
+    it('exports DocumentUploadProvider type via createDocumentUploadProvider', () => {
+      const provider = createDocumentUploadProvider(
+        defaultDocumentUploadConfig,
+      );
+      expect(provider).toBeDefined();
+    });
+  });
+});

package/src/composables/fileUpload/index.ts

@@ -0,0 +1,83 @@
+import type { DocumentUploadConfig, DocumentUploadProvider } from './types';
+import { createDocumentUploadProvider } from './useFileUploadWrapper';
+
+const WORKFLOW_ID = 'my-doc-ai';
+
+export const defaultDocumentUploadConfig: DocumentUploadConfig = {
+  baseUrl: '/file-upload',
+  userId: 'chat-user',
+  workflowId: WORKFLOW_ID,
+  searchStoreConfig: {
+    models: [
+      {
+        type: 'dense',
+        dimension: 1024,
+        distance: 'cosine',
+        modality: 'text',
+        embedding_model: 'baai/bge-m3',
+      },
+    ],
+    fusion_strategy: { type: 'rrf' },
+  },
+  workflowConfig: {
+    name: WORKFLOW_ID,
+    workflow_name: 'DocumentAI',
+    definition: { workflow_name: 'DocumentAI' },
+    parameters: {
+      initialization: {
+        store: { batch_size: 10, pages_per_part: 25 },
+      },
+      document_extraction: {
+        pdf_reader: { kind: 'pypdf', batch_size: 10 },
+        docx_reader: {
+          kind: 'docx',
+          batch_size: 10,
+          split_by_sections: false,
+        },
+        pptx_reader: { kind: 'pptx', batch_size: 10, include_notes: true },
+        xlsx_reader: {
+          kind: 'xlsx',
+          batch_size: 10,
+          max_rows: 10000,
+          max_cols: 100,
+          include_empty_sheets: false,
+        },
+        markdown_reader: { kind: 'markdown', batch_size: 10 },
+        plaintext_reader: {
+          kind: 'plaintext',
+          batch_size: 10,
+          max_content_size: 500000,
+          min_space_ratio: 0.02,
+        },
+      },
+      chunk_extraction: {
+        chunker: {
+          kind: 'naive',
+          batch_size: 1,
+          include_image_descriptions: false,
+          chunk_size: 200,
+        },
+      },
+    },
+    schema: {
+      type: 'object',
+      properties: {
+        source: {
+          description: 'Source path, connector URI, or list thereof',
+          anyOf: [
+            { type: 'string' },
+            { type: 'array', items: { type: 'string' } },
+          ],
+        },
+      },
+      additionalProperties: true,
+    },
+  },
+};
+
+const { useDocumentUpload: useDocumentUploadWithDefaultConfig } =
+  createDocumentUploadProvider(defaultDocumentUploadConfig);
+
+export { useDocumentUploadWithDefaultConfig, createDocumentUploadProvider };
+
+export type { DocumentUploadConfig, DocumentUploadProvider };