@bitwarden/sdk-internal 0.2.0-main.513 → 0.2.0-main.514

package/bitwarden_wasm_internal.d.ts

@@ -1,16 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-/**
- * Generate a new SSH key pair
- *
- * # Arguments
- * - `key_algorithm` - The algorithm to use for the key pair
- *
- * # Returns
- * - `Ok(SshKey)` if the key was successfully generated
- * - `Err(KeyGenerationError)` if the key could not be generated
- */
-export function generate_ssh_key(key_algorithm: KeyAlgorithm): SshKeyView;
 /**
  * Convert a PCKS8 or OpenSSH encrypted or unencrypted private key
  * to an OpenSSH private key with public key and fingerprint
@@ -27,6 +16,17 @@ export function generate_ssh_key(key_algorithm: KeyAlgorithm): SshKeyView;
  * - `Err(UnsupportedKeyType)` if the key type is not supported
  */
 export function import_ssh_key(imported_key: string, password?: string | null): SshKeyView;
+/**
+ * Generate a new SSH key pair
+ *
+ * # Arguments
+ * - `key_algorithm` - The algorithm to use for the key pair
+ *
+ * # Returns
+ * - `Ok(SshKey)` if the key was successfully generated
+ * - `Err(KeyGenerationError)` if the key could not be generated
+ */
+export function generate_ssh_key(key_algorithm: KeyAlgorithm): SshKeyView;
 export function init_sdk(log_level?: LogLevel | null): void;
 /**
  * Registers a DiscoverHandler so that the client can respond to DiscoverRequests.
@@ -180,32 +180,42 @@ export interface TokenProvider {
   get_access_token(): Promise<string | undefined>;
 }
 
+export interface IndexedDbConfiguration {
+  db_name: string;
+}
+
 export interface Repositories {
   cipher: Repository<Cipher> | null;
   folder: Repository<Folder> | null;
 }
 
-export interface IndexedDbConfiguration {
-  db_name: string;
-}
-
 /**
  * Active feature flags for the SDK.
  */
 export interface FeatureFlags extends Map<string, boolean> {}
 
 /**
- * Credentials for sending password secured access requests.
- * Clone auto implements the standard lib\'s Clone trait, allowing us to create copies of this
- * struct.
+ * Credentials for getting a send access token using an email and OTP.
  */
-export interface SendPasswordCredentials {
+export interface SendEmailOtpCredentials {
   /**
-   * A Base64-encoded hash of the password protecting the send.
+   * The email address to which the OTP will be sent.
    */
-  passwordHashB64: string;
+  email: string;
+  /**
+   * The one-time password (OTP) that the user has received via email.
+   */
+  otp: string;
 }
 
+/**
+ * The credentials used for send access requests.
+ */
+export type SendAccessCredentials =
+  | SendPasswordCredentials
+  | SendEmailOtpCredentials
+  | SendEmailCredentials;
+
 /**
  * A request structure for requesting a send access token from the API.
  */
@@ -221,36 +231,26 @@ export interface SendAccessTokenRequest {
 }
 
 /**
- * The credentials used for send access requests.
- */
-export type SendAccessCredentials =
-  | SendPasswordCredentials
-  | SendEmailOtpCredentials
-  | SendEmailCredentials;
-
-/**
- * Credentials for sending an OTP to the user\'s email address.
- * This is used when the send requires email verification with an OTP.
+ * Credentials for sending password secured access requests.
+ * Clone auto implements the standard lib\'s Clone trait, allowing us to create copies of this
+ * struct.
  */
-export interface SendEmailCredentials {
+export interface SendPasswordCredentials {
   /**
-   * The email address to which the OTP will be sent.
+   * A Base64-encoded hash of the password protecting the send.
    */
-  email: string;
+  passwordHashB64: string;
 }
 
 /**
- * Credentials for getting a send access token using an email and OTP.
+ * Credentials for sending an OTP to the user\'s email address.
+ * This is used when the send requires email verification with an OTP.
  */
-export interface SendEmailOtpCredentials {
+export interface SendEmailCredentials {
   /**
    * The email address to which the OTP will be sent.
    */
   email: string;
-  /**
-   * The one-time password (OTP) that the user has received via email.
-   */
-  otp: string;
 }
 
 /**
@@ -263,6 +263,14 @@ export interface SendEmailOtpCredentials {
  */
 export type UnexpectedIdentityError = string;
 
+/**
+ * Represents errors that can occur when requesting a send access token.
+ * It includes expected and unexpected API errors.
+ */
+export type SendAccessTokenError =
+  | { kind: "unexpected"; data: UnexpectedIdentityError }
+  | { kind: "expected"; data: SendAccessTokenApiErrorResponse };
+
 /**
  * A send access token which can be used to access a send.
  */
@@ -278,12 +286,14 @@ export interface SendAccessTokenResponse {
 }
 
 /**
- * Represents errors that can occur when requesting a send access token.
- * It includes expected and unexpected API errors.
+ * Invalid grant errors - typically due to invalid credentials.
  */
-export type SendAccessTokenError =
-  | { kind: "unexpected"; data: UnexpectedIdentityError }
-  | { kind: "expected"; data: SendAccessTokenApiErrorResponse };
+export type SendAccessTokenInvalidGrantError =
+  | "send_id_invalid"
+  | "password_hash_b64_invalid"
+  | "otp_invalid"
+  | "otp_generation_failed"
+  | "unknown";
 
 /**
  * Represents the possible, expected errors that can occur when requesting a send access token.
@@ -305,16 +315,6 @@ export type SendAccessTokenApiErrorResponse =
   | { error: "invalid_scope"; error_description?: string }
   | { error: "invalid_target"; error_description?: string };
 
-/**
- * Invalid grant errors - typically due to invalid credentials.
- */
-export type SendAccessTokenInvalidGrantError =
-  | "send_id_invalid"
-  | "password_hash_b64_invalid"
-  | "otp_invalid"
-  | "otp_generation_failed"
-  | "unknown";
-
 /**
  * Invalid request errors - typically due to missing parameters.
  */
@@ -325,13 +325,28 @@ export type SendAccessTokenInvalidRequestError =
   | "email_and_otp_required"
   | "unknown";
 
-export interface RegistrationError extends Error {
-  name: "RegistrationError";
-  variant: "KeyConnectorApi" | "Api" | "Crypto";
+/**
+ * Result of Key Connector registration process.
+ */
+export interface KeyConnectorRegistrationResult {
+  /**
+   * The account cryptographic state of the user.
+   */
+  account_cryptographic_state: WrappedAccountCryptographicState;
+  /**
+   * The key connector key used for unlocking.
+   */
+  key_connector_key: B64;
+  /**
+   * The encrypted user key, wrapped with the key connector key.
+   */
+  key_connector_key_wrapped_user_key: EncString;
+  /**
+   * The decrypted user key. This can be used to get the consuming client to an unlocked state.
+   */
+  user_key: B64;
 }
 
-export function isRegistrationError(error: any): error is RegistrationError;
-
 /**
  * Request parameters for SSO JIT master password registration.
  */
@@ -371,33 +386,6 @@ export interface JitMasterPasswordRegistrationRequest {
   reset_password_enroll: boolean;
 }
 
-/**
- * Request parameters for TDE (Trusted Device Encryption) registration.
- */
-export interface TdeRegistrationRequest {
-  /**
-   * Organization ID to enroll in
-   */
-  org_id: OrganizationId;
-  /**
-   * Organization\'s public key for encrypting the reset password key. This should be verified by
-   * the client and not verifying may compromise the security of the user\'s account.
-   */
-  org_public_key: B64;
-  /**
-   * User ID for the account being initialized
-   */
-  user_id: UserId;
-  /**
-   * Device identifier for TDE enrollment
-   */
-  device_identifier: string;
-  /**
-   * Whether to trust this device for TDE
-   */
-  trust_device: boolean;
-}
-
 /**
  * Result of TDE registration process.
  */
@@ -416,26 +404,38 @@ export interface TdeRegistrationResponse {
   user_key: B64;
 }
 
+export interface RegistrationError extends Error {
+  name: "RegistrationError";
+  variant: "KeyConnectorApi" | "Api" | "Crypto";
+}
+
+export function isRegistrationError(error: any): error is RegistrationError;
+
 /**
- * Result of Key Connector registration process.
+ * Request parameters for TDE (Trusted Device Encryption) registration.
  */
-export interface KeyConnectorRegistrationResult {
+export interface TdeRegistrationRequest {
   /**
-   * The account cryptographic state of the user.
+   * Organization ID to enroll in
    */
-  account_cryptographic_state: WrappedAccountCryptographicState;
+  org_id: OrganizationId;
   /**
-   * The key connector key used for unlocking.
+   * Organization\'s public key for encrypting the reset password key. This should be verified by
+   * the client and not verifying may compromise the security of the user\'s account.
    */
-  key_connector_key: B64;
+  org_public_key: B64;
   /**
-   * The encrypted user key, wrapped with the key connector key.
+   * User ID for the account being initialized
    */
-  key_connector_key_wrapped_user_key: EncString;
+  user_id: UserId;
   /**
-   * The decrypted user key. This can be used to get the consuming client to an unlocked state.
+   * Device identifier for TDE enrollment
    */
-  user_key: B64;
+  device_identifier: string;
+  /**
+   * Whether to trust this device for TDE
+   */
+  trust_device: boolean;
 }
 
 /**
@@ -456,6 +456,11 @@ export interface JitMasterPasswordRegistrationResponse {
   user_key: B64;
 }
 
+/**
+ * NewType wrapper for `CollectionId`
+ */
+export type CollectionId = Tagged<Uuid, "CollectionId">;
+
 export interface CollectionView {
   id: CollectionId | undefined;
   organizationId: OrganizationId;
@@ -484,11 +489,6 @@ export interface Collection {
   type: CollectionType;
 }
 
-/**
- * NewType wrapper for `CollectionId`
- */
-export type CollectionId = Tagged<Uuid, "CollectionId">;
-
 export interface CollectionDecryptError extends Error {
   name: "CollectionDecryptError";
   variant: "Crypto";
@@ -538,21 +538,6 @@ export interface MasterPasswordAuthenticationData {
   masterPasswordAuthenticationHash: B64;
 }
 
-export interface AccountCryptographyInitializationError extends Error {
-  name: "AccountCryptographyInitializationError";
-  variant:
-    | "WrongUserKeyType"
-    | "WrongUserKey"
-    | "CorruptData"
-    | "TamperedData"
-    | "KeyStoreAlreadyInitialized"
-    | "GenericCrypto";
-}
-
-export function isAccountCryptographyInitializationError(
-  error: any,
-): error is AccountCryptographyInitializationError;
-
 /**
  * Any keys / cryptographic protection \"downstream\" from the account symmetric key (user key).
  * Private keys are protected by the user key.
@@ -575,107 +560,23 @@ export interface RotateCryptographyStateError extends Error {
 
 export function isRotateCryptographyStateError(error: any): error is RotateCryptographyStateError;
 
-/**
- * Represents the request to initialize the user\'s organizational cryptographic state.
- */
-export interface InitOrgCryptoRequest {
-  /**
-   * The encryption keys for all the organizations the user is a part of
-   */
-  organizationKeys: Map<OrganizationId, UnsignedSharedKey>;
-}
-
-export interface MakeKeysError extends Error {
-  name: "MakeKeysError";
+export interface AccountCryptographyInitializationError extends Error {
+  name: "AccountCryptographyInitializationError";
   variant:
-    | "AccountCryptographyInitialization"
-    | "MasterPasswordDerivation"
-    | "RequestModelCreation"
-    | "Crypto";
+    | "WrongUserKeyType"
+    | "WrongUserKey"
+    | "CorruptData"
+    | "TamperedData"
+    | "KeyStoreAlreadyInitialized"
+    | "GenericCrypto";
 }
 
-export function isMakeKeysError(error: any): error is MakeKeysError;
+export function isAccountCryptographyInitializationError(
+  error: any,
+): error is AccountCryptographyInitializationError;
 
 /**
- * The crypto method used to initialize the user cryptographic state.
- */
-export type InitUserCryptoMethod =
-  | { masterPasswordUnlock: { password: string; master_password_unlock: MasterPasswordUnlockData } }
-  | { decryptedKey: { decrypted_user_key: string } }
-  | { pin: { pin: string; pin_protected_user_key: EncString } }
-  | { pinEnvelope: { pin: string; pin_protected_user_key_envelope: PasswordProtectedKeyEnvelope } }
-  | { authRequest: { request_private_key: B64; method: AuthRequestMethod } }
-  | {
-      deviceKey: {
-        device_key: string;
-        protected_device_private_key: EncString;
-        device_protected_user_key: UnsignedSharedKey;
-      };
-    }
-  | { keyConnector: { master_key: B64; user_key: EncString } };
-
-/**
- * Request for deriving a pin protected user key
- */
-export interface EnrollPinResponse {
-  /**
-   * [UserKey] protected by PIN
-   */
-  pinProtectedUserKeyEnvelope: PasswordProtectedKeyEnvelope;
-  /**
-   * PIN protected by [UserKey]
-   */
-  userKeyEncryptedPin: EncString;
-}
-
-/**
- * Request for deriving a pin protected user key
- */
-export interface DerivePinKeyResponse {
-  /**
-   * [UserKey] protected by PIN
-   */
-  pinProtectedUserKey: EncString;
-  /**
-   * PIN protected by [UserKey]
-   */
-  encryptedPin: EncString;
-}
-
-/**
- * Request for `verify_asymmetric_keys`.
- */
-export interface VerifyAsymmetricKeysRequest {
-  /**
-   * The user\'s user key
-   */
-  userKey: B64;
-  /**
-   * The user\'s public key
-   */
-  userPublicKey: B64;
-  /**
-   * User\'s private key, encrypted with the user key
-   */
-  userKeyEncryptedPrivateKey: EncString;
-}
-
-/**
- * Response for `verify_asymmetric_keys`.
- */
-export interface VerifyAsymmetricKeysResponse {
-  /**
-   * Whether the user\'s private key was decryptable by the user key.
-   */
-  privateKeyDecryptable: boolean;
-  /**
-   * Whether the user\'s private key was a valid RSA key and matched the public key provided.
-   */
-  validPrivateKey: boolean;
-}
-
-/**
- * Response for the `make_keys_for_user_crypto_v2`, containing a set of keys for a user
+ * Response for the `make_keys_for_user_crypto_v2`, containing a set of keys for a user
  */
 export interface UserCryptoV2KeysResponse {
   /**
@@ -719,59 +620,66 @@ export interface EnrollAdminPasswordResetError extends Error {
 
 export function isEnrollAdminPasswordResetError(error: any): error is EnrollAdminPasswordResetError;
 
-export interface CryptoClientError extends Error {
-  name: "CryptoClientError";
-  variant:
-    | "NotAuthenticated"
-    | "Crypto"
-    | "InvalidKdfSettings"
-    | "PasswordProtectedKeyEnvelope"
-    | "InvalidPrfInput";
-}
-
-export function isCryptoClientError(error: any): error is CryptoClientError;
-
 /**
- * Request for migrating an account from password to key connector.
+ * Response from the `update_kdf` function
  */
-export interface DeriveKeyConnectorRequest {
+export interface UpdateKdfResponse {
   /**
-   * Encrypted user key, used to validate the master key
+   * The authentication data for the new KDF setting
    */
-  userKeyEncrypted: EncString;
+  masterPasswordAuthenticationData: MasterPasswordAuthenticationData;
   /**
-   * The user\'s master password
+   * The unlock data for the new KDF setting
    */
-  password: string;
+  masterPasswordUnlockData: MasterPasswordUnlockData;
   /**
-   * The KDF parameters used to derive the master key
+   * The authentication data for the KDF setting prior to the change
    */
-  kdf: Kdf;
+  oldMasterPasswordAuthenticationData: MasterPasswordAuthenticationData;
+}
+
+/**
+ * Request for deriving a pin protected user key
+ */
+export interface DerivePinKeyResponse {
   /**
-   * The user\'s email address
+   * [UserKey] protected by PIN
    */
-  email: string;
+  pinProtectedUserKey: EncString;
+  /**
+   * PIN protected by [UserKey]
+   */
+  encryptedPin: EncString;
 }
 
-export interface DeriveKeyConnectorError extends Error {
-  name: "DeriveKeyConnectorError";
-  variant: "WrongPassword" | "Crypto";
+export interface CryptoClientError extends Error {
+  name: "CryptoClientError";
+  variant:
+    | "NotAuthenticated"
+    | "Crypto"
+    | "InvalidKdfSettings"
+    | "PasswordProtectedKeyEnvelope"
+    | "InvalidPrfInput";
 }
 
-export function isDeriveKeyConnectorError(error: any): error is DeriveKeyConnectorError;
+export function isCryptoClientError(error: any): error is CryptoClientError;
 
 /**
- * Response from the `make_update_password` function
+ * Request for `verify_asymmetric_keys`.
  */
-export interface UpdatePasswordResponse {
+export interface VerifyAsymmetricKeysRequest {
   /**
-   * Hash of the new password
+   * The user\'s user key
    */
-  passwordHash: B64;
+  userKey: B64;
   /**
-   * User key, encrypted with the new password
+   * The user\'s public key
    */
-  newKey: EncString;
+  userPublicKey: B64;
+  /**
+   * User\'s private key, encrypted with the user key
+   */
+  userKeyEncryptedPrivateKey: EncString;
 }
 
 /**
@@ -788,6 +696,52 @@ export interface MakeKeyPairResponse {
   userKeyEncryptedPrivateKey: EncString;
 }
 
+/**
+ * Represents the request to initialize the user\'s organizational cryptographic state.
+ */
+export interface InitOrgCryptoRequest {
+  /**
+   * The encryption keys for all the organizations the user is a part of
+   */
+  organizationKeys: Map<OrganizationId, UnsignedSharedKey>;
+}
+
+/**
+ * Auth requests supports multiple initialization methods.
+ */
+export type AuthRequestMethod =
+  | { userKey: { protected_user_key: UnsignedSharedKey } }
+  | { masterKey: { protected_master_key: UnsignedSharedKey; auth_request_key: EncString } };
+
+/**
+ * The crypto method used to initialize the user cryptographic state.
+ */
+export type InitUserCryptoMethod =
+  | { masterPasswordUnlock: { password: string; master_password_unlock: MasterPasswordUnlockData } }
+  | { decryptedKey: { decrypted_user_key: string } }
+  | { pin: { pin: string; pin_protected_user_key: EncString } }
+  | { pinEnvelope: { pin: string; pin_protected_user_key_envelope: PasswordProtectedKeyEnvelope } }
+  | { authRequest: { request_private_key: B64; method: AuthRequestMethod } }
+  | {
+      deviceKey: {
+        device_key: string;
+        protected_device_private_key: EncString;
+        device_protected_user_key: UnsignedSharedKey;
+      };
+    }
+  | { keyConnector: { master_key: B64; user_key: EncString } };
+
+export interface MakeKeysError extends Error {
+  name: "MakeKeysError";
+  variant:
+    | "AccountCryptographyInitialization"
+    | "MasterPasswordDerivation"
+    | "RequestModelCreation"
+    | "Crypto";
+}
+
+export function isMakeKeysError(error: any): error is MakeKeysError;
+
 /**
  * State used for initializing the user cryptographic state.
  */
@@ -816,29 +770,75 @@ export interface InitUserCryptoRequest {
 }
 
 /**
- * Response from the `update_kdf` function
+ * Request for migrating an account from password to key connector.
  */
-export interface UpdateKdfResponse {
+export interface DeriveKeyConnectorRequest {
   /**
-   * The authentication data for the new KDF setting
+   * Encrypted user key, used to validate the master key
    */
-  masterPasswordAuthenticationData: MasterPasswordAuthenticationData;
+  userKeyEncrypted: EncString;
   /**
-   * The unlock data for the new KDF setting
+   * The user\'s master password
    */
-  masterPasswordUnlockData: MasterPasswordUnlockData;
+  password: string;
   /**
-   * The authentication data for the KDF setting prior to the change
+   * The KDF parameters used to derive the master key
    */
-  oldMasterPasswordAuthenticationData: MasterPasswordAuthenticationData;
+  kdf: Kdf;
+  /**
+   * The user\'s email address
+   */
+  email: string;
 }
 
 /**
- * Auth requests supports multiple initialization methods.
+ * Request for deriving a pin protected user key
  */
-export type AuthRequestMethod =
-  | { userKey: { protected_user_key: UnsignedSharedKey } }
-  | { masterKey: { protected_master_key: UnsignedSharedKey; auth_request_key: EncString } };
+export interface EnrollPinResponse {
+  /**
+   * [UserKey] protected by PIN
+   */
+  pinProtectedUserKeyEnvelope: PasswordProtectedKeyEnvelope;
+  /**
+   * PIN protected by [UserKey]
+   */
+  userKeyEncryptedPin: EncString;
+}
+
+/**
+ * Response from the `make_update_password` function
+ */
+export interface UpdatePasswordResponse {
+  /**
+   * Hash of the new password
+   */
+  passwordHash: B64;
+  /**
+   * User key, encrypted with the new password
+   */
+  newKey: EncString;
+}
+
+/**
+ * Response for `verify_asymmetric_keys`.
+ */
+export interface VerifyAsymmetricKeysResponse {
+  /**
+   * Whether the user\'s private key was decryptable by the user key.
+   */
+  privateKeyDecryptable: boolean;
+  /**
+   * Whether the user\'s private key was a valid RSA key and matched the public key provided.
+   */
+  validPrivateKey: boolean;
+}
+
+export interface DeriveKeyConnectorError extends Error {
+  name: "DeriveKeyConnectorError";
+  variant: "WrongPassword" | "Crypto";
+}
+
+export function isDeriveKeyConnectorError(error: any): error is DeriveKeyConnectorError;
 
 /**
  * NewType wrapper for `OrganizationId`
@@ -857,35 +857,6 @@ export interface StatefulCryptoError extends Error {
 
 export function isStatefulCryptoError(error: any): error is StatefulCryptoError;
 
-export type DeviceType =
-  | "Android"
-  | "iOS"
-  | "ChromeExtension"
-  | "FirefoxExtension"
-  | "OperaExtension"
-  | "EdgeExtension"
-  | "WindowsDesktop"
-  | "MacOsDesktop"
-  | "LinuxDesktop"
-  | "ChromeBrowser"
-  | "FirefoxBrowser"
-  | "OperaBrowser"
-  | "EdgeBrowser"
-  | "IEBrowser"
-  | "UnknownBrowser"
-  | "AndroidAmazon"
-  | "UWP"
-  | "SafariBrowser"
-  | "VivaldiBrowser"
-  | "VivaldiExtension"
-  | "SafariExtension"
-  | "SDK"
-  | "Server"
-  | "WindowsCLI"
-  | "MacOsCLI"
-  | "LinuxCLI"
-  | "DuckDuckGoBrowser";
-
 /**
  * Basic client behavior settings. These settings specify the various targets and behavior of the
  * Bitwarden Client. They are optional and uneditable once the client is initialized.
@@ -938,6 +909,35 @@ export interface ClientSettings {
   bitwardenPackageType?: string | undefined;
 }
 
+export type DeviceType =
+  | "Android"
+  | "iOS"
+  | "ChromeExtension"
+  | "FirefoxExtension"
+  | "OperaExtension"
+  | "EdgeExtension"
+  | "WindowsDesktop"
+  | "MacOsDesktop"
+  | "LinuxDesktop"
+  | "ChromeBrowser"
+  | "FirefoxBrowser"
+  | "OperaBrowser"
+  | "EdgeBrowser"
+  | "IEBrowser"
+  | "UnknownBrowser"
+  | "AndroidAmazon"
+  | "UWP"
+  | "SafariBrowser"
+  | "VivaldiBrowser"
+  | "VivaldiExtension"
+  | "SafariExtension"
+  | "SDK"
+  | "Server"
+  | "WindowsCLI"
+  | "MacOsCLI"
+  | "LinuxCLI"
+  | "DuckDuckGoBrowser";
+
 export interface EncryptionSettingsError extends Error {
   name: "EncryptionSettingsError";
   variant:
@@ -1089,8 +1089,6 @@ export interface ExportError extends Error {
 
 export function isExportError(error: any): error is ExportError;
 
-export type PassphraseError = { InvalidNumWords: { minimum: number; maximum: number } };
-
 /**
  * Passphrase generator request options.
  */
@@ -1115,6 +1113,8 @@ export interface PassphraseGeneratorRequest {
   includeNumber: boolean;
 }
 
+export type PassphraseError = { InvalidNumWords: { minimum: number; maximum: number } };
+
 /**
  * Password generator request options.
  */
@@ -1180,15 +1180,6 @@ export type UsernameGeneratorRequest =
   | { catchall: { type: AppendType; domain: string } }
   | { forwarded: { service: ForwarderServiceType; website: string | undefined } };
 
-export type AppendType = "random" | { websiteName: { website: string } };
-
-export interface UsernameError extends Error {
-  name: "UsernameError";
-  variant: "InvalidApiKey" | "Unknown" | "ResponseContent" | "Reqwest";
-}
-
-export function isUsernameError(error: any): error is UsernameError;
-
 /**
  * Configures the email forwarding service to use.
  * For instructions on how to configure each service, see the documentation:
@@ -1202,6 +1193,15 @@ export type ForwarderServiceType =
   | { forwardEmail: { api_token: string; domain: string } }
   | { simpleLogin: { api_key: string; base_url: string } };
 
+export type AppendType = "random" | { websiteName: { website: string } };
+
+export interface UsernameError extends Error {
+  name: "UsernameError";
+  variant: "InvalidApiKey" | "Unknown" | "ResponseContent" | "Reqwest";
+}
+
+export function isUsernameError(error: any): error is UsernameError;
+
 export interface ReceiveError extends Error {
   name: "ReceiveError";
   variant: "Channel" | "Timeout" | "Cancelled";
@@ -1263,13 +1263,6 @@ export type Endpoint =
   | "DesktopRenderer"
   | "DesktopMain";
 
-export interface SshKeyImportError extends Error {
-  name: "SshKeyImportError";
-  variant: "Parsing" | "PasswordRequired" | "WrongPassword" | "UnsupportedKeyType";
-}
-
-export function isSshKeyImportError(error: any): error is SshKeyImportError;
-
 export interface SshKeyExportError extends Error {
   name: "SshKeyExportError";
   variant: "KeyConversion";
@@ -1277,6 +1270,13 @@ export interface SshKeyExportError extends Error {
 
 export function isSshKeyExportError(error: any): error is SshKeyExportError;
 
+export interface SshKeyImportError extends Error {
+  name: "SshKeyImportError";
+  variant: "Parsing" | "PasswordRequired" | "WrongPassword" | "UnsupportedKeyType";
+}
+
+export function isSshKeyImportError(error: any): error is SshKeyImportError;
+
 export interface KeyGenerationError extends Error {
   name: "KeyGenerationError";
   variant: "KeyGeneration" | "KeyConversion";
@@ -1313,14 +1313,6 @@ export interface CipherRiskError extends Error {
 
 export function isCipherRiskError(error: any): error is CipherRiskError;
 
-/**
- * Result of checking password exposure via HIBP API.
- */
-export type ExposedPasswordResult =
-  | { type: "NotChecked" }
-  | { type: "Found"; value: number }
-  | { type: "Error"; value: string };
-
 /**
  * Password reuse map wrapper for WASM compatibility.
  */
@@ -1371,6 +1363,14 @@ export interface CipherRiskResult {
   reuse_count: number | undefined;
 }
 
+/**
+ * Result of checking password exposure via HIBP API.
+ */
+export type ExposedPasswordResult =
+  | { type: "NotChecked" }
+  | { type: "Found"; value: number }
+  | { type: "Error"; value: string };
+
 /**
  * Options for configuring risk computation.
  */
@@ -1392,13 +1392,13 @@ export interface CipherRiskOptions {
   hibpBaseUrl?: string | undefined;
 }
 
-export interface PasswordHistory {
-  password: EncString;
+export interface PasswordHistoryView {
+  password: string;
   lastUsedDate: DateTime<Utc>;
 }
 
-export interface PasswordHistoryView {
-  password: string;
+export interface PasswordHistory {
+  password: EncString;
   lastUsedDate: DateTime<Utc>;
 }
 
@@ -1406,13 +1406,6 @@ export interface AncestorMap {
   ancestors: Map<CollectionId, string>;
 }
 
-export interface TotpError extends Error {
-  name: "TotpError";
-  variant: "InvalidOtpauth" | "MissingSecret" | "Crypto";
-}
-
-export function isTotpError(error: any): error is TotpError;
-
 export interface TotpResponse {
   /**
    * Generated TOTP code
@@ -1424,6 +1417,13 @@ export interface TotpResponse {
   period: number;
 }
 
+export interface TotpError extends Error {
+  name: "TotpError";
+  variant: "InvalidOtpauth" | "MissingSecret" | "Crypto";
+}
+
+export function isTotpError(error: any): error is TotpError;
+
 export interface DecryptError extends Error {
   name: "DecryptError";
   variant: "Crypto";
@@ -1482,11 +1482,11 @@ export interface LocalDataView {
   lastLaunched: DateTime<Utc> | undefined;
 }
 
-export interface SecureNoteView {
+export interface SecureNote {
   type: SecureNoteType;
 }
 
-export interface SecureNote {
+export interface SecureNoteView {
   type: SecureNoteType;
 }
 
@@ -1497,21 +1497,6 @@ export interface GetCipherError extends Error {
 
 export function isGetCipherError(error: any): error is GetCipherError;
 
-export interface EditCipherError extends Error {
-  name: "EditCipherError";
-  variant:
-    | "ItemNotFound"
-    | "Crypto"
-    | "Api"
-    | "VaultParse"
-    | "MissingField"
-    | "NotAuthenticated"
-    | "Repository"
-    | "Uuid";
-}
-
-export function isEditCipherError(error: any): error is EditCipherError;
-
 /**
  * Request to edit a cipher.
  */
@@ -1531,6 +1516,21 @@ export interface CipherEditRequest {
   key: EncString | undefined;
 }
 
+export interface EditCipherError extends Error {
+  name: "EditCipherError";
+  variant:
+    | "ItemNotFound"
+    | "Crypto"
+    | "Api"
+    | "VaultParse"
+    | "MissingField"
+    | "NotAuthenticated"
+    | "Repository"
+    | "Uuid";
+}
+
+export function isEditCipherError(error: any): error is EditCipherError;
+
 export interface GetOrganizationCiphersAdminError extends Error {
   name: "GetOrganizationCiphersAdminError";
   variant: "Crypto" | "VaultParse" | "Api";
@@ -1623,13 +1623,6 @@ export type CipherViewType =
   | { secureNote: SecureNoteView }
   | { sshKey: SshKeyView };
 
-export interface DecryptFileError extends Error {
-  name: "DecryptFileError";
-  variant: "Decrypt" | "Io";
-}
-
-export function isDecryptFileError(error: any): error is DecryptFileError;
-
 export interface EncryptFileError extends Error {
   name: "EncryptFileError";
   variant: "Encrypt" | "Io";
@@ -1637,18 +1630,26 @@ export interface EncryptFileError extends Error {
 
 export function isEncryptFileError(error: any): error is EncryptFileError;
 
+export interface DecryptFileError extends Error {
+  name: "DecryptFileError";
+  variant: "Decrypt" | "Io";
+}
+
+export function isDecryptFileError(error: any): error is DecryptFileError;
+
 export interface CipherPermissions {
   delete: boolean;
   restore: boolean;
 }
 
-export interface CardView {
-  cardholderName: string | undefined;
-  expMonth: string | undefined;
-  expYear: string | undefined;
-  code: string | undefined;
+/**
+ * Minimal CardView only including the needed details for list views
+ */
+export interface CardListView {
+  /**
+   * The brand of the card, e.g. Visa, Mastercard, etc.
+   */
   brand: string | undefined;
-  number: string | undefined;
 }
 
 export interface Card {
@@ -1660,14 +1661,13 @@ export interface Card {
   number: EncString | undefined;
 }
 
-/**
- * Minimal CardView only including the needed details for list views
- */
-export interface CardListView {
-  /**
-   * The brand of the card, e.g. Visa, Mastercard, etc.
-   */
+export interface CardView {
+  cardholderName: string | undefined;
+  expMonth: string | undefined;
+  expYear: string | undefined;
+  code: string | undefined;
   brand: string | undefined;
+  number: string | undefined;
 }
 
 export interface FieldView {
@@ -1684,54 +1684,47 @@ export interface Field {
   linkedId: LinkedIdType | undefined;
 }
 
-export interface LoginUriView {
-  uri: string | undefined;
-  match: UriMatchType | undefined;
-  uriChecksum: string | undefined;
-}
-
-export interface LoginUri {
-  uri: EncString | undefined;
-  match: UriMatchType | undefined;
-  uriChecksum: EncString | undefined;
-}
-
-export interface Fido2CredentialView {
+export interface Fido2CredentialNewView {
   credentialId: string;
   keyType: string;
   keyAlgorithm: string;
   keyCurve: string;
-  keyValue: EncString;
   rpId: string;
   userHandle: string | undefined;
   userName: string | undefined;
   counter: string;
   rpName: string | undefined;
   userDisplayName: string | undefined;
-  discoverable: string;
   creationDate: DateTime<Utc>;
 }
 
-export interface Fido2CredentialNewView {
+export interface Fido2CredentialListView {
   credentialId: string;
-  keyType: string;
-  keyAlgorithm: string;
-  keyCurve: string;
   rpId: string;
   userHandle: string | undefined;
   userName: string | undefined;
-  counter: string;
-  rpName: string | undefined;
   userDisplayName: string | undefined;
-  creationDate: DateTime<Utc>;
+  counter: string;
 }
 
-export interface Fido2CredentialFullView {
+export interface LoginUri {
+  uri: EncString | undefined;
+  match: UriMatchType | undefined;
+  uriChecksum: EncString | undefined;
+}
+
+export interface LoginUriView {
+  uri: string | undefined;
+  match: UriMatchType | undefined;
+  uriChecksum: string | undefined;
+}
+
+export interface Fido2CredentialView {
   credentialId: string;
   keyType: string;
   keyAlgorithm: string;
   keyCurve: string;
-  keyValue: string;
+  keyValue: EncString;
   rpId: string;
   userHandle: string | undefined;
   userName: string | undefined;
@@ -1752,6 +1745,17 @@ export interface LoginView {
   fido2Credentials: Fido2Credential[] | undefined;
 }
 
+export interface LoginListView {
+  fido2Credentials: Fido2CredentialListView[] | undefined;
+  hasFido2: boolean;
+  username: string | undefined;
+  /**
+   * The TOTP key is not decrypted. Useable as is with [`crate::generate_totp_cipher_view`].
+   */
+  totp: EncString | undefined;
+  uris: LoginUriView[] | undefined;
+}
+
 export interface Fido2Credential {
   credentialId: EncString;
   keyType: EncString;
@@ -1768,26 +1772,6 @@ export interface Fido2Credential {
   creationDate: DateTime<Utc>;
 }
 
-export interface LoginListView {
-  fido2Credentials: Fido2CredentialListView[] | undefined;
-  hasFido2: boolean;
-  username: string | undefined;
-  /**
-   * The TOTP key is not decrypted. Useable as is with [`crate::generate_totp_cipher_view`].
-   */
-  totp: EncString | undefined;
-  uris: LoginUriView[] | undefined;
-}
-
-export interface Fido2CredentialListView {
-  credentialId: string;
-  rpId: string;
-  userHandle: string | undefined;
-  userName: string | undefined;
-  userDisplayName: string | undefined;
-  counter: string;
-}
-
 export interface Login {
   username: EncString | undefined;
   password: EncString | undefined;
@@ -1798,41 +1782,27 @@ export interface Login {
   fido2Credentials: Fido2Credential[] | undefined;
 }
 
-export interface Cipher {
-  id: CipherId | undefined;
-  organizationId: OrganizationId | undefined;
-  folderId: FolderId | undefined;
-  collectionIds: CollectionId[];
-  /**
-   * More recent ciphers uses individual encryption keys to encrypt the other fields of the
-   * Cipher.
-   */
-  key: EncString | undefined;
-  name: EncString;
-  notes: EncString | undefined;
-  type: CipherType;
-  login: Login | undefined;
-  identity: Identity | undefined;
-  card: Card | undefined;
-  secureNote: SecureNote | undefined;
-  sshKey: SshKey | undefined;
-  favorite: boolean;
-  reprompt: CipherRepromptType;
-  organizationUseTotp: boolean;
-  edit: boolean;
-  permissions: CipherPermissions | undefined;
-  viewPassword: boolean;
-  localData: LocalData | undefined;
-  attachments: Attachment[] | undefined;
-  fields: Field[] | undefined;
-  passwordHistory: PasswordHistory[] | undefined;
+export interface Fido2CredentialFullView {
+  credentialId: string;
+  keyType: string;
+  keyAlgorithm: string;
+  keyCurve: string;
+  keyValue: string;
+  rpId: string;
+  userHandle: string | undefined;
+  userName: string | undefined;
+  counter: string;
+  rpName: string | undefined;
+  userDisplayName: string | undefined;
+  discoverable: string;
   creationDate: DateTime<Utc>;
-  deletedDate: DateTime<Utc> | undefined;
-  revisionDate: DateTime<Utc>;
-  archivedDate: DateTime<Utc> | undefined;
-  data: string | undefined;
 }
 
+/**
+ * NewType wrapper for `CipherId`
+ */
+export type CipherId = Tagged<Uuid, "CipherId">;
+
 export interface CipherListView {
   id: CipherId | undefined;
   organizationId: OrganizationId | undefined;
@@ -1888,29 +1858,6 @@ export interface DecryptCipherListResult {
   failures: Cipher[];
 }
 
-export type CipherListViewType =
-  | { login: LoginListView }
-  | "secureNote"
-  | { card: CardListView }
-  | "identity"
-  | "sshKey";
-
-/**
- * Available fields on a cipher and can be copied from a the list view in the UI.
- */
-export type CopyableCipherFields =
-  | "LoginUsername"
-  | "LoginPassword"
-  | "LoginTotp"
-  | "CardNumber"
-  | "CardSecurityCode"
-  | "IdentityUsername"
-  | "IdentityEmail"
-  | "IdentityPhone"
-  | "IdentityAddress"
-  | "SshKey"
-  | "SecureNotes";
-
 export interface CipherError extends Error {
   name: "CipherError";
   variant:
@@ -1928,15 +1875,6 @@ export interface CipherError extends Error {
 
 export function isCipherError(error: any): error is CipherError;
 
-export interface EncryptionContext {
-  /**
-   * The Id of the user that encrypted the cipher. It should always represent a UserId, even for
-   * Organization-owned ciphers
-   */
-  encryptedFor: UserId;
-  cipher: Cipher;
-}
-
 export interface CipherView {
   id: CipherId | undefined;
   organizationId: OrganizationId | undefined;
@@ -1974,10 +1912,72 @@ export interface CipherView {
   archivedDate: DateTime<Utc> | undefined;
 }
 
+export interface Cipher {
+  id: CipherId | undefined;
+  organizationId: OrganizationId | undefined;
+  folderId: FolderId | undefined;
+  collectionIds: CollectionId[];
+  /**
+   * More recent ciphers uses individual encryption keys to encrypt the other fields of the
+   * Cipher.
+   */
+  key: EncString | undefined;
+  name: EncString;
+  notes: EncString | undefined;
+  type: CipherType;
+  login: Login | undefined;
+  identity: Identity | undefined;
+  card: Card | undefined;
+  secureNote: SecureNote | undefined;
+  sshKey: SshKey | undefined;
+  favorite: boolean;
+  reprompt: CipherRepromptType;
+  organizationUseTotp: boolean;
+  edit: boolean;
+  permissions: CipherPermissions | undefined;
+  viewPassword: boolean;
+  localData: LocalData | undefined;
+  attachments: Attachment[] | undefined;
+  fields: Field[] | undefined;
+  passwordHistory: PasswordHistory[] | undefined;
+  creationDate: DateTime<Utc>;
+  deletedDate: DateTime<Utc> | undefined;
+  revisionDate: DateTime<Utc>;
+  archivedDate: DateTime<Utc> | undefined;
+  data: string | undefined;
+}
+
+export interface EncryptionContext {
+  /**
+   * The Id of the user that encrypted the cipher. It should always represent a UserId, even for
+   * Organization-owned ciphers
+   */
+  encryptedFor: UserId;
+  cipher: Cipher;
+}
+
+export type CipherListViewType =
+  | { login: LoginListView }
+  | "secureNote"
+  | { card: CardListView }
+  | "identity"
+  | "sshKey";
+
 /**
- * NewType wrapper for `CipherId`
+ * Available fields on a cipher and can be copied from a the list view in the UI.
  */
-export type CipherId = Tagged<Uuid, "CipherId">;
+export type CopyableCipherFields =
+  | "LoginUsername"
+  | "LoginPassword"
+  | "LoginTotp"
+  | "CardNumber"
+  | "CardSecurityCode"
+  | "IdentityUsername"
+  | "IdentityEmail"
+  | "IdentityPhone"
+  | "IdentityAddress"
+  | "SshKey"
+  | "SecureNotes";
 
 export interface SshKey {
   /**
@@ -2053,11 +2053,10 @@ export interface IdentityView {
 
 export type LinkedIdType = LoginLinkedIdType | CardLinkedIdType | IdentityLinkedIdType;
 
-export interface FolderView {
-  id: FolderId | undefined;
-  name: string;
-  revisionDate: DateTime<Utc>;
-}
+/**
+ * NewType wrapper for `FolderId`
+ */
+export type FolderId = Tagged<Uuid, "FolderId">;
 
 export interface Folder {
   id: FolderId | undefined;
@@ -2065,10 +2064,11 @@ export interface Folder {
   revisionDate: DateTime<Utc>;
 }
 
-/**
- * NewType wrapper for `FolderId`
- */
-export type FolderId = Tagged<Uuid, "FolderId">;
+export interface FolderView {
+  id: FolderId | undefined;
+  name: string;
+  revisionDate: DateTime<Utc>;
+}
 
 export interface EditFolderError extends Error {
   name: "EditFolderError";