mirror of
https://github.com/OneUptime/oneuptime
synced 2024-11-22 23:30:10 +00:00
429 lines
13 KiB
TypeScript
429 lines
13 KiB
TypeScript
import { Column, Entity, Index, JoinColumn, ManyToOne } from 'typeorm';
|
|
import BaseModel from 'Common/Models/BaseModel';
|
|
import User from './User';
|
|
import Project from './Project';
|
|
import CrudApiEndpoint from 'Common/Types/Database/CrudApiEndpoint';
|
|
import SlugifyColumn from 'Common/Types/Database/SlugifyColumn';
|
|
import Route from 'Common/Types/API/Route';
|
|
import TableColumnType from 'Common/Types/BaseDatabase/TableColumnType';
|
|
import TableColumn from 'Common/Types/Database/TableColumn';
|
|
import ColumnType from 'Common/Types/Database/ColumnType';
|
|
import ObjectID from 'Common/Types/ObjectID';
|
|
import ColumnLength from 'Common/Types/Database/ColumnLength';
|
|
import TableAccessControl from 'Common/Types/Database/AccessControl/TableAccessControl';
|
|
import Permission from 'Common/Types/Permission';
|
|
import ColumnAccessControl from 'Common/Types/Database/AccessControl/ColumnAccessControl';
|
|
import TenantColumn from 'Common/Types/Database/TenantColumn';
|
|
import TableMetadata from 'Common/Types/Database/TableMetadata';
|
|
import EnableWorkflow from 'Common/Types/Model/EnableWorkflow';
|
|
import IconProp from 'Common/Types/Icon/IconProp';
|
|
import StatusPage from './StatusPage';
|
|
import Email from 'Common/Types/Email';
|
|
import Phone from 'Common/Types/Phone';
|
|
import URL from 'Common/Types/API/URL';
|
|
import CanAccessIfCanReadOn from 'Common/Types/Database/CanAccessIfCanReadOn';
|
|
import EnableDocumentation from 'Common/Types/Model/EnableDocumentation';
|
|
|
|
@EnableDocumentation()
|
|
@EnableWorkflow({
|
|
create: true,
|
|
delete: true,
|
|
update: true,
|
|
read: true,
|
|
})
|
|
@CanAccessIfCanReadOn('statusPage')
|
|
@TenantColumn('projectId')
|
|
@TableAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanCreateStatusPageSubscriber,
|
|
Permission.Public,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanReadStatusPageSubscriber,
|
|
],
|
|
delete: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanDeleteStatusPageSubscriber,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanEditStatusPageSubscriber,
|
|
],
|
|
})
|
|
@CrudApiEndpoint(new Route('/status-page-subscriber'))
|
|
@SlugifyColumn('name', 'slug')
|
|
@TableMetadata({
|
|
tableName: 'StatusPageSubscriber',
|
|
singularName: 'Status Page Subscriber',
|
|
pluralName: 'Status Page Subscribers',
|
|
icon: IconProp.Team,
|
|
tableDescription: 'Subscriber that subscribed to your status page',
|
|
})
|
|
@Entity({
|
|
name: 'StatusPageSubscriber',
|
|
})
|
|
export default class StatusPageSubscriber extends BaseModel {
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanCreateStatusPageSubscriber,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanReadStatusPageSubscriber,
|
|
],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
manyToOneRelationColumn: 'projectId',
|
|
type: TableColumnType.Entity,
|
|
modelType: Project,
|
|
title: 'Project',
|
|
description:
|
|
'Relation to Project Resource in which this object belongs',
|
|
})
|
|
@ManyToOne(
|
|
(_type: string) => {
|
|
return Project;
|
|
},
|
|
{
|
|
eager: false,
|
|
nullable: true,
|
|
onDelete: 'CASCADE',
|
|
orphanedRowAction: 'nullify',
|
|
}
|
|
)
|
|
@JoinColumn({ name: 'projectId' })
|
|
public project?: Project = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanCreateStatusPageSubscriber,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanReadStatusPageSubscriber,
|
|
],
|
|
update: [],
|
|
})
|
|
@Index()
|
|
@TableColumn({
|
|
type: TableColumnType.ObjectID,
|
|
required: true,
|
|
canReadOnRelationQuery: true,
|
|
title: 'Project ID',
|
|
description:
|
|
'ID of your OneUptime Project in which this object belongs',
|
|
})
|
|
@Column({
|
|
type: ColumnType.ObjectID,
|
|
nullable: false,
|
|
transformer: ObjectID.getDatabaseTransformer(),
|
|
})
|
|
public projectId?: ObjectID = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanCreateStatusPageSubscriber,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanReadStatusPageSubscriber,
|
|
],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
manyToOneRelationColumn: 'statusPageId',
|
|
type: TableColumnType.Entity,
|
|
modelType: StatusPage,
|
|
title: 'Status Page',
|
|
description:
|
|
'Relation to Status Page Resource in which this object belongs',
|
|
})
|
|
@ManyToOne(
|
|
(_type: string) => {
|
|
return StatusPage;
|
|
},
|
|
{
|
|
eager: false,
|
|
nullable: true,
|
|
onDelete: 'CASCADE',
|
|
orphanedRowAction: 'nullify',
|
|
}
|
|
)
|
|
@JoinColumn({ name: 'statusPageId' })
|
|
public statusPage?: StatusPage = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanCreateStatusPageSubscriber,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanReadStatusPageSubscriber,
|
|
],
|
|
update: [],
|
|
})
|
|
@Index()
|
|
@TableColumn({
|
|
type: TableColumnType.ObjectID,
|
|
required: true,
|
|
title: 'Status Page ID',
|
|
description:
|
|
'ID of your Status Page resource where this object belongs',
|
|
})
|
|
@Column({
|
|
type: ColumnType.ObjectID,
|
|
nullable: false,
|
|
transformer: ObjectID.getDatabaseTransformer(),
|
|
})
|
|
public statusPageId?: ObjectID = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanCreateStatusPageSubscriber,
|
|
Permission.Public,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanReadStatusPageSubscriber,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanEditStatusPageSubscriber,
|
|
],
|
|
})
|
|
@TableColumn({
|
|
required: false,
|
|
type: TableColumnType.Email,
|
|
title: 'Email',
|
|
description: 'Email address of the subscriber.',
|
|
})
|
|
@Column({
|
|
nullable: true,
|
|
type: ColumnType.Email,
|
|
length: ColumnLength.Email,
|
|
transformer: Email.getDatabaseTransformer(),
|
|
})
|
|
public subscriberEmail?: Email = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanCreateStatusPageSubscriber,
|
|
Permission.Public,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanReadStatusPageSubscriber,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanEditStatusPageSubscriber,
|
|
],
|
|
})
|
|
@TableColumn({
|
|
required: false,
|
|
type: TableColumnType.Phone,
|
|
title: 'Phone',
|
|
description: 'Phone number of subscriber',
|
|
})
|
|
@Column({
|
|
nullable: true,
|
|
type: ColumnType.Phone,
|
|
length: ColumnLength.Phone,
|
|
transformer: Phone.getDatabaseTransformer(),
|
|
})
|
|
public subscriberPhone?: Phone = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanCreateStatusPageSubscriber,
|
|
Permission.Public,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanReadStatusPageSubscriber,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanEditStatusPageSubscriber,
|
|
],
|
|
})
|
|
@TableColumn({
|
|
required: false,
|
|
type: TableColumnType.ShortURL,
|
|
title: 'Webhook',
|
|
description: 'Webhook to ping when events happen on Status Page',
|
|
})
|
|
@Column({
|
|
nullable: true,
|
|
type: ColumnType.ShortURL,
|
|
transformer: URL.getDatabaseTransformer(),
|
|
})
|
|
public subscriberWebhook?: URL = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanCreateStatusPageSubscriber,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanReadStatusPageSubscriber,
|
|
],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
manyToOneRelationColumn: 'createdByUserId',
|
|
type: TableColumnType.Entity,
|
|
modelType: User,
|
|
title: 'Created by User',
|
|
description:
|
|
'Relation to User who created this object (if this object was created by a User)',
|
|
})
|
|
@ManyToOne(
|
|
(_type: string) => {
|
|
return User;
|
|
},
|
|
{
|
|
eager: false,
|
|
nullable: true,
|
|
onDelete: 'CASCADE',
|
|
orphanedRowAction: 'nullify',
|
|
}
|
|
)
|
|
@JoinColumn({ name: 'createdByUserId' })
|
|
public createdByUser?: User = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanCreateStatusPageSubscriber,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanReadStatusPageSubscriber,
|
|
],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
type: TableColumnType.ObjectID,
|
|
title: 'Created by User ID',
|
|
description:
|
|
'User ID who created this object (if this object was created by a User)',
|
|
})
|
|
@Column({
|
|
type: ColumnType.ObjectID,
|
|
nullable: true,
|
|
transformer: ObjectID.getDatabaseTransformer(),
|
|
})
|
|
public createdByUserId?: ObjectID = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CanReadStatusPageSubscriber,
|
|
],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
manyToOneRelationColumn: 'deletedByUserId',
|
|
type: TableColumnType.Entity,
|
|
title: 'Deleted by User',
|
|
description:
|
|
'Relation to User who deleted this object (if this object was deleted by a User)',
|
|
})
|
|
@ManyToOne(
|
|
(_type: string) => {
|
|
return User;
|
|
},
|
|
{
|
|
cascade: false,
|
|
eager: false,
|
|
nullable: true,
|
|
onDelete: 'CASCADE',
|
|
orphanedRowAction: 'nullify',
|
|
}
|
|
)
|
|
@JoinColumn({ name: 'deletedByUserId' })
|
|
public deletedByUser?: User = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [],
|
|
read: [Permission.CurrentUser],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
isDefaultValueColumn: true,
|
|
type: TableColumnType.Boolean,
|
|
title: 'Is Unsubscribed',
|
|
description: 'Is Subscriber Unsubscribed?',
|
|
})
|
|
@Column({
|
|
type: ColumnType.Boolean,
|
|
default: false,
|
|
})
|
|
public isUnsubscribed?: boolean = undefined;
|
|
}
|