summary refs log tree commit diff
path: root/src/util/entities/ReadState.ts
blob: 53ed55899a4039364835632c7f80a7c97a718329 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
import {
	Column,
	Entity,
	Index,
	JoinColumn,
	ManyToOne,
	RelationId,
} from "typeorm";
import { BaseClass } from "./BaseClass";
import { Channel } from "./Channel";
import { Message } from "./Message";
import { User } from "./User";

// for read receipts
// notification cursor and public read receipt need to be forwards-only (the former to prevent re-pinging when marked as unread, and the latter to be acceptable as a legal acknowledgement in criminal proceedings), and private read marker needs to be advance-rewind capable
// public read receipt ≥ notification cursor ≥ private fully read marker

@Entity("read_states")
@Index(["channel_id", "user_id"], { unique: true })
export class ReadState extends BaseClass {
	@Column()
	@RelationId((read_state: ReadState) => read_state.channel)
	channel_id: string;

	@JoinColumn({ name: "channel_id" })
	@ManyToOne(() => Channel, {
		onDelete: "CASCADE",
	})
	channel: Channel;

	@Column()
	@RelationId((read_state: ReadState) => read_state.user)
	user_id: string;

	@JoinColumn({ name: "user_id" })
	@ManyToOne(() => User, {
		onDelete: "CASCADE",
	})
	user: User;

	// fully read marker
	@Column({ nullable: true })
	last_message_id: string;

	// public read receipt
	@Column({ nullable: true })
	public_ack: string;

	// notification cursor / private read receipt
	@Column({ nullable: true })
	notifications_cursor: string;

	@Column({ nullable: true })
	last_pin_timestamp?: Date;

	@Column({ nullable: true })
	mention_count: number;

	// @Column({ nullable: true })
	// TODO: derive this from (last_message_id=notifications_cursor=public_ack)=true
	manual: boolean;
}