From 3d9239222ea2b744b49f7750777ea1e7c19c421d Mon Sep 17 00:00:00 2001 From: jaasen-livefront Date: Fri, 9 Oct 2026 17:39:35 -0700 Subject: [PATCH] [PM-44526] docs: Add SDK sync comments to vault domain and view models Points engineers to the mirrored sdk-internal structs so model changes are also made in the SDK. --- libs/common/src/vault/models/data/local.data.ts | 2 ++ libs/common/src/vault/models/domain/attachment.ts | 2 ++ libs/common/src/vault/models/domain/bank-account.ts | 2 ++ libs/common/src/vault/models/domain/card.ts | 2 ++ libs/common/src/vault/models/domain/cipher.ts | 2 ++ libs/common/src/vault/models/domain/drivers-license.ts | 2 ++ libs/common/src/vault/models/domain/fido2-credential.ts | 2 ++ libs/common/src/vault/models/domain/field.ts | 2 ++ libs/common/src/vault/models/domain/identity.ts | 2 ++ libs/common/src/vault/models/domain/login-uri.ts | 2 ++ libs/common/src/vault/models/domain/login.ts | 2 ++ libs/common/src/vault/models/domain/passport.ts | 2 ++ libs/common/src/vault/models/domain/password.ts | 2 ++ libs/common/src/vault/models/domain/secure-note.ts | 2 ++ libs/common/src/vault/models/domain/ssh-key.ts | 2 ++ libs/common/src/vault/models/view/attachment.view.ts | 2 ++ libs/common/src/vault/models/view/bank-account.view.ts | 2 ++ libs/common/src/vault/models/view/card.view.ts | 2 ++ libs/common/src/vault/models/view/cipher.view.ts | 2 ++ libs/common/src/vault/models/view/drivers-license.view.ts | 2 ++ libs/common/src/vault/models/view/fido2-credential.view.ts | 2 ++ libs/common/src/vault/models/view/field.view.ts | 2 ++ libs/common/src/vault/models/view/identity.view.ts | 2 ++ libs/common/src/vault/models/view/login-uri.view.ts | 2 ++ libs/common/src/vault/models/view/login.view.ts | 2 ++ libs/common/src/vault/models/view/passport.view.ts | 2 ++ libs/common/src/vault/models/view/password-history.view.ts | 2 ++ libs/common/src/vault/models/view/secure-note.view.ts | 2 ++ libs/common/src/vault/models/view/ssh-key.view.ts | 2 ++ 29 files changed, 58 insertions(+) diff --git a/libs/common/src/vault/models/data/local.data.ts b/libs/common/src/vault/models/data/local.data.ts index 50a24feba6f..04f56119411 100644 --- a/libs/common/src/vault/models/data/local.data.ts +++ b/libs/common/src/vault/models/data/local.data.ts @@ -3,6 +3,8 @@ import { LocalData as SdkLocalData, } from "@bitwarden/sdk-internal"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/local_data.rs). +// Field changes here must also be made there, along with fromSdkLocalData/toSdkLocalData. export type LocalData = { lastUsedDate?: number; lastLaunched?: number; diff --git a/libs/common/src/vault/models/domain/attachment.ts b/libs/common/src/vault/models/domain/attachment.ts index 954cc48a70f..61a10a16ec4 100644 --- a/libs/common/src/vault/models/domain/attachment.ts +++ b/libs/common/src/vault/models/domain/attachment.ts @@ -10,6 +10,8 @@ import { conditionalEncString, encStringFrom } from "../../utils/domain-utils"; import { AttachmentData } from "../data/attachment.data"; import { AttachmentView } from "../view/attachment.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/attachment.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class Attachment extends Domain { id?: string; url?: string; diff --git a/libs/common/src/vault/models/domain/bank-account.ts b/libs/common/src/vault/models/domain/bank-account.ts index a32691fc646..2ba125ddd1a 100644 --- a/libs/common/src/vault/models/domain/bank-account.ts +++ b/libs/common/src/vault/models/domain/bank-account.ts @@ -9,6 +9,8 @@ import { conditionalEncString, encStringFrom } from "../../utils/domain-utils"; import { BankAccountData } from "../data/bank-account.data"; import { BankAccountView } from "../view/bank-account.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/bank_account.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class BankAccount extends Domain { bankName?: EncString; nameOnAccount?: EncString; diff --git a/libs/common/src/vault/models/domain/card.ts b/libs/common/src/vault/models/domain/card.ts index 4e8a78174fb..56ea08e0bc2 100644 --- a/libs/common/src/vault/models/domain/card.ts +++ b/libs/common/src/vault/models/domain/card.ts @@ -9,6 +9,8 @@ import { conditionalEncString, encStringFrom } from "../../utils/domain-utils"; import { CardData } from "../data/card.data"; import { CardView } from "../view/card.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/card.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class Card extends Domain { cardholderName?: EncString; brand?: EncString; diff --git a/libs/common/src/vault/models/domain/cipher.ts b/libs/common/src/vault/models/domain/cipher.ts index 50ae6bec867..23cfd1c8fba 100644 --- a/libs/common/src/vault/models/domain/cipher.ts +++ b/libs/common/src/vault/models/domain/cipher.ts @@ -35,6 +35,8 @@ import { Password } from "./password"; import { SecureNote } from "./secure-note"; import { SshKey } from "./ssh-key"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/cipher.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. /** * Encrypted cipher, as stored and synced. * diff --git a/libs/common/src/vault/models/domain/drivers-license.ts b/libs/common/src/vault/models/domain/drivers-license.ts index 54014593deb..8d3e6a49c01 100644 --- a/libs/common/src/vault/models/domain/drivers-license.ts +++ b/libs/common/src/vault/models/domain/drivers-license.ts @@ -9,6 +9,8 @@ import { conditionalEncString, encStringFrom } from "../../utils/domain-utils"; import { DriversLicenseData } from "../data/drivers-license.data"; import { DriversLicenseView } from "../view/drivers-license.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/drivers_license.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class DriversLicense extends Domain { firstName?: EncString; middleName?: EncString; diff --git a/libs/common/src/vault/models/domain/fido2-credential.ts b/libs/common/src/vault/models/domain/fido2-credential.ts index f3109947c91..6899c39e5cc 100644 --- a/libs/common/src/vault/models/domain/fido2-credential.ts +++ b/libs/common/src/vault/models/domain/fido2-credential.ts @@ -9,6 +9,8 @@ import { conditionalEncString, encStringFrom } from "../../utils/domain-utils"; import { Fido2CredentialData } from "../data/fido2-credential.data"; import { Fido2CredentialView } from "../view/fido2-credential.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/login.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class Fido2Credential extends Domain { credentialId!: EncString; keyType!: EncString; diff --git a/libs/common/src/vault/models/domain/field.ts b/libs/common/src/vault/models/domain/field.ts index 38f36627f5f..2c6b5791cb1 100644 --- a/libs/common/src/vault/models/domain/field.ts +++ b/libs/common/src/vault/models/domain/field.ts @@ -15,6 +15,8 @@ import { conditionalEncString, encStringFrom } from "../../utils/domain-utils"; import { FieldData } from "../data/field.data"; import { FieldView } from "../view/field.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/field.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class Field extends Domain { name?: EncString; value?: EncString; diff --git a/libs/common/src/vault/models/domain/identity.ts b/libs/common/src/vault/models/domain/identity.ts index 02137869333..ee087631b52 100644 --- a/libs/common/src/vault/models/domain/identity.ts +++ b/libs/common/src/vault/models/domain/identity.ts @@ -9,6 +9,8 @@ import { conditionalEncString, encStringFrom } from "../../utils/domain-utils"; import { IdentityData } from "../data/identity.data"; import { IdentityView } from "../view/identity.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/identity.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class Identity extends Domain { title?: EncString; firstName?: EncString; diff --git a/libs/common/src/vault/models/domain/login-uri.ts b/libs/common/src/vault/models/domain/login-uri.ts index 8d0f77ac928..da960709525 100644 --- a/libs/common/src/vault/models/domain/login-uri.ts +++ b/libs/common/src/vault/models/domain/login-uri.ts @@ -14,6 +14,8 @@ import { conditionalEncString, encStringFrom } from "../../utils/domain-utils"; import { LoginUriData } from "../data/login-uri.data"; import { LoginUriView } from "../view/login-uri.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/login.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class LoginUri extends Domain { uri?: EncString; uriChecksum?: EncString; diff --git a/libs/common/src/vault/models/domain/login.ts b/libs/common/src/vault/models/domain/login.ts index fad7aeb5e71..d20777e7bd5 100644 --- a/libs/common/src/vault/models/domain/login.ts +++ b/libs/common/src/vault/models/domain/login.ts @@ -12,6 +12,8 @@ import { LoginView } from "../view/login.view"; import { Fido2Credential } from "./fido2-credential"; import { LoginUri } from "./login-uri"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/login.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class Login extends Domain { uris?: LoginUri[]; username?: EncString; diff --git a/libs/common/src/vault/models/domain/passport.ts b/libs/common/src/vault/models/domain/passport.ts index 34e94ff9a14..7cd759858f8 100644 --- a/libs/common/src/vault/models/domain/passport.ts +++ b/libs/common/src/vault/models/domain/passport.ts @@ -9,6 +9,8 @@ import { conditionalEncString, encStringFrom } from "../../utils/domain-utils"; import { PassportData } from "../data/passport.data"; import { PassportView } from "../view/passport.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/passport.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class Passport extends Domain { surname?: EncString; givenName?: EncString; diff --git a/libs/common/src/vault/models/domain/password.ts b/libs/common/src/vault/models/domain/password.ts index 13bca9ca2de..f3dad0137df 100644 --- a/libs/common/src/vault/models/domain/password.ts +++ b/libs/common/src/vault/models/domain/password.ts @@ -8,6 +8,8 @@ import Domain from "../../../platform/models/domain/domain-base"; import { PasswordHistoryData } from "../data/password-history.data"; import { PasswordHistoryView } from "../view/password-history.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/password_history.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class Password extends Domain { password!: EncString; lastUsedDate!: Date; diff --git a/libs/common/src/vault/models/domain/secure-note.ts b/libs/common/src/vault/models/domain/secure-note.ts index 688d34830db..02d4b9c349b 100644 --- a/libs/common/src/vault/models/domain/secure-note.ts +++ b/libs/common/src/vault/models/domain/secure-note.ts @@ -7,6 +7,8 @@ import { normalizeSecureNoteTypeForSdk, SecureNoteType } from "../../enums"; import { SecureNoteData } from "../data/secure-note.data"; import { SecureNoteView } from "../view/secure-note.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/secure_note.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class SecureNote extends Domain { type: SecureNoteType = SecureNoteType.Generic; diff --git a/libs/common/src/vault/models/domain/ssh-key.ts b/libs/common/src/vault/models/domain/ssh-key.ts index 55685799c56..dd71a67d9e7 100644 --- a/libs/common/src/vault/models/domain/ssh-key.ts +++ b/libs/common/src/vault/models/domain/ssh-key.ts @@ -8,6 +8,8 @@ import Domain from "../../../platform/models/domain/domain-base"; import { SshKeyData } from "../data/ssh-key.data"; import { SshKeyView } from "../view/ssh-key.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/ssh_key.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class SshKey extends Domain { privateKey!: EncString; /** Derivable from the private key, so may be absent at rest. */ diff --git a/libs/common/src/vault/models/view/attachment.view.ts b/libs/common/src/vault/models/view/attachment.view.ts index 68dbd627d03..6f5a3ca38a8 100644 --- a/libs/common/src/vault/models/view/attachment.view.ts +++ b/libs/common/src/vault/models/view/attachment.view.ts @@ -7,6 +7,8 @@ import { AttachmentView as SdkAttachmentView } from "@bitwarden/sdk-internal"; import { View } from "../../../models/view/view"; import { Attachment } from "../domain/attachment"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/attachment.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class AttachmentView implements View { id?: string; url?: string; diff --git a/libs/common/src/vault/models/view/bank-account.view.ts b/libs/common/src/vault/models/view/bank-account.view.ts index ba63dcf26e3..efbf29d5f2f 100644 --- a/libs/common/src/vault/models/view/bank-account.view.ts +++ b/libs/common/src/vault/models/view/bank-account.view.ts @@ -4,6 +4,8 @@ import { BankAccountView as SdkBankAccountView } from "@bitwarden/sdk-internal"; import { ItemView } from "./item.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/bank_account.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class BankAccountView extends ItemView implements SdkBankAccountView { bankName: string | undefined; nameOnAccount: string | undefined; diff --git a/libs/common/src/vault/models/view/card.view.ts b/libs/common/src/vault/models/view/card.view.ts index 9b78ad384c6..2e89696f521 100644 --- a/libs/common/src/vault/models/view/card.view.ts +++ b/libs/common/src/vault/models/view/card.view.ts @@ -8,6 +8,8 @@ import { linkedFieldOption } from "../../linked-field-option.decorator"; import { ItemView } from "./item.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/card.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class CardView extends ItemView implements SdkCardView { @linkedFieldOption(LinkedId.CardholderName, { sortPosition: 0 }) cardholderName: string | undefined; diff --git a/libs/common/src/vault/models/view/cipher.view.ts b/libs/common/src/vault/models/view/cipher.view.ts index 88f4dfaaf55..c3664a95bc6 100644 --- a/libs/common/src/vault/models/view/cipher.view.ts +++ b/libs/common/src/vault/models/view/cipher.view.ts @@ -32,6 +32,8 @@ import { PasswordHistoryView } from "./password-history.view"; import { SecureNoteView } from "./secure-note.view"; import { SshKeyView } from "./ssh-key.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/cipher.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class CipherView implements View, InitializerMetadata { readonly initializerKey = InitializerKey.CipherView; diff --git a/libs/common/src/vault/models/view/drivers-license.view.ts b/libs/common/src/vault/models/view/drivers-license.view.ts index 0b6ef0e6996..6ed8905945e 100644 --- a/libs/common/src/vault/models/view/drivers-license.view.ts +++ b/libs/common/src/vault/models/view/drivers-license.view.ts @@ -4,6 +4,8 @@ import { DriversLicenseView as SdkDriversLicenseView } from "@bitwarden/sdk-inte import { ItemView } from "./item.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/drivers_license.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class DriversLicenseView extends ItemView implements SdkDriversLicenseView { firstName: string | undefined; middleName: string | undefined; diff --git a/libs/common/src/vault/models/view/fido2-credential.view.ts b/libs/common/src/vault/models/view/fido2-credential.view.ts index 19e7f5d7e3c..0ea06f4dd54 100644 --- a/libs/common/src/vault/models/view/fido2-credential.view.ts +++ b/libs/common/src/vault/models/view/fido2-credential.view.ts @@ -7,6 +7,8 @@ import { import { ItemView } from "./item.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/login.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class Fido2CredentialView extends ItemView { credentialId!: string; keyType!: "public-key"; diff --git a/libs/common/src/vault/models/view/field.view.ts b/libs/common/src/vault/models/view/field.view.ts index 9f34420a86c..4104af3a981 100644 --- a/libs/common/src/vault/models/view/field.view.ts +++ b/libs/common/src/vault/models/view/field.view.ts @@ -6,6 +6,8 @@ import { View } from "../../../models/view/view"; import { FieldType, LinkedIdType } from "../../enums"; import { Field } from "../domain/field"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/field.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class FieldView implements View { name?: string; value?: string; diff --git a/libs/common/src/vault/models/view/identity.view.ts b/libs/common/src/vault/models/view/identity.view.ts index 92ab671b403..fdaa9cea785 100644 --- a/libs/common/src/vault/models/view/identity.view.ts +++ b/libs/common/src/vault/models/view/identity.view.ts @@ -8,6 +8,8 @@ import { linkedFieldOption } from "../../linked-field-option.decorator"; import { ItemView } from "./item.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/identity.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class IdentityView extends ItemView implements SdkIdentityView { @linkedFieldOption(LinkedId.Title, { sortPosition: 0 }) title: string | undefined; diff --git a/libs/common/src/vault/models/view/login-uri.view.ts b/libs/common/src/vault/models/view/login-uri.view.ts index 80ce77cc42f..bf9071b6682 100644 --- a/libs/common/src/vault/models/view/login-uri.view.ts +++ b/libs/common/src/vault/models/view/login-uri.view.ts @@ -9,6 +9,8 @@ import { SafeUrls, UrlType } from "../../../platform/misc/safe-urls"; import { Utils } from "../../../platform/misc/utils"; import { LoginUri } from "../domain/login-uri"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/login.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class LoginUriView implements View { match?: UriMatchStrategySetting; diff --git a/libs/common/src/vault/models/view/login.view.ts b/libs/common/src/vault/models/view/login.view.ts index 4a957b6405b..8b336a6946a 100644 --- a/libs/common/src/vault/models/view/login.view.ts +++ b/libs/common/src/vault/models/view/login.view.ts @@ -11,6 +11,8 @@ import { Fido2CredentialView } from "./fido2-credential.view"; import { ItemView } from "./item.view"; import { LoginUriView } from "./login-uri.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/login.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class LoginView extends ItemView { @linkedFieldOption(LinkedId.Username, { sortPosition: 0 }) username: string | undefined; diff --git a/libs/common/src/vault/models/view/passport.view.ts b/libs/common/src/vault/models/view/passport.view.ts index 31ef739168f..c779157f6bd 100644 --- a/libs/common/src/vault/models/view/passport.view.ts +++ b/libs/common/src/vault/models/view/passport.view.ts @@ -4,6 +4,8 @@ import { PassportView as SdkPassportView } from "@bitwarden/sdk-internal"; import { ItemView } from "./item.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/passport.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class PassportView extends ItemView implements SdkPassportView { surname: string | undefined; givenName: string | undefined; diff --git a/libs/common/src/vault/models/view/password-history.view.ts b/libs/common/src/vault/models/view/password-history.view.ts index 9bd708b19fd..9ba110586bb 100644 --- a/libs/common/src/vault/models/view/password-history.view.ts +++ b/libs/common/src/vault/models/view/password-history.view.ts @@ -7,6 +7,8 @@ import { PasswordHistoryView as SdkPasswordHistoryView } from "@bitwarden/sdk-in import { View } from "../../../models/view/view"; import { Password } from "../domain/password"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/password_history.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class PasswordHistoryView implements View { password: string = null; lastUsedDate: Date = null; diff --git a/libs/common/src/vault/models/view/secure-note.view.ts b/libs/common/src/vault/models/view/secure-note.view.ts index 85c0d3fd61c..f921fb7e2dc 100644 --- a/libs/common/src/vault/models/view/secure-note.view.ts +++ b/libs/common/src/vault/models/view/secure-note.view.ts @@ -7,6 +7,8 @@ import { SecureNote } from "../domain/secure-note"; import { ItemView } from "./item.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/secure_note.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class SecureNoteView extends ItemView implements SdkSecureNoteView { type: SecureNoteType = SecureNoteType.Generic; diff --git a/libs/common/src/vault/models/view/ssh-key.view.ts b/libs/common/src/vault/models/view/ssh-key.view.ts index c3e0349548b..a398c1e9260 100644 --- a/libs/common/src/vault/models/view/ssh-key.view.ts +++ b/libs/common/src/vault/models/view/ssh-key.view.ts @@ -4,6 +4,8 @@ import { SshKeyView as SdkSshKeyView } from "@bitwarden/sdk-internal"; import { ItemView } from "./item.view"; +// Mirrored in the SDK (bitwarden/sdk-internal: crates/bitwarden-vault/src/cipher/ssh_key.rs). +// Field changes here must also be made there, along with the toSdk/fromSdk mappings. export class SshKeyView extends ItemView { privateKey!: string; publicKey!: string;