# bpevs/favioli architecture

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

- Interactive diagram: https://gitdiagram.com/bpevs/favioli
- Repository: https://github.com/bpevs/favioli

## Overview

##### Main Components Identification

The system should be represented as a browser extension architecture with these key components:

a) Extension UI Layer:
- Popup Interface (source/popup.tsx)
- Options Page (source/options.tsx)
- Components (source/components/*)

b) Core Extension Components:
- Background Script (source/background.ts)
- Content Script (source/content_script.ts)

c) Business Logic Layer:
- Models (source/models/*)
- Utilities (source/utilities/*)

**┌─ Browser Extension Environment ─────────────────────┐**

- ┌─ UI Layer ─────────────┐                        │
- Popup               ─┼─┐                      │
- Options Page       ─┼─┤ │ Components          │
- Emoji Selector     ─┼─┘ │ - Checkbox         │
- ┘  │ - List             │
- Switch            │
- ┌─ Core Extension ──────────┘                     │

- Background Script ◄────► Content Script         │

- ┬───────────────────────────────┘   │

- ┌─ Business Logic ────────────────────────────┐   │
- Models:                  Utilities:          │   │
- Emoji                 - Favicon Selector   │   │
- Favicon               - Image Helpers      │   │
- Settings              - Permissions        │   │
- ┘    │

- ┘

##### Key Relationships to Highlight

- Data flow from UI components to Business Logic layer
- Storage interactions with Browser API
- Favicon manipulation pipeline

##### Important Technical Details

- Built with Deno and Bext
- Cross-browser compatibility (Chrome/Firefox)
- Storage mechanisms for settings
- Favicon manipulation utilities

##### Implementation Notes

- The separation between UI, core extension logic, and business logic
- How the favicon override system integrates with web pages
- The role of various utilities in favicon manipulation
- Storage and state management flow

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Browser["Browser Extension Environment"]
        subgraph UI["UI Layer"]
            Popup["Popup Interface"]
            Options["Options Page"]
            Components["Component Library"]
            EmojiSelector["Emoji Selector"]
            Pages["Pages"]
        end

        subgraph Core["Core Extension Components"]
            Background["Background Script"]
            Content["Content Script"]
        end

        subgraph Business["Business Logic Layer"]
            subgraph Models["Models"]
                Emoji["Emoji Model"]
                Favicon["Favicon Model"]
                Settings["Settings Model"]
            end

            subgraph Utils["Utilities"]
                FaviconSelector["Favicon Selector"]
                ImageHelpers["Image Helpers"]
                Permissions["Permissions"]
            end
        end

        subgraph State["State Management & Hooks"]
            BrowserStorage["Browser Storage Hook"]
            SelectedFavicon["Selected Favicon Hook"]
            StatusHook["Status Hook"]
        end

        subgraph Static["Static Resources"]
            Templates["HTML Templates"]
            Styles["Styles"]
        end

        subgraph Config["Configuration"]
            Manifest["Extension Manifest"]
            LegacyConfig["Legacy Config"]
        end
    end

    %% Relationships
    Background <--> Content
    UI --> Core
    Core --> Business
    Core --> State
    UI --> State
    Static --> UI

    %% Click Events
    click Popup "https://github.com/bpevs/favioli/blob/main/source/popup.tsx"
    click Options "https://github.com/bpevs/favioli/blob/main/source/options.tsx"
    click Components "https://github.com/bpevs/favioli/tree/main/source/components/"
    click EmojiSelector "https://github.com/bpevs/favioli/tree/main/source/components/emoji_selector/"
    click Pages "https://github.com/bpevs/favioli/tree/main/source/pages/"
    click Background "https://github.com/bpevs/favioli/blob/main/source/background.ts"
    click Content "https://github.com/bpevs/favioli/blob/main/source/content_script.ts"
    click Emoji "https://github.com/bpevs/favioli/blob/main/source/models/emoji.ts"
    click Favicon "https://github.com/bpevs/favioli/blob/main/source/models/favicon.ts"
    click Settings "https://github.com/bpevs/favioli/blob/main/source/models/settings.ts"
    click FaviconSelector "https://github.com/bpevs/favioli/blob/main/source/utilities/favicon_selector.ts"
    click ImageHelpers "https://github.com/bpevs/favioli/blob/main/source/utilities/image_helpers.ts"
    click Permissions "https://github.com/bpevs/favioli/blob/main/source/utilities/permissions.ts"
    click BrowserStorage "https://github.com/bpevs/favioli/blob/main/source/hooks/use_browser_storage.ts"
    click SelectedFavicon "https://github.com/bpevs/favioli/blob/main/source/hooks/use_selected_favicon.ts"
    click StatusHook "https://github.com/bpevs/favioli/blob/main/source/hooks/use_status.ts"
    click Manifest "https://github.com/bpevs/favioli/blob/main/source/manifest.json"
    click LegacyConfig "https://github.com/bpevs/favioli/blob/main/source/config/legacy_autoselect_set.ts"

    %% Styling
    classDef ui fill:#a8d1f0
    classDef core fill:#90ee90
    classDef business fill:#ffeb99
    classDef state fill:#ffc0cb
    classDef static fill:#d3d3d3
    classDef config fill:#deb887

    class Popup,Options,Components,EmojiSelector,Pages ui
    class Background,Content core
    class Emoji,Favicon,Settings,FaviconSelector,ImageHelpers,Permissions business
    class BrowserStorage,SelectedFavicon,StatusHook state
    class Templates,Styles static
    class Manifest,LegacyConfig config
```
