@pezkuwi/util 14.0.6 → 14.0.7

package/build/README.md

@@ -1,17 +0,0 @@
-# @pezkuwi/util
-
-Various useful utility functions that are used across all projects in the [@pezkuwi](https://pezkuwi.js.org) namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.
-
-## Usage
-
-Installation -
-
-```
-yarn add @pezkuwi/util
-```
-
-Functions can be imported directly from the package, e.g.
-
-```js
-import { isHex } from '@pezkuwi/util';
-```

package/build/array/chunk.js

@@ -1,27 +0,0 @@
-/**
- * @name arrayChunk
- * @summary Split T[] into T[][] based on the defind size
- * @description
- * Returns a set ao arrays based on the chunksize
- * @example
- * <BR>
- *
- * ```javascript
- * import { arrayChunk } from '@pezkuwi/util';
- *
- * arrayChunk([1, 2, 3, 4, 5]); // [[1, 2], [3, 4], [5]]
- * ```
- */
-export function arrayChunk(array, chunkSize) {
-    const outputSize = Math.ceil(array.length / chunkSize);
-    // shortcut for the single-split case
-    if (outputSize === 1) {
-        return [array];
-    }
-    const output = Array(outputSize);
-    for (let i = 0; i < outputSize; i++) {
-        const offset = i * chunkSize;
-        output[i] = array.slice(offset, offset + chunkSize);
-    }
-    return output;
-}

package/build/array/filter.js

@@ -1,19 +0,0 @@
-/**
- * @name arrayFilter
- * @summary Filters undefined and (optionally) null values from an array
- * @description
- * Returns a new array with all `undefined` values removed. Optionally, when `allowNulls = false`, it removes the `null` values as well
- * @example
- * <BR>
- *
- * ```javascript
- * import { arrayFilter } from '@pezkuwi/util';
- *
- * arrayFilter([0, void 0, true, null, false, '']); // [0, true, null, false, '']
- * arrayFilter([0, void 0, true, null, false, ''], false); // [0, true, false, '']
- * ```
- */
-export function arrayFilter(array, allowNulls = true) {
-    return array.filter((v) => v !== undefined &&
-        (allowNulls || v !== null));
-}

package/build/array/flatten.js

@@ -1,39 +0,0 @@
-/**
- * @name arrayFlatten
- * @summary Merge T[][] into T[]
- * @description
- * Returns a new array with all arrays merged into one
- * @example
- * <BR>
- *
- * ```javascript
- * import { arrayFlatten } from '@pezkuwi/util';
- *
- * arrayFlatten([[1, 2], [3, 4], [5]]); // [1, 2, 3, 4, 5]
- * ```
- */
-export function arrayFlatten(arrays) {
-    const num = arrays.length;
-    // shortcuts for the empty & single-entry case
-    if (num === 0) {
-        return [];
-    }
-    else if (num === 1) {
-        return arrays[0];
-    }
-    // pre-allocate based on the combined size
-    let size = 0;
-    for (let i = 0; i < num; i++) {
-        size += arrays[i].length;
-    }
-    const output = new Array(size);
-    let i = -1;
-    for (let j = 0; j < num; j++) {
-        const a = arrays[j];
-        // instead of pushing, we just set the entries
-        for (let e = 0, count = a.length; e < count; e++) {
-            output[++i] = a[e];
-        }
-    }
-    return output;
-}

package/build/array/index.js

@@ -1,10 +0,0 @@
-/**
- * @summary Utility methods that operates on arrays
- */
-export { arrayChunk } from './chunk.js';
-export { arrayFilter } from './filter.js';
-export { arrayFlatten } from './flatten.js';
-export { arrayRange } from './range.js';
-export { arrayShuffle } from './shuffle.js';
-export { arrayUnzip } from './unzip.js';
-export { arrayZip } from './zip.js';

package/build/array/range.js

@@ -1,25 +0,0 @@
-/**
- * @name arrayRange
- * @summary Returns a range of numbers ith the size and the specified offset
- * @description
- * Returns a new array of numbers with the specific size. Optionally, when `startAt`, is provided, it generates the range to start at a specific value.
- * @example
- * <BR>
- *
- * ```javascript
- * import { arrayRange } from '@pezkuwi/util';
- *
- * arrayRange(5); // [0, 1, 2, 3, 4]
- * arrayRange(3, 5); // [5, 6, 7]
- * ```
- */
-export function arrayRange(size, startAt = 0) {
-    if (size <= 0) {
-        throw new Error('Expected non-zero, positive number as a range size');
-    }
-    const result = new Array(size);
-    for (let i = 0; i < size; i++) {
-        result[i] = i + startAt;
-    }
-    return result;
-}

package/build/array/shuffle.js

@@ -1,19 +0,0 @@
-/**
- * @name arrayShuffle
- * @description Shuffles the input array (unlike sort, this is not done in-place)
- */
-export function arrayShuffle(input) {
-    const result = input.slice();
-    let curr = result.length;
-    // noop for the single entry
-    if (curr === 1) {
-        return result;
-    }
-    while (curr !== 0) {
-        // ~~ is more performant than Math.floor
-        const rand = ~~(Math.random() * curr);
-        curr--;
-        [result[curr], result[rand]] = [result[rand], result[curr]];
-    }
-    return result;
-}

package/build/array/unzip.js

@@ -1,13 +0,0 @@
-/**
- * @name arrayUnzip
- * @description Splits a single [K, V][] into [K[], V[]]
- */
-export function arrayUnzip(entries) {
-    const count = entries.length;
-    const keys = new Array(count);
-    const values = new Array(count);
-    for (let i = 0; i < count; i++) {
-        [keys[i], values[i]] = entries[i];
-    }
-    return [keys, values];
-}

package/build/array/zip.js

@@ -1,12 +0,0 @@
-/**
- * @name arrayZip
- * @description Combines 2 distinct key/value arrays into a single [K, V] array
- */
-export function arrayZip(keys, values) {
-    const count = keys.length;
-    const result = new Array(count);
-    for (let i = 0; i < count; i++) {
-        result[i] = [keys[i], values[i]];
-    }
-    return result;
-}

package/build/assert.js

@@ -1,39 +0,0 @@
-import { isFunction } from './is/function.js';
-/**
- * @name assert
- * @summary Checks for a valid test, if not Error is thrown.
- * @description
- * Checks that `test` is a truthy value. If value is falsy (`null`, `undefined`, `false`, ...), it throws an Error with the supplied `message`. When `test` passes, `true` is returned.
- * @example
- * <BR>
- *
- * ```javascript
- * const { assert } from '@pezkuwi/util';
- *
- * assert(true, 'True should be true'); // passes
- * assert(false, 'False should not be true'); // Error thrown
- * assert(false, () => 'message'); // Error with 'message'
- * ```
- */
-export function assert(condition, message) {
-    if (!condition) {
-        throw new Error(isFunction(message)
-            ? message()
-            : message);
-    }
-}
-/**
- * @name assertReturn
- * @description Returns when the value is not undefined/null, otherwise throws assertion error
- */
-export function assertReturn(value, message) {
-    assert(value !== undefined && value !== null, message);
-    return value;
-}
-/**
- * @name assertUnreachable
- * @description An assertion helper that ensures all codepaths are followed
- */
-export function assertUnreachable(x) {
-    throw new Error(`This codepath should be unreachable. Unhandled input: ${x}`);
-}

package/build/bi/consts.js

@@ -1,91 +0,0 @@
-import { BigInt } from '@pezkuwi/x-bigint';
-/**
- * @name _0n
- * @summary BigInt constant for 0.
- */
-export const _0n = /*#__PURE__*/ BigInt(0);
-/**
- * @name _1n
- * @summary BigInt constant for 1.
- */
-export const _1n = /*#__PURE__*/ BigInt(1);
-/**
- * @name _2n
- * @summary BigInt constant for 2.
- */
-export const _2n = /*#__PURE__*/ BigInt(2);
-/**
- * @name _3n
- * @summary BigInt constant for 3.
- */
-export const _3n = /*#__PURE__*/ BigInt(3);
-/**
- * @name _4n
- * @summary BigInt constant for 4.
- */
-export const _4n = /*#__PURE__*/ BigInt(4);
-/**
- * @name _5n
- * @summary BigInt constant for 5.
- */
-export const _5n = /*#__PURE__*/ BigInt(5);
-/**
- * @name _6n
- * @summary BigInt constant for 6.
- */
-export const _6n = /*#__PURE__*/ BigInt(6);
-/**
- * @name _7n
- * @summary BigInt constant for 7.
- */
-export const _7n = /*#__PURE__*/ BigInt(7);
-/**
- * @name _8n
- * @summary BigInt constant for 8.
- */
-export const _8n = /*#__PURE__*/ BigInt(8);
-/**
- * @name _9n
- * @summary BigInt constant for 9.
- */
-export const _9n = /*#__PURE__*/ BigInt(9);
-/**
- * @name _10n
- * @summary BigInt constant for 10.
- */
-export const _10n = /*#__PURE__*/ BigInt(10);
-/**
- * @name _100n
- * @summary BigInt constant for 100.
- */
-export const _100n = /*#__PURE__*/ BigInt(100);
-/**
- * @name _1000n
- * @summary BigInt constant for 1000.
- */
-export const _1000n = /*#__PURE__*/ BigInt(1_000);
-/**
- * @name _1Mn
- * @summary BigInt constant for 1,000,000 (million).
- */
-export const _1Mn = /*#__PURE__*/ BigInt(1_000_000);
-/**
-* @name _1Bn
-* @summary BigInt constant for 1,000,000,000 (billion).
-*/
-export const _1Bn = /*#__PURE__*/ BigInt(1_000_000_000);
-/**
-* @name _1Qn
-* @summary BigInt constant for 1,000,000,000,000,000,000 (quitillion).
-*/
-export const _1Qn = _1Bn * _1Bn;
-/**
-* @name _2pow53n
-* @summary BigInt constant for MAX_SAFE_INTEGER
-*/
-export const _2pow53n = /*#__PURE__*/ BigInt(Number.MAX_SAFE_INTEGER);
-/**
- * @name _sqrt2pow53n
- * @summary BigInt constant for Math.sqrt(MAX_SAFE_INTEGER)
- */
-export const _sqrt2pow53n = /*#__PURE__*/ BigInt(94906265);

package/build/bi/helpers.js

@@ -1,16 +0,0 @@
-/** @internal */
-export function createCmp(cmp) {
-    return (...items) => {
-        const count = items.length;
-        if (count === 0) {
-            throw new Error('Must provide one or more arguments');
-        }
-        let result = items[0];
-        for (let i = 1; i < count; i++) {
-            if (cmp(items[i], result)) {
-                result = items[i];
-            }
-        }
-        return result;
-    };
-}

package/build/bi/index.js

@@ -1,9 +0,0 @@
-/**
- * @summary Utility methods to convert to and from `bigint` objects
- */
-export { nMax, nMin } from './min.js';
-export { nSqrt } from './sqrt.js';
-export { nToBigInt } from './toBigInt.js';
-export { nToHex } from './toHex.js';
-export { nToU8a } from './toU8a.js';
-export * from './consts.js';

package/build/bi/min.js

@@ -1,11 +0,0 @@
-import { createCmp } from './helpers.js';
-/**
- * @name nMax
- * @summary Finds and returns the highest value in an array of bigint.
- */
-export const nMax = /*#__PURE__*/ createCmp((a, b) => a > b);
-/**
- * @name nMin
- * @summary Finds and returns the lowest value in an array of bigint.
- */
-export const nMin = /*#__PURE__*/ createCmp((a, b) => a < b);

package/build/bi/sqrt.js

@@ -1,29 +0,0 @@
-import { BigInt } from '@pezkuwi/x-bigint';
-import { _0n, _1n, _2pow53n, _sqrt2pow53n } from './consts.js';
-import { nToBigInt } from './toBigInt.js';
-/**
- * @name nSqrt
- * @summary Calculates the integer square root of a bigint
- */
-export function nSqrt(value) {
-    const n = nToBigInt(value);
-    if (n < _0n) {
-        throw new Error('square root of negative numbers is not supported');
-    }
-    // https://stackoverflow.com/questions/53683995/javascript-big-integer-square-root/
-    // shortcut <= 2^53 - 1 to use the JS utils
-    if (n <= _2pow53n) {
-        // ~~ is more performant that Math.floor
-        return BigInt(~~Math.sqrt(Number(n)));
-    }
-    // Use sqrt(MAX_SAFE_INTEGER) as starting point. since we already know the
-    // output will be larger than this, we expect this to be a safe start
-    let x0 = _sqrt2pow53n;
-    while (true) {
-        const x1 = ((n / x0) + x0) >> _1n;
-        if (x0 === x1 || (x0 === (x1 - _1n))) {
-            return x0;
-        }
-        x0 = x1;
-    }
-}

package/build/bi/toBigInt.js

@@ -1,25 +0,0 @@
-import { BigInt } from '@pezkuwi/x-bigint';
-import { hexToBigInt } from '../hex/toBigInt.js';
-import { isBn } from '../is/bn.js';
-import { isHex } from '../is/hex.js';
-import { isToBigInt } from '../is/toBigInt.js';
-import { isToBn } from '../is/toBn.js';
-/**
- * @name nToBigInt
- * @summary Creates a bigInt value from a BN, bigint, string (base 10 or hex) or number input.
- */
-export function nToBigInt(value) {
-    return typeof value === 'bigint'
-        ? value
-        : !value
-            ? BigInt(0)
-            : isHex(value)
-                ? hexToBigInt(value.toString())
-                : isBn(value)
-                    ? BigInt(value.toString())
-                    : isToBigInt(value)
-                        ? value.toBigInt()
-                        : isToBn(value)
-                            ? BigInt(value.toBn().toString())
-                            : BigInt(value);
-}

package/build/bi/toHex.js

@@ -1,9 +0,0 @@
-import { u8aToHex } from '../u8a/index.js';
-import { nToU8a } from './toU8a.js';
-/**
- * @name nToHex
- * @summary Creates a hex value from a bigint object.
- */
-export function nToHex(value, { bitLength = -1, isLe = false, isNegative = false } = {}) {
-    return u8aToHex(nToU8a(value || 0, { bitLength, isLe, isNegative }));
-}

package/build/bi/toU8a.js

@@ -1,49 +0,0 @@
-import { BigInt } from '@pezkuwi/x-bigint';
-import { _0n, _1n } from './consts.js';
-import { nToBigInt } from './toBigInt.js';
-const DIV = BigInt(256);
-const NEG_MASK = BigInt(0xff);
-function toU8a(value, isLe, isNegative) {
-    const arr = [];
-    const withSigned = isNegative && (value < _0n);
-    if (withSigned) {
-        value = (value + _1n) * -_1n;
-    }
-    while (value !== _0n) {
-        const mod = value % DIV;
-        const val = Number(withSigned
-            ? mod ^ NEG_MASK
-            : mod);
-        if (isLe) {
-            arr.push(val);
-        }
-        else {
-            arr.unshift(val);
-        }
-        value = (value - mod) / DIV;
-    }
-    return Uint8Array.from(arr);
-}
-/**
- * @name nToU8a
- * @summary Creates a Uint8Array object from a bigint.
- */
-export function nToU8a(value, { bitLength = -1, isLe = true, isNegative = false } = {}) {
-    const valueBi = nToBigInt(value);
-    if (valueBi === _0n) {
-        return bitLength === -1
-            ? new Uint8Array(1)
-            : new Uint8Array(Math.ceil((bitLength || 0) / 8));
-    }
-    const u8a = toU8a(valueBi, isLe, isNegative);
-    if (bitLength === -1) {
-        return u8a;
-    }
-    const byteLength = Math.ceil((bitLength || 0) / 8);
-    const output = new Uint8Array(byteLength);
-    if (isNegative) {
-        output.fill(0xff);
-    }
-    output.set(u8a, isLe ? 0 : byteLength - u8a.length);
-    return output;
-}

package/build/bn/bn.js

@@ -1,2 +0,0 @@
-import BN from 'bn.js';
-export { BN };

package/build/bn/consts.js

@@ -1,91 +0,0 @@
-import { BN } from './bn.js';
-/**
- * @name BN_ZERO
- * @summary BN constant for 0.
- */
-export const BN_ZERO = /*#__PURE__*/ new BN(0);
-/**
- * @name BN_ONE
- * @summary BN constant for 1.
- */
-export const BN_ONE = /*#__PURE__*/ new BN(1);
-/**
- * @name BN_TWO
- * @summary BN constant for 2.
- */
-export const BN_TWO = /*#__PURE__*/ new BN(2);
-/**
- * @name BN_THREE
- * @summary BN constant for 3.
- */
-export const BN_THREE = /*#__PURE__*/ new BN(3);
-/**
- * @name BN_FOUR
- * @summary BN constant for 4.
- */
-export const BN_FOUR = /*#__PURE__*/ new BN(4);
-/**
- * @name BN_FIVE
- * @summary BN constant for 5.
- */
-export const BN_FIVE = /*#__PURE__*/ new BN(5);
-/**
- * @name BN_SIX
- * @summary BN constant for 6.
- */
-export const BN_SIX = /*#__PURE__*/ new BN(6);
-/**
- * @name BN_SEVEN
- * @summary BN constant for 7.
- */
-export const BN_SEVEN = /*#__PURE__*/ new BN(7);
-/**
- * @name BN_EIGHT
- * @summary BN constant for 8.
- */
-export const BN_EIGHT = /*#__PURE__*/ new BN(8);
-/**
- * @name BN_NINE
- * @summary BN constant for 9.
- */
-export const BN_NINE = /*#__PURE__*/ new BN(9);
-/**
- * @name BN_TEN
- * @summary BN constant for 10.
- */
-export const BN_TEN = /*#__PURE__*/ new BN(10);
-/**
- * @name BN_HUNDRED
- * @summary BN constant for 100.
- */
-export const BN_HUNDRED = /*#__PURE__*/ new BN(100);
-/**
- * @name BN_THOUSAND
- * @summary BN constant for 1,000.
- */
-export const BN_THOUSAND = /*#__PURE__*/ new BN(1_000);
-/**
- * @name BN_MILLION
- * @summary BN constant for 1,000,000.
- */
-export const BN_MILLION = /*#__PURE__*/ new BN(1_000_000);
-/**
- * @name BN_BILLION
- * @summary BN constant for 1,000,000,000.
- */
-export const BN_BILLION = /*#__PURE__*/ new BN(1_000_000_000);
-/**
- * @name BN_QUINTILL
- * @summary BN constant for 1,000,000,000,000,000,000.
- */
-export const BN_QUINTILL = BN_BILLION.mul(BN_BILLION);
-/**
- * @name BN_MAX_INTEGER
- * @summary BN constant for MAX_SAFE_INTEGER
- */
-export const BN_MAX_INTEGER = /*#__PURE__*/ new BN(Number.MAX_SAFE_INTEGER);
-/**
- * @name BN_SQRT_MAX_INTEGER
- * @summary BN constant for Math.sqrt(MAX_SAFE_INTEGER)
- */
-export const BN_SQRT_MAX_INTEGER = /*#__PURE__*/ new BN(94906265);

package/build/bn/fromHex.js

@@ -1 +0,0 @@
-export { hexToBn as bnFromHex } from '../hex/toBn.js';

package/build/bn/index.js

@@ -1,11 +0,0 @@
-/**
- * @summary Utility methods to convert to and from `BN` objects
- */
-export { BN } from './bn.js';
-export { bnFromHex } from './fromHex.js';
-export { bnMax, bnMin } from './min.js';
-export { bnSqrt } from './sqrt.js';
-export { bnToBn } from './toBn.js';
-export { bnToHex } from './toHex.js';
-export { bnToU8a } from './toU8a.js';
-export * from './consts.js';

package/build/bn/min.js

@@ -1,29 +0,0 @@
-import { createCmp } from '../bi/helpers.js';
-/**
- * @name bnMax
- * @summary Finds and returns the highest value in an array of BNs.
- * @example
- * <BR>
- *
- * ```javascript
- * import BN from 'bn.js';
- * import { bnMax } from '@pezkuwi/util';
- *
- * bnMax([new BN(1), new BN(3), new BN(2)]).toString(); // => '3'
- * ```
- */
-export const bnMax = /*#__PURE__*/ createCmp((a, b) => a.gt(b));
-/**
- * @name bnMin
- * @summary Finds and returns the smallest value in an array of BNs.
- * @example
- * <BR>
- *
- * ```javascript
- * import BN from 'bn.js';
- * import { bnMin } from '@pezkuwi/util';
- *
- * bnMin([new BN(1), new BN(3), new BN(2)]).toString(); // => '1'
- * ```
- */
-export const bnMin = /*#__PURE__*/ createCmp((a, b) => a.lt(b));

package/build/bn/sqrt.js

@@ -1,38 +0,0 @@
-import { BN } from './bn.js';
-import { BN_MAX_INTEGER, BN_ONE, BN_SQRT_MAX_INTEGER } from './consts.js';
-import { bnToBn } from './toBn.js';
-/**
- * @name bnSqrt
- * @summary Calculates the integer square root of a BN
- * @example
- * <BR>
- *
- * ```javascript
- * import BN from 'bn.js';
- * import { bnSqrt } from '@pezkuwi/util';
- *
- * bnSqrt(new BN(16)).toString(); // => '4'
- * ```
- */
-export function bnSqrt(value) {
-    const n = bnToBn(value);
-    if (n.isNeg()) {
-        throw new Error('square root of negative numbers is not supported');
-    }
-    // https://stackoverflow.com/questions/53683995/javascript-big-integer-square-root/
-    // shortcut <= 2^53 - 1 to use the JS utils
-    if (n.lte(BN_MAX_INTEGER)) {
-        // ~~ More performant version of Math.floor
-        return new BN(~~Math.sqrt(n.toNumber()));
-    }
-    // Use sqrt(MAX_SAFE_INTEGER) as starting point. since we already know the
-    // output will be larger than this, we expect this to be a safe start
-    let x0 = BN_SQRT_MAX_INTEGER.clone();
-    while (true) {
-        const x1 = n.div(x0).iadd(x0).ishrn(1);
-        if (x0.eq(x1) || x0.eq(x1.sub(BN_ONE))) {
-            return x0;
-        }
-        x0 = x1;
-    }
-}