@bitwarden/sdk-internal 0.2.0-main.297 → 0.2.0-main.298

package/node/bitwarden_wasm_internal.d.ts

@@ -179,6 +179,138 @@ export interface TestError extends Error {
 
 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`
  */
@@ -1915,13 +2047,16 @@ export class PureCrypto {
    */
   static derive_kdf_material(password: Uint8Array, salt: Uint8Array, kdf: Kdf): Uint8Array;
 }
+/**
+ * The `SendAccessClient` is used to interact with the Bitwarden API to get send access tokens.
+ */
 export class SendAccessClient {
   private constructor();
   free(): void;
   /**
-   * Request an access token for the provided send
+   * Requests a new send access token.
    */
-  request_send_access_token(request: string): Promise<string>;
+  request_send_access_token(request: SendAccessTokenRequest): Promise<SendAccessTokenResponse>;
 }
 export class StateClient {
   private constructor();

package/node/bitwarden_wasm_internal.js

@@ -828,7 +828,7 @@ module.exports.isEncryptFileError = function (error) {
 };
 
 function __wbg_adapter_54(arg0, arg1, arg2) {
-  wasm._dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h6a23de37c0a4c025(
+  wasm._dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hb3d7232059e1cc02(
     arg0,
     arg1,
     addHeapObject(arg2),
@@ -838,7 +838,7 @@ function __wbg_adapter_54(arg0, arg1, arg2) {
 function __wbg_adapter_57(arg0, arg1, arg2) {
   try {
     const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-    wasm._dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h3dbaf14f9a6d0ccb(
+    wasm._dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h0165cee9349ff8be(
       retptr,
       arg0,
       arg1,
@@ -3701,7 +3701,9 @@ const SendAccessClientFinalization =
   typeof FinalizationRegistry === "undefined"
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry((ptr) => wasm.__wbg_sendaccessclient_free(ptr >>> 0, 1));
-
+/**
+ * The `SendAccessClient` is used to interact with the Bitwarden API to get send access tokens.
+ */
 class SendAccessClient {
   static __wrap(ptr) {
     ptr = ptr >>> 0;
@@ -3723,14 +3725,15 @@ class SendAccessClient {
     wasm.__wbg_sendaccessclient_free(ptr, 0);
   }
   /**
-   * Request an access token for the provided send
-   * @param {string} request
-   * @returns {Promise<string>}
+   * Requests a new send access token.
+   * @param {SendAccessTokenRequest} request
+   * @returns {Promise<SendAccessTokenResponse>}
    */
   request_send_access_token(request) {
-    const ptr0 = passStringToWasm0(request, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-    const len0 = WASM_VECTOR_LEN;
-    const ret = wasm.sendaccessclient_request_send_access_token(this.__wbg_ptr, ptr0, len0);
+    const ret = wasm.sendaccessclient_request_send_access_token(
+      this.__wbg_ptr,
+      addHeapObject(request),
+    );
     return takeObject(ret);
   }
 }
@@ -3971,6 +3974,13 @@ module.exports.__wbg_append_b44785ebeb668479 = function () {
   }, arguments);
 };
 
+module.exports.__wbg_arrayBuffer_d1b44c4390db422f = function () {
+  return handleError(function (arg0) {
+    const ret = getObject(arg0).arrayBuffer();
+    return addHeapObject(ret);
+  }, arguments);
+};
+
 module.exports.__wbg_buffer_609cc3eee51ed158 = function (arg0) {
   const ret = getObject(arg0).buffer;
   return addHeapObject(ret);
@@ -4076,7 +4086,7 @@ module.exports.__wbg_getTime_46267b1c24877e30 = function (arg0) {
   return ret;
 };
 
-module.exports.__wbg_get_484769665c8b04d7 = function () {
+module.exports.__wbg_get_5954c491716c2aba = function () {
   return handleError(function (arg0, arg1, arg2) {
     let deferred0_0;
     let deferred0_1;
@@ -4103,7 +4113,7 @@ module.exports.__wbg_get_b9b93047fe3cf45b = function (arg0, arg1) {
   return addHeapObject(ret);
 };
 
-module.exports.__wbg_get_de8d5678adfaf755 = function () {
+module.exports.__wbg_get_f292da1aaf91a9f6 = function () {
   return handleError(function (arg0, arg1, arg2) {
     let deferred0_0;
     let deferred0_1;
@@ -4118,7 +4128,7 @@ module.exports.__wbg_get_de8d5678adfaf755 = function () {
   }, arguments);
 };
 
-module.exports.__wbg_getaccesstoken_96168db7f6c5341e = function (arg0) {
+module.exports.__wbg_getaccesstoken_83d6cb0a610d80fb = function (arg0) {
   const ret = getObject(arg0).get_access_token();
   return addHeapObject(ret);
 };
@@ -4303,14 +4313,14 @@ module.exports.__wbg_length_e2d2a49132c1b256 = function (arg0) {
   return ret;
 };
 
-module.exports.__wbg_list_8f027b1e8d6eeabd = function () {
+module.exports.__wbg_list_c75c44aded6fb0ed = function () {
   return handleError(function (arg0) {
     const ret = getObject(arg0).list();
     return addHeapObject(ret);
   }, arguments);
 };
 
-module.exports.__wbg_list_dc4b0ecf24e8c2e6 = function () {
+module.exports.__wbg_list_f22b3fc3f932db50 = function () {
   return handleError(function (arg0) {
     const ret = getObject(arg0).list();
     return addHeapObject(ret);
@@ -4511,7 +4521,7 @@ module.exports.__wbg_randomFillSync_ac0988aba3254290 = function () {
   }, arguments);
 };
 
-module.exports.__wbg_remove_6a18bbab25f54853 = function () {
+module.exports.__wbg_remove_2860ca0121286728 = function () {
   return handleError(function (arg0, arg1, arg2) {
     let deferred0_0;
     let deferred0_1;
@@ -4526,7 +4536,7 @@ module.exports.__wbg_remove_6a18bbab25f54853 = function () {
   }, arguments);
 };
 
-module.exports.__wbg_remove_a2c151845405193a = function () {
+module.exports.__wbg_remove_4b6c3a289bd83e64 = function () {
   return handleError(function (arg0, arg1, arg2) {
     let deferred0_0;
     let deferred0_1;
@@ -4572,19 +4582,7 @@ module.exports.__wbg_setTimeout_ca12ead8b48245e2 = function (arg0, arg1) {
   return addHeapObject(ret);
 };
 
-module.exports.__wbg_set_37837023f3d740e8 = function (arg0, arg1, arg2) {
-  getObject(arg0)[arg1 >>> 0] = takeObject(arg2);
-};
-
-module.exports.__wbg_set_3f1d0b984ed272ed = function (arg0, arg1, arg2) {
-  getObject(arg0)[takeObject(arg1)] = takeObject(arg2);
-};
-
-module.exports.__wbg_set_65595bdd868b3009 = function (arg0, arg1, arg2) {
-  getObject(arg0).set(getObject(arg1), arg2 >>> 0);
-};
-
-module.exports.__wbg_set_8136ddb4c6a06792 = function () {
+module.exports.__wbg_set_2e736aaa4683c4c3 = function () {
   return handleError(function (arg0, arg1, arg2, arg3) {
     let deferred0_0;
     let deferred0_1;
@@ -4599,12 +4597,24 @@ module.exports.__wbg_set_8136ddb4c6a06792 = function () {
   }, arguments);
 };
 
+module.exports.__wbg_set_37837023f3d740e8 = function (arg0, arg1, arg2) {
+  getObject(arg0)[arg1 >>> 0] = takeObject(arg2);
+};
+
+module.exports.__wbg_set_3f1d0b984ed272ed = function (arg0, arg1, arg2) {
+  getObject(arg0)[takeObject(arg1)] = takeObject(arg2);
+};
+
+module.exports.__wbg_set_65595bdd868b3009 = function (arg0, arg1, arg2) {
+  getObject(arg0).set(getObject(arg1), arg2 >>> 0);
+};
+
 module.exports.__wbg_set_8fc6bf8a5b1071d1 = function (arg0, arg1, arg2) {
   const ret = getObject(arg0).set(getObject(arg1), getObject(arg2));
   return addHeapObject(ret);
 };
 
-module.exports.__wbg_set_951bbfd8bc802f55 = function () {
+module.exports.__wbg_set_e4e1569b3197663a = function () {
   return handleError(function (arg0, arg1, arg2, arg3) {
     let deferred0_0;
     let deferred0_1;
@@ -4829,28 +4839,28 @@ module.exports.__wbindgen_cb_drop = function (arg0) {
   return ret;
 };
 
-module.exports.__wbindgen_closure_wrapper187 = function (arg0, arg1, arg2) {
+module.exports.__wbindgen_closure_wrapper188 = function (arg0, arg1, arg2) {
   const ret = makeMutClosure(arg0, arg1, 7, __wbg_adapter_54);
   return addHeapObject(ret);
 };
 
-module.exports.__wbindgen_closure_wrapper189 = function (arg0, arg1, arg2) {
+module.exports.__wbindgen_closure_wrapper190 = function (arg0, arg1, arg2) {
   const ret = makeMutClosure(arg0, arg1, 7, __wbg_adapter_57);
   return addHeapObject(ret);
 };
 
-module.exports.__wbindgen_closure_wrapper3594 = function (arg0, arg1, arg2) {
-  const ret = makeMutClosure(arg0, arg1, 290, __wbg_adapter_60);
+module.exports.__wbindgen_closure_wrapper3761 = function (arg0, arg1, arg2) {
+  const ret = makeMutClosure(arg0, arg1, 294, __wbg_adapter_60);
   return addHeapObject(ret);
 };
 
-module.exports.__wbindgen_closure_wrapper5956 = function (arg0, arg1, arg2) {
-  const ret = makeMutClosure(arg0, arg1, 315, __wbg_adapter_60);
+module.exports.__wbindgen_closure_wrapper6113 = function (arg0, arg1, arg2) {
+  const ret = makeMutClosure(arg0, arg1, 319, __wbg_adapter_60);
   return addHeapObject(ret);
 };
 
-module.exports.__wbindgen_closure_wrapper6337 = function (arg0, arg1, arg2) {
-  const ret = makeMutClosure(arg0, arg1, 339, __wbg_adapter_54);
+module.exports.__wbindgen_closure_wrapper6494 = function (arg0, arg1, arg2) {
+  const ret = makeMutClosure(arg0, arg1, 342, __wbg_adapter_54);
   return addHeapObject(ret);
 };
 

package/node/bitwarden_wasm_internal_bg.wasm.d.ts

@@ -175,11 +175,7 @@ export const import_ssh_key: (a: number, b: number, c: number, d: number, e: num
 export const isTestError: (a: number) => number;
 export const __wbg_authclient_free: (a: number, b: number) => void;
 export const authclient_send_access: (a: number) => number;
-export const sendaccessclient_request_send_access_token: (
-  a: number,
-  b: number,
-  c: number,
-) => number;
+export const sendaccessclient_request_send_access_token: (a: number, b: number) => number;
 export const isCollectionDecryptError: (a: number) => number;
 export const cryptoclient_initialize_user_crypto: (a: number, b: number) => number;
 export const cryptoclient_initialize_org_crypto: (a: number, b: number) => number;
@@ -398,12 +394,12 @@ export const __wbindgen_exn_store: (a: number) => void;
 export const __wbindgen_free: (a: number, b: number, c: number) => void;
 export const __wbindgen_export_4: WebAssembly.Table;
 export const __wbindgen_add_to_stack_pointer: (a: number) => number;
-export const _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h6a23de37c0a4c025: (
+export const _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hb3d7232059e1cc02: (
   a: number,
   b: number,
   c: number,
 ) => void;
-export const _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h3dbaf14f9a6d0ccb: (
+export const _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h0165cee9349ff8be: (
   a: number,
   b: number,
   c: number,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitwarden/sdk-internal",
-  "version": "0.2.0-main.297",
+  "version": "0.2.0-main.298",
   "license": "GPL-3.0",
   "repository": {
     "type": "git",