@aleph-alpha/chat-kit 1.4.0 → 1.5.1

package/src/composables/fileUpload/types.ts

@@ -0,0 +1,409 @@
+import type { ComputedRef, MaybeRef, Ref } from 'vue';
+
+// ---------------------------------------------------------------------------
+//  HTTP Client
+// ---------------------------------------------------------------------------
+
+export interface RequestConfig {
+  signal?: AbortSignal;
+  onUploadProgress?: (event: { loaded: number; total: number }) => void;
+}
+
+export interface SseEvent {
+  event: string;
+  data: string;
+}
+
+export interface SseStream {
+  subscribe(callback: (event: SseEvent) => void): void;
+  close(): void;
+}
+
+export interface HttpClient {
+  get<T>(url: string, config?: RequestConfig): Promise<T>;
+  post<T>(url: string, body: unknown, config?: RequestConfig): Promise<T>;
+  delete<T>(url: string, config?: RequestConfig): Promise<T>;
+  stream(url: string, config?: RequestConfig): SseStream;
+}
+
+// ---------------------------------------------------------------------------
+//  Endpoint Resolver
+// ---------------------------------------------------------------------------
+
+export interface EndpointResolver {
+  files: (storeId: string) => string;
+  file: (storeId: string, fileId: string) => string;
+  filePublicUrl: (storeId: string, fileId: string) => string;
+  workflowRun: (storeId: string, workflowId: string) => string;
+  workflowRunEventStream: (
+    storeId: string,
+    workflowId: string,
+    runId: string,
+  ) => string;
+}
+
+export const defaultEndpoints: EndpointResolver = {
+  files: (storeId) => `search-stores/${storeId}/files`,
+  file: (storeId, fileId) => `search-stores/${storeId}/files/${fileId}`,
+  filePublicUrl: (storeId, fileId) =>
+    `search-stores/${storeId}/files/${fileId}/public-urls?ttl=1h`,
+  workflowRun: (storeId, workflowId) =>
+    `search-stores/${storeId}/workflows/${workflowId}/runs`,
+  workflowRunEventStream: (storeId, workflowId, runId) =>
+    `search-stores/${storeId}/workflows/${workflowId}/runs/${runId}/event-stream`,
+};
+
+// ---------------------------------------------------------------------------
+//  Domain Models
+// ---------------------------------------------------------------------------
+
+export interface RemoteFile {
+  id: string;
+  name: string;
+  size: number;
+  mime_type: string;
+  created_at: string;
+  updated_at: string;
+  metadata: Record<string, unknown>;
+}
+
+// ---------------------------------------------------------------------------
+//  File Constraints & Validation
+// ---------------------------------------------------------------------------
+
+export interface FileConstraints {
+  allowedMimeTypes: string[];
+  allowedExtensions: string[];
+  maxFileSizeBytes: number;
+  maxFilesPerUpload: number;
+}
+
+export type ValidatorFn = (
+  file: File,
+  constraints: FileConstraints,
+) => ValidationResult | Promise<ValidationResult>;
+
+export interface ValidationResult {
+  valid: boolean;
+  reason?: string;
+}
+
+// ---------------------------------------------------------------------------
+//  File State
+// ---------------------------------------------------------------------------
+
+export type FileStatus =
+  | 'queued'
+  | 'validating'
+  | 'uploading'
+  | 'processing'
+  | 'success'
+  | 'failed'
+  | 'cancelled'
+  | 'removing'
+  | 'removed';
+
+export type ThumbnailStrategy = 'canvas' | 'icon-fallback';
+
+export interface FileThumbnail {
+  dataUrl: string;
+  width: number;
+  height: number;
+  generatedAt: string;
+  strategy: ThumbnailStrategy;
+}
+
+export interface FileUploadError {
+  code: string;
+  message: string;
+  httpStatus?: number;
+  details?: unknown;
+  occurredAt: string;
+}
+
+export interface FileEntry {
+  id: string;
+  groupId: string;
+  fileName: string;
+  fileSize: number;
+  fileType: string;
+
+  status: FileStatus;
+  progress: number;
+
+  queuedAt: string;
+  uploadStartedAt: string | null;
+  uploadCompletedAt: string | null;
+  cancelledAt: string | null;
+  removedAt: string | null;
+
+  uploadDurationMs: number | null;
+  remoteFileId: string | null;
+  error: FileUploadError | null;
+
+  attemptCount: number;
+  lastAttemptAt: string | null;
+
+  thumbnail: FileThumbnail | null;
+  metadata: Record<string, unknown>;
+}
+
+export type FileStateMap = Map<string, FileEntry>;
+
+// ---------------------------------------------------------------------------
+//  Upload
+// ---------------------------------------------------------------------------
+
+export interface UploadParams {
+  id: string;
+  files: File | File[];
+  metadata?: Record<string, unknown>;
+  forwardedProps?: Record<string, unknown>;
+  signal?: AbortSignal;
+}
+
+export interface UploadResult {
+  id: string;
+  results: UploadFileResult[];
+}
+
+export interface UploadFileResult {
+  fileId: string;
+  success: boolean;
+  status: FileStatus;
+  remoteFileId?: string;
+  error?: FileUploadError;
+  uploadDate: string;
+  metadata?: Record<string, unknown>;
+}
+
+// ---------------------------------------------------------------------------
+//  File Removal
+// ---------------------------------------------------------------------------
+
+export interface RemoveFileOptions {
+  removeFromState?: boolean;
+  removeFromRemote?: boolean;
+}
+
+// ---------------------------------------------------------------------------
+//  Retry
+// ---------------------------------------------------------------------------
+
+export interface RetryPolicy {
+  maxRetries: number;
+  delayMs: number;
+  backoffMultiplier?: number;
+  retryableStatusCodes?: number[];
+}
+
+// ---------------------------------------------------------------------------
+//  Persistence
+// ---------------------------------------------------------------------------
+
+export interface PersistOptions {
+  dbName?: string;
+  storeName?: string;
+  debounceMs?: number;
+  maxAge?: number;
+  filter?: (entry: FileEntry) => boolean;
+}
+
+// ---------------------------------------------------------------------------
+//  Events
+// ---------------------------------------------------------------------------
+
+export type UploadEvent =
+  | { type: 'file:queued'; fileId: string; entry: FileEntry }
+  | { type: 'file:validating'; fileId: string }
+  | { type: 'file:uploading'; fileId: string; attemptCount: number }
+  | { type: 'file:progress'; fileId: string; progress: number }
+  | {
+      type: 'file:success';
+      fileId: string;
+      remoteFileId: string;
+      durationMs: number;
+    }
+  | { type: 'file:failed'; fileId: string; error: FileUploadError }
+  | { type: 'file:cancelled'; fileId: string }
+  | { type: 'file:removed'; fileId: string }
+  | { type: 'file:thumbnail-failed'; fileId: string; reason: string }
+  | { type: 'upload:complete'; groupId: string; results: UploadFileResult[] }
+  | { type: 'workflow:started'; runId: string }
+  | { type: 'workflow:event'; event: WorkflowRunEvent }
+  | { type: 'workflow:completed'; runId: string }
+  | {
+      type: 'workflow:failed';
+      runId: string;
+      error: { code: string; message: string };
+    }
+  | { type: 'state:restored'; entryCount: number }
+  | { type: 'state:persisted'; entryCount: number }
+  | { type: 'state:persist-error'; error: Error };
+
+// ---------------------------------------------------------------------------
+//  Scoped View
+// ---------------------------------------------------------------------------
+
+export interface ScopedFileView {
+  files: ComputedRef<FileEntry[]>;
+  count: ComputedRef<number>;
+  progress: ComputedRef<number>;
+  isUploading: ComputedRef<boolean>;
+  hasErrors: ComputedRef<boolean>;
+  clear: () => void;
+  cancel: () => void;
+  retry: (fileId: string) => void;
+}
+
+// ---------------------------------------------------------------------------
+//  Workflow
+// ---------------------------------------------------------------------------
+
+export interface WorkflowRunInput {
+  source: string;
+}
+
+export type WorkflowRunStatus =
+  | 'connecting'
+  | 'running'
+  | 'completed'
+  | 'failed'
+  | 'cancelled';
+
+export interface WorkflowRunEvent {
+  id: string;
+  status: string;
+}
+
+export interface WorkflowRun {
+  runId: string;
+  workflowId: string;
+  storeId: string;
+  status: WorkflowRunStatus;
+  events: WorkflowRunEvent[];
+  error: { code: string; message: string } | null;
+  startedAt: string;
+  completedAt: string | null;
+}
+
+export interface WorkflowStream {
+  close(): void;
+}
+
+// ---------------------------------------------------------------------------
+//  Error
+// ---------------------------------------------------------------------------
+
+export type ErrorCode =
+  | 'NO_ACTIVE_STORE'
+  | 'STORE_NOT_FOUND'
+  | 'FILE_TOO_LARGE'
+  | 'FILE_TYPE_NOT_ALLOWED'
+  | 'MAX_FILES_EXCEEDED'
+  | 'VALIDATION_FAILED'
+  | 'UPLOAD_FAILED'
+  | 'UPLOAD_ABORTED'
+  | 'REMOVE_FAILED'
+  | 'WORKFLOW_NOT_FOUND'
+  | 'WORKFLOW_RUN_FAILED'
+  | 'NETWORK_ERROR'
+  | 'UPLOAD_INTERRUPTED'
+  | 'REMOVE_INTERRUPTED';
+
+export class SdkError extends Error {
+  constructor(
+    public readonly code: ErrorCode,
+    message: string,
+    public readonly details?: unknown,
+  ) {
+    super(message);
+    this.name = 'SdkError';
+  }
+}
+
+// ---------------------------------------------------------------------------
+//  Document Upload Provider Config
+// ---------------------------------------------------------------------------
+
+export interface SearchStoreModel {
+  type: string;
+  dimension: number;
+  distance: string;
+  modality: string;
+  embedding_model: string;
+}
+
+export interface DocumentUploadConfig {
+  baseUrl: string;
+  userId: string;
+  workflowId: string;
+  searchStoreConfig: {
+    models: SearchStoreModel[];
+    fusion_strategy: Record<string, unknown>;
+  };
+  workflowConfig: Record<string, unknown>;
+  persist?: boolean;
+  maxConcurrency?: number;
+  headers?: Record<string, string>;
+  onEvent?: (event: UploadEvent) => void;
+}
+
+export interface DocumentUploadProvider {
+  useDocumentUpload: (
+    conversationIdRef: MaybeRef<string>,
+  ) => DocumentUploadReturn;
+}
+
+export interface DocumentUploadReturn {
+  upload: UseFileUploadReturn;
+  storeId: Ref<string>;
+  fileInput: Ref<HTMLInputElement | null>;
+  uploadFiles: (files: File[]) => Promise<UploadResult | undefined>;
+  unassignedFiles: ComputedRef<FileEntry[]>;
+  assignFilesToMessage: (messageId: string) => void;
+  getFilesForMessage: (messageId: string) => FileEntry[];
+  stampResponseId: (responseId: string, localMessageId: string) => void;
+  purgeCompletedFiles: () => void;
+  handleFilesSelected: (event: Event) => void;
+}
+
+// ---------------------------------------------------------------------------
+//  Composable Options & Return
+// ---------------------------------------------------------------------------
+
+export interface UseFileUploadOptions {
+  client: HttpClient;
+  storeId?: string;
+  workflowId: string;
+  endpoints?: EndpointResolver;
+  persist?: PersistOptions | boolean;
+  maxConcurrency?: number;
+  retryPolicy?: RetryPolicy;
+  validators?: ValidatorFn[];
+  onEvent?: (event: UploadEvent) => void;
+}
+
+export interface UseFileUploadReturn {
+  getSupportedFileTypes: () => FileConstraints;
+
+  upload: (params: UploadParams) => Promise<UploadResult>;
+  cancel: (groupId: string) => void;
+  removeFile: (fileId: string, options?: RemoveFileOptions) => Promise<void>;
+
+  files: Ref<FileStateMap>;
+  getFileState: (id: string) => FileEntry | undefined;
+  updateFileMetadata: (id: string, meta: Record<string, unknown>) => void;
+  clearState: () => void;
+  setStoreId: (id: string) => void;
+  getPublicUrl: (fileId: string) => Promise<string>;
+
+  scopeBy: (metadataKey: string, value: string) => ScopedFileView;
+
+  workflowRun: Ref<WorkflowRun | null>;
+  runWorkflow: (fileIds: string[]) => Promise<WorkflowStream>;
+
+  isRestoring: Ref<boolean>;
+  restoreState: () => Promise<void>;
+  purgePersistedState: () => Promise<void>;
+}