refactoring

Resolve #7779

packages/backend/src/models/entities/notification.ts

@@ -0,0 +1,172 @@
+import { Entity, Index, JoinColumn, ManyToOne, Column, PrimaryColumn } from 'typeorm';
+import { User } from './user';
+import { id } from '../id';
+import { Note } from './note';
+import { FollowRequest } from './follow-request';
+import { UserGroupInvitation } from './user-group-invitation';
+import { AccessToken } from './access-token';
+import { notificationTypes } from '@/types';
+
+@Entity()
+export class Notification {
+	@PrimaryColumn(id())
+	public id: string;
+
+	@Index()
+	@Column('timestamp with time zone', {
+		comment: 'The created date of the Notification.'
+	})
+	public createdAt: Date;
+
+	/**
+	 * 通知の受信者
+	 */
+	@Index()
+	@Column({
+		...id(),
+		comment: 'The ID of recipient user of the Notification.'
+	})
+	public notifieeId: User['id'];
+
+	@ManyToOne(type => User, {
+		onDelete: 'CASCADE'
+	})
+	@JoinColumn()
+	public notifiee: User | null;
+
+	/**
+	 * 通知の送信者(initiator)
+	 */
+	@Index()
+	@Column({
+		...id(),
+		nullable: true,
+		comment: 'The ID of sender user of the Notification.'
+	})
+	public notifierId: User['id'] | null;
+
+	@ManyToOne(type => User, {
+		onDelete: 'CASCADE'
+	})
+	@JoinColumn()
+	public notifier: User | null;
+
+	/**
+	 * 通知の種類。
+	 * follow - フォローされた
+	 * mention - 投稿で自分が言及された
+	 * reply - (自分または自分がWatchしている)投稿が返信された
+	 * renote - (自分または自分がWatchしている)投稿がRenoteされた
+	 * quote - (自分または自分がWatchしている)投稿が引用Renoteされた
+	 * reaction - (自分または自分がWatchしている)投稿にリアクションされた
+	 * pollVote - (自分または自分がWatchしている)投稿の投票に投票された
+	 * receiveFollowRequest - フォローリクエストされた
+	 * followRequestAccepted - 自分の送ったフォローリクエストが承認された
+	 * groupInvited - グループに招待された
+	 * app - アプリ通知
+	 */
+	@Index()
+	@Column('enum', {
+		enum: notificationTypes,
+		comment: 'The type of the Notification.'
+	})
+	public type: typeof notificationTypes[number];
+
+	/**
+	 * 通知が読まれたかどうか
+	 */
+	@Index()
+	@Column('boolean', {
+		default: false,
+		comment: 'Whether the Notification is read.'
+	})
+	public isRead: boolean;
+
+	@Column({
+		...id(),
+		nullable: true
+	})
+	public noteId: Note['id'] | null;
+
+	@ManyToOne(type => Note, {
+		onDelete: 'CASCADE'
+	})
+	@JoinColumn()
+	public note: Note | null;
+
+	@Column({
+		...id(),
+		nullable: true
+	})
+	public followRequestId: FollowRequest['id'] | null;
+
+	@ManyToOne(type => FollowRequest, {
+		onDelete: 'CASCADE'
+	})
+	@JoinColumn()
+	public followRequest: FollowRequest | null;
+
+	@Column({
+		...id(),
+		nullable: true
+	})
+	public userGroupInvitationId: UserGroupInvitation['id'] | null;
+
+	@ManyToOne(type => UserGroupInvitation, {
+		onDelete: 'CASCADE'
+	})
+	@JoinColumn()
+	public userGroupInvitation: UserGroupInvitation | null;
+
+	@Column('varchar', {
+		length: 128, nullable: true
+	})
+	public reaction: string | null;
+
+	@Column('integer', {
+		nullable: true
+	})
+	public choice: number | null;
+
+	/**
+	 * アプリ通知のbody
+	 */
+	@Column('varchar', {
+		length: 2048, nullable: true
+	})
+	public customBody: string | null;
+
+	/**
+	 * アプリ通知のheader
+	 * (省略時はアプリ名で表示されることを期待)
+	 */
+	@Column('varchar', {
+		length: 256, nullable: true
+	})
+	public customHeader: string | null;
+
+	/**
+	 * アプリ通知のicon(URL)
+	 * (省略時はアプリアイコンで表示されることを期待)
+	 */
+	@Column('varchar', {
+		length: 1024, nullable: true
+	})
+	public customIcon: string | null;
+
+	/**
+	 * アプリ通知のアプリ(のトークン)
+	 */
+	@Index()
+	@Column({
+		...id(),
+		nullable: true
+	})
+	public appAccessTokenId: AccessToken['id'] | null;
+
+	@ManyToOne(type => AccessToken, {
+		onDelete: 'CASCADE'
+	})
+	@JoinColumn()
+	public appAccessToken: AccessToken | null;
+}