@ragbits/api-client 0.0.3 → 1.4.0-dev.202512021005

package/dist/types.d.ts

@@ -1,156 +1,16 @@
-import { RJSFSchema } from '@rjsf/utils';
-/**
- * Message roles for chat conversations
- */
-export declare enum MessageRole {
-    USER = "user",
-    ASSISTANT = "assistant",
-    SYSTEM = "system"
-}
-/**
- * Message structure for chat conversations
- */
-export interface Message {
-    role: MessageRole;
-    content: string;
-    id?: string;
-}
-/**
- * Reference structure for document references
- */
-export interface Reference {
-    title: string;
-    content: string;
-    url?: string;
-}
-/**
- * Response types from the API
- */
-export declare enum ChatResponseType {
-    MESSAGE = "message",
-    REFERENCE = "reference",
-    STATE_UPDATE = "state_update",
-    TEXT = "text",
-    MESSAGE_ID = "message_id",
-    CONVERSATION_ID = "conversation_id",
-    LIVE_UPDATE = "live_update",
-    FOLLOWUP_MESSAGES = "followup_messages"
-}
-/**
- * Feedback types for user feedback
- */
-export declare enum FeedbackType {
-    LIKE = "like",
-    DISLIKE = "dislike"
-}
-/**
- * Server state interface for state updates
- */
-export interface ServerState {
-    state: Record<string, unknown>;
-    signature: string;
-}
-export declare enum LiveUpdateType {
-    START = "START",
-    FINISH = "FINISH"
-}
-export interface LiveUpdate {
-    update_id: string;
-    type: LiveUpdateType;
-    content: {
-        label: string;
-        description?: string;
-    };
-}
-/**
- * Specific chat response types
- */
-interface MessageIdChatResponse {
-    type: ChatResponseType.MESSAGE_ID;
-    content: string;
-}
-interface TextChatResponse {
-    type: ChatResponseType.TEXT;
-    content: string;
-}
-interface ReferenceChatResponse {
-    type: ChatResponseType.REFERENCE;
-    content: Reference;
-}
-interface ConversationIdChatResponse {
-    type: ChatResponseType.CONVERSATION_ID;
-    content: string;
-}
-interface StateUpdateChatResponse {
-    type: ChatResponseType.STATE_UPDATE;
-    content: ServerState;
-}
-interface LiveUpdateChatResponse {
-    type: ChatResponseType.LIVE_UPDATE;
-    content: LiveUpdate;
-}
-interface FollowupMessagesChatResponse {
-    type: ChatResponseType.FOLLOWUP_MESSAGES;
-    content: string[];
-}
-/**
- * Typed chat response union
- */
-export type TypedChatResponse = TextChatResponse | ReferenceChatResponse | MessageIdChatResponse | ConversationIdChatResponse | StateUpdateChatResponse | LiveUpdateChatResponse | FollowupMessagesChatResponse;
-/**
- * Base chat request to the API
- */
-export interface ChatRequest {
-    message: string;
-    history: Message[];
-    context?: Record<string, unknown>;
-}
-/**
- * Feedback request to the API
- */
-export interface FeedbackRequest {
-    message_id: string;
-    feedback: FeedbackType;
-    payload: Record<string, unknown> | null;
-}
-/**
- * Feedback response from the API
- */
-export interface FeedbackResponse {
-    status: string;
-}
-/**
- * UI customization configuration
- */
-export interface UICustomization {
-    header: {
-        title?: string;
-        subtitle?: string;
-        logo?: string;
-    };
-    welcome_message?: string;
-}
-/**
- * Configuration response from the API
- */
-export interface ConfigResponse {
-    feedback: {
-        like: {
-            enabled: boolean;
-            form: RJSFSchema | null;
-        };
-        dislike: {
-            enabled: boolean;
-            form: RJSFSchema | null;
-        };
-    };
-    customization: UICustomization | null;
+import { ConfigResponse, FeedbackRequest, FeedbackResponse, ChatRequest, ChatResponse, LogoutRequest, LoginRequest, LoginResponse } from './autogen.types';
+export interface GenericResponse {
+    success: boolean;
 }
 /**
  * Configuration for the client
  */
 export interface ClientConfig {
     baseUrl?: string;
+    auth?: {
+        getToken?: () => string;
+        onUnauthorized?: () => Promise<void> | void;
+    };
 }
 /**
  * Callbacks for handling streaming responses
@@ -160,79 +20,59 @@ export interface StreamCallbacks<T, E = Error> {
     onError: (error: E) => void | Promise<void>;
     onClose?: () => void | Promise<void>;
 }
+export interface EndpointDefinition<Req = any, Res = any> {
+    method: string;
+    request: Req;
+    response: Res;
+}
 /**
- * Regular API endpoint definitions with their request/response types
+ * Base predefined API endpoint definitions with their request/response types
  */
-export interface ApiEndpoints {
-    '/api/config': {
-        method: 'GET';
-        request: never;
-        response: ConfigResponse;
-    };
-    '/api/feedback': {
-        method: 'POST';
-        request: FeedbackRequest;
-        response: FeedbackResponse;
-    };
+export interface BaseApiEndpoints {
+    '/api/config': EndpointDefinition<never, ConfigResponse>;
+    '/api/feedback': EndpointDefinition<FeedbackRequest, FeedbackResponse>;
+    '/api/auth/login': EndpointDefinition<LoginRequest, LoginResponse>;
+    '/api/auth/logout': EndpointDefinition<LogoutRequest, GenericResponse>;
+    '/api/theme': EndpointDefinition<never, string>;
 }
 /**
  * Streaming API endpoint definitions with their request/stream response types
  */
-export interface StreamingEndpoints {
-    '/api/chat': {
-        method: 'POST';
-        request: ChatRequest;
-        stream: TypedChatResponse;
-    };
+export interface BaseStreamingEndpoints {
+    '/api/chat': EndpointDefinition<ChatRequest, ChatResponse>;
 }
 /**
  * Extract endpoint paths as a union type
  */
-export type ApiEndpointPath = keyof ApiEndpoints;
-/**
- * Extract streaming endpoint paths as a union type
- */
-export type StreamingEndpointPath = keyof StreamingEndpoints;
+export type EndpointPath<Endpoints extends {
+    [K in keyof Endpoints]: EndpointDefinition;
+}> = keyof Endpoints;
 /**
  * Extract request type for a specific API endpoint
  */
-export type ApiEndpointRequest<T extends ApiEndpointPath> = ApiEndpoints[T]['request'];
+export type EndpointRequest<URL extends keyof Endpoints, Endpoints extends {
+    [K in keyof Endpoints]: EndpointDefinition;
+}> = Endpoints[URL]['request'];
 /**
  * Extract response type for a specific API endpoint
  */
-export type ApiEndpointResponse<T extends ApiEndpointPath> = ApiEndpoints[T]['response'];
+export type EndpointResponse<URL extends keyof Endpoints, Endpoints extends {
+    [K in keyof Endpoints]: EndpointDefinition;
+}> = Endpoints[URL]['response'];
 /**
  * Extract HTTP method for a specific API endpoint
  */
-export type ApiEndpointMethod<T extends ApiEndpointPath> = ApiEndpoints[T]['method'];
-/**
- * Extract request type for a specific streaming endpoint
- */
-export type StreamingEndpointRequest<T extends StreamingEndpointPath> = StreamingEndpoints[T]['request'];
-/**
- * Extract stream response type for a specific streaming endpoint
- */
-export type StreamingEndpointStream<T extends StreamingEndpointPath> = StreamingEndpoints[T]['stream'];
-/**
- * Extract HTTP method for a specific streaming endpoint
- */
-export type StreamingEndpointMethod<T extends StreamingEndpointPath> = StreamingEndpoints[T]['method'];
+export type EndpointMethod<URL extends keyof Endpoints, Endpoints extends {
+    [K in keyof Endpoints]: EndpointDefinition;
+}> = Endpoints[URL]['method'];
 /**
  * Generic request options for API endpoints with typed methods and body
  */
-export interface TypedApiRequestOptions<T extends ApiEndpointPath> {
-    method?: ApiEndpointMethod<T>;
-    body?: ApiEndpointRequest<T> extends never ? undefined : ApiEndpointRequest<T>;
-    headers?: Record<string, string>;
-    signal?: AbortSignal;
-}
-/**
- * Typed request options for specific streaming endpoints
- */
-export interface TypedStreamRequestOptions<T extends StreamingEndpointPath> {
-    method?: StreamingEndpointMethod<T>;
-    body?: StreamingEndpointRequest<T>;
+export interface RequestOptions<URL extends keyof Endpoints, Endpoints extends {
+    [K in keyof Endpoints]: EndpointDefinition;
+}> {
+    method?: Endpoints[URL]['method'];
+    body?: Endpoints[URL]['request'] extends never ? undefined : Endpoints[URL]['request'];
     headers?: Record<string, string>;
     signal?: AbortSignal;
 }
-export {};

package/package.json

@@ -1,7 +1,11 @@
 {
     "name": "@ragbits/api-client",
-    "version": "0.0.3",
+    "version": "1.4.0-dev.202512021005",
     "description": "JavaScript client for the Ragbits API",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/deepsense-ai/ragbits"
+    },
     "main": "dist/index.cjs",
     "module": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -22,7 +26,7 @@
         "lint": "eslint .",
         "format": "prettier --write .",
         "format:check": "prettier --check .",
-        "clean": "rm -rf ./dist"
+        "clean": "rm -rf ./dist && rm -f ./tsconfig.tsbuildinfo"
     },
     "keywords": [
         "ragbits",
@@ -36,7 +40,7 @@
         "@rjsf/utils": "^5.24.12",
         "@testing-library/jest-dom": "^6.4.0",
         "@types/node": "^20.0.0",
-        "@vitest/coverage-v8": "^1.6.0",
+        "@vitest/coverage-v8": "^4.0.7",
         "eslint": "^9.17.0",
         "globals": "^15.14.0",
         "msw": "^2.0.0",
@@ -44,6 +48,6 @@
         "tsup": "^8.0.0",
         "typescript": "^5.0.0",
         "typescript-eslint": "^8.18.2",
-        "vitest": "^1.6.0"
+        "vitest": "^4.0.7"
     }
 }