# breeze/breeze-client architecture

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

- Interactive diagram: https://gitdiagram.com/breeze/breeze-client
- Repository: https://github.com/breeze/breeze-client

## Overview

##### Project Type and Purpose
- This is an open-source JavaScript client library (“breeze-client”) for rich data management in browser/mobile apps.
- Key features: client-side querying, change tracking, model validation, batch saves, offline support.
- It exposes a core API (EntityManager, EntityQuery, etc.) and is extended via adapters (HTTP, OData, URI builders, model libraries) and mixins.

##### High-Level Architecture Overview
- Core Library: central modules under src/core, src/entity-*. These implement the EntityManager, metadata parsing, change tracking, validation, queries, and save logic.
- Adapters: protocol-specific plugins (adapter-ajax-*, adapter-data-service-*, adapter-model-library-*) that implement HTTP transport, OData/WebAPI conventions, knockout/backing-store integration, URI building.
- Mixins: optional behaviors that augment the core (get-entity-graph, save-queuing).
- Public API Layer: public_api.ts, index.ts export the assembled API surface.
- Packaging/Build Tools: tools/ scripts for bundling, generating Angular package format, UMD bundles, etc.
- Tests: spec/ directory contains unit and integration tests validating core, adapters, mixins using Jest.

##### Main Components and Relationships
a. Core Module
- EntityManager & EntityQuery
- Metadata parsers (csdl-metadata-parser)
- Change tracking, validation, eventing
b. Adapter Layer (Plugin Pattern)
- AbstractAdapter defines the interface
- Concrete adapters register with interface-registry
- DataServiceAdapters (OData, WebAPI) use adapters+URI builders
- AjaxAdapters (fetch, AngularJS, jQuery, HttpClient, fake for tests)
c. Mixin Layer
- Mixin modules hook into EntityManager to add graph retrieval and save-queuing
d. Public API
- Aggregates and re-exports core, adapters, mixins
e. Build/Packaging
- Tools generate ESM2022, FESM2022, and UMD bundles per ng-package.json configs
f. Testing
- spec/ exercises core+adapters+mixin integration against fake backends + real JSON metadata

##### Architectural Patterns and Principles
- Modular, plugin-based design—adapters and mixins are loosely coupled via a registry
- Separation of concerns—core only defines abstractions, protocol details live in adapters
- Dependency injection at runtime via adapter registration
- API surface is stable and versioned via ng-package and package.json metadata

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Public API
    PublicAPI["Public API"]:::api

    %% Core Module
    subgraph "Core Module"
        CoreTS["core.ts"]:::core
        EM["entity-manager.ts"]:::core
        EQ["entity-query.ts"]:::core
        MP["csdl-metadata-parser.ts"]:::core
        VAL["validate.ts"]:::core
    end

    %% Adapter Registry
    AR["Adapter Registry"]:::adapter

    %% Adapters
    subgraph "Ajax Adapters"
        AA1["adapter-ajax-angularjs.ts"]:::adapter
        AA2["adapter-ajax-fetch.ts"]:::adapter
        AA3["adapter-ajax-httpclient.ts"]:::adapter
        AA4["adapter-ajax-jquery.ts"]:::adapter
        AA5["adapter-ajax-post.ts"]:::adapter
        AA6["adapter-ajax-fake.ts"]:::adapter
    end

    subgraph "Data Service Adapters"
        DS1["adapter-data-service-odata.ts"]:::adapter
        DS2["adapter-data-service-webapi.ts"]:::adapter
    end

    subgraph "Model Library Adapters"
        ML1["adapter-model-library-backing-store.ts"]:::adapter
        ML2["adapter-model-library-ko.ts"]:::adapter
    end

    subgraph "URI Builders"
        UB1["adapter-uri-builder-json.ts"]:::adapter
        UB2["adapter-uri-builder-odata.ts"]:::adapter
    end

    %% Mixins
    subgraph "Mixins"
        MX1["mixin-get-entity-graph.ts"]:::mixin
        MX2["mixin-save-queuing.ts"]:::mixin
    end

    %% Build Tools and Tests
    BT["Build/Packaging Tools"]:::tool
    TZ["Tests"]:::test

    %% Connections
    PublicAPI --> CoreTS
    PublicAPI --> AR
    PublicAPI --> MX1
    PublicAPI --> MX2

    CoreTS --> EM
    CoreTS --> EQ
    CoreTS --> MP
    CoreTS --> VAL

    EM --> AR
    EQ --> AR
    MP --> AR
    VAL --> AR

    AR --> AA1
    AR --> AA2
    AR --> AA3
    AR --> AA4
    AR --> AA5
    AR --> AA6

    AR --> DS1
    AR --> DS2

    DS1 --> UB1
    DS1 --> UB2
    DS2 --> UB1
    DS2 --> UB2

    CoreTS -.-> MX1
    CoreTS -.-> MX2

    BT -.-> PublicAPI
    BT -.-> CoreTS

    TZ --> PublicAPI
    TZ --> AA6

    %% Click Events
    click CoreTS "https://github.com/breeze/breeze-client/blob/master/src/core.ts"
    click EM "https://github.com/breeze/breeze-client/blob/master/src/entity-manager.ts"
    click EQ "https://github.com/breeze/breeze-client/blob/master/src/entity-query.ts"
    click MP "https://github.com/breeze/breeze-client/blob/master/src/csdl-metadata-parser.ts"
    click VAL "https://github.com/breeze/breeze-client/blob/master/src/validate.ts"
    click AR "https://github.com/breeze/breeze-client/blob/master/src/interface-registry.ts"
    click AA1 "https://github.com/breeze/breeze-client/blob/master/src/adapter-ajax-angularjs.ts"
    click AA2 "https://github.com/breeze/breeze-client/blob/master/src/adapter-ajax-fetch.ts"
    click AA3 "https://github.com/breeze/breeze-client/blob/master/src/adapter-ajax-httpclient.ts"
    click AA4 "https://github.com/breeze/breeze-client/blob/master/src/adapter-ajax-jquery.ts"
    click AA5 "https://github.com/breeze/breeze-client/blob/master/src/adapter-ajax-post.ts"
    click AA6 "https://github.com/breeze/breeze-client/blob/master/src/adapter-ajax-fake.ts"
    click DS1 "https://github.com/breeze/breeze-client/blob/master/src/adapter-data-service-odata.ts"
    click DS2 "https://github.com/breeze/breeze-client/blob/master/src/adapter-data-service-webapi.ts"
    click ML1 "https://github.com/breeze/breeze-client/blob/master/src/adapter-model-library-backing-store.ts"
    click ML2 "https://github.com/breeze/breeze-client/blob/master/src/adapter-model-library-ko.ts"
    click UB1 "https://github.com/breeze/breeze-client/blob/master/src/adapter-uri-builder-json.ts"
    click UB2 "https://github.com/breeze/breeze-client/blob/master/src/adapter-uri-builder-odata.ts"
    click MX1 "https://github.com/breeze/breeze-client/blob/master/src/mixin-get-entity-graph.ts"
    click MX2 "https://github.com/breeze/breeze-client/blob/master/src/mixin-save-queuing.ts"
    click PublicAPI "https://github.com/breeze/breeze-client/blob/master/public_api.ts"
    click PublicAPI "https://github.com/breeze/breeze-client/blob/master/index.ts"
    click BT "https://github.com/breeze/breeze-client/tree/master/tools/"
    click BT "https://github.com/breeze/breeze-client/blob/master/ng-package.json"
    click TZ "https://github.com/breeze/breeze-client/tree/master/spec/"

    %% Styles
    classDef core fill:#D0E4F5,stroke:#0366d6,stroke-width:1px
    classDef adapter fill:#DFF5E1,stroke:#28a745,stroke-width:1px
    classDef mixin fill:#FFE7C6,stroke:#f08c00,stroke-width:1px
    classDef api fill:#E5DAF7,stroke:#6f42c1,stroke-width:1px
    classDef tool fill:#F0F0F0,stroke:#6a737d,stroke-width:1px
    classDef test fill:#FDE8E8,stroke:#d73a49,stroke-width:1px
```
