bigint-crypto-utils - npm Package Compare versions

Comparing version 2.5.0 to 2.5.1

package.json

 {
   "name": "bigint-crypto-utils",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "description": "Utils for working with cryptography using native JS implementation of BigInt. It includes arbitrary precision modular arithmetics, cryptographically secure random numbers and strong probable prime generation/testing.",
@@ -22,17 +22,18 @@ "keywords": [
   "repository": "github:juanelas/bigint-crypto-utils",
-  "main": "./dist/bigint-crypto-utils-latest.node.js",
-  "browser": "./dist/bigint-crypto-utils-latest.browser.mod.min.js",
-  "types": "./types/bigint-crypto-utils.d.ts",
+  "main": "./lib/index.node.js",
+  "browser": "./lib/index.browser.mod.js",
+  "types": "./types/index.d.ts",
   "directories": {
     "build": "./build",
-    "dist": "./dist",
+    "lib": "./lib",
     "src": "./src",
     "test": "./test",
-    "types": "/types"
+    "types": "./types"
   },
   "scripts": {
-    "test": "mocha --timeout 600000",
-    "build:js": "node build/build.rollup.js",
-    "build:browserTests": "node build/build.browser.tests.js",
-    "build:docs": "jsdoc2md --template=./src/readme-template.hbs --files ./src/main.js > README.md",
+    "test": "mocha",
+    "build:js": "rollup -c build/rollup.config.js",
+    "build:standard": "standard --fix",
+    "build:browserTests": "rollup -c build/rollup.tests.config.js",
+    "build:docs": "jsdoc2md --template=./src/doc/readme-template.md --files ./lib/index.browser.mod.js -d 3 > README.md",
     "build:dts": "node build/build.dts.js",
@@ -42,2 +43,19 @@ "build": "run-s build:**",
   },
+  "standard": {
+    "env": [
+      "mocha"
+    ],
+    "globals": [
+      "BigInt",
+      "Blob",
+      "postMessage",
+      "self",
+      "Worker"
+    ],
+    "ignore": [
+      "/test/browser/",
+      "/lib/index.browser.bundle.js",
+      "/lib/index.browser.bundle.mod.js"
+    ]
+  },
   "devDependencies": {
@@ -48,11 +66,11 @@ "@rollup/plugin-commonjs": "^11.0.2",
     "@rollup/plugin-replace": "^2.3.1",
-    "chai": ">=4.2.0",
-    "eslint": "^6.8.0",
+    "chai": "^4.2.0",
     "jsdoc-to-markdown": "^5.0.3",
-    "mocha": "^7.1.0",
+    "mocha": "^7.1.1",
     "npm-run-all": "^4.1.5",
-    "rollup": "^2.0.6",
+    "rollup": "^2.3.3",
     "rollup-plugin-terser": "^5.3.0",
+    "standard": "^14.3.3",
     "typescript": "^3.8.3"
   }
 }

README.md

@@ -0,4 +1,6 @@
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+
 # bigint-crypto-utils
 
-Utils for working with cryptography using native JS ([ES-2020](https://tc39.es/ecma262/#sec-bigint-objects)) implementation of BigInt. It includes some extra functions to work with modular arithmetics along with secure random numbers and a fast strong probable prime generator/tester (parallelised multi-threaded Miller-Rabin primality test). It can be used by any [Web Browser or webview supporting BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#Browser_compatibility) and with Node.js (>=10.4.0). In the latter case, for multi-threaded primality tests, you should use Node.js v11 or newer or enable at runtime with `node --experimental-worker` with Node.js version >= 10.5.0 and < 11.
+Utils for working with cryptography using native JS ([ES-2020](https://tc39.es/ecma262/#sec-bigint-objects)) implementation of BigInt. It includes some extra functions to work with modular arithmetic along with secure random numbers and a fast strong probable prime generator/tester (parallelized multi-threaded Miller-Rabin primality test). It can be used by any [Web Browser or webview supporting BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#Browser_compatibility) and with Node.js (>=10.4.0). In the latter case, for multi-threaded primality tests, you should use Node.js v11 or newer or enable at runtime with `node --experimental-worker` with Node.js version >= 10.5.0 and < 11.
 
@@ -19,3 +21,3 @@ > The operations supported on BigInts are not constant time. BigInt can be therefore **[unsuitable for use in cryptography](https://www.chosenplaintext.ca/articles/beginners-guide-constant-time-cryptography.html).** Many platforms provide native support for cryptography, such as [Web Cryptography API](https://w3c.github.io/webcrypto/) or [Node.js Crypto](https://nodejs.org/dist/latest/docs/api/crypto.html).
 
-For web browsers, you can also directly download the [IIFE file](https://raw.githubusercontent.com/juanelas/bigint-crypto-utils/master/dist/bigint-crypto-utils-latest.browser.js) or the [ES6 module](https://raw.githubusercontent.com/juanelas/bigint-crypto-utils/master/dist/bigint-crypto-utils-latest.browser.mod.min.js) from GitHub.
+For web browsers, you can also directly download the [IIFE file](https://raw.githubusercontent.com/juanelas/bigint-crypto-utils/master/lib/index.browser.bundle.js) or the [ES6 module](https://raw.githubusercontent.com/juanelas/bigint-crypto-utils/master/lib/index.browser.bundle.mod.js) from GitHub.
 
@@ -62,3 +64,3 @@ ## Usage examples
 <script type="module">
-  import * as bigintCryptoUtils from "bigint-utils-latest.browser.mod.min.js";
+  import * as bigintCryptoUtils from "<path to the downloaded index.browser.bundle.mod.js>";
 
@@ -94,5 +96,5 @@ let a = BigInt("5");
 
-# bigint-crypto-utils JS Doc
+## bigint-crypto-utils JS Doc
 
-## Functions
+### Functions
 
@@ -107,3 +109,3 @@ <dl>
 <dt><a href="#eGcd">eGcd(a, b)</a> ⇒ <code><a href="#egcdReturn">egcdReturn</a></code></dt>
-<dd><p>An iterative implementation of the extended euclidean algorithm or extended greatest common divisor algorithm. 
+<dd><p>An iterative implementation of the extended euclidean algorithm or extended greatest common divisor algorithm.
 Take positive integers a, b as input, and return a triple (g, x, y), such that ax + by = g = gcd(a, b).</p>
@@ -115,3 +117,3 @@ </dd>
 <dt><a href="#isProbablyPrime">isProbablyPrime(w, [iterations])</a> ⇒ <code>Promise</code></dt>
-<dd><p>The test first tries if any of the first 250 small primes are a factor of the input number and then passes several 
+<dd><p>The test first tries if any of the first 250 small primes are a factor of the input number and then passes several
 iterations of Miller-Rabin Probabilistic Primality Test (FIPS 186-4 C.3.1)</p>
@@ -135,10 +137,10 @@ </dd>
 <dt><a href="#prime">prime(bitLength, [iterations])</a> ⇒ <code>Promise</code></dt>
-<dd><p>A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator. 
-The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI 
-main process, and it can be much faster (if several cores or cpu are available). 
-The node version can also use worker_threads if they are available (enabled by default with Node 11 and 
+<dd><p>A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
+The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
+main process, and it can be much faster (if several cores or cpu are available).
+The node version can also use worker_threads if they are available (enabled by default with Node 11 and
 and can be enabled at runtime executing node --experimental-worker with node &gt;=10.5.0).</p>
 </dd>
 <dt><a href="#primeSync">primeSync(bitLength, [iterations])</a> ⇒ <code>bigint</code></dt>
-<dd><p>A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator. 
+<dd><p>A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
 The sync version is NOT RECOMMENDED since it won&#39;t use workers and thus it&#39;ll be slower and may freeze thw window in browser&#39;s javascript. Please consider using prime() instead.</p>
@@ -163,3 +165,3 @@ </dd>
 
-## Typedefs
+### Typedefs
 
@@ -174,3 +176,3 @@ <dl>
 
-## abs(a) ⇒ <code>bigint</code>
+### abs(a) ⇒ <code>bigint</code>
 Absolute value. abs(a)==a if a>=0. abs(a)==-a if a<0
@@ -187,3 +189,3 @@
 
-## bitLength(a) ⇒ <code>number</code>
+### bitLength(a) ⇒ <code>number</code>
 Returns the bitlength of a number
@@ -200,4 +202,4 @@
 
-## eGcd(a, b) ⇒ [<code>egcdReturn</code>](#egcdReturn)
-An iterative implementation of the extended euclidean algorithm or extended greatest common divisor algorithm. 
+### eGcd(a, b) ⇒ [<code>egcdReturn</code>](#egcdReturn)
+An iterative implementation of the extended euclidean algorithm or extended greatest common divisor algorithm.
 Take positive integers a, b as input, and return a triple (g, x, y), such that ax + by = g = gcd(a, b).
@@ -215,3 +217,3 @@
 
-## gcd(a, b) ⇒ <code>bigint</code>
+### gcd(a, b) ⇒ <code>bigint</code>
 Greatest-common divisor of two integers based on the iterative binary algorithm.
@@ -229,4 +231,4 @@
 
-## isProbablyPrime(w, [iterations]) ⇒ <code>Promise</code>
-The test first tries if any of the first 250 small primes are a factor of the input number and then passes several 
+### isProbablyPrime(w, [iterations]) ⇒ <code>Promise</code>
+The test first tries if any of the first 250 small primes are a factor of the input number and then passes several
 iterations of Miller-Rabin Probabilistic Primality Test (FIPS 186-4 C.3.1)
@@ -244,3 +246,3 @@
 
-## lcm(a, b) ⇒ <code>bigint</code>
+### lcm(a, b) ⇒ <code>bigint</code>
 The least common multiple computed as abs(a*b)/gcd(a,b)
@@ -258,3 +260,3 @@
 
-## max(a, b) ⇒ <code>bigint</code>
+### max(a, b) ⇒ <code>bigint</code>
 Maximum. max(a,b)==a if a>=b. max(a,b)==b if a<=b
@@ -272,3 +274,3 @@
 
-## min(a, b) ⇒ <code>bigint</code>
+### min(a, b) ⇒ <code>bigint</code>
 Minimum. min(a,b)==b if a>=b. min(a,b)==a if a<=b
@@ -286,3 +288,3 @@
 
-## modInv(a, n) ⇒ <code>bigint</code>
+### modInv(a, n) ⇒ <code>bigint</code>
 Modular inverse.
@@ -300,3 +302,3 @@
 
-## modPow(b, e, n) ⇒ <code>bigint</code>
+### modPow(b, e, n) ⇒ <code>bigint</code>
 Modular exponentiation b**e mod n. Currently using the right-to-left binary method
@@ -315,7 +317,7 @@
 
-## prime(bitLength, [iterations]) ⇒ <code>Promise</code>
-A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator. 
-The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI 
-main process, and it can be much faster (if several cores or cpu are available). 
-The node version can also use worker_threads if they are available (enabled by default with Node 11 and 
+### prime(bitLength, [iterations]) ⇒ <code>Promise</code>
+A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
+The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
+main process, and it can be much faster (if several cores or cpu are available).
+The node version can also use worker_threads if they are available (enabled by default with Node 11 and
 and can be enabled at runtime executing node --experimental-worker with node >=10.5.0).
@@ -333,4 +335,4 @@
 
-## primeSync(bitLength, [iterations]) ⇒ <code>bigint</code>
-A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator. 
+### primeSync(bitLength, [iterations]) ⇒ <code>bigint</code>
+A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
 The sync version is NOT RECOMMENDED since it won't use workers and thus it'll be slower and may freeze thw window in browser's javascript. Please consider using prime() instead.
@@ -348,3 +350,3 @@
 
-## randBetween(max, [min]) ⇒ <code>bigint</code>
+### randBetween(max, [min]) ⇒ <code>bigint</code>
 Returns a cryptographically secure random integer between [min,max]
@@ -362,3 +364,3 @@
 
-## randBits(bitLength, [forceLength]) ⇒ <code>Buffer</code> \| <code>Uint8Array</code>
+### randBits(bitLength, [forceLength]) ⇒ <code>Buffer</code> \| <code>Uint8Array</code>
 Secure random bits for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
@@ -376,3 +378,3 @@
 
-## randBytes(byteLength, [forceLength]) ⇒ <code>Promise</code>
+### randBytes(byteLength, [forceLength]) ⇒ <code>Promise</code>
 Secure random bytes for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
@@ -390,3 +392,3 @@
 
-## randBytesSync(byteLength, [forceLength]) ⇒ <code>Buffer</code> \| <code>Uint8Array</code>
+### randBytesSync(byteLength, [forceLength]) ⇒ <code>Buffer</code> \| <code>Uint8Array</code>
 Secure random bytes for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
@@ -404,3 +406,3 @@
 
-## toZn(a, n) ⇒ <code>bigint</code>
+### toZn(a, n) ⇒ <code>bigint</code>
 Finds the smallest positive element that is congruent to a in modulo n
@@ -418,3 +420,3 @@
 
-## egcdReturn : <code>Object</code>
+### egcdReturn : <code>Object</code>
 A triple (g, x, y), such that ax + by = g = gcd(a, b).
@@ -431,3 +433,1 @@
 
-
-* * *

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

408

increased by0.25%

Worsened metrics

Total package byte prevSize

78872

decreased by-20.31%

Number of package files

8

decreased by-11.11%

Lines of code

1720

decreased by-27.15%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes