bitwarden_pm/
migrations.rs

1//! Manages repository migrations for the Bitwarden SDK.
2
3use bitwarden_core::{
4    client::persisted_state::OrganizationSharedKey, key_management::UserKeyState,
5};
6use bitwarden_send::Send;
7use bitwarden_state::{
8    SettingItem,
9    repository::{RepositoryItem, RepositoryMigrationStep, RepositoryMigrations},
10};
11use bitwarden_vault::{Cipher, Folder};
12
13/// Returns a list of all SDK-managed repository migrations.
14pub fn get_sdk_managed_migrations() -> RepositoryMigrations {
15    use RepositoryMigrationStep::*;
16    RepositoryMigrations::new(vec![
17        // Add any new migrations here. Note that order matters, and that removing a repository
18        // requires a separate migration step using `Remove(...)`.
19        Add(Cipher::data()),
20        Add(Folder::data()),
21        Add(UserKeyState::data()),
22        Add(SettingItem::data()),
23        Add(OrganizationSharedKey::data()),
24        Add(Send::data()),
25    ])
26}
27
28/// Macro to create the client managed repositories for the SDK.
29/// To add a new repository, add it to the list in the macro invocation.
30/// This is meant to be used by the final application crates (e.g., bitwarden-uniffi,
31/// bitwarden-wasm-internal, bw).
32#[macro_export]
33macro_rules! create_client_managed_repositories {
34    ($container_name:ident, $macro:ident) => {
35        $macro! {
36            $container_name;
37            // List any SDK-managed repositories here. The format is:
38            // <fully qualified path to the item>, <item type idenfier>, <field name>, <name of the repository implementation>
39            ::bitwarden_vault::Cipher, Cipher, cipher, CipherRepository;
40            ::bitwarden_vault::Folder, Folder, folder, FolderRepository;
41            ::bitwarden_core::key_management::UserKeyState, UserKeyState, user_key_state, UserKeyStateRepository;
42            ::bitwarden_core::key_management::LocalUserDataKeyState, LocalUserDataKeyState, local_user_data_key_state, LocalUserDataKeyStateRepository;
43            ::bitwarden_core::key_management::EphemeralPinEnvelopeState, EphemeralPinEnvelopeState, ephemeral_pin_envelope_state, EphemeralPinEnvelopeStateRepository;
44            ::bitwarden_core::client::persisted_state::OrganizationSharedKey, OrganizationSharedKey, organization_shared_key, OrganizationSharedKeyRepository;
45            ::bitwarden_send::Send, Send, send, SendRepository;
46        }
47    };
48}
bitwarden_pm/migrations.rs

bitwarden_pm/
migrations.rs
