@pezkuwi/util 14.0.12 → 14.0.14

package/build/u8a/toU8a.js

@@ -1,39 +0,0 @@
-import { hexToU8a } from '../hex/toU8a.js';
-import { isBuffer } from '../is/buffer.js';
-import { isHex } from '../is/hex.js';
-import { isU8a } from '../is/u8a.js';
-import { stringToU8a } from '../string/toU8a.js';
-/**
- * @name u8aToU8a
- * @summary Creates a Uint8Array value from a Uint8Array, Buffer, string or hex input.
- * @description
- * `null` or `undefined` inputs returns a `[]` result, Uint8Array values returns the value, hex strings returns a Uint8Array representation.
- * If `strict` is true, `null` or `undefined` will throw an error instead of returning an empty array.
- * Supports input types: Uint8Array, Buffer, hex string, string, or number array.
- * @example
- * <BR>
- *
- * ```javascript
- * import { u8aToU8a } from '@pezkuwi/util';
- *
- * u8aToU8a(new Uint8Array([0x12, 0x34]); // => Uint8Array([0x12, 0x34])
- * u8aToU8a(0x1234); // => Uint8Array([0x12, 0x34])
- * ```
- */
-export function u8aToU8a(value, strict = false) {
-    if (strict && (value === null || value === undefined)) {
-        throw new Error('u8aToU8a: Expected non-null, non-undefined value');
-    }
-    return isU8a(value)
-        // NOTE isBuffer needs to go here since it actually extends
-        // Uint8Array on Node.js environments, so all Buffer are Uint8Array,
-        // but Uint8Array is not Buffer
-        ? isBuffer(value)
-            ? new Uint8Array(value)
-            : value
-        : isHex(value)
-            ? hexToU8a(value)
-            : Array.isArray(value)
-                ? new Uint8Array(value)
-                : stringToU8a(value);
-}

package/build/u8a/wrap.d.ts

@@ -1,22 +0,0 @@
-import type { U8aLike } from '../types.js';
-/** @internal */
-export declare const U8A_WRAP_ETHEREUM: Uint8Array<ArrayBufferLike>;
-/** @internal */
-export declare const U8A_WRAP_PREFIX: Uint8Array<ArrayBufferLike>;
-/** @internal */
-export declare const U8A_WRAP_POSTFIX: Uint8Array<ArrayBufferLike>;
-/** @internal */
-export declare function u8aIsWrapped(u8a: Uint8Array, withEthereum: boolean): boolean;
-/**
- * @name u8aUnwrapBytes
- * @description Removes all <Bytes>...</Bytes> wrappers from the supplied value
- */
-export declare function u8aUnwrapBytes(bytes: U8aLike): Uint8Array;
-/**
- * @name u8aWrapBytes
- * @description
- * Adds a <Bytes>...</Bytes> wrapper to the supplied value, if
- * - We don't already have a Bytes wrapper
- * - The message is not an Ethereum-style message
- */
-export declare function u8aWrapBytes(bytes: U8aLike): Uint8Array;

package/build/u8a/wrap.js

@@ -1,43 +0,0 @@
-import { u8aConcatStrict } from './concat.js';
-import { u8aEq } from './eq.js';
-import { u8aToU8a } from './toU8a.js';
-/** @internal */
-export const U8A_WRAP_ETHEREUM = /*#__PURE__*/ u8aToU8a('\x19Ethereum Signed Message:\n');
-/** @internal */
-export const U8A_WRAP_PREFIX = /*#__PURE__*/ u8aToU8a('<Bytes>');
-/** @internal */
-export const U8A_WRAP_POSTFIX = /*#__PURE__*/ u8aToU8a('</Bytes>');
-const WRAP_LEN = U8A_WRAP_PREFIX.length + U8A_WRAP_POSTFIX.length;
-/** @internal */
-export function u8aIsWrapped(u8a, withEthereum) {
-    return ((u8a.length >= WRAP_LEN &&
-        u8aEq(u8a.subarray(0, U8A_WRAP_PREFIX.length), U8A_WRAP_PREFIX) &&
-        u8aEq(u8a.slice(-U8A_WRAP_POSTFIX.length), U8A_WRAP_POSTFIX)) ||
-        (withEthereum &&
-            u8a.length >= U8A_WRAP_ETHEREUM.length &&
-            u8aEq(u8a.subarray(0, U8A_WRAP_ETHEREUM.length), U8A_WRAP_ETHEREUM)));
-}
-/**
- * @name u8aUnwrapBytes
- * @description Removes all <Bytes>...</Bytes> wrappers from the supplied value
- */
-export function u8aUnwrapBytes(bytes) {
-    const u8a = u8aToU8a(bytes);
-    // we don't want to unwrap Ethereum-style wraps
-    return u8aIsWrapped(u8a, false)
-        ? u8a.subarray(U8A_WRAP_PREFIX.length, u8a.length - U8A_WRAP_POSTFIX.length)
-        : u8a;
-}
-/**
- * @name u8aWrapBytes
- * @description
- * Adds a <Bytes>...</Bytes> wrapper to the supplied value, if
- * - We don't already have a Bytes wrapper
- * - The message is not an Ethereum-style message
- */
-export function u8aWrapBytes(bytes) {
-    const u8a = u8aToU8a(bytes);
-    return u8aIsWrapped(u8a, true)
-        ? u8a
-        : u8aConcatStrict([U8A_WRAP_PREFIX, u8a, U8A_WRAP_POSTFIX]);
-}

package/build-deno/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 'https://deno.land/x/pezkuwi/util/mod.ts';
-```

package/build-deno/array/chunk.ts

@@ -1,33 +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 'https://deno.land/x/pezkuwi/util/mod.ts';
- *
- * arrayChunk([1, 2, 3, 4, 5]); // [[1, 2], [3, 4], [5]]
- * ```
- */
-export function arrayChunk <T> (array: T[], chunkSize: number): T[][] {
-  const outputSize = Math.ceil(array.length / chunkSize);
-
-  // shortcut for the single-split case
-  if (outputSize === 1) {
-    return [array];
-  }
-
-  const output = Array<T[]>(outputSize);
-
-  for (let i = 0; i < outputSize; i++) {
-    const offset = i * chunkSize;
-
-    output[i] = array.slice(offset, offset + chunkSize);
-  }
-
-  return output;
-}

package/build-deno/array/filter.ts

@@ -1,22 +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 'https://deno.land/x/pezkuwi/util/mod.ts';
- *
- * 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 <T = unknown> (array: readonly (T | null | undefined)[], allowNulls = true): T[] {
-  return array.filter((v): v is T =>
-    v !== undefined &&
-    (allowNulls || v !== null)
-  );
-}

package/build-deno/array/flatten.ts

@@ -1,47 +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 'https://deno.land/x/pezkuwi/util/mod.ts';
- *
- * arrayFlatten([[1, 2], [3, 4], [5]]); // [1, 2, 3, 4, 5]
- * ```
- */
-export function arrayFlatten <T> (arrays: readonly T[][]): T[] {
-  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<T>(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-deno/array/index.ts

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

package/build-deno/array/range.ts

@@ -1,29 +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 'https://deno.land/x/pezkuwi/util/mod.ts';
- *
- * arrayRange(5); // [0, 1, 2, 3, 4]
- * arrayRange(3, 5); // [5, 6, 7]
- * ```
- */
-export function arrayRange (size: number, startAt = 0): number[] {
-  if (size <= 0) {
-    throw new Error('Expected non-zero, positive number as a range size');
-  }
-
-  const result = new Array<number>(size);
-
-  for (let i = 0; i < size; i++) {
-    result[i] = i + startAt;
-  }
-
-  return result;
-}

package/build-deno/array/shuffle.ts

@@ -1,25 +0,0 @@
-
-/**
- * @name arrayShuffle
- * @description Shuffles the input array (unlike sort, this is not done in-place)
- */
-export function arrayShuffle <T> (input: readonly T[]): T[] {
-  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-deno/array/unzip.ts

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

package/build-deno/array/zip.ts

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

package/build-deno/assert.ts

@@ -1,48 +0,0 @@
-
-import { isFunction } from './is/function.ts';
-
-type MessageFn = () => string;
-
-/**
- * @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: unknown, message: string | MessageFn): asserts condition {
-  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 <T> (value: T | undefined | null, message: string | MessageFn): T {
-  assert(value !== undefined && value !== null, message);
-
-  return value;
-}
-
-/**
- * @name assertUnreachable
- * @description An assertion helper that ensures all codepaths are followed
- */
-export function assertUnreachable (x: never): never {
-  throw new Error(`This codepath should be unreachable. Unhandled input: ${x as unknown as string}`);
-}

package/build-deno/bi/consts.ts

@@ -1,110 +0,0 @@
-
-import { BigInt } from 'https://deno.land/x/pezkuwi/x-bigint/mod.ts';
-
-/**
- * @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-deno/bi/helpers.ts

@@ -1,21 +0,0 @@
-
-/** @internal */
-export function createCmp <T> (cmp: (a: T, b: T) => boolean): (...items: T[]) => T {
-  return (...items: T[]): T => {
-    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-deno/bi/index.ts

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

package/build-deno/bi/min.ts

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

package/build-deno/bi/sqrt.ts

@@ -1,41 +0,0 @@
-
-import type { BN } from '../bn/index.ts';
-import type { ToBigInt, ToBn } from '../types.ts';
-
-import { BigInt } from 'https://deno.land/x/pezkuwi/x-bigint/mod.ts';
-
-import { _0n, _1n, _2pow53n, _sqrt2pow53n } from './consts.ts';
-import { nToBigInt } from './toBigInt.ts';
-
-/**
- * @name nSqrt
- * @summary Calculates the integer square root of a bigint
- */
-export function nSqrt <ExtToBn extends ToBn | ToBigInt> (value: ExtToBn | BN | bigint | string | number | null): bigint {
-  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-deno/bi/toBigInt.ts

@@ -1,31 +0,0 @@
-
-import type { BN } from '../bn/bn.ts';
-import type { ToBigInt, ToBn } from '../types.ts';
-
-import { BigInt } from 'https://deno.land/x/pezkuwi/x-bigint/mod.ts';
-
-import { hexToBigInt } from '../hex/toBigInt.ts';
-import { isBn } from '../is/bn.ts';
-import { isHex } from '../is/hex.ts';
-import { isToBigInt } from '../is/toBigInt.ts';
-import { isToBn } from '../is/toBn.ts';
-
-/**
- * @name nToBigInt
- * @summary Creates a bigInt value from a BN, bigint, string (base 10 or hex) or number input.
- */
-export function nToBigInt <ExtToBn extends ToBigInt | ToBn> (value?: ExtToBn | BN | bigint | string | number | null): bigint {
-  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-deno/bi/toHex.ts

@@ -1,14 +0,0 @@
-
-import type { BN } from '../bn/bn.ts';
-import type { HexString, NumberOptions, ToBigInt, ToBn } from '../types.ts';
-
-import { u8aToHex } from '../u8a/index.ts';
-import { nToU8a } from './toU8a.ts';
-
-/**
- * @name nToHex
- * @summary Creates a hex value from a bigint object.
- */
-export function nToHex <ExtToBn extends ToBn | ToBigInt> (value?: ExtToBn | BN | bigint | number | null, { bitLength = -1, isLe = false, isNegative = false }: NumberOptions = {}): HexString {
-  return u8aToHex(nToU8a(value || 0, { bitLength, isLe, isNegative }));
-}