# hexya-addons/web architecture

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

- Interactive diagram: https://gitdiagram.com/hexya-addons/web
- Repository: https://github.com/hexya-addons/web

## Overview

##### Project Type and Purpose
- This is a full-stack web client module (called “web”) for the Hexya framework.
- Backend: written in Go, exposing HTTP controllers, RPC endpoints, domain logic, i18n and an Odoo-proxy.
- Frontend: a rich JavaScript/CSS/QWeb application (borrowed from Odoo web client), organized into modules (core, chrome, fields, views, services, widgets).

##### High-Level Components
a. Browser-Side Application
- Static Assets Servered:
– JavaScript libraries and app code under static/src/js (core, chrome, fields, views, services, widgets)
– SCSS/CSS under static/src/scss
– QWeb XML templates under static/src/xml
– 3rd-party libs under static/lib
- Module Layers:
– Core services (ajax, rpc, session)
– UI chrome (menu, sidebar, root_widget)
– Field types, views (form, list, kanban, graph, calendar), widgets
– Data & state management (ram_storage, local_storage)
– Internationalization (i18n files)

b. Go Backend Server
- Entry point in 000hexya.go, client/client.go
- HTTP Controllers under controllers/ (login, session, assets, proxy, webclient, dataset, binary, model_calls, etc.)
- Domain logic under domains/ and company.go, user.go
- Security, filters, mixins, session management
- Odoo RPC proxy module (odooproxy/) forwarding calls to an Odoo instance
- Resources definitions (XML) under resources/
- Build & config: go.mod, .travis.yml, run_tests.sh, scripts/i18nUpdate.go

c. External Dependencies
- Odoo backend (via proxy)
- Browser loads external JS/CSS libs (jQuery, Bootstrap, ace editor, Chart.js, pdfjs, etc.)
- No direct database connection in this module; domain data managed via Hexya ORM elsewhere.

##### Relationships and Data Flows
- Browser → HTTP Server:
- Initial page load & asset download (controllers/assets)
- AJAX/RPC calls (controllers/model_calls, dataset, binary…)
- HTTP Server → Domain Layer:
- Controllers invoke domain functions (domains/domains.go)
- Security & session middleware enforce access
- HTTP Server → Odoo:
- Proxy controller forwards certain RPCs to an external Odoo server
- Browser Internal:
- JS UI modules communicate via rpc.ajax→backend, update models in RAM/local storage, render views with QWeb

##### Architectural Patterns & Design Principles
- MVC on both sides:
- Backend: Controllers → Domains (Models) → Templates/JSON
- Frontend: Models (ram_storage/local_storage) → Controllers (basic_controller) → Views/Renderers
- Service-oriented frontend with decoupled modules and event bus (bus.js)
- Single Page Application (SPA) style with dynamic view switching
- Internationalization via .po files loaded server-side then used in JS

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Browser Layer
    subgraph "Browser (Client)" 
        direction TB
        Browser["SPA Browser"]:::frontend
        subgraph "JS Modules"
            direction TB
            Core["Core Services"]:::frontend
            Chrome["UI Chrome"]:::frontend
            Fields["Field Types"]:::frontend
            Views["Views Layer"]:::frontend
            Widgets["Widgets"]:::frontend
            Services["Frontend Services"]:::frontend
        end
        QWeb["QWeb Templates"]:::frontend
        SCSS["SCSS/CSS Styles"]:::frontend
        Libs["3rd-Party Libs"]:::frontend
    end

    %% Backend Layer
    subgraph "Go Backend Server" 
        direction TB
        Entry["Entry Points"]:::backend
        Controllers["HTTP Controllers"]:::backend
        Domains["Domain Logic Layer"]:::backend
        Proxy["Odoo RPC Proxy"]:::backend
        Resources["Resource Definitions"]:::backend
        I18n["Internationalization (.po)"]:::backend
        Build["Build & Config"]:::backend
    end

    %% External
    subgraph "External Services"
        direction TB
        OdooExt["External Odoo Server"]:::external
        CDN["CDN Libraries"]:::external
    end

    %% Relationships
    Browser -->|"GET /static, /templates"| Controllers
    Browser -->|"AJAX/RPC"| Controllers
    Controllers -->|"invoke domains"| Domains
    Controllers -->|"proxy RPC calls"| Proxy
    Proxy -->|"forward RPC"| OdooExt
    QWeb -->|load templates| Controllers
    I18n -->|load translations| Controllers
    Controllers -->|serve assets| Core
    Controllers -->|serve assets| Chrome
    Controllers -->|serve assets| Fields
    Controllers -->|serve assets| Views
    Controllers -->|serve assets| Widgets
    Controllers -->|serve assets| Services
    Controllers -->|serve assets| QWeb
    Controllers -->|serve assets| SCSS
    Controllers -->|serve assets| Libs

    %% Click Events - Frontend
    click Core "https://github.com/hexya-addons/web/tree/master/static/src/js/core/"
    click Chrome "https://github.com/hexya-addons/web/tree/master/static/src/js/chrome/"
    click Fields "https://github.com/hexya-addons/web/tree/master/static/src/js/fields/"
    click Views "https://github.com/hexya-addons/web/tree/master/static/src/js/views/"
    click Widgets "https://github.com/hexya-addons/web/tree/master/static/src/js/widgets/"
    click Services "https://github.com/hexya-addons/web/tree/master/static/src/js/services/"
    click QWeb "https://github.com/hexya-addons/web/tree/master/static/src/xml/"
    click SCSS "https://github.com/hexya-addons/web/tree/master/static/src/scss/"
    click Libs "https://github.com/hexya-addons/web/tree/master/static/lib/"

    %% Click Events - Backend
    click Entry "https://github.com/hexya-addons/web/blob/master/000hexya.go"
    click Entry "https://github.com/hexya-addons/web/blob/master/client/client.go"
    click Controllers "https://github.com/hexya-addons/web/tree/master/controllers/"
    click Domains "https://github.com/hexya-addons/web/blob/master/domains/domains.go"
    click Domains "https://github.com/hexya-addons/web/blob/master/domains/domains_test.go"
    click Domains "https://github.com/hexya-addons/web/blob/master/company.go"
    click Domains "https://github.com/hexya-addons/web/blob/master/user.go"
    click Domains "https://github.com/hexya-addons/web/blob/master/filter.go"
    click Domains "https://github.com/hexya-addons/web/blob/master/security.go"
    click Domains "https://github.com/hexya-addons/web/blob/master/common_mixin.go"
    click Proxy "https://github.com/hexya-addons/web/blob/master/odooproxy/odooproxy.go"
    click Resources "https://github.com/hexya-addons/web/tree/master/resources/"
    click I18n "https://github.com/hexya-addons/web/tree/master/i18n/"
    click Build "https://github.com/hexya-addons/web/blob/master/go.mod"
    click Build "https://github.com/hexya-addons/web/blob/master/go.sum"
    click Build "https://github.com/hexya-addons/web/blob/master/.travis.yml"
    click Build "https://github.com/hexya-addons/web/blob/master/run_tests.sh"
    click Build "https://github.com/hexya-addons/web/blob/master/scripts/i18nUpdate.go"

    %% Styles
    classDef frontend fill:#e0ffe0,stroke:#2d662d,color:#000;
    classDef backend fill:#e0e0ff,stroke:#26396b,color:#000;
    classDef external fill:#f0f0f0,stroke:#555,color:#000;
```
