@bitwarden/sdk-internal 0.2.0-main.159 → 0.2.0-main.160

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/VERSION CHANGED
@@ -1 +1 @@
1
- c6835e59d5abdd50a117729dd718a23029a71ad8
1
+ 08722745ba9689df9505591848cd26d4f54c01e9
@@ -338,6 +338,19 @@ export interface ExportError extends Error {
338
338
 
339
339
  export function isExportError(error: any): error is ExportError;
340
340
 
341
+ export type UsernameGeneratorRequest =
342
+ | { word: { capitalize: boolean; include_number: boolean } }
343
+ | { subaddress: { type: AppendType; email: string } }
344
+ | { catchall: { type: AppendType; domain: string } }
345
+ | { forwarded: { service: ForwarderServiceType; website: string | undefined } };
346
+
347
+ export interface UsernameError extends Error {
348
+ name: "UsernameError";
349
+ variant: "InvalidApiKey" | "Unknown" | "ResponseContent" | "Reqwest";
350
+ }
351
+
352
+ export function isUsernameError(error: any): error is UsernameError;
353
+
341
354
  /**
342
355
  * Password generator request options.
343
356
  */
@@ -1089,27 +1102,57 @@ export class GeneratorClient {
1089
1102
  private constructor();
1090
1103
  free(): void;
1091
1104
  /**
1092
- * Generates a password from a provided request
1105
+ * Generates a random password.
1093
1106
  *
1094
- * # Arguments
1095
- * - `request` - Settings for the character sets and password length
1107
+ * The character sets and password length can be customized using the `input` parameter.
1096
1108
  *
1097
- * # Returns
1098
- * - `Ok(String)` containing the generated password
1099
- * - `Err(PasswordError)` if password generation fails
1100
- */
1101
- password(request: PasswordGeneratorRequest): string;
1102
- /**
1103
- * Generates a passphrase from a provided request
1109
+ * # Examples
1104
1110
  *
1105
- * # Arguments
1106
- * - `request` - Settings for the word count, word separators character sets
1111
+ * ```
1112
+ * use bitwarden_core::Client;
1113
+ * use bitwarden_generators::{GeneratorClientsExt, PassphraseError, PasswordGeneratorRequest};
1107
1114
  *
1108
- * # Returns
1109
- * - `Ok(String)` containing the generated passphrase
1110
- * - `Err(PassphraseError)` if passphrase generation fails
1111
- */
1112
- passphrase(request: PassphraseGeneratorRequest): string;
1115
+ * async fn test() -> Result<(), PassphraseError> {
1116
+ * let input = PasswordGeneratorRequest {
1117
+ * lowercase: true,
1118
+ * uppercase: true,
1119
+ * numbers: true,
1120
+ * length: 20,
1121
+ * ..Default::default()
1122
+ * };
1123
+ * let password = Client::new(None).generator().password(input).unwrap();
1124
+ * println!("{}", password);
1125
+ * Ok(())
1126
+ * }
1127
+ * ```
1128
+ */
1129
+ password(input: PasswordGeneratorRequest): string;
1130
+ /**
1131
+ * Generates a random passphrase.
1132
+ * A passphrase is a combination of random words separated by a character.
1133
+ * An example of passphrase is `correct horse battery staple`.
1134
+ *
1135
+ * The number of words and their case, the word separator, and the inclusion of
1136
+ * a number in the passphrase can be customized using the `input` parameter.
1137
+ *
1138
+ * # Examples
1139
+ *
1140
+ * ```
1141
+ * use bitwarden_core::Client;
1142
+ * use bitwarden_generators::{GeneratorClientsExt, PassphraseError, PassphraseGeneratorRequest};
1143
+ *
1144
+ * async fn test() -> Result<(), PassphraseError> {
1145
+ * let input = PassphraseGeneratorRequest {
1146
+ * num_words: 4,
1147
+ * ..Default::default()
1148
+ * };
1149
+ * let passphrase = Client::new(None).generator().passphrase(input).unwrap();
1150
+ * println!("{}", passphrase);
1151
+ * Ok(())
1152
+ * }
1153
+ * ```
1154
+ */
1155
+ passphrase(input: PassphraseGeneratorRequest): string;
1113
1156
  }
1114
1157
  export class IncomingMessage {
1115
1158
  free(): void;
@@ -309,6 +309,19 @@ export function isExportError(error) {
309
309
  }
310
310
  }
311
311
 
312
+ /**
313
+ * @param {any} error
314
+ * @returns {boolean}
315
+ */
316
+ export function isUsernameError(error) {
317
+ try {
318
+ const ret = wasm.isUsernameError(addBorrowedObject(error));
319
+ return ret !== 0;
320
+ } finally {
321
+ heap[stack_pointer++] = undefined;
322
+ }
323
+ }
324
+
312
325
  /**
313
326
  * @param {any} error
314
327
  * @returns {boolean}
@@ -600,7 +613,7 @@ function __wbg_adapter_53(arg0, arg1, arg2) {
600
613
  );
601
614
  }
602
615
 
603
- function __wbg_adapter_237(arg0, arg1, arg2, arg3) {
616
+ function __wbg_adapter_238(arg0, arg1, arg2, arg3) {
604
617
  wasm.wasm_bindgen__convert__closures__invoke2_mut__h2a33b0877ef96682(
605
618
  arg0,
606
619
  arg1,
@@ -936,7 +949,7 @@ export class BitwardenClient {
936
949
  * @returns {GeneratorClient}
937
950
  */
938
951
  generator() {
939
- const ret = wasm.bitwardenclient_generator(this.__wbg_ptr);
952
+ const ret = wasm.bitwardenclient_crypto(this.__wbg_ptr);
940
953
  return GeneratorClient.__wrap(ret);
941
954
  }
942
955
  /**
@@ -1485,23 +1498,38 @@ export class GeneratorClient {
1485
1498
  wasm.__wbg_generatorclient_free(ptr, 0);
1486
1499
  }
1487
1500
  /**
1488
- * Generates a password from a provided request
1501
+ * Generates a random password.
1489
1502
  *
1490
- * # Arguments
1491
- * - `request` - Settings for the character sets and password length
1503
+ * The character sets and password length can be customized using the `input` parameter.
1492
1504
  *
1493
- * # Returns
1494
- * - `Ok(String)` containing the generated password
1495
- * - `Err(PasswordError)` if password generation fails
1496
- * @param {PasswordGeneratorRequest} request
1505
+ * # Examples
1506
+ *
1507
+ * ```
1508
+ * use bitwarden_core::Client;
1509
+ * use bitwarden_generators::{GeneratorClientsExt, PassphraseError, PasswordGeneratorRequest};
1510
+ *
1511
+ * async fn test() -> Result<(), PassphraseError> {
1512
+ * let input = PasswordGeneratorRequest {
1513
+ * lowercase: true,
1514
+ * uppercase: true,
1515
+ * numbers: true,
1516
+ * length: 20,
1517
+ * ..Default::default()
1518
+ * };
1519
+ * let password = Client::new(None).generator().password(input).unwrap();
1520
+ * println!("{}", password);
1521
+ * Ok(())
1522
+ * }
1523
+ * ```
1524
+ * @param {PasswordGeneratorRequest} input
1497
1525
  * @returns {string}
1498
1526
  */
1499
- password(request) {
1527
+ password(input) {
1500
1528
  let deferred2_0;
1501
1529
  let deferred2_1;
1502
1530
  try {
1503
1531
  const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
1504
- wasm.generatorclient_password(retptr, this.__wbg_ptr, addHeapObject(request));
1532
+ wasm.generatorclient_password(retptr, this.__wbg_ptr, addHeapObject(input));
1505
1533
  var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
1506
1534
  var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
1507
1535
  var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
@@ -1522,23 +1550,38 @@ export class GeneratorClient {
1522
1550
  }
1523
1551
  }
1524
1552
  /**
1525
- * Generates a passphrase from a provided request
1553
+ * Generates a random passphrase.
1554
+ * A passphrase is a combination of random words separated by a character.
1555
+ * An example of passphrase is `correct horse battery staple`.
1526
1556
  *
1527
- * # Arguments
1528
- * - `request` - Settings for the word count, word separators character sets
1557
+ * The number of words and their case, the word separator, and the inclusion of
1558
+ * a number in the passphrase can be customized using the `input` parameter.
1529
1559
  *
1530
- * # Returns
1531
- * - `Ok(String)` containing the generated passphrase
1532
- * - `Err(PassphraseError)` if passphrase generation fails
1533
- * @param {PassphraseGeneratorRequest} request
1560
+ * # Examples
1561
+ *
1562
+ * ```
1563
+ * use bitwarden_core::Client;
1564
+ * use bitwarden_generators::{GeneratorClientsExt, PassphraseError, PassphraseGeneratorRequest};
1565
+ *
1566
+ * async fn test() -> Result<(), PassphraseError> {
1567
+ * let input = PassphraseGeneratorRequest {
1568
+ * num_words: 4,
1569
+ * ..Default::default()
1570
+ * };
1571
+ * let passphrase = Client::new(None).generator().passphrase(input).unwrap();
1572
+ * println!("{}", passphrase);
1573
+ * Ok(())
1574
+ * }
1575
+ * ```
1576
+ * @param {PassphraseGeneratorRequest} input
1534
1577
  * @returns {string}
1535
1578
  */
1536
- passphrase(request) {
1579
+ passphrase(input) {
1537
1580
  let deferred2_0;
1538
1581
  let deferred2_1;
1539
1582
  try {
1540
1583
  const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
1541
- wasm.generatorclient_passphrase(retptr, this.__wbg_ptr, addHeapObject(request));
1584
+ wasm.generatorclient_passphrase(retptr, this.__wbg_ptr, addHeapObject(input));
1542
1585
  var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
1543
1586
  var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
1544
1587
  var r2 = getDataViewMemory0().getInt32(retptr + 4 * 2, true);
@@ -2654,7 +2697,7 @@ export function __wbg_new_23a2665fac83c611(arg0, arg1) {
2654
2697
  const a = state0.a;
2655
2698
  state0.a = 0;
2656
2699
  try {
2657
- return __wbg_adapter_237(a, state0.b, arg0, arg1);
2700
+ return __wbg_adapter_238(a, state0.b, arg0, arg1);
2658
2701
  } finally {
2659
2702
  state0.a = a;
2660
2703
  }
@@ -3021,13 +3064,13 @@ export function __wbindgen_cb_drop(arg0) {
3021
3064
  return ret;
3022
3065
  }
3023
3066
 
3024
- export function __wbindgen_closure_wrapper2876(arg0, arg1, arg2) {
3025
- const ret = makeMutClosure(arg0, arg1, 664, __wbg_adapter_50);
3067
+ export function __wbindgen_closure_wrapper2889(arg0, arg1, arg2) {
3068
+ const ret = makeMutClosure(arg0, arg1, 669, __wbg_adapter_50);
3026
3069
  return addHeapObject(ret);
3027
3070
  }
3028
3071
 
3029
- export function __wbindgen_closure_wrapper3269(arg0, arg1, arg2) {
3030
- const ret = makeMutClosure(arg0, arg1, 786, __wbg_adapter_53);
3072
+ export function __wbindgen_closure_wrapper3282(arg0, arg1, arg2) {
3073
+ const ret = makeMutClosure(arg0, arg1, 791, __wbg_adapter_53);
3031
3074
  return addHeapObject(ret);
3032
3075
  }
3033
3076
 
Binary file
@@ -31,6 +31,10 @@ export const exporterclient_export_cxf: (
31
31
  ) => void;
32
32
  export const exporterclient_import_cxf: (a: number, b: number, c: number, d: number) => void;
33
33
  export const isExportError: (a: number) => number;
34
+ export const __wbg_generatorclient_free: (a: number, b: number) => void;
35
+ export const generatorclient_password: (a: number, b: number, c: number) => void;
36
+ export const generatorclient_passphrase: (a: number, b: number, c: number) => void;
37
+ export const isUsernameError: (a: number) => number;
34
38
  export const isPasswordError: (a: number) => number;
35
39
  export const isPassphraseError: (a: number) => number;
36
40
  export const __wbg_outgoingmessage_free: (a: number, b: number) => void;
@@ -105,13 +109,10 @@ export const bitwardenclient_version: (a: number, b: number) => void;
105
109
  export const bitwardenclient_throw: (a: number, b: number, c: number, d: number) => void;
106
110
  export const bitwardenclient_http_get: (a: number, b: number, c: number) => number;
107
111
  export const bitwardenclient_crypto: (a: number) => number;
108
- export const bitwardenclient_generator: (a: number) => number;
109
112
  export const cryptoclient_initialize_user_crypto: (a: number, b: number) => number;
110
113
  export const cryptoclient_initialize_org_crypto: (a: number, b: number) => number;
111
114
  export const cryptoclient_make_key_pair: (a: number, b: number, c: number, d: number) => void;
112
115
  export const cryptoclient_verify_asymmetric_keys: (a: number, b: number, c: number) => void;
113
- export const generatorclient_password: (a: number, b: number, c: number) => void;
114
- export const generatorclient_passphrase: (a: number, b: number, c: number) => void;
115
116
  export const set_log_level: (a: number) => void;
116
117
  export const init_sdk: (a: number) => void;
117
118
  export const __wbg_purecrypto_free: (a: number, b: number) => void;
@@ -179,10 +180,10 @@ export const vaultclient_attachments: (a: number) => number;
179
180
  export const vaultclient_totp: (a: number) => number;
180
181
  export const isTestError: (a: number) => number;
181
182
  export const bitwardenclient_vault: (a: number) => number;
183
+ export const bitwardenclient_generator: (a: number) => number;
182
184
  export const bitwardenclient_exporters: (a: number) => number;
183
185
  export const vaultclient_ciphers: (a: number) => number;
184
186
  export const vaultclient_folders: (a: number) => number;
185
- export const __wbg_generatorclient_free: (a: number, b: number) => void;
186
187
  export const __wbg_vaultclient_free: (a: number, b: number) => void;
187
188
  export const __wbg_totpclient_free: (a: number, b: number) => void;
188
189
  export const __wbg_foldersclient_free: (a: number, b: number) => void;