# bhoominn/nb_utils architecture

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

- Interactive diagram: https://gitdiagram.com/bhoominn/nb_utils
- Repository: https://github.com/bhoominn/nb_utils

## Overview

##### Project Type and Purpose
- **Type**: Federated Flutter plugin package (multi-platform)
- **Purpose**: Provide reusable UI widgets, extensions, system/package utilities, and platform method-channel integrations to Flutter apps on Android, iOS, Web, Windows, Linux, and macOS.

##### Top-Level Architecture Components
A. **Plugin Package (nb_utils)**
– Core Dart library (lib/):
- `nb_utils_platform_interface.dart`: Defines abstract interface.
- `nb_utils_method_channel.dart`: Default MethodChannel implementation for mobile/desktop.
- `nb_utils_web.dart`: Web‐specific implementation.
- `src/`:
– `/utils`, `/widgets`, `/extensions`, `/models`, `/chatgpt`: Pure Dart code (no native calls).
– **Platform-specific folders**:
- `android/src/.../NbUtilsPlugin.kt`
- `ios/Classes/NbUtilsPlugin.swift` (+ macos Swift code)
- `linux/nb_utils_plugin.cc`
- `windows/nb_utils_plugin.cpp`
– **Pub configuration files**: `pubspec.yaml`, `nb_utils.podspec`

B. **Example App** (example/)
– Flutter application demonstrating usage on Android, iOS, macOS, web, Linux, Windows.
– Contains platform embedding for each target (Gradle, Xcode, CMake etc.).
– Depends on nb_utils via `pubspec.yaml`.

##### Relationships and Interactions
1. **Flutter App** → depends on → **nb_utils**
2. **Dart API calls** (e.g., `initialize()`, `getIpAddress()`, `showConfirmDialog()`, widget constructors, extension methods) → resolved to →
a. Pure-Dart modules under `lib/src/` (no channel)
b. Platform interface if the API requires a native bridge
– The call goes from `nb_utils_platform_interface` to `nb_utils_method_channel` (MethodChannel)
– MethodChannel dispatches to native code in Android/iOS/Linux/Windows/macOS plugin classes
3. **Native Plugin Code** → communicates back results → via MethodChannel callbacks → to Dart side

##### Important Architectural Patterns and Design Principles
– **Federated plugin** using platform-interface + method-channel pattern
– **Separation of concerns**:
- UI widgets & extensions in pure Dart (cross-platform)
- Platform method-implementation only for native operations (shared_prefs, system utilities)
– **Example app** isolated under `example/` to ensure real-world integration testing

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Application Layer
    subgraph "Application Layer"
        ExampleApp["Flutter App\n(example/lib/main.dart)"]:::application
        ExamplePubspec["Example Pubspec\n(example/pubspec.yaml)"]:::application
    end

    %% Public API Layer
    subgraph "Plugin Public API Layer"
        PublicAPI["nb_utils.dart\n(lib/nb_utils.dart)"]:::api
        PlatformInterface["Platform Interface\n(lib/nb_utils_platform_interface.dart)"]:::api
        WebImpl["Web Implementation\n(lib/nb_utils_web.dart)"]:::api
    end

    %% Core Dart Modules
    subgraph "Core Dart Modules" 
        subgraph "Utilities" 
            SharedPref["shared_pref.dart"]:::dart
            SystemUtils["system_utils.dart"]:::dart
            NetworkUtils["network_utils.dart"]:::dart
        end
        subgraph "Widgets"
            AnimatedListView["animated_list_view.dart"]:::dart
            BlurWidget["blur_widget.dart"]:::dart
            LoaderWidget["loader_widget.dart"]:::dart
            ConfirmDialog["confirmation_dialog.dart"]:::dart
        end
        subgraph "Extensions"
            StringExt["string_extensions.dart"]:::dart
            DateTimeExt["date_time_extensions.dart"]:::dart
        end
        subgraph "Models"
            PackageInfoModel["package_info_model.dart"]:::dart
            WalkthroughModel["walkthrough_model.dart"]:::dart
        end
        subgraph "ChatGPT Integration"
            ChatGPTCore["chat_gpt.dart"]:::dart
            ChatGPTComp["chat_gpt_component.dart"]:::dart
            ChatGPTModels["chat_gpt_models.dart"]:::dart
            ChatGPTStrings["chat_gpt_strings.dart"]:::dart
        end
    end

    %% MethodChannel Bridge
    MethodChannel["MethodChannel Bridge\n(lib/nb_utils_method_channel.dart)"]:::bridge

    %% Native Implementations
    subgraph "Native Plugin Implementations"
        AndroidPlugin["Android Plugin (Kotlin)\n(NbUtilsPlugin.kt)"]:::native
        iOSPlugin["iOS Plugin (Swift)\n(NbUtilsPlugin.swift)"]:::native
        macOSPlugin["macOS Plugin (Swift)\n(NbUtilsPlugin.swift)"]:::native
        LinuxPlugin["Linux Plugin (C++)\n(nb_utils_plugin.cc)"]:::native
        WindowsPlugin["Windows Plugin (C++)\n(nb_utils_plugin.cpp)"]:::native
    end

    %% External Services
    OSServices["OS Native Services\n(SharedPref, File I/O, System APIs)"]:::external
    ChatGPTService["External HTTP\n(ChatGPT API)"]:::external

    %% Connections
    ExampleApp -->|depends on| PublicAPI
    ExampleApp -->|depends on| ExamplePubspec
    PublicAPI -->|uses| PlatformInterface
    PublicAPI -->|uses| WebImpl
    PlatformInterface -->|calls| MethodChannel
    WebImpl -->|implements| PublicAPI
    PublicAPI -->|re-exports| SharedPref
    PublicAPI -->|re-exports| AnimatedListView
    SharedPref -->|pure Dart| SystemUtils
    SystemUtils -->|pure Dart| NetworkUtils
    NetworkUtils -->|HTTP calls| ChatGPTService
    AnimatedListView -->|widget| LoaderWidget
    LoaderWidget -->|widget| BlurWidget
    BlurWidget -->|widget| ConfirmDialog
    ConfirmDialog -->|widget| StringExt
    StringExt -->|extension| DateTimeExt
    DateTimeExt -->|extension| PackageInfoModel
    PackageInfoModel -->|model| WalkthroughModel
    WalkthroughModel -->|model| ChatGPTCore
    ChatGPTCore -->|component| ChatGPTComp
    ChatGPTComp -->|models| ChatGPTModels
    ChatGPTModels -->|strings| ChatGPTStrings
    MethodChannel -->|bridges| AndroidPlugin
    MethodChannel -->|bridges| iOSPlugin
    MethodChannel -->|bridges| macOSPlugin
    MethodChannel -->|bridges| LinuxPlugin
    MethodChannel -->|bridges| WindowsPlugin
    AndroidPlugin -->|invokes| OSServices
    iOSPlugin -->|invokes| OSServices
    macOSPlugin -->|invokes| OSServices
    LinuxPlugin -->|invokes| OSServices
    WindowsPlugin -->|invokes| OSServices

    %% Click Events
    click ExampleApp "https://github.com/bhoominn/nb_utils/blob/main/example/lib/main.dart"
    click ExamplePubspec "https://github.com/bhoominn/nb_utils/blob/main/example/pubspec.yaml"
    click PublicAPI "https://github.com/bhoominn/nb_utils/blob/main/lib/nb_utils.dart"
    click PlatformInterface "https://github.com/bhoominn/nb_utils/blob/main/lib/nb_utils_platform_interface.dart"
    click WebImpl "https://github.com/bhoominn/nb_utils/blob/main/lib/nb_utils_web.dart"
    click SharedPref "https://github.com/bhoominn/nb_utils/blob/main/lib/src/utils/shared_pref.dart"
    click SystemUtils "https://github.com/bhoominn/nb_utils/blob/main/lib/src/utils/system_utils.dart"
    click NetworkUtils "https://github.com/bhoominn/nb_utils/blob/main/lib/src/utils/network_utils.dart"
    click AnimatedListView "https://github.com/bhoominn/nb_utils/blob/main/lib/src/widgets/animatedList/animated_list_view.dart"
    click BlurWidget "https://github.com/bhoominn/nb_utils/blob/main/lib/src/widgets/blur_widget.dart"
    click LoaderWidget "https://github.com/bhoominn/nb_utils/blob/main/lib/src/widgets/loader_widget.dart"
    click ConfirmDialog "https://github.com/bhoominn/nb_utils/blob/main/lib/src/widgets/confirmation_dialog.dart"
    click StringExt "https://github.com/bhoominn/nb_utils/blob/main/lib/src/extensions/string_extensions.dart"
    click DateTimeExt "https://github.com/bhoominn/nb_utils/blob/main/lib/src/extensions/date_time_extensions.dart"
    click PackageInfoModel "https://github.com/bhoominn/nb_utils/blob/main/lib/src/models/package_info_model.dart"
    click WalkthroughModel "https://github.com/bhoominn/nb_utils/blob/main/lib/src/models/walkthrough_model.dart"
    click ChatGPTCore "https://github.com/bhoominn/nb_utils/blob/main/lib/src/chatgpt/chat_gpt.dart"
    click ChatGPTComp "https://github.com/bhoominn/nb_utils/blob/main/lib/src/chatgpt/chat_gpt_component.dart"
    click ChatGPTModels "https://github.com/bhoominn/nb_utils/blob/main/lib/src/chatgpt/chat_gpt_models.dart"
    click ChatGPTStrings "https://github.com/bhoominn/nb_utils/blob/main/lib/src/chatgpt/chat_gpt_strings.dart"
    click MethodChannel "https://github.com/bhoominn/nb_utils/blob/main/lib/nb_utils_method_channel.dart"
    click AndroidPlugin "https://github.com/bhoominn/nb_utils/blob/main/android/src/main/kotlin/com/example/nb_utils/NbUtilsPlugin.kt"
    click iOSPlugin "https://github.com/bhoominn/nb_utils/blob/main/ios/Classes/NbUtilsPlugin.swift"
    click macOSPlugin "https://github.com/bhoominn/nb_utils/blob/main/macos/Classes/NbUtilsPlugin.swift"
    click LinuxPlugin "https://github.com/bhoominn/nb_utils/blob/main/linux/nb_utils_plugin.cc"
    click WindowsPlugin "https://github.com/bhoominn/nb_utils/blob/main/windows/nb_utils_plugin.cpp"

    %% Styles
    classDef application fill:#ffecd1,stroke:#e58c0c;
    classDef api fill:#d1e8ff,stroke:#2b65ec;
    classDef dart fill:#e0ffe0,stroke:#2d8f2d;
    classDef bridge fill:#fff0b3,stroke:#ccb200;
    classDef native fill:#ffd1d1,stroke:#d12828;
    classDef external fill:#f0f0f0,stroke:#888888;
```
