# gid-oss/dataui-nestjs-crud architecture

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

- Interactive diagram: https://gitdiagram.com/gid-oss/dataui-nestjs-crud
- Repository: https://github.com/gid-oss/dataui-nestjs-crud

## Overview

##### Main Components Identification
The system should be represented as a modular microframework with three main packages:

a) Core Components (@dataui/crud):
- Interceptors, decorators, and validation components
- Configuration service and reflection helpers

b) Request Handling (@dataui/crud-request):
- RequestQueryBuilder and RequestQueryParser
- Validation and exception handling components
- Query parsing flow

c) Database Integration (@dataui/crud-typeorm):
- TypeOrmCrudService as the base service layer
- Connection to various database systems (MySQL, PostgreSQL)
- Entity-service relationship

##### Relationships and Interactions

- Client Request → RequestQueryParser → Controller → Service → Database
- How the CRUD decorator integrates with NestJS controllers
- Relationship between DTOs, entities, and responses

##### Architectural Pattern Representation

Use these visual elements:
- Hexagonal architecture pattern showing clear separation of:
- Core business logic (inner layer)
- Controllers and DTOs (middle layer)
- External interfaces (outer layer)
- Blue: Core CRUD functionality
- Green: Request handling components
- Orange: Database integration
- Gray: External interfaces

##### Component Details

Specific elements:
**┌─ Client Layer ─────────────────────┐**
- RequestQueryBuilder                 │
- ┬──────────────────────┘
- ↓
**┌─ API Layer ──┴─────────────────────┐**
- ┌─ @Crud Decorator ─┐              │
- Controllers     │              │
- Interceptors    │              │
- Validators      │              │
- ┬─┘              │
- ┬─────────────────┘
- ↓
**┌─ Service Layer ──┴─────────────────┐**
- ┌─ TypeOrmCrudService ─┐           │
- CRUD Operations    │           │
- Query Building     │           │
- ┬───┘           │
- ┬────────────────┘
- ↓
**┌─ Database Layer ─┴─────────────────┐**
- MySQL / PostgreSQL                  │
- ┘

##### Integration Points

Integration with:
- NestJS framework
- TypeORM
- Swagger documentation
- Frontend applications

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Client
        RQB[RequestQueryBuilder]
    end

    subgraph "API Layer"
        CD["@Crud Decorator"]
        INT[Interceptors]
        VAL[Validation]
        SWG[Swagger Helper]
    end

    subgraph "Service Layer"
        ACS[Abstract CRUD Service]
        TOCS[TypeOrmCrudService]
        SI[Service Interfaces]
    end

    subgraph "Request Processing"
        RQP[RequestQueryParser]
        RQV[Request Validator]
        EXC[Exception Handler]
    end

    subgraph "Database Layer"
        DB1[(MySQL)]
        DB2[(PostgreSQL)]
    end

    subgraph "Core Components"
        CS[Configuration Service]
        RH[Reflection Helpers]
    end

    %% Relationships
    RQB --> RQP
    RQP --> CD
    CD --> INT
    CD --> VAL
    CD --> SWG
    INT --> ACS
    VAL --> RQV
    RQV --> EXC
    ACS --> TOCS
    TOCS --> DB1
    TOCS --> DB2
    CS --> CD
    RH --> CD
    SI --> ACS

    %% Click Events
    click CD "https://github.com/gid-oss/dataui-nestjs-crud/blob/master/packages/crud/src/decorators/crud.decorator.ts"
    click INT "https://github.com/gid-oss/dataui-nestjs-crud/tree/master/packages/crud/src/interceptors/"
    click VAL "https://github.com/gid-oss/dataui-nestjs-crud/blob/master/packages/crud/src/crud/validation.helper.ts"
    click CS "https://github.com/gid-oss/dataui-nestjs-crud/blob/master/packages/crud/src/module/crud-config.service.ts"
    click RH "https://github.com/gid-oss/dataui-nestjs-crud/blob/master/packages/crud/src/crud/reflection.helper.ts"
    click RQB "https://github.com/gid-oss/dataui-nestjs-crud/blob/master/packages/crud-request/src/request-query.builder.ts"
    click RQP "https://github.com/gid-oss/dataui-nestjs-crud/blob/master/packages/crud-request/src/request-query.parser.ts"
    click RQV "https://github.com/gid-oss/dataui-nestjs-crud/blob/master/packages/crud-request/src/request-query.validator.ts"
    click EXC "https://github.com/gid-oss/dataui-nestjs-crud/blob/master/packages/crud-request/src/exceptions/request-query.exception.ts"
    click TOCS "https://github.com/gid-oss/dataui-nestjs-crud/blob/master/packages/crud-typeorm/src/typeorm-crud.service.ts"
    click ACS "https://github.com/gid-oss/dataui-nestjs-crud/blob/master/packages/crud/src/services/crud-service.abstract.ts"
    click SI "https://github.com/gid-oss/dataui-nestjs-crud/blob/master/packages/crud/src/interfaces/crud-controller.interface.ts"
    click SWG "https://github.com/gid-oss/dataui-nestjs-crud/blob/master/packages/crud/src/crud/swagger.helper.ts"

    %% Styling
    classDef core fill:#2196F3,color:white
    classDef request fill:#4CAF50,color:white
    classDef database fill:#FF9800,color:white
    classDef external fill:#9E9E9E,color:white

    class CD,INT,VAL,CS,RH,ACS,SI core
    class RQB,RQP,RQV,EXC request
    class TOCS,DB1,DB2 database
    class SWG external
```
