# marrwan/package_management architecture

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

- Interactive diagram: https://gitdiagram.com/marrwan/package_management
- Repository: https://github.com/marrwan/package_management

## Overview

##### Project type and purpose
- This is a standalone backend service—a GraphQL API built with Express and Apollo Server—focused on package management and user authentication.
- It exposes queries and mutations over HTTP, interacts with MongoDB, and secures endpoints via JWT-based auth.

##### File structure
- Entry point:
- `bin/www` – launches the HTTP server
- `app.js` – sets up Express, Apollo Server, middleware, and GraphQL endpoint
- Configuration:
- `src/config/db.js` – connects to MongoDB using `MONGO_URI`
- Middleware:
- `src/middlewares/auth.middleware.js` – parses/validates JWT, attaches user to request
- GraphQL layer:
- `src/graphql/schemas/schema.js` – defines typeDefs
- `src/graphql/resolvers/*.resolvers.js` – resolve functions for queries/mutations
- Business logic:
- `src/services/*.service.js` – implement domain operations (user registration, login, package CRUD)
- Data layer:
- `src/models/*.model.js` – Mongoose schema definitions for User and Package
- Utilities:
- `src/utils/hash.utils.js` – password hashing
- `src/utils/jwt.utils.js` – token creation/verification
- `src/utils/validation.utils.js` – input validation
- Environment:
- `.env` – holds `MONGO_URI`, `PORT`, `JWT_SECRET`, `NODE_ENV`

##### README for additional insights
- Apollo Server is mounted at `/graphql`.
- JWT tokens guard mutations (create/update/delete/switchRole).
- Supported operations: user auth, package CRUD, filtering.
- Uses MongoDB for persistence.

##### Main components & their interactions
a. Clients
- GraphQL clients (GraphQL Playground, Postman, Front-end)
b. API Gateway
- Express HTTP server + Apollo GraphQL middleware
c. Auth Middleware
- Intercepts requests → verifies JWT → attaches user context
d. GraphQL Layer
- Resolvers dispatch to services
e. Service Layer
- Contains business rules (auth, package logic)
- Calls data layer via models
f. Data Layer
- Mongoose models perform CRUD on MongoDB
g. External Systems
- MongoDB database
- Environment (secrets, config)

Flow: Client → HTTP POST /graphql → Auth Middleware → Apollo Server
→ Schema & Resolvers → Service methods → Mongoose Models → MongoDB
← Data ← Model ← Service ← Resolver ← Response → Client

##### Architectural patterns and principles
- Layered architecture: presentation (GraphQL), application (services), domain/data (models)
- Separation of concerns: each directory has a single responsibility
- JWT-based stateless authentication
- Apollo Server for schema-first GraphQL API
- Use of environment variables for config and secrets
- Centralized error handling in resolvers/services

##### Final advice
- Critical paths: both authenticated and public
- Clearly call out the flow of tokens and data

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Clients
    Client["Clients\n(GraphQL Playground,\nPostman, Front-end)"]:::external

    %% Entry Layer
    subgraph "Entry Layer"
        direction TB
        BinWWW["bin/www\n(HTTP Server Launcher)"]:::api
        AppJS["app.js\n(Express + Apollo Setup)"]:::api
    end

    %% Middleware
    AuthMW["Auth Middleware\n(src/middlewares/auth.middleware.js)"]:::api

    %% GraphQL Layer
    subgraph "GraphQL Layer"
        direction TB
        Schema["Schema\ntypeDefs\n(src/graphql/schemas/schema.js)"]:::api
        ResolversIndex["Resolvers Index\n(src/graphql/resolvers/index.js)"]:::api
        AuthResolvers["Auth Resolvers\n(src/graphql/resolvers/auth.resolvers.js)"]:::api
        PackageResolvers["Package Resolvers\n(src/graphql/resolvers/package.resolvers.js)"]:::api
    end

    %% Service Layer
    subgraph "Service Layer"
        direction TB
        AuthService["Auth Service\n(src/services/auth.service.js)"]:::service
        PackageService["Package Service\n(src/services/package.service.js)"]:::service
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        UserModel["User Model\n(src/models/user.model.js)"]:::data
        PackageModel["Package Model\n(src/models/package.model.js)"]:::data
        MongoDB[(MongoDB)]:::data
    end

    %% Utilities & Config
    subgraph "Utilities & Config"
        direction TB
        DBConfig["DB Config\n(src/config/db.js)"]:::util
        HashUtil["Hash Utils\n(src/utils/hash.utils.js)"]:::util
        JWTUtil["JWT Utils\n(src/utils/jwt.utils.js)"]:::util
        ValidationUtil["Validation Utils\n(src/utils/validation.utils.js)"]:::util
        Env[".env\n(Environment Variables)"]:::util
        PackageJSON["package.json"]:::util
        PackageLock["package-lock.json"]:::util
        GitIgnore[".gitignore"]:::util
        Readme["README.md"]:::util
    end

    %% Connections
    Client -->|HTTP POST /graphql| BinWWW
    BinWWW -->|launch| AppJS
    AppJS -->|mounts middleware| AuthMW
    AppJS -->|mounts GraphQL endpoint| Schema
    AppJS --> Schema
    AuthMW -->|attaches user context| ResolversIndex
    Schema --> ResolversIndex
    ResolversIndex --> AuthResolvers
    ResolversIndex --> PackageResolvers
    AuthResolvers --> AuthService
    PackageResolvers --> PackageService
    AuthService --> UserModel
    AuthService --> PackageModel
    PackageService --> PackageModel
    PackageService --> UserModel
    UserModel --> MongoDB
    PackageModel --> MongoDB

    %% Utilities & Config Connections
    Env --> DBConfig
    DBConfig --> MongoDB
    Env --> JWTUtil
    AuthMW --> JWTUtil
    AuthService --> JWTUtil
    AuthService --> HashUtil
    AuthResolvers --> ValidationUtil

    %% Click Events
    click BinWWW "https://github.com/marrwan/package_management/tree/main/bin/www"
    click AppJS "https://github.com/marrwan/package_management/blob/main/app.js"
    click DBConfig "https://github.com/marrwan/package_management/blob/main/src/config/db.js"
    click AuthMW "https://github.com/marrwan/package_management/blob/main/src/middlewares/auth.middleware.js"
    click Schema "https://github.com/marrwan/package_management/blob/main/src/graphql/schemas/schema.js"
    click AuthResolvers "https://github.com/marrwan/package_management/blob/main/src/graphql/resolvers/auth.resolvers.js"
    click PackageResolvers "https://github.com/marrwan/package_management/blob/main/src/graphql/resolvers/package.resolvers.js"
    click ResolversIndex "https://github.com/marrwan/package_management/blob/main/src/graphql/resolvers/index.js"
    click AuthService "https://github.com/marrwan/package_management/blob/main/src/services/auth.service.js"
    click PackageService "https://github.com/marrwan/package_management/blob/main/src/services/package.service.js"
    click UserModel "https://github.com/marrwan/package_management/blob/main/src/models/user.model.js"
    click PackageModel "https://github.com/marrwan/package_management/blob/main/src/models/package.model.js"
    click HashUtil "https://github.com/marrwan/package_management/blob/main/src/utils/hash.utils.js"
    click JWTUtil "https://github.com/marrwan/package_management/blob/main/src/utils/jwt.utils.js"
    click ValidationUtil "https://github.com/marrwan/package_management/blob/main/src/utils/validation.utils.js"
    click Env "https://github.com/marrwan/package_management/blob/main/.env.example"
    click PackageJSON "https://github.com/marrwan/package_management/blob/main/package.json"
    click PackageLock "https://github.com/marrwan/package_management/blob/main/package-lock.json"
    click GitIgnore "https://github.com/marrwan/package_management/blob/main/.gitignore"
    click Readme "https://github.com/marrwan/package_management/blob/main/README.md"

    %% Styles
    classDef api fill:#E3F2FD,stroke:#64B5F6,color:#0D47A1,stroke-width:1px
    classDef service fill:#E8F5E9,stroke:#66BB6A,color:#1B5E20,stroke-width:1px
    classDef data fill:#FFF3E0,stroke:#FFA726,color:#E65100,stroke-width:1px
    classDef util fill:#CFD8DC,stroke:#90A4AE,color:#37474F,stroke-width:1px
    classDef external fill:#FFECB3,stroke:#FFD54F,color:#BF360C,stroke-width:1px
```
