@pezkuwi/util 14.0.5 → 14.0.6

package/build/packageDetect.d.ts

@@ -0,0 +1 @@
+export {};

package/build/packageDetect.js

@@ -0,0 +1,5 @@
+import { packageInfo as decoderInfo } from '@pezkuwi/x-textdecoder';
+import { packageInfo as encoderInfo } from '@pezkuwi/x-textencoder';
+import { detectPackage } from './detectPackage.js';
+import { packageInfo } from './packageInfo.js';
+detectPackage(packageInfo, null, [decoderInfo, encoderInfo]);

package/build/packageInfo.d.ts

@@ -0,0 +1,6 @@
+export declare const packageInfo: {
+    name: string;
+    path: string;
+    type: string;
+    version: string;
+};

package/build/packageInfo.js

@@ -0,0 +1 @@
+export const packageInfo = { name: '@pezkuwi/util', path: (import.meta && import.meta.url) ? new URL(import.meta.url).pathname.substring(0, new URL(import.meta.url).pathname.lastIndexOf('/') + 1) : 'auto', type: 'esm', version: '14.0.6' };

package/build/promisify.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @name promisify
+ * @summary Wraps an async callback into a `Promise`
+ * @description
+ * Wraps the supplied async function `fn` that has a standard JS callback `(error: Error, result: any)` into a `Promise`, passing the supplied parameters. When `error` is set, the Promise is rejected, else the Promise resolves with the `result` value.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * const { promisify } from '@pezkuwi/util';
+ *
+ * await promisify(null, ((a, cb) => cb(null, a), true); // resolves with `true`
+ * await promisify(null, (cb) => cb(new Error('error!'))); // rejects with `error!`
+ * ```
+ */
+export declare function promisify<R = any>(self: unknown, fn: (...params: any[]) => any, ...params: any[]): Promise<R>;

package/build/promisify.js

@@ -0,0 +1,27 @@
+/**
+ * @name promisify
+ * @summary Wraps an async callback into a `Promise`
+ * @description
+ * Wraps the supplied async function `fn` that has a standard JS callback `(error: Error, result: any)` into a `Promise`, passing the supplied parameters. When `error` is set, the Promise is rejected, else the Promise resolves with the `result` value.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * const { promisify } from '@pezkuwi/util';
+ *
+ * await promisify(null, ((a, cb) => cb(null, a), true); // resolves with `true`
+ * await promisify(null, (cb) => cb(new Error('error!'))); // rejects with `error!`
+ * ```
+ */
+export function promisify(self, fn, ...params) {
+    return new Promise((resolve, reject) => {
+        fn.apply(self, params.concat((error, result) => {
+            if (error) {
+                reject(error);
+            }
+            else {
+                resolve(result);
+            }
+        }));
+    });
+}

package/build/string/camelCase.d.ts

@@ -0,0 +1,13 @@
+import type { AnyString } from '../types.js';
+export declare const CC_TO_UP: string[];
+export declare const CC_TO_LO: string[];
+/**
+ * @name stringCamelCase
+ * @summary Convert a dash/dot/underscore/space separated Ascii string/String to camelCase
+ */
+export declare const stringCamelCase: (value: AnyString) => string;
+/**
+ * @name stringPascalCase
+ * @summary Convert a dash/dot/underscore/space separated Ascii string/String to PascalCase
+ */
+export declare const stringPascalCase: (value: AnyString) => string;

package/build/string/camelCase.js

@@ -0,0 +1,59 @@
+export const CC_TO_UP = new Array(256);
+export const CC_TO_LO = new Array(256);
+for (let i = 0, count = CC_TO_UP.length; i < count; i++) {
+    CC_TO_LO[i] = String.fromCharCode(i).toLowerCase();
+    CC_TO_UP[i] = String.fromCharCode(i).toUpperCase();
+}
+/** @internal */
+function formatAllCaps(w) {
+    return w.slice(0, w.length - 1).toLowerCase() + CC_TO_UP[w.charCodeAt(w.length - 1)];
+}
+/**
+ * @internal
+ *
+ * Inspired by https://stackoverflow.com/a/2970667
+ *
+ * This is not as optimal as the original SO answer (we split into per-word),
+ * however it does pass the tests (which the SO version doesn't) and is still
+ * a major improvement over the original camelcase npm package -
+ *
+ *   camelcase: 20.88 μs/op
+ *        this:  1.00 μs/op
+ *
+ * Caveat of this: only Ascii, but acceptable for the intended usecase
+ */
+function converter(format) {
+    return (value) => {
+        const parts = value
+            // replace all separators (including consequtive) with spaces
+            .replace(/[-_., ]+/g, ' ')
+            // we don't want leading or trailing spaces
+            .trim()
+            // split into words
+            .split(' ');
+        let result = '';
+        for (let i = 0, count = parts.length; i < count; i++) {
+            const w = parts[i];
+            // apply the formatting
+            result += format(/^[\dA-Z]+$/.test(w)
+                // all full uppercase + letters are changed to lowercase
+                ? w.toLowerCase()
+                // all consecutive capitals + letters are changed to lowercase
+                // e.g. UUID64 -> uuid64, while preserving splits, eg. NFTOrder -> nftOrder
+                : w.replace(/^[\dA-Z]{2,}[^a-z]/, formatAllCaps), i);
+        }
+        return result;
+    };
+}
+/**
+ * @name stringCamelCase
+ * @summary Convert a dash/dot/underscore/space separated Ascii string/String to camelCase
+ */
+export const stringCamelCase = /*#__PURE__*/ converter((w, i) => 
+(i ? CC_TO_UP[w.charCodeAt(0)] : CC_TO_LO[w.charCodeAt(0)]) + w.slice(1));
+/**
+ * @name stringPascalCase
+ * @summary Convert a dash/dot/underscore/space separated Ascii string/String to PascalCase
+ */
+export const stringPascalCase = /*#__PURE__*/ converter((w) => 
+CC_TO_UP[w.charCodeAt(0)] + w.slice(1));

package/build/string/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @summary Utility methods to convert to work with `string` values
+ */
+export { stringCamelCase, stringPascalCase } from './camelCase.js';
+export { stringLowerFirst, stringUpperFirst } from './lowerFirst.js';
+export { stringShorten } from './shorten.js';
+export { stringToHex } from './toHex.js';
+export { stringToU8a } from './toU8a.js';

package/build/string/index.js

@@ -0,0 +1,8 @@
+/**
+ * @summary Utility methods to convert to work with `string` values
+ */
+export { stringCamelCase, stringPascalCase } from './camelCase.js';
+export { stringLowerFirst, stringUpperFirst } from './lowerFirst.js';
+export { stringShorten } from './shorten.js';
+export { stringToHex } from './toHex.js';
+export { stringToU8a } from './toU8a.js';

package/build/string/lowerFirst.d.ts

@@ -0,0 +1,31 @@
+import type { AnyString } from '../types.js';
+/**
+ * @name stringLowerFirst
+ * @summary Lowercase the first letter of a string
+ * @description
+ * Lowercase the first letter of a string
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringLowerFirst } from '@pezkuwi/util';
+ *
+ * stringLowerFirst('ABC'); // => 'aBC'
+ * ```
+ */
+export declare const stringLowerFirst: (value?: AnyString | null) => string;
+/**
+ * @name stringUpperFirst
+ * @summary Uppercase the first letter of a string
+ * @description
+ * Lowercase the first letter of a string
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringUpperFirst } from '@pezkuwi/util';
+ *
+ * stringUpperFirst('abc'); // => 'Abc'
+ * ```
+ */
+export declare const stringUpperFirst: (value?: AnyString | null) => string;

package/build/string/lowerFirst.js

@@ -0,0 +1,37 @@
+import { CC_TO_LO, CC_TO_UP } from './camelCase.js';
+/** @internal */
+function converter(map) {
+    return (value) => value
+        ? map[value.charCodeAt(0)] + value.slice(1)
+        : '';
+}
+/**
+ * @name stringLowerFirst
+ * @summary Lowercase the first letter of a string
+ * @description
+ * Lowercase the first letter of a string
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringLowerFirst } from '@pezkuwi/util';
+ *
+ * stringLowerFirst('ABC'); // => 'aBC'
+ * ```
+ */
+export const stringLowerFirst = /*#__PURE__*/ converter(CC_TO_LO);
+/**
+ * @name stringUpperFirst
+ * @summary Uppercase the first letter of a string
+ * @description
+ * Lowercase the first letter of a string
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringUpperFirst } from '@pezkuwi/util';
+ *
+ * stringUpperFirst('abc'); // => 'Abc'
+ * ```
+ */
+export const stringUpperFirst = /*#__PURE__*/ converter(CC_TO_UP);

package/build/string/shorten.d.ts

@@ -0,0 +1,16 @@
+import type { AnyString } from '../types.js';
+/**
+ * @name stringShorten
+ * @summary Returns a string with maximum length
+ * @description
+ * Checks the string against the `prefixLength`, if longer than double this, shortens it by placing `..` in the middle of it
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringShorten } from '@pezkuwi/util';
+ *
+ * stringShorten('1234567890', 2); // => 12..90
+ * ```
+ */
+export declare function stringShorten(value: AnyString, prefixLength?: number): string;

package/build/string/shorten.js

@@ -0,0 +1,19 @@
+/**
+ * @name stringShorten
+ * @summary Returns a string with maximum length
+ * @description
+ * Checks the string against the `prefixLength`, if longer than double this, shortens it by placing `..` in the middle of it
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringShorten } from '@pezkuwi/util';
+ *
+ * stringShorten('1234567890', 2); // => 12..90
+ * ```
+ */
+export function stringShorten(value, prefixLength = 6) {
+    return value.length <= 2 + 2 * prefixLength
+        ? value.toString()
+        : `${value.substring(0, prefixLength)}…${value.slice(-prefixLength)}`;
+}

package/build/string/toHex.d.ts

@@ -0,0 +1,16 @@
+import type { AnyString, HexString } from '../types.js';
+/**
+ * @name stringToHex
+ * @summary Creates a hex string from a utf-8 string
+ * @description
+ * String input values return the actual encoded hex value.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringToHex } from '@pezkuwi/util';
+ *
+ * stringToU8a('hello'); // 0x68656c6c6f
+ * ```
+ */
+export declare function stringToHex(value?: AnyString): HexString;

package/build/string/toHex.js

@@ -0,0 +1,19 @@
+import { u8aToHex } from '../u8a/toHex.js';
+import { stringToU8a } from './toU8a.js';
+/**
+ * @name stringToHex
+ * @summary Creates a hex string from a utf-8 string
+ * @description
+ * String input values return the actual encoded hex value.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringToHex } from '@pezkuwi/util';
+ *
+ * stringToU8a('hello'); // 0x68656c6c6f
+ * ```
+ */
+export function stringToHex(value) {
+    return u8aToHex(stringToU8a(value));
+}

package/build/string/toU8a.d.ts

@@ -0,0 +1,16 @@
+import type { AnyString } from '../types.js';
+/**
+ * @name stringToU8a
+ * @summary Creates a Uint8Array object from a utf-8 string.
+ * @description
+ * String input values return the actual encoded `UInt8Array`. `null` or `undefined` values returns an empty encoded array.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringToU8a } from '@pezkuwi/util';
+ *
+ * stringToU8a('hello'); // [0x68, 0x65, 0x6c, 0x6c, 0x6f]
+ * ```
+ */
+export declare function stringToU8a(value?: AnyString | null): Uint8Array;

package/build/string/toU8a.js

@@ -0,0 +1,21 @@
+import { TextEncoder } from '@pezkuwi/x-textencoder';
+const encoder = new TextEncoder();
+/**
+ * @name stringToU8a
+ * @summary Creates a Uint8Array object from a utf-8 string.
+ * @description
+ * String input values return the actual encoded `UInt8Array`. `null` or `undefined` values returns an empty encoded array.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringToU8a } from '@pezkuwi/util';
+ *
+ * stringToU8a('hello'); // [0x68, 0x65, 0x6c, 0x6c, 0x6f]
+ * ```
+ */
+export function stringToU8a(value) {
+    return value
+        ? encoder.encode(value.toString())
+        : new Uint8Array();
+}

package/build/stringify.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @name stringify
+ * @summary Performs a JSON.stringify, with BigInt handling
+ * @description A wrapper for JSON.stringify that handles BigInt values transparently, converting them to string. No differences from the native JSON.stringify function otherwise.
+ */
+export declare function stringify(value: unknown, space?: string | number): string;

package/build/stringify.js

@@ -0,0 +1,15 @@
+import { isBigInt } from './is/bigInt.js';
+/** @internal */
+function replacer(_, v) {
+    return isBigInt(v)
+        ? v.toString()
+        : v;
+}
+/**
+ * @name stringify
+ * @summary Performs a JSON.stringify, with BigInt handling
+ * @description A wrapper for JSON.stringify that handles BigInt values transparently, converting them to string. No differences from the native JSON.stringify function otherwise.
+ */
+export function stringify(value, space) {
+    return JSON.stringify(value, replacer, space);
+}

package/build/types.d.ts

@@ -0,0 +1,62 @@
+import type { BN } from './bn/bn.js';
+/** An interface that defines an actual JS class */
+export interface Class<T = any, A extends unknown[] = any[]> {
+    prototype: T;
+    new (...args: A): T;
+    hasOwnProperty(prop: string): boolean;
+    isPrototypeOf(other: unknown): boolean;
+}
+export type Constructor<T = any, A extends unknown[] = any[]> = Class<T, A>;
+export interface ToBigInt {
+    toBigInt: () => bigint;
+}
+export interface ToBn {
+    toBn: () => BN;
+}
+export interface SiDef {
+    power: number;
+    text: string;
+    value: string;
+}
+export interface Logger {
+    debug: (...values: unknown[]) => void;
+    error: (...values: unknown[]) => void;
+    log: (...values: unknown[]) => void;
+    noop: (...values: unknown[]) => void;
+    warn: (...values: unknown[]) => void;
+}
+export interface ToBnOptions {
+    /** Convert in LE format */
+    isLe?: boolean;
+    /** Number is signed, apply two's complement */
+    isNegative?: boolean;
+}
+export interface NumberOptions extends ToBnOptions {
+    /** Limit to the specified bitLength, despite input length */
+    bitLength?: number;
+}
+export interface Time {
+    days: number;
+    hours: number;
+    minutes: number;
+    seconds: number;
+    milliseconds: number;
+}
+export type Memoized<F> = F & {
+    unmemoize: (...args: unknown[]) => void;
+};
+export type AnyString = string | String;
+export type HexDigit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'a' | 'b' | 'c' | 'd' | 'e' | 'f';
+export type HexString = `0x${string}`;
+export interface BufferObject extends Uint8Array {
+    equals: (otherBuffer: Uint8Array) => boolean;
+    readDoubleLE: (offset?: number) => number;
+}
+export interface BufferClass extends Class<BufferObject> {
+    from: <T = BufferObject>(value: unknown) => T;
+    isBuffer: (value: unknown) => boolean;
+}
+export type U8aLike = number[] | Uint8Array | AnyString;
+export interface Observable {
+    next: (...params: unknown[]) => unknown;
+}

package/build/types.js

@@ -0,0 +1 @@
+export {};

package/build/u8a/cmp.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @name u8aCmp
+ * @summary Compares two Uint8Arrays for sorting.
+ * @description
+ * For `UInt8Array` (or hex string) input values returning -1, 0 or +1
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { u8aCmp } from '@pezkuwi/util';
+ *
+ * u8aCmp(new Uint8Array([0x67, 0x65]), new Uint8Array([0x68, 0x65])); // -1
+ * u8aCmp(new Uint8Array([0x68, 0x65]), new Uint8Array([0x68, 0x65])); // 0
+ * u8aCmp(new Uint8Array([0x69, 0x65]), new Uint8Array([0x68, 0x65])); // +1
+ * ```
+ */
+export declare function u8aCmp(a: string | Uint8Array, b: string | Uint8Array): number;

package/build/u8a/cmp.js

@@ -0,0 +1,46 @@
+import { u8aToU8a } from './toU8a.js';
+/**
+ * @name u8aCmp
+ * @summary Compares two Uint8Arrays for sorting.
+ * @description
+ * For `UInt8Array` (or hex string) input values returning -1, 0 or +1
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { u8aCmp } from '@pezkuwi/util';
+ *
+ * u8aCmp(new Uint8Array([0x67, 0x65]), new Uint8Array([0x68, 0x65])); // -1
+ * u8aCmp(new Uint8Array([0x68, 0x65]), new Uint8Array([0x68, 0x65])); // 0
+ * u8aCmp(new Uint8Array([0x69, 0x65]), new Uint8Array([0x68, 0x65])); // +1
+ * ```
+ */
+export function u8aCmp(a, b) {
+    const u8aa = u8aToU8a(a);
+    const u8ab = u8aToU8a(b);
+    let i = 0;
+    while (true) {
+        const overA = i >= u8aa.length;
+        const overB = i >= u8ab.length;
+        if (overA && overB) {
+            // both ends reached
+            return 0;
+        }
+        else if (overA) {
+            // a has no more data, b has data
+            return -1;
+        }
+        else if (overB) {
+            // b has no more data, a has data
+            return 1;
+        }
+        else if (u8aa[i] !== u8ab[i]) {
+            // the number in this index doesn't match
+            // (we don't use u8aa[i] - u8ab[i] since that doesn't match with localeCompare)
+            return u8aa[i] > u8ab[i]
+                ? 1
+                : -1;
+        }
+        i++;
+    }
+}

package/build/u8a/concat.d.ts

@@ -0,0 +1,24 @@
+import type { U8aLike } from '../types.js';
+/**
+ * @name u8aConcat
+ * @summary Creates a concatenated Uint8Array from the inputs.
+ * @description
+ * Concatenates the input arrays into a single `UInt8Array`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { { u8aConcat } from '@pezkuwi/util';
+ *
+ * u8aConcat(
+ *   new Uint8Array([1, 2, 3]),
+ *   new Uint8Array([4, 5, 6])
+ * ); // [1, 2, 3, 4, 5, 6]
+ * ```
+ */
+export declare function u8aConcat(...list: readonly U8aLike[]): Uint8Array;
+/**
+ * @name u8aConcatStrict
+ * @description A strict version of [[u8aConcat]], accepting only Uint8Array inputs
+ */
+export declare function u8aConcatStrict(u8as: readonly Uint8Array[], length?: number): Uint8Array;

package/build/u8a/concat.js

@@ -0,0 +1,47 @@
+import { u8aToU8a } from './toU8a.js';
+/**
+ * @name u8aConcat
+ * @summary Creates a concatenated Uint8Array from the inputs.
+ * @description
+ * Concatenates the input arrays into a single `UInt8Array`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { { u8aConcat } from '@pezkuwi/util';
+ *
+ * u8aConcat(
+ *   new Uint8Array([1, 2, 3]),
+ *   new Uint8Array([4, 5, 6])
+ * ); // [1, 2, 3, 4, 5, 6]
+ * ```
+ */
+export function u8aConcat(...list) {
+    const count = list.length;
+    const u8as = new Array(count);
+    let length = 0;
+    for (let i = 0; i < count; i++) {
+        u8as[i] = u8aToU8a(list[i]);
+        length += u8as[i].length;
+    }
+    return u8aConcatStrict(u8as, length);
+}
+/**
+ * @name u8aConcatStrict
+ * @description A strict version of [[u8aConcat]], accepting only Uint8Array inputs
+ */
+export function u8aConcatStrict(u8as, length = 0) {
+    const count = u8as.length;
+    let offset = 0;
+    if (!length) {
+        for (let i = 0; i < count; i++) {
+            length += u8as[i].length;
+        }
+    }
+    const result = new Uint8Array(length);
+    for (let i = 0; i < count; i++) {
+        result.set(u8as[i], offset);
+        offset += u8as[i].length;
+    }
+    return result;
+}

package/build/u8a/concatBuffer.d.ts

@@ -0,0 +1,19 @@
+import type { U8aLike } from '../types.js';
+/**
+ * @name u8aConcat
+ * @summary Creates a concatenated Uint8Array from the inputs.
+ * @description
+ * Concatenates the input arrays into a single `UInt8Array`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { { u8aConcat } from '@pezkuwi/util';
+ *
+ * u8aConcat(
+ *   new Uint8Array([1, 2, 3]),
+ *   new Uint8Array([4, 5, 6])
+ * ); // [1, 2, 3, 4, 5, 6]
+ * ```
+ */
+export declare function u8aConcat(...list: readonly U8aLike[]): Uint8Array;

package/build/u8a/concatBuffer.js

@@ -0,0 +1,26 @@
+import { u8aToU8a } from './toU8a.js';
+/**
+ * @name u8aConcat
+ * @summary Creates a concatenated Uint8Array from the inputs.
+ * @description
+ * Concatenates the input arrays into a single `UInt8Array`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { { u8aConcat } from '@pezkuwi/util';
+ *
+ * u8aConcat(
+ *   new Uint8Array([1, 2, 3]),
+ *   new Uint8Array([4, 5, 6])
+ * ); // [1, 2, 3, 4, 5, 6]
+ * ```
+ */
+export function u8aConcat(...list) {
+    const count = list.length;
+    const u8as = new Array(count);
+    for (let i = 0; i < count; i++) {
+        u8as[i] = u8aToU8a(list[i]);
+    }
+    return Uint8Array.from(Buffer.concat(u8as));
+}

package/build/u8a/empty.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @name u8aEmpty
+ * @summary Tests for a `Uint8Array` for emptyness
+ * @description
+ * Checks to see if the input `Uint8Array` has zero length or contains all 0 values.
+ */
+export declare function u8aEmpty(value: Uint8Array): boolean;

package/build/u8a/empty.js

@@ -0,0 +1,17 @@
+/**
+ * @name u8aEmpty
+ * @summary Tests for a `Uint8Array` for emptyness
+ * @description
+ * Checks to see if the input `Uint8Array` has zero length or contains all 0 values.
+ */
+export function u8aEmpty(value) {
+    const len = value.length | 0;
+    // on smaller sizes, the byte-by-byte compare is faster than allocating
+    // another object for DataView (on very large arrays the DataView is faster)
+    for (let i = 0; i < len; i++) {
+        if (value[i] | 0) {
+            return false;
+        }
+    }
+    return true;
+}

package/build/u8a/eq.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @name u8aEq
+ * @summary Compares two Uint8Arrays for equality.
+ * @description
+ * For `UInt8Array` (or hex string) input values true if there is a match.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { u8aEq } from '@pezkuwi/util';
+ *
+ * u8aEq(new Uint8Array([0x68, 0x65]), new Uint8Array([0x68, 0x65])); // true
+ * ```
+ */
+export declare function u8aEq(a: string | Uint8Array, b: string | Uint8Array): boolean;