Added readme and updated webpack configuration to build correctly. Moved web and node files to Web and Node directories. Added a few comments.

Author: Johannestegner

.eslintrc.json

@@ -0,0 +1,4 @@
+{
+  "parser": "babel-eslint",
+  "extends": "@jitesoft"
+}

README.md

@@ -0,0 +1,53 @@
+# @jitesoft/random-string
+
+Random string generator with a shared api for both node and web.
+
+Usage:
+
+```javascript
+import random from '@jitesoft/random-string';
+const randomString = random(128, { minSpecial: 5 }); 
+console.log(randomString);
+// random string with a minimum of 5 special characters and a full length of 128 characters.
+```
+
+If you wish to access the specific files by absolute paths, they are located at `@jitesoft/random-string/dist/index.node.js` and `@jitesoft/random-string/dist/index.web.js`.
+
+## Information
+
+### Randomness
+
+The random generator for the node version uses the `crypto` library to generate random characters while the web version
+uses the web `crypto` api. If web crypto api is not available, it will fallback to using the `Math.random` function.  
+The `Math.random` function is NOT a cryptographically secure algorithm, the randomness should be good enough, but do not
+use the fallback in cases where high security is a must.
+
+### Characters
+
+The following characters are used (char codes):
+
+Alpha: `65-90` & `97-122`  
+Numbers: `48-57`  
+Special: `33-47` & `58-64` & `91-96` & `123-126`
+
+## Options
+
+The following options (with defaults shown) can be passed as an object as the second argument of the function:
+
+```json
+{
+    "special": true,
+    "numbers": true,   
+    "alpha": true,
+    "minSpecial": 0,
+    "minNumbers": 0,
+    "minAlpha": 0
+}
+```
+
+This allows for a bit more specific generation of strings, default values are used for anything not set when parsing the options.
+
+## Source
+
+The source code is kept intact under the `src` directory in the package. This is so that you may use the code directly if you wish to convert
+it with your own bundler or converter.

package-lock.json

@@ -1,19 +1,22 @@
 {
-  "name": "@jitesoft/rand",
+  "name": "@jitesoft/random-string",
   "version": "1.0.0",
-  "description": "Random string generator.",
+  "description": "Cross environment random string generator.",
   "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "browser": "dist/index-web.js",
+  "browser": "dist/index.web.js",
   "scripts": {
-    "test": "eslint src/ && jest"
+    "test": "eslint src/ && jest",
+    "build:prod": "cross-env NODE_ENV=production webpack --config webpack.config.js"
   },
   "keywords": [
-    "random"
+    "random",
+    "cross-env",
+    "web",
+    "node",
+    "random string"
   ],
   "author": "Johannes Tegnér <johannes@jitesoft.com>",
   "license": "MIT",
-  "dependencies": {},
   "devDependencies": {
     "@babel/core": "^7.8.4",
     "@jitesoft/babel-preset-main": "^2.1.3",
@@ -27,9 +30,5 @@
     "jest": "^25.1.0",
     "webpack": "^5.0.0-beta.13",
     "webpack-cli": "^4.0.0-beta.3"
-  },
-  "eslintConfig": {
-    "parser": "babel-eslint",
-    "extends": "@jitesoft"
   }
 }

package.json

@@ -27,7 +27,6 @@ export default class Generator {
     return this.getRandom(len).map(i => (Math.round(i % 10) + 48));
   }
 
-
   /**
    * Fetch a list of random char codes of special characters.
    *

src/Generator.js

@@ -0,0 +1,7 @@
+import NodeGenerator from '../NodeGenerator';
+import rand from '../rand';
+
+const generator = new NodeGenerator();
+const random = rand(generator);
+
+export default random;

src/Node/index.js

@@ -0,0 +1,11 @@
+import WebGenerator from '../WebGenerator';
+import rand from '../rand';
+
+const generator = new WebGenerator();
+const random = rand(generator);
+
+export default random;
+export {
+  random,
+  rand
+};

src/Web/index.js

@@ -1,41 +1,71 @@
-import { shuffle } from './Util'
+import { shuffle } from './Util';
 
-export default (generator) => (length, options = {
+/**
+ * @typedef Option
+ * @type {{special: boolean, minAlpha: number, alpha: boolean, numbers: boolean, minNumbers: number, minSpecial: number}}
+ */
+
+const defaultOptions = {
   alpha: true,
   numbers: true,
   special: true,
-  minAlpha: 1,
-  minNumbers: 1,
-  minSpecial: 1,
-}) => {
-
-  const lists = {
-    alpha:   (options.alpha   ? generator.alpha(length)   : []),
-    special: (options.special ? generator.special(length) : []),
-    numbers: (options.numbers ? generator.numbers(length) : []),
-    combined: []
-  };
+  minAlpha: 0,
+  minNumbers: 0,
+  minSpecial: 0
+};
+
+/**
+ * Factory method for the random string generator.
+ * @param generator
+ * @return {function(*=, *=): string}
+ */
+export default (generator) =>
+  /**
+   * Random string generator.
+   *
+   * @param {number} [length] Length of the string to generate.
+   * @param {Option} [options] Options object to specify character types and minimums.
+   * @return {string} Generated random string.
+   */
+  (length = 32, options = {}) => {
+    options = Object.assign({}, defaultOptions, options);
+
+    if (options.minNumbers + options.minAlpha + options.minSpecial > length) {
+      throw new Error(
+        'You have specified a lower length than possible with the minimum count of specific character types:\n' +
+        `\tLength ${length}.\n` +
+        `\tMin Alpha: ${options.minAlpha}\n` +
+        `\tMin Numeric: ${options.minNumbers}\n` +
+        `\tMin Special: ${options.minSpecial}`
+      );
+    }
+
+    const lists = {
+      alpha: Array.from(options.alpha ? generator.alpha(length) : []),
+      special: Array.from(options.special ? generator.special(length) : []),
+      numbers: Array.from(options.numbers ? generator.numbers(length) : []),
+      combined: []
+    };
 
-  const result = [];
-  result.push(...lists.alpha.splice(0, options.minAlpha));
-  result.push(...lists.special.splice(0, options.minSpecial));
-  result.push(...lists.numbers.splice(0, options.numbers));
-
-  lists.combined = shuffle([].concat(
-    ...lists.alpha,
-    ...lists.special,
-    ...lists.numbers)
-  );
-
-  // Concat rest.
-  result.push(lists.combined.splice(0, length - (
-    (options.special ? options.minSpecial : 0)
-    +
-    (options.alpha ? options.minAlpha : 0)
-    +
-    (options.numbers ? options.minNumbers : 0)
-  )));
-
-  return shuffle(result);
-}
+    const result = [];
+    result.push(...(options.alpha ? lists.alpha.splice(0, options.minAlpha) : []));
+    result.push(...(options.numbers ? lists.numbers.splice(0, options.minNumbers) : []));
+    result.push(...(options.special ? lists.special.splice(0, options.minSpecial) : []));
 
+    lists.combined.push(
+      ...lists.alpha,
+      ...lists.numbers,
+      ...lists.special
+    );
+
+    lists.combined = shuffle(lists.combined);
+
+    // Concat rest.
+    result.push(...lists.combined.splice(0, length - (
+      (options.special ? options.minSpecial : 0) +
+      (options.alpha ? options.minAlpha : 0) +
+      (options.numbers ? options.minNumbers : 0)
+    )));
+
+    return String.fromCharCode(...shuffle(result));
+  };

src/node.js

@@ -1,9 +1,9 @@
 const Path = require('path');
 
-module.exports = {
+const shared = {
   mode: process.env.NODE_ENV,
   optimization: {
-    minimize: process.env.NODE_ENV === 'production'
+    minimize: process.env.NODE_ENV === 'production',
   },
   module: {
     rules: [
@@ -13,16 +13,31 @@ module.exports = {
         loader: 'babel-loader'
       }
     ]
-  },
-  entry: {
-    index: [
-      Path.join(__dirname, 'src', 'index.js')
-    ]
-  },
+  }
+};
+
+const web = Object.assign({}, shared, {
+  target: 'web',
+  entry: Path.join(__dirname, 'src', 'Web', 'index.js'),
   output: {
-    filename: 'index.js',
-    library: '@jitesoft/rand',
+    filename: 'index.web.js',
+    library: '@jitesoft/random-string',
     libraryTarget: 'umd',
     globalObject: 'this'
   }
-};
+});
+
+const node = Object.assign({}, shared, {
+  target: 'node',
+  entry: Path.join(__dirname, 'src', 'Node', 'index.js'),
+  output: {
+    filename: 'index.node.js',
+    library: '@jitesoft/random-string',
+    libraryTarget: 'umd'
+  }
+});
+
+module.exports = [
+  web,
+  node
+];