base32-key 1.0.8 → 1.1.0

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.
@@ -1,11 +1,23 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.fromHexString = void 0;
3
+ exports.fromHexString = exports.encodeBase32 = void 0;
4
+ const errors_1 = require("./errors");
5
+ const options_1 = require("./options");
4
6
  const utils_1 = require("./utils");
5
- function baseEncode(numArray, alphabet) {
6
- return numArray.map(alphabet.charAt.bind(alphabet)).join('');
7
+ function parseHexString(base16String) {
8
+ if (typeof base16String !== 'string') {
9
+ throw new TypeError('Invalid hex string: expected a string');
10
+ }
11
+ const hex = /^0x/i.test(base16String)
12
+ ? base16String.substring(2)
13
+ : base16String;
14
+ const base16Numbers = utils_1.baseDecode(hex.toLowerCase(), utils_1.BASE_16_DIGITS);
15
+ if (base16Numbers == null || base16Numbers.length === 0) {
16
+ throw new errors_1.Base32KeyError('INVALID_HEX', `Invalid hex string: "${base16String}"`);
17
+ }
18
+ return base16Numbers;
7
19
  }
8
- function encodeBase32(base32Numbers, grouped, checked, upperCase) {
20
+ function encodeBase32(base32Numbers, grouped, checked, upperCase, keepLeadingZeros = false) {
9
21
  const digits = upperCase ? utils_1.BASE_32_DIGITS : utils_1.BASE_32_DIGITS_LOWERCASE;
10
22
  if (grouped) {
11
23
  // This assumes base32num.length is a multiple of 4.
@@ -15,7 +27,7 @@ function encodeBase32(base32Numbers, grouped, checked, upperCase) {
15
27
  if (checked) {
16
28
  groupNum.push(utils_1.calculateCrc5(groupNum));
17
29
  }
18
- groups.push(baseEncode(groupNum, digits));
30
+ groups.push(utils_1.baseEncode(groupNum, digits));
19
31
  }
20
32
  return groups.join('-');
21
33
  }
@@ -24,12 +36,15 @@ function encodeBase32(base32Numbers, grouped, checked, upperCase) {
24
36
  base32Numbers.push(utils_1.calculateCrc5(base32Numbers));
25
37
  }
26
38
  let i = 0;
27
- while (i + 1 < base32Numbers.length && base32Numbers[i] == 0) {
39
+ while (!keepLeadingZeros &&
40
+ i + 1 < base32Numbers.length &&
41
+ base32Numbers[i] == 0) {
28
42
  ++i;
29
43
  }
30
- return baseEncode(base32Numbers.slice(i), digits);
44
+ return utils_1.baseEncode(base32Numbers.slice(i), digits);
31
45
  }
32
46
  }
47
+ exports.encodeBase32 = encodeBase32;
33
48
  function numberToBase32(input) {
34
49
  const base16Numbers = input.concat([]);
35
50
  while (base16Numbers.length % 5 != 0) {
@@ -49,38 +64,11 @@ function numberToBase32(input) {
49
64
  }
50
65
  return base32num;
51
66
  }
52
- // cspell: disable
53
- /**
54
- * Encode Base32 key from HexString
55
- *
56
- * ### Example (es module)
57
- * ```js
58
- * import { fromHexString } from 'base32-key'
59
- * console.log(fromHexString('c0ffee'))
60
- * // => '222ET-3ZZGN'
61
- * ```
62
- *
63
- * ### Example (commonjs)
64
- * ```js
65
- * var fromHexString = require('base32-key').fromHexString;
66
- * console.log(fromHexString('c0ffee'))
67
- * // => '222ET-3ZZGN'
68
- * ```
69
- *
70
- * @param base16String - Input HexString.
71
- * @param grouped - Split the result into groups.
72
- * @param checked - Include the checksum into Base32-Key.
73
- * @param upperCase - Use uppercase or lowercase Base32-Key.
74
- * @returns Base32-Key string.
75
- * @anotherNote Some other value.
76
- */
77
- // cspell: enable
78
- exports.fromHexString = (base16String, grouped = true, checked = true, upperCase = true) => {
79
- const base16Numbers = [...base16String].map((c) => {
80
- return parseInt(c, 16);
81
- });
67
+ function fromHexString(base16String, ...args) {
68
+ const { grouped, checked, upperCase } = options_1.resolveOptions(args);
69
+ const base16Numbers = parseHexString(base16String);
82
70
  const base32Numbers = numberToBase32(base16Numbers);
83
- const result = encodeBase32(base32Numbers, grouped, checked, upperCase);
84
- return result;
85
- };
86
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW5jb2RlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9lbmNvZGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsbUNBSWlCO0FBRWpCLFNBQVMsVUFBVSxDQUFDLFFBQTJCLEVBQUUsUUFBZ0I7SUFDL0QsT0FBTyxRQUFRLENBQUMsR0FBRyxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDO0FBQy9ELENBQUM7QUFFRCxTQUFTLFlBQVksQ0FDbkIsYUFBdUIsRUFDdkIsT0FBZ0IsRUFDaEIsT0FBZ0IsRUFDaEIsU0FBa0I7SUFFbEIsTUFBTSxNQUFNLEdBQUcsU0FBUyxDQUFDLENBQUMsQ0FBQyxzQkFBYyxDQUFDLENBQUMsQ0FBQyxnQ0FBd0IsQ0FBQztJQUNyRSxJQUFJLE9BQU8sRUFBRTtRQUNYLG9EQUFvRDtRQUNwRCxNQUFNLE1BQU0sR0FBRyxFQUFFLENBQUM7UUFDbEIsS0FBSyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxHQUFHLGFBQWEsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxJQUFJLENBQUMsRUFBRTtZQUNoRCxNQUFNLFFBQVEsR0FBRyxhQUFhLENBQUMsS0FBSyxDQUFDLENBQUMsRUFBRSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7WUFDL0MsSUFBSSxPQUFPLEVBQUU7Z0JBQ1gsUUFBUSxDQUFDLElBQUksQ0FBQyxxQkFBYSxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUM7YUFDeEM7WUFDRCxNQUFNLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxRQUFRLEVBQUUsTUFBTSxDQUFDLENBQUMsQ0FBQztTQUMzQztRQUNELE9BQU8sTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztLQUN6QjtTQUFNO1FBQ0wsSUFBSSxPQUFPLEVBQUU7WUFDWCxhQUFhLENBQUMsSUFBSSxDQUFDLHFCQUFhLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQztTQUNsRDtRQUNELElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUNWLE9BQU8sQ0FBQyxHQUFHLENBQUMsR0FBRyxhQUFhLENBQUMsTUFBTSxJQUFJLGFBQWEsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLEVBQUU7WUFDNUQsRUFBRSxDQUFDLENBQUM7U0FDTDtRQUNELE9BQU8sVUFBVSxDQUFDLGFBQWEsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLEVBQUUsTUFBTSxDQUFDLENBQUM7S0FDbkQ7QUFDSCxDQUFDO0FBRUQsU0FBUyxjQUFjLENBQUMsS0FBd0I7SUFDOUMsTUFBTSxhQUFhLEdBQUcsS0FBSyxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUV2QyxPQUFPLGFBQWEsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxJQUFJLENBQUMsRUFBRTtRQUNwQyxhQUFhLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDO0tBQzFCO0lBRUQsTUFBTSxTQUFTLEdBQUcsRUFBRSxDQUFDO0lBRXJCLEtBQUssSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsR0FBRyxhQUFhLENBQUMsTUFBTSxFQUFFLENBQUMsSUFBSSxDQUFDLEVBQUU7UUFDaEQsTUFBTSxJQUFJLEdBQ1IsQ0FBQyxhQUFhLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQztZQUM1QixDQUFDLGFBQWEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksRUFBRSxDQUFDO1lBQzVCLENBQUMsYUFBYSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDM0IsQ0FBQyxhQUFhLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUMzQixDQUFDLGFBQWEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDOUIsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksSUFBSSxFQUFFLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztRQUNsQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxJQUFJLEVBQUUsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDO1FBQ2xDLFNBQVMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLElBQUksQ0FBQyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7UUFDakMsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksSUFBSSxDQUFDLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztLQUNsQztJQUVELE9BQU8sU0FBUyxDQUFDO0FBQ25CLENBQUM7QUFFRCxrQkFBa0I7QUFDbEI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBdUJHO0FBRUgsaUJBQWlCO0FBQ0osUUFBQSxhQUFhLEdBQUcsQ0FDM0IsWUFBb0IsRUFDcEIsT0FBTyxHQUFHLElBQUksRUFDZCxPQUFPLEdBQUcsSUFBSSxFQUNkLFNBQVMsR0FBRyxJQUFJLEVBQ1IsRUFBRTtJQUNWLE1BQU0sYUFBYSxHQUFHLENBQUMsR0FBRyxZQUFZLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUUsRUFBRTtRQUNoRCxPQUFPLFFBQVEsQ0FBQyxDQUFDLEVBQUUsRUFBRSxDQUFDLENBQUM7SUFDekIsQ0FBQyxDQUFDLENBQUM7SUFDSCxNQUFNLGFBQWEsR0FBRyxjQUFjLENBQUMsYUFBYSxDQUFDLENBQUM7SUFDcEQsTUFBTSxNQUFNLEdBQUcsWUFBWSxDQUFDLGFBQWEsRUFBRSxPQUFPLEVBQUUsT0FBTyxFQUFFLFNBQVMsQ0FBQyxDQUFDO0lBQ3hFLE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUMsQ0FBQyJ9
71
+ return encodeBase32(base32Numbers, grouped, checked, upperCase);
72
+ }
73
+ exports.fromHexString = fromHexString;
74
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW5jb2RlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9lbmNvZGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEscUNBQTBDO0FBQzFDLHVDQUEwRDtBQUMxRCxtQ0FPaUI7QUFFakIsU0FBUyxjQUFjLENBQUMsWUFBb0I7SUFDMUMsSUFBSSxPQUFPLFlBQVksS0FBSyxRQUFRLEVBQUU7UUFDcEMsTUFBTSxJQUFJLFNBQVMsQ0FBQyx1Q0FBdUMsQ0FBQyxDQUFDO0tBQzlEO0lBQ0QsTUFBTSxHQUFHLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUM7UUFDbkMsQ0FBQyxDQUFDLFlBQVksQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDO1FBQzNCLENBQUMsQ0FBQyxZQUFZLENBQUM7SUFDakIsTUFBTSxhQUFhLEdBQUcsa0JBQVUsQ0FBQyxHQUFHLENBQUMsV0FBVyxFQUFFLEVBQUUsc0JBQWMsQ0FBQyxDQUFDO0lBQ3BFLElBQUksYUFBYSxJQUFJLElBQUksSUFBSSxhQUFhLENBQUMsTUFBTSxLQUFLLENBQUMsRUFBRTtRQUN2RCxNQUFNLElBQUksdUJBQWMsQ0FDdEIsYUFBYSxFQUNiLHdCQUF3QixZQUFZLEdBQUcsQ0FDeEMsQ0FBQztLQUNIO0lBQ0QsT0FBTyxhQUFhLENBQUM7QUFDdkIsQ0FBQztBQUVELFNBQWdCLFlBQVksQ0FDMUIsYUFBdUIsRUFDdkIsT0FBZ0IsRUFDaEIsT0FBZ0IsRUFDaEIsU0FBa0IsRUFDbEIsZ0JBQWdCLEdBQUcsS0FBSztJQUV4QixNQUFNLE1BQU0sR0FBRyxTQUFTLENBQUMsQ0FBQyxDQUFDLHNCQUFjLENBQUMsQ0FBQyxDQUFDLGdDQUF3QixDQUFDO0lBQ3JFLElBQUksT0FBTyxFQUFFO1FBQ1gsb0RBQW9EO1FBQ3BELE1BQU0sTUFBTSxHQUFHLEVBQUUsQ0FBQztRQUNsQixLQUFLLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEdBQUcsYUFBYSxDQUFDLE1BQU0sRUFBRSxDQUFDLElBQUksQ0FBQyxFQUFFO1lBQ2hELE1BQU0sUUFBUSxHQUFHLGFBQWEsQ0FBQyxLQUFLLENBQUMsQ0FBQyxFQUFFLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztZQUMvQyxJQUFJLE9BQU8sRUFBRTtnQkFDWCxRQUFRLENBQUMsSUFBSSxDQUFDLHFCQUFhLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQzthQUN4QztZQUNELE1BQU0sQ0FBQyxJQUFJLENBQUMsa0JBQVUsQ0FBQyxRQUFRLEVBQUUsTUFBTSxDQUFDLENBQUMsQ0FBQztTQUMzQztRQUNELE9BQU8sTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztLQUN6QjtTQUFNO1FBQ0wsSUFBSSxPQUFPLEVBQUU7WUFDWCxhQUFhLENBQUMsSUFBSSxDQUFDLHFCQUFhLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQztTQUNsRDtRQUNELElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUNWLE9BQ0UsQ0FBQyxnQkFBZ0I7WUFDakIsQ0FBQyxHQUFHLENBQUMsR0FBRyxhQUFhLENBQUMsTUFBTTtZQUM1QixhQUFhLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxFQUNyQjtZQUNBLEVBQUUsQ0FBQyxDQUFDO1NBQ0w7UUFDRCxPQUFPLGtCQUFVLENBQUMsYUFBYSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsRUFBRSxNQUFNLENBQUMsQ0FBQztLQUNuRDtBQUNILENBQUM7QUFqQ0Qsb0NBaUNDO0FBRUQsU0FBUyxjQUFjLENBQUMsS0FBd0I7SUFDOUMsTUFBTSxhQUFhLEdBQUcsS0FBSyxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUV2QyxPQUFPLGFBQWEsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxJQUFJLENBQUMsRUFBRTtRQUNwQyxhQUFhLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDO0tBQzFCO0lBRUQsTUFBTSxTQUFTLEdBQUcsRUFBRSxDQUFDO0lBRXJCLEtBQUssSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsR0FBRyxhQUFhLENBQUMsTUFBTSxFQUFFLENBQUMsSUFBSSxDQUFDLEVBQUU7UUFDaEQsTUFBTSxJQUFJLEdBQ1IsQ0FBQyxhQUFhLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQztZQUM1QixDQUFDLGFBQWEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksRUFBRSxDQUFDO1lBQzVCLENBQUMsYUFBYSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDM0IsQ0FBQyxhQUFhLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUMzQixDQUFDLGFBQWEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDOUIsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksSUFBSSxFQUFFLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztRQUNsQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxJQUFJLEVBQUUsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDO1FBQ2xDLFNBQVMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLElBQUksQ0FBQyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7UUFDakMsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksSUFBSSxDQUFDLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztLQUNsQztJQUVELE9BQU8sU0FBUyxDQUFDO0FBQ25CLENBQUM7QUF1Q0QsU0FBZ0IsYUFBYSxDQUMzQixZQUFvQixFQUNwQixHQUFHLElBQWU7SUFFbEIsTUFBTSxFQUFFLE9BQU8sRUFBRSxPQUFPLEVBQUUsU0FBUyxFQUFFLEdBQUcsd0JBQWMsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUM3RCxNQUFNLGFBQWEsR0FBRyxjQUFjLENBQUMsWUFBWSxDQUFDLENBQUM7SUFDbkQsTUFBTSxhQUFhLEdBQUcsY0FBYyxDQUFDLGFBQWEsQ0FBQyxDQUFDO0lBQ3BELE9BQU8sWUFBWSxDQUFDLGFBQWEsRUFBRSxPQUFPLEVBQUUsT0FBTyxFQUFFLFNBQVMsQ0FBQyxDQUFDO0FBQ2xFLENBQUM7QUFSRCxzQ0FRQyJ9
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Machine-readable reason for a {@link Base32KeyError}.
3
+ *
4
+ * - `INVALID_HEX`: the hex input is empty or contains non-hex characters.
5
+ * - `INVALID_CHARACTER`: a group contains a character outside the alphabet.
6
+ * - `INVALID_LENGTH`: the key, or one of its groups, has the wrong length.
7
+ * - `CHECKSUM_MISMATCH`: a group's check digit does not match its data.
8
+ * - `GENERATION_FAILED`: `generateKey` found no key accepted by the filter.
9
+ * - `NO_RANDOM_SOURCE`: no secure random source is available.
10
+ */
11
+ export declare type Base32KeyErrorCode = 'INVALID_HEX' | 'INVALID_CHARACTER' | 'INVALID_LENGTH' | 'CHECKSUM_MISMATCH' | 'GENERATION_FAILED' | 'NO_RANDOM_SOURCE';
12
+ /**
13
+ * Error thrown by base32-key for invalid input.
14
+ *
15
+ * `invalidGroups` lists the 0-based indexes of the groups that failed, so a
16
+ * form can highlight exactly which part of a key the user mistyped.
17
+ */
18
+ export declare class Base32KeyError extends Error {
19
+ readonly code: Base32KeyErrorCode;
20
+ readonly invalidGroups: readonly number[];
21
+ constructor(code: Base32KeyErrorCode, message: string, invalidGroups?: readonly number[]);
22
+ }
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Base32KeyError = void 0;
4
+ /**
5
+ * Error thrown by base32-key for invalid input.
6
+ *
7
+ * `invalidGroups` lists the 0-based indexes of the groups that failed, so a
8
+ * form can highlight exactly which part of a key the user mistyped.
9
+ */
10
+ class Base32KeyError extends Error {
11
+ constructor(code, message, invalidGroups = []) {
12
+ super(message);
13
+ this.name = 'Base32KeyError';
14
+ this.code = code;
15
+ this.invalidGroups = invalidGroups;
16
+ }
17
+ }
18
+ exports.Base32KeyError = Base32KeyError;
19
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9lcnJvcnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBa0JBOzs7OztHQUtHO0FBQ0gsTUFBYSxjQUFlLFNBQVEsS0FBSztJQUl2QyxZQUNFLElBQXdCLEVBQ3hCLE9BQWUsRUFDZixnQkFBbUMsRUFBRTtRQUVyQyxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDZixJQUFJLENBQUMsSUFBSSxHQUFHLGdCQUFnQixDQUFDO1FBQzdCLElBQUksQ0FBQyxJQUFJLEdBQUcsSUFBSSxDQUFDO1FBQ2pCLElBQUksQ0FBQyxhQUFhLEdBQUcsYUFBYSxDQUFDO0lBQ3JDLENBQUM7Q0FDRjtBQWRELHdDQWNDIn0=
@@ -0,0 +1,36 @@
1
+ import { EncodeOptions } from './options';
2
+ /** Options for {@link generateKey}. */
3
+ export interface GenerateOptions extends EncodeOptions {
4
+ /** Number of 20-bit groups (4 data digits each). Default `4` (80 bits). */
5
+ readonly groups?: number;
6
+ /**
7
+ * Return `false` to reject a candidate key, e.g. one that contains an
8
+ * offensive word or already exists in your database.
9
+ */
10
+ readonly filter?: (key: string) => boolean;
11
+ /** Candidates to try before giving up. Default `100`. */
12
+ readonly maxAttempts?: number;
13
+ /**
14
+ * Source of random bytes. Defaults to `crypto.getRandomValues`, which is
15
+ * available in browsers and Node.js 19+. Must return `length` bytes.
16
+ */
17
+ readonly random?: (length: number) => Uint8Array;
18
+ }
19
+ /**
20
+ * Generate a random key, for example a product key or a voucher code.
21
+ *
22
+ * ### Example
23
+ * ```js
24
+ * generateKey()
25
+ * // => e.g. 'K7RQX-2HMTD-9WCJA-PNE4F' (80 random bits)
26
+ * generateKey({ groups: 3, filter: (key) => !blocklist.has(key) })
27
+ * ```
28
+ *
29
+ * Keys always have the same length: `groups` groups of 5 characters (4 when
30
+ * `checked` is `false`), or the same digits without hyphens when `grouped`
31
+ * is `false`.
32
+ *
33
+ * @throws {@link Base32KeyError} with code `GENERATION_FAILED` when
34
+ * `filter` rejects `maxAttempts` candidates in a row.
35
+ */
36
+ export declare function generateKey(options?: GenerateOptions): string;
@@ -0,0 +1,58 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.generateKey = void 0;
4
+ const encode_1 = require("./encode");
5
+ const errors_1 = require("./errors");
6
+ const options_1 = require("./options");
7
+ function defaultRandom(length) {
8
+ const crypto = globalThis.crypto;
9
+ if (!crypto || typeof crypto.getRandomValues !== 'function') {
10
+ throw new errors_1.Base32KeyError('NO_RANDOM_SOURCE', 'No secure random source: pass the `random` option, e.g. (n) => require("crypto").randomBytes(n)');
11
+ }
12
+ return crypto.getRandomValues(new Uint8Array(length));
13
+ }
14
+ // cspell: disable
15
+ /**
16
+ * Generate a random key, for example a product key or a voucher code.
17
+ *
18
+ * ### Example
19
+ * ```js
20
+ * generateKey()
21
+ * // => e.g. 'K7RQX-2HMTD-9WCJA-PNE4F' (80 random bits)
22
+ * generateKey({ groups: 3, filter: (key) => !blocklist.has(key) })
23
+ * ```
24
+ *
25
+ * Keys always have the same length: `groups` groups of 5 characters (4 when
26
+ * `checked` is `false`), or the same digits without hyphens when `grouped`
27
+ * is `false`.
28
+ *
29
+ * @throws {@link Base32KeyError} with code `GENERATION_FAILED` when
30
+ * `filter` rejects `maxAttempts` candidates in a row.
31
+ */
32
+ // cspell: enable
33
+ function generateKey(options = {}) {
34
+ const { groups = 4, filter, maxAttempts = 100, random = defaultRandom, } = options;
35
+ if (!Number.isInteger(groups) || groups < 1) {
36
+ throw new RangeError(`groups must be a positive integer, got ${groups}`);
37
+ }
38
+ if (!Number.isInteger(maxAttempts) || maxAttempts < 1) {
39
+ throw new RangeError(`maxAttempts must be a positive integer, got ${maxAttempts}`);
40
+ }
41
+ const { grouped, checked, upperCase } = options_1.resolveOptions([options]);
42
+ const digitCount = groups * 4;
43
+ for (let attempt = 0; attempt < maxAttempts; ++attempt) {
44
+ const bytes = random(digitCount);
45
+ if (!bytes || bytes.length < digitCount) {
46
+ throw new RangeError(`random must return ${digitCount} bytes`);
47
+ }
48
+ // 256 is a multiple of 32, so masking keeps the digits uniform.
49
+ const digits = Array.from(bytes.slice(0, digitCount), (b) => b & 31);
50
+ const key = encode_1.encodeBase32(digits, grouped, checked, upperCase, true);
51
+ if (!filter || filter(key)) {
52
+ return key;
53
+ }
54
+ }
55
+ throw new errors_1.Base32KeyError('GENERATION_FAILED', `No key accepted by filter after ${maxAttempts} attempts`);
56
+ }
57
+ exports.generateKey = generateKey;
58
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2VuZXJhdGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL2dlbmVyYXRlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLHFDQUF3QztBQUN4QyxxQ0FBMEM7QUFDMUMsdUNBQTBEO0FBd0IxRCxTQUFTLGFBQWEsQ0FBQyxNQUFjO0lBQ25DLE1BQU0sTUFBTSxHQUFJLFVBQXNDLENBQUMsTUFBTSxDQUFDO0lBQzlELElBQUksQ0FBQyxNQUFNLElBQUksT0FBTyxNQUFNLENBQUMsZUFBZSxLQUFLLFVBQVUsRUFBRTtRQUMzRCxNQUFNLElBQUksdUJBQWMsQ0FDdEIsa0JBQWtCLEVBQ2xCLGlHQUFpRyxDQUNsRyxDQUFDO0tBQ0g7SUFDRCxPQUFPLE1BQU0sQ0FBQyxlQUFlLENBQUMsSUFBSSxVQUFVLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQztBQUN4RCxDQUFDO0FBRUQsa0JBQWtCO0FBQ2xCOzs7Ozs7Ozs7Ozs7Ozs7O0dBZ0JHO0FBQ0gsaUJBQWlCO0FBQ2pCLFNBQWdCLFdBQVcsQ0FBQyxVQUEyQixFQUFFO0lBQ3ZELE1BQU0sRUFDSixNQUFNLEdBQUcsQ0FBQyxFQUNWLE1BQU0sRUFDTixXQUFXLEdBQUcsR0FBRyxFQUNqQixNQUFNLEdBQUcsYUFBYSxHQUN2QixHQUFHLE9BQU8sQ0FBQztJQUNaLElBQUksQ0FBQyxNQUFNLENBQUMsU0FBUyxDQUFDLE1BQU0sQ0FBQyxJQUFJLE1BQU0sR0FBRyxDQUFDLEVBQUU7UUFDM0MsTUFBTSxJQUFJLFVBQVUsQ0FBQywwQ0FBMEMsTUFBTSxFQUFFLENBQUMsQ0FBQztLQUMxRTtJQUNELElBQUksQ0FBQyxNQUFNLENBQUMsU0FBUyxDQUFDLFdBQVcsQ0FBQyxJQUFJLFdBQVcsR0FBRyxDQUFDLEVBQUU7UUFDckQsTUFBTSxJQUFJLFVBQVUsQ0FDbEIsK0NBQStDLFdBQVcsRUFBRSxDQUM3RCxDQUFDO0tBQ0g7SUFDRCxNQUFNLEVBQUUsT0FBTyxFQUFFLE9BQU8sRUFBRSxTQUFTLEVBQUUsR0FBRyx3QkFBYyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQztJQUNsRSxNQUFNLFVBQVUsR0FBRyxNQUFNLEdBQUcsQ0FBQyxDQUFDO0lBQzlCLEtBQUssSUFBSSxPQUFPLEdBQUcsQ0FBQyxFQUFFLE9BQU8sR0FBRyxXQUFXLEVBQUUsRUFBRSxPQUFPLEVBQUU7UUFDdEQsTUFBTSxLQUFLLEdBQUcsTUFBTSxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQ2pDLElBQUksQ0FBQyxLQUFLLElBQUksS0FBSyxDQUFDLE1BQU0sR0FBRyxVQUFVLEVBQUU7WUFDdkMsTUFBTSxJQUFJLFVBQVUsQ0FBQyxzQkFBc0IsVUFBVSxRQUFRLENBQUMsQ0FBQztTQUNoRTtRQUNELGdFQUFnRTtRQUNoRSxNQUFNLE1BQU0sR0FBRyxLQUFLLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxLQUFLLENBQUMsQ0FBQyxFQUFFLFVBQVUsQ0FBQyxFQUFFLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7UUFDckUsTUFBTSxHQUFHLEdBQUcscUJBQVksQ0FBQyxNQUFNLEVBQUUsT0FBTyxFQUFFLE9BQU8sRUFBRSxTQUFTLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDcEUsSUFBSSxDQUFDLE1BQU0sSUFBSSxNQUFNLENBQUMsR0FBRyxDQUFDLEVBQUU7WUFDMUIsT0FBTyxHQUFHLENBQUM7U0FDWjtLQUNGO0lBQ0QsTUFBTSxJQUFJLHVCQUFjLENBQ3RCLG1CQUFtQixFQUNuQixtQ0FBbUMsV0FBVyxXQUFXLENBQzFELENBQUM7QUFDSixDQUFDO0FBakNELGtDQWlDQyJ9
@@ -0,0 +1,28 @@
1
+ /** Letter case of the Base32 alphabet. */
2
+ export declare type KeyCase = 'upper' | 'lower';
3
+ /** Options for encoding a key. */
4
+ export interface EncodeOptions {
5
+ /** Split the key into hyphen-separated groups of 4 data digits. Default `true`. */
6
+ readonly grouped?: boolean;
7
+ /** Add a CRC-5 check digit (per group when grouped). Default `true`. */
8
+ readonly checked?: boolean;
9
+ /** Alphabet to use. Default `'upper'`. */
10
+ readonly case?: KeyCase;
11
+ }
12
+ /** Options for decoding or validating a key. */
13
+ export interface DecodeOptions extends EncodeOptions {
14
+ /**
15
+ * Clean up user input before decoding: ignore whitespace, accept letters in
16
+ * either case and, for grouped keys, accept missing or misplaced hyphens.
17
+ * Default `false` for `toHexString`/`toBigInt`, `true` for `validate`.
18
+ */
19
+ readonly normalize?: boolean;
20
+ }
21
+ export interface ResolvedOptions {
22
+ readonly grouped: boolean;
23
+ readonly checked: boolean;
24
+ readonly upperCase: boolean;
25
+ readonly normalize: boolean;
26
+ }
27
+ /** Reads either an options object or the legacy positional booleans. */
28
+ export declare function resolveOptions(args: readonly unknown[], normalizeByDefault?: boolean): ResolvedOptions;
@@ -0,0 +1,35 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.resolveOptions = void 0;
4
+ function resolveCase(value) {
5
+ if (value === undefined || value === 'upper') {
6
+ return true;
7
+ }
8
+ if (value === 'lower') {
9
+ return false;
10
+ }
11
+ throw new TypeError(`Invalid case option: ${String(value)}`);
12
+ }
13
+ /** Reads either an options object or the legacy positional booleans. */
14
+ function resolveOptions(args, normalizeByDefault = false) {
15
+ const [first, checked, upperCase] = args;
16
+ if (typeof first === 'object' && first !== null) {
17
+ const options = first;
18
+ return {
19
+ grouped: options.grouped !== false,
20
+ checked: options.checked !== false,
21
+ upperCase: resolveCase(options.case),
22
+ normalize: options.normalize === undefined
23
+ ? normalizeByDefault
24
+ : options.normalize,
25
+ };
26
+ }
27
+ return {
28
+ grouped: first !== false,
29
+ checked: checked !== false,
30
+ upperCase: upperCase !== false,
31
+ normalize: normalizeByDefault,
32
+ };
33
+ }
34
+ exports.resolveOptions = resolveOptions;
35
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3B0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvb3B0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUE4QkEsU0FBUyxXQUFXLENBQUMsS0FBYztJQUNqQyxJQUFJLEtBQUssS0FBSyxTQUFTLElBQUksS0FBSyxLQUFLLE9BQU8sRUFBRTtRQUM1QyxPQUFPLElBQUksQ0FBQztLQUNiO0lBQ0QsSUFBSSxLQUFLLEtBQUssT0FBTyxFQUFFO1FBQ3JCLE9BQU8sS0FBSyxDQUFDO0tBQ2Q7SUFDRCxNQUFNLElBQUksU0FBUyxDQUFDLHdCQUF3QixNQUFNLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQyxDQUFDO0FBQy9ELENBQUM7QUFFRCx3RUFBd0U7QUFDeEUsU0FBZ0IsY0FBYyxDQUM1QixJQUF3QixFQUN4QixrQkFBa0IsR0FBRyxLQUFLO0lBRTFCLE1BQU0sQ0FBQyxLQUFLLEVBQUUsT0FBTyxFQUFFLFNBQVMsQ0FBQyxHQUFHLElBQUksQ0FBQztJQUN6QyxJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVEsSUFBSSxLQUFLLEtBQUssSUFBSSxFQUFFO1FBQy9DLE1BQU0sT0FBTyxHQUFHLEtBQXNCLENBQUM7UUFDdkMsT0FBTztZQUNMLE9BQU8sRUFBRSxPQUFPLENBQUMsT0FBTyxLQUFLLEtBQUs7WUFDbEMsT0FBTyxFQUFFLE9BQU8sQ0FBQyxPQUFPLEtBQUssS0FBSztZQUNsQyxTQUFTLEVBQUUsV0FBVyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUM7WUFDcEMsU0FBUyxFQUNQLE9BQU8sQ0FBQyxTQUFTLEtBQUssU0FBUztnQkFDN0IsQ0FBQyxDQUFDLGtCQUFrQjtnQkFDcEIsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxTQUFTO1NBQ3hCLENBQUM7S0FDSDtJQUNELE9BQU87UUFDTCxPQUFPLEVBQUUsS0FBSyxLQUFLLEtBQUs7UUFDeEIsT0FBTyxFQUFFLE9BQU8sS0FBSyxLQUFLO1FBQzFCLFNBQVMsRUFBRSxTQUFTLEtBQUssS0FBSztRQUM5QixTQUFTLEVBQUUsa0JBQWtCO0tBQzlCLENBQUM7QUFDSixDQUFDO0FBdkJELHdDQXVCQyJ9
@@ -1,3 +1,9 @@
1
- import { toHexString } from './lib/decode';
2
- import { fromHexString } from './lib/encode';
3
- export { fromHexString, toHexString };
1
+ export { formatInput, toHexString, validate } from './lib/decode';
2
+ export type { ValidationResult } from './lib/decode';
3
+ export { fromHexString } from './lib/encode';
4
+ export { Base32KeyError } from './lib/errors';
5
+ export type { Base32KeyErrorCode } from './lib/errors';
6
+ export { fromBigInt, toBigInt } from './lib/bigint';
7
+ export { generateKey } from './lib/generate';
8
+ export type { GenerateOptions } from './lib/generate';
9
+ export type { DecodeOptions, EncodeOptions, KeyCase } from './lib/options';
@@ -1,4 +1,6 @@
1
- import { toHexString } from './lib/decode';
2
- import { fromHexString } from './lib/encode';
3
- export { fromHexString, toHexString };
4
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFdBQVcsRUFBRSxNQUFNLGNBQWMsQ0FBQztBQUMzQyxPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sY0FBYyxDQUFDO0FBRTdDLE9BQU8sRUFBRSxhQUFhLEVBQUUsV0FBVyxFQUFFLENBQUMifQ==
1
+ export { formatInput, toHexString, validate } from './lib/decode';
2
+ export { fromHexString } from './lib/encode';
3
+ export { Base32KeyError } from './lib/errors';
4
+ export { fromBigInt, toBigInt } from './lib/bigint';
5
+ export { generateKey } from './lib/generate';
6
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFdBQVcsRUFBRSxXQUFXLEVBQUUsUUFBUSxFQUFFLE1BQU0sY0FBYyxDQUFDO0FBRWxFLE9BQU8sRUFBRSxhQUFhLEVBQUUsTUFBTSxjQUFjLENBQUM7QUFDN0MsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLGNBQWMsQ0FBQztBQUU5QyxPQUFPLEVBQUUsVUFBVSxFQUFFLFFBQVEsRUFBRSxNQUFNLGNBQWMsQ0FBQztBQUNwRCxPQUFPLEVBQUUsV0FBVyxFQUFFLE1BQU0sZ0JBQWdCLENBQUMifQ==
@@ -0,0 +1,14 @@
1
+ import { DecodeOptions, EncodeOptions } from './options';
2
+ /**
3
+ * Encode a non-negative BigInt as a Base32 key.
4
+ *
5
+ * @example `fromBigInt(BigInt(12648430))` returns `'222ET-3ZZGN'`.
6
+ */
7
+ export declare function fromBigInt(value: bigint, options?: EncodeOptions): string;
8
+ /**
9
+ * Decode a Base32 key to a BigInt.
10
+ *
11
+ * @example `toBigInt('222ET-3ZZGN')` returns `12648430n`.
12
+ * @throws {@link Base32KeyError} like {@link toHexString}.
13
+ */
14
+ export declare function toBigInt(keyString: string, options?: DecodeOptions): bigint;
@@ -0,0 +1,27 @@
1
+ import { toHexString } from './decode';
2
+ import { fromHexString } from './encode';
3
+ // cspell: disable
4
+ /**
5
+ * Encode a non-negative BigInt as a Base32 key.
6
+ *
7
+ * @example `fromBigInt(BigInt(12648430))` returns `'222ET-3ZZGN'`.
8
+ */
9
+ export function fromBigInt(value, options) {
10
+ if (typeof value !== 'bigint') {
11
+ throw new TypeError('Invalid: expected a bigint');
12
+ }
13
+ if (value < BigInt(0)) {
14
+ throw new RangeError('Invalid: expected a non-negative bigint');
15
+ }
16
+ return fromHexString(value.toString(16), options);
17
+ }
18
+ /**
19
+ * Decode a Base32 key to a BigInt.
20
+ *
21
+ * @example `toBigInt('222ET-3ZZGN')` returns `12648430n`.
22
+ * @throws {@link Base32KeyError} like {@link toHexString}.
23
+ */
24
+ export function toBigInt(keyString, options) {
25
+ return BigInt(`0x${toHexString(keyString, options)}`);
26
+ }
27
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmlnaW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9iaWdpbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFdBQVcsRUFBRSxNQUFNLFVBQVUsQ0FBQztBQUN2QyxPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sVUFBVSxDQUFDO0FBR3pDLGtCQUFrQjtBQUNsQjs7OztHQUlHO0FBQ0gsTUFBTSxVQUFVLFVBQVUsQ0FBQyxLQUFhLEVBQUUsT0FBdUI7SUFDL0QsSUFBSSxPQUFPLEtBQUssS0FBSyxRQUFRLEVBQUU7UUFDN0IsTUFBTSxJQUFJLFNBQVMsQ0FBQyw0QkFBNEIsQ0FBQyxDQUFDO0tBQ25EO0lBQ0QsSUFBSSxLQUFLLEdBQUcsTUFBTSxDQUFDLENBQUMsQ0FBQyxFQUFFO1FBQ3JCLE1BQU0sSUFBSSxVQUFVLENBQUMseUNBQXlDLENBQUMsQ0FBQztLQUNqRTtJQUNELE9BQU8sYUFBYSxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsRUFBRSxDQUFDLEVBQUUsT0FBTyxDQUFDLENBQUM7QUFDcEQsQ0FBQztBQUVEOzs7OztHQUtHO0FBQ0gsTUFBTSxVQUFVLFFBQVEsQ0FBQyxTQUFpQixFQUFFLE9BQXVCO0lBQ2pFLE9BQU8sTUFBTSxDQUFDLEtBQUssV0FBVyxDQUFDLFNBQVMsRUFBRSxPQUFPLENBQUMsRUFBRSxDQUFDLENBQUM7QUFDeEQsQ0FBQyJ9
@@ -1,25 +1,65 @@
1
+ import { Base32KeyErrorCode } from './errors';
2
+ import { DecodeOptions, EncodeOptions, ResolvedOptions } from './options';
3
+ /** Splits a key into the groups that are decoded independently. */
4
+ export declare function splitKey(keyString: string, options: ResolvedOptions): string[];
5
+ /** Result of {@link validate}. */
6
+ export interface ValidationResult {
7
+ /** `true` when the whole key decodes and every check digit matches. */
8
+ readonly valid: boolean;
9
+ /** 0-based indexes of the groups that are invalid. */
10
+ readonly invalidGroups: readonly number[];
11
+ /** Reason of the first invalid group, when the key is invalid. */
12
+ readonly code?: Base32KeyErrorCode;
13
+ }
1
14
  /**
2
- * Decode Base32 key to HexString
15
+ * Decode a Base32 key to a hex string.
3
16
  *
4
- * ### Example (es module)
17
+ * ### Example
5
18
  * ```js
6
19
  * import { toHexString } from 'base32-key'
7
- * console.log(fromHexString('222ET-3ZZGN'))
20
+ * toHexString('222ET-3ZZGN')
21
+ * // => 'c0ffee'
22
+ * toHexString('222et 3zzgn', { normalize: true })
8
23
  * // => 'c0ffee'
9
24
  * ```
10
25
  *
11
- * ### Example (commonjs)
26
+ * @param keyString - Input Base32 key.
27
+ * @param options - Decoding options, or the legacy `grouped` boolean.
28
+ * @returns Hex string without leading zeroes.
29
+ * @throws {@link Base32KeyError} if the key is empty, malformed or fails a
30
+ * checksum; its `invalidGroups` lists the groups at fault.
31
+ */
32
+ export declare function toHexString(keyString: string, options?: DecodeOptions): string;
33
+ /**
34
+ * @deprecated Pass an options object instead of positional booleans.
35
+ * @param keyString - Input Base32 key.
36
+ * @param grouped - The key is split into groups.
37
+ * @param checked - The key includes check digits.
38
+ * @param upperCase - The key uses the uppercase alphabet.
39
+ */
40
+ export declare function toHexString(keyString: string, grouped?: boolean, checked?: boolean, upperCase?: boolean): string;
41
+ /**
42
+ * Check a key without throwing, for example while the user is typing.
43
+ *
44
+ * Input is normalized by default (whitespace, letter case and hyphen
45
+ * placement are ignored); pass `normalize: false` to check it as is.
46
+ *
47
+ * ### Example
12
48
  * ```js
13
- * var toHexString = require('base32-key').toHexString;
14
- * console.log(toHexString('222ET-3ZZGN'))
15
- * // => 'c0ffee'
49
+ * validate('222ET-3ZZGX')
50
+ * // => { valid: false, invalidGroups: [1], code: 'CHECKSUM_MISMATCH' }
16
51
  * ```
52
+ */
53
+ export declare function validate(keyString: string, options?: DecodeOptions): ValidationResult;
54
+ /**
55
+ * Format raw user input as a key: drops whitespace, applies the alphabet's
56
+ * letter case and inserts hyphens between groups. Partial input is fine.
57
+ * Characters outside the alphabet are kept so `validate` can flag them.
17
58
  *
18
- * @param keyString - Input Base32-Key.
19
- * @param grouped - Split the result into groups.
20
- * @param checked - Include the checksum into Base32-Key.
21
- * @param upperCase - Use uppercase or lowercase Base32-Key.
22
- * @returns Base-16 string.
23
- * @anotherNote Some other value.
59
+ * ### Example
60
+ * ```js
61
+ * formatInput('222et3zz')
62
+ * // => '222ET-3ZZ'
63
+ * ```
24
64
  */
25
- export declare const toHexString: (keyString: string, grouped?: boolean, checked?: boolean, upperCase?: boolean) => string;
65
+ export declare function formatInput(raw: string, options?: EncodeOptions): string;