nanoid 3.1.27 → 3.1.31
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/README.md +3 -3
- package/async/index.browser.cjs +35 -0
- package/async/index.browser.js +1 -36
- package/async/index.cjs +35 -0
- package/async/index.js +3 -39
- package/async/index.native.js +3 -34
- package/async/package.json +12 -0
- package/index.browser.cjs +62 -0
- package/index.browser.js +2 -44
- package/index.cjs +44 -0
- package/index.dev.js +62 -0
- package/index.js +9 -46
- package/index.prod.js +62 -0
- package/non-secure/index.cjs +21 -0
- package/non-secure/index.js +2 -11
- package/non-secure/package.json +6 -0
- package/package.json +44 -8
- package/url-alphabet/index.cjs +3 -0
- package/url-alphabet/index.js +2 -5
- package/url-alphabet/package.json +6 -0
- package/README.ru.md +0 -513
- package/README.zh-CN.md +0 -510
- package/bin/nanoid.test.js +0 -11
package/README.md
CHANGED
@@ -3,21 +3,21 @@
|
|
3
3
|
<img src="https://ai.github.io/nanoid/logo.svg" align="right"
|
4
4
|
alt="Nano ID logo by Anton Lovchikov" width="180" height="94">
|
5
5
|
|
6
|
-
**English** | [Русский](./README.ru.md) | [简体中文](./README.zh-CN.md)
|
6
|
+
**English** | [Русский](./README.ru.md) | [简体中文](./README.zh-CN.md) | [Bahasa Indonesia](./README.id-ID.md)
|
7
7
|
|
8
8
|
A tiny, secure, URL-friendly, unique string ID generator for JavaScript.
|
9
9
|
|
10
10
|
> “An amazing level of senseless perfectionism,
|
11
11
|
> which is simply impossible not to respect.”
|
12
12
|
|
13
|
-
* **Small.**
|
13
|
+
* **Small.** 130 bytes (minified and gzipped). No dependencies.
|
14
14
|
[Size Limit] controls the size.
|
15
15
|
* **Fast.** It is 2 times faster than UUID.
|
16
16
|
* **Safe.** It uses hardware random generator. Can be used in clusters.
|
17
17
|
* **Short IDs.** It uses a larger alphabet than UUID (`A-Za-z0-9_-`).
|
18
18
|
So ID size was reduced from 36 to 21 symbols.
|
19
19
|
* **Portable.** Nano ID was ported
|
20
|
-
to [
|
20
|
+
to [20 programming languages](#other-programming-languages).
|
21
21
|
|
22
22
|
```js
|
23
23
|
import { nanoid } from 'nanoid'
|
@@ -0,0 +1,35 @@
|
|
1
|
+
let random = bytes =>
|
2
|
+
Promise.resolve(crypto.getRandomValues(new Uint8Array(bytes)))
|
3
|
+
let customAlphabet = (alphabet, size) => {
|
4
|
+
let mask = (2 << (Math.log(alphabet.length - 1) / Math.LN2)) - 1
|
5
|
+
let step = -~((1.6 * mask * size) / alphabet.length)
|
6
|
+
return () => {
|
7
|
+
let id = ''
|
8
|
+
while (true) {
|
9
|
+
let bytes = crypto.getRandomValues(new Uint8Array(step))
|
10
|
+
let i = step
|
11
|
+
while (i--) {
|
12
|
+
id += alphabet[bytes[i] & mask] || ''
|
13
|
+
if (id.length === size) return Promise.resolve(id)
|
14
|
+
}
|
15
|
+
}
|
16
|
+
}
|
17
|
+
}
|
18
|
+
let nanoid = (size = 21) => {
|
19
|
+
let id = ''
|
20
|
+
let bytes = crypto.getRandomValues(new Uint8Array(size))
|
21
|
+
while (size--) {
|
22
|
+
let byte = bytes[size] & 63
|
23
|
+
if (byte < 36) {
|
24
|
+
id += byte.toString(36)
|
25
|
+
} else if (byte < 62) {
|
26
|
+
id += (byte - 26).toString(36).toUpperCase()
|
27
|
+
} else if (byte < 63) {
|
28
|
+
id += '_'
|
29
|
+
} else {
|
30
|
+
id += '-'
|
31
|
+
}
|
32
|
+
}
|
33
|
+
return Promise.resolve(id)
|
34
|
+
}
|
35
|
+
module.exports = { nanoid, customAlphabet, random }
|
package/async/index.browser.js
CHANGED
@@ -1,62 +1,28 @@
|
|
1
1
|
let random = bytes =>
|
2
2
|
Promise.resolve(crypto.getRandomValues(new Uint8Array(bytes)))
|
3
|
-
|
4
3
|
let customAlphabet = (alphabet, size) => {
|
5
|
-
// First, a bitmask is necessary to generate the ID. The bitmask makes bytes
|
6
|
-
// values closer to the alphabet size. The bitmask calculates the closest
|
7
|
-
// `2^31 - 1` number, which exceeds the alphabet size.
|
8
|
-
// For example, the bitmask for the alphabet size 30 is 31 (00011111).
|
9
|
-
// `Math.clz32` is not used, because it is not available in browsers.
|
10
4
|
let mask = (2 << (Math.log(alphabet.length - 1) / Math.LN2)) - 1
|
11
|
-
// Though, the bitmask solution is not perfect since the bytes exceeding
|
12
|
-
// the alphabet size are refused. Therefore, to reliably generate the ID,
|
13
|
-
// the random bytes redundancy has to be satisfied.
|
14
|
-
|
15
|
-
// Note: every hardware random generator call is performance expensive,
|
16
|
-
// because the system call for entropy collection takes a lot of time.
|
17
|
-
// So, to avoid additional system calls, extra bytes are requested in advance.
|
18
|
-
|
19
|
-
// Next, a step determines how many random bytes to generate.
|
20
|
-
// The number of random bytes gets decided upon the ID size, mask,
|
21
|
-
// alphabet size, and magic number 1.6 (using 1.6 peaks at performance
|
22
|
-
// according to benchmarks).
|
23
|
-
|
24
|
-
// `-~f => Math.ceil(f)` if f is a float
|
25
|
-
// `-~i => i + 1` if i is an integer
|
26
5
|
let step = -~((1.6 * mask * size) / alphabet.length)
|
27
|
-
|
28
6
|
return () => {
|
29
7
|
let id = ''
|
30
8
|
while (true) {
|
31
9
|
let bytes = crypto.getRandomValues(new Uint8Array(step))
|
32
|
-
// A compact alternative for `for (var i = 0; i < step; i++)`.
|
33
10
|
let i = step
|
34
11
|
while (i--) {
|
35
|
-
// Adding `|| ''` refuses a random byte that exceeds the alphabet size.
|
36
12
|
id += alphabet[bytes[i] & mask] || ''
|
37
13
|
if (id.length === size) return Promise.resolve(id)
|
38
14
|
}
|
39
15
|
}
|
40
16
|
}
|
41
17
|
}
|
42
|
-
|
43
18
|
let nanoid = (size = 21) => {
|
44
19
|
let id = ''
|
45
20
|
let bytes = crypto.getRandomValues(new Uint8Array(size))
|
46
|
-
|
47
|
-
// A compact alternative for `for (var i = 0; i < step; i++)`.
|
48
21
|
while (size--) {
|
49
|
-
// It is incorrect to use bytes exceeding the alphabet size.
|
50
|
-
// The following mask reduces the random byte in the 0-255 value
|
51
|
-
// range to the 0-63 value range. Therefore, adding hacks, such
|
52
|
-
// as empty string fallback or magic numbers, is unneccessary because
|
53
|
-
// the bitmask trims bytes down to the alphabet size.
|
54
22
|
let byte = bytes[size] & 63
|
55
23
|
if (byte < 36) {
|
56
|
-
// `0-9a-z`
|
57
24
|
id += byte.toString(36)
|
58
25
|
} else if (byte < 62) {
|
59
|
-
// `A-Z`
|
60
26
|
id += (byte - 26).toString(36).toUpperCase()
|
61
27
|
} else if (byte < 63) {
|
62
28
|
id += '_'
|
@@ -66,5 +32,4 @@ let nanoid = (size = 21) => {
|
|
66
32
|
}
|
67
33
|
return Promise.resolve(id)
|
68
34
|
}
|
69
|
-
|
70
|
-
module.exports = { nanoid, customAlphabet, random }
|
35
|
+
export { nanoid, customAlphabet, random }
|
package/async/index.cjs
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
let crypto = require('crypto')
|
2
|
+
let { urlAlphabet } = require('../url-alphabet/index.cjs')
|
3
|
+
let random = bytes =>
|
4
|
+
new Promise((resolve, reject) => {
|
5
|
+
crypto.randomFill(Buffer.allocUnsafe(bytes), (err, buf) => {
|
6
|
+
if (err) {
|
7
|
+
reject(err)
|
8
|
+
} else {
|
9
|
+
resolve(buf)
|
10
|
+
}
|
11
|
+
})
|
12
|
+
})
|
13
|
+
let customAlphabet = (alphabet, size) => {
|
14
|
+
let mask = (2 << (31 - Math.clz32((alphabet.length - 1) | 1))) - 1
|
15
|
+
let step = Math.ceil((1.6 * mask * size) / alphabet.length)
|
16
|
+
let tick = id =>
|
17
|
+
random(step).then(bytes => {
|
18
|
+
let i = step
|
19
|
+
while (i--) {
|
20
|
+
id += alphabet[bytes[i] & mask] || ''
|
21
|
+
if (id.length === size) return id
|
22
|
+
}
|
23
|
+
return tick(id)
|
24
|
+
})
|
25
|
+
return () => tick('')
|
26
|
+
}
|
27
|
+
let nanoid = (size = 21) =>
|
28
|
+
random(size).then(bytes => {
|
29
|
+
let id = ''
|
30
|
+
while (size--) {
|
31
|
+
id += urlAlphabet[bytes[size] & 63]
|
32
|
+
}
|
33
|
+
return id
|
34
|
+
})
|
35
|
+
module.exports = { nanoid, customAlphabet, random }
|
package/async/index.js
CHANGED
@@ -1,14 +1,7 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
let { urlAlphabet } = require('../url-alphabet')
|
4
|
-
|
5
|
-
// `crypto.randomFill()` is a little faster than `crypto.randomBytes()`,
|
6
|
-
// because it is possible to use in combination with `Buffer.allocUnsafe()`.
|
1
|
+
import crypto from 'crypto'
|
2
|
+
import { urlAlphabet } from '../url-alphabet/index.js'
|
7
3
|
let random = bytes =>
|
8
4
|
new Promise((resolve, reject) => {
|
9
|
-
// `Buffer.allocUnsafe()` is faster because it doesn’t flush the memory.
|
10
|
-
// Memory flushing is unnecessary since the buffer allocation itself resets
|
11
|
-
// the memory with the new bytes.
|
12
5
|
crypto.randomFill(Buffer.allocUnsafe(bytes), (err, buf) => {
|
13
6
|
if (err) {
|
14
7
|
reject(err)
|
@@ -17,55 +10,26 @@ let random = bytes =>
|
|
17
10
|
}
|
18
11
|
})
|
19
12
|
})
|
20
|
-
|
21
13
|
let customAlphabet = (alphabet, size) => {
|
22
|
-
// First, a bitmask is necessary to generate the ID. The bitmask makes bytes
|
23
|
-
// values closer to the alphabet size. The bitmask calculates the closest
|
24
|
-
// `2^31 - 1` number, which exceeds the alphabet size.
|
25
|
-
// For example, the bitmask for the alphabet size 30 is 31 (00011111).
|
26
14
|
let mask = (2 << (31 - Math.clz32((alphabet.length - 1) | 1))) - 1
|
27
|
-
// Though, the bitmask solution is not perfect since the bytes exceeding
|
28
|
-
// the alphabet size are refused. Therefore, to reliably generate the ID,
|
29
|
-
// the random bytes redundancy has to be satisfied.
|
30
|
-
|
31
|
-
// Note: every hardware random generator call is performance expensive,
|
32
|
-
// because the system call for entropy collection takes a lot of time.
|
33
|
-
// So, to avoid additional system calls, extra bytes are requested in advance.
|
34
|
-
|
35
|
-
// Next, a step determines how many random bytes to generate.
|
36
|
-
// The number of random bytes gets decided upon the ID size, mask,
|
37
|
-
// alphabet size, and magic number 1.6 (using 1.6 peaks at performance
|
38
|
-
// according to benchmarks).
|
39
15
|
let step = Math.ceil((1.6 * mask * size) / alphabet.length)
|
40
|
-
|
41
16
|
let tick = id =>
|
42
17
|
random(step).then(bytes => {
|
43
|
-
// A compact alternative for `for (var i = 0; i < step; i++)`.
|
44
18
|
let i = step
|
45
19
|
while (i--) {
|
46
|
-
// Adding `|| ''` refuses a random byte that exceeds the alphabet size.
|
47
20
|
id += alphabet[bytes[i] & mask] || ''
|
48
21
|
if (id.length === size) return id
|
49
22
|
}
|
50
23
|
return tick(id)
|
51
24
|
})
|
52
|
-
|
53
25
|
return () => tick('')
|
54
26
|
}
|
55
|
-
|
56
27
|
let nanoid = (size = 21) =>
|
57
28
|
random(size).then(bytes => {
|
58
29
|
let id = ''
|
59
|
-
// A compact alternative for `for (var i = 0; i < step; i++)`.
|
60
30
|
while (size--) {
|
61
|
-
// It is incorrect to use bytes exceeding the alphabet size.
|
62
|
-
// The following mask reduces the random byte in the 0-255 value
|
63
|
-
// range to the 0-63 value range. Therefore, adding hacks, such
|
64
|
-
// as empty string fallback or magic numbers, is unneccessary because
|
65
|
-
// the bitmask trims bytes down to the alphabet size.
|
66
31
|
id += urlAlphabet[bytes[size] & 63]
|
67
32
|
}
|
68
33
|
return id
|
69
34
|
})
|
70
|
-
|
71
|
-
module.exports = { nanoid, customAlphabet, random }
|
35
|
+
export { nanoid, customAlphabet, random }
|
package/async/index.native.js
CHANGED
@@ -1,57 +1,26 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
let { urlAlphabet } = require('../url-alphabet')
|
4
|
-
|
1
|
+
import { getRandomBytesAsync } from 'expo-random'
|
2
|
+
import { urlAlphabet } from '../url-alphabet/index.js'
|
5
3
|
let random = getRandomBytesAsync
|
6
|
-
|
7
4
|
let customAlphabet = (alphabet, size) => {
|
8
|
-
// First, a bitmask is necessary to generate the ID. The bitmask makes bytes
|
9
|
-
// values closer to the alphabet size. The bitmask calculates the closest
|
10
|
-
// `2^31 - 1` number, which exceeds the alphabet size.
|
11
|
-
// For example, the bitmask for the alphabet size 30 is 31 (00011111).
|
12
5
|
let mask = (2 << (31 - Math.clz32((alphabet.length - 1) | 1))) - 1
|
13
|
-
// Though, the bitmask solution is not perfect since the bytes exceeding
|
14
|
-
// the alphabet size are refused. Therefore, to reliably generate the ID,
|
15
|
-
// the random bytes redundancy has to be satisfied.
|
16
|
-
|
17
|
-
// Note: every hardware random generator call is performance expensive,
|
18
|
-
// because the system call for entropy collection takes a lot of time.
|
19
|
-
// So, to avoid additional system calls, extra bytes are requested in advance.
|
20
|
-
|
21
|
-
// Next, a step determines how many random bytes to generate.
|
22
|
-
// The number of random bytes gets decided upon the ID size, mask,
|
23
|
-
// alphabet size, and magic number 1.6 (using 1.6 peaks at performance
|
24
|
-
// according to benchmarks).
|
25
6
|
let step = Math.ceil((1.6 * mask * size) / alphabet.length)
|
26
|
-
|
27
7
|
let tick = id =>
|
28
8
|
random(step).then(bytes => {
|
29
|
-
// A compact alternative for `for (var i = 0; i < step; i++)`.
|
30
9
|
let i = step
|
31
10
|
while (i--) {
|
32
|
-
// Adding `|| ''` refuses a random byte that exceeds the alphabet size.
|
33
11
|
id += alphabet[bytes[i] & mask] || ''
|
34
12
|
if (id.length === size) return id
|
35
13
|
}
|
36
14
|
return tick(id)
|
37
15
|
})
|
38
|
-
|
39
16
|
return () => tick('')
|
40
17
|
}
|
41
|
-
|
42
18
|
let nanoid = (size = 21) =>
|
43
19
|
random(size).then(bytes => {
|
44
20
|
let id = ''
|
45
|
-
// A compact alternative for `for (var i = 0; i < step; i++)`.
|
46
21
|
while (size--) {
|
47
|
-
// It is incorrect to use bytes exceeding the alphabet size.
|
48
|
-
// The following mask reduces the random byte in the 0-255 value
|
49
|
-
// range to the 0-63 value range. Therefore, adding hacks, such
|
50
|
-
// as empty string fallback or magic numbers, is unneccessary because
|
51
|
-
// the bitmask trims bytes down to the alphabet size.
|
52
22
|
id += urlAlphabet[bytes[size] & 63]
|
53
23
|
}
|
54
24
|
return id
|
55
25
|
})
|
56
|
-
|
57
|
-
module.exports = { nanoid, customAlphabet, random }
|
26
|
+
export { nanoid, customAlphabet, random }
|
@@ -0,0 +1,62 @@
|
|
1
|
+
let { urlAlphabet } = require('./url-alphabet/index.cjs')
|
2
|
+
if (process.env.NODE_ENV !== 'production') {
|
3
|
+
if (
|
4
|
+
typeof navigator !== 'undefined' &&
|
5
|
+
navigator.product === 'ReactNative' &&
|
6
|
+
typeof crypto === 'undefined'
|
7
|
+
) {
|
8
|
+
throw new Error(
|
9
|
+
'React Native does not have a built-in secure random generator. ' +
|
10
|
+
'If you don’t need unpredictable IDs use `nanoid/non-secure`. ' +
|
11
|
+
'For secure IDs, import `react-native-get-random-values` ' +
|
12
|
+
'before Nano ID.'
|
13
|
+
)
|
14
|
+
}
|
15
|
+
if (typeof msCrypto !== 'undefined' && typeof crypto === 'undefined') {
|
16
|
+
throw new Error(
|
17
|
+
'Import file with `if (!window.crypto) window.crypto = window.msCrypto`' +
|
18
|
+
' before importing Nano ID to fix IE 11 support'
|
19
|
+
)
|
20
|
+
}
|
21
|
+
if (typeof crypto === 'undefined') {
|
22
|
+
throw new Error(
|
23
|
+
'Your browser does not have secure random generator. ' +
|
24
|
+
'If you don’t need unpredictable IDs, you can use nanoid/non-secure.'
|
25
|
+
)
|
26
|
+
}
|
27
|
+
}
|
28
|
+
let random = bytes => crypto.getRandomValues(new Uint8Array(bytes))
|
29
|
+
let customRandom = (alphabet, size, getRandom) => {
|
30
|
+
let mask = (2 << (Math.log(alphabet.length - 1) / Math.LN2)) - 1
|
31
|
+
let step = -~((1.6 * mask * size) / alphabet.length)
|
32
|
+
return () => {
|
33
|
+
let id = ''
|
34
|
+
while (true) {
|
35
|
+
let bytes = getRandom(step)
|
36
|
+
let j = step
|
37
|
+
while (j--) {
|
38
|
+
id += alphabet[bytes[j] & mask] || ''
|
39
|
+
if (id.length === size) return id
|
40
|
+
}
|
41
|
+
}
|
42
|
+
}
|
43
|
+
}
|
44
|
+
let customAlphabet = (alphabet, size) => customRandom(alphabet, size, random)
|
45
|
+
let nanoid = (size = 21) => {
|
46
|
+
let id = ''
|
47
|
+
let bytes = crypto.getRandomValues(new Uint8Array(size))
|
48
|
+
while (size--) {
|
49
|
+
let byte = bytes[size] & 63
|
50
|
+
if (byte < 36) {
|
51
|
+
id += byte.toString(36)
|
52
|
+
} else if (byte < 62) {
|
53
|
+
id += (byte - 26).toString(36).toUpperCase()
|
54
|
+
} else if (byte < 63) {
|
55
|
+
id += '_'
|
56
|
+
} else {
|
57
|
+
id += '-'
|
58
|
+
}
|
59
|
+
}
|
60
|
+
return id
|
61
|
+
}
|
62
|
+
module.exports = { nanoid, customAlphabet, customRandom, urlAlphabet, random }
|
package/index.browser.js
CHANGED
@@ -1,10 +1,5 @@
|
|
1
|
-
|
2
|
-
// according to `browser` config in `package.json`.
|
3
|
-
|
4
|
-
let { urlAlphabet } = require('./url-alphabet')
|
5
|
-
|
1
|
+
import { urlAlphabet } from './url-alphabet/index.js'
|
6
2
|
if (process.env.NODE_ENV !== 'production') {
|
7
|
-
// All bundlers will remove this block in the production bundle.
|
8
3
|
if (
|
9
4
|
typeof navigator !== 'undefined' &&
|
10
5
|
navigator.product === 'ReactNative' &&
|
@@ -30,67 +25,31 @@ if (process.env.NODE_ENV !== 'production') {
|
|
30
25
|
)
|
31
26
|
}
|
32
27
|
}
|
33
|
-
|
34
28
|
let random = bytes => crypto.getRandomValues(new Uint8Array(bytes))
|
35
|
-
|
36
29
|
let customRandom = (alphabet, size, getRandom) => {
|
37
|
-
// First, a bitmask is necessary to generate the ID. The bitmask makes bytes
|
38
|
-
// values closer to the alphabet size. The bitmask calculates the closest
|
39
|
-
// `2^31 - 1` number, which exceeds the alphabet size.
|
40
|
-
// For example, the bitmask for the alphabet size 30 is 31 (00011111).
|
41
|
-
// `Math.clz32` is not used, because it is not available in browsers.
|
42
30
|
let mask = (2 << (Math.log(alphabet.length - 1) / Math.LN2)) - 1
|
43
|
-
// Though, the bitmask solution is not perfect since the bytes exceeding
|
44
|
-
// the alphabet size are refused. Therefore, to reliably generate the ID,
|
45
|
-
// the random bytes redundancy has to be satisfied.
|
46
|
-
|
47
|
-
// Note: every hardware random generator call is performance expensive,
|
48
|
-
// because the system call for entropy collection takes a lot of time.
|
49
|
-
// So, to avoid additional system calls, extra bytes are requested in advance.
|
50
|
-
|
51
|
-
// Next, a step determines how many random bytes to generate.
|
52
|
-
// The number of random bytes gets decided upon the ID size, mask,
|
53
|
-
// alphabet size, and magic number 1.6 (using 1.6 peaks at performance
|
54
|
-
// according to benchmarks).
|
55
|
-
|
56
|
-
// `-~f => Math.ceil(f)` if f is a float
|
57
|
-
// `-~i => i + 1` if i is an integer
|
58
31
|
let step = -~((1.6 * mask * size) / alphabet.length)
|
59
|
-
|
60
32
|
return () => {
|
61
33
|
let id = ''
|
62
34
|
while (true) {
|
63
35
|
let bytes = getRandom(step)
|
64
|
-
// A compact alternative for `for (var i = 0; i < step; i++)`.
|
65
36
|
let j = step
|
66
37
|
while (j--) {
|
67
|
-
// Adding `|| ''` refuses a random byte that exceeds the alphabet size.
|
68
38
|
id += alphabet[bytes[j] & mask] || ''
|
69
39
|
if (id.length === size) return id
|
70
40
|
}
|
71
41
|
}
|
72
42
|
}
|
73
43
|
}
|
74
|
-
|
75
44
|
let customAlphabet = (alphabet, size) => customRandom(alphabet, size, random)
|
76
|
-
|
77
45
|
let nanoid = (size = 21) => {
|
78
46
|
let id = ''
|
79
47
|
let bytes = crypto.getRandomValues(new Uint8Array(size))
|
80
|
-
|
81
|
-
// A compact alternative for `for (var i = 0; i < step; i++)`.
|
82
48
|
while (size--) {
|
83
|
-
// It is incorrect to use bytes exceeding the alphabet size.
|
84
|
-
// The following mask reduces the random byte in the 0-255 value
|
85
|
-
// range to the 0-63 value range. Therefore, adding hacks, such
|
86
|
-
// as empty string fallback or magic numbers, is unneccessary because
|
87
|
-
// the bitmask trims bytes down to the alphabet size.
|
88
49
|
let byte = bytes[size] & 63
|
89
50
|
if (byte < 36) {
|
90
|
-
// `0-9a-z`
|
91
51
|
id += byte.toString(36)
|
92
52
|
} else if (byte < 62) {
|
93
|
-
// `A-Z`
|
94
53
|
id += (byte - 26).toString(36).toUpperCase()
|
95
54
|
} else if (byte < 63) {
|
96
55
|
id += '_'
|
@@ -100,5 +59,4 @@ let nanoid = (size = 21) => {
|
|
100
59
|
}
|
101
60
|
return id
|
102
61
|
}
|
103
|
-
|
104
|
-
module.exports = { nanoid, customAlphabet, customRandom, urlAlphabet, random }
|
62
|
+
export { nanoid, customAlphabet, customRandom, urlAlphabet, random }
|
package/index.cjs
ADDED
@@ -0,0 +1,44 @@
|
|
1
|
+
let crypto = require('crypto')
|
2
|
+
let { urlAlphabet } = require('./url-alphabet/index.cjs')
|
3
|
+
const POOL_SIZE_MULTIPLIER = 128
|
4
|
+
let pool, poolOffset
|
5
|
+
let fillPool = bytes => {
|
6
|
+
if (!pool || pool.length < bytes) {
|
7
|
+
pool = Buffer.allocUnsafe(bytes * POOL_SIZE_MULTIPLIER)
|
8
|
+
crypto.randomFillSync(pool)
|
9
|
+
poolOffset = 0
|
10
|
+
} else if (poolOffset + bytes > pool.length) {
|
11
|
+
crypto.randomFillSync(pool)
|
12
|
+
poolOffset = 0
|
13
|
+
}
|
14
|
+
poolOffset += bytes
|
15
|
+
}
|
16
|
+
let random = bytes => {
|
17
|
+
fillPool((bytes -= 0))
|
18
|
+
return pool.subarray(poolOffset - bytes, poolOffset)
|
19
|
+
}
|
20
|
+
let customRandom = (alphabet, size, getRandom) => {
|
21
|
+
let mask = (2 << (31 - Math.clz32((alphabet.length - 1) | 1))) - 1
|
22
|
+
let step = Math.ceil((1.6 * mask * size) / alphabet.length)
|
23
|
+
return () => {
|
24
|
+
let id = ''
|
25
|
+
while (true) {
|
26
|
+
let bytes = getRandom(step)
|
27
|
+
let i = step
|
28
|
+
while (i--) {
|
29
|
+
id += alphabet[bytes[i] & mask] || ''
|
30
|
+
if (id.length === size) return id
|
31
|
+
}
|
32
|
+
}
|
33
|
+
}
|
34
|
+
}
|
35
|
+
let customAlphabet = (alphabet, size) => customRandom(alphabet, size, random)
|
36
|
+
let nanoid = (size = 21) => {
|
37
|
+
fillPool((size -= 0))
|
38
|
+
let id = ''
|
39
|
+
for (let i = poolOffset - size; i < poolOffset; i++) {
|
40
|
+
id += urlAlphabet[pool[i] & 63]
|
41
|
+
}
|
42
|
+
return id
|
43
|
+
}
|
44
|
+
module.exports = { nanoid, customAlphabet, customRandom, urlAlphabet, random }
|
package/index.dev.js
ADDED
@@ -0,0 +1,62 @@
|
|
1
|
+
import { urlAlphabet } from './url-alphabet/index.js'
|
2
|
+
if (true) {
|
3
|
+
if (
|
4
|
+
typeof navigator !== 'undefined' &&
|
5
|
+
navigator.product === 'ReactNative' &&
|
6
|
+
typeof crypto === 'undefined'
|
7
|
+
) {
|
8
|
+
throw new Error(
|
9
|
+
'React Native does not have a built-in secure random generator. ' +
|
10
|
+
'If you don’t need unpredictable IDs use `nanoid/non-secure`. ' +
|
11
|
+
'For secure IDs, import `react-native-get-random-values` ' +
|
12
|
+
'before Nano ID.'
|
13
|
+
)
|
14
|
+
}
|
15
|
+
if (typeof msCrypto !== 'undefined' && typeof crypto === 'undefined') {
|
16
|
+
throw new Error(
|
17
|
+
'Import file with `if (!window.crypto) window.crypto = window.msCrypto`' +
|
18
|
+
' before importing Nano ID to fix IE 11 support'
|
19
|
+
)
|
20
|
+
}
|
21
|
+
if (typeof crypto === 'undefined') {
|
22
|
+
throw new Error(
|
23
|
+
'Your browser does not have secure random generator. ' +
|
24
|
+
'If you don’t need unpredictable IDs, you can use nanoid/non-secure.'
|
25
|
+
)
|
26
|
+
}
|
27
|
+
}
|
28
|
+
let random = bytes => crypto.getRandomValues(new Uint8Array(bytes))
|
29
|
+
let customRandom = (alphabet, size, getRandom) => {
|
30
|
+
let mask = (2 << (Math.log(alphabet.length - 1) / Math.LN2)) - 1
|
31
|
+
let step = -~((1.6 * mask * size) / alphabet.length)
|
32
|
+
return () => {
|
33
|
+
let id = ''
|
34
|
+
while (true) {
|
35
|
+
let bytes = getRandom(step)
|
36
|
+
let j = step
|
37
|
+
while (j--) {
|
38
|
+
id += alphabet[bytes[j] & mask] || ''
|
39
|
+
if (id.length === size) return id
|
40
|
+
}
|
41
|
+
}
|
42
|
+
}
|
43
|
+
}
|
44
|
+
let customAlphabet = (alphabet, size) => customRandom(alphabet, size, random)
|
45
|
+
let nanoid = (size = 21) => {
|
46
|
+
let id = ''
|
47
|
+
let bytes = crypto.getRandomValues(new Uint8Array(size))
|
48
|
+
while (size--) {
|
49
|
+
let byte = bytes[size] & 63
|
50
|
+
if (byte < 36) {
|
51
|
+
id += byte.toString(36)
|
52
|
+
} else if (byte < 62) {
|
53
|
+
id += (byte - 26).toString(36).toUpperCase()
|
54
|
+
} else if (byte < 63) {
|
55
|
+
id += '_'
|
56
|
+
} else {
|
57
|
+
id += '-'
|
58
|
+
}
|
59
|
+
}
|
60
|
+
return id
|
61
|
+
}
|
62
|
+
export { nanoid, customAlphabet, customRandom, urlAlphabet, random }
|
package/index.js
CHANGED
@@ -1,20 +1,7 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
// It is best to make fewer, larger requests to the crypto module to
|
6
|
-
// avoid system call overhead. So, random numbers are generated in a
|
7
|
-
// pool. The pool is a Buffer that is larger than the initial random
|
8
|
-
// request size by this multiplier. The pool is enlarged if subsequent
|
9
|
-
// requests exceed the maximum buffer size.
|
10
|
-
const POOL_SIZE_MULTIPLIER = 32
|
1
|
+
import crypto from 'crypto'
|
2
|
+
import { urlAlphabet } from './url-alphabet/index.js'
|
3
|
+
const POOL_SIZE_MULTIPLIER = 128
|
11
4
|
let pool, poolOffset
|
12
|
-
|
13
|
-
let random = bytes => {
|
14
|
-
fillPool(bytes)
|
15
|
-
return pool.subarray(poolOffset - bytes, poolOffset)
|
16
|
-
}
|
17
|
-
|
18
5
|
let fillPool = bytes => {
|
19
6
|
if (!pool || pool.length < bytes) {
|
20
7
|
pool = Buffer.allocUnsafe(bytes * POOL_SIZE_MULTIPLIER)
|
@@ -26,56 +13,32 @@ let fillPool = bytes => {
|
|
26
13
|
}
|
27
14
|
poolOffset += bytes
|
28
15
|
}
|
29
|
-
|
16
|
+
let random = bytes => {
|
17
|
+
fillPool((bytes -= 0))
|
18
|
+
return pool.subarray(poolOffset - bytes, poolOffset)
|
19
|
+
}
|
30
20
|
let customRandom = (alphabet, size, getRandom) => {
|
31
|
-
// First, a bitmask is necessary to generate the ID. The bitmask makes bytes
|
32
|
-
// values closer to the alphabet size. The bitmask calculates the closest
|
33
|
-
// `2^31 - 1` number, which exceeds the alphabet size.
|
34
|
-
// For example, the bitmask for the alphabet size 30 is 31 (00011111).
|
35
21
|
let mask = (2 << (31 - Math.clz32((alphabet.length - 1) | 1))) - 1
|
36
|
-
// Though, the bitmask solution is not perfect since the bytes exceeding
|
37
|
-
// the alphabet size are refused. Therefore, to reliably generate the ID,
|
38
|
-
// the random bytes redundancy has to be satisfied.
|
39
|
-
|
40
|
-
// Note: every hardware random generator call is performance expensive,
|
41
|
-
// because the system call for entropy collection takes a lot of time.
|
42
|
-
// So, to avoid additional system calls, extra bytes are requested in advance.
|
43
|
-
|
44
|
-
// Next, a step determines how many random bytes to generate.
|
45
|
-
// The number of random bytes gets decided upon the ID size, mask,
|
46
|
-
// alphabet size, and magic number 1.6 (using 1.6 peaks at performance
|
47
|
-
// according to benchmarks).
|
48
22
|
let step = Math.ceil((1.6 * mask * size) / alphabet.length)
|
49
|
-
|
50
23
|
return () => {
|
51
24
|
let id = ''
|
52
25
|
while (true) {
|
53
26
|
let bytes = getRandom(step)
|
54
|
-
// A compact alternative for `for (let i = 0; i < step; i++)`.
|
55
27
|
let i = step
|
56
28
|
while (i--) {
|
57
|
-
// Adding `|| ''` refuses a random byte that exceeds the alphabet size.
|
58
29
|
id += alphabet[bytes[i] & mask] || ''
|
59
30
|
if (id.length === size) return id
|
60
31
|
}
|
61
32
|
}
|
62
33
|
}
|
63
34
|
}
|
64
|
-
|
65
35
|
let customAlphabet = (alphabet, size) => customRandom(alphabet, size, random)
|
66
|
-
|
67
36
|
let nanoid = (size = 21) => {
|
68
|
-
fillPool(size)
|
37
|
+
fillPool((size -= 0))
|
69
38
|
let id = ''
|
70
39
|
for (let i = poolOffset - size; i < poolOffset; i++) {
|
71
|
-
// It is incorrect to use bytes exceeding the alphabet size.
|
72
|
-
// The following mask reduces the random byte in the 0-255 value
|
73
|
-
// range to the 0-63 value range. Therefore, adding hacks, such
|
74
|
-
// as empty string fallback or magic numbers, is unneccessary because
|
75
|
-
// the bitmask trims bytes down to the alphabet size.
|
76
40
|
id += urlAlphabet[pool[i] & 63]
|
77
41
|
}
|
78
42
|
return id
|
79
43
|
}
|
80
|
-
|
81
|
-
module.exports = { nanoid, customAlphabet, customRandom, urlAlphabet, random }
|
44
|
+
export { nanoid, customAlphabet, customRandom, urlAlphabet, random }
|