# dsaquel/solid-realtime architecture

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

- Interactive diagram: https://gitdiagram.com/dsaquel/solid-realtime
- Repository: https://github.com/dsaquel/solid-realtime

## Overview

##### Main Components

a) Core Library Layer:
- Watcher System (from src/lib/watcher.ts)
- Utils and Types components (from src/utils.ts and src/types.ts)

b) Connector Layer:
- Supabase Connector
- Firebase Connector
- Prisma Connector
- Raw SQL Connector

c) Client Application Layer:
- SolidJS Application
- Reactive Store
- Real-time Data Subscription

d) External Services Layer:
- Supabase
- Firebase
- Prisma Database
- Raw SQL Database

##### Specific Implementation Details

Create sections showing:
- Store Creation Flow
- Real-time Subscription Process
- Data Update Propagation

##### Technical Specifications

A technical details section showing:
- TypeScript integration
- SolidJS reactive primitives
- Connection configuration requirements
- Environment variables structure

##### External Services Layer

- Plugin-based architecture with the different connectors
- How the watcher system integrates with SolidJS's reactivity
- Type-safe nature of the connections
- Configuration requirements for each connector
- Error handling and fallback patterns

- Data flow directions
- Component type indicators
- Connection type indicators
- Configuration requirement indicators

Keep the following aspects in mind:
- The library's primary purpose of managing real-time connections
- The flexibility of supporting multiple backend services
- The integration with SolidJS's reactive system
- The type-safe nature of the connections
- The configuration requirements for each service

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef client fill:#FFA500,stroke:#000
    classDef core fill:#3498db,stroke:#000
    classDef connector fill:#2ecc71,stroke:#000
    classDef external fill:#9b59b6,stroke:#000
    classDef config fill:#95a5a6,stroke:#000

    %% Client Application Layer
    subgraph ClientLayer
        App["SolidJS Application"]:::client
        Store["Reactive Store"]:::client
        Sub["Real-time Subscription"]:::client
    end

    %% Core Layer
    subgraph CoreLayer
        Core["Solid RealTime Core"]:::core
        Watcher["Watcher System"]:::core
        Utils["Utilities"]:::core
        Types["Type Definitions"]:::core
    end

    %% Connectors Layer
    subgraph ConnectorsLayer
        SupabaseC["Supabase Connector"]:::connector
        FirebaseC["Firebase Connector"]:::connector
        PrismaC["Prisma Connector"]:::connector
        SQLC["Raw SQL Connector"]:::connector
    end

    %% External Services Layer
    subgraph ExternalLayer
        Supabase[("Supabase")]:::external
        Firebase[("Firebase")]:::external
        Prisma[("Prisma DB")]:::external
        SQL[("Raw SQL DB")]:::external
    end

    %% Configuration Nodes
    SupaConfig["Supabase Config"]:::config
    FireConfig["Firebase Config"]:::config
    PrismaConfig["Prisma Config"]:::config
    SQLConfig["SQL Config"]:::config

    %% Relationships
    App --> Store
    Store --> Sub
    Sub <--> Core
    Core --> Watcher
    Core --> Utils
    Core --> Types

    Core --> SupabaseC
    Core --> FirebaseC
    Core --> PrismaC
    Core --> SQLC

    SupabaseC <--> Supabase
    FirebaseC <--> Firebase
    PrismaC <--> Prisma
    SQLC <--> SQL

    SupabaseC --> SupaConfig
    FirebaseC --> FireConfig
    PrismaC --> PrismaConfig
    SQLC --> SQLConfig

    %% Click Events
    click Core "https://github.com/Dsaquel/solid-realtime/blob/master/src/index.ts"
    click Watcher "https://github.com/Dsaquel/solid-realtime/blob/master/src/lib/watcher.ts"
    click Utils "https://github.com/Dsaquel/solid-realtime/blob/master/src/utils.ts"
    click Types "https://github.com/Dsaquel/solid-realtime/blob/master/src/types.ts"
    click SupabaseC "https://github.com/Dsaquel/solid-realtime/blob/master/src/lib/connector/supabase.ts"
    click FirebaseC "https://github.com/Dsaquel/solid-realtime/blob/master/src/lib/connector/firebase.ts"
    click PrismaC "https://github.com/Dsaquel/solid-realtime/blob/master/src/lib/connector/prisma.tsx"
    click SQLC "https://github.com/Dsaquel/solid-realtime/blob/master/src/lib/connector/rawSQL.ts"
    click SupaConfig "https://github.com/Dsaquel/solid-realtime/blob/master/docs/configuration-supabase.md"
    click FireConfig "https://github.com/Dsaquel/solid-realtime/blob/master/docs/configuration-firebase.md"
    click PrismaConfig "https://github.com/Dsaquel/solid-realtime/blob/master/docs/configuration-prisma.md"
    click SQLConfig "https://github.com/Dsaquel/solid-realtime/blob/master/docs/configuration-rawsql.md"

    %% Legend
    subgraph Legend
        L1["Client Component"]:::client
        L2["Core Component"]:::core
        L3["Connector Component"]:::connector
        L4[("External Service")]:::external
        L5["Configuration"]:::config
    end
```
