base32-key 1.0.9 → 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.
- package/CHANGELOG.md +7 -0
- package/README.md +88 -0
- package/build/main/index.d.ts +9 -3
- package/build/main/index.js +13 -4
- package/build/main/lib/bigint.d.ts +14 -0
- package/build/main/lib/bigint.js +32 -0
- package/build/main/lib/decode.d.ts +54 -14
- package/build/main/lib/decode.js +122 -44
- package/build/main/lib/encode.d.ts +21 -17
- package/build/main/lib/encode.js +15 -35
- package/build/main/lib/errors.d.ts +22 -0
- package/build/main/lib/errors.js +19 -0
- package/build/main/lib/generate.d.ts +36 -0
- package/build/main/lib/generate.js +58 -0
- package/build/main/lib/options.d.ts +28 -0
- package/build/main/lib/options.js +35 -0
- package/build/module/index.d.ts +9 -3
- package/build/module/index.js +6 -4
- package/build/module/lib/bigint.d.ts +14 -0
- package/build/module/lib/bigint.js +27 -0
- package/build/module/lib/decode.d.ts +54 -14
- package/build/module/lib/decode.js +117 -43
- package/build/module/lib/encode.d.ts +21 -17
- package/build/module/lib/encode.js +12 -34
- package/build/module/lib/errors.d.ts +22 -0
- package/build/module/lib/errors.js +15 -0
- package/build/module/lib/generate.d.ts +36 -0
- package/build/module/lib/generate.js +54 -0
- package/build/module/lib/options.d.ts +28 -0
- package/build/module/lib/options.js +31 -0
- package/package.json +1 -1
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { Base32KeyError } from './errors';
|
|
2
|
+
import { resolveOptions } from './options';
|
|
1
3
|
import { BASE_16_DIGITS, BASE_32_DIGITS, BASE_32_DIGITS_LOWERCASE, baseDecode, baseEncode, calculateCrc5, } from './utils';
|
|
2
4
|
function parseHexString(base16String) {
|
|
3
5
|
if (typeof base16String !== 'string') {
|
|
@@ -8,11 +10,11 @@ function parseHexString(base16String) {
|
|
|
8
10
|
: base16String;
|
|
9
11
|
const base16Numbers = baseDecode(hex.toLowerCase(), BASE_16_DIGITS);
|
|
10
12
|
if (base16Numbers == null || base16Numbers.length === 0) {
|
|
11
|
-
throw new
|
|
13
|
+
throw new Base32KeyError('INVALID_HEX', `Invalid hex string: "${base16String}"`);
|
|
12
14
|
}
|
|
13
15
|
return base16Numbers;
|
|
14
16
|
}
|
|
15
|
-
function encodeBase32(base32Numbers, grouped, checked, upperCase) {
|
|
17
|
+
export function encodeBase32(base32Numbers, grouped, checked, upperCase, keepLeadingZeros = false) {
|
|
16
18
|
const digits = upperCase ? BASE_32_DIGITS : BASE_32_DIGITS_LOWERCASE;
|
|
17
19
|
if (grouped) {
|
|
18
20
|
// This assumes base32num.length is a multiple of 4.
|
|
@@ -31,7 +33,9 @@ function encodeBase32(base32Numbers, grouped, checked, upperCase) {
|
|
|
31
33
|
base32Numbers.push(calculateCrc5(base32Numbers));
|
|
32
34
|
}
|
|
33
35
|
let i = 0;
|
|
34
|
-
while (
|
|
36
|
+
while (!keepLeadingZeros &&
|
|
37
|
+
i + 1 < base32Numbers.length &&
|
|
38
|
+
base32Numbers[i] == 0) {
|
|
35
39
|
++i;
|
|
36
40
|
}
|
|
37
41
|
return baseEncode(base32Numbers.slice(i), digits);
|
|
@@ -56,36 +60,10 @@ function numberToBase32(input) {
|
|
|
56
60
|
}
|
|
57
61
|
return base32num;
|
|
58
62
|
}
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
* Encode Base32 key from HexString
|
|
62
|
-
*
|
|
63
|
-
* ### Example (es module)
|
|
64
|
-
* ```js
|
|
65
|
-
* import { fromHexString } from 'base32-key'
|
|
66
|
-
* console.log(fromHexString('c0ffee'))
|
|
67
|
-
* // => '222ET-3ZZGN'
|
|
68
|
-
* ```
|
|
69
|
-
*
|
|
70
|
-
* ### Example (commonjs)
|
|
71
|
-
* ```js
|
|
72
|
-
* var fromHexString = require('base32-key').fromHexString;
|
|
73
|
-
* console.log(fromHexString('c0ffee'))
|
|
74
|
-
* // => '222ET-3ZZGN'
|
|
75
|
-
* ```
|
|
76
|
-
*
|
|
77
|
-
* @param base16String - Input HexString (an optional `0x` prefix is allowed).
|
|
78
|
-
* @param grouped - Split the result into groups.
|
|
79
|
-
* @param checked - Include the checksum into Base32-Key.
|
|
80
|
-
* @param upperCase - Use uppercase or lowercase Base32-Key.
|
|
81
|
-
* @returns Base32-Key string.
|
|
82
|
-
* @throws Error if `base16String` is empty or contains non-hex characters.
|
|
83
|
-
*/
|
|
84
|
-
// cspell: enable
|
|
85
|
-
export const fromHexString = (base16String, grouped = true, checked = true, upperCase = true) => {
|
|
63
|
+
export function fromHexString(base16String, ...args) {
|
|
64
|
+
const { grouped, checked, upperCase } = resolveOptions(args);
|
|
86
65
|
const base16Numbers = parseHexString(base16String);
|
|
87
66
|
const base32Numbers = numberToBase32(base16Numbers);
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW5jb2RlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9lbmNvZGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUNMLGNBQWMsRUFDZCxjQUFjLEVBQ2Qsd0JBQXdCLEVBQ3hCLFVBQVUsRUFDVixVQUFVLEVBQ1YsYUFBYSxHQUNkLE1BQU0sU0FBUyxDQUFDO0FBRWpCLFNBQVMsY0FBYyxDQUFDLFlBQW9CO0lBQzFDLElBQUksT0FBTyxZQUFZLEtBQUssUUFBUSxFQUFFO1FBQ3BDLE1BQU0sSUFBSSxTQUFTLENBQUMsdUNBQXVDLENBQUMsQ0FBQztLQUM5RDtJQUNELE1BQU0sR0FBRyxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDO1FBQ25DLENBQUMsQ0FBQyxZQUFZLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQztRQUMzQixDQUFDLENBQUMsWUFBWSxDQUFDO0lBQ2pCLE1BQU0sYUFBYSxHQUFHLFVBQVUsQ0FBQyxHQUFHLENBQUMsV0FBVyxFQUFFLEVBQUUsY0FBYyxDQUFDLENBQUM7SUFDcEUsSUFBSSxhQUFhLElBQUksSUFBSSxJQUFJLGFBQWEsQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFO1FBQ3ZELE1BQU0sSUFBSSxLQUFLLENBQUMsd0JBQXdCLFlBQVksR0FBRyxDQUFDLENBQUM7S0FDMUQ7SUFDRCxPQUFPLGFBQWEsQ0FBQztBQUN2QixDQUFDO0FBRUQsU0FBUyxZQUFZLENBQ25CLGFBQXVCLEVBQ3ZCLE9BQWdCLEVBQ2hCLE9BQWdCLEVBQ2hCLFNBQWtCO0lBRWxCLE1BQU0sTUFBTSxHQUFHLFNBQVMsQ0FBQyxDQUFDLENBQUMsY0FBYyxDQUFDLENBQUMsQ0FBQyx3QkFBd0IsQ0FBQztJQUNyRSxJQUFJLE9BQU8sRUFBRTtRQUNYLG9EQUFvRDtRQUNwRCxNQUFNLE1BQU0sR0FBRyxFQUFFLENBQUM7UUFDbEIsS0FBSyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxHQUFHLGFBQWEsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxJQUFJLENBQUMsRUFBRTtZQUNoRCxNQUFNLFFBQVEsR0FBRyxhQUFhLENBQUMsS0FBSyxDQUFDLENBQUMsRUFBRSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7WUFDL0MsSUFBSSxPQUFPLEVBQUU7Z0JBQ1gsUUFBUSxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQzthQUN4QztZQUNELE1BQU0sQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLFFBQVEsRUFBRSxNQUFNLENBQUMsQ0FBQyxDQUFDO1NBQzNDO1FBQ0QsT0FBTyxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0tBQ3pCO1NBQU07UUFDTCxJQUFJLE9BQU8sRUFBRTtZQUNYLGFBQWEsQ0FBQyxJQUFJLENBQUMsYUFBYSxDQUFDLGFBQWEsQ0FBQyxDQUFDLENBQUM7U0FDbEQ7UUFDRCxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDVixPQUFPLENBQUMsR0FBRyxDQUFDLEdBQUcsYUFBYSxDQUFDLE1BQU0sSUFBSSxhQUFhLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxFQUFFO1lBQzVELEVBQUUsQ0FBQyxDQUFDO1NBQ0w7UUFDRCxPQUFPLFVBQVUsQ0FBQyxhQUFhLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxFQUFFLE1BQU0sQ0FBQyxDQUFDO0tBQ25EO0FBQ0gsQ0FBQztBQUVELFNBQVMsY0FBYyxDQUFDLEtBQXdCO0lBQzlDLE1BQU0sYUFBYSxHQUFHLEtBQUssQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDLENBQUM7SUFFdkMsT0FBTyxhQUFhLENBQUMsTUFBTSxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQUU7UUFDcEMsYUFBYSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0FBQztLQUMxQjtJQUVELE1BQU0sU0FBUyxHQUFHLEVBQUUsQ0FBQztJQUVyQixLQUFLLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEdBQUcsYUFBYSxDQUFDLE1BQU0sRUFBRSxDQUFDLElBQUksQ0FBQyxFQUFFO1FBQ2hELE1BQU0sSUFBSSxHQUNSLENBQUMsYUFBYSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUM7WUFDNUIsQ0FBQyxhQUFhLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQztZQUM1QixDQUFDLGFBQWEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQzNCLENBQUMsYUFBYSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDM0IsQ0FBQyxhQUFhLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO1FBQzlCLFNBQVMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7UUFDbEMsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksSUFBSSxFQUFFLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztRQUNsQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxJQUFJLENBQUMsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDO1FBQ2pDLFNBQVMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLElBQUksQ0FBQyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7S0FDbEM7SUFFRCxPQUFPLFNBQVMsQ0FBQztBQUNuQixDQUFDO0FBRUQsa0JBQWtCO0FBQ2xCOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQXVCRztBQUVILGlCQUFpQjtBQUNqQixNQUFNLENBQUMsTUFBTSxhQUFhLEdBQUcsQ0FDM0IsWUFBb0IsRUFDcEIsT0FBTyxHQUFHLElBQUksRUFDZCxPQUFPLEdBQUcsSUFBSSxFQUNkLFNBQVMsR0FBRyxJQUFJLEVBQ1IsRUFBRTtJQUNWLE1BQU0sYUFBYSxHQUFHLGNBQWMsQ0FBQyxZQUFZLENBQUMsQ0FBQztJQUNuRCxNQUFNLGFBQWEsR0FBRyxjQUFjLENBQUMsYUFBYSxDQUFDLENBQUM7SUFDcEQsTUFBTSxNQUFNLEdBQUcsWUFBWSxDQUFDLGFBQWEsRUFBRSxPQUFPLEVBQUUsT0FBTyxFQUFFLFNBQVMsQ0FBQyxDQUFDO0lBQ3hFLE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUMsQ0FBQyJ9
|
|
67
|
+
return encodeBase32(base32Numbers, grouped, checked, upperCase);
|
|
68
|
+
}
|
|
69
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW5jb2RlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9lbmNvZGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLFVBQVUsQ0FBQztBQUMxQyxPQUFPLEVBQWlCLGNBQWMsRUFBRSxNQUFNLFdBQVcsQ0FBQztBQUMxRCxPQUFPLEVBQ0wsY0FBYyxFQUNkLGNBQWMsRUFDZCx3QkFBd0IsRUFDeEIsVUFBVSxFQUNWLFVBQVUsRUFDVixhQUFhLEdBQ2QsTUFBTSxTQUFTLENBQUM7QUFFakIsU0FBUyxjQUFjLENBQUMsWUFBb0I7SUFDMUMsSUFBSSxPQUFPLFlBQVksS0FBSyxRQUFRLEVBQUU7UUFDcEMsTUFBTSxJQUFJLFNBQVMsQ0FBQyx1Q0FBdUMsQ0FBQyxDQUFDO0tBQzlEO0lBQ0QsTUFBTSxHQUFHLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUM7UUFDbkMsQ0FBQyxDQUFDLFlBQVksQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDO1FBQzNCLENBQUMsQ0FBQyxZQUFZLENBQUM7SUFDakIsTUFBTSxhQUFhLEdBQUcsVUFBVSxDQUFDLEdBQUcsQ0FBQyxXQUFXLEVBQUUsRUFBRSxjQUFjLENBQUMsQ0FBQztJQUNwRSxJQUFJLGFBQWEsSUFBSSxJQUFJLElBQUksYUFBYSxDQUFDLE1BQU0sS0FBSyxDQUFDLEVBQUU7UUFDdkQsTUFBTSxJQUFJLGNBQWMsQ0FDdEIsYUFBYSxFQUNiLHdCQUF3QixZQUFZLEdBQUcsQ0FDeEMsQ0FBQztLQUNIO0lBQ0QsT0FBTyxhQUFhLENBQUM7QUFDdkIsQ0FBQztBQUVELE1BQU0sVUFBVSxZQUFZLENBQzFCLGFBQXVCLEVBQ3ZCLE9BQWdCLEVBQ2hCLE9BQWdCLEVBQ2hCLFNBQWtCLEVBQ2xCLGdCQUFnQixHQUFHLEtBQUs7SUFFeEIsTUFBTSxNQUFNLEdBQUcsU0FBUyxDQUFDLENBQUMsQ0FBQyxjQUFjLENBQUMsQ0FBQyxDQUFDLHdCQUF3QixDQUFDO0lBQ3JFLElBQUksT0FBTyxFQUFFO1FBQ1gsb0RBQW9EO1FBQ3BELE1BQU0sTUFBTSxHQUFHLEVBQUUsQ0FBQztRQUNsQixLQUFLLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEdBQUcsYUFBYSxDQUFDLE1BQU0sRUFBRSxDQUFDLElBQUksQ0FBQyxFQUFFO1lBQ2hELE1BQU0sUUFBUSxHQUFHLGFBQWEsQ0FBQyxLQUFLLENBQUMsQ0FBQyxFQUFFLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztZQUMvQyxJQUFJLE9BQU8sRUFBRTtnQkFDWCxRQUFRLENBQUMsSUFBSSxDQUFDLGFBQWEsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDO2FBQ3hDO1lBQ0QsTUFBTSxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsUUFBUSxFQUFFLE1BQU0sQ0FBQyxDQUFDLENBQUM7U0FDM0M7UUFDRCxPQUFPLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7S0FDekI7U0FBTTtRQUNMLElBQUksT0FBTyxFQUFFO1lBQ1gsYUFBYSxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQztTQUNsRDtRQUNELElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUNWLE9BQ0UsQ0FBQyxnQkFBZ0I7WUFDakIsQ0FBQyxHQUFHLENBQUMsR0FBRyxhQUFhLENBQUMsTUFBTTtZQUM1QixhQUFhLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxFQUNyQjtZQUNBLEVBQUUsQ0FBQyxDQUFDO1NBQ0w7UUFDRCxPQUFPLFVBQVUsQ0FBQyxhQUFhLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxFQUFFLE1BQU0sQ0FBQyxDQUFDO0tBQ25EO0FBQ0gsQ0FBQztBQUVELFNBQVMsY0FBYyxDQUFDLEtBQXdCO0lBQzlDLE1BQU0sYUFBYSxHQUFHLEtBQUssQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDLENBQUM7SUFFdkMsT0FBTyxhQUFhLENBQUMsTUFBTSxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQUU7UUFDcEMsYUFBYSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0FBQztLQUMxQjtJQUVELE1BQU0sU0FBUyxHQUFHLEVBQUUsQ0FBQztJQUVyQixLQUFLLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEdBQUcsYUFBYSxDQUFDLE1BQU0sRUFBRSxDQUFDLElBQUksQ0FBQyxFQUFFO1FBQ2hELE1BQU0sSUFBSSxHQUNSLENBQUMsYUFBYSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUM7WUFDNUIsQ0FBQyxhQUFhLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQztZQUM1QixDQUFDLGFBQWEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQzNCLENBQUMsYUFBYSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDM0IsQ0FBQyxhQUFhLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO1FBQzlCLFNBQVMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7UUFDbEMsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksSUFBSSxFQUFFLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztRQUNsQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxJQUFJLENBQUMsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDO1FBQ2pDLFNBQVMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLElBQUksQ0FBQyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7S0FDbEM7SUFFRCxPQUFPLFNBQVMsQ0FBQztBQUNuQixDQUFDO0FBdUNELE1BQU0sVUFBVSxhQUFhLENBQzNCLFlBQW9CLEVBQ3BCLEdBQUcsSUFBZTtJQUVsQixNQUFNLEVBQUUsT0FBTyxFQUFFLE9BQU8sRUFBRSxTQUFTLEVBQUUsR0FBRyxjQUFjLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDN0QsTUFBTSxhQUFhLEdBQUcsY0FBYyxDQUFDLFlBQVksQ0FBQyxDQUFDO0lBQ25ELE1BQU0sYUFBYSxHQUFHLGNBQWMsQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUNwRCxPQUFPLFlBQVksQ0FBQyxhQUFhLEVBQUUsT0FBTyxFQUFFLE9BQU8sRUFBRSxTQUFTLENBQUMsQ0FBQztBQUNsRSxDQUFDIn0=
|
|
@@ -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,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Error thrown by base32-key for invalid input.
|
|
3
|
+
*
|
|
4
|
+
* `invalidGroups` lists the 0-based indexes of the groups that failed, so a
|
|
5
|
+
* form can highlight exactly which part of a key the user mistyped.
|
|
6
|
+
*/
|
|
7
|
+
export class Base32KeyError extends Error {
|
|
8
|
+
constructor(code, message, invalidGroups = []) {
|
|
9
|
+
super(message);
|
|
10
|
+
this.name = 'Base32KeyError';
|
|
11
|
+
this.code = code;
|
|
12
|
+
this.invalidGroups = invalidGroups;
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9lcnJvcnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBa0JBOzs7OztHQUtHO0FBQ0gsTUFBTSxPQUFPLGNBQWUsU0FBUSxLQUFLO0lBSXZDLFlBQ0UsSUFBd0IsRUFDeEIsT0FBZSxFQUNmLGdCQUFtQyxFQUFFO1FBRXJDLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUNmLElBQUksQ0FBQyxJQUFJLEdBQUcsZ0JBQWdCLENBQUM7UUFDN0IsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUM7UUFDakIsSUFBSSxDQUFDLGFBQWEsR0FBRyxhQUFhLENBQUM7SUFDckMsQ0FBQztDQUNGIn0=
|
|
@@ -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,54 @@
|
|
|
1
|
+
import { encodeBase32 } from './encode';
|
|
2
|
+
import { Base32KeyError } from './errors';
|
|
3
|
+
import { resolveOptions } from './options';
|
|
4
|
+
function defaultRandom(length) {
|
|
5
|
+
const crypto = globalThis.crypto;
|
|
6
|
+
if (!crypto || typeof crypto.getRandomValues !== 'function') {
|
|
7
|
+
throw new Base32KeyError('NO_RANDOM_SOURCE', 'No secure random source: pass the `random` option, e.g. (n) => require("crypto").randomBytes(n)');
|
|
8
|
+
}
|
|
9
|
+
return crypto.getRandomValues(new Uint8Array(length));
|
|
10
|
+
}
|
|
11
|
+
// cspell: disable
|
|
12
|
+
/**
|
|
13
|
+
* Generate a random key, for example a product key or a voucher code.
|
|
14
|
+
*
|
|
15
|
+
* ### Example
|
|
16
|
+
* ```js
|
|
17
|
+
* generateKey()
|
|
18
|
+
* // => e.g. 'K7RQX-2HMTD-9WCJA-PNE4F' (80 random bits)
|
|
19
|
+
* generateKey({ groups: 3, filter: (key) => !blocklist.has(key) })
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* Keys always have the same length: `groups` groups of 5 characters (4 when
|
|
23
|
+
* `checked` is `false`), or the same digits without hyphens when `grouped`
|
|
24
|
+
* is `false`.
|
|
25
|
+
*
|
|
26
|
+
* @throws {@link Base32KeyError} with code `GENERATION_FAILED` when
|
|
27
|
+
* `filter` rejects `maxAttempts` candidates in a row.
|
|
28
|
+
*/
|
|
29
|
+
// cspell: enable
|
|
30
|
+
export function generateKey(options = {}) {
|
|
31
|
+
const { groups = 4, filter, maxAttempts = 100, random = defaultRandom, } = options;
|
|
32
|
+
if (!Number.isInteger(groups) || groups < 1) {
|
|
33
|
+
throw new RangeError(`groups must be a positive integer, got ${groups}`);
|
|
34
|
+
}
|
|
35
|
+
if (!Number.isInteger(maxAttempts) || maxAttempts < 1) {
|
|
36
|
+
throw new RangeError(`maxAttempts must be a positive integer, got ${maxAttempts}`);
|
|
37
|
+
}
|
|
38
|
+
const { grouped, checked, upperCase } = resolveOptions([options]);
|
|
39
|
+
const digitCount = groups * 4;
|
|
40
|
+
for (let attempt = 0; attempt < maxAttempts; ++attempt) {
|
|
41
|
+
const bytes = random(digitCount);
|
|
42
|
+
if (!bytes || bytes.length < digitCount) {
|
|
43
|
+
throw new RangeError(`random must return ${digitCount} bytes`);
|
|
44
|
+
}
|
|
45
|
+
// 256 is a multiple of 32, so masking keeps the digits uniform.
|
|
46
|
+
const digits = Array.from(bytes.slice(0, digitCount), (b) => b & 31);
|
|
47
|
+
const key = encodeBase32(digits, grouped, checked, upperCase, true);
|
|
48
|
+
if (!filter || filter(key)) {
|
|
49
|
+
return key;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
throw new Base32KeyError('GENERATION_FAILED', `No key accepted by filter after ${maxAttempts} attempts`);
|
|
53
|
+
}
|
|
54
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2VuZXJhdGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL2dlbmVyYXRlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSxVQUFVLENBQUM7QUFDeEMsT0FBTyxFQUFFLGNBQWMsRUFBRSxNQUFNLFVBQVUsQ0FBQztBQUMxQyxPQUFPLEVBQWlCLGNBQWMsRUFBRSxNQUFNLFdBQVcsQ0FBQztBQXdCMUQsU0FBUyxhQUFhLENBQUMsTUFBYztJQUNuQyxNQUFNLE1BQU0sR0FBSSxVQUFzQyxDQUFDLE1BQU0sQ0FBQztJQUM5RCxJQUFJLENBQUMsTUFBTSxJQUFJLE9BQU8sTUFBTSxDQUFDLGVBQWUsS0FBSyxVQUFVLEVBQUU7UUFDM0QsTUFBTSxJQUFJLGNBQWMsQ0FDdEIsa0JBQWtCLEVBQ2xCLGlHQUFpRyxDQUNsRyxDQUFDO0tBQ0g7SUFDRCxPQUFPLE1BQU0sQ0FBQyxlQUFlLENBQUMsSUFBSSxVQUFVLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQztBQUN4RCxDQUFDO0FBRUQsa0JBQWtCO0FBQ2xCOzs7Ozs7Ozs7Ozs7Ozs7O0dBZ0JHO0FBQ0gsaUJBQWlCO0FBQ2pCLE1BQU0sVUFBVSxXQUFXLENBQUMsVUFBMkIsRUFBRTtJQUN2RCxNQUFNLEVBQ0osTUFBTSxHQUFHLENBQUMsRUFDVixNQUFNLEVBQ04sV0FBVyxHQUFHLEdBQUcsRUFDakIsTUFBTSxHQUFHLGFBQWEsR0FDdkIsR0FBRyxPQUFPLENBQUM7SUFDWixJQUFJLENBQUMsTUFBTSxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUMsSUFBSSxNQUFNLEdBQUcsQ0FBQyxFQUFFO1FBQzNDLE1BQU0sSUFBSSxVQUFVLENBQUMsMENBQTBDLE1BQU0sRUFBRSxDQUFDLENBQUM7S0FDMUU7SUFDRCxJQUFJLENBQUMsTUFBTSxDQUFDLFNBQVMsQ0FBQyxXQUFXLENBQUMsSUFBSSxXQUFXLEdBQUcsQ0FBQyxFQUFFO1FBQ3JELE1BQU0sSUFBSSxVQUFVLENBQ2xCLCtDQUErQyxXQUFXLEVBQUUsQ0FDN0QsQ0FBQztLQUNIO0lBQ0QsTUFBTSxFQUFFLE9BQU8sRUFBRSxPQUFPLEVBQUUsU0FBUyxFQUFFLEdBQUcsY0FBYyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQztJQUNsRSxNQUFNLFVBQVUsR0FBRyxNQUFNLEdBQUcsQ0FBQyxDQUFDO0lBQzlCLEtBQUssSUFBSSxPQUFPLEdBQUcsQ0FBQyxFQUFFLE9BQU8sR0FBRyxXQUFXLEVBQUUsRUFBRSxPQUFPLEVBQUU7UUFDdEQsTUFBTSxLQUFLLEdBQUcsTUFBTSxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQ2pDLElBQUksQ0FBQyxLQUFLLElBQUksS0FBSyxDQUFDLE1BQU0sR0FBRyxVQUFVLEVBQUU7WUFDdkMsTUFBTSxJQUFJLFVBQVUsQ0FBQyxzQkFBc0IsVUFBVSxRQUFRLENBQUMsQ0FBQztTQUNoRTtRQUNELGdFQUFnRTtRQUNoRSxNQUFNLE1BQU0sR0FBRyxLQUFLLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxLQUFLLENBQUMsQ0FBQyxFQUFFLFVBQVUsQ0FBQyxFQUFFLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7UUFDckUsTUFBTSxHQUFHLEdBQUcsWUFBWSxDQUFDLE1BQU0sRUFBRSxPQUFPLEVBQUUsT0FBTyxFQUFFLFNBQVMsRUFBRSxJQUFJLENBQUMsQ0FBQztRQUNwRSxJQUFJLENBQUMsTUFBTSxJQUFJLE1BQU0sQ0FBQyxHQUFHLENBQUMsRUFBRTtZQUMxQixPQUFPLEdBQUcsQ0FBQztTQUNaO0tBQ0Y7SUFDRCxNQUFNLElBQUksY0FBYyxDQUN0QixtQkFBbUIsRUFDbkIsbUNBQW1DLFdBQVcsV0FBVyxDQUMxRCxDQUFDO0FBQ0osQ0FBQyJ9
|
|
@@ -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,31 @@
|
|
|
1
|
+
function resolveCase(value) {
|
|
2
|
+
if (value === undefined || value === 'upper') {
|
|
3
|
+
return true;
|
|
4
|
+
}
|
|
5
|
+
if (value === 'lower') {
|
|
6
|
+
return false;
|
|
7
|
+
}
|
|
8
|
+
throw new TypeError(`Invalid case option: ${String(value)}`);
|
|
9
|
+
}
|
|
10
|
+
/** Reads either an options object or the legacy positional booleans. */
|
|
11
|
+
export function resolveOptions(args, normalizeByDefault = false) {
|
|
12
|
+
const [first, checked, upperCase] = args;
|
|
13
|
+
if (typeof first === 'object' && first !== null) {
|
|
14
|
+
const options = first;
|
|
15
|
+
return {
|
|
16
|
+
grouped: options.grouped !== false,
|
|
17
|
+
checked: options.checked !== false,
|
|
18
|
+
upperCase: resolveCase(options.case),
|
|
19
|
+
normalize: options.normalize === undefined
|
|
20
|
+
? normalizeByDefault
|
|
21
|
+
: options.normalize,
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
return {
|
|
25
|
+
grouped: first !== false,
|
|
26
|
+
checked: checked !== false,
|
|
27
|
+
upperCase: upperCase !== false,
|
|
28
|
+
normalize: normalizeByDefault,
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3B0aW9ucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvb3B0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUE4QkEsU0FBUyxXQUFXLENBQUMsS0FBYztJQUNqQyxJQUFJLEtBQUssS0FBSyxTQUFTLElBQUksS0FBSyxLQUFLLE9BQU8sRUFBRTtRQUM1QyxPQUFPLElBQUksQ0FBQztLQUNiO0lBQ0QsSUFBSSxLQUFLLEtBQUssT0FBTyxFQUFFO1FBQ3JCLE9BQU8sS0FBSyxDQUFDO0tBQ2Q7SUFDRCxNQUFNLElBQUksU0FBUyxDQUFDLHdCQUF3QixNQUFNLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQyxDQUFDO0FBQy9ELENBQUM7QUFFRCx3RUFBd0U7QUFDeEUsTUFBTSxVQUFVLGNBQWMsQ0FDNUIsSUFBd0IsRUFDeEIsa0JBQWtCLEdBQUcsS0FBSztJQUUxQixNQUFNLENBQUMsS0FBSyxFQUFFLE9BQU8sRUFBRSxTQUFTLENBQUMsR0FBRyxJQUFJLENBQUM7SUFDekMsSUFBSSxPQUFPLEtBQUssS0FBSyxRQUFRLElBQUksS0FBSyxLQUFLLElBQUksRUFBRTtRQUMvQyxNQUFNLE9BQU8sR0FBRyxLQUFzQixDQUFDO1FBQ3ZDLE9BQU87WUFDTCxPQUFPLEVBQUUsT0FBTyxDQUFDLE9BQU8sS0FBSyxLQUFLO1lBQ2xDLE9BQU8sRUFBRSxPQUFPLENBQUMsT0FBTyxLQUFLLEtBQUs7WUFDbEMsU0FBUyxFQUFFLFdBQVcsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDO1lBQ3BDLFNBQVMsRUFDUCxPQUFPLENBQUMsU0FBUyxLQUFLLFNBQVM7Z0JBQzdCLENBQUMsQ0FBQyxrQkFBa0I7Z0JBQ3BCLENBQUMsQ0FBQyxPQUFPLENBQUMsU0FBUztTQUN4QixDQUFDO0tBQ0g7SUFDRCxPQUFPO1FBQ0wsT0FBTyxFQUFFLEtBQUssS0FBSyxLQUFLO1FBQ3hCLE9BQU8sRUFBRSxPQUFPLEtBQUssS0FBSztRQUMxQixTQUFTLEVBQUUsU0FBUyxLQUFLLEtBQUs7UUFDOUIsU0FBUyxFQUFFLGtCQUFrQjtLQUM5QixDQUFDO0FBQ0osQ0FBQyJ9
|