A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Nest framework TypeScript starter repository.

Project setup

$ npm install

Compile and run the project

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Run tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Deployment

When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the deployment documentation for more information.

If you are looking for a cloud-based platform to deploy your NestJS application, check out Mau, our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:

$ npm install -g mau
$ mau deploy

With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

Resources

Check out a few resources that may come in handy when working with NestJS:

• Visit the NestJS Documentation to learn more about the framework.
• For questions and support, please visit our Discord channel.
• To dive deeper and get more hands-on experience, check out our official video courses.
• Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
• Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
• Need help with your project (part-time to full-time)? Check out our official enterprise support.
• To stay in the loop and get updates, follow us on X and LinkedIn.
• Looking for a job, or have a job to offer? Check out our official Jobs board.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.

Notes Yourself

# 1. install nestjs and create project:

$ npm i -g @nestjs/cli
$ nest new project-name

# 2. run dev:

npm|yarn run start:dev

# 3. generate module:

nest g module modulename

function: Module trong NestJS đóng vai trò như một container để tổ chức và quản lý các phần khác nhau của ứng dụng

# 4. generate controller:

nest g controller controllername --no-spec

# 5. generate service:

nest g service servicename --no-spec

docker

docker compose up dev-db -d

docker ps

docker info

docker logs id

prisma

https://www.prisma.io/

npx prisma migrate dev

npx prisma migrate dev --name init

npx prisma --help

npx prisma studio ---- view database

npx prisma db seed --preview-feature

Argon2

npm install argon2: Password hashing using Argon2 algorithm

class-validator and class class-transformer

Client Request → JSON Body → ValidationPipe
    |                             |
    v                             v
class-transformer      →  Chuyển thành class instance
    |                             |
    v                             v
class-validator        →  Xác thực dữ liệu trong class
    |                             |
    v                             v
Controller             ←  Dữ liệu đã xác thực (DTO instance)

1. Khả năng kiểm soát và mở rộng dữ liệu dễ dàng hơn.
2. Kết hợp với class-validator để xác thực dữ liệu.
    - class-validator chỉ hoạt động với class instance chứ không với plain object.
3. Lọc bỏ dữ liệu thừa hoặc không mong muốn, giúp bảo mật hơn.
4. Tính nhất quán và an toàn trong việc xử lý dữ liệu.
5. Code rõ ràng, bảo trì dễ dàng và tuân theo OOP.

instance in OOP

- instance: là một biểu hiện cụ thể của một class

// Tạo một instance từ class
const person1 = new Person('Alice', 25);

Tầm quan trọng của Instance trong OOP
Trừu tượng hóa:
Class cung cấp một khuôn mẫu, còn instance cho phép trừu tượng hóa các đối tượng thực tế trong thế giới thật.

Tái sử dụng mã nguồn:
Tạo nhiều instance từ một class giúp tái sử dụng logic và giảm bớt việc lặp lại mã nguồn.

Đóng gói (Encapsulation):
Instance cung cấp khả năng đóng gói dữ liệu và phương thức, đảm bảo rằng trạng thái của một instance không bị thay đổi ngoài ý muốn.

Kế thừa và Đa hình:
Các instance cũng thừa hưởng hoặc mở rộng các đặc điểm từ class cha, hỗ trợ các khái niệm như kế thừa và đa hình.

jwt (json web token)

I. Mục đích
Được sử dụng phổ biến trong cơ chế authentication (xác thực) và authorization (ủy quyền).

II. Thành phần
1. Header: Chứa metadata mô tả về token.
{
  "alg": "HS256",   // Thuật toán mã hóa (e.g., HMAC SHA256, RSA, etc.)
  "typ": "JWT"      // Loại token (luôn là "JWT")
}

2. Payload: Chứa dữ liệu (claims) của token. Đây là phần mà ứng dụng lưu trữ các thông tin như user ID, quyền truy cập, hoặc bất kỳ dữ liệu nào cần thiết.
{
  "userId": "1234567890",
  "role": "admin",
  "iat": 1644235600  // Thời điểm tạo token (Unix timestamp)
}

Registered Claims: Là các claims chuẩn theo RFC 7519 như:
iss (issuer): Ai là người phát hành token.
sub (subject): Chủ thể của token.
aud (audience): Đối tượng của token.
exp (expiration): Token hết hạn lúc nào.
iat (issued at): Thời gian token được phát hành.
Public Claims: Dữ liệu công khai do người dùng định nghĩa (e.g., role, userId).
Private Claims: Dữ liệu riêng dùng để giao tiếp giữa các bên.

3. Signature: Phần bảo mật giúp xác thực token không bị thay đổi. Được tạo bằng cách ký vào header và payload bằng thuật toán và một secret key.
signature = HMACSHA256(
  base64UrlEncode(header) + "." + base64UrlEncode(payload),
  secret
)

III. Hoạt động
1. Người dùng (Client) gửi thông tin đăng nhập đến Server:
   - [Client] -> POST /login {username, password}

2. Server kiểm tra thông tin đăng nhập:
   - Nếu thông tin chính xác:
      a. Tạo JWT (gồm Header, Payload, và Signature).
      b. Trả JWT cho Client.
   - Nếu thông tin sai: Trả lỗi 401 (Unauthorized).

3. Client lưu JWT (thường trong Local Storage hoặc Cookie).

4. Client gửi yêu cầu tới Server kèm JWT trong Header:
   - [Client] -> GET /protected-resource
     Header: Authorization: Bearer <JWT>

5. Server kiểm tra JWT:
   a. Giải mã và kiểm tra tính hợp lệ của chữ ký (Signature).
   b. Kiểm tra thời gian hết hạn (Expiration, `exp`).
   c. Nếu hợp lệ: Cho phép truy cập tài nguyên.
   d. Nếu không hợp lệ: Trả lỗi 403 (Forbidden).

6. Server trả về dữ liệu yêu cầu hoặc thông báo lỗi:
   - [Server] -> 200 OK (trả dữ liệu) hoặc 403 Forbidden.

IV. install
npm install --save @nestjs/jwt

passport-jwt jwt

I. passport-jwt là một module giúp tích hợp passport với JWT.

II. Cài đặt
$ npm install --save @nestjs/passport passport passport-local
$ npm install --save-dev @types/passport-local
$ npm install passport-jwt

III. Hoạt động
[Client]
   |
   | 1. Gửi thông tin đăng nhập (username/password)
   V
[AuthController (/auth/login)]
   |
   | 2. Gọi AuthService để xác thực thông tin đăng nhập
   V
[AuthService]
   |
   | 3. Nếu thông tin hợp lệ, tạo JWT Token bằng @nestjs/jwt
   |    - Tạo payload (username, userId, etc.)
   |    - Mã hóa payload để tạo access_token
   V
[JWT Module]
   |
   | 4. Trả JWT Token cho Client (Response)
   V
[Client]
   |
   | 5. Gửi yêu cầu đến tài nguyên bảo vệ (Protected Resource)
   |    - Đính kèm JWT Token trong Header (Authorization: Bearer <token>)
   V
[ProtectedController (/protected)]
   |
   | 6. @UseGuards(AuthGuard('jwt')) được kích hoạt
   V
[PassportModule (AuthGuard)]
   |
   | 7. AuthGuard gọi JwtStrategy để kiểm tra tính hợp lệ của JWT Token
   |    - Lấy token từ header
   |    - Giải mã token bằng @nestjs/jwt (xác thực chữ ký và thời hạn)
   V
[JwtStrategy]
   |
   | 8. Nếu token hợp lệ, trả về thông tin người dùng (payload)
   |    - Truyền thông tin người dùng vào request object (req.user)
   V
[ProtectedController]
   |
   | 9. Xử lý yêu cầu, trả về tài nguyên hoặc kết quả
   V
[Client]
   |
   | 10. Nhận phản hồi từ server (Response)

web: https://www.passportjs.org/packages/passport-jwt/
jwt: https://jwt.io/#debugger-io

e2e tests with pactumJs

Free & OpenSource REST API Testing Tool for all levels in a Test Pyramid

install
   -  yarn add -D pactum
   -  npm install -D pactum
document
   -  https://pactumjs.github.io/

yarn

install
   - npm install --global yarn
version
   - yarn --version

yarn add -D dotenv-cli

Client --> [API Request] --> Server

   - HTTP Method: POST
   - URL: /bookmarks
   - Headers:
      Authorization: Bearer <token>
   - Body: { "title": "My Bookmark", "url": "https://example.com" }


   1. Guard (`JwtGuard`) kích hoạt:
   - @UseGuards(JwtGuard) bảo vệ route `/bookmarks`.
   - Guard kiểm tra `Authorization` header có Bearer Token.
   - Gọi `JwtStrategy` để xác thực token.


   2. JwtStrategy xác thực token:
   - Lấy token từ `Authorization` header.
   - Giải mã token với `JWT_SECRET`.
   - Nếu token hợp lệ:
       - Trích xuất payload từ token, ví dụ: { sub: 1, email: 'user@example.com' }.
       - Gắn payload vào request.user:
           request.user = { id: 1, email: 'user@example.com' }
   - Nếu token không hợp lệ:
       - Trả về lỗi: 401 Unauthorized.


   3. Controller xử lý request:
   - Request được cho phép đi vào controller bởi Guard.
   - Controller nhận request với thông tin user đã được gắn vào request.user.
   - `@GetUser` decorator được sử dụng để lấy thông tin từ request.user.


   4. @GetUser decorator:
   - Truy cập request.user.
   - Nếu sử dụng @GetUser('id'):
       - Trả về `user.id`, ví dụ: 1.
   - Nếu sử dụng @GetUser():
       - Trả về toàn bộ user, ví dụ: { id: 1, email: 'user@example.com' }.

   --> tiếp tục đến với sử lý logic ở Controller