@pezkuwi/util 14.0.23 → 14.0.26

package/src/hex/toBn.spec.ts

@@ -1,74 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { hexToBn } from './index.js';
-
-describe('hexToBn', (): void => {
-  it('converts prefixed hex values to BN', (): void => {
-    expect(
-      hexToBn('0x81').toString(16)
-    ).toBe('81');
-  });
-
-  it('converts null values to BN(0)', (): void => {
-    expect(
-      hexToBn(null).toNumber()
-    ).toBe(0);
-  });
-
-  it('converts 0x values to BN(0)', (): void => {
-    expect(
-      hexToBn('0x').toNumber()
-    ).toBe(0);
-  });
-
-  it('should convert with Big Endian by default', (): void => {
-    expect(
-      hexToBn('0x0100').toNumber()
-    ).toBe(256);
-  });
-
-  it('converts 0x values to BN(0) (LE)', (): void => {
-    expect(
-      hexToBn('0x', { isLe: true }).toNumber()
-    ).toBe(0);
-  });
-
-  it('converts little-endian', (): void => {
-    expect(
-      hexToBn('0x4500000000000000', { isLe: true }).toNumber()
-    ).toBe(69);
-  });
-
-  it('handles negative numbers (LE)', (): void => {
-    expect(
-      hexToBn('0x2efb', { isLe: true, isNegative: true }).toNumber()
-    ).toBe(-1234);
-  });
-
-  it('handles negative numbers (BE)', (): void => {
-    expect(
-      hexToBn('0xfb2e', { isLe: false, isNegative: true }).toNumber()
-    ).toBe(-1234);
-  });
-
-  it('handles negative numbers (LE, 128)', (): void => {
-    expect(
-      hexToBn('0x00009c584c491ff2ffffffffffffffff', { isLe: true, isNegative: true }).toString()
-    ).toEqual('-1000000000000000000');
-  });
-
-  it('handles starting zeros correctly (BE)', (): void => {
-    expect(
-      hexToBn('0x0000000000000100', { isLe: false }).toNumber()
-    ).toBe(256);
-  });
-
-  it('handles starting zeros correctly (LE)', (): void => {
-    expect(
-      hexToBn('0x0001000000000000', { isLe: true }).toNumber()
-    ).toBe(256);
-  });
-});

package/src/hex/toBn.ts

@@ -1,40 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { ToBnOptions } from '../types.js';
-
-import { BN } from '../bn/bn.js';
-import { hexStripPrefix } from './stripPrefix.js';
-
-/**
- * @name hexToBn
- * @summary Creates a BN.js object from a hex string.
- * @description
- * `null` inputs returns a `BN(0)` result. Hex input values return the actual value converted to a BN. Anything that is not a hex string (including the `0x` prefix) throws an error.
- * @param _value The value to convert
- * @param _options Options to pass while converting
- * @param _options.isLe Convert using Little Endian
- * @param _options.isNegative Convert using two's complement
- * @example
- * <BR>
- *
- * ```javascript
- * import { hexToBn } from '@pezkuwi/util';
- *
- * hexToBn('0x123480001f'); // => BN(0x123480001f)
- * ```
- */
-export function hexToBn (value?: string | null, { isLe = false, isNegative = false }: ToBnOptions = {}): BN {
-  if (!value || value === '0x') {
-    return new BN(0);
-  }
-
-  const stripped = hexStripPrefix(value);
-  const bn = new BN(stripped, 16, isLe ? 'le' : 'be');
-
-  // fromTwos takes as parameter the number of bits, which is the hex length
-  // multiplied by 4 (2 bytes being 8 bits)
-  return isNegative
-    ? bn.fromTwos(stripped.length * 4)
-    : bn;
-}

package/src/hex/toNumber.spec.ts

@@ -1,20 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { hexToNumber } from './index.js';
-
-describe('hexToNumber', (): void => {
-  it('converts an empty to NaN', (): void => {
-    expect(
-      hexToNumber()
-    ).toEqual(NaN);
-  });
-
-  it('converts to a number from hex', (): void => {
-    expect(
-      hexToNumber('0x1234')
-    ).toEqual(0x1234);
-  });
-});

package/src/hex/toNumber.ts

@@ -1,24 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { hexToBn } from './toBn.js';
-
-/**
- * @name hexToNumber
- * @summary Creates a Number value from a Buffer object.
- * @description
- * `null` inputs returns an NaN result, `hex` values return the actual value as a `Number`.
- * @example
- * <BR>
- *
- * ```javascript
- * import { hexToNumber } from '@pezkuwi/util';
- *
- * hexToNumber('0x1234'); // => 0x1234
- * ```
- */
-export function hexToNumber (value?: string | null): number {
-  return value
-    ? hexToBn(value).toNumber()
-    : NaN;
-}

package/src/hex/toString.spec.ts

@@ -1,20 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { hexToString } from './index.js';
-
-describe('hexToString', (): void => {
-  it('converts an empty to ""', (): void => {
-    expect(
-      hexToString()
-    ).toEqual('');
-  });
-
-  it('converts to a string from hex', (): void => {
-    expect(
-      hexToString('0x68656c6c6f')
-    ).toEqual('hello');
-  });
-});

package/src/hex/toString.ts

@@ -1,25 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { u8aToString } from '../u8a/toString.js';
-import { hexToU8a } from './toU8a.js';
-
-/**
- * @name hexToU8a
- * @summary Creates a Uint8Array object from a hex string.
- * @description
- * Hex input values return the actual bytes value converted to a string. Anything that is not a hex string (including the `0x` prefix) throws an error.
- * @example
- * <BR>
- *
- * ```javascript
- * import { hexToString } from '@pezkuwi/util';
- *
- * hexToU8a('0x68656c6c6f'); // hello
- * ```
- */
-export function hexToString (_value?: string | null): string {
-  return u8aToString(
-    hexToU8a(_value)
-  );
-}

package/src/hex/toU8a.spec.ts

@@ -1,76 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { perfCmp } from '../test/index.js';
-import { hexToU8a } from './index.js';
-import { hexToU8a as hexToU8aBuffer } from './toU8aBuffer.js';
-
-let ptest = '0x';
-
-for (let i = 0; i < 1_000_000; i++) {
-  ptest += (i % 256).toString(16);
-}
-
-describe('hexToU8a', (): void => {
-  it('returns an empty Uint8Array when null provided', (): void => {
-    expect(
-      hexToU8a(null)
-    ).toHaveLength(0);
-  });
-
-  it('returns an empty Uint8Array when 0x provided', (): void => {
-    expect(
-      hexToU8a('0x')
-    ).toHaveLength(0);
-  });
-
-  it('returns a Uint8Array with the correct values', (): void => {
-    expect(
-      hexToU8a('0x80000a')
-    ).toEqual(
-      new Uint8Array([128, 0, 10])
-    );
-  });
-
-  it('returns a Uint8Array with the correct values (bitLength > provided)', (): void => {
-    expect(
-      hexToU8a('0x80000A', 64)
-    ).toEqual(
-      new Uint8Array([0, 0, 0, 0, 0, 128, 0, 10])
-    );
-  });
-
-  it('returns a Uint8Array with the correct values (bitLength < provided)', (): void => {
-    expect(
-      hexToU8a('0x80000a', 16)
-    ).toEqual(
-      new Uint8Array([128, 0])
-    );
-  });
-
-  it('converts a non-aligned string', (): void => {
-    expect(
-      hexToU8a('0x123')
-    ).toEqual(new Uint8Array([0x12, 0x30]));
-  });
-
-  it('converts known bytes to their correct values', (): void => {
-    expect(
-      hexToU8a('0x68656c6c6f20776f726c64') // hello world (11 bytes, non-aligned)
-    ).toEqual(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x77, 0x6f, 0x72, 0x6c, 0x64]));
-  });
-
-  it('converts known bytes to their correct values (upper/lower)', (): void => {
-    expect(
-      hexToU8a('0x68656C6c6f20776F726c64') // hello world (11 bytes, non-aligned)
-    ).toEqual(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x77, 0x6f, 0x72, 0x6c, 0x64]));
-  });
-
-  perfCmp('hexToU8a', ['hexToU8aBuffer', 'hexToU8a'], 40, [[ptest]], (s: string, isSecond) =>
-    isSecond
-      ? hexToU8a(s)
-      : hexToU8aBuffer(s)
-  );
-});

package/src/hex/toU8a.ts

@@ -1,68 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-const CHR = '0123456789abcdef';
-const U8 = new Uint8Array(256);
-const U16 = new Uint8Array(256 * 256);
-
-for (let i = 0, count = CHR.length; i < count; i++) {
-  U8[CHR[i].charCodeAt(0) | 0] = i | 0;
-
-  if (i > 9) {
-    U8[CHR[i].toUpperCase().charCodeAt(0) | 0] = i | 0;
-  }
-}
-
-for (let i = 0; i < 256; i++) {
-  const s = i << 8;
-
-  for (let j = 0; j < 256; j++) {
-    U16[s | j] = (U8[i] << 4) | U8[j];
-  }
-}
-
-/**
- * @name hexToU8a
- * @summary Creates a Uint8Array object from a hex string.
- * @description
- * `null` inputs returns an empty `Uint8Array` result. Hex input values return the actual bytes value converted to a Uint8Array. Anything that is not a hex string (including the `0x` prefix) throws an error.
- * @example
- * <BR>
- *
- * ```javascript
- * import { hexToU8a } from '@pezkuwi/util';
- *
- * hexToU8a('0x80001f'); // Uint8Array([0x80, 0x00, 0x1f])
- * hexToU8a('0x80001f', 32); // Uint8Array([0x00, 0x80, 0x00, 0x1f])
- * ```
- */
-export function hexToU8a (value?: string | null, bitLength = -1): Uint8Array {
-  if (!value) {
-    return new Uint8Array();
-  }
-
-  let s = value.startsWith('0x')
-    ? 2
-    : 0;
-
-  const decLength = Math.ceil((value.length - s) / 2);
-  const endLength = Math.ceil(
-    bitLength === -1
-      ? decLength
-      : bitLength / 8
-  );
-  const result = new Uint8Array(endLength);
-  const offset = endLength > decLength
-    ? endLength - decLength
-    : 0;
-
-  for (let i = offset; i < endLength; i++, s += 2) {
-    // The big factor here is actually the string lookups. If we do
-    // HEX_TO_U16[value.substring()] we get an 10x slowdown. In the
-    // same vein using charCodeAt (as opposed to value[s] or value.charAt(s)) is
-    // also the faster operation by at least 2x with the character map above
-    result[i] = U16[(value.charCodeAt(s) << 8) | value.charCodeAt(s + 1)];
-  }
-
-  return result;
-}

package/src/hex/toU8aBuffer.spec.ts

@@ -1,38 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { hexToU8a } from './toU8aBuffer.js';
-
-describe('hexToU8a', (): void => {
-  it('returns an empty Uint8Array when null provided', (): void => {
-    expect(
-      hexToU8a(null)
-    ).toHaveLength(0);
-  });
-
-  it('returns a Uint8Array with the correct values', (): void => {
-    expect(
-      hexToU8a('0x80000a')
-    ).toEqual(
-      new Uint8Array([128, 0, 10])
-    );
-  });
-
-  it('returns a Uint8Array with the correct values (bitLength > provided)', (): void => {
-    expect(
-      hexToU8a('0x80000A', 64)
-    ).toEqual(
-      new Uint8Array([0, 0, 0, 0, 0, 128, 0, 10])
-    );
-  });
-
-  it('returns a Uint8Array with the correct values (bitLength < provided)', (): void => {
-    expect(
-      hexToU8a('0x80000a', 16)
-    ).toEqual(
-      new Uint8Array([128, 0])
-    );
-  });
-});

package/src/hex/toU8aBuffer.ts

@@ -1,52 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/**
- * @name hexToU8a
- * @summary Creates a Uint8Array object from a hex string.
- * @description
- * `null` inputs returns an empty `Uint8Array` result. Hex input values return the actual bytes value converted to a Uint8Array. Anything that is not a hex string (including the `0x` prefix) throws an error.
- * @example
- * <BR>
- *
- * ```javascript
- * import { hexToU8a } from '@pezkuwi/util';
- *
- * hexToU8a('0x80001f'); // Uint8Array([0x80, 0x00, 0x1f])
- * hexToU8a('0x80001f', 32); // Uint8Array([0x00, 0x80, 0x00, 0x1f])
- * ```
- */
-export function hexToU8a (_value?: string | null, bitLength = -1): Uint8Array {
-  if (!_value) {
-    return new Uint8Array();
-  }
-
-  const value = _value.startsWith('0x')
-    ? _value.substring(2)
-    : _value;
-  const buf = Buffer.from(value, 'hex');
-  const valLength = value.length / 2;
-  const resultLength = Math.ceil(
-    bitLength === -1
-      ? valLength
-      : bitLength / 8
-  );
-
-  if (resultLength === valLength) {
-    return Uint8Array.from(buf);
-  }
-
-  const offset = resultLength > valLength
-    ? resultLength - valLength
-    : 0;
-
-  if (offset) {
-    const u8a = new Uint8Array(resultLength);
-
-    u8a.set(buf, offset);
-
-    return u8a;
-  }
-
-  return Uint8Array.from(buf.subarray(0, resultLength));
-}

package/src/index.spec.ts

@@ -1,12 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { assert } from './index.js';
-
-describe('index', (): void => {
-  it('exports ok', (): void => {
-    expect(assert).toBeDefined();
-  });
-});

package/src/index.ts

@@ -1,6 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import './packageDetect.js';
-
-export * from './bundle.js';

package/src/is/array.spec.ts

@@ -1,20 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { isArray } from './index.js';
-
-describe('isArray', (): void => {
-  it('is false on no value', (): void => {
-    expect(isArray()).toEqual(false);
-  });
-
-  it('is false on non-array', (): void => {
-    expect(isArray(123)).toEqual(false);
-  });
-
-  it('is true when Array is found', (): void => {
-    expect(isArray([1, 2, 3])).toEqual(true);
-  });
-});

package/src/is/array.ts

@@ -1,10 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/**
- * @name isArray
- * @summary Tests for a Array instance.
- */
-export function isArray <T> (value?: unknown): value is T[] {
-  return Array.isArray(value);
-}

package/src/is/ascii.spec.ts

@@ -1,49 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { stringToU8a } from '../string/index.js';
-import { perf } from '../test/index.js';
-import { isAscii } from './index.js';
-
-describe('isAscii', (): void => {
-  it('returns true for an ASCII string', (): void => {
-    expect(isAscii('Hello World! Testing')).toEqual(true);
-  });
-
-  it('returns false for an ASCII string (with formatters)', (): void => {
-    expect(isAscii('Hello\tWorld!\n\rTesting')).toEqual(false);
-  });
-
-  it('returns false on an non-ascii string', (): void => {
-    expect(isAscii('你好，世界')).toEqual(false);
-  });
-
-  it('returns true for ASCII bytes', (): void => {
-    expect(isAscii(stringToU8a('Hello World! Testing'))).toEqual(true);
-  });
-
-  it('returns true for empty string inputs', (): void => {
-    expect(isAscii('')).toEqual(true);
-  });
-
-  it('returns true for empty U8a inputs', (): void => {
-    expect(isAscii(new Uint8Array())).toEqual(true);
-  });
-
-  it('returns false for empty undefined inputs', (): void => {
-    expect(isAscii()).toEqual(false);
-  });
-
-  it('returns false for non-printable characters', (): void => {
-    expect(isAscii(new Uint8Array([5]))).toEqual(false);
-  });
-
-  it('returns false for hex input, non-ascii', (): void => {
-    expect(isAscii('0x010203')).toEqual(false);
-  });
-
-  perf('isAscii (str)', 2_000_000, [['Hello World! Testing']], isAscii);
-  perf('isAscii (u8a)', 200_000, [[[stringToU8a('Hello World! Testing')]]], isAscii);
-});

package/src/is/ascii.ts

@@ -1,52 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { AnyString, U8aLike } from '../types.js';
-
-import { u8aToU8a } from '../u8a/toU8a.js';
-import { isHex } from './hex.js';
-import { isString } from './string.js';
-
-/** @internal */
-function isAsciiStr (str: AnyString): boolean {
-  for (let i = 0, count = str.length; i < count; i++) {
-    const b = str.charCodeAt(i);
-
-    // check is inlined here, it is faster than making a call
-    if (b < 32 || b > 126) {
-      return false;
-    }
-  }
-
-  return true;
-}
-
-/** @internal */
-function isAsciiBytes (u8a: Uint8Array | number[]): boolean {
-  for (let i = 0, count = u8a.length; i < count; i++) {
-    const b = u8a[i] | 0;
-
-    // check is inlined here, it is faster than making a call
-    if (b < 32 || b > 126) {
-      return false;
-    }
-  }
-
-  return true;
-}
-
-/**
- * @name isAscii
- * @summary Tests if the input is printable ASCII
- * @description
- * Checks to see if the input string or Uint8Array is printable ASCII, 32-127 + formatters
- */
-export function isAscii (value?: U8aLike | null): boolean {
-  return isString(value)
-    ? isHex(value)
-      ? isAsciiBytes(u8aToU8a(value))
-      : isAsciiStr(value)
-    : value
-      ? isAsciiBytes(value)
-      : false;
-}

package/src/is/bigInt.spec.ts

@@ -1,26 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { isBigInt } from './index.js';
-
-describe('isBigInt', (): void => {
-  it('returns true with a ...n value', (): void => {
-    expect(
-      isBigInt(123456n)
-    ).toEqual(true);
-  });
-
-  it('returns true with a BigInt(...) value', (): void => {
-    expect(
-      isBigInt(BigInt(123456))
-    ).toEqual(true);
-  });
-
-  it('returns false on non-BigInt values', (): void => {
-    expect(
-      isBigInt(0)
-    ).toEqual(false);
-  });
-});

package/src/is/bigInt.ts

@@ -1,20 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/**
- * @name isBigInt
- * @summary Tests for a `BigInt` object instance.
- * @description
- * Checks to see if the input object is an instance of `BigInt`
- * @example
- * <BR>
- *
- * ```javascript
- * import { isBigInt } from '@pezkuwi/util';
- *
- * console.log('isBigInt', isBigInt(123_456n)); // => true
- * ```
- */
-export function isBigInt (value: unknown): value is bigint {
-  return typeof value === 'bigint';
-}

package/src/is/bn.spec.ts

@@ -1,21 +0,0 @@
-// Copyright 2017-2025 @pezkuwi/util authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
-
-import { BN } from '../bn/index.js';
-import { isBn } from './index.js';
-
-describe('isBN', (): void => {
-  it('returns true when a BN value', (): void => {
-    expect(
-      isBn(new BN(123))
-    ).toEqual(true);
-  });
-
-  it('returns false on non-BN values', (): void => {
-    expect(
-      isBn(0)
-    ).toEqual(false);
-  });
-});