How breeze/breeze-client works
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