@bitwarden/sdk-internal 0.1.2 → 0.1.4

package/node/bitwarden_wasm_internal.d.ts

@@ -0,0 +1,222 @@
+/* tslint:disable */
+/* eslint-disable */
+export enum LogLevel {
+  Trace = 0,
+  Debug = 1,
+  Info = 2,
+  Warn = 3,
+  Error = 4,
+}
+export interface InitUserCryptoRequest {
+  /**
+   * The user\'s KDF parameters, as received from the prelogin request
+   */
+  kdfParams: Kdf;
+  /**
+   * The user\'s email address
+   */
+  email: string;
+  /**
+   * The user\'s encrypted private key
+   */
+  privateKey: string;
+  /**
+   * The initialization method to use
+   */
+  method: InitUserCryptoMethod;
+}
+
+export type InitUserCryptoMethod =
+  | { password: { password: string; user_key: string } }
+  | { decryptedKey: { decrypted_user_key: string } }
+  | { pin: { pin: string; pin_protected_user_key: EncString } }
+  | { authRequest: { request_private_key: string; method: AuthRequestMethod } }
+  | {
+      deviceKey: {
+        device_key: string;
+        protected_device_private_key: EncString;
+        device_protected_user_key: AsymmetricEncString;
+      };
+    }
+  | { keyConnector: { master_key: string; user_key: string } };
+
+export type AuthRequestMethod =
+  | { userKey: { protected_user_key: AsymmetricEncString } }
+  | { masterKey: { protected_master_key: AsymmetricEncString; auth_request_key: EncString } };
+
+export interface InitOrgCryptoRequest {
+  /**
+   * The encryption keys for all the organizations the user is a part of
+   */
+  organizationKeys: Map<Uuid, AsymmetricEncString>;
+}
+
+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";
+
+/**
+ * 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();
+ * ```
+ */
+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;
+}
+
+export type AsymmetricEncString = string;
+
+export type EncString = string;
+
+/**
+ * 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 Folder {
+  id: Uuid | undefined;
+  name: EncString;
+  revisionDate: DateTime<Utc>;
+}
+
+export interface FolderView {
+  id: Uuid | undefined;
+  name: string;
+  revisionDate: DateTime<Utc>;
+}
+
+export type Uuid = string;
+
+/**
+ * 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 class BitwardenClient {
+  free(): void;
+  /**
+   * @param {ClientSettings | undefined} [settings]
+   * @param {LogLevel | undefined} [log_level]
+   */
+  constructor(settings?: ClientSettings, log_level?: LogLevel);
+  /**
+   * Test method, echoes back the input
+   * @param {string} msg
+   * @returns {string}
+   */
+  echo(msg: string): string;
+  /**
+   * Test method, calls http endpoint
+   * @param {string} url
+   * @returns {Promise<string>}
+   */
+  http_get(url: string): Promise<string>;
+  /**
+   * @returns {ClientCrypto}
+   */
+  crypto(): ClientCrypto;
+  /**
+   * @returns {ClientVault}
+   */
+  vault(): ClientVault;
+}
+export class ClientCrypto {
+  free(): void;
+  /**
+   * Initialization method for the user crypto. Needs to be called before any other crypto
+   * operations.
+   * @param {InitUserCryptoRequest} req
+   * @returns {Promise<void>}
+   */
+  initialize_user_crypto(req: InitUserCryptoRequest): Promise<void>;
+  /**
+   * Initialization method for the organization crypto. Needs to be called after
+   * `initialize_user_crypto` but before any other crypto operations.
+   * @param {InitOrgCryptoRequest} req
+   * @returns {Promise<void>}
+   */
+  initialize_org_crypto(req: InitOrgCryptoRequest): Promise<void>;
+}
+export class ClientFolders {
+  free(): void;
+  /**
+   * Decrypt folder
+   * @param {Folder} folder
+   * @returns {FolderView}
+   */
+  decrypt(folder: Folder): FolderView;
+}
+export class ClientVault {
+  free(): void;
+  /**
+   * @returns {ClientFolders}
+   */
+  folders(): ClientFolders;
+}