# screamonei2/oms architecture

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

- Interactive diagram: https://gitdiagram.com/screamonei2/oms
- Repository: https://github.com/screamonei2/oms

## Overview

##### Project Type and Purpose
- This is a full-stack web application built with SvelteKit (frontend + server-side routes) and Supabase (BaaS for Auth, Postgres database, Realtime, Storage).
- It manages orders, clients, products, categories, uses role-based permissions, notifications, and real-time updates.

##### File Structure
- Top-level:
- src/: SvelteKit app (app.html, hooks.server.ts for request hooks).
- src/lib/: reusable modules—components (UI), services (data access), stores (client state), db init, supabase client, utils, types.
- src/routes/: page endpoints (+page.svelte, +server.ts) organized by feature (auth, categories, clients, orders, products, dashboard, init).
- supabase/: local CLI config + SQL migrations for database schema.
- schema.sql & dummy_data.sql: defines tables & seed data.
- Config: svelte.config.js, vite.config.ts, tsconfig.json define build and TypeScript settings.

##### Key Components
a. Frontend/UI Layer (Browser)
- SvelteKit pages & components: authentication flows, dashboards, modals, forms, notifications bar, sidebar, header.
- Client-side stores for auth state, permissions, notifications.
b. SvelteKit Server/Route Layer
- +server.ts endpoints (e.g., auth callback) for SSR or form actions.
- Hooks (hooks.server.ts) for injecting session info.
c. Data Access / Services
- src/lib/services/database.ts and supabase.ts: wrapper around Supabase JS client.
- Functions that CRUD orders, clients, products, categories.
d. Supabase Backend
- Auth service for login, registration, role-based permissions.
- PostgreSQL database (tables defined in migrations & schema.sql).
- Realtime subscriptions for notifications.
- Storage (if used).
e. External Interfaces
- Developer’s browser, Supabase cloud APIs (Auth, Postgres REST/GraphQL, Realtime).

##### Relationships & Data Flow
- User → Browser UI (Svelte components) → SvelteKit page & stores.
- UI invokes services → supabase.js client → Supabase Auth or Database.
- Supabase returns data → services → Svelte stores → reactive UI updates.
- Realtime events (notifications) flow from Supabase → client subscription → notifications store → UI.
- SSR routes use server-side services via hooks.server.ts injecting session.

##### Architectural Patterns & Principles
- Modular separation: UI components, services (business logic), stores (state), routes (presentation + SSR), utils (shared helpers).
- Unidirectional data flow: services → stores → UI.
- Role-based access guard (PermissionGuard component).
- Schema migrations managed under supabase/migrations.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Browser / Frontend Layer
    subgraph "Browser / Frontend"
        subgraph "UI Components"
            AuthComp["Auth.svelte"]:::frontend
            Header["Header.svelte"]:::frontend
            Sidebar["Sidebar.svelte"]:::frontend
            NotificationsUI["Notifications.svelte"]:::frontend
            CategoryModal["CategoryModal.svelte"]:::frontend
            ClientModal["ClientModal.svelte"]:::frontend
            OrderModal["OrderModal.svelte"]:::frontend
            ProductModal["ProductModal.svelte"]:::frontend
            ConfirmDeleteModal["ConfirmDeleteModal.svelte"]:::frontend
            ViewOrderModal["ViewOrderModal.svelte"]:::frontend
            PermissionGuard["PermissionGuard.svelte"]:::frontend
        end
        subgraph "Pages"
            RootPage["+page.svelte (root)"]:::frontend
            AuthPage["+page.svelte (auth)"]:::frontend
            CategoriesPage["+page.svelte (categories)"]:::frontend
            ClientsPage["+page.svelte (clients)"]:::frontend
            OrdersPage["+page.svelte (orders)"]:::frontend
            ProductsPage["+page.svelte (products)"]:::frontend
            DashboardPage["+page.svelte (dashboard)"]:::frontend
            InitPage["+page.svelte (init)"]:::frontend
        end
        subgraph "Stores"
            AuthStore["auth.ts"]:::frontend
            PermStore["permissions.ts"]:::frontend
            NotifStore["notifications.ts"]:::frontend
        end
    end

    %% SvelteKit Server Layer
    subgraph "SvelteKit Server"
        subgraph "Routes & Hooks"
            Hooks["hooks.server.ts"]:::server
            AuthCallback["+server.ts (auth/callback)"]:::server
            ErrorCat["+error.svelte (categories)"]:::server
            ErrorClients["+error.svelte (clients)"]:::server
            ErrorOrders["+error.svelte (orders)"]:::server
            ErrorProducts["+error.svelte (products)"]:::server
            AppLayout["+layout.svelte"]:::server
            LayoutTs["+layout.ts"]:::server
            AppError["+error.svelte (app)"]:::server
        end
        subgraph "Services & Utils"
            SupabaseClient["supabase.ts"]:::server
            DatabaseService["database.ts"]:::server
            TypesDb["database.types.ts"]:::server
            TypesShared["shared.ts"]:::server
            AuthUtils["auth.ts"]:::server
            ErrorUtils["errorHandler.ts"]:::server
            Fetcher["fetcher.ts"]:::server
            PermUtils["permissions.ts"]:::server
            DBInit["init.ts"]:::server
        end
        subgraph "Config & Migrations"
            Schema["schema.sql"]:::server
            Seed["dummy_data.sql"]:::server
            Migrations["supabase/migrations"]:::server
            ConfigFiles["svelte.config.js / vite.config.ts / tsconfig.json"]:::server
        end
    end

    %% Supabase Backend Layer
    subgraph "Supabase Backend"
        AuthService["Auth Service"]:::backend
        PostgresDB["Postgres Database"]:::backend
        Realtime["Realtime"]:::backend
        Storage["Storage"]:::backend
    end

    %% Data Flows
    RootPage -->|"renders"| AuthComp
    RootPage -->|navigates| DashboardPage
    Pages -->|use| Sidebar
    Pages -->|use| Header
    Pages -->|use| NotificationsUI
    AuthComp -->|updates| AuthStore
    PermissionGuard -->|guards| Pages
    Pages -->|dispatch actions| SupabaseClient
    SupabaseClient -->|"calls Auth API"| AuthService
    SupabaseClient -->|"queries"| PostgresDB
    PostgresDB -->|"responds"| SupabaseClient
    SupabaseClient -->|returns data| DatabaseService
    DatabaseService -->|"updates"| AuthStore
    DatabaseService -->|"updates"| PermStore
    DatabaseService -->|"updates"| NotifStore
    Realtime -->|push alerts| NotifStore
    NotifStore -->|triggers| NotificationsUI
    Hooks -->|injects session| SupabaseClient
    AuthCallback -->|handles login| SupabaseClient
    DBInit -->|"runs migrations"| Schema
    Schema -->|"defines tables"| PostgresDB
    Migrations -->|"applies"| PostgresDB

    %% Click Events
    click AuthComp "https://github.com/screamonei2/oms/blob/main/src/lib/components/Auth.svelte"
    click Header "https://github.com/screamonei2/oms/blob/main/src/lib/components/Header.svelte"
    click Sidebar "https://github.com/screamonei2/oms/blob/main/src/lib/components/Sidebar.svelte"
    click NotificationsUI "https://github.com/screamonei2/oms/blob/main/src/lib/components/Notifications.svelte"
    click CategoryModal "https://github.com/screamonei2/oms/blob/main/src/lib/components/CategoryModal.svelte"
    click ClientModal "https://github.com/screamonei2/oms/blob/main/src/lib/components/ClientModal.svelte"
    click OrderModal "https://github.com/screamonei2/oms/blob/main/src/lib/components/OrderModal.svelte"
    click ProductModal "https://github.com/screamonei2/oms/blob/main/src/lib/components/ProductModal.svelte"
    click ConfirmDeleteModal "https://github.com/screamonei2/oms/blob/main/src/lib/components/ConfirmDeleteModal.svelte"
    click ViewOrderModal "https://github.com/screamonei2/oms/blob/main/src/lib/components/ViewOrderModal.svelte"
    click PermissionGuard "https://github.com/screamonei2/oms/blob/main/src/lib/components/PermissionGuard.svelte"
    click DashboardPage "https://github.com/screamonei2/oms/blob/main/src/lib/pages/Dashboard.svelte"
    click RootPage "https://github.com/screamonei2/oms/blob/main/src/routes/+page.svelte"
    click AuthPage "https://github.com/screamonei2/oms/blob/main/src/routes/auth/+page.svelte"
    click CategoriesPage "https://github.com/screamonei2/oms/blob/main/src/routes/categories/+page.svelte"
    click ClientsPage "https://github.com/screamonei2/oms/blob/main/src/routes/clients/+page.svelte"
    click OrdersPage "https://github.com/screamonei2/oms/blob/main/src/routes/orders/+page.svelte"
    click ProductsPage "https://github.com/screamonei2/oms/blob/main/src/routes/products/+page.svelte"
    click DashboardPage "https://github.com/screamonei2/oms/blob/main/src/routes/dashboard/+page.svelte"
    click InitPage "https://github.com/screamonei2/oms/blob/main/src/routes/init/+page.svelte"
    click Hooks "https://github.com/screamonei2/oms/blob/main/src/hooks.server.ts"
    click AuthCallback "https://github.com/screamonei2/oms/blob/main/src/routes/auth/callback/+server.ts"
    click ErrorCat "https://github.com/screamonei2/oms/blob/main/src/routes/categories/+error.svelte"
    click ErrorClients "https://github.com/screamonei2/oms/blob/main/src/routes/clients/+error.svelte"
    click ErrorOrders "https://github.com/screamonei2/oms/blob/main/src/routes/orders/+error.svelte"
    click ErrorProducts "https://github.com/screamonei2/oms/blob/main/src/routes/products/+error.svelte"
    click AppLayout "https://github.com/screamonei2/oms/blob/main/src/routes/+layout.svelte"
    click LayoutTs "https://github.com/screamonei2/oms/blob/main/src/routes/+layout.ts"
    click AppError "https://github.com/screamonei2/oms/blob/main/src/routes/+error.svelte"
    click AuthStore "https://github.com/screamonei2/oms/blob/main/src/lib/stores/auth.ts"
    click PermStore "https://github.com/screamonei2/oms/blob/main/src/lib/stores/permissions.ts"
    click NotifStore "https://github.com/screamonei2/oms/blob/main/src/lib/stores/notifications.ts"
    click SupabaseClient "https://github.com/screamonei2/oms/blob/main/src/lib/supabase.ts"
    click DatabaseService "https://github.com/screamonei2/oms/blob/main/src/lib/services/database.ts"
    click DBInit "https://github.com/screamonei2/oms/blob/main/src/lib/db/init.ts"
    click Schema "https://github.com/screamonei2/oms/blob/main/schema.sql"
    click Seed "https://github.com/screamonei2/oms/blob/main/dummy_data.sql"
    click Migrations "https://github.com/screamonei2/oms/tree/main/supabase/migrations"
    click TypesDb "https://github.com/screamonei2/oms/blob/main/src/lib/types/database.types.ts"
    click TypesShared "https://github.com/screamonei2/oms/blob/main/src/lib/types/shared.ts"
    click AuthUtils "https://github.com/screamonei2/oms/blob/main/src/lib/utils/auth.ts"
    click ErrorUtils "https://github.com/screamonei2/oms/blob/main/src/lib/utils/errorHandler.ts"
    click Fetcher "https://github.com/screamonei2/oms/blob/main/src/lib/utils/fetcher.ts"
    click PermUtils "https://github.com/screamonei2/oms/blob/main/src/lib/utils/permissions.ts"

    %% Styles
    classDef frontend fill:#EDF5FF,stroke:#0366d6,color:#0366d6;
    classDef server fill:#E6FFED,stroke:#28a745,color:#22863a;
    classDef backend fill:#FFF5E5,stroke:#D69E2E,color:#B1702A;
```
