From bab704992ff71b823dee50e5c0de414b8c0eb910 Mon Sep 17 00:00:00 2001
From: Lhcfl <Lhcfl@outlook.com>
Date: Tue, 26 Mar 2024 16:59:42 +0800
Subject: [PATCH] feat: add post history page

---
 locales/en-US.yml                             |   1 +
 locales/zh-CN.yml                             |   1 +
 .../src/server/api/endpoints/notes/history.ts |   3 +
 .../src/components/MkDateSeparatedList.vue    |   2 +-
 packages/client/src/components/MkNote.vue     |   8 +-
 packages/client/src/filters/note.ts           |   9 +-
 packages/client/src/pages/note-history.vue    | 123 ++++++++++++++++++
 packages/client/src/router.ts                 |   5 +
 packages/client/src/scripts/get-note-menu.ts  |  17 +++
 packages/firefish-js/src/api.types.ts         |   9 ++
 packages/firefish-js/src/entities.ts          |  13 +-
 11 files changed, 186 insertions(+), 5 deletions(-)
 create mode 100644 packages/client/src/pages/note-history.vue

diff --git a/locales/en-US.yml b/locales/en-US.yml
index 88b44d2787..9a85183fe3 100644
--- a/locales/en-US.yml
+++ b/locales/en-US.yml
@@ -2232,3 +2232,4 @@ messagingUnencryptedInfo: "Chats on Firefish are not end-to-end encrypted. Don't
   any sensitive infomation over Firefish."
 autocorrectNoteLanguage: "Show a warning if the post language does not match the auto-detected result"
 incorrectLanguageWarning: "It looks like your post is in {detected}, but you selected {current}.\nWould you like to set the language to {detected} instead?"
+noteEditHistory: "Post edit history"
diff --git a/locales/zh-CN.yml b/locales/zh-CN.yml
index f67bf4a600..85b73d7b45 100644
--- a/locales/zh-CN.yml
+++ b/locales/zh-CN.yml
@@ -2060,3 +2060,4 @@ noAltTextWarning: 有些附件没有描述。您是否忘记写描述了？
 showNoAltTextWarning: 当您尝试发布没有描述的帖子附件时显示警告
 autocorrectNoteLanguage: 当帖子语言不符合自动检测的结果的时候显示警告
 incorrectLanguageWarning: "看上去您帖子使用的语言是{detected}，但您选择的语言是{current}。\n要改为以{detected}发帖吗？"
+noteEditHistory: "帖子编辑历史"
diff --git a/packages/backend/src/server/api/endpoints/notes/history.ts b/packages/backend/src/server/api/endpoints/notes/history.ts
index e0c7be3df5..fb49b4a5b9 100644
--- a/packages/backend/src/server/api/endpoints/notes/history.ts
+++ b/packages/backend/src/server/api/endpoints/notes/history.ts
@@ -58,6 +58,9 @@ export default define(meta, paramDef, async (ps, user) => {
 		},
 		take: ps.limit,
 		skip: ps.offset,
+		order: {
+			id: "DESC"
+		},
 	});
 
 	return await NoteEdits.packMany(history);
diff --git a/packages/client/src/components/MkDateSeparatedList.vue b/packages/client/src/components/MkDateSeparatedList.vue
index e40d64dd7d..c6b75a20fc 100644
--- a/packages/client/src/components/MkDateSeparatedList.vue
+++ b/packages/client/src/components/MkDateSeparatedList.vue
@@ -10,7 +10,7 @@ export default defineComponent({
 	props: {
 		items: {
 			type: Array as PropType<
-				{ id: string; createdAt: string; _shouldInsertAd_: boolean }[]
+				{ id: string; createdAt: string; _shouldInsertAd_?: boolean }[]
 			>,
 			required: true,
 		},
diff --git a/packages/client/src/components/MkNote.vue b/packages/client/src/components/MkNote.vue
index e13050206b..723fabbeee 100644
--- a/packages/client/src/components/MkNote.vue
+++ b/packages/client/src/components/MkNote.vue
@@ -154,7 +154,12 @@
 						{{ appearNote.channel.name }}</MkA
 					>
 				</div>
-				<footer ref="footerEl" class="footer" tabindex="-1">
+				<footer
+					v-show="!hideFooter" 
+					ref="footerEl"
+					class="footer"
+					tabindex="-1"
+				>
 					<XReactionsViewer
 						v-if="enableEmojiReactions"
 						ref="reactionsViewer"
@@ -312,6 +317,7 @@ const props = defineProps<{
 	pinned?: boolean;
 	detailedView?: boolean;
 	collapsedReply?: boolean;
+	hideFooter?: boolean;
 }>();
 
 const inChannel = inject("inChannel", null);
diff --git a/packages/client/src/filters/note.ts b/packages/client/src/filters/note.ts
index 3f7294634e..dd9388d67a 100644
--- a/packages/client/src/filters/note.ts
+++ b/packages/client/src/filters/note.ts
@@ -1,5 +1,12 @@
 import type { entities } from "firefish-js";
 
-export const notePage = (note: entities.Note) => {
+export function notePage(
+	note: entities.Note,
+	options?: {
+		historyPage?: boolean
+}) {
+	if (options?.historyPage) {
+		return `/notes/${note.id}/history`;
+	}
 	return `/notes/${note.id}`;
 };
diff --git a/packages/client/src/pages/note-history.vue b/packages/client/src/pages/note-history.vue
new file mode 100644
index 0000000000..ec1433b60c
--- /dev/null
+++ b/packages/client/src/pages/note-history.vue
@@ -0,0 +1,123 @@
+<template>
+	<MkStickyContainer>
+		<template #header
+			><MkPageHeader
+				:display-back-button="true"
+		/></template>
+		<MkSpacer :content-max="800">
+			
+			<MkLoading v-if="!loaded" />
+			<MkPagination
+				v-else
+				ref="pagingComponent"
+				v-slot="{ items: noteEdits }"
+				:pagination="pagination"
+			>
+				<div ref="tlEl" class="giivymft noGap">
+					<XList
+						v-slot="{ item: noteEdit }"
+						:items="convertNoteEditsToNotes(noteEdits as NoteEdit[])"
+						class="notes"
+						:no-gap="true"
+					>
+						<XNote
+							:key="noteEdit.id"
+							class="qtqtichx"
+							:note="noteEdit"
+							:hide-footer="true"
+						/>
+					</XList>
+				</div>
+			</MkPagination>
+				
+		</MkSpacer>
+	</MkStickyContainer>
+</template>
+
+<script lang="ts" setup>
+import { computed, onMounted, ref } from "vue";
+import MkPagination from "@/components/MkPagination.vue"
+import type { Paging } from "@/components/MkPagination.vue"
+import { api } from "@/os";
+import XList from "@/components/MkDateSeparatedList.vue";
+import XNote from "@/components/MkNote.vue";
+import { i18n } from "@/i18n";
+import { definePageMetadata } from "@/scripts/page-metadata";
+import icon from "@/scripts/icon";
+import type { Note, NoteEdit } from "firefish-js/src/entities";
+
+const pagingComponent = ref<InstanceType<typeof MkPagination>>();
+
+const props = defineProps<{
+	noteId: string;
+}>();
+
+const pagination: Paging = {
+	endpoint: "notes/history" as const,
+	limit: 10,
+	offsetMode: true,
+	params: computed(() => ({
+		noteId: props.noteId
+	})),
+};
+
+definePageMetadata(
+	computed(() => ({
+		title: i18n.t("noteEditHistory"),
+		icon: `${icon("ph-clock-countdown")}`,
+	})),
+);
+
+const note = ref<Note>({} as Note);
+const loaded = ref(false);
+
+onMounted(() => {
+	api("notes/show", {
+		noteId: props.noteId,
+	}).then((res) => {
+		// Remove unnecessary parts
+		res.renote = undefined;
+		res.renoteId = null;
+		res.reply = undefined;
+		res.replyId = null;
+		
+		note.value = res;
+		loaded.value = true;
+	});
+});
+
+function convertNoteEditsToNotes(noteEdits: NoteEdit[]) {
+	return [note.value].concat(
+		noteEdits.map(e => convertNoteEditToNote(e))
+	);
+}
+
+function convertNoteEditToNote(noteEdit: NoteEdit): Note {
+	return Object.assign({}, note.value, {
+		id: crypto.randomUUID(), // Don't use noteId
+		createdAt: noteEdit.updatedAt,
+		text: noteEdit.text,
+		cw: noteEdit.cw,
+		_shouldInsertAd_: false,
+	});
+}
+</script>
+
+<style lang="scss" scoped>
+.giivymft {
+	&.noGap {
+		> .notes {
+			background: var(--panel) !important;
+			border-radius: var(--radius);
+		}
+	}
+	&:not(.noGap) {
+		> .notes {
+			.qtqtichx {
+				background: var(--panel);
+				border-radius: var(--radius);
+			}
+		}
+	}
+}
+</style>
diff --git a/packages/client/src/router.ts b/packages/client/src/router.ts
index 35b54b20ec..a21df2981e 100644
--- a/packages/client/src/router.ts
+++ b/packages/client/src/router.ts
@@ -39,6 +39,11 @@ export const routes = [
 		path: "/notes/:noteId",
 		component: page(() => import("./pages/note.vue")),
 	},
+	{
+		name: "note-history",
+		path: "/notes/:noteId/history",
+		component: page(() => import("./pages/note-history.vue")),
+	},
 	{
 		path: "/clips/:clipId",
 		component: page(() => import("./pages/clip.vue")),
diff --git a/packages/client/src/scripts/get-note-menu.ts b/packages/client/src/scripts/get-note-menu.ts
index ddd9d7c5f4..082e1203db 100644
--- a/packages/client/src/scripts/get-note-menu.ts
+++ b/packages/client/src/scripts/get-note-menu.ts
@@ -11,6 +11,10 @@ import { noteActions } from "@/store";
 import { shareAvailable } from "@/scripts/share-available";
 import { getUserMenu } from "@/scripts/get-user-menu";
 import icon from "@/scripts/icon";
+import { useRouter } from "@/router";
+import { notePage } from "@/filters/note";
+
+const router = useRouter();
 
 export function getNoteMenu(props: {
 	note: entities.Note;
@@ -73,6 +77,10 @@ export function getNoteMenu(props: {
 		});
 	}
 
+	function showEditHistory(): void {
+		router.push(notePage(appearNote, { historyPage: true }));
+	}
+
 	function makePrivate(): void {
 		os.confirm({
 			type: "warning",
@@ -288,6 +296,8 @@ export function getNoteMenu(props: {
 			noteId: appearNote.id,
 		});
 
+		const isEdited = !!appearNote.updatedAt;
+
 		const isAppearAuthor = appearNote.userId === me.id;
 
 		menu = [
@@ -361,6 +371,13 @@ export function getNoteMenu(props: {
 							action: () => togglePin(true),
 					  }
 				: undefined,
+			isEdited
+				? {
+						icon: `${icon('ph-clock-countdown')}`,
+						text: i18n.ts.noteEditHistory,
+						action: () => showEditHistory(),
+					}
+				: undefined,
 			instance.translatorAvailable
 				? {
 						icon: `${icon("ph-translate")}`,
diff --git a/packages/firefish-js/src/api.types.ts b/packages/firefish-js/src/api.types.ts
index 5db210b932..74c744b235 100644
--- a/packages/firefish-js/src/api.types.ts
+++ b/packages/firefish-js/src/api.types.ts
@@ -22,6 +22,7 @@ import type {
 	MeDetailed,
 	MessagingMessage,
 	Note,
+	NoteEdit,
 	NoteFavorite,
 	NoteReaction,
 	Notification,
@@ -657,6 +658,14 @@ export type Endpoints = {
 		};
 		res: Note[];
 	};
+	"notes/history": {
+		req: {
+			noteId: Note["id"];
+			limit?: number;
+			offset?: number;
+		};
+		res: NoteEdit[]
+	};
 	"notes/recommended-timeline": {
 		req: {
 			limit?: number;
diff --git a/packages/firefish-js/src/entities.ts b/packages/firefish-js/src/entities.ts
index 1cbdedd00b..a09a4a1fca 100644
--- a/packages/firefish-js/src/entities.ts
+++ b/packages/firefish-js/src/entities.ts
@@ -143,9 +143,9 @@ export type Note = {
 	user: User;
 	userId: User["id"];
 	reply?: Note;
-	replyId: Note["id"];
+	replyId: Note["id"] | null;
 	renote?: Note;
-	renoteId: Note["id"];
+	renoteId: Note["id"] | null;
 	files: DriveFile[];
 	fileIds: DriveFile["id"][];
 	visibility: "public" | "home" | "followers" | "specified";
@@ -176,6 +176,15 @@ export type Note = {
 	isHidden?: boolean;
 };
 
+export type NoteEdit = {
+	id: string;
+	noteId: string;
+	text: string | null;
+	cw: string | null;
+	updatedAt: string;
+	fileIds: DriveFile["id"];
+}
+
 export type NoteReaction = {
 	id: ID;
 	createdAt: DateString;