Skip to content

📈 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!

5.9 KB
Raw Blame
import { Entity, Column, PrimaryColumn, ManyToOne, OneToMany } from 'typeorm'
import { ApiProperty } from '@nestjs/swagger'

import { Alert } from '../../alert/entity/alert.entity'
import { Experiment } from '../../experiment/entity/experiment.entity'
import { FeatureFlag } from '../../feature-flag/entity/feature-flag.entity'
import { Goal } from '../../goal/entity/goal.entity'
import { User } from '../../user/entities/user.entity'
import { ProjectShare } from './project-share.entity'
import { ProjectSubscriber } from './project-subscriber.entity'
import { Funnel } from './funnel.entity'
import { Annotation } from './annotation.entity'
import { CAPTCHA_SECRET_KEY_LENGTH } from '../../common/constants'
import { ProjectViewEntity } from './project-view.entity'
import { Organisation } from '../../organisation/entity/organisation.entity'

export enum BotsProtectionLevel {
  OFF = 'off',
  BASIC = 'basic',
  STRICT = 'strict',
}

enum CaptchaDifficultyMode {
  MANUAL = 'manual',
  AUTO = 'auto',
}

// In case of modifying some properties here add them to the GDPR data export email template
@Entity()
export class Project {
  @ApiProperty()
  @PrimaryColumn('varchar', {
    unique: true,
    length: 12,
  })
  id: string

  @ApiProperty()
  @Column('varchar', { length: 50 })
  name: string

  @ApiProperty()
  @Column('simple-array')
  origins: string[]

  @ApiProperty()
  @Column('simple-array', { nullable: true, default: null })
  ipBlacklist: string[]

  // IPs (or CIDR ranges) that bot detection (Shields) never flags
  @ApiProperty()
  @Column('simple-array', { nullable: true, default: null })
  ipWhitelist: string[]

  @ApiProperty()
  @Column('simple-array', { nullable: true, default: null })
  countryBlacklist: string[]

  @ApiProperty()
  @Column({
    default: true,
  })
  active: boolean

  @ApiProperty()
  @Column({
    default: false,
  })
  public: boolean

  @Column('boolean', { default: false })
  isTransferring: boolean

  // CAPTCHA secret key - if set, CAPTCHA is enabled for this project
  @ApiProperty()
  @Column('varchar', { default: null, length: CAPTCHA_SECRET_KEY_LENGTH })
  captchaSecretKey: string | null

  // CAPTCHA PoW difficulty (number of leading zeros required in hash)
  // Default is 4 (~65k iterations, ~1-2 seconds on average devices)
  @ApiProperty()
  @Column('tinyint', { default: 4, unsigned: true })
  captchaDifficulty: number

  @ApiProperty()
  @Column({
    type: 'enum',
    enum: CaptchaDifficultyMode,
    default: CaptchaDifficultyMode.MANUAL,
  })
  captchaDifficultyMode: CaptchaDifficultyMode

  @ApiProperty()
  @Column({
    type: 'enum',
    enum: BotsProtectionLevel,
    default: BotsProtectionLevel.BASIC,
  })
  botsProtectionLevel: BotsProtectionLevel

  @ApiProperty({ type: () => User })
  @ManyToOne(() => User, (user) => user.projects)
  admin: User

  @ApiProperty({ type: () => ProjectShare })
  @OneToMany(() => ProjectShare, (share) => share.project)
  share: ProjectShare[]

  @ApiProperty({ type: () => Alert })
  @OneToMany(() => Alert, (alert) => alert.project)
  alerts: Alert[]

  @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
  created: Date

  @OneToMany(() => ProjectSubscriber, (subscriber) => subscriber.project, {
    cascade: true,
  })
  subscribers: ProjectSubscriber[]

  @ApiProperty({ type: () => Funnel })
  @OneToMany(() => Funnel, (funnel) => funnel.project)
  funnels: Funnel[]

  @ApiProperty({ type: () => Annotation })
  @OneToMany(() => Annotation, (annotation) => annotation.project)
  annotations: Annotation[]

  @ApiProperty({ type: () => Goal })
  @OneToMany(() => Goal, (goal) => goal.project)
  goals: Goal[]

  @ApiProperty({ type: () => FeatureFlag })
  @OneToMany(() => FeatureFlag, (featureFlag) => featureFlag.project)
  featureFlags: FeatureFlag[]

  @ApiProperty({ type: () => Experiment })
  @OneToMany(() => Experiment, (experiment) => experiment.project)
  experiments: Experiment[]

  @Column('varchar', {
    default: null,
    length: 60,
    nullable: true,
  })
  passwordHash: string | null

  @Column('boolean', { default: false })
  isPasswordProtected: boolean

  @Column('boolean', { default: false })
  isArchived: boolean

  @OneToMany(() => ProjectViewEntity, (projectView) => projectView.id)
  views: ProjectViewEntity[]

  @ManyToOne(() => Organisation, (org) => org.projects, { nullable: true })
  organisation: Organisation | null

  // Google Search Console integration
  @Column('varchar', { nullable: true, default: null, length: 512 })
  gscPropertyUri: string | null

  @Column('text', { nullable: true, default: null })
  gscAccessTokenEnc: string | null

  @Column('text', { nullable: true, default: null })
  gscRefreshTokenEnc: string | null

  @Column('bigint', { nullable: true, default: null })
  gscTokenExpiry: string | null

  @Column('varchar', { nullable: true, default: null, length: 512 })
  gscScope: string | null

  @Column('varchar', { nullable: true, default: null, length: 256 })
  gscAccountEmail: string | null

  // Revenue / Payment provider integration
  @Column('text', { nullable: true, default: null })
  paddleApiKeyEnc: string | null

  @Column('varchar', { nullable: true, default: null, length: 3 })
  revenueCurrency: string | null

  @Column('text', { nullable: true, default: null })
  paddleApiKeyPermissions: string | null

  @Column('text', { nullable: true, default: null })
  stripeApiKeyEnc: string | null

  @Column('text', { nullable: true, default: null })
  stripeApiKeyPermissions: string | null

  @Column('datetime', { nullable: true, default: null })
  revenueLastSyncAt: Date | null

  @Column('boolean', { default: false })
  revenueApiEnabled: boolean

  @Column('int', { unsigned: true, default: 30 })
  sessionReplayRetentionDays: number

  @ApiProperty()
  @Column('varchar', { nullable: true, default: null, length: 512 })
  websiteUrl: string | null

  @ApiProperty({ type: [String], nullable: true })
  @Column('text', { nullable: true, default: null })
  brandKeywords: string | null
}