📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!
TypeScript chartsclickhousedockergdprgoogle-analyticsmetricsmonitoringmysqlnestjsprivacyredisself-hostedselfhostedstatisticstailwindcssweb-analyticswebanalyticswebsite
import { ApiProperty } from '@nestjs/swagger'
import {
IsNotEmpty,
Length,
IsEnum,
IsOptional,
IsArray,
IsString,
IsUrl,
MaxLength,
ValidateIf,
} from 'class-validator'
import { BotsProtectionLevel } from '../entity/project.entity'
export class ProjectDTO {
@ApiProperty({
example: 'Your awesome project',
required: true,
description: 'A display name for your project',
})
@IsNotEmpty()
@Length(1, 50)
name: string
@ApiProperty({
example: 'aUn1quEid-3',
required: true,
description: 'A unique project ID',
})
@IsNotEmpty()
id: string
@ApiProperty({
example: 'localhost:3000,example.com',
required: false,
description: 'An array allowed origins',
})
origins: string[] | null
@ApiProperty({
enum: BotsProtectionLevel,
required: false,
description: 'Bots protection level',
})
@IsEnum(BotsProtectionLevel)
@IsOptional()
botsProtectionLevel?: BotsProtectionLevel
@ApiProperty({
example: '::1,127.0.0.1,192.168.0.1/32',
required: false,
description: 'Array of blocked IP addresses',
})
ipBlacklist: string[] | null
@ApiProperty({
example: ['::1', '127.0.0.1', '192.168.0.1/32'],
required: false,
description:
'Array of IP addresses (or CIDR ranges) that are never flagged by bot protection. Useful for server-side event tracking.',
})
ipWhitelist: string[] | null
@ApiProperty({
example: ['RU', 'BY', 'KP'],
required: false,
description:
'Array of blocked country codes (ISO 3166-1 alpha-2). Traffic from these countries will not be tracked.',
})
@IsOptional()
@IsArray()
countryBlacklist: string[] | null
@ApiProperty({
required: false,
description:
"The project's state. If enabled - all the incoming analytics data will be saved.",
})
active: boolean
@ApiProperty({
required: false,
description:
"When true, anyone on the internet (including Google) would be able to see the project's Dashboard.",
})
public: boolean
@ApiProperty({
example: 'https://example.com',
required: false,
description:
'Optional website URL. Used to display favicon and construct clickable page links.',
})
@IsOptional()
@ValidateIf((o) => o.websiteUrl !== null && o.websiteUrl !== undefined)
@IsUrl({}, { message: 'websiteUrl must be a valid URL' })
@MaxLength(512)
websiteUrl?: string | null
@ApiProperty({
example: ['swetrix', 'swetrix analytics'],
required: false,
description:
'Brand keywords used to classify search queries as branded vs non-branded traffic.',
})
@IsOptional()
@ValidateIf((o) => o.brandKeywords !== null && o.brandKeywords !== undefined)
@IsArray()
@IsString({ each: true })
brandKeywords?: string[] | null
}