nanoid 2.0.0 → 2.0.1

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.0.1
+* Reduce npm package size.
+* Mark package as not having side effects (by @xiaody).
+
 ## 2.0
 * Use `-` instead of `~` in default alphabet to by file name safe.
 * Add `nanoid/non-secure/generate`.

package/README.md

@@ -79,20 +79,20 @@ There are two main differences between Nano ID and UUID v4:
 
 ```rust
 $ ./test/benchmark
-nanoid                    413,579 ops/sec
-nanoid/generate           401,349 ops/sec
-uid.sync                  354,882 ops/sec
-uuid/v4                   353,836 ops/sec
-shortid                    39,152 ops/sec
+nanoid                    337,879 ops/sec
+nanoid/generate           335,929 ops/sec
+uid.sync                  275,315 ops/sec
+uuid/v4                   273,602 ops/sec
+shortid                    32,798 ops/sec
 
 Async:
-nanoid/async               85,168 ops/sec
-nanoid/async/generate      81,037 ops/sec
-uid                        78,426 ops/sec
+nanoid/async               73,782 ops/sec
+nanoid/async/generate      80,775 ops/sec
+uid                        67,419 ops/sec
 
 Non-secure:
-nanoid/non-secure       2,718,186 ops/sec
-rndm                    2,544,612 ops/sec
+nanoid/non-secure       2,745,340 ops/sec
+rndm                    2,611,595 ops/sec
 ```
 
 
@@ -123,6 +123,29 @@ in our [ID collision probability] calculator.
 
 [ID collision probability]: https://zelark.github.io/nano-id-cc/
 
+### React
+**Do not** use a nanoid for `key` prop. In React `key` should be consistence
+between renders. This is bad code:
+
+```jsx
+<Item key={nanoid()} /> /* DON’T DO IT */
+```
+
+This is good code. Note, that we added `"input"` string in front of `id`,
+because Nano ID could be started from number. HTML ID can’t be started
+from the number.
+
+```jsx
+  id = 'input' + nanoid()
+
+  render () {
+    return <>
+      <label htmlFor={this.id}>Label text</label>
+      <input id={this.id} type="text"/>
+    </>;
+  }
+}
+```
 
 ### React Native
 
@@ -285,7 +308,7 @@ async function createUser () {
 * [Java](https://github.com/aventrix/jnanoid)
 * [Nim](https://github.com/icyphox/nanoid.nim)
 * [PHP](https://github.com/hidehalo/nanoid-php)
-* [Python](https://github.com/puyuan/py-nanoid)
+* [Python](https://github.com/puyuan/py-nanoid) with [dictionaries](https://github.com/aidarkhanov/py-nanoid-dictionary)
 * [Ruby](https://github.com/radeno/nanoid.rb)
 * [Rust](https://github.com/nikolay-govorov/nanoid)
 * [Swift](https://github.com/antiflasher/NanoID)

package/async/index.js

@@ -1,16 +1,6 @@
-var crypto = require('crypto')
-
+var random = require('./random')
 var url = require('../url')
 
-var random
-if (crypto.randomFill) {
-  random = function (bytes, callback) {
-    return crypto.randomFill(Buffer.allocUnsafe(bytes), callback)
-  }
-} else {
-  random = crypto.randomBytes
-}
-
 /**
  * Generate secure URL-friendly unique ID. Non-blocking version.
  *
@@ -18,7 +8,6 @@ if (crypto.randomFill) {
  * to UUID v4.
  *
  * @param {number} [size=21] The number of symbols in ID.
- * @param {function} [callback] for environments without `Promise`.
  *
  * @return {Promise} Promise with random string.
  *
@@ -31,41 +20,13 @@ if (crypto.randomFill) {
  * @name async
  * @function
  */
-module.exports = function (size, callback, attempt) {
+module.exports = function (size) {
   size = size || 21
-
-  if (!callback) {
-    if (typeof Promise !== 'function') {
-      throw new TypeError('Function callback is required')
-    }
-    return new Promise(function (resolve, reject) {
-      module.exports(size, function (error, id) {
-        if (error) {
-          reject(error)
-        } else {
-          resolve(id)
-        }
-      })
-    })
-  } else if (typeof callback !== 'function') {
-    throw new TypeError('Callback is not a function')
-  }
-
-  random(size, function (err, bytes) {
-    if (err) {
-      if (typeof attempt === 'undefined') attempt = 3
-      attempt -= 1
-      if (attempt === 0) {
-        callback(err)
-      } else {
-        setTimeout(module.exports.bind(null, size, callback, attempt), 10)
-      }
-    } else {
-      var id = ''
-      while (0 < size--) {
-        id += url[bytes[size] & 63]
-      }
-      callback(null, id)
+  return random(size).then(function (bytes) {
+    var id = ''
+    while (0 < size--) {
+      id += url[bytes[size] & 63]
     }
+    return id
   })
 }

package/index.js

@@ -18,26 +18,12 @@ var url = require('./url')
  * @name nanoid
  * @function
  */
-module.exports = function (size, attempt) {
+module.exports = function (size) {
   size = size || 21
-
-  var bytes
-  try {
-    bytes = random(size)
-  } catch (e) {
-    if (typeof attempt === 'undefined') attempt = 3
-    attempt -= 1
-    if (attempt === 0) {
-      throw e
-    } else {
-      return module.exports(size, attempt)
-    }
-  }
-
+  var bytes = random(size)
   var id = ''
   while (0 < size--) {
     id += url[bytes[size] & 63]
   }
-
   return id
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nanoid",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "A tiny (141 bytes), secure URL-friendly unique string ID generator",
   "keywords": [
     "uuid",
@@ -17,6 +17,7 @@
     "./async/index.js": "./async/index.browser.js",
     "./async/random.js": "./async/random.browser.js"
   },
+  "sideEffects": false,
   "husky": {
     "hooks": {
       "pre-commit": "lint-staged"