cleanup

app/models/Notification.ts

@@ -18,24 +18,48 @@ class Notification extends BaseModel {
   @observable
   id: string;
 
+  /**
+   * The date the notification was marked as read.
+   */
   @Field
   @observable
   viewedAt: Date | null;
 
+  /**
+   * The date the notification was archived.
+   */
   @Field
   @observable
   archivedAt: Date | null;
 
+  /**
+   * The user that triggered the notification.
+   */
   actor?: User;
 
+  /**
+   * The document ID that the notification is associated with.
+   */
   documentId?: string;
 
-  collectionId?: string;
+  /**
-
+   * The document that the notification is associated with.
+   */
   document?: Document;
 
+  /**
+   * The collection ID that the notification is associated with.
+   */
+  collectionId?: string;
+
+  /**
+   * The comment that the notification is associated with.
+   */
   comment?: Comment;
 
+  /**
+   * The type of notification.
+   */
   event: NotificationEventType;
 
   /**
@@ -72,23 +96,29 @@ class Notification extends BaseModel {
    */
   eventText(t: TFunction): string {
     switch (this.event) {
-      case "documents.publish":
+      case NotificationEventType.PublishDocument:
         return t("published");
-      case "documents.update":
+      case NotificationEventType.UpdateDocument:
-      case "revisions.create":
+      case NotificationEventType.CreateRevision:
         return t("edited");
-      case "collections.create":
+      case NotificationEventType.CreateCollection:
         return t("created the collection");
-      case "documents.mentioned":
+      case NotificationEventType.MentionedInDocument:
-      case "comments.mentioned":
+      case NotificationEventType.MentionedInComment:
         return t("mentioned you in");
-      case "comments.create":
+      case NotificationEventType.CreateComment:
         return t("left a comment on");
       default:
         return this.event;
     }
   }
 
+  /**
+   * Returns the subject of the notification. This is the title of the associated
+   * document.
+   *
+   * @returns The subject
+   */
   get subject() {
     return this.document?.title;
   }
@@ -131,10 +161,9 @@ class Notification extends BaseModel {
       case NotificationEventType.ExportCompleted: {
         return settingsPath("export");
       }
-      default: {
+      default:
-        const check: never = this.event;
+        this.event satisfies never;
-        throw new Error(`Unhandled case: ${check}`);
+        return;
-      }
     }
   }
 }

app/utils/language.ts

@@ -12,13 +12,13 @@ export async function changeLanguage(
   toLanguageString: string | null | undefined,
   i18n: i18n
 ) {
+  // Languages are stored in en_US format in the database, however the
+  // frontend translation framework (i18next) expects en-US
   const locale = toLanguageString
     ? unicodeCLDRtoBCP47(toLanguageString)
     : undefined;
 
   if (locale && i18n.languages?.[0] !== locale) {
-    // Languages are stored in en_US format in the database, however the
-    // frontend translation framework (i18next) expects en-US
     await i18n.changeLanguage(locale);
     await Desktop.bridge?.setSpellCheckerLanguages(["en-US", locale]);
   }