lcbp3/5_Backend_Folder_V1_4_3.md

โครงสร้างโฟลเดอร์และไฟล์ทั้งหมดสำหรับ Backend (NestJS) ตามแผนงาน LCBP3-DMS v1.4.3 ตั้งแต่ Phase 0 ถึง Phase 6 (T0-T6.2) ที่ได้ดำเนินการไปแล้ว

โครงสร้างนี้ออกแบบตามหลัก Domain-Driven Design และ Modular Architecture ที่ระบุไว้ในแผนพัฒนา

---

📂 backend/ (Backend Application)

• .env (สำหรับ Local Dev เท่านั้น ห้าม commit)
• .gitignore
• .prettierrc
• docker-compose.override.yml
• docker-compose.yml
• nest-cli.json
• tsconfig.build.json
• tsconfig.json
• package.json
• pnpm-lock.yaml
• README.md

---

📂 backend/src/ (Source Code)

**📄 Entry Points

• main.ts
• app.module.ts
• app.service.ts
• app.controller.ts
• app.controller.spec.ts
• redlock.d.ts

📁 src/common/ (Shared Resources)

• common.module.ts
• auth/
  • dto/
    • login.dto.ts
    • register.dto.ts
  • strategies/
    • local.strategy.ts
    • jwt.strategy.ts
  • auth.controller.spec.ts
  • auth.controller.ts
  • auth.module.ts
  • auth.service.spec.ts
  • auth.service.ts
• config/
  • env.validation.ts
  • redis.config.ts
• decorators/
  • audit.decorator.ts
  • bypass-maintenance.decorator.ts
  • current-user.decorator.ts
  • idempotency.decorator.ts
  • require-permission.decorator.ts
  • retry.decorator.ts
  • circuit-breaker.decorator.ts
• entities/
  • audit-log.entity.ts
  • base.entity.ts
• exceptions/
  • http-exception.filter.ts
• file-storage/
  • entities/
    • attachment.entity.ts
  • file-storage.controller.spec.ts
  • file-storage.controller.ts
  • file-storage.module.ts
  • file-storage.service.spec.ts
  • file-storage.service.ts
  • file-cleanup.service.ts
• guards/`
  • jwt-auth.guard.ts
  • jwt-refresh.guard.ts
  • maintenance-mode.guard.ts
  • rbac.guard.ts
• interceptors/
  • audit-log.interceptor.ts
  • idempotency.interceptor.ts
  • performance.interceptor.ts
  • transform.interceptor.ts
• resilience/
  • resilience.module.ts
• services/
  • crypto.service.ts
  • request-context.service.ts

📁 src/modules/ (Feature Modules)

1. user/ (User Management & RBAC)

   • dto/
     • assign-user-role.dto.ts
     • create-user.dto.ts
     • update-user.dto.ts
     • update-user-preference.dto.ts
   • entities/
     • user.entity.ts
     • role.entity.ts
     • permission.entity.ts
     • user-assignment.entity.ts
     • user-preference.entity.ts
   • user-assignment.service.ts
   • user-preference.service.ts
   • user.controller.ts
   • user.module.ts
   • user.service.ts
   • user.service.spec.ts

2. project/ (Project Structure)

   • dto/
     • create-project.dto.ts
     • search-project.dto.ts
     • update-project.dto.ts
   • entities/
     • contract-organization.entity.ts
     • contract.entity.ts
     • organization.entity.ts
     • project-organization.entity.ts
     • project.entity.ts
   • project.controller.spec.ts
   • project.controller.ts
   • project.module.ts
   • project.service.spec.ts
   • project.service.ts

3. correspondence/ (Core Document System)

   • dto/
     • add-reference.dto.ts
     • create-correspondence.dto.ts
     • search-correspondence.dto.ts
     • submit-correspondence.dto.ts
     • workflow-action.dto.ts
   • entities/
     • correspondence-reference.entity.ts
     • correspondence-revision.entity.ts
     • correspondence-routing.entity.ts
     • correspondence-status.entity.ts
     • correspondence-type.entity.ts
     • correspondence.entity.ts
     • routing-template-step.entity.ts
     • routing-template.entity.ts
   • correspondence.controller.spec.ts
   • correspondence.controller.ts
   • correspondence.module.ts
   • correspondence.service.spec.ts
   • correspondence.service.ts

4. drawing/ (Contract & Shop Drawings)

   • dto/
     • create-contract-drawing.dto.ts
     • create-shop-drawing-revision.dto.ts
     • create-shop-drawing.dto.ts
     • search-contract-drawing.dto.ts
     • search-shop-drawing.dto.ts
     • update-contract-drawing.dto.ts
   • entities/
     • contract-drawing-sub-category.entity.ts
     • contract-drawing-volume.entity.ts
     • contract-drawing.entity.ts
     • shop-drawing-main-category.entity.ts
     • shop-drawing-revision.entity.ts
     • shop-drawing-sub-category.entity.ts
     • shop-drawing.entity.ts
   • contract-drawing.controller.ts
   • contract-drawing.service.ts
   • drawing-master-data.controller.ts
   • drawing-master-data.service.ts
   • drawing.module.ts
   • shop-drawing.controller.ts
   • shop-drawing.service.ts

5. rfa/ (Request for Approval & Advanced Workflow)

   • dto/
     • create-rfa.dto.ts
     • search-rfa.dto.ts
     • update-rfa.dto.ts
   • entities/
     • rfa-approve-code.entity.ts
     • rfa-item.entity.ts
     • rfa-revision.entity.ts
     • rfa-status-code.entity.ts
     • rfa-type.entity.ts
     • rfa-workflow-template-step.entity.ts
     • rfa-workflow-template.entity.ts
     • rfa-workflow.entity.ts
     • rfa.entity.ts
   • rfa.controller.ts
   • rfa.module.ts
   • rfa.service.ts

6. circulation/ (Internal Routing)

   • dto/
     • create-circulation.dto.ts
     • update-circulation-routing.dto.ts
     • search-circulation.dto.ts
   • entities/
     • circulation-routing.entity.ts
     • circulation-status-code.entity.ts
     • circulation.entity.ts
   • circulation.controller.ts
   • circulation.module.ts
   • circulation.service.ts

7. transmittal/ (Document Forwarding)

   • dto/
     • create-transmittal.dto.ts
     • search-transmittal.dto.ts
     • update-transmittal.dto.ts
   • entities/
     • transmittal-item.entity.ts
     • transmittal.entity.ts
   • transmittal.controller.ts
   • transmittal.module.ts
   • transmittal.service.ts

8. notification/ (System Alerts)

   • dto/
     • create-notification.dto.ts
     • search-notification.dto.ts
   • entities/
     • notification.entity.ts
   • notification-cleanup.service.ts
   • notification.controller.ts
   • notification.gateway.ts
   • notification.module.ts
   • notification.processor.ts
   • notification.service.ts

9. search/ (Elasticsearch)

   • dto/search-query.dto.ts
   • search.controller.ts
   • search.module.ts
   • search.service.ts

10. document-numbering/

    • entities/
      • document-number-format.entity.ts
      • document-number-counter.entity.ts
    • document-numbering.module.ts
    • document-numbering.service.spec.ts
    • document-numbering.service.ts

11. workflow-engine/ (Unified Logic)

    • dto/
      • create-workflow-definition.dto.ts
      • evaluate-workflow.dto.ts
      • get-available-actions.dto.ts
      • update-workflow-definition.dto.ts
    • interfaces/workflow.interface.ts
    • workflow-dsl.service.ts
    • workflow-engine.module.ts
    • workflow-engine.service.spec.ts
    • workflow-engine.service.ts

12. json-schema/ (Validation)

    • dto/
      • create-json-schema.dto.ts+
      • search-json-schema.dto.ts
      • update-json-schema.dto.ts
    • entities/
      • json-schema.entity.ts
    • json-schema.controller.spec.ts
    • json-schema.controller.ts
    • json-schema.module.ts
    • json-schema.service.spec.ts
    • json-schema.service.ts

13. monitoring/ (Monitoring & Metrics)

    • controllers/
      • health.controller.ts
    • dto/
      • set-maintenance.dto.ts
    • logger/
      • winston.config.ts
    • services/
      • metrics.service.ts
    • monitoring.controller.ts
    • monitoring.service.ts
    • monitoring.module.ts

Folder Structure ของ Backend (NestJS) ที่

---

📁 Backend Folder Structure (LCBP3-DMS v1.4.3)

backend/
├── .env                         # Environment variables for local development only (not committed)
├── .gitignore                   # Git ignore rules
├── .prettierrc                  # Prettier configuration
├── docker-compose.yml           # Main deployment container configuration
├── docker-compose.override.yml  # Dev-time secret/environment injection
├── package.json                 # Node dependencies and NPM scripts
├── pnpm-lock.yaml               # Dependency lock file for pnpm
├── tsconfig.json                # TypeScript compiler configuration
├── tsconfig.build.json          # TypeScript compiler configuration for production
├── nest-cli.json                # NestJS project configuration
├── README.md                    # Project documentation
└── src/
    ├── main.ts                  # Application bootstrap and initialization
    ├── app.module.ts            # Root application module
    ├── app.service.ts           # Root application service
    ├── app.controller.ts        # Root application controller
    ├── app.controller.spec.ts   # Root application unit tests
    ├── redlock.d.ts             # Redlock configuration
    │
    ├── common/                  # 🛠️ Shared framework resources used across modules
    │   ├── common.module.ts     # Registers shared providers
    │   │
    │   ├── auth/                # 🛡️ Authentication module
    │   │   ├── dto/
    │   │   │   ├── login.dto.ts                # Login request payload
    │   │   │   └── register.dto.ts             # Registration payload
    │   │   ├── strategies/
    │   │   │   ├── local.strategy.ts           # Local strategy for authentication
    │   │   │   └── jwt.strategy.ts             # JWT strategy for authentication
    │   │   ├── auth.module.ts                  # Auth DI module
    │   │   ├── auth.controller.ts              # Auth REST endpoints
    │   │   ├── auth.controller.spec.ts         # Unit tests for controller
    │   │   ├── auth.service.ts                 # Authentication logic
    │   │   └── auth.service.spec.ts            # Unit test for service
    │   │
    │   ├── config/               # 📄 Configuration
    │   │   ├── env.validation.ts              # Zod/Joi validation for environment variables
    │   │   └── redis.config.ts                # Redis configuration
    │   │
    │   ├── decorators/           # 📡 Decorators for common use cases
    │   │   ├── audit.decorator.ts              # Enables audit logging for a method
    │   │   ├── bypass-maintenance.decorator.ts # Declares bypass maintenance requirement
    │   │   ├── current-user.decorator.ts       # Extracts logged-in user from request
    │   │   ├── idempotency.decorator.ts        # Declares idempotency requirement
    │   │   ├── require-permission.decorator.ts # Declares RBAC permission requirement
    │   │   ├── retry.decorator.ts              # Declares retry requirement
    │   │   └── circuit-breaker.decorator.ts    # Declares circuit breaker requirement
    │   │
    │   ├── entities/               # 📚 Database entities
    │   │   ├── audit-log.entity.ts             # Audit log database entity
    │   │   └── base.entity.ts                  # Base abstraction containing core columns
    │   │
    │   ├── exceptions/             # 🛡️ Global exception trap/formatter
    │   │   └── http-exception.filter.ts        # Global exception trap/formatter
    │   │
    │   ├── file-storage/           # 📂 Two-Phase document storage (upload → scan → commit)
    │   │   ├── entities/
    │   │   │   └── attachment.entity.ts        # Represents stored file metadata
    │   │   ├── file-storage.controller.ts      # Upload/download endpoints
    │   │   ├── file-storage.controller.spec.ts # Unit tests
    │   │   ├── file-storage.module.ts          # Module DI bindings
    │   │   ├── file-storage.service.ts         # File handling logic
    │   │   ├── file-storage.service.spec.ts    # Unit tests
    │   │   └── file-cleanup.service.ts         # Cleanup temporary files
    │   │
    │   ├── guards/                  # 🛡️ JWT authentication guard
    │   │   ├── jwt-auth.guard.ts               # JWT authentication guard
    │   │   ├── jwt-refresh.guard.ts            # JWT refresh guard
    │   │   ├── maintenance-mode.guard.ts       # Maintenance mode guard
    │   │   └── rbac.guard.ts                   # Role-based access control enforcement (ตรวจสอบสิทธิ์ 4 ระดับ)
    │   │
    │   ├── interceptors/           # 📡 Interceptors for common use cases
    │   │   ├── audit-log.interceptor.ts        # Automatically logs certain operations
    │   │   ├── idempotency.interceptor.ts      # Idempotency interceptor
    │   │   ├── performance.interceptor.ts      #
    │   │   └── transform.interceptor.ts        # Standardized response formatting
    │   │
    │   ├─── resilience/             # 🛡️ Circuit-breaker / retry logic (if implemented)
    │   │   └── resilience.module.ts            # Resilience module
    │   │
    │   └──── services/              # 🔐 Security service
    │       ├── crypto.service.ts               # Crypto service
    │       └── request-context.service.ts      # Request context service (for logging)
    │
    ├── modules/             # 📦 Module-specific resources
    │   ├── user/                    # 👤 User + RBAC module
    │   │   ├── dto/
    │   │   │   ├── assign-user-role.dto.ts     # Assign roles to users
    │   │   │   ├── create-user.dto.ts          # Create new user
    │   │   │   ├── update-user.dto.ts          # Update user details
    │   │   │   └── update-user-preference.dto.ts # Update user preferences
    │   │   ├── entities/
    │   │   │   ├── user.entity.ts              # User table definition
    │   │   │   ├── role.entity.ts              # Role definition
    │   │   │   ├── permission.entity.ts        # Permission entity
    │   │   │   ├── user-assignment.entity.ts   # User assignment entity
    │   │   │   └── user-preference.entity.ts   # User preference settings
    │   │   ├── user-assignment.service.ts      # User assignment service
    │   │   ├── user-preference.service.ts      # User preference service
    │   │   ├── user.controller.ts              # REST endpoints
    │   │   ├── user.module.ts                  # Module DI container
    │   │   ├── user.service.ts                 # Business logic
    │   │   └── user.service.spec.ts            # Unit tests
    │   │
    │   ├── project/              # 🏢 Project/Organization/Contract structure
    │   │   ├── dto/
    │   │   │   ├── create-project.dto.ts       # Create new project
    │   │   │   ├── search-project.dto.ts       # Search projects
    │   │   │   └── update-project.dto.ts       # Update project
    │   │   ├── entities/
    │   │   │   ├── project.entity.ts           # Project table definition
    │   │   │   ├── contract.entity.ts          # Contract table definition
    │   │   │   ├── organization.entity.ts      # Organization table definition
    │   │   │   ├── project-organization.entity.ts  # Project organization entity
    │   │   │   └── contract-organization.entity.ts  # Contract organization entity
    │   │   ├── project.controller.ts           # REST endpoints
    │   │   ├── project.controller.spec.ts      # Unit tests
    │   │   ├── project.module.ts               # Module DI container
    │   │   ├── project.service.ts              # Business logic
    │   │   └── project.service.spec.ts         # Unit tests
    │   │
    │   ├── correspondence/        # ✉️ Formal letters with routing workflow
    │   │   ├── dto/
    │   │   │   ├── add-reference.dto.ts                # Add reference to correspondence
    │   │   │   ├── create-correspondence.dto.ts        # Create new correspondence
    │   │   │   ├── search-correspondence.dto.ts        # Search correspondences
    │   │   │   ├── submit-correspondence.dto.ts        # Submit correspondence
    │   │   │   └── workflow-action.dto.ts              # Workflow action
    │   │   ├── entities/
    │   │   │   ├── correspondence.entity.ts            # Correspondence table definition
    │   │   │   ├── correspondence-revision.entity.ts   # Correspondence revision entity
    │   │   │   ├── correspondence-routing.entity.ts    # Correspondence routing entity (Unified Workflow)
    │   │   │   ├── correspondence-status.entity.ts     # Correspondence status entity
    │   │   │   ├── correspondence-type.entity.ts       # Correspondence type entity
    │   │   │   ├── correspondence-reference.entity.ts  # Correspondence reference entity
    │   │   │   ├── routing-template.entity.ts          # Routing template entity
    │   │   │   └── routing-template-step.entity.ts     # Routing template step entity
    │   │   ├── correspondence.controller.ts            # REST endpoints
    │   │   ├── correspondence.controller.spec.ts       # Unit tests
    │   │   ├── correspondence.module.ts                # Module DI container
    │   │   ├── correspondence.service.ts               # Business logic
    │   │   └── correspondence.service.spec.ts          # Unit tests
    │   │
    │   ├── drawing/               # 📐Contract & Shop drawing tracking
    │   │   ├── dto/
    │   │   │   ├── create-contract-drawing.dto.ts      # Create new contract drawing
    │   │   │   ├── create-shop-drawing.dto.ts          # Create new shop drawing
    │   │   │   ├── create-shop-drawing-revision.dto.ts # Create new shop drawing revision
    │   │   │   ├── search-contract-drawing.dto.ts      # Search contract drawings
    │   │   │   ├── search-shop-drawing.dto.ts          # Search shop drawings
    │   │   │   └── update-contract-drawing.dto.ts      # Update contract drawing
    │   │   ├── entities/
    │   │   │   ├── contract-drawing.entity.ts          # Contract drawing entity
    │   │   │   ├── contract-drawing-volume.entity.ts   # Contract drawing volume entity
    │   │   │   ├── contract-drawing-sub-category.entity.ts  # Contract drawing sub category entity
    │   │   │   ├── shop-drawing.entity.ts              # Shop drawing entity
    │   │   │   ├── shop-drawing-revision.entity.ts     # Shop drawing revision entity
    │   │   │   ├── shop-drawing-main-category.entity.ts  # Shop drawing main category entity
    │   │   │   └── shop-drawing-sub-category.entity.ts # Shop drawing sub category entity
    │   │   ├── drawing.module.ts                   # Module DI container
    │   │   ├── contract-drawing.controller.ts      # REST endpoints
    │   │   ├── contract-drawing.service.ts         # Business logic
    │   │   ├── drawing-master-data.controller.ts   # REST endpoints
    │   │   ├── drawing-master-data.service.ts      # Business logic
    │   │   ├── shop-drawing.controller.ts          # REST endpoints
    │   │   └── shop-drawing.service.ts             # Business logic
    │   │
    │   ├── rfa/                   # ✅ Request for Approval (multi-step workflow)
    │   │   ├── dto/
    │   │   │   ├── create-rfa.dto.ts               # Create new RFA
    │   │   │   ├── search-rfa.dto.ts               # Search RFAs
    │   │   │   └── update-rfa.dto.ts               # Update RFA
    │   │   ├── entities/
    │   │   │   ├── rfa.entity.ts                   # RFA entity
    │   │   │   ├── rfa-revision.entity.ts          # RFA revision entity
    │   │   │   ├── rfa-item.entity.ts              # RFA item entity
    │   │   │   ├── rfa-type.entity.ts              # RFA type entity
    │   │   │   ├── rfa-status-code.entity.ts       # RFA status code entity
    │   │   │   ├── rfa-approve-code.entity.ts      # RFA approve code entity
    │   │   │   ├── rfa-workflow.entity.ts          # RFA workflow entity
    │   │   │   ├── rfa-workflow-template.entity.ts # RFA workflow template entity
    │   │   │   └── rfa-workflow-template-step.entity.ts  # RFA workflow template step entity
    │   │   ├── rfa.controller.ts                   # REST endpoints
    │   │   ├── rfa.module.ts                       # Module DI container
    │   │   └── rfa.service.ts                      # Business logic
    │   │
    │   ├── circulation/           # 🔄 Internal routing workflow
    │   │   ├── dto/
    │   │   │   ├── create-circulation.dto.ts       # Create new circulation
    │   │   │   ├── update-circulation-routing.dto.ts  # Update circulation routing
    │   │   │   └── search-circulation.dto.ts       # Search circulation
    │   │   ├── entities/
    │   │   │   ├── circulation.entity.ts           # Circulation entity
    │   │   │   ├── circulation-routing.entity.ts   # Circulation routing entity
    │   │   │   └── circulation-status-code.entity.ts  # Circulation status code entity
    │   │   ├── circulation.controller.ts           # REST endpoints
    │   │   ├── circulation.module.ts               # Module DI container
    │   │   └── circulation.service.ts              # Business logic
    │   │
    │   ├── transmittal/            # 📤 Document forwarding
    │   │   ├── dto/
    │   │   │   ├── create-transmittal.dto.ts       # Create new transmittal
    │   │   │   ├── search-transmittal.dto.ts       # Search transmittal
    │   │   │   └── update-transmittal.dto.ts       # Update transmittal
    │   │   ├── entities/
    │   │   │   ├── transmittal.entity.ts           # Transmittal entity
    │   │   │   └── transmittal-item.entity.ts      # Transmittal item entity
    │   │   ├── transmittal.controller.ts           # REST endpoints
    │   │   ├── transmittal.module.ts               # Module DI container
    │   │   └── transmittal.service.ts              # Business logic
    │   │
    │   ├── notification/           # 🔔 Real-Time notification system
    │   │   ├── dto/
    │   │   │   ├── create-notification.dto.ts      # Create new notification
    │   │   │   └── search-notification.dto.ts      # Search notification
    │   │   ├── entities/
    │   │   │   └── notification.entity.ts          # Notification entity
    │   │   ├── notification.module.ts              # WebSocket + Processor registration
    │   │   ├── notification.controller.ts          # REST endpoints
    │   │   ├── notification.gateway.ts             # WebSocket gateway
    │   │   ├── notification.processor.ts           # Message consumer (Consumer/Worker for Email & Line)
    │   │   ├── notification.service.ts             # Business logic
    │   │   └── notification-cleanup.service.ts     # Cron-based cleanup job
    │   │
    │   ├── search/                 # 🔍 Elasticsearch integration
    │   │   ├── dto/
    │   │   │   └── search-query.dto.ts             # Search query
    │   │   ├── search.module.ts                    # Module DI container
    │   │   ├── search.controller.ts                # REST endpoints
    │   │   └── search.service.ts                   # Indexing/search logic
    │   │
    │   ├── document-numbering/     # 🔢 Auto-increment controlled ID generation
    │   │   ├── entities/
    │   │   │   ├── document-number-format.entity.ts  # Document number format entity
    │   │   │   └── document-number-counter.entity.ts # Document number counter entity
    │   │   ├── document-numbering.module.ts          # Module DI container
    │   │   ├── document-numbering.service.ts         # Business logic
    │   │   └── document-numbering.service.spec.ts    # Unit tests
    │   │
    │   ├── workflow-engine/        # ⚙️ Unified state-machine workflow engine
    │   │   ├── dto/
    │   │   │   ├── create-workflow-definition.dto.ts # Create new workflow definition
    │   │   │   ├── evaluate-workflow.dto.ts          # Evaluate workflow
    │   │   │   ├── get-available-actions.dto.ts      # Get available actions
    │   │   │   └── update-workflow-definition.dto.ts # Update workflow definition
    │   │   ├── entities/
    │   │   │   └── workflow-definition.entity.ts     # Workflow definition entity
    │   │   ├── interfaces/
    │   │   │   └── workflow.interface.ts             # Workflow interface
    │   │   ├── workflow-engine.controller.ts         # REST endpoints
    │   │   ├── workflow-engine.module.ts             # Module DI container
    │   │   ├── workflow-engine.service.ts            # State Machine Logic
    │   │   └── workflow-engine.service.spec.ts       # Unit tests
    │   │
    │   ├── json-schema/            # 📋 Dynamic request schema validation
    │   │   ├── dto/
    │   │   │   ├── create-json-schema.dto.ts     # Create new JSON schema
    │   │   │   ├── update-json-schema.dto.ts     # Update JSON schema
    │   │   │   └── search-json-schema.dto.ts     # Search JSON schema
    │   │   ├── entities/
    │   │   │   └── json-schema.entity.ts         # JSON schema entity
    │   │   ├── json-schema.module.ts             # Module DI container
    │   │   ├── json-schema.controller.ts         # REST endpoints
    │   │   ├── json-schema.controller.spec.ts    # Unit tests
    │   │   ├── json-schema.service.ts            # Business logic
    │   │   └── json-schema.service.spec.ts       # Unit tests
    │   │
    │   └── monitoring/            # 📋 Dynamic request schema validation
    │       ├── controllers/
    │       │   └── health.controller.ts          # Create new JSON schema
    │       ├── dto/
    │       │   └── set-maintenance.dto.ts        # Create new JSON schema
    │       ├── logger/
    │       │   └── winston.config.ts             # JSON schema entity
    │       ├── services/
    │       │   └── metrics.service.ts            # JSON schema entity
    │       ├── monitoring.controller.ts          # REST endpoints
    │       ├── monitoring.service.ts             # Business logic
    │       └── monitoring.module.ts              # Module DI container

---