Notifications interface (#5354)

Co-authored-by: Apoorv Mishra <apoorvmishra101092@gmail.com>

app/models/Notification.ts

@@ -0,0 +1,127 @@
+import { TFunction } from "i18next";
+import { action, observable } from "mobx";
+import { NotificationEventType } from "@shared/types";
+import {
+  collectionPath,
+  commentPath,
+  documentPath,
+} from "~/utils/routeHelpers";
+import BaseModel from "./BaseModel";
+import Comment from "./Comment";
+import Document from "./Document";
+import User from "./User";
+import Field from "./decorators/Field";
+
+class Notification extends BaseModel {
+  @Field
+  @observable
+  id: string;
+
+  @Field
+  @observable
+  viewedAt: Date | null;
+
+  @Field
+  @observable
+  archivedAt: Date | null;
+
+  actor: User;
+
+  documentId?: string;
+
+  collectionId?: string;
+
+  document?: Document;
+
+  comment?: Comment;
+
+  event: NotificationEventType;
+
+  /**
+   * Mark the notification as read or unread
+   *
+   * @returns A promise that resolves when the notification has been saved.
+   */
+  @action
+  toggleRead() {
+    this.viewedAt = this.viewedAt ? null : new Date();
+    return this.save();
+  }
+
+  /**
+   * Mark the notification as read
+   *
+   * @returns A promise that resolves when the notification has been saved.
+   */
+  @action
+  markAsRead() {
+    if (this.viewedAt) {
+      return;
+    }
+
+    this.viewedAt = new Date();
+    return this.save();
+  }
+
+  /**
+   * Returns translated text that describes the notification
+   *
+   * @param t - The translation function
+   * @returns The event text
+   */
+  eventText(t: TFunction): string {
+    switch (this.event) {
+      case "documents.publish":
+        return t("published");
+      case "documents.update":
+      case "revisions.create":
+        return t("edited");
+      case "collections.create":
+        return t("created the collection");
+      case "documents.mentioned":
+      case "comments.mentioned":
+        return t("mentioned you in");
+      case "comments.create":
+        return t("left a comment on");
+      default:
+        return this.event;
+    }
+  }
+
+  get subject() {
+    return this.document?.title;
+  }
+
+  /**
+   * Returns the path to the model associated with the notification that can be
+   * used with the router.
+   *
+   * @returns The router path.
+   */
+  get path() {
+    switch (this.event) {
+      case "documents.publish":
+      case "documents.update":
+      case "revisions.create": {
+        return this.document ? documentPath(this.document) : "";
+      }
+      case "collections.create": {
+        const collection = this.store.rootStore.documents.get(
+          this.collectionId
+        );
+        return collection ? collectionPath(collection.url) : "";
+      }
+      case "documents.mentioned":
+      case "comments.mentioned":
+      case "comments.create": {
+        return this.document && this.comment
+          ? commentPath(this.document, this.comment)
+          : "";
+      }
+      default:
+        return "";
+    }
+  }
+}
+
+export default Notification;