@bitwarden/sdk-internal 0.2.0-main.35 → 0.2.0-main.351

package/node/bitwarden_wasm_internal.d.ts

@@ -1,6 +1,110 @@
 /* tslint:disable */
 /* eslint-disable */
-export function generate_ssh_key(key_algorithm: KeyAlgorithm): GenerateSshKeyResult;
+export function set_log_level(level: LogLevel): void;
+export function init_sdk(log_level?: LogLevel | null): void;
+/**
+ * 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
+ *
+ * # Arguments
+ * - `imported_key` - The private key to convert
+ * - `password` - The password to use for decrypting the key
+ *
+ * # Returns
+ * - `Ok(SshKey)` if the key was successfully coneverted
+ * - `Err(PasswordRequired)` if the key is encrypted and no password was provided
+ * - `Err(WrongPassword)` if the password provided is incorrect
+ * - `Err(ParsingError)` if the key could not be parsed
+ * - `Err(UnsupportedKeyType)` if the key type is not supported
+ */
+export function import_ssh_key(imported_key: string, password?: string | null): SshKeyView;
+/**
+ * Registers a DiscoverHandler so that the client can respond to DiscoverRequests.
+ */
+export function ipcRegisterDiscoverHandler(
+  ipc_client: IpcClient,
+  response: DiscoverResponse,
+): Promise<void>;
+/**
+ * Sends a DiscoverRequest to the specified destination and returns the response.
+ */
+export function ipcRequestDiscover(
+  ipc_client: IpcClient,
+  destination: Endpoint,
+  abort_signal?: AbortSignal | null,
+): Promise<DiscoverResponse>;
+export enum CardLinkedIdType {
+  CardholderName = 300,
+  ExpMonth = 301,
+  ExpYear = 302,
+  Code = 303,
+  Brand = 304,
+  Number = 305,
+}
+export enum CipherRepromptType {
+  None = 0,
+  Password = 1,
+}
+export enum CipherType {
+  Login = 1,
+  SecureNote = 2,
+  Card = 3,
+  Identity = 4,
+  SshKey = 5,
+}
+/**
+ * Represents the type of a [FieldView].
+ */
+export enum FieldType {
+  /**
+   * Text field
+   */
+  Text = 0,
+  /**
+   * Hidden text field
+   */
+  Hidden = 1,
+  /**
+   * Boolean field
+   */
+  Boolean = 2,
+  /**
+   * Linked field
+   */
+  Linked = 3,
+}
+export enum IdentityLinkedIdType {
+  Title = 400,
+  MiddleName = 401,
+  Address1 = 402,
+  Address2 = 403,
+  Address3 = 404,
+  City = 405,
+  State = 406,
+  PostalCode = 407,
+  Country = 408,
+  Company = 409,
+  Email = 410,
+  Phone = 411,
+  Ssn = 412,
+  Username = 413,
+  PassportNumber = 414,
+  LicenseNumber = 415,
+  FirstName = 416,
+  LastName = 417,
+  FullName = 418,
+}
 export enum LogLevel {
   Trace = 0,
   Debug = 1,
@@ -8,7 +112,258 @@ export enum LogLevel {
   Warn = 3,
   Error = 4,
 }
+export enum LoginLinkedIdType {
+  Username = 100,
+  Password = 101,
+}
+export enum SecureNoteType {
+  Generic = 0,
+}
+export enum UriMatchType {
+  Domain = 0,
+  Host = 1,
+  StartsWith = 2,
+  Exact = 3,
+  RegularExpression = 4,
+  Never = 5,
+}
+
+import { Tagged } from "type-fest";
+
+/**
+ * A string that **MUST** be a valid UUID.
+ *
+ * Never create or cast to this type directly, use the `uuid<T>()` function instead.
+ */
+export type Uuid = unknown;
+
+/**
+ * RFC3339 compliant date-time string.
+ * @typeParam T - Not used in JavaScript.
+ */
+export type DateTime<T = unknown> = string;
+
+/**
+ * UTC date-time string. Not used in JavaScript.
+ */
+export type Utc = unknown;
+
+/**
+ * An integer that is known not to equal zero.
+ */
+export type NonZeroU32 = number;
+
+export interface Repository<T> {
+  get(id: string): Promise<T | null>;
+  list(): Promise<T[]>;
+  set(id: string, value: T): Promise<void>;
+  remove(id: string): Promise<void>;
+}
+
+export interface TokenProvider {
+  get_access_token(): Promise<string | undefined>;
+}
+
+/**
+ * Active feature flags for the SDK.
+ */
+export interface FeatureFlags extends Map<string, boolean> {}
+
+export interface Repositories {
+  cipher: Repository<Cipher> | null;
+  folder: Repository<Folder> | null;
+}
+
+export interface IndexedDbConfiguration {
+  db_name: string;
+}
+
+export interface TestError extends Error {
+  name: "TestError";
+}
+
+export function isTestError(error: any): error is TestError;
+
+/**
+ * Represents the possible, expected errors that can occur when requesting a send access token.
+ */
+export type SendAccessTokenApiErrorResponse =
+  | {
+      error: "invalid_request";
+      error_description?: string;
+      send_access_error_type?: SendAccessTokenInvalidRequestError;
+    }
+  | {
+      error: "invalid_grant";
+      error_description?: string;
+      send_access_error_type?: SendAccessTokenInvalidGrantError;
+    }
+  | { error: "invalid_client"; error_description?: string }
+  | { error: "unauthorized_client"; error_description?: string }
+  | { error: "unsupported_grant_type"; error_description?: string }
+  | { 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"
+  | "email_invalid"
+  | "otp_invalid"
+  | "otp_generation_failed"
+  | "unknown";
+
+/**
+ * Invalid request errors - typically due to missing parameters.
+ */
+export type SendAccessTokenInvalidRequestError =
+  | "send_id_required"
+  | "password_hash_b64_required"
+  | "email_required"
+  | "email_and_otp_required_otp_sent"
+  | "unknown";
+
+/**
+ * Any unexpected error that occurs when making requests to identity. This could be
+ * local/transport/decoding failure from the HTTP client (DNS/TLS/connect/read timeout,
+ * connection reset, or JSON decode failure on a success response) or non-2xx response with an
+ * unexpected body or status. Used when decoding the server\'s error payload into
+ * `SendAccessTokenApiErrorResponse` fails, or for 5xx responses where no structured error is
+ * available.
+ */
+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.
+ */
+export interface SendAccessTokenResponse {
+  /**
+   * The actual token string.
+   */
+  token: string;
+  /**
+   * The timestamp in milliseconds when the token expires.
+   */
+  expiresAt: number;
+}
+
+/**
+ * A request structure for requesting a send access token from the API.
+ */
+export interface SendAccessTokenRequest {
+  /**
+   * The id of the send for which the access token is requested.
+   */
+  sendId: string;
+  /**
+   * The optional send access credentials.
+   */
+  sendAccessCredentials?: SendAccessCredentials;
+}
+
+/**
+ * The credentials used for send access requests.
+ */
+export type SendAccessCredentials =
+  | SendPasswordCredentials
+  | SendEmailCredentials
+  | SendEmailOtpCredentials;
+
+/**
+ * Credentials for getting a send access token using an email and OTP.
+ */
+export interface SendEmailOtpCredentials {
+  /**
+   * 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;
+}
+
+/**
+ * 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 SendEmailCredentials {
+  /**
+   * The email address to which the OTP will be sent.
+   */
+  email: string;
+}
+
+/**
+ * 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 SendPasswordCredentials {
+  /**
+   * A Base64-encoded hash of the password protecting the send.
+   */
+  passwordHashB64: string;
+}
+
+/**
+ * NewType wrapper for `CollectionId`
+ */
+export type CollectionId = Tagged<Uuid, "CollectionId">;
+
+export interface Collection {
+  id: CollectionId | undefined;
+  organizationId: OrganizationId;
+  name: EncString;
+  externalId: string | undefined;
+  hidePasswords: boolean;
+  readOnly: boolean;
+  manage: boolean;
+  defaultUserCollectionEmail: string | undefined;
+  type: CollectionType;
+}
+
+export interface CollectionView {
+  id: CollectionId | undefined;
+  organizationId: OrganizationId;
+  name: string;
+  externalId: string | undefined;
+  hidePasswords: boolean;
+  readOnly: boolean;
+  manage: boolean;
+  type: CollectionType;
+}
+
+/**
+ * Type of collection
+ */
+export type CollectionType = "SharedCollection" | "DefaultUserCollection";
+
+export interface CollectionDecryptError extends Error {
+  name: "CollectionDecryptError";
+  variant: "Crypto";
+}
+
+export function isCollectionDecryptError(error: any): error is CollectionDecryptError;
+
+/**
+ * State used for initializing the user cryptographic state.
+ */
 export interface InitUserCryptoRequest {
+  /**
+   * The user\'s ID.
+   */
+  userId: UserId | undefined;
   /**
    * The user\'s KDF parameters, as received from the prelogin request
    */
@@ -20,216 +375,1396 @@ export interface InitUserCryptoRequest {
   /**
    * The user\'s encrypted private key
    */
-  privateKey: string;
+  privateKey: EncString;
+  /**
+   * The user\'s signing key
+   */
+  signingKey: EncString | undefined;
+  /**
+   * The user\'s security state
+   */
+  securityState: SignedSecurityState | undefined;
   /**
    * The initialization method to use
    */
   method: InitUserCryptoMethod;
 }
 
+/**
+ * The crypto method used to initialize the user cryptographic state.
+ */
 export type InitUserCryptoMethod =
-  | { password: { password: string; user_key: string } }
+  | { password: { password: string; user_key: EncString } }
+  | { masterPasswordUnlock: { password: string; master_password_unlock: MasterPasswordUnlockData } }
   | { decryptedKey: { decrypted_user_key: string } }
   | { pin: { pin: string; pin_protected_user_key: EncString } }
-  | { authRequest: { request_private_key: string; method: AuthRequestMethod } }
+  | { 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: AsymmetricEncString;
+        device_protected_user_key: UnsignedSharedKey;
       };
     }
-  | { keyConnector: { master_key: string; user_key: string } };
+  | { keyConnector: { master_key: B64; user_key: EncString } };
 
+/**
+ * Auth requests supports multiple initialization methods.
+ */
 export type AuthRequestMethod =
-  | { userKey: { protected_user_key: AsymmetricEncString } }
-  | { masterKey: { protected_master_key: AsymmetricEncString; auth_request_key: EncString } };
+  | { userKey: { protected_user_key: UnsignedSharedKey } }
+  | { masterKey: { protected_master_key: UnsignedSharedKey; auth_request_key: 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<Uuid, AsymmetricEncString>;
+  organizationKeys: Map<OrganizationId, UnsignedSharedKey>;
 }
 
-export interface CoreError extends Error {
-  name: "CoreError";
-  variant:
-    | "MissingFieldError"
-    | "VaultLocked"
-    | "NotAuthenticated"
-    | "AccessTokenInvalid"
-    | "InvalidResponse"
-    | "Crypto"
-    | "IdentityFail"
-    | "Reqwest"
-    | "Serde"
-    | "Io"
-    | "InvalidBase64"
-    | "Chrono"
-    | "ResponseContent"
-    | "ValidationError"
-    | "InvalidStateFileVersion"
-    | "InvalidStateFile"
-    | "Internal"
-    | "EncryptionSettings";
-}
-
-export function isCoreError(error: any): error is CoreError;
+/**
+ * Response from the `update_kdf` function
+ */
+export interface UpdateKdfResponse {
+  /**
+   * The authentication data for the new KDF setting
+   */
+  masterPasswordAuthenticationData: MasterPasswordAuthenticationData;
+  /**
+   * The unlock data for the new KDF setting
+   */
+  masterPasswordUnlockData: MasterPasswordUnlockData;
+  /**
+   * The authentication data for the KDF setting prior to the change
+   */
+  oldMasterPasswordAuthenticationData: MasterPasswordAuthenticationData;
+}
 
-export interface EncryptionSettingsError extends Error {
-  name: "EncryptionSettingsError";
-  variant: "Crypto" | "InvalidBase64" | "VaultLocked" | "InvalidPrivateKey" | "MissingPrivateKey";
+/**
+ * Response from the `update_password` function
+ */
+export interface UpdatePasswordResponse {
+  /**
+   * Hash of the new password
+   */
+  passwordHash: B64;
+  /**
+   * User key, encrypted with the new password
+   */
+  newKey: EncString;
 }
 
-export function isEncryptionSettingsError(error: any): error is EncryptionSettingsError;
+/**
+ * Request for deriving a pin protected user key
+ */
+export interface EnrollPinResponse {
+  /**
+   * [UserKey] protected by PIN
+   */
+  pinProtectedUserKeyEnvelope: PasswordProtectedKeyEnvelope;
+  /**
+   * PIN protected by [UserKey]
+   */
+  userKeyEncryptedPin: EncString;
+}
 
-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";
+/**
+ * Request for deriving a pin protected user key
+ */
+export interface DerivePinKeyResponse {
+  /**
+   * [UserKey] protected by PIN
+   */
+  pinProtectedUserKey: EncString;
+  /**
+   * PIN protected by [UserKey]
+   */
+  encryptedPin: EncString;
+}
 
 /**
- * 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.
- *
- * Defaults to
- *
- * ```
- * # use bitwarden_core::{ClientSettings, DeviceType};
- * let settings = ClientSettings {
- *     identity_url: \"https://identity.bitwarden.com\".to_string(),
- *     api_url: \"https://api.bitwarden.com\".to_string(),
- *     user_agent: \"Bitwarden Rust-SDK\".to_string(),
- *     device_type: DeviceType::SDK,
- * };
- * let default = ClientSettings::default();
- * ```
+ * Request for migrating an account from password to key connector.
  */
-export interface ClientSettings {
+export interface DeriveKeyConnectorRequest {
+  /**
+   * Encrypted user key, used to validate the master key
+   */
+  userKeyEncrypted: EncString;
+  /**
+   * The user\'s master password
+   */
+  password: string;
+  /**
+   * The KDF parameters used to derive the master key
+   */
+  kdf: Kdf;
+  /**
+   * The user\'s email address
+   */
+  email: string;
+}
+
+/**
+ * Response from the `make_key_pair` function
+ */
+export interface MakeKeyPairResponse {
+  /**
+   * The user\'s public key
+   */
+  userPublicKey: B64;
+  /**
+   * User\'s private key, encrypted with the user key
+   */
+  userKeyEncryptedPrivateKey: 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
+ */
+export interface UserCryptoV2KeysResponse {
+  /**
+   * User key
+   */
+  userKey: B64;
+  /**
+   * Wrapped private key
+   */
+  privateKey: EncString;
+  /**
+   * Public key
+   */
+  publicKey: B64;
+  /**
+   * The user\'s public key, signed by the signing key
+   */
+  signedPublicKey: SignedPublicKey;
+  /**
+   * Signing key, encrypted with the user\'s symmetric key
+   */
+  signingKey: EncString;
+  /**
+   * Base64 encoded verifying key
+   */
+  verifyingKey: B64;
+  /**
+   * The user\'s signed security state
+   */
+  securityState: SignedSecurityState;
+  /**
+   * The security state\'s version
+   */
+  securityVersion: number;
+}
+
+/**
+ * Represents the data required to unlock with the master password.
+ */
+export interface MasterPasswordUnlockData {
+  /**
+   * The key derivation function used to derive the master key
+   */
+  kdf: Kdf;
+  /**
+   * The master key wrapped user key
+   */
+  masterKeyWrappedUserKey: EncString;
+  /**
+   * The salt used in the KDF, typically the user\'s email
+   */
+  salt: string;
+}
+
+/**
+ * Represents the data required to authenticate with the master password.
+ */
+export interface MasterPasswordAuthenticationData {
+  kdf: Kdf;
+  salt: string;
+  masterPasswordAuthenticationHash: B64;
+}
+
+export type SignedSecurityState = string;
+
+/**
+ * NewType wrapper for `UserId`
+ */
+export type UserId = Tagged<Uuid, "UserId">;
+
+/**
+ * NewType wrapper for `OrganizationId`
+ */
+export type OrganizationId = Tagged<Uuid, "OrganizationId">;
+
+/**
+ * A non-generic wrapper around `bitwarden-crypto`\'s `PasswordProtectedKeyEnvelope`.
+ */
+export type PasswordProtectedKeyEnvelope = Tagged<string, "PasswordProtectedKeyEnvelope">;
+
+export interface MasterPasswordError extends Error {
+  name: "MasterPasswordError";
+  variant:
+    | "EncryptionKeyMalformed"
+    | "KdfMalformed"
+    | "InvalidKdfConfiguration"
+    | "MissingField"
+    | "Crypto";
+}
+
+export function isMasterPasswordError(error: any): error is MasterPasswordError;
+
+export interface DeriveKeyConnectorError extends Error {
+  name: "DeriveKeyConnectorError";
+  variant: "WrongPassword" | "Crypto";
+}
+
+export function isDeriveKeyConnectorError(error: any): error is DeriveKeyConnectorError;
+
+export interface EnrollAdminPasswordResetError extends Error {
+  name: "EnrollAdminPasswordResetError";
+  variant: "Crypto";
+}
+
+export function isEnrollAdminPasswordResetError(error: any): error is EnrollAdminPasswordResetError;
+
+export interface CryptoClientError extends Error {
+  name: "CryptoClientError";
+  variant: "NotAuthenticated" | "Crypto" | "InvalidKdfSettings" | "PasswordProtectedKeyEnvelope";
+}
+
+export function isCryptoClientError(error: any): error is CryptoClientError;
+
+export interface StatefulCryptoError extends Error {
+  name: "StatefulCryptoError";
+  variant: "MissingSecurityState" | "WrongAccountCryptoVersion" | "Crypto";
+}
+
+export function isStatefulCryptoError(error: any): error is StatefulCryptoError;
+
+export interface EncryptionSettingsError extends Error {
+  name: "EncryptionSettingsError";
+  variant:
+    | "Crypto"
+    | "InvalidPrivateKey"
+    | "InvalidSigningKey"
+    | "InvalidSecurityState"
+    | "MissingPrivateKey"
+    | "UserIdAlreadySet"
+    | "WrongPin";
+}
+
+export function isEncryptionSettingsError(error: any): error is EncryptionSettingsError;
+
+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.
+ *
+ * Defaults to
+ *
+ * ```
+ * # use bitwarden_core::{ClientSettings, DeviceType};
+ * let settings = ClientSettings {
+ *     identity_url: \"https://identity.bitwarden.com\".to_string(),
+ *     api_url: \"https://api.bitwarden.com\".to_string(),
+ *     user_agent: \"Bitwarden Rust-SDK\".to_string(),
+ *     device_type: DeviceType::SDK,
+ *     bitwarden_client_version: None,
+ * };
+ * let default = ClientSettings::default();
+ * ```
+ */
+export interface ClientSettings {
+  /**
+   * The identity url of the targeted Bitwarden instance. Defaults to `https://identity.bitwarden.com`
+   */
+  identityUrl?: string;
+  /**
+   * The api url of the targeted Bitwarden instance. Defaults to `https://api.bitwarden.com`
+   */
+  apiUrl?: string;
+  /**
+   * The user_agent to sent to Bitwarden. Defaults to `Bitwarden Rust-SDK`
+   */
+  userAgent?: string;
+  /**
+   * Device type to send to Bitwarden. Defaults to SDK
+   */
+  deviceType?: DeviceType;
+  /**
+   * Bitwarden Client Version to send to Bitwarden.
+   */
+  bitwardenClientVersion?: string | undefined;
+}
+
+export type UnsignedSharedKey = Tagged<string, "UnsignedSharedKey">;
+
+export type EncString = Tagged<string, "EncString">;
+
+export type SignedPublicKey = Tagged<string, "SignedPublicKey">;
+
+/**
+ * The type of key / signature scheme used for signing and verifying.
+ */
+export type SignatureAlgorithm = "ed25519";
+
+/**
+ * Key Derivation Function for Bitwarden Account
+ *
+ * In Bitwarden accounts can use multiple KDFs to derive their master key from their password. This
+ * Enum represents all the possible KDFs.
+ */
+export type Kdf =
+  | { pBKDF2: { iterations: NonZeroU32 } }
+  | { argon2id: { iterations: NonZeroU32; memory: NonZeroU32; parallelism: NonZeroU32 } };
+
+export interface CryptoError extends Error {
+  name: "CryptoError";
+  variant:
+    | "InvalidKey"
+    | "InvalidMac"
+    | "MacNotProvided"
+    | "KeyDecrypt"
+    | "InvalidKeyLen"
+    | "InvalidUtf8String"
+    | "MissingKey"
+    | "MissingField"
+    | "MissingKeyId"
+    | "ReadOnlyKeyStore"
+    | "InsufficientKdfParameters"
+    | "EncString"
+    | "Rsa"
+    | "Fingerprint"
+    | "Argon"
+    | "ZeroNumber"
+    | "OperationNotSupported"
+    | "WrongKeyType"
+    | "WrongCoseKeyId"
+    | "InvalidNonceLength"
+    | "InvalidPadding"
+    | "Signature"
+    | "Encoding";
+}
+
+export function isCryptoError(error: any): error is CryptoError;
+
+/**
+ * Base64 encoded data
+ *
+ * Is indifferent about padding when decoding, but always produces padding when encoding.
+ */
+export type B64 = string;
+
+/**
+ * Temporary struct to hold metadata related to current account
+ *
+ * Eventually the SDK itself should have this state and we get rid of this struct.
+ */
+export interface Account {
+  id: Uuid;
+  email: string;
+  name: string | undefined;
+}
+
+export type ExportFormat = "Csv" | "Json" | { EncryptedJson: { password: string } };
+
+export interface ExportError extends Error {
+  name: "ExportError";
+  variant:
+    | "MissingField"
+    | "NotAuthenticated"
+    | "Csv"
+    | "Cxf"
+    | "Json"
+    | "EncryptedJson"
+    | "BitwardenCrypto"
+    | "Cipher";
+}
+
+export function isExportError(error: any): error is ExportError;
+
+export type UsernameGeneratorRequest =
+  | { word: { capitalize: boolean; include_number: boolean } }
+  | { subaddress: { type: AppendType; email: string } }
+  | { catchall: { type: AppendType; domain: string } }
+  | { forwarded: { service: ForwarderServiceType; website: string | undefined } };
+
+/**
+ * Configures the email forwarding service to use.
+ * For instructions on how to configure each service, see the documentation:
+ * <https://bitwarden.com/help/generator/#username-types>
+ */
+export type ForwarderServiceType =
+  | { addyIo: { api_token: string; domain: string; base_url: string } }
+  | { duckDuckGo: { token: string } }
+  | { firefox: { api_token: string } }
+  | { fastmail: { api_token: string } }
+  | { 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;
+
+/**
+ * Password generator request options.
+ */
+export interface PasswordGeneratorRequest {
+  /**
+   * Include lowercase characters (a-z).
+   */
+  lowercase: boolean;
+  /**
+   * Include uppercase characters (A-Z).
+   */
+  uppercase: boolean;
+  /**
+   * Include numbers (0-9).
+   */
+  numbers: boolean;
+  /**
+   * Include special characters: ! @ # $ % ^ & *
+   */
+  special: boolean;
+  /**
+   * The length of the generated password.
+   * Note that the password length must be greater than the sum of all the minimums.
+   */
+  length: number;
+  /**
+   * When set to true, the generated password will not contain ambiguous characters.
+   * The ambiguous characters are: I, O, l, 0, 1
+   */
+  avoidAmbiguous: boolean;
+  /**
+   * The minimum number of lowercase characters in the generated password.
+   * When set, the value must be between 1 and 9. This value is ignored if lowercase is false.
+   */
+  minLowercase: number | undefined;
+  /**
+   * The minimum number of uppercase characters in the generated password.
+   * When set, the value must be between 1 and 9. This value is ignored if uppercase is false.
+   */
+  minUppercase: number | undefined;
+  /**
+   * The minimum number of numbers in the generated password.
+   * When set, the value must be between 1 and 9. This value is ignored if numbers is false.
+   */
+  minNumber: number | undefined;
+  /**
+   * The minimum number of special characters in the generated password.
+   * When set, the value must be between 1 and 9. This value is ignored if special is false.
+   */
+  minSpecial: number | undefined;
+}
+
+export interface PasswordError extends Error {
+  name: "PasswordError";
+  variant: "NoCharacterSetEnabled" | "InvalidLength";
+}
+
+export function isPasswordError(error: any): error is PasswordError;
+
+/**
+ * Passphrase generator request options.
+ */
+export interface PassphraseGeneratorRequest {
+  /**
+   * Number of words in the generated passphrase.
+   * This value must be between 3 and 20.
+   */
+  numWords: number;
+  /**
+   * Character separator between words in the generated passphrase. The value cannot be empty.
+   */
+  wordSeparator: string;
+  /**
+   * When set to true, capitalize the first letter of each word in the generated passphrase.
+   */
+  capitalize: boolean;
+  /**
+   * When set to true, include a number at the end of one of the words in the generated
+   * passphrase.
+   */
+  includeNumber: boolean;
+}
+
+export type PassphraseError = { InvalidNumWords: { minimum: number; maximum: number } };
+
+export interface DiscoverResponse {
+  version: string;
+}
+
+export type Endpoint =
+  | { Web: { id: number } }
+  | "BrowserForeground"
+  | "BrowserBackground"
+  | "DesktopRenderer"
+  | "DesktopMain";
+
+export interface IpcCommunicationBackendSender {
+  send(message: OutgoingMessage): Promise<void>;
+}
+
+export interface ChannelError extends Error {
+  name: "ChannelError";
+}
+
+export function isChannelError(error: any): error is ChannelError;
+
+export interface DeserializeError extends Error {
+  name: "DeserializeError";
+}
+
+export function isDeserializeError(error: any): error is DeserializeError;
+
+export interface RequestError extends Error {
+  name: "RequestError";
+  variant: "Subscribe" | "Receive" | "Timeout" | "Send" | "Rpc";
+}
+
+export function isRequestError(error: any): error is RequestError;
+
+export interface TypedReceiveError extends Error {
+  name: "TypedReceiveError";
+  variant: "Channel" | "Timeout" | "Cancelled" | "Typing";
+}
+
+export function isTypedReceiveError(error: any): error is TypedReceiveError;
+
+export interface ReceiveError extends Error {
+  name: "ReceiveError";
+  variant: "Channel" | "Timeout" | "Cancelled";
+}
+
+export function isReceiveError(error: any): error is ReceiveError;
+
+export interface SubscribeError extends Error {
+  name: "SubscribeError";
+  variant: "NotStarted";
+}
+
+export function isSubscribeError(error: any): error is SubscribeError;
+
+export type KeyAlgorithm = "Ed25519" | "Rsa3072" | "Rsa4096";
+
+export interface SshKeyExportError extends Error {
+  name: "SshKeyExportError";
+  variant: "KeyConversion";
+}
+
+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";
+}
+
+export function isKeyGenerationError(error: any): error is KeyGenerationError;
+
+export interface DatabaseError extends Error {
+  name: "DatabaseError";
+  variant: "UnsupportedConfiguration" | "ThreadBoundRunner" | "Serialization" | "JS" | "Internal";
+}
+
+export function isDatabaseError(error: any): error is DatabaseError;
+
+export interface StateRegistryError extends Error {
+  name: "StateRegistryError";
+  variant: "DatabaseAlreadyInitialized" | "DatabaseNotInitialized" | "Database";
+}
+
+export function isStateRegistryError(error: any): error is StateRegistryError;
+
+export interface CallError extends Error {
+  name: "CallError";
+}
+
+export function isCallError(error: any): error is CallError;
+
+/**
+ * NewType wrapper for `CipherId`
+ */
+export type CipherId = Tagged<Uuid, "CipherId">;
+
+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 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;
+}
+
+export interface CipherView {
+  id: CipherId | undefined;
+  organizationId: OrganizationId | undefined;
+  folderId: FolderId | undefined;
+  collectionIds: CollectionId[];
+  /**
+   * Temporary, required to support re-encrypting existing items.
+   */
+  key: EncString | undefined;
+  name: string;
+  notes: string | undefined;
+  type: CipherType;
+  login: LoginView | undefined;
+  identity: IdentityView | undefined;
+  card: CardView | undefined;
+  secureNote: SecureNoteView | undefined;
+  sshKey: SshKeyView | undefined;
+  favorite: boolean;
+  reprompt: CipherRepromptType;
+  organizationUseTotp: boolean;
+  edit: boolean;
+  permissions: CipherPermissions | undefined;
+  viewPassword: boolean;
+  localData: LocalDataView | undefined;
+  attachments: AttachmentView[] | undefined;
+  fields: FieldView[] | undefined;
+  passwordHistory: PasswordHistoryView[] | undefined;
+  creationDate: DateTime<Utc>;
+  deletedDate: DateTime<Utc> | undefined;
+  revisionDate: DateTime<Utc>;
+  archivedDate: DateTime<Utc> | undefined;
+}
+
+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 CipherListView {
+  id: CipherId | undefined;
+  organizationId: OrganizationId | undefined;
+  folderId: FolderId | undefined;
+  collectionIds: CollectionId[];
+  /**
+   * Temporary, required to support calculating TOTP from CipherListView.
+   */
+  key: EncString | undefined;
+  name: string;
+  subtitle: string;
+  type: CipherListViewType;
+  favorite: boolean;
+  reprompt: CipherRepromptType;
+  organizationUseTotp: boolean;
+  edit: boolean;
+  permissions: CipherPermissions | undefined;
+  viewPassword: boolean;
+  /**
+   * The number of attachments
+   */
+  attachments: number;
+  /**
+   * Indicates if the cipher has old attachments that need to be re-uploaded
+   */
+  hasOldAttachments: boolean;
+  creationDate: DateTime<Utc>;
+  deletedDate: DateTime<Utc> | undefined;
+  revisionDate: DateTime<Utc>;
+  archivedDate: DateTime<Utc> | undefined;
+  /**
+   * Hints for the presentation layer for which fields can be copied.
+   */
+  copyableFields: CopyableCipherFields[];
+  localData: LocalDataView | undefined;
+}
+
+/**
+ * Represents the result of decrypting a list of ciphers.
+ *
+ * This struct contains two vectors: `successes` and `failures`.
+ * `successes` contains the decrypted `CipherListView` objects,
+ * while `failures` contains the original `Cipher` objects that failed to decrypt.
+ */
+export interface DecryptCipherListResult {
+  /**
+   * The decrypted `CipherListView` objects.
+   */
+  successes: CipherListView[];
+  /**
+   * The original `Cipher` objects that failed to decrypt.
+   */
+  failures: Cipher[];
+}
+
+export interface Field {
+  name: EncString | undefined;
+  value: EncString | undefined;
+  type: FieldType;
+  linkedId: LinkedIdType | undefined;
+}
+
+export interface FieldView {
+  name: string | undefined;
+  value: string | undefined;
+  type: FieldType;
+  linkedId: LinkedIdType | undefined;
+}
+
+export type LinkedIdType = LoginLinkedIdType | CardLinkedIdType | IdentityLinkedIdType;
+
+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 Fido2Credential {
+  credentialId: EncString;
+  keyType: EncString;
+  keyAlgorithm: EncString;
+  keyCurve: EncString;
+  keyValue: EncString;
+  rpId: EncString;
+  userHandle: EncString | undefined;
+  userName: EncString | undefined;
+  counter: EncString;
+  rpName: EncString | undefined;
+  userDisplayName: EncString | undefined;
+  discoverable: EncString;
+  creationDate: DateTime<Utc>;
+}
+
+export interface Fido2CredentialListView {
+  credentialId: string;
+  rpId: string;
+  userHandle: string | undefined;
+  userName: string | undefined;
+  userDisplayName: string | undefined;
+  counter: string;
+}
+
+export interface Fido2CredentialView {
+  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 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>;
+}
+
+export interface Fido2CredentialNewView {
+  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>;
+}
+
+export interface Login {
+  username: EncString | undefined;
+  password: EncString | undefined;
+  passwordRevisionDate: DateTime<Utc> | undefined;
+  uris: LoginUri[] | undefined;
+  totp: EncString | undefined;
+  autofillOnPageLoad: boolean | undefined;
+  fido2Credentials: Fido2Credential[] | undefined;
+}
+
+export interface LoginView {
+  username: string | undefined;
+  password: string | undefined;
+  passwordRevisionDate: DateTime<Utc> | undefined;
+  uris: LoginUriView[] | undefined;
+  totp: string | undefined;
+  autofillOnPageLoad: boolean | undefined;
+  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 SecureNote {
+  type: SecureNoteType;
+}
+
+export interface SecureNoteView {
+  type: SecureNoteType;
+}
+
+/**
+ * Request to add or edit a folder.
+ */
+export interface FolderAddEditRequest {
+  /**
+   * The new name of the folder.
+   */
+  name: string;
+}
+
+/**
+ * NewType wrapper for `FolderId`
+ */
+export type FolderId = Tagged<Uuid, "FolderId">;
+
+export interface Folder {
+  id: FolderId | undefined;
+  name: EncString;
+  revisionDate: DateTime<Utc>;
+}
+
+export interface FolderView {
+  id: FolderId | undefined;
+  name: string;
+  revisionDate: DateTime<Utc>;
+}
+
+export interface AncestorMap {
+  ancestors: Map<CollectionId, string>;
+}
+
+export interface DecryptError extends Error {
+  name: "DecryptError";
+  variant: "Crypto";
+}
+
+export function isDecryptError(error: any): error is DecryptError;
+
+export interface EncryptError extends Error {
+  name: "EncryptError";
+  variant: "Crypto" | "MissingUserId";
+}
+
+export function isEncryptError(error: any): error is EncryptError;
+
+export interface TotpResponse {
+  /**
+   * Generated TOTP code
+   */
+  code: string;
+  /**
+   * Time period
+   */
+  period: number;
+}
+
+export interface TotpError extends Error {
+  name: "TotpError";
+  variant: "InvalidOtpauth" | "MissingSecret" | "Crypto";
+}
+
+export function isTotpError(error: any): error is TotpError;
+
+export interface PasswordHistoryView {
+  password: string;
+  lastUsedDate: DateTime<Utc>;
+}
+
+export interface PasswordHistory {
+  password: EncString;
+  lastUsedDate: DateTime<Utc>;
+}
+
+export interface GetFolderError extends Error {
+  name: "GetFolderError";
+  variant: "ItemNotFound" | "Crypto" | "Repository";
+}
+
+export function isGetFolderError(error: any): error is GetFolderError;
+
+export interface EditFolderError extends Error {
+  name: "EditFolderError";
+  variant:
+    | "ItemNotFound"
+    | "Crypto"
+    | "Api"
+    | "VaultParse"
+    | "MissingField"
+    | "Repository"
+    | "Uuid";
+}
+
+export function isEditFolderError(error: any): error is EditFolderError;
+
+export interface CreateFolderError extends Error {
+  name: "CreateFolderError";
+  variant: "Crypto" | "Api" | "VaultParse" | "MissingField" | "Repository";
+}
+
+export function isCreateFolderError(error: any): error is CreateFolderError;
+
+export interface SshKeyView {
   /**
-   * The identity url of the targeted Bitwarden instance. Defaults to `https://identity.bitwarden.com`
+   * SSH private key (ed25519/rsa) in unencrypted openssh private key format [OpenSSH private key](https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.key)
    */
-  identityUrl?: string;
+  privateKey: string;
   /**
-   * The api url of the targeted Bitwarden instance. Defaults to `https://api.bitwarden.com`
+   * SSH public key (ed25519/rsa) according to [RFC4253](https://datatracker.ietf.org/doc/html/rfc4253#section-6.6)
    */
-  apiUrl?: string;
+  publicKey: string;
   /**
-   * The user_agent to sent to Bitwarden. Defaults to `Bitwarden Rust-SDK`
+   * SSH fingerprint using SHA256 in the format: `SHA256:BASE64_ENCODED_FINGERPRINT`
    */
-  userAgent?: string;
+  fingerprint: string;
+}
+
+export interface SshKey {
   /**
-   * Device type to send to Bitwarden. Defaults to SDK
+   * SSH private key (ed25519/rsa) in unencrypted openssh private key format [OpenSSH private key](https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.key)
    */
-  deviceType?: DeviceType;
+  privateKey: EncString;
+  /**
+   * SSH public key (ed25519/rsa) according to [RFC4253](https://datatracker.ietf.org/doc/html/rfc4253#section-6.6)
+   */
+  publicKey: EncString;
+  /**
+   * SSH fingerprint using SHA256 in the format: `SHA256:BASE64_ENCODED_FINGERPRINT`
+   */
+  fingerprint: EncString;
 }
 
-export type AsymmetricEncString = string;
+export interface LocalDataView {
+  lastUsedDate: DateTime<Utc> | undefined;
+  lastLaunched: DateTime<Utc> | undefined;
+}
 
-export type EncString = string;
+export interface LocalData {
+  lastUsedDate: DateTime<Utc> | undefined;
+  lastLaunched: DateTime<Utc> | undefined;
+}
 
-/**
- * Key Derivation Function for Bitwarden Account
- *
- * In Bitwarden accounts can use multiple KDFs to derive their master key from their password. This
- * Enum represents all the possible KDFs.
- */
-export type Kdf =
-  | { pBKDF2: { iterations: NonZeroU32 } }
-  | { argon2id: { iterations: NonZeroU32; memory: NonZeroU32; parallelism: NonZeroU32 } };
+export interface IdentityView {
+  title: string | undefined;
+  firstName: string | undefined;
+  middleName: string | undefined;
+  lastName: string | undefined;
+  address1: string | undefined;
+  address2: string | undefined;
+  address3: string | undefined;
+  city: string | undefined;
+  state: string | undefined;
+  postalCode: string | undefined;
+  country: string | undefined;
+  company: string | undefined;
+  email: string | undefined;
+  phone: string | undefined;
+  ssn: string | undefined;
+  username: string | undefined;
+  passportNumber: string | undefined;
+  licenseNumber: string | undefined;
+}
 
-export interface GenerateSshKeyResult {
-  private_key: string;
-  public_key: string;
-  key_fingerprint: string;
+export interface Identity {
+  title: EncString | undefined;
+  firstName: EncString | undefined;
+  middleName: EncString | undefined;
+  lastName: EncString | undefined;
+  address1: EncString | undefined;
+  address2: EncString | undefined;
+  address3: EncString | undefined;
+  city: EncString | undefined;
+  state: EncString | undefined;
+  postalCode: EncString | undefined;
+  country: EncString | undefined;
+  company: EncString | undefined;
+  email: EncString | undefined;
+  phone: EncString | undefined;
+  ssn: EncString | undefined;
+  username: EncString | undefined;
+  passportNumber: EncString | undefined;
+  licenseNumber: EncString | undefined;
 }
 
-export type KeyAlgorithm = "Ed25519" | "Rsa3072" | "Rsa4096";
+export interface CipherPermissions {
+  delete: boolean;
+  restore: boolean;
+}
 
-export interface KeyGenerationError extends Error {
-  name: "KeyGenerationError";
-  variant: "KeyGenerationError" | "KeyConversionError";
+export interface CipherError extends Error {
+  name: "CipherError";
+  variant: "MissingField" | "Crypto" | "Encrypt" | "AttachmentsWithoutKeys";
 }
 
-export function isKeyGenerationError(error: any): error is KeyGenerationError;
+export function isCipherError(error: any): error is CipherError;
 
-export interface Folder {
-  id: Uuid | undefined;
-  name: EncString;
-  revisionDate: DateTime<Utc>;
+/**
+ * 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;
 }
 
-export interface FolderView {
-  id: Uuid | undefined;
-  name: string;
-  revisionDate: DateTime<Utc>;
+export interface CardView {
+  cardholderName: string | undefined;
+  expMonth: string | undefined;
+  expYear: string | undefined;
+  code: string | undefined;
+  brand: string | undefined;
+  number: string | undefined;
 }
 
-export interface TestError extends Error {
-  name: "TestError";
+export interface Card {
+  cardholderName: EncString | undefined;
+  expMonth: EncString | undefined;
+  expYear: EncString | undefined;
+  code: EncString | undefined;
+  brand: EncString | undefined;
+  number: EncString | undefined;
 }
 
-export function isTestError(error: any): error is TestError;
+export interface DecryptFileError extends Error {
+  name: "DecryptFileError";
+  variant: "Decrypt" | "Io";
+}
 
-export type Uuid = string;
+export function isDecryptFileError(error: any): error is DecryptFileError;
 
-/**
- * RFC3339 compliant date-time string.
- * @typeParam T - Not used in JavaScript.
- */
-export type DateTime<T = unknown> = string;
+export interface EncryptFileError extends Error {
+  name: "EncryptFileError";
+  variant: "Encrypt" | "Io";
+}
+
+export function isEncryptFileError(error: any): error is EncryptFileError;
+
+export interface AttachmentView {
+  id: string | undefined;
+  url: string | undefined;
+  size: string | undefined;
+  sizeName: string | undefined;
+  fileName: string | undefined;
+  key: EncString | undefined;
+  /**
+   * The decrypted attachmentkey in base64 format.
+   *
+   * **TEMPORARY FIELD**: This field is a temporary workaround to provide
+   * decrypted attachment keys to the TypeScript client during the migration
+   * process. It will be removed once the encryption/decryption logic is
+   * fully migrated to the SDK.
+   *
+   * **Ticket**: <https://bitwarden.atlassian.net/browse/PM-23005>
+   *
+   * Do not rely on this field for long-term use.
+   */
+  decryptedKey: string | undefined;
+}
+
+export interface Attachment {
+  id: string | undefined;
+  url: string | undefined;
+  size: string | undefined;
+  /**
+   * Readable size, ex: \"4.2 KB\" or \"1.43 GB\
+   */
+  sizeName: string | undefined;
+  fileName: EncString | undefined;
+  key: EncString | undefined;
+}
 
+export class AttachmentsClient {
+  private constructor();
+  free(): void;
+  decrypt_buffer(
+    cipher: Cipher,
+    attachment: AttachmentView,
+    encrypted_buffer: Uint8Array,
+  ): Uint8Array;
+}
 /**
- * UTC date-time string. Not used in JavaScript.
+ * Subclient containing auth functionality.
  */
-export type Utc = unknown;
-
+export class AuthClient {
+  private constructor();
+  free(): void;
+  /**
+   * Client for send access functionality
+   */
+  send_access(): SendAccessClient;
+}
 /**
- * An integer that is known not to equal zero.
+ * The main entry point for the Bitwarden SDK in WebAssembly environments
  */
-export type NonZeroU32 = number;
-
 export class BitwardenClient {
   free(): void;
-  constructor(settings?: ClientSettings, log_level?: LogLevel);
+  /**
+   * Initialize a new instance of the SDK client
+   */
+  constructor(token_provider: any, settings?: ClientSettings | null);
   /**
    * Test method, echoes back the input
    */
   echo(msg: string): string;
+  /**
+   * Returns the current SDK version
+   */
   version(): string;
-  throw(msg: string): Promise<void>;
+  /**
+   * Test method, always throws an error
+   */
+  throw(msg: string): void;
   /**
    * Test method, calls http endpoint
    */
   http_get(url: string): Promise<string>;
-  crypto(): ClientCrypto;
-  vault(): ClientVault;
+  /**
+   * Auth related operations.
+   */
+  auth(): AuthClient;
+  /**
+   * Crypto related operations.
+   */
+  crypto(): CryptoClient;
+  /**
+   * Vault item related operations.
+   */
+  vault(): VaultClient;
+  /**
+   * Constructs a specific client for platform-specific functionality
+   */
+  platform(): PlatformClient;
+  /**
+   * Constructs a specific client for generating passwords and passphrases
+   */
+  generator(): GeneratorClient;
+  /**
+   * Exporter related operations.
+   */
+  exporters(): ExporterClient;
+}
+export class CiphersClient {
+  private constructor();
+  free(): void;
+  encrypt(cipher_view: CipherView): EncryptionContext;
+  /**
+   * Encrypt a cipher with the provided key. This should only be used when rotating encryption
+   * keys in the Web client.
+   *
+   * Until key rotation is fully implemented in the SDK, this method must be provided the new
+   * symmetric key in base64 format. See PM-23084
+   *
+   * If the cipher has a CipherKey, it will be re-encrypted with the new key.
+   * If the cipher does not have a CipherKey and CipherKeyEncryption is enabled, one will be
+   * generated using the new key. Otherwise, the cipher's data will be encrypted with the new
+   * key directly.
+   */
+  encrypt_cipher_for_rotation(cipher_view: CipherView, new_key: B64): EncryptionContext;
+  decrypt(cipher: Cipher): CipherView;
+  decrypt_list(ciphers: Cipher[]): CipherListView[];
+  /**
+   * Decrypt cipher list with failures
+   * Returns both successfully decrypted ciphers and any that failed to decrypt
+   */
+  decrypt_list_with_failures(ciphers: Cipher[]): DecryptCipherListResult;
+  decrypt_fido2_credentials(cipher_view: CipherView): Fido2CredentialView[];
+  /**
+   * Temporary method used to re-encrypt FIDO2 credentials for a cipher view.
+   * Necessary until the TS clients utilize the SDK entirely for FIDO2 credentials management.
+   * TS clients create decrypted FIDO2 credentials that need to be encrypted manually when
+   * encrypting the rest of the CipherView.
+   * TODO: Remove once TS passkey provider implementation uses SDK - PM-8313
+   */
+  set_fido2_credentials(
+    cipher_view: CipherView,
+    fido2_credentials: Fido2CredentialFullView[],
+  ): CipherView;
+  move_to_organization(cipher_view: CipherView, organization_id: OrganizationId): CipherView;
+  decrypt_fido2_private_key(cipher_view: CipherView): string;
+}
+export class CollectionViewNodeItem {
+  private constructor();
+  free(): void;
+  get_item(): CollectionView;
+  get_parent(): CollectionView | undefined;
+  get_children(): CollectionView[];
+  get_ancestors(): AncestorMap;
+}
+export class CollectionViewTree {
+  private constructor();
+  free(): void;
+  get_item_for_view(collection_view: CollectionView): CollectionViewNodeItem | undefined;
+  get_root_items(): CollectionViewNodeItem[];
+  get_flat_items(): CollectionViewNodeItem[];
+}
+export class CollectionsClient {
+  private constructor();
+  free(): void;
+  decrypt(collection: Collection): CollectionView;
+  decrypt_list(collections: Collection[]): CollectionView[];
+  /**
+   *
+   * Returns the vector of CollectionView objects in a tree structure based on its implemented
+   * path().
+   */
+  get_collection_tree(collections: CollectionView[]): CollectionViewTree;
 }
-export class ClientCrypto {
+/**
+ * A client for the crypto operations.
+ */
+export class CryptoClient {
   private constructor();
   free(): void;
   /**
@@ -242,17 +1777,421 @@ export class ClientCrypto {
    * `initialize_user_crypto` but before any other crypto operations.
    */
   initialize_org_crypto(req: InitOrgCryptoRequest): Promise<void>;
+  /**
+   * Generates a new key pair and encrypts the private key with the provided user key.
+   * Crypto initialization not required.
+   */
+  make_key_pair(user_key: B64): MakeKeyPairResponse;
+  /**
+   * Verifies a user's asymmetric keys by decrypting the private key with the provided user
+   * key. Returns if the private key is decryptable and if it is a valid matching key.
+   * Crypto initialization not required.
+   */
+  verify_asymmetric_keys(request: VerifyAsymmetricKeysRequest): VerifyAsymmetricKeysResponse;
+  /**
+   * Makes a new signing key pair and signs the public key for the user
+   */
+  make_keys_for_user_crypto_v2(): UserCryptoV2KeysResponse;
+  /**
+   * Creates a rotated set of account keys for the current state
+   */
+  get_v2_rotated_account_keys(): UserCryptoV2KeysResponse;
+  /**
+   * Create the data necessary to update the user's kdf settings. The user's encryption key is
+   * re-encrypted for the password under the new kdf settings. This returns the re-encrypted
+   * user key and the new password hash but does not update sdk state.
+   */
+  make_update_kdf(password: string, kdf: Kdf): UpdateKdfResponse;
+  /**
+   * Protects the current user key with the provided PIN. The result can be stored and later
+   * used to initialize another client instance by using the PIN and the PIN key with
+   * `initialize_user_crypto`.
+   */
+  enroll_pin(pin: string): EnrollPinResponse;
+  /**
+   * Protects the current user key with the provided PIN. The result can be stored and later
+   * used to initialize another client instance by using the PIN and the PIN key with
+   * `initialize_user_crypto`. The provided pin is encrypted with the user key.
+   */
+  enroll_pin_with_encrypted_pin(encrypted_pin: string): EnrollPinResponse;
+  /**
+   * Decrypts a `PasswordProtectedKeyEnvelope`, returning the user key, if successful.
+   * This is a stop-gap solution, until initialization of the SDK is used.
+   */
+  unseal_password_protected_key_envelope(
+    pin: string,
+    envelope: PasswordProtectedKeyEnvelope,
+  ): Uint8Array;
 }
-export class ClientFolders {
+export class ExporterClient {
+  private constructor();
+  free(): void;
+  export_vault(folders: Folder[], ciphers: Cipher[], format: ExportFormat): string;
+  export_organization_vault(
+    collections: Collection[],
+    ciphers: Cipher[],
+    format: ExportFormat,
+  ): string;
+  /**
+   * Credential Exchange Format (CXF)
+   *
+   * *Warning:* Expect this API to be unstable, and it will change in the future.
+   *
+   * For use with Apple using [ASCredentialExportManager](https://developer.apple.com/documentation/authenticationservices/ascredentialexportmanager).
+   * Ideally, the input should be immediately serialized from [ASImportableAccount](https://developer.apple.com/documentation/authenticationservices/asimportableaccount).
+   */
+  export_cxf(account: Account, ciphers: Cipher[]): string;
+  /**
+   * Credential Exchange Format (CXF)
+   *
+   * *Warning:* Expect this API to be unstable, and it will change in the future.
+   *
+   * For use with Apple using [ASCredentialExportManager](https://developer.apple.com/documentation/authenticationservices/ascredentialexportmanager).
+   * Ideally, the input should be immediately serialized from [ASImportableAccount](https://developer.apple.com/documentation/authenticationservices/asimportableaccount).
+   */
+  import_cxf(payload: string): Cipher[];
+}
+/**
+ * Wrapper for folder specific functionality.
+ */
+export class FoldersClient {
   private constructor();
   free(): void;
   /**
-   * Decrypt folder
+   * Encrypt a [FolderView] to a [Folder].
+   */
+  encrypt(folder_view: FolderView): Folder;
+  /**
+   * Encrypt a [Folder] to [FolderView].
    */
   decrypt(folder: Folder): FolderView;
+  /**
+   * Decrypt a list of [Folder]s to a list of [FolderView]s.
+   */
+  decrypt_list(folders: Folder[]): FolderView[];
+  /**
+   * Get all folders from state and decrypt them to a list of [FolderView].
+   */
+  list(): Promise<FolderView[]>;
+  /**
+   * Get a specific [Folder] by its ID from state and decrypt it to a [FolderView].
+   */
+  get(folder_id: FolderId): Promise<FolderView>;
+  /**
+   * Create a new [Folder] and save it to the server.
+   */
+  create(request: FolderAddEditRequest): Promise<FolderView>;
+  /**
+   * Edit the [Folder] and save it to the server.
+   */
+  edit(folder_id: FolderId, request: FolderAddEditRequest): Promise<FolderView>;
+}
+export class GeneratorClient {
+  private constructor();
+  free(): void;
+  /**
+   * Generates a random password.
+   *
+   * The character sets and password length can be customized using the `input` parameter.
+   *
+   * # Examples
+   *
+   * ```
+   * use bitwarden_core::Client;
+   * use bitwarden_generators::{GeneratorClientsExt, PassphraseError, PasswordGeneratorRequest};
+   *
+   * async fn test() -> Result<(), PassphraseError> {
+   *     let input = PasswordGeneratorRequest {
+   *         lowercase: true,
+   *         uppercase: true,
+   *         numbers: true,
+   *         length: 20,
+   *         ..Default::default()
+   *     };
+   *     let password = Client::new(None).generator().password(input).unwrap();
+   *     println!("{}", password);
+   *     Ok(())
+   * }
+   * ```
+   */
+  password(input: PasswordGeneratorRequest): string;
+  /**
+   * Generates a random passphrase.
+   * A passphrase is a combination of random words separated by a character.
+   * An example of passphrase is `correct horse battery staple`.
+   *
+   * The number of words and their case, the word separator, and the inclusion of
+   * a number in the passphrase can be customized using the `input` parameter.
+   *
+   * # Examples
+   *
+   * ```
+   * use bitwarden_core::Client;
+   * use bitwarden_generators::{GeneratorClientsExt, PassphraseError, PassphraseGeneratorRequest};
+   *
+   * async fn test() -> Result<(), PassphraseError> {
+   *     let input = PassphraseGeneratorRequest {
+   *         num_words: 4,
+   *         ..Default::default()
+   *     };
+   *     let passphrase = Client::new(None).generator().passphrase(input).unwrap();
+   *     println!("{}", passphrase);
+   *     Ok(())
+   * }
+   * ```
+   */
+  passphrase(input: PassphraseGeneratorRequest): string;
+}
+export class IncomingMessage {
+  free(): void;
+  constructor(payload: Uint8Array, destination: Endpoint, source: Endpoint, topic?: string | null);
+  /**
+   * Try to parse the payload as JSON.
+   * @returns The parsed JSON value, or undefined if the payload is not valid JSON.
+   */
+  parse_payload_as_json(): any;
+  payload: Uint8Array;
+  destination: Endpoint;
+  source: Endpoint;
+  get topic(): string | undefined;
+  set topic(value: string | null | undefined);
+}
+/**
+ * JavaScript wrapper around the IPC client. For more information, see the
+ * [IpcClient] documentation.
+ */
+export class IpcClient {
+  free(): void;
+  constructor(communication_provider: IpcCommunicationBackend);
+  start(): Promise<void>;
+  isRunning(): Promise<boolean>;
+  send(message: OutgoingMessage): Promise<void>;
+  subscribe(): Promise<IpcClientSubscription>;
+}
+/**
+ * JavaScript wrapper around the IPC client subscription. For more information, see the
+ * [IpcClientSubscription](crate::IpcClientSubscription) documentation.
+ */
+export class IpcClientSubscription {
+  private constructor();
+  free(): void;
+  receive(abort_signal?: AbortSignal | null): Promise<IncomingMessage>;
+}
+/**
+ * JavaScript implementation of the `CommunicationBackend` trait for IPC communication.
+ */
+export class IpcCommunicationBackend {
+  free(): void;
+  /**
+   * Creates a new instance of the JavaScript communication backend.
+   */
+  constructor(sender: IpcCommunicationBackendSender);
+  /**
+   * Used by JavaScript to provide an incoming message to the IPC framework.
+   */
+  receive(message: IncomingMessage): void;
+}
+export class OutgoingMessage {
+  free(): void;
+  constructor(payload: Uint8Array, destination: Endpoint, topic?: string | null);
+  /**
+   * Create a new message and encode the payload as JSON.
+   */
+  static new_json_payload(
+    payload: any,
+    destination: Endpoint,
+    topic?: string | null,
+  ): OutgoingMessage;
+  payload: Uint8Array;
+  destination: Endpoint;
+  get topic(): string | undefined;
+  set topic(value: string | null | undefined);
+}
+export class PlatformClient {
+  private constructor();
+  free(): void;
+  state(): StateClient;
+  /**
+   * Load feature flags into the client
+   */
+  load_flags(flags: FeatureFlags): void;
+}
+/**
+ * This module represents a stopgap solution to provide access to primitive crypto functions for JS
+ * clients. It is not intended to be used outside of the JS clients and this pattern should not be
+ * proliferated. It is necessary because we want to use SDK crypto prior to the SDK being fully
+ * responsible for state and keys.
+ */
+export class PureCrypto {
+  private constructor();
+  free(): void;
+  /**
+   * DEPRECATED: Use `symmetric_decrypt_string` instead.
+   * Cleanup ticket: <https://bitwarden.atlassian.net/browse/PM-21247>
+   */
+  static symmetric_decrypt(enc_string: string, key: Uint8Array): string;
+  static symmetric_decrypt_string(enc_string: string, key: Uint8Array): string;
+  static symmetric_decrypt_bytes(enc_string: string, key: Uint8Array): Uint8Array;
+  /**
+   * DEPRECATED: Use `symmetric_decrypt_filedata` instead.
+   * Cleanup ticket: <https://bitwarden.atlassian.net/browse/PM-21247>
+   */
+  static symmetric_decrypt_array_buffer(enc_bytes: Uint8Array, key: Uint8Array): Uint8Array;
+  static symmetric_decrypt_filedata(enc_bytes: Uint8Array, key: Uint8Array): Uint8Array;
+  static symmetric_encrypt_string(plain: string, key: Uint8Array): string;
+  /**
+   * DEPRECATED: Only used by send keys
+   */
+  static symmetric_encrypt_bytes(plain: Uint8Array, key: Uint8Array): string;
+  static symmetric_encrypt_filedata(plain: Uint8Array, key: Uint8Array): Uint8Array;
+  static decrypt_user_key_with_master_password(
+    encrypted_user_key: string,
+    master_password: string,
+    email: string,
+    kdf: Kdf,
+  ): Uint8Array;
+  static encrypt_user_key_with_master_password(
+    user_key: Uint8Array,
+    master_password: string,
+    email: string,
+    kdf: Kdf,
+  ): string;
+  static make_user_key_aes256_cbc_hmac(): Uint8Array;
+  static make_user_key_xchacha20_poly1305(): Uint8Array;
+  /**
+   * Wraps (encrypts) a symmetric key using a symmetric wrapping key, returning the wrapped key
+   * as an EncString.
+   */
+  static wrap_symmetric_key(key_to_be_wrapped: Uint8Array, wrapping_key: Uint8Array): string;
+  /**
+   * Unwraps (decrypts) a wrapped symmetric key using a symmetric wrapping key, returning the
+   * unwrapped key as a serialized byte array.
+   */
+  static unwrap_symmetric_key(wrapped_key: string, wrapping_key: Uint8Array): Uint8Array;
+  /**
+   * Wraps (encrypts) an SPKI DER encoded encapsulation (public) key using a symmetric wrapping
+   * key. Note: Usually, a public key is - by definition - public, so this should not be
+   * used. The specific use-case for this function is to enable rotateable key sets, where
+   * the "public key" is not public, with the intent of preventing the server from being able
+   * to overwrite the user key unlocked by the rotateable keyset.
+   */
+  static wrap_encapsulation_key(encapsulation_key: Uint8Array, wrapping_key: Uint8Array): string;
+  /**
+   * Unwraps (decrypts) a wrapped SPKI DER encoded encapsulation (public) key using a symmetric
+   * wrapping key.
+   */
+  static unwrap_encapsulation_key(wrapped_key: string, wrapping_key: Uint8Array): Uint8Array;
+  /**
+   * Wraps (encrypts) a PKCS8 DER encoded decapsulation (private) key using a symmetric wrapping
+   * key,
+   */
+  static wrap_decapsulation_key(decapsulation_key: Uint8Array, wrapping_key: Uint8Array): string;
+  /**
+   * Unwraps (decrypts) a wrapped PKCS8 DER encoded decapsulation (private) key using a symmetric
+   * wrapping key.
+   */
+  static unwrap_decapsulation_key(wrapped_key: string, wrapping_key: Uint8Array): Uint8Array;
+  /**
+   * Encapsulates (encrypts) a symmetric key using an asymmetric encapsulation key (public key)
+   * in SPKI format, returning the encapsulated key as a string. Note: This is unsigned, so
+   * the sender's authenticity cannot be verified by the recipient.
+   */
+  static encapsulate_key_unsigned(shared_key: Uint8Array, encapsulation_key: Uint8Array): string;
+  /**
+   * Decapsulates (decrypts) a symmetric key using an decapsulation key (private key) in PKCS8
+   * DER format. Note: This is unsigned, so the sender's authenticity cannot be verified by the
+   * recipient.
+   */
+  static decapsulate_key_unsigned(
+    encapsulated_key: string,
+    decapsulation_key: Uint8Array,
+  ): Uint8Array;
+  /**
+   * Given a wrapped signing key and the symmetric key it is wrapped with, this returns
+   * the corresponding verifying key.
+   */
+  static verifying_key_for_signing_key(signing_key: string, wrapping_key: Uint8Array): Uint8Array;
+  /**
+   * Returns the algorithm used for the given verifying key.
+   */
+  static key_algorithm_for_verifying_key(verifying_key: Uint8Array): SignatureAlgorithm;
+  /**
+   * For a given signing identity (verifying key), this function verifies that the signing
+   * identity claimed ownership of the public key. This is a one-sided claim and merely shows
+   * that the signing identity has the intent to receive messages encrypted to the public
+   * key.
+   */
+  static verify_and_unwrap_signed_public_key(
+    signed_public_key: Uint8Array,
+    verifying_key: Uint8Array,
+  ): Uint8Array;
+  /**
+   * Derive output of the KDF for a [bitwarden_crypto::Kdf] configuration.
+   */
+  static derive_kdf_material(password: Uint8Array, salt: Uint8Array, kdf: Kdf): Uint8Array;
+  static decrypt_user_key_with_master_key(
+    encrypted_user_key: string,
+    master_key: Uint8Array,
+  ): Uint8Array;
+}
+/**
+ * The `SendAccessClient` is used to interact with the Bitwarden API to get send access tokens.
+ */
+export class SendAccessClient {
+  private constructor();
+  free(): void;
+  /**
+   * Requests a new send access token.
+   */
+  request_send_access_token(request: SendAccessTokenRequest): Promise<SendAccessTokenResponse>;
+}
+export class StateClient {
+  private constructor();
+  free(): void;
+  register_cipher_repository(cipher_repository: any): void;
+  register_folder_repository(store: any): void;
+  register_client_managed_repositories(repositories: Repositories): void;
+  /**
+   * Initialize the database for SDK managed repositories.
+   */
+  initialize_state(configuration: IndexedDbConfiguration): Promise<void>;
+}
+export class TotpClient {
+  private constructor();
+  free(): void;
+  /**
+   * Generates a TOTP code from a provided key
+   *
+   * # Arguments
+   * - `key` - Can be:
+   *     - A base32 encoded string
+   *     - OTP Auth URI
+   *     - Steam URI
+   * - `time_ms` - Optional timestamp in milliseconds
+   */
+  generate_totp(key: string, time_ms?: number | null): TotpResponse;
 }
-export class ClientVault {
+export class VaultClient {
   private constructor();
   free(): void;
-  folders(): ClientFolders;
+  /**
+   * Attachment related operations.
+   */
+  attachments(): AttachmentsClient;
+  /**
+   * Cipher related operations.
+   */
+  ciphers(): CiphersClient;
+  /**
+   * Folder related operations.
+   */
+  folders(): FoldersClient;
+  /**
+   * TOTP related operations.
+   */
+  totp(): TotpClient;
+  /**
+   * Collection related operations.
+   */
+  collections(): CollectionsClient;
 }