bigintAbsolute value. abs(a)==a if a>=0. abs(a)==-a if a<0
-numberReturns the bitlength of a number
-egcdReturnAn 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).
-bigintGreatest-common divisor of two integers based on the iterative binary algorithm.
-Promise.<boolean>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)
-bigintThe least common multiple computed as abs(a*b)/gcd(a,b)
-bigintMaximum. max(a,b)==a if a>=b. max(a,b)==b if a<=b
-bigintMinimum. min(a,b)==b if a>=b. min(a,b)==a if a<=b
-bigintModular inverse.
-bigintModular exponentiation b**e mod n. Currently using the right-to-left binary method
-Promise.<bigint>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).
-bigintA 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.
-bigintReturns a cryptographically secure random integer between [min,max]. Both numbers must be >=0
-Promise.<(Buffer|Uint8Array)>Secure random bits for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
-Buffer | Uint8ArraySecure random bits for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
-Promise.<(Buffer|Uint8Array)>Secure random bytes for both node and browsers. Node version uses crypto.randomBytes() and browser one self.crypto.getRandomValues()
-Buffer | Uint8ArraySecure random bytes for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
-bigintFinds the smallest positive element that is congruent to a in modulo n
-ObjectA triple (g, x, y), such that ax + by = g = gcd(a, b).
-bigint
-Absolute value. abs(a)==a if a>=0. abs(a)==-a if a<0
-
-**Kind**: global function
-**Returns**: bigint - the absolute value of a
-
-| Param | Type |
-| --- | --- |
-| a | number \| bigint |
-
-
-
-### bitLength(a) ⇒ number
-Returns the bitlength of a number
-
-**Kind**: global function
-**Returns**: number - - the bit length
-
-| Param | Type |
-| --- | --- |
-| a | number \| bigint |
-
-
-
-### eGcd(a, b) ⇒ [egcdReturn](#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).
-
-**Kind**: global function
-**Returns**: [egcdReturn](#egcdReturn) - A triple (g, x, y), such that ax + by = g = gcd(a, b).
-**Throws**:
-
-- RangeError a and b MUST be > 0
-
-
-| Param | Type |
-| --- | --- |
-| a | number \| bigint |
-| b | number \| bigint |
-
-
-
-### egcdReturn : Object
-A triple (g, x, y), such that ax + by = g = gcd(a, b).
-
-**Kind**: global typedef
-**Properties**
-
-| Name | Type |
-| --- | --- |
-| g | bigint |
-| x | bigint |
-| y | bigint |
-
-
-
-### gcd(a, b) ⇒ bigint
-Greatest-common divisor of two integers based on the iterative binary algorithm.
-
-**Kind**: global function
-**Returns**: bigint - The greatest common divisor of a and b
-
-| Param | Type |
-| --- | --- |
-| a | number \| bigint |
-| b | number \| bigint |
-
-
-
-### isProbablyPrime(w, [iterations], [disableWorkers]) ⇒ Promise.<boolean>
-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)
-
-**Kind**: global function
-**Returns**: Promise.<boolean> - A promise that resolves to a boolean that is either true (a probably prime number) or false (definitely composite)
-**Throws**:
-
-- RangeError w MUST be >= 0
-
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| w | number \| bigint | | A positive integer to be tested for primality |
-| [iterations] | number | 16 | The number of iterations for the primality test. The value shall be consistent with Table C.1, C.2 or C.3 |
-| [disableWorkers] | boolean | false | Disable the use of workers for the primality test |
-
-
-
-### lcm(a, b) ⇒ bigint
-The least common multiple computed as abs(a*b)/gcd(a,b)
-
-**Kind**: global function
-**Returns**: bigint - The least common multiple of a and b
-
-| Param | Type |
-| --- | --- |
-| a | number \| bigint |
-| b | number \| bigint |
-
-
-
-### max(a, b) ⇒ bigint
-Maximum. max(a,b)==a if a>=b. max(a,b)==b if a<=b
-
-**Kind**: global function
-**Returns**: bigint - maximum of numbers a and b
-
-| Param | Type |
-| --- | --- |
-| a | number \| bigint |
-| b | number \| bigint |
-
-
-
-### min(a, b) ⇒ bigint
-Minimum. min(a,b)==b if a>=b. min(a,b)==a if a<=b
-
-**Kind**: global function
-**Returns**: bigint - minimum of numbers a and b
-
-| Param | Type |
-| --- | --- |
-| a | number \| bigint |
-| b | number \| bigint |
-
-
-
-### modInv(a, n) ⇒ bigint
-Modular inverse.
-
-**Kind**: global function
-**Returns**: bigint - the inverse modulo n
-**Throws**:
-
-- RangeError a does not have inverse modulo n
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| a | number \| bigint | The number to find an inverse for |
-| n | number \| bigint | The modulo |
-
-
-
-### modPow(b, e, n) ⇒ bigint
-Modular exponentiation b**e mod n. Currently using the right-to-left binary method
-
-**Kind**: global function
-**Returns**: bigint - b**e mod n
-
-| Param | Type | Description |
-| --- | --- | --- |
-| b | number \| bigint | base |
-| e | number \| bigint | exponent |
-| n | number \| bigint | modulo |
-
-
-
-### prime(bitLength, [iterations]) ⇒ Promise.<bigint>
-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).
-
-**Kind**: global function
-**Returns**: Promise.<bigint> - A promise that resolves to a bigint probable prime of bitLength bits.
-**Throws**:
-
-- RangeError bitLength MUST be > 0
-
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| bitLength | number | | The required bit length for the generated prime |
-| [iterations] | number | 16 | The number of iterations for the Miller-Rabin Probabilistic Primality Test |
-
-
-
-### primeSync(bitLength, [iterations]) ⇒ bigint
-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.
-
-**Kind**: global function
-**Returns**: bigint - A bigint probable prime of bitLength bits.
-**Throws**:
-
-- RangeError bitLength MUST be > 0
-
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| bitLength | number | | The required bit length for the generated prime |
-| [iterations] | number | 16 | The number of iterations for the Miller-Rabin Probabilistic Primality Test |
-
-
-
-### randBetween(max, [min]) ⇒ bigint
-Returns a cryptographically secure random integer between [min,max]. Both numbers must be >=0
-
-**Kind**: global function
-**Returns**: bigint - A cryptographically secure random bigint between [min,max]
-**Throws**:
-
-- RangeError Arguments MUST be: max > 0 && min >=0 && max > min
-
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| max | bigint | | Returned value will be <= max |
-| [min] | bigint | BigInt(1) | Returned value will be >= min |
-
-
-
-### randBits(bitLength, [forceLength]) ⇒ Promise.<(Buffer\|Uint8Array)>
-Secure random bits for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
-
-**Kind**: global function
-**Returns**: Promise.<(Buffer\|Uint8Array)> - A Promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits
-**Throws**:
-
-- RangeError bitLength MUST be > 0
-
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| bitLength | number | | The desired number of random bits |
-| [forceLength] | boolean | false | If we want to force the output to have a specific bit length. It basically forces the msb to be 1 |
-
-
-
-### randBitsSync(bitLength, [forceLength]) ⇒ Buffer \| Uint8Array
-Secure random bits for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
-
-**Kind**: global function
-**Returns**: Buffer \| Uint8Array - A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits
-**Throws**:
-
-- RangeError bitLength MUST be > 0
-
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| bitLength | number | | The desired number of random bits |
-| [forceLength] | boolean | false | If we want to force the output to have a specific bit length. It basically forces the msb to be 1 |
-
-
-
-### randBytes(byteLength, [forceLength]) ⇒ Promise.<(Buffer\|Uint8Array)>
-Secure random bytes for both node and browsers. Node version uses crypto.randomBytes() and browser one self.crypto.getRandomValues()
-
-**Kind**: global function
-**Returns**: Promise.<(Buffer\|Uint8Array)> - A promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes
-**Throws**:
-
-- RangeError byteLength MUST be > 0
-
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| byteLength | number | | The desired number of random bytes |
-| [forceLength] | boolean | false | If we want to force the output to have a bit length of 8*byteLength. It basically forces the msb to be 1 |
-
-
-
-### randBytesSync(byteLength, [forceLength]) ⇒ Buffer \| Uint8Array
-Secure random bytes for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
-
-**Kind**: global function
-**Returns**: Buffer \| Uint8Array - A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes
-**Throws**:
-
-- RangeError byteLength MUST be > 0
-
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| byteLength | number | | The desired number of random bytes |
-| [forceLength] | boolean | false | If we want to force the output to have a bit length of 8*byteLength. It basically forces the msb to be 1 |
-
-
-
-### toZn(a, n) ⇒ bigint
-Finds the smallest positive element that is congruent to a in modulo n
-
-**Kind**: global function
-**Returns**: bigint - The smallest positive representation of a in modulo n
-
-| Param | Type | Description |
-| --- | --- | --- |
-| a | number \| bigint | An integer |
-| n | number \| bigint | The modulo |
-
+[Check the API](./docs/API.md)
diff --git a/build/bin/mocha-ts.js b/build/bin/mocha-ts.js
new file mode 100644
index 0000000..6124838
--- /dev/null
+++ b/build/bin/mocha-ts.js
@@ -0,0 +1,73 @@
+#! /usr/bin/env node
+const path = require('path')
+const childProcess = require('child_process')
+
+const rootDir = path.join(__dirname, '../..')
+const mochaTsRelativeDir = '.mocha-ts'
+const minimatch = require('minimatch')
+const glob = require('glob')
+
+// First let us prepare the args to pass to mocha.
+// ts.files will be replaced by their js-transpiled counterparts
+// a watch file to our semaphore will be added
+const processedArgs = processArgs(process.argv.slice(2))
+
+// Now we can run a script and invoke a callback when complete, e.g.
+runScript(path.join(rootDir, 'node_modules/.bin/mocha'), processArgs(processedArgs))
+
+function processArgs (args) {
+ args = process.argv.slice(2).map(arg => {
+ const filenames = glob.sync(arg, { cwd: rootDir, matchBase: true })
+ if (filenames.length > 0) {
+ return filenames.map(file => {
+ const isTsTestFile = minimatch(file, '{test/**/*.ts,src/**/*.spec.ts}', { matchBase: true })
+ if (isTsTestFile) {
+ return `${mochaTsRelativeDir}/${file.slice(0, -3)}.js`
+ }
+ return file
+ })
+ }
+ return arg
+ })
+
+ const processedArgs = []
+
+ let addSemaphore = false
+ let semaphoreAdded = false
+ for (const arg of args) {
+ if (Array.isArray(arg)) {
+ processedArgs.push(...arg)
+ } else {
+ processedArgs.push(arg)
+ if (arg === '--watch' || arg === '-w') {
+ addSemaphore = true
+ } else if (arg === '--watch-files') {
+ processedArgs.push(`${mochaTsRelativeDir}/semaphore`)
+ semaphoreAdded = true
+ }
+ }
+ }
+ if (addSemaphore === true || semaphoreAdded === false) {
+ processedArgs.push('--watch-files')
+ processedArgs.push(`${mochaTsRelativeDir}/semaphore`)
+ }
+
+ return processedArgs
+}
+
+function runScript (scriptPath, args) {
+ const mochaCmd = childProcess.fork(path.join(rootDir, 'node_modules/.bin/mocha'), processedArgs, {
+ cwd: rootDir
+ })
+
+ mochaCmd.on('error', (error) => {
+ throw error
+ })
+
+ // execute the callback once the process has finished running
+ mochaCmd.on('exit', function (code) {
+ if (code !== 0) {
+ throw new Error('exit code ' + code)
+ }
+ })
+}
diff --git a/build/build.docs.js b/build/build.docs.js
index 6371233..d766560 100644
--- a/build/build.docs.js
+++ b/build/build.docs.js
@@ -1,7 +1,7 @@
'use strict'
const fs = require('fs')
-const jsdoc2md = require('jsdoc-to-markdown')
+const TypeDoc = require('typedoc')
const path = require('path')
const pkgJson = require('../package.json')
@@ -14,6 +14,33 @@ function camelise (str) {
})
}
+async function typedoc () {
+ const app = new TypeDoc.Application()
+
+ // If you want TypeDoc to load tsconfig.json / typedoc.json files
+ app.options.addReader(new TypeDoc.TSConfigReader())
+ app.options.addReader(new TypeDoc.TypeDocReader())
+
+ app.bootstrap({
+ // typedoc options here
+ entryPoints: ['src/index.ts'],
+ plugin: ['typedoc-plugin-markdown'],
+ includeVersion: true,
+ entryDocument: 'API.md',
+ readme: 'none'
+ })
+
+ const project = app.convert()
+
+ if (project) {
+ // Project may not have converted correctly
+ const output = path.join(rootDir, './docs')
+
+ // Rendered docs
+ await app.generateDocs(project, output)
+ }
+}
+
function getRepositoryData () {
if (typeof pkgJson.repository === 'string') {
const repodata = pkgJson.repository.split(/[:/]/)
@@ -30,40 +57,45 @@ function getRepositoryData () {
const { repoProvider, repoUsername, repoName } = getRepositoryData() || { repoProvider: null, repoUsername: null, repoName: null }
-let iifeBundle, esmBundle, workflowBadget, coverallsBadge
-if (repoProvider && repoProvider === 'github') {
- iifeBundle = `[IIFE bundle](https://raw.githubusercontent.com/${repoUsername}/${repoName}/master/lib/index.browser.bundle.iife.js)`
- esmBundle = `[ESM bundle](https://raw.githubusercontent.com/${repoUsername}/${repoName}/master/lib/index.browser.bundle.mod.js)`
- workflowBadget = ``
- coverallsBadge = `[](https://coveralls.io/github/${repoUsername}/${repoName}?branch=master)`
+const regex = /^(?:(?Look for the results in the JS console (Developer Tools)
+ diff --git a/examples/node.cjs.js b/examples/node.cjs.js index 54f3de2..78bc8ec 100644 --- a/examples/node.cjs.js +++ b/examples/node.cjs.js @@ -1,4 +1,4 @@ -const bigintCryptoUtils = require('../lib/index.node') +const bigintCryptoUtils = require('../') // const bigintCryptoUtils = require('bigint-crypto-utils') /* A BigInt with value 666 can be declared calling the bigint constructor as diff --git a/lib/index.browser.bundle.iife.js b/lib/index.browser.bundle.iife.js deleted file mode 100644 index 8760611..0000000 --- a/lib/index.browser.bundle.iife.js +++ /dev/null @@ -1 +0,0 @@ -var bigintCryptoUtils=function(n){"use strict";function t(n){return(n=BigInt(n))>=0n?n:-n}function e(n){if(1n===(n=BigInt(n)))return 1;let t=1;do{t++}while((n>>=1n)>1n);return t}function r(n,t){if((n=BigInt(n))<=0n|(t=BigInt(t))<=0n)throw new RangeError("a and b MUST be > 0");let e=0n,r=1n,o=1n,i=0n;for(;0n!==n;){const s=t/n,a=t%n,c=e-o*s,u=r-i*s;t=n,n=a,e=o,r=i,o=c,i=u}return{g:t,x:e,y:r}}function o(n,e){if(n=t(n),e=t(e),0n===n)return e;if(0n===e)return n;let r=0n;for(;!(1n&(n|e));)n>>=1n,e>>=1n,r++;for(;!(1n&n);)n>>=1n;do{for(;!(1n&e);)e>>=1n;if(n>e){const t=n;n=e,e=t}e-=n}while(e);return n<