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,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 base32toBase16(base32Numbers) {
3
5
  while (base32Numbers.length % 4 != 0) {
@@ -13,59 +15,137 @@ function base32toBase16(base32Numbers) {
13
15
  }
14
16
  return base16Numbers;
15
17
  }
16
- function decode(keyString, grouped, checked, upperCase) {
17
- const digits = upperCase ? BASE_32_DIGITS : BASE_32_DIGITS_LOWERCASE;
18
- const base32num = baseDecode(keyString, digits);
19
- if (base32num == null ||
20
- (grouped && base32num.length != 4 + (checked ? 1 : 0))) {
21
- throw new Error('Invalid');
18
+ /** Splits a key into the groups that are decoded independently. */
19
+ export function splitKey(keyString, options) {
20
+ if (!options.normalize) {
21
+ return keyString.split('-');
22
22
  }
23
- if (checked) {
23
+ const cleaned = keyString.replace(/[\s-]+/g, '');
24
+ const folded = options.upperCase
25
+ ? cleaned.toUpperCase()
26
+ : cleaned.toLowerCase();
27
+ if (!options.grouped) {
28
+ return [folded];
29
+ }
30
+ const size = options.checked ? 5 : 4;
31
+ const groups = [];
32
+ for (let i = 0; i < folded.length; i += size) {
33
+ groups.push(folded.substring(i, i + size));
34
+ }
35
+ return groups.length > 0 ? groups : [''];
36
+ }
37
+ function decodeGroup(group, options) {
38
+ const alphabet = options.upperCase
39
+ ? BASE_32_DIGITS
40
+ : BASE_32_DIGITS_LOWERCASE;
41
+ const base32num = baseDecode(group, alphabet);
42
+ if (base32num == null) {
43
+ return { ok: false, code: 'INVALID_CHARACTER' };
44
+ }
45
+ if (base32num.length === 0 ||
46
+ (options.grouped && base32num.length != 4 + (options.checked ? 1 : 0))) {
47
+ return { ok: false, code: 'INVALID_LENGTH' };
48
+ }
49
+ if (options.checked) {
24
50
  // Remove and verify check digit.
25
51
  const check = base32num.pop();
26
52
  if (calculateCrc5(base32num) !== check) {
27
- throw new Error('Invalid');
53
+ return { ok: false, code: 'CHECKSUM_MISMATCH' };
54
+ }
55
+ }
56
+ return {
57
+ ok: true,
58
+ hex: baseEncode(base32toBase16(base32num), BASE_16_DIGITS),
59
+ };
60
+ }
61
+ const MESSAGES = {
62
+ INVALID_CHARACTER: 'a character outside the alphabet',
63
+ INVALID_LENGTH: 'the wrong length',
64
+ CHECKSUM_MISMATCH: 'a check digit that does not match',
65
+ };
66
+ function analyze(keyString, options) {
67
+ const groups = splitKey(keyString, options);
68
+ const invalidGroups = [];
69
+ let code;
70
+ let hex = '';
71
+ groups.forEach((group, index) => {
72
+ const result = decodeGroup(group, options);
73
+ if (result.ok) {
74
+ hex += result.hex;
75
+ }
76
+ else {
77
+ invalidGroups.push(index);
78
+ code = code || result.code;
28
79
  }
80
+ });
81
+ return { hex, invalidGroups, code };
82
+ }
83
+ function decodeKey(keyString, options) {
84
+ if (typeof keyString !== 'string') {
85
+ throw new TypeError('Invalid: expected a string');
86
+ }
87
+ const { hex, invalidGroups, code } = analyze(keyString, options);
88
+ if (code !== undefined) {
89
+ const where = invalidGroups.length === 1
90
+ ? `group ${invalidGroups[0] + 1}`
91
+ : `groups ${invalidGroups.map((i) => i + 1).join(', ')}`;
92
+ throw new Base32KeyError(code, `Invalid key: ${where} ${invalidGroups.length === 1 ? 'has' : 'have'} ${MESSAGES[code]}`, invalidGroups);
93
+ }
94
+ // Trim leading zeroes from result.
95
+ let i = 0;
96
+ const zero = BASE_16_DIGITS.charAt(0);
97
+ while (i < hex.length - 1 && hex.charAt(i) === zero) {
98
+ ++i;
29
99
  }
30
- return baseEncode(base32toBase16(base32num), BASE_16_DIGITS);
100
+ // A key that encodes the value zero may carry no data digits at all
101
+ // (e.g. the key "2" without groups but with a checksum), which decodes to "".
102
+ return hex.substring(i) || zero;
103
+ }
104
+ export function toHexString(keyString, ...args) {
105
+ return decodeKey(keyString, resolveOptions(args));
31
106
  }
32
107
  // cspell: disable
33
108
  /**
34
- * Decode Base32 key to HexString
109
+ * Check a key without throwing, for example while the user is typing.
35
110
  *
36
- * ### Example (es module)
111
+ * Input is normalized by default (whitespace, letter case and hyphen
112
+ * placement are ignored); pass `normalize: false` to check it as is.
113
+ *
114
+ * ### Example
37
115
  * ```js
38
- * import { toHexString } from 'base32-key'
39
- * console.log(fromHexString('222ET-3ZZGN'))
40
- * // => 'c0ffee'
116
+ * validate('222ET-3ZZGX')
117
+ * // => { valid: false, invalidGroups: [1], code: 'CHECKSUM_MISMATCH' }
41
118
  * ```
119
+ */
120
+ // cspell: enable
121
+ export function validate(keyString, options = {}) {
122
+ if (typeof keyString !== 'string') {
123
+ throw new TypeError('Invalid: expected a string');
124
+ }
125
+ const resolved = resolveOptions([options], true);
126
+ const { invalidGroups, code } = analyze(keyString, resolved);
127
+ return code === undefined
128
+ ? { valid: true, invalidGroups }
129
+ : { valid: false, invalidGroups, code };
130
+ }
131
+ // cspell: disable
132
+ /**
133
+ * Format raw user input as a key: drops whitespace, applies the alphabet's
134
+ * letter case and inserts hyphens between groups. Partial input is fine.
135
+ * Characters outside the alphabet are kept so `validate` can flag them.
42
136
  *
43
- * ### Example (commonjs)
137
+ * ### Example
44
138
  * ```js
45
- * var toHexString = require('base32-key').toHexString;
46
- * console.log(toHexString('222ET-3ZZGN'))
47
- * // => 'c0ffee'
139
+ * formatInput('222et3zz')
140
+ * // => '222ET-3ZZ'
48
141
  * ```
49
- *
50
- * @param keyString - Input Base32-Key.
51
- * @param grouped - Split the result into groups.
52
- * @param checked - Include the checksum into Base32-Key.
53
- * @param upperCase - Use uppercase or lowercase Base32-Key.
54
- * @returns Base-16 string.
55
- * @anotherNote Some other value.
56
142
  */
57
143
  // cspell: enable
58
- export const toHexString = (keyString, grouped = true, checked = true, upperCase = true) => {
59
- const result = keyString
60
- .split('-')
61
- .map((k) => decode(k, grouped, checked, upperCase))
62
- .join('');
63
- // Trim leading zeroes from result.
64
- let i = 0;
65
- const zero = BASE_16_DIGITS.charAt(0);
66
- while (i < result.length - 1 && result.charAt(i) === zero) {
67
- ++i;
144
+ export function formatInput(raw, options = {}) {
145
+ if (typeof raw !== 'string') {
146
+ throw new TypeError('Invalid: expected a string');
68
147
  }
69
- return result.substring(i);
70
- };
71
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVjb2RlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9kZWNvZGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUNMLGNBQWMsRUFDZCxjQUFjLEVBQ2Qsd0JBQXdCLEVBQ3hCLFVBQVUsRUFDVixVQUFVLEVBQ1YsYUFBYSxHQUNkLE1BQU0sU0FBUyxDQUFDO0FBRWpCLFNBQVMsY0FBYyxDQUFDLGFBQXVCO0lBQzdDLE9BQU8sYUFBYSxDQUFDLE1BQU0sR0FBRyxDQUFDLElBQUksQ0FBQyxFQUFFO1FBQ3BDLGFBQWEsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQUM7S0FDMUI7SUFDRCxNQUFNLGFBQWEsR0FBRyxFQUFFLENBQUM7SUFDekIsS0FBSyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxHQUFHLGFBQWEsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxJQUFJLENBQUMsRUFBRTtRQUNoRCxNQUFNLElBQUksR0FDUixDQUFDLGFBQWEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksRUFBRSxDQUFDO1lBQzVCLENBQUMsYUFBYSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUM7WUFDNUIsQ0FBQyxhQUFhLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUMzQixDQUFDLGFBQWEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDOUIsYUFBYSxDQUFDLElBQUksQ0FDaEIsQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDLEdBQUcsRUFBRSxFQUNqQixDQUFDLElBQUksSUFBSSxFQUFFLENBQUMsR0FBRyxFQUFFLEVBQ2pCLENBQUMsSUFBSSxJQUFJLENBQUMsQ0FBQyxHQUFHLEVBQUUsRUFDaEIsQ0FBQyxJQUFJLElBQUksQ0FBQyxDQUFDLEdBQUcsRUFBRSxFQUNoQixDQUFDLElBQUksSUFBSSxDQUFDLENBQUMsR0FBRyxFQUFFLENBQ2pCLENBQUM7S0FDSDtJQUNELE9BQU8sYUFBYSxDQUFDO0FBQ3ZCLENBQUM7QUFFRCxTQUFTLE1BQU0sQ0FDYixTQUFpQixFQUNqQixPQUFnQixFQUNoQixPQUFnQixFQUNoQixTQUFrQjtJQUVsQixNQUFNLE1BQU0sR0FBRyxTQUFTLENBQUMsQ0FBQyxDQUFDLGNBQWMsQ0FBQyxDQUFDLENBQUMsd0JBQXdCLENBQUM7SUFDckUsTUFBTSxTQUFTLEdBQUcsVUFBVSxDQUFDLFNBQVMsRUFBRSxNQUFNLENBQUMsQ0FBQztJQUNoRCxJQUNFLFNBQVMsSUFBSSxJQUFJO1FBQ2pCLENBQUMsT0FBTyxJQUFJLFNBQVMsQ0FBQyxNQUFNLElBQUksQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQ3REO1FBQ0EsTUFBTSxJQUFJLEtBQUssQ0FBQyxTQUFTLENBQUMsQ0FBQztLQUM1QjtJQUNELElBQUksT0FBTyxFQUFFO1FBQ1gsaUNBQWlDO1FBQ2pDLE1BQU0sS0FBSyxHQUFHLFNBQVMsQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUM5QixJQUFJLGFBQWEsQ0FBQyxTQUFTLENBQUMsS0FBSyxLQUFLLEVBQUU7WUFDdEMsTUFBTSxJQUFJLEtBQUssQ0FBQyxTQUFTLENBQUMsQ0FBQztTQUM1QjtLQUNGO0lBQ0QsT0FBTyxVQUFVLENBQUMsY0FBYyxDQUFDLFNBQVMsQ0FBQyxFQUFFLGNBQWMsQ0FBQyxDQUFDO0FBQy9ELENBQUM7QUFFRCxrQkFBa0I7QUFFbEI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBdUJHO0FBQ0gsaUJBQWlCO0FBQ2pCLE1BQU0sQ0FBQyxNQUFNLFdBQVcsR0FBRyxDQUN6QixTQUFpQixFQUNqQixPQUFPLEdBQUcsSUFBSSxFQUNkLE9BQU8sR0FBRyxJQUFJLEVBQ2QsU0FBUyxHQUFHLElBQUksRUFDUixFQUFFO0lBQ1YsTUFBTSxNQUFNLEdBQUcsU0FBUztTQUNyQixLQUFLLENBQUMsR0FBRyxDQUFDO1NBQ1YsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxNQUFNLENBQUMsQ0FBQyxFQUFFLE9BQU8sRUFBRSxPQUFPLEVBQUUsU0FBUyxDQUFDLENBQUM7U0FDbEQsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBRVosbUNBQW1DO0lBQ25DLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUNWLE1BQU0sSUFBSSxHQUFHLGNBQWMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDdEMsT0FBTyxDQUFDLEdBQUcsTUFBTSxDQUFDLE1BQU0sR0FBRyxDQUFDLElBQUksTUFBTSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsS0FBSyxJQUFJLEVBQUU7UUFDekQsRUFBRSxDQUFDLENBQUM7S0FDTDtJQUNELE9BQU8sTUFBTSxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsQ0FBQztBQUM3QixDQUFDLENBQUMifQ==
148
+ const resolved = resolveOptions([options], true);
149
+ return splitKey(raw, resolved).join(resolved.grouped ? '-' : '');
150
+ }
151
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVjb2RlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9kZWNvZGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLGNBQWMsRUFBc0IsTUFBTSxVQUFVLENBQUM7QUFDOUQsT0FBTyxFQUlMLGNBQWMsR0FDZixNQUFNLFdBQVcsQ0FBQztBQUNuQixPQUFPLEVBQ0wsY0FBYyxFQUNkLGNBQWMsRUFDZCx3QkFBd0IsRUFDeEIsVUFBVSxFQUNWLFVBQVUsRUFDVixhQUFhLEdBQ2QsTUFBTSxTQUFTLENBQUM7QUFFakIsU0FBUyxjQUFjLENBQUMsYUFBdUI7SUFDN0MsT0FBTyxhQUFhLENBQUMsTUFBTSxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQUU7UUFDcEMsYUFBYSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0FBQztLQUMxQjtJQUNELE1BQU0sYUFBYSxHQUFHLEVBQUUsQ0FBQztJQUN6QixLQUFLLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEdBQUcsYUFBYSxDQUFDLE1BQU0sRUFBRSxDQUFDLElBQUksQ0FBQyxFQUFFO1FBQ2hELE1BQU0sSUFBSSxHQUNSLENBQUMsYUFBYSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUM7WUFDNUIsQ0FBQyxhQUFhLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQztZQUM1QixDQUFDLGFBQWEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQzNCLENBQUMsYUFBYSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQztRQUM5QixhQUFhLENBQUMsSUFBSSxDQUNoQixDQUFDLElBQUksSUFBSSxFQUFFLENBQUMsR0FBRyxFQUFFLEVBQ2pCLENBQUMsSUFBSSxJQUFJLEVBQUUsQ0FBQyxHQUFHLEVBQUUsRUFDakIsQ0FBQyxJQUFJLElBQUksQ0FBQyxDQUFDLEdBQUcsRUFBRSxFQUNoQixDQUFDLElBQUksSUFBSSxDQUFDLENBQUMsR0FBRyxFQUFFLEVBQ2hCLENBQUMsSUFBSSxJQUFJLENBQUMsQ0FBQyxHQUFHLEVBQUUsQ0FDakIsQ0FBQztLQUNIO0lBQ0QsT0FBTyxhQUFhLENBQUM7QUFDdkIsQ0FBQztBQUVELG1FQUFtRTtBQUNuRSxNQUFNLFVBQVUsUUFBUSxDQUFDLFNBQWlCLEVBQUUsT0FBd0I7SUFDbEUsSUFBSSxDQUFDLE9BQU8sQ0FBQyxTQUFTLEVBQUU7UUFDdEIsT0FBTyxTQUFTLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0tBQzdCO0lBQ0QsTUFBTSxPQUFPLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQyxTQUFTLEVBQUUsRUFBRSxDQUFDLENBQUM7SUFDakQsTUFBTSxNQUFNLEdBQUcsT0FBTyxDQUFDLFNBQVM7UUFDOUIsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxXQUFXLEVBQUU7UUFDdkIsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxXQUFXLEVBQUUsQ0FBQztJQUMxQixJQUFJLENBQUMsT0FBTyxDQUFDLE9BQU8sRUFBRTtRQUNwQixPQUFPLENBQUMsTUFBTSxDQUFDLENBQUM7S0FDakI7SUFDRCxNQUFNLElBQUksR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUNyQyxNQUFNLE1BQU0sR0FBRyxFQUFFLENBQUM7SUFDbEIsS0FBSyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxHQUFHLE1BQU0sQ0FBQyxNQUFNLEVBQUUsQ0FBQyxJQUFJLElBQUksRUFBRTtRQUM1QyxNQUFNLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxTQUFTLENBQUMsQ0FBQyxFQUFFLENBQUMsR0FBRyxJQUFJLENBQUMsQ0FBQyxDQUFDO0tBQzVDO0lBQ0QsT0FBTyxNQUFNLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDO0FBQzNDLENBQUM7QUFNRCxTQUFTLFdBQVcsQ0FBQyxLQUFhLEVBQUUsT0FBd0I7SUFDMUQsTUFBTSxRQUFRLEdBQUcsT0FBTyxDQUFDLFNBQVM7UUFDaEMsQ0FBQyxDQUFDLGNBQWM7UUFDaEIsQ0FBQyxDQUFDLHdCQUF3QixDQUFDO0lBQzdCLE1BQU0sU0FBUyxHQUFHLFVBQVUsQ0FBQyxLQUFLLEVBQUUsUUFBUSxDQUFDLENBQUM7SUFDOUMsSUFBSSxTQUFTLElBQUksSUFBSSxFQUFFO1FBQ3JCLE9BQU8sRUFBRSxFQUFFLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBRSxtQkFBbUIsRUFBRSxDQUFDO0tBQ2pEO0lBQ0QsSUFDRSxTQUFTLENBQUMsTUFBTSxLQUFLLENBQUM7UUFDdEIsQ0FBQyxPQUFPLENBQUMsT0FBTyxJQUFJLFNBQVMsQ0FBQyxNQUFNLElBQUksQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxFQUN0RTtRQUNBLE9BQU8sRUFBRSxFQUFFLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBRSxnQkFBZ0IsRUFBRSxDQUFDO0tBQzlDO0lBQ0QsSUFBSSxPQUFPLENBQUMsT0FBTyxFQUFFO1FBQ25CLGlDQUFpQztRQUNqQyxNQUFNLEtBQUssR0FBRyxTQUFTLENBQUMsR0FBRyxFQUFFLENBQUM7UUFDOUIsSUFBSSxhQUFhLENBQUMsU0FBUyxDQUFDLEtBQUssS0FBSyxFQUFFO1lBQ3RDLE9BQU8sRUFBRSxFQUFFLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBRSxtQkFBbUIsRUFBRSxDQUFDO1NBQ2pEO0tBQ0Y7SUFDRCxPQUFPO1FBQ0wsRUFBRSxFQUFFLElBQUk7UUFDUixHQUFHLEVBQUUsVUFBVSxDQUFDLGNBQWMsQ0FBQyxTQUFTLENBQUMsRUFBRSxjQUFjLENBQUM7S0FDM0QsQ0FBQztBQUNKLENBQUM7QUFFRCxNQUFNLFFBQVEsR0FBdUQ7SUFDbkUsaUJBQWlCLEVBQUUsa0NBQWtDO0lBQ3JELGNBQWMsRUFBRSxrQkFBa0I7SUFDbEMsaUJBQWlCLEVBQUUsbUNBQW1DO0NBQ3ZELENBQUM7QUFZRixTQUFTLE9BQU8sQ0FBQyxTQUFpQixFQUFFLE9BQXdCO0lBQzFELE1BQU0sTUFBTSxHQUFHLFFBQVEsQ0FBQyxTQUFTLEVBQUUsT0FBTyxDQUFDLENBQUM7SUFDNUMsTUFBTSxhQUFhLEdBQWEsRUFBRSxDQUFDO0lBQ25DLElBQUksSUFBb0MsQ0FBQztJQUN6QyxJQUFJLEdBQUcsR0FBRyxFQUFFLENBQUM7SUFDYixNQUFNLENBQUMsT0FBTyxDQUFDLENBQUMsS0FBSyxFQUFFLEtBQUssRUFBRSxFQUFFO1FBQzlCLE1BQU0sTUFBTSxHQUFHLFdBQVcsQ0FBQyxLQUFLLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDM0MsSUFBSSxNQUFNLENBQUMsRUFBRSxFQUFFO1lBQ2IsR0FBRyxJQUFJLE1BQU0sQ0FBQyxHQUFHLENBQUM7U0FDbkI7YUFBTTtZQUNMLGFBQWEsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUM7WUFDMUIsSUFBSSxHQUFHLElBQUksSUFBSSxNQUFNLENBQUMsSUFBSSxDQUFDO1NBQzVCO0lBQ0gsQ0FBQyxDQUFDLENBQUM7SUFDSCxPQUFPLEVBQUUsR0FBRyxFQUFFLGFBQWEsRUFBRSxJQUFJLEVBQUUsQ0FBQztBQUN0QyxDQUFDO0FBRUQsU0FBUyxTQUFTLENBQUMsU0FBa0IsRUFBRSxPQUF3QjtJQUM3RCxJQUFJLE9BQU8sU0FBUyxLQUFLLFFBQVEsRUFBRTtRQUNqQyxNQUFNLElBQUksU0FBUyxDQUFDLDRCQUE0QixDQUFDLENBQUM7S0FDbkQ7SUFDRCxNQUFNLEVBQUUsR0FBRyxFQUFFLGFBQWEsRUFBRSxJQUFJLEVBQUUsR0FBRyxPQUFPLENBQUMsU0FBUyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQ2pFLElBQUksSUFBSSxLQUFLLFNBQVMsRUFBRTtRQUN0QixNQUFNLEtBQUssR0FDVCxhQUFhLENBQUMsTUFBTSxLQUFLLENBQUM7WUFDeEIsQ0FBQyxDQUFDLFNBQVMsYUFBYSxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUMsRUFBRTtZQUNqQyxDQUFDLENBQUMsVUFBVSxhQUFhLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUM7UUFDN0QsTUFBTSxJQUFJLGNBQWMsQ0FDdEIsSUFBSSxFQUNKLGdCQUFnQixLQUFLLElBQUksYUFBYSxDQUFDLE1BQU0sS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsTUFBTSxJQUNsRSxRQUFRLENBQUMsSUFBSSxDQUNmLEVBQUUsRUFDRixhQUFhLENBQ2QsQ0FBQztLQUNIO0lBRUQsbUNBQW1DO0lBQ25DLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUNWLE1BQU0sSUFBSSxHQUFHLGNBQWMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDdEMsT0FBTyxDQUFDLEdBQUcsR0FBRyxDQUFDLE1BQU0sR0FBRyxDQUFDLElBQUksR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsS0FBSyxJQUFJLEVBQUU7UUFDbkQsRUFBRSxDQUFDLENBQUM7S0FDTDtJQUNELG9FQUFvRTtJQUNwRSw4RUFBOEU7SUFDOUUsT0FBTyxHQUFHLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQyxJQUFJLElBQUksQ0FBQztBQUNsQyxDQUFDO0FBcUNELE1BQU0sVUFBVSxXQUFXLENBQUMsU0FBaUIsRUFBRSxHQUFHLElBQWU7SUFDL0QsT0FBTyxTQUFTLENBQUMsU0FBUyxFQUFFLGNBQWMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO0FBQ3BELENBQUM7QUFFRCxrQkFBa0I7QUFDbEI7Ozs7Ozs7Ozs7O0dBV0c7QUFDSCxpQkFBaUI7QUFDakIsTUFBTSxVQUFVLFFBQVEsQ0FDdEIsU0FBaUIsRUFDakIsVUFBeUIsRUFBRTtJQUUzQixJQUFJLE9BQU8sU0FBUyxLQUFLLFFBQVEsRUFBRTtRQUNqQyxNQUFNLElBQUksU0FBUyxDQUFDLDRCQUE0QixDQUFDLENBQUM7S0FDbkQ7SUFDRCxNQUFNLFFBQVEsR0FBRyxjQUFjLENBQUMsQ0FBQyxPQUFPLENBQUMsRUFBRSxJQUFJLENBQUMsQ0FBQztJQUNqRCxNQUFNLEVBQUUsYUFBYSxFQUFFLElBQUksRUFBRSxHQUFHLE9BQU8sQ0FBQyxTQUFTLEVBQUUsUUFBUSxDQUFDLENBQUM7SUFDN0QsT0FBTyxJQUFJLEtBQUssU0FBUztRQUN2QixDQUFDLENBQUMsRUFBRSxLQUFLLEVBQUUsSUFBSSxFQUFFLGFBQWEsRUFBRTtRQUNoQyxDQUFDLENBQUMsRUFBRSxLQUFLLEVBQUUsS0FBSyxFQUFFLGFBQWEsRUFBRSxJQUFJLEVBQUUsQ0FBQztBQUM1QyxDQUFDO0FBRUQsa0JBQWtCO0FBQ2xCOzs7Ozs7Ozs7O0dBVUc7QUFDSCxpQkFBaUI7QUFDakIsTUFBTSxVQUFVLFdBQVcsQ0FBQyxHQUFXLEVBQUUsVUFBeUIsRUFBRTtJQUNsRSxJQUFJLE9BQU8sR0FBRyxLQUFLLFFBQVEsRUFBRTtRQUMzQixNQUFNLElBQUksU0FBUyxDQUFDLDRCQUE0QixDQUFDLENBQUM7S0FDbkQ7SUFDRCxNQUFNLFFBQVEsR0FBRyxjQUFjLENBQUMsQ0FBQyxPQUFPLENBQUMsRUFBRSxJQUFJLENBQUMsQ0FBQztJQUNqRCxPQUFPLFFBQVEsQ0FBQyxHQUFHLEVBQUUsUUFBUSxDQUFDLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUM7QUFDbkUsQ0FBQyJ9
@@ -1,25 +1,29 @@
1
+ import { EncodeOptions } from './options';
2
+ export declare function encodeBase32(base32Numbers: number[], grouped: boolean, checked: boolean, upperCase: boolean, keepLeadingZeros?: boolean): string;
1
3
  /**
2
- * Encode Base32 key from HexString
4
+ * Encode a hex string as a Base32 key.
3
5
  *
4
- * ### Example (es module)
6
+ * ### Example
5
7
  * ```js
6
8
  * import { fromHexString } from 'base32-key'
7
- * console.log(fromHexString('c0ffee'))
9
+ * fromHexString('c0ffee')
8
10
  * // => '222ET-3ZZGN'
11
+ * fromHexString('c0ffee', { grouped: false, case: 'lower' })
12
+ * // => 'nb99qj'
9
13
  * ```
10
14
  *
11
- * ### Example (commonjs)
12
- * ```js
13
- * var fromHexString = require('base32-key').fromHexString;
14
- * console.log(fromHexString('c0ffee'))
15
- * // => '222ET-3ZZGN'
16
- * ```
17
- *
18
- * @param base16String - Input HexString.
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 Base32-Key string.
23
- * @anotherNote Some other value.
15
+ * @param base16String - Input hex string (an optional `0x` prefix is allowed).
16
+ * @param options - Encoding options, or the legacy `grouped` boolean.
17
+ * @returns Base32 key.
18
+ * @throws {@link Base32KeyError} with code `INVALID_HEX` if `base16String` is
19
+ * empty or contains non-hex characters.
20
+ */
21
+ export declare function fromHexString(base16String: string, options?: EncodeOptions): string;
22
+ /**
23
+ * @deprecated Pass an options object instead of positional booleans.
24
+ * @param base16String - Input hex string.
25
+ * @param grouped - Split the key into groups.
26
+ * @param checked - Add check digits.
27
+ * @param upperCase - Use the uppercase alphabet.
24
28
  */
25
- export declare const fromHexString: (base16String: string, grouped?: boolean, checked?: boolean, upperCase?: boolean) => string;
29
+ export declare function fromHexString(base16String: string, grouped?: boolean, checked?: boolean, upperCase?: boolean): string;
@@ -1,8 +1,20 @@
1
- import { BASE_32_DIGITS, BASE_32_DIGITS_LOWERCASE, calculateCrc5, } from './utils';
2
- function baseEncode(numArray, alphabet) {
3
- return numArray.map(alphabet.charAt.bind(alphabet)).join('');
1
+ import { Base32KeyError } from './errors';
2
+ import { resolveOptions } from './options';
3
+ import { BASE_16_DIGITS, BASE_32_DIGITS, BASE_32_DIGITS_LOWERCASE, baseDecode, baseEncode, calculateCrc5, } from './utils';
4
+ function parseHexString(base16String) {
5
+ if (typeof base16String !== 'string') {
6
+ throw new TypeError('Invalid hex string: expected a string');
7
+ }
8
+ const hex = /^0x/i.test(base16String)
9
+ ? base16String.substring(2)
10
+ : base16String;
11
+ const base16Numbers = baseDecode(hex.toLowerCase(), BASE_16_DIGITS);
12
+ if (base16Numbers == null || base16Numbers.length === 0) {
13
+ throw new Base32KeyError('INVALID_HEX', `Invalid hex string: "${base16String}"`);
14
+ }
15
+ return base16Numbers;
4
16
  }
5
- function encodeBase32(base32Numbers, grouped, checked, upperCase) {
17
+ export function encodeBase32(base32Numbers, grouped, checked, upperCase, keepLeadingZeros = false) {
6
18
  const digits = upperCase ? BASE_32_DIGITS : BASE_32_DIGITS_LOWERCASE;
7
19
  if (grouped) {
8
20
  // This assumes base32num.length is a multiple of 4.
@@ -21,7 +33,9 @@ function encodeBase32(base32Numbers, grouped, checked, upperCase) {
21
33
  base32Numbers.push(calculateCrc5(base32Numbers));
22
34
  }
23
35
  let i = 0;
24
- while (i + 1 < base32Numbers.length && base32Numbers[i] == 0) {
36
+ while (!keepLeadingZeros &&
37
+ i + 1 < base32Numbers.length &&
38
+ base32Numbers[i] == 0) {
25
39
  ++i;
26
40
  }
27
41
  return baseEncode(base32Numbers.slice(i), digits);
@@ -46,38 +60,10 @@ function numberToBase32(input) {
46
60
  }
47
61
  return base32num;
48
62
  }
49
- // cspell: disable
50
- /**
51
- * Encode Base32 key from HexString
52
- *
53
- * ### Example (es module)
54
- * ```js
55
- * import { fromHexString } from 'base32-key'
56
- * console.log(fromHexString('c0ffee'))
57
- * // => '222ET-3ZZGN'
58
- * ```
59
- *
60
- * ### Example (commonjs)
61
- * ```js
62
- * var fromHexString = require('base32-key').fromHexString;
63
- * console.log(fromHexString('c0ffee'))
64
- * // => '222ET-3ZZGN'
65
- * ```
66
- *
67
- * @param base16String - Input HexString.
68
- * @param grouped - Split the result into groups.
69
- * @param checked - Include the checksum into Base32-Key.
70
- * @param upperCase - Use uppercase or lowercase Base32-Key.
71
- * @returns Base32-Key string.
72
- * @anotherNote Some other value.
73
- */
74
- // cspell: enable
75
- export const fromHexString = (base16String, grouped = true, checked = true, upperCase = true) => {
76
- const base16Numbers = [...base16String].map((c) => {
77
- return parseInt(c, 16);
78
- });
63
+ export function fromHexString(base16String, ...args) {
64
+ const { grouped, checked, upperCase } = resolveOptions(args);
65
+ const base16Numbers = parseHexString(base16String);
79
66
  const base32Numbers = numberToBase32(base16Numbers);
80
- const result = encodeBase32(base32Numbers, grouped, checked, upperCase);
81
- return result;
82
- };
83
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW5jb2RlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9lbmNvZGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUNMLGNBQWMsRUFDZCx3QkFBd0IsRUFDeEIsYUFBYSxHQUNkLE1BQU0sU0FBUyxDQUFDO0FBRWpCLFNBQVMsVUFBVSxDQUFDLFFBQTJCLEVBQUUsUUFBZ0I7SUFDL0QsT0FBTyxRQUFRLENBQUMsR0FBRyxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDO0FBQy9ELENBQUM7QUFFRCxTQUFTLFlBQVksQ0FDbkIsYUFBdUIsRUFDdkIsT0FBZ0IsRUFDaEIsT0FBZ0IsRUFDaEIsU0FBa0I7SUFFbEIsTUFBTSxNQUFNLEdBQUcsU0FBUyxDQUFDLENBQUMsQ0FBQyxjQUFjLENBQUMsQ0FBQyxDQUFDLHdCQUF3QixDQUFDO0lBQ3JFLElBQUksT0FBTyxFQUFFO1FBQ1gsb0RBQW9EO1FBQ3BELE1BQU0sTUFBTSxHQUFHLEVBQUUsQ0FBQztRQUNsQixLQUFLLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEdBQUcsYUFBYSxDQUFDLE1BQU0sRUFBRSxDQUFDLElBQUksQ0FBQyxFQUFFO1lBQ2hELE1BQU0sUUFBUSxHQUFHLGFBQWEsQ0FBQyxLQUFLLENBQUMsQ0FBQyxFQUFFLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztZQUMvQyxJQUFJLE9BQU8sRUFBRTtnQkFDWCxRQUFRLENBQUMsSUFBSSxDQUFDLGFBQWEsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDO2FBQ3hDO1lBQ0QsTUFBTSxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsUUFBUSxFQUFFLE1BQU0sQ0FBQyxDQUFDLENBQUM7U0FDM0M7UUFDRCxPQUFPLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7S0FDekI7U0FBTTtRQUNMLElBQUksT0FBTyxFQUFFO1lBQ1gsYUFBYSxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQztTQUNsRDtRQUNELElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUNWLE9BQU8sQ0FBQyxHQUFHLENBQUMsR0FBRyxhQUFhLENBQUMsTUFBTSxJQUFJLGFBQWEsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLEVBQUU7WUFDNUQsRUFBRSxDQUFDLENBQUM7U0FDTDtRQUNELE9BQU8sVUFBVSxDQUFDLGFBQWEsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLEVBQUUsTUFBTSxDQUFDLENBQUM7S0FDbkQ7QUFDSCxDQUFDO0FBRUQsU0FBUyxjQUFjLENBQUMsS0FBd0I7SUFDOUMsTUFBTSxhQUFhLEdBQUcsS0FBSyxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUV2QyxPQUFPLGFBQWEsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxJQUFJLENBQUMsRUFBRTtRQUNwQyxhQUFhLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDO0tBQzFCO0lBRUQsTUFBTSxTQUFTLEdBQUcsRUFBRSxDQUFDO0lBRXJCLEtBQUssSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsR0FBRyxhQUFhLENBQUMsTUFBTSxFQUFFLENBQUMsSUFBSSxDQUFDLEVBQUU7UUFDaEQsTUFBTSxJQUFJLEdBQ1IsQ0FBQyxhQUFhLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQztZQUM1QixDQUFDLGFBQWEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksRUFBRSxDQUFDO1lBQzVCLENBQUMsYUFBYSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDM0IsQ0FBQyxhQUFhLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUMzQixDQUFDLGFBQWEsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDOUIsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksSUFBSSxFQUFFLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztRQUNsQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxJQUFJLEVBQUUsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDO1FBQ2xDLFNBQVMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLElBQUksQ0FBQyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7UUFDakMsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDLElBQUksSUFBSSxDQUFDLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztLQUNsQztJQUVELE9BQU8sU0FBUyxDQUFDO0FBQ25CLENBQUM7QUFFRCxrQkFBa0I7QUFDbEI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBdUJHO0FBRUgsaUJBQWlCO0FBQ2pCLE1BQU0sQ0FBQyxNQUFNLGFBQWEsR0FBRyxDQUMzQixZQUFvQixFQUNwQixPQUFPLEdBQUcsSUFBSSxFQUNkLE9BQU8sR0FBRyxJQUFJLEVBQ2QsU0FBUyxHQUFHLElBQUksRUFDUixFQUFFO0lBQ1YsTUFBTSxhQUFhLEdBQUcsQ0FBQyxHQUFHLFlBQVksQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsRUFBRSxFQUFFO1FBQ2hELE9BQU8sUUFBUSxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQztJQUN6QixDQUFDLENBQUMsQ0FBQztJQUNILE1BQU0sYUFBYSxHQUFHLGNBQWMsQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUNwRCxNQUFNLE1BQU0sR0FBRyxZQUFZLENBQUMsYUFBYSxFQUFFLE9BQU8sRUFBRSxPQUFPLEVBQUUsU0FBUyxDQUFDLENBQUM7SUFDeEUsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQyxDQUFDIn0=
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
package/package.json CHANGED
@@ -1,11 +1,14 @@
1
1
  {
2
2
  "name": "base32-key",
3
- "version": "1.0.8",
3
+ "version": "1.1.0",
4
4
  "description": "A base 32 encoding for binary strings",
5
5
  "main": "build/main/index.js",
6
6
  "typings": "build/main/index.d.ts",
7
7
  "module": "build/module/index.js",
8
- "repository": "https://github.com/ducminhquan/base32-key",
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "git+https://github.com/ducminhquan/base32-key.git"
11
+ },
9
12
  "license": "MIT",
10
13
  "keywords": [
11
14
  "base32",
@@ -25,28 +28,24 @@
25
28
  "test:prettier": "prettier \"src/**/*.ts\" --list-different",
26
29
  "test:spelling": "cspell \"{README.md,.github/*.md,src/**/*.ts}\"",
27
30
  "test:unit": "nyc --silent ava",
28
- "check-cli": "run-s test diff-integration-tests check-integration-tests",
29
- "check-integration-tests": "run-s check-integration-test:*",
30
- "diff-integration-tests": "mkdir -p diff && rm -rf diff/test && cp -r test diff/test && rm -rf diff/test/test-*/.git && cd diff && git init --quiet && git add -A && git commit --quiet --no-verify --allow-empty -m 'WIP' && echo '\\n\\nCommitted most recent integration test output in the \"diff\" directory. Review the changes with \"cd diff && git diff HEAD\" or your preferred git diff viewer.'",
31
31
  "watch:build": "tsc -p tsconfig.json -w",
32
32
  "watch:test": "nyc --silent ava --watch",
33
33
  "cov": "run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html",
34
34
  "cov:html": "nyc report --reporter=html",
35
35
  "cov:lcov": "nyc report --reporter=lcov",
36
- "cov:send": "run-s cov:lcov && codecov",
37
36
  "cov:check": "nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100",
38
37
  "doc": "run-s doc:html && open-cli build/docs/index.html",
39
38
  "doc:html": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs --excludeNotExported --excludeNotDocumented",
40
39
  "doc:json": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json",
41
40
  "doc:publish": "gh-pages -m \"[ci skip] Updates\" -d build/docs",
42
41
  "version": "standard-version",
42
+ "release": "standard-version && git push --follow-tags origin master",
43
43
  "reset-hard": "git clean -dfx && git reset --hard && npm i",
44
44
  "prepare-release": "run-s reset-hard test cov:check doc:html version doc:publish"
45
45
  },
46
46
  "engines": {
47
47
  "node": ">=10"
48
48
  },
49
- "dependencies": {},
50
49
  "devDependencies": {
51
50
  "@ava/typescript": "^1.1.1",
52
51
  "@istanbuljs/nyc-config-typescript": "^1.0.1",