# spatie/laravel-data architecture

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

- Interactive diagram: https://gitdiagram.com/spatie/laravel-data
- Repository: https://github.com/spatie/laravel-data

## Overview

##### Core Data Layer
- It to its essential concerns (BaseData, ValidateableData, TransformableData, etc.)

##### Data Processing Pipeline
- DataPipeline with its various pipes:
- AuthorizedDataPipe
- CastPropertiesDataPipe
- ValidatePropertiesDataPipe
- MapPropertiesDataPipe

##### Support Systems (arranged in clusters)
a. Transformation Layer
- Transformers
- Casts
- Normalizers

b. Validation Layer
- ValidationAttributes
- RuleInferrers
- Validators

c. Creation Layer
- Factories
- CreationContext
- DataContainer

##### Integration Points
- Connections to Laravel's core components:
- Eloquent Models
- Form Requests
- API Resources
- TypeScript generation capability

##### Data Collections
- Relationship between Data objects and Collections
- Specialized collections (Paginated, Cursor-paginated)

**┌─────────────────────────────── Laravel Application ───────────────────────────────┐**

- ┌─────────── Data Processing Pipeline ───────────┐                              │

- ┌─────┐    ┌─────┐    ┌─────┐    ┌─────┐   │                              │
- Auth │─►  │Cast │─►  │Valid│─►  │Map  │   │                              │
- Pipe │    │Pipe │    │Pipe │    │Pipe │   │                              │
- ┘    └─────┘    └─────┘    └─────┘   │                              │
- ┬───────────────────────┘                              │

- ┌─────────── Core Data Layer ──────────┐                                       │

- ┌─────────────────┐          │      ┌─── Integration Points ───┐     │
- Data       │          │      │                          │     │
- ┬────────┘          │      │  - Eloquent             │     │
- API Resources        │     │
- ┌───────────┴───────────┐        │      │  - Form Requests        │     │
- TypeScript           │     │
- ▼                       ▼        │      │                          │     │
- Validation           Transformation │      └──────────────────────────┘     │
- ┘                                       │

- ┘

Important Considerations:

##### Legends
- Component type indicators

##### Validation flow
- Request data → Validation → Data Object creation
- Attribute-based validation

##### Extensibility points
- Custom transformers
- Custom casts
- Custom validation rules

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Data Processing Pipeline"
        direction TB
        AuthPipe["AuthorizedDataPipe"]:::pipe
        CastPipe["CastPropertiesDataPipe"]:::pipe
        ValidPipe["ValidatePropertiesDataPipe"]:::pipe
        MapPipe["MapPropertiesDataPipe"]:::pipe
        
        AuthPipe --> CastPipe
        CastPipe --> ValidPipe
        ValidPipe --> MapPipe
    end

    subgraph "Core Data Layer"
        direction TB
        Data["Data Class"]:::core
        BaseData["BaseData"]:::core
        ValidData["ValidateableData"]:::core
        TransformData["TransformableData"]:::core
        
        Data --> BaseData
        Data --> ValidData
        Data --> TransformData
    end

    subgraph "Support Systems"
        direction TB
        subgraph "Transformation"
            Transformers["Transformers"]:::transform
            Casts["Casts"]:::transform
            Normalizers["Normalizers"]:::transform
        end

        subgraph "Validation"
            ValAttributes["Validation Attributes"]:::validate
            RuleInferrers["Rule Inferrers"]:::validate
            Validators["Validators"]:::validate
        end

        subgraph "Creation"
            Factories["Factories"]:::create
            CreationContext["Creation Context"]:::create
            DataContainer["Data Container"]:::create
        end
    end

    subgraph "Integration Points"
        direction TB
        TypeScript["TypeScript Generation"]:::integration
        Laravel["Laravel Integration"]:::integration
        Eloquent["Eloquent Integration"]:::integration
    end

    subgraph "Collections"
        direction TB
        BaseCollection["Data Collection"]:::collection
        PaginatedCollection["Paginated Collection"]:::collection
        CursorCollection["Cursor Paginated Collection"]:::collection
        
        BaseCollection --> PaginatedCollection
        BaseCollection --> CursorCollection
    end

    %% Connections
    Data --> AuthPipe
    MapPipe --> Data
    Data --> Transformers
    Data --> ValAttributes
    Data --> BaseCollection
    Data --> Laravel

    %% Click Events
    click Data "https://github.com/spatie/laravel-data/blob/main/src/Data.php"
    click BaseData "https://github.com/spatie/laravel-data/blob/main/src/Concerns/BaseData.php"
    click ValidData "https://github.com/spatie/laravel-data/blob/main/src/Concerns/ValidateableData.php"
    click TransformData "https://github.com/spatie/laravel-data/blob/main/src/Concerns/TransformableData.php"
    click AuthPipe "https://github.com/spatie/laravel-data/blob/main/src/DataPipes/AuthorizedDataPipe.php"
    click CastPipe "https://github.com/spatie/laravel-data/blob/main/src/DataPipes/CastPropertiesDataPipe.php"
    click ValidPipe "https://github.com/spatie/laravel-data/blob/main/src/DataPipes/ValidatePropertiesDataPipe.php"
    click MapPipe "https://github.com/spatie/laravel-data/blob/main/src/DataPipes/MapPropertiesDataPipe.php"
    click Transformers "https://github.com/spatie/laravel-data/tree/main/src/Transformers"
    click Casts "https://github.com/spatie/laravel-data/tree/main/src/Casts"
    click Normalizers "https://github.com/spatie/laravel-data/tree/main/src/Normalizers"
    click ValAttributes "https://github.com/spatie/laravel-data/tree/main/src/Attributes/Validation"
    click RuleInferrers "https://github.com/spatie/laravel-data/tree/main/src/RuleInferrers"
    click Validators "https://github.com/spatie/laravel-data/tree/main/src/Support/Validation"
    click Factories "https://github.com/spatie/laravel-data/tree/main/src/Support/Factories"
    click CreationContext "https://github.com/spatie/laravel-data/blob/main/src/Support/Creation/CreationContext.php"
    click DataContainer "https://github.com/spatie/laravel-data/blob/main/src/Support/DataContainer.php"
    click TypeScript "https://github.com/spatie/laravel-data/tree/main/src/Support/TypeScriptTransformer"
    click Laravel "https://github.com/spatie/laravel-data/blob/main/src/LaravelDataServiceProvider.php"
    click Eloquent "https://github.com/spatie/laravel-data/tree/main/src/Support/EloquentCasts"
    click BaseCollection "https://github.com/spatie/laravel-data/blob/main/src/DataCollection.php"
    click PaginatedCollection "https://github.com/spatie/laravel-data/blob/main/src/PaginatedDataCollection.php"
    click CursorCollection "https://github.com/spatie/laravel-data/blob/main/src/CursorPaginatedDataCollection.php"

    %% Styling
    classDef core fill:#2563eb,color:white
    classDef pipe fill:#16a34a,color:white
    classDef transform fill:#9333ea,color:white
    classDef validate fill:#dc2626,color:white
    classDef create fill:#ea580c,color:white
    classDef integration fill:#0284c7,color:white
    classDef collection fill:#4f46e5,color:white
```
