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!

Added project subscriber entity

Yevhenii Kulisidib11bfa02c3f6
diff --git a/src/action-tokens/action-token.entity.ts b/src/action-tokens/action-token.entity.ts
index 1dfb4c2fb..4d3ab7fe4 100644
--- a/src/action-tokens/action-token.entity.ts
+++ b/src/action-tokens/action-token.entity.ts
@@ -1,37 +1,38 @@
-import {
- Entity,
- PrimaryGeneratedColumn,
- ManyToOne,
- Timestamp,
- CreateDateColumn,
- Column,
-} from 'typeorm'
-import { User } from '../user/entities/user.entity'
-
-export enum ActionTokenType {
- EMAIL_VERIFICATION,
- PASSWORD_RESET,
- EMAIL_CHANGE,
- PROJECT_SHARE,
-}
-
-@Entity()
-export class ActionToken {
- @PrimaryGeneratedColumn('uuid')
- id: string
-
- @ManyToOne(() => User, user => user.actionTokens, { onDelete: 'CASCADE' })
- user: User
-
- @CreateDateColumn()
- created: Timestamp
-
- @Column('varchar', { length: 254, default: null })
- newValue: string
-
- @Column({
- type: 'enum',
- enum: ActionTokenType,
- })
- action: ActionTokenType
-}
+import {
+ Entity,
+ PrimaryGeneratedColumn,
+ ManyToOne,
+ Timestamp,
+ CreateDateColumn,
+ Column,
+} from 'typeorm'
+import { User } from '../user/entities/user.entity'
+
+export enum ActionTokenType {
+ EMAIL_VERIFICATION,
+ PASSWORD_RESET,
+ EMAIL_CHANGE,
+ PROJECT_SHARE,
+ ADDING_PROJECT_SUBSCRIBER,
+}
+
+@Entity()
+export class ActionToken {
+ @PrimaryGeneratedColumn('uuid')
+ id: string
+
+ @ManyToOne(() => User, user => user.actionTokens, { onDelete: 'CASCADE' })
+ user: User
+
+ @CreateDateColumn()
+ created: Timestamp
+
+ @Column('varchar', { length: 254, default: null })
+ newValue: string
+
+ @Column({
+ type: 'enum',
+ enum: ActionTokenType,
+ })
+ action: ActionTokenType
+}
diff --git a/src/project/entity/index.ts b/src/project/entity/index.ts
new file mode 100644
index 000000000..c01847b61
--- /dev/null
+++ b/src/project/entity/index.ts
@@ -0,0 +1 @@
+export * from './project-subscriber.entity'
diff --git a/src/project/entity/project-subscriber.entity.ts b/src/project/entity/project-subscriber.entity.ts
new file mode 100644
index 000000000..4f43935d1
--- /dev/null
+++ b/src/project/entity/project-subscriber.entity.ts
@@ -0,0 +1,34 @@
+import {
+ Column,
+ CreateDateColumn,
+ Entity,
+ ManyToOne,
+ PrimaryGeneratedColumn,
+ UpdateDateColumn,
+} from 'typeorm'
+import { ReportFrequency } from '../enums'
+import { Project } from './project.entity'
+
+@Entity()
+export class ProjectSubscriber {
+ @PrimaryGeneratedColumn('uuid')
+ id: string
+
+ @Column('varchar', { length: 254 })
+ email: string
+
+ @Column('enum', { default: ReportFrequency.MONTHLY, enum: ReportFrequency })
+ reportFrequency: ReportFrequency
+
+ @Column('boolean', { default: false })
+ isConfirmed: boolean
+
+ @CreateDateColumn()
+ addedAt: Date
+
+ @UpdateDateColumn()
+ updatedAt: Date
+
+ @ManyToOne(() => Project, project => project.subscribers)
+ project: Project
+}
diff --git a/src/project/entity/project.entity.ts b/src/project/entity/project.entity.ts
index 8c6081b63..d234c1ab3 100644
--- a/src/project/entity/project.entity.ts
+++ b/src/project/entity/project.entity.ts
@@ -1,72 +1,78 @@
-import {
- Entity,
- Column,
- PrimaryColumn,
- ManyToOne,
- OneToMany,
- JoinTable,
-} from 'typeorm'
-import { ApiProperty } from '@nestjs/swagger'
-
-import { User } from '../../user/entities/user.entity'
-import { ProjectShare } from './project-share.entity'
-import { Alert } from 'src/alert/entity/alert.entity'
-import { ExtensionToProject } from '../../marketplace/extensions/entities/extension-to-project.entity'
-
-// In case of modifying some properties here, make sure to also edit them in common/constants.ts -> selfhosted -> clickhouse
-// and to 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[]
-
- @ApiProperty()
- @Column({
- default: true,
- })
- active: boolean
-
- @ApiProperty()
- @Column({
- default: false,
- })
- public: boolean
-
- @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(
- () => ExtensionToProject,
- extensionToProject => extensionToProject.project,
- )
- @JoinTable()
- extensions: ExtensionToProject[]
-}
+import {
+ Entity,
+ Column,
+ PrimaryColumn,
+ ManyToOne,
+ OneToMany,
+ JoinTable,
+} from 'typeorm'
+import { ApiProperty } from '@nestjs/swagger'
+
+import { User } from '../../user/entities/user.entity'
+import { ProjectShare } from './project-share.entity'
+import { Alert } from 'src/alert/entity/alert.entity'
+import { ExtensionToProject } from '../../marketplace/extensions/entities/extension-to-project.entity'
+import { ProjectSubscriber } from './project-subscriber.entity'
+
+// In case of modifying some properties here, make sure to also edit them in common/constants.ts -> selfhosted -> clickhouse
+// and to 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[]
+
+ @ApiProperty()
+ @Column({
+ default: true,
+ })
+ active: boolean
+
+ @ApiProperty()
+ @Column({
+ default: false,
+ })
+ public: boolean
+
+ @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(
+ () => ExtensionToProject,
+ extensionToProject => extensionToProject.project,
+ )
+ @JoinTable()
+ extensions: ExtensionToProject[]
+
+ @OneToMany(() => ProjectSubscriber, subscriber => subscriber.project, {
+ cascade: true,
+ })
+ subscribers: ProjectSubscriber[]
+}
diff --git a/src/project/enums/index.ts b/src/project/enums/index.ts
new file mode 100644
index 000000000..27ef1fab2
--- /dev/null
+++ b/src/project/enums/index.ts
@@ -0,0 +1 @@
+export * from './report-frequency.enum'
diff --git a/src/project/enums/report-frequency.enum.ts b/src/project/enums/report-frequency.enum.ts
new file mode 100644
index 000000000..15fae835c
--- /dev/null
+++ b/src/project/enums/report-frequency.enum.ts
@@ -0,0 +1,6 @@
+export enum ReportFrequency {
+ QUARTERLY = 'quarterly',
+ MONTHLY = 'monthly',
+ WEEKLY = 'weekly',
+ NEVER = 'never',
+}
diff --git a/src/project/project.module.ts b/src/project/project.module.ts
index dba1cb34d..daf6c819c 100644
--- a/src/project/project.module.ts
+++ b/src/project/project.module.ts
@@ -9,11 +9,11 @@ import { UserModule } from '../user/user.module'
import { ActionTokensModule } from '../action-tokens/action-tokens.module'
import { MailerModule } from '../mailer/mailer.module'
import { AppLoggerModule } from '../logger/logger.module'
+import { ProjectSubscriber } from './entity'
@Module({
imports: [
- TypeOrmModule.forFeature([Project]),
- TypeOrmModule.forFeature([ProjectShare]),
+ TypeOrmModule.forFeature([Project, ProjectShare, ProjectSubscriber]),
forwardRef(() => UserModule),
AppLoggerModule,
ActionTokensModule,