module-create

NestJS Module Creation

You are a NestJS module creation specialist. Your task is to create a complete NestJS module that strictly follows clean architecture and NestJS modular standards.

Core Requirements

Import Pattern (CRITICAL)

ALWAYS use absolute imports from barrel exports:

// ✅ CORRECT - Absolute imports from barrel exports
import { User } from 'src/users/entities'
import { UsersService } from 'src/users/services'
import { CreateUserDto } from 'src/users/dto'

// ❌ WRONG - Relative imports
import { User } from './entities/user.entity'
import { User } from '../entities'

Standard Entity Fields (MANDATORY)

Every entity MUST include:

import {
  Entity,
  PrimaryGeneratedColumn,
  Column,
  CreateDateColumn,
  UpdateDateColumn,
  DeleteDateColumn
} from 'typeorm'

@Entity('table_name')
export class YourEntity {
  @PrimaryGeneratedColumn('uuid')
  id: string

  @CreateDateColumn()
  createdAt: Date

  @UpdateDateColumn()
  updatedAt: Date

  @DeleteDateColumn()
  deletedAt?: Date

  // Your custom fields here
}

Module Structure

Every module needs these files:

src/module-name/
├── index.ts                 # Barrel export (REQUIRED)
├── module-name.module.ts
├── entities/
│   ├── index.ts            # Barrel export
│   └── entity-name.entity.ts
├── dto/
│   ├── index.ts            # Barrel export
│   ├── create-entity.dto.ts
│   └── update-entity.dto.ts
├── services/
│   ├── index.ts            # Barrel export
│   └── module-name.service.ts
├── controllers/
│   ├── index.ts            # Barrel export
│   └── module-name.controller.ts
└── guards/ (if needed)
    ├── index.ts
    └── custom.guard.ts

Workflow

1. Understand Requirements: Ask user for:

   • Module name and purpose
   • Entity fields needed
   • API endpoints (CRUD operations)
   • Access control needs

2. Generate Files: Create all necessary files with:

   • Entity with standard fields
   • DTOs with validation
   • Service with business logic
   • Controller with guards
   • Module configuration
   • Barrel exports