# ebbot-ai/ebbot_flutter_ui architecture

> Architecture diagram of the GitHub repository ebbot-ai/ebbot_flutter_ui, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ebbot-ai/ebbot_flutter_ui
- Repository: https://github.com/ebbot-ai/ebbot_flutter_ui

## Overview

##### Project type and purpose
- This repository is a Flutter plugin package named “Ebbot Flutter UI” together with a demo Flutter app.
- Its purpose is to provide a drop-in chat widget that encapsulates business logic from the `ebbot-dart-client` library and renders it using the `flutter-chat-ui` package.

##### File structure
- Top-level directories:
- `lib/v1` – the Dart code for the plugin, organized into subpackages:
– `configuration` (data models and configuration objects)
– `controller` (API controller)
– `src/controller` (state-management controllers)
– `src/service` (services that drive chat, callback, logging, support, etc.)
– `src/parser` (message/chat parsers)
– `src/initializer` (dependency initialization, service locator)
– `src/util` (utilities, extensions)
– `src/widget` (UI widget implementations)
- Platform folders – standard Flutter embedding code for Android, iOS, Web, Linux, macOS, Windows.
- `docs` – markdown documentation.
- Root files – configuration (`pubspec.yaml`, CI scripts, README).

##### Extract architecture details from README
- The plugin wraps two key dependencies:
- `flutter-chat-ui` for UI rendering
- `ebbot-dart-client` for business logic and communication with Ebbot backend
- A demo app shows how to wire up the widget in a real Flutter project.

##### Main components
a. Demo Flutter App (your host application)
b. Flutter Engine & Platform Embedder
c. Ebbot Flutter UI plugin, subdivided into layers:
- Presentation/UI Layer: widgets under `lib/v1/src/widget`
- State/Controller Layer: controllers under `lib/v1/controller` and `lib/v1/src/controller`
- Service Layer: classes under `lib/v1/src/service`
- Parser Layer: under `lib/v1/src/parser`
- Initialization/DI Layer: under `lib/v1/src/initializer` using a service locator
- Configuration/Model Layer: under `lib/v1/configuration`
- Utility Layer: under `lib/v1/src/util`
d. External Dependencies:
- `flutter-chat-ui` package (UI library)
- `ebbot-dart-client` library (chat logic)
e. External Ebbot Chat Service (REST/WebSocket API backend)

##### Relationships and interactions
- The Demo App imports the plugin and passes a configuration object into the top-level Chat widget.
- The Chat widget invokes the Controller layer, which in turn uses Service classes.
- Service classes delegate message formatting/parsing to the Parser layer, and handle callbacks to the host via `ebbot_callback_service`.
- Services rely on `ebbot-dart-client` to perform HTTP/WebSocket calls to the remote Ebbot Chat Service.
- The UI layer draws messages using `flutter-chat-ui`.
- The Initialization layer wires up dependencies at startup (service locator).

##### Architectural patterns and design principles
- Layered architecture separating UI, controllers, services, parsers, and models.
- Dependency Injection via a simple Service Locator.
- MVC/MVVM-style separation: widgets (View), controllers (ViewModel), services (Model/Business Logic).
- Cross-platform support via the standard Flutter Engine + platform embedder.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Demo Application
    subgraph "Demo Flutter App (Host Application)"
        direction TB
        Android["android/"]:::demoApp
        IOS["ios/"]:::demoApp
        LinuxApp["linux/"]:::demoApp
        MacOSApp["macos/"]:::demoApp
        WebApp["web/"]:::demoApp
        WindowsApp["windows/"]:::demoApp
    end

    %% Engine & Embedder
    subgraph "Flutter Engine & Platform Embedder"
        direction TB
        LinuxEmbedder["linux/flutter/"]:::engine
        MacOSEmbedder["macos/Flutter/"]:::engine
        WindowsEmbedder["windows/flutter/"]:::engine
    end

    %% Plugin Public API
    EbbotAPI["Ebbot Flutter UI\n(lib/v1/ebbot_flutter_ui.dart)"]:::plugin

    %% Plugin Internal Layers
    subgraph "Ebbot Flutter UI Plugin Internal Layers"
        direction TB
        subgraph "Initialization/DI Layer"
            ControllerInit["ebbot_controller_initializer.dart"]:::plugin
            ServiceInit["ebbot_service_initializer.dart"]:::plugin
            ServiceLocator["service_locator.dart"]:::plugin
        end
        subgraph "Configuration/Model Layer"
            ConfigModels["configuration/*.dart"]:::plugin
        end
        subgraph "Parser Layer"
            ChatParser["ebbot_chat_parser.dart"]:::plugin
            MessageParser["ebbot_message_parser.dart"]:::plugin
        end
        subgraph "Service Layer"
            TranscriptService["chat_transcript_service.dart"]:::plugin
            CallbackService["ebbot_callback_service.dart"]:::plugin
            ListenerService["ebbot_chat_listener_service.dart"]:::plugin
            DartClientService["ebbot_dart_client_service.dart"]:::plugin
            SupportService["ebbot_support_service.dart"]:::plugin
            LogService["log_service.dart"]:::plugin
        end
        subgraph "State/Controller Layer"
            APIController["ebbot_api_controller.dart"]:::plugin
            InputController["chat_input_controller.dart"]:::plugin
            FieldController["chat_input_field_controller.dart"]:::plugin
            TranscriptController["chat_transcript_controller.dart"]:::plugin
            CustomMsgController["chat_ui_custom_message_controller.dart"]:::plugin
            ChatStreamController["ebbot_chat_stream_controller.dart"]:::plugin
            MessageStreamController["ebbot_message_stream_controller.dart"]:::plugin
            ResettableController["resettable_controller.dart"]:::plugin
        end
        subgraph "Presentation/UI Layer"
            CarouselWidget["carousel_widget.dart"]:::plugin
            ContextMenuWidget["context_menu_widget.dart"]:::plugin
            CustomChatWidget["custom_chat_widget.dart"]:::plugin
            ListWidget["list_widget.dart"]:::plugin
            RatingWidget["rating_widget.dart"]:::plugin
            StartPageWidget["start_page_widget.dart"]:::plugin
            UrlBoxWidget["url_box_widget.dart"]:::plugin
            UrlButtonWidget["url_button_widget.dart"]:::plugin
        end
        subgraph "Utility Layer"
            GptUserUtil["ebbot_gpt_user.dart"]:::plugin
            ExtensionUtil["extension.dart"]:::plugin
            StringUtil["string_util.dart"]:::plugin
        end
    end

    %% External Dependencies
    FlutterChatUI["flutter-chat-ui\n(package)"]:::extLib
    EbbotDartClient["ebbot-dart-client\n(package)"]:::extLib

    %% External Service
    EbbotService["Ebbot Chat Service\n(REST/WebSocket API)"]:::extSvc

    %% Connections
    Android -->|hosts widget| EbbotAPI
    IOS -->|hosts widget| EbbotAPI
    LinuxApp -->|hosts widget| EbbotAPI
    MacOSApp -->|hosts widget| EbbotAPI
    WebApp -->|hosts widget| EbbotAPI
    WindowsApp -->|hosts widget| EbbotAPI

    EbbotAPI -->|initialize| ServiceLocator
    ServiceLocator -->|register| ControllerInit
    ServiceLocator -->|register| ServiceInit

    EbbotAPI -->|render UI| CustomChatWidget
    CustomChatWidget -->|invoke| APIController
    APIController -->|calls| TranscriptService
    TranscriptService -->|uses| ChatParser
    TranscriptService -->|uses| MessageParser
    TranscriptService -->|delegates| CallbackService
    TranscriptService -->|calls| DartClientService
    DartClientService -->|uses| EbbotDartClient
    EbbotDartClient -->|HTTP/WebSocket| EbbotService
    TranscriptService -->|logs| LogService
    APIController -->|updates| ChatStreamController
    ChatStreamController -->|streams| CustomChatWidget

    CustomChatWidget -->|renders| FlutterChatUI

    %% Click Events
    click Android "https://github.com/ebbot-ai/ebbot_flutter_ui/tree/main/android/"
    click IOS "https://github.com/ebbot-ai/ebbot_flutter_ui/tree/main/ios/"
    click LinuxApp "https://github.com/ebbot-ai/ebbot_flutter_ui/tree/main/linux/"
    click MacOSApp "https://github.com/ebbot-ai/ebbot_flutter_ui/tree/main/macos/"
    click WebApp "https://github.com/ebbot-ai/ebbot_flutter_ui/tree/main/web/"
    click WindowsApp "https://github.com/ebbot-ai/ebbot_flutter_ui/tree/main/windows/"
    click LinuxEmbedder "https://github.com/ebbot-ai/ebbot_flutter_ui/tree/main/linux/flutter/"
    click MacOSEmbedder "https://github.com/ebbot-ai/ebbot_flutter_ui/tree/main/macos/Flutter/"
    click WindowsEmbedder "https://github.com/ebbot-ai/ebbot_flutter_ui/tree/main/windows/flutter/"
    click EbbotAPI "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/ebbot_flutter_ui.dart"
    click ControllerInit "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/initializer/ebbot_controller_initializer.dart"
    click ServiceInit "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/initializer/ebbot_service_initializer.dart"
    click ServiceLocator "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/initializer/service_locator.dart"
    click ConfigModels "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/configuration/ebbot_configuration.dart"
    click ChatParser "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/parser/ebbot_chat_parser.dart"
    click MessageParser "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/parser/ebbot_message_parser.dart"
    click TranscriptService "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/service/chat_transcript_service.dart"
    click CallbackService "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/service/ebbot_callback_service.dart"
    click ListenerService "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/service/ebbot_chat_listener_service.dart"
    click DartClientService "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/service/ebbot_dart_client_service.dart"
    click SupportService "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/service/ebbot_support_service.dart"
    click LogService "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/service/log_service.dart"
    click APIController "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/controller/ebbot_api_controller.dart"
    click InputController "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/controller/chat_input_controller.dart"
    click FieldController "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/controller/chat_input_field_controller.dart"
    click TranscriptController "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/controller/chat_transcript_controller.dart"
    click CustomMsgController "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/controller/chat_ui_custom_message_controller.dart"
    click ChatStreamController "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/controller/ebbot_chat_stream_controller.dart"
    click MessageStreamController "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/controller/ebbot_message_stream_controller.dart"
    click ResettableController "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/controller/resettable_controller.dart"
    click CarouselWidget "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/widget/carousel_widget.dart"
    click ContextMenuWidget "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/widget/context_menu_widget.dart"
    click CustomChatWidget "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/widget/custom_chat_widget.dart"
    click ListWidget "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/widget/list_widget.dart"
    click RatingWidget "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/widget/rating_widget.dart"
    click StartPageWidget "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/widget/start_page_widget.dart"
    click UrlBoxWidget "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/widget/url_box_widget.dart"
    click UrlButtonWidget "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/widget/url_button_widget.dart"
    click GptUserUtil "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/util/ebbot_gpt_user.dart"
    click ExtensionUtil "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/util/extension.dart"
    click StringUtil "https://github.com/ebbot-ai/ebbot_flutter_ui/blob/main/lib/v1/src/util/string_util.dart"

    %% Styles
    classDef demoApp fill:#cce5ff,stroke:#3399ff
    classDef engine fill:#f0f0f0,stroke:#666666
    classDef plugin fill:#e6ffe6,stroke:#33cc33
    classDef extLib fill:#f3e6ff,stroke:#9933cc
    classDef extSvc fill:#ffe6cc,stroke:#ff9933
```
