add dto validation and swagger schemas

This commit is contained in:
2026-05-12 16:17:39 +03:30
parent abb387e743
commit 460537090b
21 changed files with 510 additions and 0 deletions
+9
View File
@@ -1,10 +1,19 @@
import 'reflect-metadata';
import { ValidationPipe } from '@nestjs/common';
import { NestFactory } from '@nestjs/core';
import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
import { AppModule } from './app.module';
async function bootstrap() {
const app = await NestFactory.create(AppModule);
app.useGlobalPipes(
new ValidationPipe({
forbidNonWhitelisted: true,
transform: true,
whitelist: true,
}),
);
const swaggerConfig = new DocumentBuilder()
.setTitle('Montime API')
.setDescription('Local services super app API')
@@ -1,13 +1,53 @@
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
import {
IsArray,
IsBoolean,
IsEnum,
IsOptional,
IsString,
IsUUID,
Matches,
MaxLength,
} from 'class-validator';
import { AttributeType } from '../../../entities/attribute-definition.entity';
export class CreateAttributeDefinitionDto {
@ApiProperty({ example: 'Has Waiting Room' })
@IsString()
@MaxLength(120)
title!: string;
/** یکتا در محدوده همان دسته شغلی */
@ApiProperty({ example: 'has-waiting-room' })
@IsString()
@MaxLength(120)
@Matches(/^[a-z0-9]+(?:-[a-z0-9]+)*$/, {
message: 'key must be lowercase words separated by hyphens',
})
key!: string;
@ApiProperty({ enum: AttributeType, example: AttributeType.BOOLEAN })
@IsEnum(AttributeType)
type!: AttributeType;
@ApiProperty({ format: 'uuid' })
@IsUUID()
categoryId!: string;
/** برای type=select آرایه گزینه‌ها */
@ApiPropertyOptional({ type: [String], example: ['small', 'medium', 'large'] })
@IsOptional()
@IsArray()
@IsString({ each: true })
options?: string[];
@ApiPropertyOptional({ example: false })
@IsOptional()
@IsBoolean()
required?: boolean;
@ApiPropertyOptional({ example: true })
@IsOptional()
@IsBoolean()
isFilterable?: boolean;
}
@@ -1,11 +1,59 @@
import { ApiPropertyOptional } from '@nestjs/swagger';
import {
IsArray,
IsBoolean,
IsEnum,
IsOptional,
IsString,
IsUUID,
Matches,
MaxLength,
} from 'class-validator';
import { AttributeType } from '../../../entities/attribute-definition.entity';
export class UpdateAttributeDefinitionDto {
@ApiPropertyOptional({ example: 'Has Waiting Room' })
@IsOptional()
@IsString()
@MaxLength(120)
title?: string;
@ApiPropertyOptional({ example: 'has-waiting-room' })
@IsOptional()
@IsString()
@MaxLength(120)
@Matches(/^[a-z0-9]+(?:-[a-z0-9]+)*$/, {
message: 'key must be lowercase words separated by hyphens',
})
key?: string;
@ApiPropertyOptional({ enum: AttributeType, example: AttributeType.BOOLEAN })
@IsOptional()
@IsEnum(AttributeType)
type?: AttributeType;
@ApiPropertyOptional({ format: 'uuid' })
@IsOptional()
@IsUUID()
categoryId?: string;
@ApiPropertyOptional({
type: [String],
example: ['small', 'medium', 'large'],
nullable: true,
})
@IsOptional()
@IsArray()
@IsString({ each: true })
options?: string[] | null;
@ApiPropertyOptional({ example: false })
@IsOptional()
@IsBoolean()
required?: boolean;
@ApiPropertyOptional({ example: true })
@IsOptional()
@IsBoolean()
isFilterable?: boolean;
}
+8
View File
@@ -1,3 +1,11 @@
import { ApiProperty } from '@nestjs/swagger';
import { IsString, Matches } from 'class-validator';
export class RequestOtpDto {
@ApiProperty({ example: '09122222222' })
@IsString()
@Matches(/^(\+?\d{10,15}|09\d{9})$/, {
message: 'mobile must be a valid mobile number',
})
mobile!: string;
}
+14
View File
@@ -1,4 +1,18 @@
import { ApiProperty } from '@nestjs/swagger';
import { IsString, Matches } from 'class-validator';
export class VerifyOtpDto {
@ApiProperty({ example: '09122222222' })
@IsString()
@Matches(/^(\+?\d{10,15}|09\d{9})$/, {
message: 'mobile must be a valid mobile number',
})
mobile!: string;
@ApiProperty({ example: '123456' })
@IsString()
@Matches(/^\d{4,8}$/, {
message: 'code must be 4 to 8 digits',
})
code!: string;
}
@@ -1,8 +1,27 @@
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
import { IsISO8601, IsOptional, IsString, IsUUID, MaxLength } from 'class-validator';
export class CreateBookingDto {
@ApiProperty({ format: 'uuid' })
@IsUUID()
customerId!: string;
@ApiProperty({ format: 'uuid' })
@IsUUID()
businessId!: string;
@ApiProperty({ format: 'uuid' })
@IsUUID()
businessServiceId!: string;
/** ISO 8601 datetime string */
@ApiProperty({ example: '2026-05-13T10:00:00.000Z' })
@IsISO8601()
scheduledAt!: string;
@ApiPropertyOptional({ example: 'Test booking', nullable: true })
@IsOptional()
@IsString()
@MaxLength(500)
note?: string | null;
}
@@ -1,7 +1,21 @@
import { ApiPropertyOptional } from '@nestjs/swagger';
import { IsEnum, IsISO8601, IsOptional, IsString, MaxLength } from 'class-validator';
import { BookingStatus } from '../../../entities/booking.entity';
export class UpdateBookingDto {
@ApiPropertyOptional({ example: '2026-05-13T10:00:00.000Z' })
@IsOptional()
@IsISO8601()
scheduledAt?: string;
@ApiPropertyOptional({ enum: BookingStatus, example: BookingStatus.CONFIRMED })
@IsOptional()
@IsEnum(BookingStatus)
status?: BookingStatus;
@ApiPropertyOptional({ example: 'Customer asked for morning slot', nullable: true })
@IsOptional()
@IsString()
@MaxLength(500)
note?: string | null;
}
@@ -1,6 +1,19 @@
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
import { IsOptional, IsString, IsUUID, MaxLength } from 'class-validator';
export class CreateBusinessAttributeValueDto {
@ApiProperty({ format: 'uuid' })
@IsUUID()
businessId!: string;
@ApiProperty({ format: 'uuid' })
@IsUUID()
attributeDefinitionId!: string;
/** مقدار به صورت رشته ذخیره می‌شود؛ برای boolean مثلا true/false */
@ApiPropertyOptional({ example: 'true', nullable: true })
@IsOptional()
@IsString()
@MaxLength(500)
value?: string | null;
}
@@ -1,3 +1,10 @@
import { ApiPropertyOptional } from '@nestjs/swagger';
import { IsOptional, IsString, MaxLength } from 'class-validator';
export class UpdateBusinessAttributeValueDto {
@ApiPropertyOptional({ example: 'true', nullable: true })
@IsOptional()
@IsString()
@MaxLength(500)
value?: string | null;
}
@@ -1,5 +1,22 @@
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
import { IsBoolean, IsOptional, IsString, Matches, MaxLength } from 'class-validator';
export class CreateBusinessCategoryDto {
@ApiProperty({ example: 'Car Wash' })
@IsString()
@MaxLength(150)
title!: string;
@ApiProperty({ example: 'car-wash' })
@IsString()
@MaxLength(120)
@Matches(/^[a-z0-9]+(?:-[a-z0-9]+)*$/, {
message: 'slug must be lowercase words separated by hyphens',
})
slug!: string;
@ApiPropertyOptional({ example: true })
@IsOptional()
@IsBoolean()
isActive?: boolean;
}
@@ -1,5 +1,24 @@
import { ApiPropertyOptional } from '@nestjs/swagger';
import { IsBoolean, IsOptional, IsString, Matches, MaxLength } from 'class-validator';
export class UpdateBusinessCategoryDto {
@ApiPropertyOptional({ example: 'Car Wash' })
@IsOptional()
@IsString()
@MaxLength(150)
title?: string;
@ApiPropertyOptional({ example: 'car-wash' })
@IsOptional()
@IsString()
@MaxLength(120)
@Matches(/^[a-z0-9]+(?:-[a-z0-9]+)*$/, {
message: 'slug must be lowercase words separated by hyphens',
})
slug?: string;
@ApiPropertyOptional({ example: true })
@IsOptional()
@IsBoolean()
isActive?: boolean;
}
@@ -1,9 +1,31 @@
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
import { IsBoolean, IsInt, IsNumber, IsOptional, IsUUID, Max, Min } from 'class-validator';
export class CreateBusinessServiceDto {
@ApiProperty({ format: 'uuid' })
@IsUUID()
businessId!: string;
@ApiProperty({ format: 'uuid' })
@IsUUID()
serviceTemplateId!: string;
/** قیمت به واحد پول (عدد اعشاری مجاز است) */
@ApiProperty({ example: 100000 })
@IsNumber({ maxDecimalPlaces: 2 })
@Min(0)
price!: number;
/** اگر خالی باشد از template.defaultDurationMinutes استفاده می‌شود */
@ApiPropertyOptional({ example: 30, nullable: true })
@IsOptional()
@IsInt()
@Min(1)
@Max(1440)
durationMinutes?: number | null;
@ApiPropertyOptional({ example: true })
@IsOptional()
@IsBoolean()
isActive?: boolean;
}
@@ -1,6 +1,27 @@
import { ApiPropertyOptional } from '@nestjs/swagger';
import { IsBoolean, IsInt, IsNumber, IsOptional, IsUUID, Max, Min } from 'class-validator';
export class UpdateBusinessServiceDto {
@ApiPropertyOptional({ format: 'uuid' })
@IsOptional()
@IsUUID()
serviceTemplateId?: string;
@ApiPropertyOptional({ example: 100000 })
@IsOptional()
@IsNumber({ maxDecimalPlaces: 2 })
@Min(0)
price?: number;
@ApiPropertyOptional({ example: 30, nullable: true })
@IsOptional()
@IsInt()
@Min(1)
@Max(1440)
durationMinutes?: number | null;
@ApiPropertyOptional({ example: true })
@IsOptional()
@IsBoolean()
isActive?: boolean;
}
@@ -1,4 +1,17 @@
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
import { IsOptional, IsString, Matches, MaxLength } from 'class-validator';
export class AssignBusinessOwnerDto {
@ApiProperty({ example: '09111111111' })
@IsString()
@Matches(/^(\+?\d{10,15}|09\d{9})$/, {
message: 'mobile must be a valid mobile number',
})
mobile!: string;
@ApiPropertyOptional({ example: 'Business Admin', nullable: true })
@IsOptional()
@IsString()
@MaxLength(150)
fullName?: string | null;
}
@@ -1,12 +1,68 @@
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
import {
IsBoolean,
IsLatitude,
IsLongitude,
IsOptional,
IsString,
IsUUID,
Matches,
MaxLength,
} from 'class-validator';
export class CreateBusinessDto {
@ApiProperty({ example: 'Shine Carwash' })
@IsString()
@MaxLength(150)
title!: string;
@ApiProperty({ example: 'shine-carwash' })
@IsString()
@MaxLength(120)
@Matches(/^[a-z0-9]+(?:-[a-z0-9]+)*$/, {
message: 'slug must be lowercase words separated by hyphens',
})
slug!: string;
@ApiProperty({ format: 'uuid' })
@IsUUID()
categoryId!: string;
@ApiPropertyOptional({ example: 'Premium carwash service' })
@IsOptional()
@IsString()
@MaxLength(500)
description?: string;
@ApiPropertyOptional({ example: '09123456789' })
@IsOptional()
@IsString()
@MaxLength(20)
contactPhone?: string;
@ApiPropertyOptional({ example: 'Main street' })
@IsOptional()
@IsString()
@MaxLength(500)
address?: string;
@ApiPropertyOptional({ example: 35.6892 })
@IsOptional()
@IsLatitude()
latitude?: number;
@ApiPropertyOptional({ example: 51.389 })
@IsOptional()
@IsLongitude()
longitude?: number;
@ApiPropertyOptional({ format: 'uuid' })
@IsOptional()
@IsUUID()
ownerId?: string;
@ApiPropertyOptional({ example: true })
@IsOptional()
@IsBoolean()
isActive?: boolean;
}
@@ -1,12 +1,71 @@
import { ApiPropertyOptional } from '@nestjs/swagger';
import {
IsBoolean,
IsLatitude,
IsLongitude,
IsOptional,
IsString,
IsUUID,
Matches,
MaxLength,
} from 'class-validator';
export class UpdateBusinessDto {
@ApiPropertyOptional({ example: 'Shine Carwash' })
@IsOptional()
@IsString()
@MaxLength(150)
title?: string;
@ApiPropertyOptional({ example: 'shine-carwash' })
@IsOptional()
@IsString()
@MaxLength(120)
@Matches(/^[a-z0-9]+(?:-[a-z0-9]+)*$/, {
message: 'slug must be lowercase words separated by hyphens',
})
slug?: string;
@ApiPropertyOptional({ format: 'uuid' })
@IsOptional()
@IsUUID()
categoryId?: string;
@ApiPropertyOptional({ example: 'Premium carwash service', nullable: true })
@IsOptional()
@IsString()
@MaxLength(500)
description?: string | null;
@ApiPropertyOptional({ example: '09123456789', nullable: true })
@IsOptional()
@IsString()
@MaxLength(20)
contactPhone?: string | null;
@ApiPropertyOptional({ example: 'Main street', nullable: true })
@IsOptional()
@IsString()
@MaxLength(500)
address?: string | null;
@ApiPropertyOptional({ example: 35.6892, nullable: true })
@IsOptional()
@IsLatitude()
latitude?: number | null;
@ApiPropertyOptional({ example: 51.389, nullable: true })
@IsOptional()
@IsLongitude()
longitude?: number | null;
@ApiPropertyOptional({ format: 'uuid', nullable: true })
@IsOptional()
@IsUUID()
ownerId?: string | null;
@ApiPropertyOptional({ example: true })
@IsOptional()
@IsBoolean()
isActive?: boolean;
}
@@ -1,8 +1,49 @@
import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
import {
IsBoolean,
IsInt,
IsOptional,
IsString,
IsUUID,
Matches,
Max,
MaxLength,
Min,
} from 'class-validator';
export class CreateServiceTemplateDto {
@ApiProperty({ example: 'Basic Wash' })
@IsString()
@MaxLength(150)
title!: string;
@ApiProperty({ example: 'basic-wash' })
@IsString()
@MaxLength(120)
@Matches(/^[a-z0-9]+(?:-[a-z0-9]+)*$/, {
message: 'slug must be lowercase words separated by hyphens',
})
slug!: string;
@ApiProperty({ format: 'uuid' })
@IsUUID()
categoryId!: string;
@ApiPropertyOptional({ example: 'Exterior wash' })
@IsOptional()
@IsString()
@MaxLength(500)
description?: string;
@ApiPropertyOptional({ example: 30 })
@IsOptional()
@IsInt()
@Min(1)
@Max(1440)
defaultDurationMinutes?: number;
@ApiPropertyOptional({ example: true })
@IsOptional()
@IsBoolean()
isActive?: boolean;
}
@@ -1,8 +1,52 @@
import { ApiPropertyOptional } from '@nestjs/swagger';
import {
IsBoolean,
IsInt,
IsOptional,
IsString,
IsUUID,
Matches,
Max,
MaxLength,
Min,
} from 'class-validator';
export class UpdateServiceTemplateDto {
@ApiPropertyOptional({ example: 'Basic Wash' })
@IsOptional()
@IsString()
@MaxLength(150)
title?: string;
@ApiPropertyOptional({ example: 'basic-wash' })
@IsOptional()
@IsString()
@MaxLength(120)
@Matches(/^[a-z0-9]+(?:-[a-z0-9]+)*$/, {
message: 'slug must be lowercase words separated by hyphens',
})
slug?: string;
@ApiPropertyOptional({ format: 'uuid' })
@IsOptional()
@IsUUID()
categoryId?: string;
@ApiPropertyOptional({ example: 'Exterior wash', nullable: true })
@IsOptional()
@IsString()
@MaxLength(500)
description?: string | null;
@ApiPropertyOptional({ example: 30 })
@IsOptional()
@IsInt()
@Min(1)
@Max(1440)
defaultDurationMinutes?: number;
@ApiPropertyOptional({ example: true })
@IsOptional()
@IsBoolean()
isActive?: boolean;
}
+14
View File
@@ -1,7 +1,21 @@
import { ApiPropertyOptional } from '@nestjs/swagger';
import { IsBoolean, IsEnum, IsOptional, IsString, MaxLength } from 'class-validator';
import { UserRole } from '../../../entities/user.entity';
export class UpdateUserDto {
@ApiPropertyOptional({ example: 'Mahdi', nullable: true })
@IsOptional()
@IsString()
@MaxLength(150)
fullName?: string | null;
@ApiPropertyOptional({ enum: UserRole, example: UserRole.BUSINESS_OWNER })
@IsOptional()
@IsEnum(UserRole)
role?: UserRole;
@ApiPropertyOptional({ example: true })
@IsOptional()
@IsBoolean()
isActive?: boolean;
}