feat: Autogenerate TS types (#727)

Author: jakubduda-dsai

package-lock.json

@@ -2,19 +2,20 @@
 
 ## Unreleased
 
+- Autogenerate typescript types based on backend typing (#727)
+
 ## 1.2.1 (2025-08-04)
 
 ### Changed
 
 - ragbits-core updated to version v1.2.1
-
 - Fix routing error causing chat to not be displayed with disabled history (#764)
 
 ## 1.2.0 (2025-08-01)
+
 ### Changed
 
 - ragbits-core updated to version v1.2.0
-
 - Update TailwindCSS, React, Vite, tailwind config (#742)
 - Add images support in chat message, images gallery (#731)
 - Add persistent user settings (#719)

packages/ragbits-chat/CHANGELOG.md

@@ -5,18 +5,25 @@
 from collections.abc import AsyncGenerator
 from contextlib import asynccontextmanager
 from pathlib import Path
-from typing import Any, Literal
 
 import uvicorn
 from fastapi import FastAPI, HTTPException, Request, status
 from fastapi.exceptions import RequestValidationError
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import HTMLResponse, JSONResponse, StreamingResponse
 from fastapi.staticfiles import StaticFiles
-from pydantic import BaseModel, Field
 
 from ragbits.chat.interface import ChatInterface
-from ragbits.chat.interface.types import ChatContext, ChatResponse, ChatResponseType, Message
+from ragbits.chat.interface.types import (
+    ChatContext,
+    ChatMessageRequest,
+    ChatResponse,
+    ChatResponseType,
+    ConfigResponse,
+    FeedbackConfig,
+    FeedbackItem,
+    FeedbackRequest,
+)
 from ragbits.core.audit.metrics import record_metric
 from ragbits.core.audit.metrics.base import MetricType
 from ragbits.core.audit.traces import trace
@@ -26,26 +33,6 @@
 logger = logging.getLogger(__name__)
 
 
-class ChatMessageRequest(BaseModel):
-    """
-    Request body for chat message
-    """
-
-    message: str = Field(..., description="The current user message")
-    history: list[Message] = Field(default_factory=list, description="Previous message history")
-    context: dict[str, Any] = Field(default_factory=dict, description="User context information")
-
-
-class FeedbackRequest(BaseModel):
-    """
-    Request body for feedback submission
-    """
-
-    message_id: str = Field(..., description="ID of the message receiving feedback")
-    feedback: Literal["like", "dislike"] = Field(..., description="Type of feedback (like or dislike)")
-    payload: dict = Field(default_factory=dict, description="Additional feedback details")
-
-
 class RagbitsAPI:
     """
     RagbitsAPI class for running API with Demo UI for testing purposes
@@ -126,30 +113,26 @@ async def feedback(request: FeedbackRequest) -> JSONResponse:
 
         @self.app.get("/api/config", response_class=JSONResponse)
         async def config() -> JSONResponse:
-            like_config = self.chat_interface.feedback_config.like_form
-            dislike_config = self.chat_interface.feedback_config.dislike_form
-            user_settings_config = self.chat_interface.user_settings.form
-
-            config_dict = {
-                "feedback": {
-                    "like": {
-                        "enabled": self.chat_interface.feedback_config.like_enabled,
-                        "form": like_config,
-                    },
-                    "dislike": {
-                        "enabled": self.chat_interface.feedback_config.dislike_enabled,
-                        "form": dislike_config,
-                    },
-                },
-                "customization": self.chat_interface.ui_customization.model_dump()
-                if self.chat_interface.ui_customization
-                else None,
-                "user_settings": {"form": user_settings_config},
-                "debug_mode": self.debug_mode,
-                "conversation_history": self.chat_interface.conversation_history,
-            }
-
-            return JSONResponse(content=config_dict)
+            feedback_config = self.chat_interface.feedback_config
+
+            config_response = ConfigResponse(
+                feedback=FeedbackConfig(
+                    like=FeedbackItem(
+                        enabled=feedback_config.like_enabled,
+                        form=feedback_config.like_form,
+                    ),
+                    dislike=FeedbackItem(
+                        enabled=feedback_config.dislike_enabled,
+                        form=feedback_config.dislike_form,
+                    ),
+                ),
+                customization=self.chat_interface.ui_customization,
+                user_settings=self.chat_interface.user_settings,
+                debug_mode=self.debug_mode,
+                conversation_history=self.chat_interface.conversation_history,
+            )
+
+            return JSONResponse(content=config_response.model_dump())
 
         @self.app.get("/{full_path:path}", response_class=HTMLResponse)
         async def root() -> HTMLResponse:

packages/ragbits-chat/src/ragbits/chat/api.py

@@ -7,7 +7,7 @@
 import uuid
 from abc import ABC, abstractmethod
 from collections.abc import AsyncGenerator, Callable
-from typing import Any, Literal
+from typing import Any
 
 from ragbits.chat.interface.ui_customization import UICustomization
 from ragbits.core.audit.metrics import record_metric
@@ -22,6 +22,7 @@
     ChatContext,
     ChatResponse,
     ChatResponseType,
+    FeedbackType,
     Image,
     LiveUpdate,
     LiveUpdateContent,
@@ -329,8 +330,8 @@ async def chat(
     async def save_feedback(
         self,
         message_id: str,
-        feedback: Literal["like", "dislike"],
-        payload: dict,
+        feedback: FeedbackType,
+        payload: dict[str, Any] | None = None,
     ) -> None:
         """
         Save feedback about a chat message.

packages/ragbits-chat/src/ragbits/chat/interface/_interface.py

@@ -3,6 +3,9 @@
 
 from pydantic import BaseModel, ConfigDict, Field
 
+from ragbits.chat.interface.forms import UserSettings
+from ragbits.chat.interface.ui_customization import UICustomization
+
 
 class MessageRole(str, Enum):
     """Defines the role of the message sender in a conversation."""
@@ -76,6 +79,15 @@ class ChatResponseType(str, Enum):
     IMAGE = "image"
 
 
+class ChatContext(BaseModel):
+    """Represents the context of a chat conversation."""
+
+    conversation_id: str | None = None
+    message_id: str | None = None
+    state: dict[str, Any] = Field(default_factory=dict)
+    model_config = ConfigDict(extra="allow")
+
+
 class ChatResponse(BaseModel):
     """Container for different types of chat responses."""
 
@@ -145,10 +157,56 @@ def as_image(self) -> Image | None:
         return cast(Image, self.content) if self.type == ChatResponseType.IMAGE else None
 
 
-class ChatContext(BaseModel):
-    """Represents the context of a chat conversation."""
+class ChatMessageRequest(BaseModel):
+    """Client-side chat request interface."""
 
-    conversation_id: str | None = None
-    message_id: str | None = None
-    state: dict[str, Any] = Field(default_factory=dict)
-    model_config = ConfigDict(extra="allow")
+    message: str = Field(..., description="The current user message")
+    history: list["Message"] = Field(default_factory=list, description="Previous message history")
+    context: dict[str, Any] = Field(default_factory=dict, description="User context information")
+
+
+class FeedbackType(str, Enum):
+    """Feedback types for user feedback."""
+
+    LIKE = "like"
+    DISLIKE = "dislike"
+
+
+class FeedbackResponse(BaseModel):
+    """Response from feedback submission."""
+
+    status: str = Field(..., description="Status of the feedback submission")
+
+
+class FeedbackRequest(BaseModel):
+    """
+    Request body for feedback submission
+    """
+
+    message_id: str = Field(..., description="ID of the message receiving feedback")
+    feedback: FeedbackType = Field(..., description="Type of feedback (like or dislike)")
+    payload: dict[str, Any] = Field(default_factory=dict, description="Additional feedback details")
+
+
+class FeedbackItem(BaseModel):
+    """Individual feedback configuration (like/dislike)."""
+
+    enabled: bool = Field(..., description="Whether this feedback type is enabled")
+    form: dict[str, Any] | None = Field(..., description="Form schema for this feedback type")
+
+
+class FeedbackConfig(BaseModel):
+    """Feedback configuration containing like and dislike settings."""
+
+    like: FeedbackItem = Field(..., description="Like feedback configuration")
+    dislike: FeedbackItem = Field(..., description="Dislike feedback configuration")
+
+
+class ConfigResponse(BaseModel):
+    """Configuration response from the API."""
+
+    feedback: FeedbackConfig = Field(..., description="Feedback configuration")
+    customization: UICustomization | None = Field(default=None, description="UI customization")
+    user_settings: UserSettings = Field(default_factory=UserSettings, description="User settings")
+    debug_mode: bool = Field(default=False, description="Debug mode flag")
+    conversation_history: bool = Field(default=False, description="Debug mode flag")

packages/ragbits-chat/src/ragbits/chat/interface/types.py

@@ -0,0 +1,9 @@
+"""
+Providers for ragbits-chat package.
+
+This module contains provider classes for various ragbits-chat functionality.
+"""
+
+from .model_provider import RagbitsChatModelProvider
+
+__all__ = ["RagbitsChatModelProvider"]