[EC-281] Add de/serialization methods to CipherView objects (#2970)

libs/common/src/models/domain/symmetricCryptoKey.ts

@@ -1,5 +1,8 @@
+import { Jsonify } from "type-fest";
+
+import { Utils } from "@bitwarden/common/misc/utils";
+
 import { EncryptionType } from "../../enums/encryptionType";
-import { Utils } from "../../misc/utils";
 
 export class SymmetricCryptoKey {
   key: ArrayBuffer;
@@ -55,21 +58,17 @@ export class SymmetricCryptoKey {
     }
   }
 
-  static initFromJson(jsonResult: SymmetricCryptoKey): SymmetricCryptoKey {
-    if (jsonResult == null) {
-      return jsonResult;
+  toJSON() {
+    // The whole object is constructed from the initial key, so just store the B64 key
+    return { keyB64: this.keyB64 };
+  }
+
+  static fromJSON(obj: Jsonify<SymmetricCryptoKey>): SymmetricCryptoKey {
+    if (obj == null) {
+      return null;
     }
 
-    if (jsonResult.keyB64 != null) {
-      jsonResult.key = Utils.fromB64ToArray(jsonResult.keyB64).buffer;
-    }
-    if (jsonResult.encKeyB64 != null) {
-      jsonResult.encKey = Utils.fromB64ToArray(jsonResult.encKeyB64).buffer;
-    }
-    if (jsonResult.macKeyB64 != null) {
-      jsonResult.macKey = Utils.fromB64ToArray(jsonResult.macKeyB64).buffer;
-    }
-
-    return jsonResult;
+    const arrayBuffer = Utils.fromB64ToArray(obj.keyB64).buffer;
+    return new SymmetricCryptoKey(arrayBuffer);
   }
 }

libs/common/src/models/view/attachmentView.ts

@@ -1,3 +1,5 @@
+import { Jsonify } from "type-fest";
+
 import { Attachment } from "../domain/attachment";
 import { SymmetricCryptoKey } from "../domain/symmetricCryptoKey";
 
@@ -32,4 +34,9 @@ export class AttachmentView implements View {
     }
     return 0;
   }
+
+  static fromJSON(obj: Partial<Jsonify<AttachmentView>>): AttachmentView {
+    const key = obj.key == null ? null : SymmetricCryptoKey.fromJSON(obj.key);
+    return Object.assign(new AttachmentView(), obj, { key: key });
+  }
 }

libs/common/src/models/view/cardView.ts

@@ -1,3 +1,5 @@
+import { Jsonify } from "type-fest";
+
 import { CardLinkedId as LinkedId } from "../../enums/linkedIdType";
 import { linkedFieldOption } from "../../misc/linkedFieldOption.decorator";
 
@@ -17,10 +19,6 @@ export class CardView extends ItemView {
   private _number: string = null;
   private _subTitle: string = null;
 
-  constructor() {
-    super();
-  }
-
   get maskedCode(): string {
     return this.code != null ? "•".repeat(this.code.length) : null;
   }
@@ -79,4 +77,8 @@ export class CardView extends ItemView {
   private formatYear(year: string): string {
     return year.length === 2 ? "20" + year : year;
   }
+
+  static fromJSON(obj: Partial<Jsonify<CardView>>): CardView {
+    return Object.assign(new CardView(), obj);
+  }
 }

libs/common/src/models/view/cipherView.ts

@@ -1,3 +1,5 @@
+import { Jsonify } from "type-fest";
+
 import { CipherRepromptType } from "../../enums/cipherRepromptType";
 import { CipherType } from "../../enums/cipherType";
 import { LinkedIdType } from "../../enums/linkedIdType";
@@ -131,4 +133,40 @@ export class CipherView implements View {
   linkedFieldI18nKey(id: LinkedIdType): string {
     return this.linkedFieldOptions.get(id)?.i18nKey;
   }
+
+  static fromJSON(obj: Partial<Jsonify<CipherView>>): CipherView {
+    const view = new CipherView();
+    const revisionDate = obj.revisionDate == null ? null : new Date(obj.revisionDate);
+    const deletedDate = obj.deletedDate == null ? null : new Date(obj.deletedDate);
+    const attachments = obj.attachments?.map((a: any) => AttachmentView.fromJSON(a));
+    const fields = obj.fields?.map((f: any) => FieldView.fromJSON(f));
+    const passwordHistory = obj.passwordHistory?.map((ph: any) => PasswordHistoryView.fromJSON(ph));
+
+    Object.assign(view, obj, {
+      revisionDate: revisionDate,
+      deletedDate: deletedDate,
+      attachments: attachments,
+      fields: fields,
+      passwordHistory: passwordHistory,
+    });
+
+    switch (obj.type) {
+      case CipherType.Card:
+        view.card = CardView.fromJSON(obj.card);
+        break;
+      case CipherType.Identity:
+        view.identity = IdentityView.fromJSON(obj.identity);
+        break;
+      case CipherType.Login:
+        view.login = LoginView.fromJSON(obj.login);
+        break;
+      case CipherType.SecureNote:
+        view.secureNote = SecureNoteView.fromJSON(obj.secureNote);
+        break;
+      default:
+        break;
+    }
+
+    return view;
+  }
 }

libs/common/src/models/view/fieldView.ts

@@ -1,3 +1,5 @@
+import { Jsonify } from "type-fest";
+
 import { FieldType } from "../../enums/fieldType";
 import { LinkedIdType } from "../../enums/linkedIdType";
 import { Field } from "../domain/field";
@@ -25,4 +27,8 @@ export class FieldView implements View {
   get maskedValue(): string {
     return this.value != null ? "••••••••" : null;
   }
+
+  static fromJSON(obj: Partial<Jsonify<FieldView>>): FieldView {
+    return Object.assign(new FieldView(), obj);
+  }
 }

libs/common/src/models/view/identityView.ts

@@ -1,3 +1,5 @@
+import { Jsonify } from "type-fest";
+
 import { IdentityLinkedId as LinkedId } from "../../enums/linkedIdType";
 import { linkedFieldOption } from "../../misc/linkedFieldOption.decorator";
 import { Utils } from "../../misc/utils";
@@ -139,4 +141,8 @@ export class IdentityView extends ItemView {
     addressPart2 += ", " + postalCode;
     return addressPart2;
   }
+
+  static fromJSON(obj: Partial<Jsonify<IdentityView>>): IdentityView {
+    return Object.assign(new IdentityView(), obj);
+  }
 }

libs/common/src/models/view/loginUriView.ts

@@ -1,3 +1,5 @@
+import { Jsonify } from "type-fest";
+
 import { UriMatchType } from "../../enums/uriMatchType";
 import { Utils } from "../../misc/utils";
 import { LoginUri } from "../domain/loginUri";
@@ -124,4 +126,8 @@ export class LoginUriView implements View {
       ? "http://" + this.uri
       : this.uri;
   }
+
+  static fromJSON(obj: Partial<Jsonify<LoginUriView>>): LoginUriView {
+    return Object.assign(new LoginUriView(), obj);
+  }
 }

libs/common/src/models/view/loginView.ts

@@ -1,3 +1,5 @@
+import { Jsonify } from "type-fest";
+
 import { LoginLinkedId as LinkedId } from "../../enums/linkedIdType";
 import { linkedFieldOption } from "../../misc/linkedFieldOption.decorator";
 import { Utils } from "../../misc/utils";
@@ -60,4 +62,15 @@ export class LoginView extends ItemView {
   get hasUris(): boolean {
     return this.uris != null && this.uris.length > 0;
   }
+
+  static fromJSON(obj: Partial<Jsonify<LoginView>>): LoginView {
+    const passwordRevisionDate =
+      obj.passwordRevisionDate == null ? null : new Date(obj.passwordRevisionDate);
+    const uris = obj.uris?.map((uri: any) => LoginUriView.fromJSON(uri));
+
+    return Object.assign(new LoginView(), obj, {
+      passwordRevisionDate: passwordRevisionDate,
+      uris: uris,
+    });
+  }
 }

libs/common/src/models/view/passwordHistoryView.ts

@@ -1,3 +1,5 @@
+import { Jsonify } from "type-fest";
+
 import { Password } from "../domain/password";
 
 import { View } from "./view";
@@ -13,4 +15,12 @@ export class PasswordHistoryView implements View {
 
     this.lastUsedDate = ph.lastUsedDate;
   }
+
+  static fromJSON(obj: Partial<Jsonify<PasswordHistoryView>>): PasswordHistoryView {
+    const lastUsedDate = obj.lastUsedDate == null ? null : new Date(obj.lastUsedDate);
+
+    return Object.assign(new PasswordHistoryView(), obj, {
+      lastUsedDate: lastUsedDate,
+    });
+  }
 }

libs/common/src/models/view/secureNoteView.ts

@@ -1,3 +1,5 @@
+import { Jsonify } from "type-fest";
+
 import { SecureNoteType } from "../../enums/secureNoteType";
 import { SecureNote } from "../domain/secureNote";
 
@@ -18,4 +20,8 @@ export class SecureNoteView extends ItemView {
   get subTitle(): string {
     return null;
   }
+
+  static fromJSON(obj: Partial<Jsonify<SecureNoteView>>): SecureNoteView {
+    return Object.assign(new SecureNoteView(), obj);
+  }
 }