nanoid 2.0.2 → 2.1.1

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.1.1
+* Fix React Native support (by Shawn Hwei).
+
+## 2.1
+* Improve React Native support (by Sebastian Werner).
+
+## 2.0.4
+* Improve error text for React Native (by Sebastian Werner).
+
+## 2.0.3
+* Fix freeze on string in ID length.
+
 ## 2.0.2
 * Improve docs (by Sylvanus Kateile and Mark Stosberg).
 

package/README.md

@@ -6,19 +6,19 @@
 A tiny, secure, URL-friendly, unique string ID generator for JavaScript.
 
 * **Small.** 141 bytes (minified and gzipped). No dependencies.
-[Size Limit] controls the size.
-* **Safe.** It uses cryptographically strong random APIs
-and tests distribution of symbols.
+  [Size Limit] controls the size.
+* **Safe.** It uses cryptographically strong random APIs.
+  Can be used in clusters.
 * **Fast.** It’s 16% faster than UUID.
 * **Compact.** It uses a larger alphabet than UUID (`A-Za-z0-9_-`).
-So ID size was reduced from 36 to 21 symbols.
+  So ID size was reduced from 36 to 21 symbols.
 
 ```js
 var nanoid = require('nanoid')
 model.id = nanoid() //=> "V1StGXR8_Z5jdHi6B-myT"
 ```
 
-The generator supports Node.js, React Native, and [all browsers].
+Supports [all browsers], Node.js and React Native.
 
 [all browsers]: http://caniuse.com/#feat=getrandomvalues
 [Size Limit]:   https://github.com/ai/size-limit
@@ -28,6 +28,25 @@ The generator supports Node.js, React Native, and [all browsers].
        alt="Sponsored by Evil Martians" width="236" height="54">
 </a>
 
+## Table of Contents
+
+1. [Comparison with UUID](#comparison-with-uuid)
+2. [Benchmark](#benchmark)
+4. [Tools](#tools)
+3. [Security](#security)
+6. Usage
+   1. [JS](#js)
+   2. [React](#react)
+   3. [React Native](#react-native)
+   4. [Web Workers](#web-workers)
+   5. [PouchDB and CouchDB](#pouchdb-and-couchdb)
+   5. [Mongoose](#mongoose)
+   6. [Other Programming Languages](#other-programming-languages)
+7. API
+   1. [Async](#async)
+   2. [Custom Alphabet or Length](#custom-alphabet-or-length)
+   3. [Custom Random Bytes Generator](#custom-random-bytes-generator)
+
 
 ## Comparison with UUID
 
@@ -44,7 +63,7 @@ There are three main differences between Nano ID and UUID v4:
    are packed in just 21 symbols instead of 36.
 2. Nano ID code is 3 times less than `uuid/v4` package:
    141 bytes instead of 435.
-3. Because of memory allocation tricks, Nano ID 16% faster than UUID.
+3. Because of memory allocation tricks, Nano ID is 16% faster than UUID.
 
 
 ## Benchmark
@@ -70,6 +89,19 @@ rndm                    2,413,565 ops/sec
 ```
 
 
+## Tools
+
+* [ID size calculator] to choice smaller ID size depends on your case.
+* [`nanoid-dictionary`] with popular alphabets to use with `nanoid/generate`.
+* [`nanoid-cli`] to generate ID from CLI.
+* [`nanoid-good`] to be sure that your ID doesn't contain any obscene words.
+
+[`nanoid-dictionary`]: https://github.com/CyberAP/nanoid-dictionary
+[ID size calculator]:  https://zelark.github.io/nano-id-cc/
+[`nanoid-cli`]:        https://github.com/twhitbeck/nanoid-cli
+[`nanoid-good`]:       https://github.com/y-gagar1n/nanoid-good
+
+
 ## Security
 
 *See a good article about random generators theory:
@@ -99,43 +131,17 @@ Nano ID uses a [better algorithm] and is tested for uniformity.
 [better algorithm]: https://github.com/ai/nanoid/blob/master/format.js
 
 
-## Tools
-
-* [ID size calculator] to choice smaller ID size depends on your case.
-* [`nanoid-dictionary`] with popular alphabets to use with `nanoid/generate`.
-* [`nanoid-cli`] to generate ID from CLI.
-* [`nanoid-good`] to be sure that your ID doesn't contain any obscene words.
-
-[`nanoid-dictionary`]: https://github.com/CyberAP/nanoid-dictionary
-[ID size calculator]:  https://zelark.github.io/nano-id-cc/
-[`nanoid-cli`]:        https://github.com/twhitbeck/nanoid-cli
-[`nanoid-good`]:       https://github.com/y-gagar1n/nanoid-good
-
-
-## Other Programming Languages
-
-* [C#](https://github.com/codeyu/nanoid-net)
-* [Clojure and ClojureScript](https://github.com/zelark/nano-id)
-* [Crystal](https://github.com/mamantoha/nanoid.cr)
-* [Dart](https://github.com/pd4d10/nanoid)
-* [Go](https://github.com/matoous/go-nanoid)
-* [Elixir](https://github.com/railsmechanic/nanoid)
-* [Haskell](https://github.com/4e6/nanoid-hs)
-* [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) 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)
-
-Also, [CLI tool] is available to generate IDs from a command line.
+### Vulnerabilities
 
-[CLI tool]: https://github.com/twhitbeck/nanoid-cli
+To report a security vulnerability, please use the
+[Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.
 
 
 ## Usage
 
+### JS
+
 The main module uses URL-friendly symbols (`A-Za-z0-9_-`) and returns an ID
 with 21 characters (to have a collision probability similar to UUID v4).
 
@@ -156,6 +162,7 @@ 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
@@ -165,38 +172,54 @@ between renders. This is bad code:
 <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.
+This is good code. `this.id` will be generated only once:
 
 ```jsx
-  id = 'input' + nanoid()
-
+  id = nanoid()
   render () {
-    return <>
-      <label htmlFor={this.id}>Label text</label>
-      <input id={this.id} type="text"/>
-    </>;
+    return <Item key={this.id}>;
   }
 }
 ```
 
+If you want to use Nano ID for `id`, you must to set some string prefix.
+Nano ID could be started from number. HTML ID can’t be started from the number.
+
+```jsx
+<input id={'id' + this.id} type="text"/>
+```
+
+
 ### React Native
 
-To generate secure random IDs in React Native, you must use
-[a native random generator] and asynchronous API:
+React Native doesn’t have built-in random generator.
+
+1. Check [`expo-random`] docs and install it.
+2. Use `nanoid/async` instead of synchronous `nanoid`.
 
 ```js
-const generateSecureRandom = require('react-native-securerandom').generateSecureRandom
-const format = require('nanoid/async/format')
-const url = require('nanoid/url')
+const nanoid = require('nanoid/async')
 
 async function createUser () {
-  user.id = await format(generateSecureRandom, url, 21);
+  user.id = await nanoid()
 }
 ```
 
-[a native random generator]: https://github.com/rh389/react-native-securerandom
+
+### PouchDB and CouchDB
+
+In PouchDB and CouchDB, IDs can’t start with an underscore `_`.
+A prefix is required to prevent this issue, as Nano ID might use a `_`
+at the start of the ID by default.
+
+Override the default ID with the following option:
+
+```js
+db.put({
+  _id: 'id' + nanoid(),
+  …
+})
+```
 
 
 ### Mongoose
@@ -205,7 +228,7 @@ async function createUser () {
 const mySchema = new Schema({
   _id: {
     type: String,
-    default: () => nanoid(10)
+    default: () => nanoid()
   }
 })
 ```
@@ -227,6 +250,33 @@ model.id = nanoid() //=> "Uakgb_J5m9g-0JDMbcJqLJ"
 ```
 
 
+### Other Programming Languages
+
+Nano ID was ported to many languages. You can use these ports to have the same
+ID generators on client and server side.
+
+* [C#](https://github.com/codeyu/nanoid-net)
+* [Clojure and ClojureScript](https://github.com/zelark/nano-id)
+* [Crystal](https://github.com/mamantoha/nanoid.cr)
+* [Dart](https://github.com/pd4d10/nanoid-dart)
+* [Go](https://github.com/matoous/go-nanoid)
+* [Elixir](https://github.com/railsmechanic/nanoid)
+* [Haskell](https://github.com/4e6/nanoid-hs)
+* [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) with [dictionaries](https://pypi.org/project/nanoid-dictionary)
+* [Ruby](https://github.com/radeno/nanoid.rb)
+* [Rust](https://github.com/nikolay-govorov/nanoid)
+* [Swift](https://github.com/antiflasher/NanoID)
+
+Also, [CLI tool] is available to generate IDs from a command line.
+
+[CLI tool]: https://github.com/twhitbeck/nanoid-cli
+
+
+## API
+
 ### Async
 
 To generate hardware random bytes, CPU will collect electromagnetic noise.

package/async/format.js

@@ -31,6 +31,7 @@
 module.exports = function (random, alphabet, size) {
   var mask = (2 << Math.log(alphabet.length - 1) / Math.LN2) - 1
   var step = Math.ceil(1.6 * mask * size / alphabet.length)
+  size = +size
 
   function tick (id) {
     return random(step).then(function (bytes) {

package/async/random.rn.js

@@ -0,0 +1,14 @@
+var random
+try {
+  random = require('expo-random')
+} catch (e) {
+  throw new Error(
+    'React-Native does not have a built-in secure random generator. ' +
+    'Install `expo-random` locally or ' +
+    'if you don’t need unpredictable IDs, you can use `nanoid/non-secure`.'
+  )
+}
+
+module.exports = function (bytes) {
+  return random.getRandomBytesAsync(bytes)
+}

package/format.js

@@ -29,6 +29,7 @@
 module.exports = function (random, alphabet, size) {
   var mask = (2 << Math.log(alphabet.length - 1) / Math.LN2) - 1
   var step = Math.ceil(1.6 * mask * size / alphabet.length)
+  size = +size
 
   var id = ''
   while (true) {

package/index.browser.js

@@ -1,4 +1,11 @@
 if (process.env.NODE_ENV !== 'production') {
+  if (typeof navigator !== 'undefined' && navigator.product === 'ReactNative') {
+    throw new Error(
+      'React Native does not have a built-in secure random generator. ' +
+      'If you don’t need unpredictable IDs, you can use `nanoid/non-secure`. ' +
+      'For secure ID install `expo-random` locally and use `nanoid/async`.'
+    )
+  }
   if (typeof self === 'undefined' || (!self.crypto && !self.msCrypto)) {
     throw new Error(
       'Your browser does not have secure random generator. ' +

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nanoid",
-  "version": "2.0.2",
+  "version": "2.1.1",
   "description": "A tiny (141 bytes), secure URL-friendly unique string ID generator",
   "keywords": [
     "uuid",
@@ -17,5 +17,14 @@
     "./async/index.js": "./async/index.browser.js",
     "./async/random.js": "./async/random.browser.js"
   },
-  "sideEffects": false
+  "react-native": {
+    "./async/random.js": "./async/random.rn.js"
+  },
+  "sideEffects": false,
+  "eslintIgnore": [
+    "test/demo/build"
+  ],
+  "sharec": {
+    "version": "0.4.4"
+  }
 }