@pezkuwi/util 14.0.6 → 14.0.7

package/build/logger.js

@@ -1,118 +0,0 @@
-import { xglobal } from '@pezkuwi/x-global';
-import { formatDate } from './format/formatDate.js';
-import { isBn } from './is/bn.js';
-import { isBuffer } from './is/buffer.js';
-import { isFunction } from './is/function.js';
-import { isObject } from './is/object.js';
-import { isU8a } from './is/u8a.js';
-import { u8aToHex } from './u8a/toHex.js';
-import { u8aToU8a } from './u8a/toU8a.js';
-import { noop } from './noop.js';
-const logTo = {
-    debug: 'log',
-    error: 'error',
-    log: 'log',
-    warn: 'warn'
-};
-function formatOther(value) {
-    if (value && isObject(value) && value.constructor === Object) {
-        const result = {};
-        for (const [k, v] of Object.entries(value)) {
-            result[k] = loggerFormat(v);
-        }
-        return result;
-    }
-    return value;
-}
-export function loggerFormat(value) {
-    if (Array.isArray(value)) {
-        return value.map(loggerFormat);
-    }
-    else if (isBn(value)) {
-        return value.toString();
-    }
-    else if (isU8a(value) || isBuffer(value)) {
-        return u8aToHex(u8aToU8a(value));
-    }
-    return formatOther(value);
-}
-function formatWithLength(maxLength) {
-    return (v) => {
-        if (maxLength <= 0) {
-            return v;
-        }
-        const r = `${v}`;
-        return r.length < maxLength
-            ? v
-            : `${r.substring(0, maxLength)} ...`;
-    };
-}
-function apply(log, type, values, maxSize = -1) {
-    if (values.length === 1 && isFunction(values[0])) {
-        const fnResult = values[0]();
-        return apply(log, type, Array.isArray(fnResult) ? fnResult : [fnResult], maxSize);
-    }
-    console[logTo[log]](formatDate(new Date()), type, ...values
-        .map(loggerFormat)
-        .map(formatWithLength(maxSize)));
-}
-function isDebugOn(e, type) {
-    return !!e && (e === '*' ||
-        type === e ||
-        (e.endsWith('*') &&
-            type.startsWith(e.slice(0, -1))));
-}
-function isDebugOff(e, type) {
-    return !!e && (e.startsWith('-') &&
-        (type === e.slice(1) ||
-            (e.endsWith('*') &&
-                type.startsWith(e.slice(1, -1)))));
-}
-function getDebugFlag(env, type) {
-    let flag = false;
-    for (const e of env) {
-        if (isDebugOn(e, type)) {
-            flag = true;
-        }
-        else if (isDebugOff(e, type)) {
-            flag = false;
-        }
-    }
-    return flag;
-}
-function parseEnv(type) {
-    const maxSize = parseInt(xglobal.process?.env?.['DEBUG_MAX'] || '-1', 10);
-    return [
-        getDebugFlag((xglobal.process?.env?.['DEBUG'] || '').toLowerCase().split(','), type),
-        isNaN(maxSize)
-            ? -1
-            : maxSize
-    ];
-}
-/**
- * @name Logger
- * @summary Creates a consistent log interface for messages
- * @description
- * Returns a `Logger` that has `.log`, `.error`, `.warn` and `.debug` (controlled with environment `DEBUG=typeA,typeB`) methods. Logging is done with a consistent prefix (type of logger, date) followed by the actual message using the underlying console.
- * @example
- * <BR>
- *
- * ```javascript
- * import { logger } from '@pezkuwi/util';
- *
- * const l = logger('test');
- * ```
- */
-export function logger(origin) {
-    const type = `${origin.toUpperCase()}:`.padStart(16);
-    const [isDebug, maxSize] = parseEnv(origin.toLowerCase());
-    return {
-        debug: isDebug
-            ? (...values) => apply('debug', type, values, maxSize)
-            : noop,
-        error: (...values) => apply('error', type, values),
-        log: (...values) => apply('log', type, values),
-        noop,
-        warn: (...values) => apply('warn', type, values)
-    };
-}

package/build/memoize.d.ts

@@ -1,10 +0,0 @@
-import type { Memoized } from './types.js';
-interface Options {
-    getInstanceId?: () => string;
-}
-/**
- * @name memoize
- * @description Memomize the function with a specific instanceId
- */
-export declare function memoize<T, F extends (...args: any[]) => T>(fn: F, { getInstanceId }?: Options): Memoized<F>;
-export {};

package/build/memoize.js

@@ -1,30 +0,0 @@
-import { stringify } from './stringify.js';
-function defaultGetId() {
-    return 'none';
-}
-/**
- * @name memoize
- * @description Memomize the function with a specific instanceId
- */
-export function memoize(fn, { getInstanceId = defaultGetId } = {}) {
-    const cache = {};
-    const memoized = (...args) => {
-        const stringParams = stringify(args);
-        const instanceId = getInstanceId();
-        if (!cache[instanceId]) {
-            cache[instanceId] = {};
-        }
-        if (cache[instanceId][stringParams] === undefined) {
-            cache[instanceId][stringParams] = fn(...args);
-        }
-        return cache[instanceId][stringParams];
-    };
-    memoized.unmemoize = (...args) => {
-        const stringParams = stringify(args);
-        const instanceId = getInstanceId();
-        if (cache[instanceId]?.[stringParams] !== undefined) {
-            delete cache[instanceId][stringParams];
-        }
-    };
-    return memoized;
-}

package/build/nextTick.d.ts

@@ -1,5 +0,0 @@
-/**
- * @name nextTick
- * @description Defer the operation to the queue for evaluation on the next tick
- */
-export declare function nextTick(onExec: () => unknown, onError?: (error: Error) => unknown): void;

package/build/nextTick.js

@@ -1,24 +0,0 @@
-/**
- * @name nextTick
- * @description Defer the operation to the queue for evaluation on the next tick
- */
-export function nextTick(onExec, onError) {
-    // While Promise.resolve().then(...) would defer to the nextTick, this
-    // actually does not play as nicely in browsers like the setTimeout(...)
-    // approach. So the safer, though less optimal approach is the one taken here
-    setTimeout(() => {
-        Promise
-            .resolve()
-            .then(() => {
-            onExec();
-        })
-            .catch((error) => {
-            if (onError) {
-                onError(error);
-            }
-            else {
-                console.error(error);
-            }
-        });
-    }, 0);
-}

package/build/noop.d.ts

@@ -1,8 +0,0 @@
-/**
- * A sharable identity function. Returns the input as-is with no transformation applied.
- */
-export declare function identity<T>(value: T): T;
-/**
- * A sharable noop function. As the name suggests, does nothing
- */
-export declare function noop(): void;

package/build/noop.js

@@ -1,12 +0,0 @@
-/**
- * A sharable identity function. Returns the input as-is with no transformation applied.
- */
-export function identity(value) {
-    return value;
-}
-/**
- * A sharable noop function. As the name suggests, does nothing
- */
-export function noop() {
-    // noop
-}

package/build/number/index.d.ts

@@ -1,5 +0,0 @@
-/**
- * @summary Utility methods to convert to and from `number` values
- */
-export { numberToHex } from './toHex.js';
-export { numberToU8a } from './toU8a.js';

package/build/number/index.js

@@ -1,5 +0,0 @@
-/**
- * @summary Utility methods to convert to and from `number` values
- */
-export { numberToHex } from './toHex.js';
-export { numberToU8a } from './toU8a.js';

package/build/number/toHex.d.ts

@@ -1,17 +0,0 @@
-import type { HexString } from '../types.js';
-/**
- * @name numberToHex
- * @summary Creates a hex value from a number.
- * @description
- * `null`/`undefined`/`NaN` inputs returns an empty `0x` result. `number` input values return the actual bytes value converted to a `hex`. With `bitLength` set, it converts the number to the equivalent size.
- * @example
- * <BR>
- *
- * ```javascript
- * import { numberToHex } from '@pezkuwi/util';
- *
- * numberToHex(0x1234); // => '0x1234'
- * numberToHex(0x1234, 32); // => 0x00001234
- * ```
- */
-export declare function numberToHex(value?: number | null, bitLength?: number): HexString;

package/build/number/toHex.js

@@ -1,20 +0,0 @@
-import { hexFixLength } from '../hex/fixLength.js';
-/**
- * @name numberToHex
- * @summary Creates a hex value from a number.
- * @description
- * `null`/`undefined`/`NaN` inputs returns an empty `0x` result. `number` input values return the actual bytes value converted to a `hex`. With `bitLength` set, it converts the number to the equivalent size.
- * @example
- * <BR>
- *
- * ```javascript
- * import { numberToHex } from '@pezkuwi/util';
- *
- * numberToHex(0x1234); // => '0x1234'
- * numberToHex(0x1234, 32); // => 0x00001234
- * ```
- */
-export function numberToHex(value, bitLength = -1) {
-    const hex = (!value || Number.isNaN(value) ? 0 : value).toString(16);
-    return hexFixLength(hex.length % 2 ? `0${hex}` : hex, bitLength, true);
-}

package/build/number/toU8a.d.ts

@@ -1,15 +0,0 @@
-/**
- * @name numberToU8a
- * @summary Creates a Uint8Array object from a number.
- * @description
- * `null`/`undefined`/`NaN` inputs returns an empty `Uint8Array` result. `number` input values return the actual bytes value converted to a `Uint8Array`. With `bitLength`, it converts the value to the equivalent size.
- * @example
- * <BR>
- *
- * ```javascript
- * import { numberToU8a } from '@pezkuwi/util';
- *
- * numberToU8a(0x1234); // => [0x12, 0x34]
- * ```
- */
-export declare function numberToU8a(value?: number | null, bitLength?: number): Uint8Array;

package/build/number/toU8a.js

@@ -1,19 +0,0 @@
-import { hexToU8a } from '../hex/toU8a.js';
-import { numberToHex } from './toHex.js';
-/**
- * @name numberToU8a
- * @summary Creates a Uint8Array object from a number.
- * @description
- * `null`/`undefined`/`NaN` inputs returns an empty `Uint8Array` result. `number` input values return the actual bytes value converted to a `Uint8Array`. With `bitLength`, it converts the value to the equivalent size.
- * @example
- * <BR>
- *
- * ```javascript
- * import { numberToU8a } from '@pezkuwi/util';
- *
- * numberToU8a(0x1234); // => [0x12, 0x34]
- * ```
- */
-export function numberToU8a(value, bitLength = -1) {
-    return hexToU8a(numberToHex(value, bitLength));
-}

package/build/object/clear.d.ts

@@ -1,5 +0,0 @@
-/**
- * @name objectClear
- * @summary Removes all the keys from the input object
- */
-export declare function objectClear<T>(value: Record<string, T>): Record<string, T>;

package/build/object/clear.js

@@ -1,11 +0,0 @@
-/**
- * @name objectClear
- * @summary Removes all the keys from the input object
- */
-export function objectClear(value) {
-    const keys = Object.keys(value);
-    for (let i = 0, count = keys.length; i < count; i++) {
-        delete value[keys[i]];
-    }
-    return value;
-}

package/build/object/copy.d.ts

@@ -1,5 +0,0 @@
-/**
- * @name objectCopy
- * @summary Creates a shallow clone of the input object
- */
-export declare function objectCopy<T extends object>(source: T): T;

package/build/object/copy.js

@@ -1,8 +0,0 @@
-import { objectSpread } from './spread.js';
-/**
- * @name objectCopy
- * @summary Creates a shallow clone of the input object
- */
-export function objectCopy(source) {
-    return objectSpread({}, source);
-}

package/build/object/entries.d.ts

@@ -1,9 +0,0 @@
-type Entries<T> = {
-    [K in keyof T]: [K, T[K]];
-}[keyof T][];
-/**
- * @name objectEntries
- * @summary A version of Object.entries that is typed for TS
- */
-export declare function objectEntries<T extends object>(obj: T): Entries<T>;
-export {};

package/build/object/entries.js

@@ -1,7 +0,0 @@
-/**
- * @name objectEntries
- * @summary A version of Object.entries that is typed for TS
- */
-export function objectEntries(obj) {
-    return Object.entries(obj);
-}

package/build/object/index.d.ts

@@ -1,7 +0,0 @@
-export { objectClear } from './clear.js';
-export { objectCopy } from './copy.js';
-export { objectEntries } from './entries.js';
-export { objectKeys } from './keys.js';
-export { objectProperties, objectProperty } from './property.js';
-export { objectSpread } from './spread.js';
-export { objectValues } from './values.js';

package/build/object/index.js

@@ -1,7 +0,0 @@
-export { objectClear } from './clear.js';
-export { objectCopy } from './copy.js';
-export { objectEntries } from './entries.js';
-export { objectKeys } from './keys.js';
-export { objectProperties, objectProperty } from './property.js';
-export { objectSpread } from './spread.js';
-export { objectValues } from './values.js';

package/build/object/keys.d.ts

@@ -1,5 +0,0 @@
-/**
- * @name objectKeys
- * @summary A version of Object.keys that is typed for TS
- */
-export declare function objectKeys<T extends object, K extends Extract<keyof T, string>>(value: T): K[];

package/build/object/keys.js

@@ -1,7 +0,0 @@
-/**
- * @name objectKeys
- * @summary A version of Object.keys that is typed for TS
- */
-export function objectKeys(value) {
-    return Object.keys(value);
-}

package/build/object/property.d.ts

@@ -1,10 +0,0 @@
-/**
- * @name objectProperty
- * @summary Assign a get property on the input object
- */
-export declare function objectProperty<S>(that: object, key: string, getter: (key: string, index: number, self: S) => unknown, getName?: (key: string, index: number) => string, index?: number): void;
-/**
- * @name objectProperties
- * @summary Assign get properties on the input object
- */
-export declare function objectProperties<S>(that: object, keys: string[], getter: (key: string, index: number, self: S) => unknown, getName?: (key: string, index: number) => string): void;

package/build/object/property.js

@@ -1,34 +0,0 @@
-/**
- * @name objectProperty
- * @summary Assign a get property on the input object
- */
-export function objectProperty(that, key, getter, getName, index = 0) {
-    const name = getName
-        ? getName(key, index)
-        : key;
-    // There are 3 approaches here -
-    //  - Object.prototype.hasOwnProperty.call(that, key) - this only checks the current class, i.e
-    //    will retuirn false if the property is set in the parent class
-    //  - isUndefined(...) - this may yield a false positive when the property is there, but not set.
-    //    Additionally, on pre-defined getters it may make a call
-    //  - key in that - Does not need to be combined with either of the above and checks the full chain
-    if (!(name in that)) {
-        Object.defineProperty(that, name, {
-            enumerable: true,
-            // Unlike in lazy, we always call into the upper function, i.e. this method
-            // does not cache old values (it is expected to be used for dynamic values)
-            get: function () {
-                return getter(key, index, this);
-            }
-        });
-    }
-}
-/**
- * @name objectProperties
- * @summary Assign get properties on the input object
- */
-export function objectProperties(that, keys, getter, getName) {
-    for (let i = 0, count = keys.length; i < count; i++) {
-        objectProperty(that, keys[i], getter, getName, i);
-    }
-}

package/build/object/spread.d.ts

@@ -1,6 +0,0 @@
-/**
- * @name objectSpread
- * @summary Concats all sources into the destination
- * @description Spreads object properties while maintaining object integrity
- */
-export declare function objectSpread<T extends object>(dest: object, ...sources: (object | undefined | null)[]): T;

package/build/object/spread.js

@@ -1,31 +0,0 @@
-/**
- * @name objectSpread
- * @summary Concats all sources into the destination
- * @description Spreads object properties while maintaining object integrity
- */
-export function objectSpread(dest, ...sources) {
-    const filterProps = new Set(['__proto__', 'constructor', 'prototype']);
-    for (let i = 0, count = sources.length; i < count; i++) {
-        const src = sources[i];
-        if (src) {
-            if (typeof src.entries === 'function') {
-                for (const [key, value] of src.entries()) {
-                    if (!filterProps.has(key)) {
-                        dest[key] = value;
-                    }
-                }
-            }
-            else {
-                // Create a clean copy of the source object
-                const sanitizedSrc = Object.create(null);
-                for (const [key, value] of Object.entries(src)) {
-                    if (!filterProps.has(key)) {
-                        sanitizedSrc[key] = value;
-                    }
-                }
-                Object.assign(dest, sanitizedSrc);
-            }
-        }
-    }
-    return dest;
-}

package/build/object/values.d.ts

@@ -1,5 +0,0 @@
-/**
- * @name objectValues
- * @summary A version of Object.values that is typed for TS
- */
-export declare function objectValues<T extends object>(obj: T): T[keyof T][];

package/build/object/values.js

@@ -1,7 +0,0 @@
-/**
- * @name objectValues
- * @summary A version of Object.values that is typed for TS
- */
-export function objectValues(obj) {
-    return Object.values(obj);
-}