@pezkuwi/util 14.0.10 → 14.0.11

package/cjs/is/observable.d.ts

@@ -0,0 +1,16 @@
+import type { Observable } from '../types.js';
+/**
+ * @name isBObservable
+ * @summary Tests for a `Observable` object instance.
+ * @description
+ * Checks to see if the input object is an instance of `BN` (bn.js).
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isObservable } from '@pezkuwi/util';
+ *
+ * console.log('isObservable', isObservable(...));
+ * ```
+ */
+export declare const isObservable: (value?: unknown) => value is Observable;

package/cjs/is/observable.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObservable = void 0;
+const helpers_js_1 = require("./helpers.js");
+/**
+ * @name isBObservable
+ * @summary Tests for a `Observable` object instance.
+ * @description
+ * Checks to see if the input object is an instance of `BN` (bn.js).
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isObservable } from '@pezkuwi/util';
+ *
+ * console.log('isObservable', isObservable(...));
+ * ```
+ */
+exports.isObservable = (0, helpers_js_1.isOn)('next');

package/cjs/is/promise.d.ts

@@ -0,0 +1 @@
+export declare const isPromise: (value?: unknown) => value is Promise<unknown>;

package/cjs/is/promise.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPromise = void 0;
+const helpers_js_1 = require("./helpers.js");
+exports.isPromise = (0, helpers_js_1.isOnObject)('catch', 'then');

package/cjs/is/riscv.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @name isRiscV
+ * @summary Tests if the input has a RISC-V header
+ * @description
+ * Checks to see if the input Uint8Array contains a valid RISC-V header
+ */
+export declare function isRiscV(bytes: unknown): bytes is Uint8Array;

package/cjs/is/riscv.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRiscV = isRiscV;
+const eq_js_1 = require("../u8a/eq.js");
+const u8a_js_1 = require("./u8a.js");
+const ELF_MAGIC = new Uint8Array([0x7f, 0x45, 0x4c, 0x46]); // ELF magic bytes: 0x7f, 'E', 'L', 'F'
+const PVM_MAGIC = new Uint8Array([0x50, 0x56, 0x4d, 0x00]); // 'P', 'V', 'M', 0x00
+/**
+ * @name isRiscV
+ * @summary Tests if the input has a RISC-V header
+ * @description
+ * Checks to see if the input Uint8Array contains a valid RISC-V header
+ */
+function isRiscV(bytes) {
+    if ((0, u8a_js_1.isU8a)(bytes)) {
+        const start = bytes.subarray(0, 4);
+        return (0, eq_js_1.u8aEq)(start, PVM_MAGIC) || (0, eq_js_1.u8aEq)(start, ELF_MAGIC);
+    }
+    return false;
+}

package/cjs/is/string.d.ts

@@ -0,0 +1,16 @@
+import type { AnyString } from '../types.js';
+/**
+ * @name isString
+ * @summary Tests for a string.
+ * @description
+ * Checks to see if the input value is a JavaScript string.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isString } from '@pezkuwi/util';
+ *
+ * console.log('isString', isString('test')); // => true
+ * ```
+ */
+export declare function isString(value: unknown): value is AnyString;

package/cjs/is/string.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isString = isString;
+/**
+ * @name isString
+ * @summary Tests for a string.
+ * @description
+ * Checks to see if the input value is a JavaScript string.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isString } from '@pezkuwi/util';
+ *
+ * console.log('isString', isString('test')); // => true
+ * ```
+ */
+function isString(value) {
+    return typeof value === 'string' || value instanceof String;
+}

package/cjs/is/testChain.d.ts

@@ -0,0 +1 @@
+export declare function isTestChain(chain?: string | null): boolean;

package/cjs/is/testChain.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTestChain = isTestChain;
+const REGEX_DEV = /(Development|Local Testnet)$/;
+function isTestChain(chain) {
+    if (!chain) {
+        return false;
+    }
+    return !!REGEX_DEV.test(chain.toString());
+}

package/cjs/is/toBigInt.d.ts

@@ -0,0 +1,2 @@
+import type { ToBigInt } from '../types.js';
+export declare const isToBigInt: (value?: unknown) => value is ToBigInt;

package/cjs/is/toBigInt.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isToBigInt = void 0;
+const helpers_js_1 = require("./helpers.js");
+exports.isToBigInt = (0, helpers_js_1.isOn)('toBigInt');

package/cjs/is/toBn.d.ts

@@ -0,0 +1,2 @@
+import type { ToBn } from '../types.js';
+export declare const isToBn: (value?: unknown) => value is ToBn;

package/cjs/is/toBn.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isToBn = void 0;
+const helpers_js_1 = require("./helpers.js");
+exports.isToBn = (0, helpers_js_1.isOn)('toBn');

package/cjs/is/u8a.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @name isU8a
+ * @summary Tests for a `Uint8Array` object instance.
+ * @description
+ * Checks to see if the input object is an instance of `Uint8Array`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isUint8Array } from '@pezkuwi/util';
+ *
+ * console.log('isU8a', isU8a([])); // => false
+ * ```
+ */
+export declare function isU8a(value?: unknown): value is Uint8Array;

package/cjs/is/u8a.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isU8a = isU8a;
+/**
+ * @name isU8a
+ * @summary Tests for a `Uint8Array` object instance.
+ * @description
+ * Checks to see if the input object is an instance of `Uint8Array`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isUint8Array } from '@pezkuwi/util';
+ *
+ * console.log('isU8a', isU8a([])); // => false
+ * ```
+ */
+function isU8a(value) {
+    // here we defer the instanceof check which is actually slightly
+    // slower than just checking the constrctor (direct instances)
+    return (((value && value.constructor) === Uint8Array) ||
+        value instanceof Uint8Array);
+}

package/cjs/is/undefined.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @name isUndefined
+ * @summary Tests for a `undefined` values.
+ * @description
+ * Checks to see if the input value is `undefined`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isUndefined } from '@pezkuwi/util';
+ *
+ * console.log('isUndefined', isUndefined(void(0))); // => true
+ * ```
+ */
+export declare function isUndefined(value?: unknown): value is undefined;

package/cjs/is/undefined.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isUndefined = isUndefined;
+/**
+ * @name isUndefined
+ * @summary Tests for a `undefined` values.
+ * @description
+ * Checks to see if the input value is `undefined`.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { isUndefined } from '@pezkuwi/util';
+ *
+ * console.log('isUndefined', isUndefined(void(0))); // => true
+ * ```
+ */
+function isUndefined(value) {
+    return value === undefined;
+}

package/cjs/is/utf8.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @name isUtf8
+ * @summary Tests if the input is valid Utf8
+ * @description
+ * Checks to see if the input string or Uint8Array is valid Utf8
+ */
+export declare function isUtf8(value?: number[] | Uint8Array | string | null): boolean;

package/cjs/is/utf8.js

@@ -0,0 +1,200 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isUtf8 = isUtf8;
+const toU8a_js_1 = require("../u8a/toU8a.js");
+const string_js_1 = require("./string.js");
+/**
+ * @name isUtf8
+ * @summary Tests if the input is valid Utf8
+ * @description
+ * Checks to see if the input string or Uint8Array is valid Utf8
+ */
+function isUtf8(value) {
+    if (!value) {
+        return (0, string_js_1.isString)(value);
+    }
+    const u8a = (0, toU8a_js_1.u8aToU8a)(value);
+    const len = u8a.length;
+    let i = 0;
+    while (i < len) {
+        if (u8a[i] <= 0x7F) /* 00..7F */ {
+            i += 1;
+        }
+        else if (u8a[i] >= 0xC2 && u8a[i] <= 0xDF) /* C2..DF 80..BF */ {
+            if (i + 1 < len) /* Expect a 2nd byte */ {
+                if (u8a[i + 1] < 0x80 || u8a[i + 1] > 0xBF) {
+                    // *message = "After a first byte between C2 and DF, expecting a 2nd byte between 80 and BF";
+                    // *faulty_bytes = 2;
+                    return false;
+                }
+            }
+            else {
+                // *message = "After a first byte between C2 and DF, expecting a 2nd byte.";
+                // *faulty_bytes = 1;
+                return false;
+            }
+            i += 2;
+        }
+        else if (u8a[i] === 0xE0) /* E0 A0..BF 80..BF */ {
+            if (i + 2 < len) /* Expect a 2nd and 3rd byte */ {
+                if (u8a[i + 1] < 0xA0 || u8a[i + 1] > 0xBF) {
+                    // *message = "After a first byte of E0, expecting a 2nd byte between A0 and BF.";
+                    // *faulty_bytes = 2;
+                    return false;
+                }
+                if (u8a[i + 2] < 0x80 || u8a[i + 2] > 0xBF) {
+                    // *message = "After a first byte of E0, expecting a 3nd byte between 80 and BF.";
+                    // *faulty_bytes = 3;
+                    return false;
+                }
+            }
+            else {
+                // *message = "After a first byte of E0, expecting two following bytes.";
+                // *faulty_bytes = 1;
+                return false;
+            }
+            i += 3;
+        }
+        else if (u8a[i] >= 0xE1 && u8a[i] <= 0xEC) /* E1..EC 80..BF 80..BF */ {
+            if (i + 2 < len) /* Expect a 2nd and 3rd byte */ {
+                if (u8a[i + 1] < 0x80 || u8a[i + 1] > 0xBF) {
+                    // *message = "After a first byte between E1 and EC, expecting the 2nd byte between 80 and BF.";
+                    // *faulty_bytes = 2;
+                    return false;
+                }
+                if (u8a[i + 2] < 0x80 || u8a[i + 2] > 0xBF) {
+                    // *message = "After a first byte between E1 and EC, expecting the 3rd byte between 80 and BF.";
+                    // *faulty_bytes = 3;
+                    return false;
+                }
+            }
+            else {
+                // *message = "After a first byte between E1 and EC, expecting two following bytes.";
+                // *faulty_bytes = 1;
+                return false;
+            }
+            i += 3;
+        }
+        else if (u8a[i] === 0xED) /* ED 80..9F 80..BF */ {
+            if (i + 2 < len) /* Expect a 2nd and 3rd byte */ {
+                if (u8a[i + 1] < 0x80 || u8a[i + 1] > 0x9F) {
+                    // *message = "After a first byte of ED, expecting 2nd byte between 80 and 9F.";
+                    // *faulty_bytes = 2;
+                    return false;
+                }
+                if (u8a[i + 2] < 0x80 || u8a[i + 2] > 0xBF) {
+                    // *message = "After a first byte of ED, expecting 3rd byte between 80 and BF.";
+                    // *faulty_bytes = 3;
+                    return false;
+                }
+            }
+            else {
+                // *message = "After a first byte of ED, expecting two following bytes.";
+                // *faulty_bytes = 1;
+                return false;
+            }
+            i += 3;
+        }
+        else if (u8a[i] >= 0xEE && u8a[i] <= 0xEF) /* EE..EF 80..BF 80..BF */ {
+            if (i + 2 < len) /* Expect a 2nd and 3rd byte */ {
+                if (u8a[i + 1] < 0x80 || u8a[i + 1] > 0xBF) {
+                    // *message = "After a first byte between EE and EF, expecting 2nd byte between 80 and BF.";
+                    // *faulty_bytes = 2;
+                    return false;
+                }
+                if (u8a[i + 2] < 0x80 || u8a[i + 2] > 0xBF) {
+                    // *message = "After a first byte between EE and EF, expecting 3rd byte between 80 and BF.";
+                    // *faulty_bytes = 3;
+                    return false;
+                }
+            }
+            else {
+                // *message = "After a first byte between EE and EF, two following bytes.";
+                // *faulty_bytes = 1;
+                return false;
+            }
+            i += 3;
+        }
+        else if (u8a[i] === 0xF0) /* F0 90..BF 80..BF 80..BF */ {
+            if (i + 3 < len) /* Expect a 2nd, 3rd 3th byte */ {
+                if (u8a[i + 1] < 0x90 || u8a[i + 1] > 0xBF) {
+                    // *message = "After a first byte of F0, expecting 2nd byte between 90 and BF.";
+                    // *faulty_bytes = 2;
+                    return false;
+                }
+                if (u8a[i + 2] < 0x80 || u8a[i + 2] > 0xBF) {
+                    // *message = "After a first byte of F0, expecting 3rd byte between 80 and BF.";
+                    // *faulty_bytes = 3;
+                    return false;
+                }
+                if (u8a[i + 3] < 0x80 || u8a[i + 3] > 0xBF) {
+                    // *message = "After a first byte of F0, expecting 4th byte between 80 and BF.";
+                    // *faulty_bytes = 4;
+                    return false;
+                }
+            }
+            else {
+                // *message = "After a first byte of F0, expecting three following bytes.";
+                // *faulty_bytes = 1;
+                return false;
+            }
+            i += 4;
+        }
+        else if (u8a[i] >= 0xF1 && u8a[i] <= 0xF3) /* F1..F3 80..BF 80..BF 80..BF */ {
+            if (i + 3 < len) /* Expect a 2nd, 3rd 3th byte */ {
+                if (u8a[i + 1] < 0x80 || u8a[i + 1] > 0xBF) {
+                    // *message = "After a first byte of F1, F2, or F3, expecting a 2nd byte between 80 and BF.";
+                    // *faulty_bytes = 2;
+                    return false;
+                }
+                if (u8a[i + 2] < 0x80 || u8a[i + 2] > 0xBF) {
+                    // *message = "After a first byte of F1, F2, or F3, expecting a 3rd byte between 80 and BF.";
+                    // *faulty_bytes = 3;
+                    return false;
+                }
+                if (u8a[i + 3] < 0x80 || u8a[i + 3] > 0xBF) {
+                    // *message = "After a first byte of F1, F2, or F3, expecting a 4th byte between 80 and BF.";
+                    // *faulty_bytes = 4;
+                    return false;
+                }
+            }
+            else {
+                // *message = "After a first byte of F1, F2, or F3, expecting three following bytes.";
+                // *faulty_bytes = 1;
+                return false;
+            }
+            i += 4;
+        }
+        else if (u8a[i] === 0xF4) /* F4 80..8F 80..BF 80..BF */ {
+            if (i + 3 < len) /* Expect a 2nd, 3rd 3th byte */ {
+                if (u8a[i + 1] < 0x80 || u8a[i + 1] > 0x8F) {
+                    // *message = "After a first byte of F4, expecting 2nd byte between 80 and 8F.";
+                    // *faulty_bytes = 2;
+                    return false;
+                }
+                if (u8a[i + 2] < 0x80 || u8a[i + 2] > 0xBF) {
+                    // *message = "After a first byte of F4, expecting 3rd byte between 80 and BF.";
+                    // *faulty_bytes = 3;
+                    return false;
+                }
+                if (u8a[i + 3] < 0x80 || u8a[i + 3] > 0xBF) {
+                    // *message = "After a first byte of F4, expecting 4th byte between 80 and BF.";
+                    // *faulty_bytes = 4;
+                    return false;
+                }
+            }
+            else {
+                // *message = "After a first byte of F4, expecting three following bytes.";
+                // *faulty_bytes = 1;
+                return false;
+            }
+            i += 4;
+        }
+        else {
+            // *message = "Expecting bytes in the following ranges: 00..7F C2..F4.";
+            // *faulty_bytes = 1;
+            return false;
+        }
+    }
+    return true;
+}

package/cjs/is/wasm.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @name isWasm
+ * @summary Tests if the input has a WASM header
+ * @description
+ * Checks to see if the input Uint8Array contains a valid WASM header
+ */
+export declare function isWasm(value?: unknown): value is Uint8Array;

package/cjs/is/wasm.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWasm = isWasm;
+const eq_js_1 = require("../u8a/eq.js");
+const u8a_js_1 = require("./u8a.js");
+const WASM_MAGIC = new Uint8Array([0, 97, 115, 109]); // \0asm
+/**
+ * @name isWasm
+ * @summary Tests if the input has a WASM header
+ * @description
+ * Checks to see if the input Uint8Array contains a valid WASM header
+ */
+function isWasm(value) {
+    return (0, u8a_js_1.isU8a)(value) && (0, eq_js_1.u8aEq)(value.subarray(0, 4), WASM_MAGIC);
+}

package/cjs/lazy.d.ts

@@ -0,0 +1,14 @@
+type AnyFn = (...args: unknown[]) => unknown;
+/**
+ * @name lazyMethod
+ * @description
+ * Creates a lazy, on-demand getter for the specific value. Upon get the value will be evaluated.
+ */
+export declare function lazyMethod<T, K, S>(result: Record<string, T> | AnyFn, item: K, creator: (item: K, index: number, self: S) => T, getName?: (item: K, index: number) => string, index?: number): void;
+/**
+ * @name lazyMethods
+ * @description
+ * Creates lazy, on-demand getters for the specific values.
+ */
+export declare function lazyMethods<T, K, S>(result: Record<string, T>, items: readonly K[], creator: (item: K, index: number, self: S) => T, getName?: (item: K, index: number) => string): Record<string, T>;
+export {};

package/cjs/lazy.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lazyMethod = lazyMethod;
+exports.lazyMethods = lazyMethods;
+/**
+ * @name lazyMethod
+ * @description
+ * Creates a lazy, on-demand getter for the specific value. Upon get the value will be evaluated.
+ */
+function lazyMethod(result, item, creator, getName, index = 0) {
+    const name = getName
+        ? getName(item, index)
+        : item.toString();
+    let value;
+    Object.defineProperty(result, name, {
+        // This allows for re-configuration with the embedded defineProperty below
+        // and ensures that on tested browsers and Node, it _will_ be redefined
+        // and thus short-circuited for future access
+        configurable: true,
+        enumerable: true,
+        // Use a function here, we don't want to capture the outer this, i.e.
+        // don't use arrow functions in this context since we have a this inside
+        get: function () {
+            // This check should _always_ be false and unneeded, since we override
+            // with a value below ... however we ensure we are quire vigilant against
+            // all environment failures, so we are rather be safe than sorry
+            if (value === undefined) {
+                value = creator(item, index, this);
+                try {
+                    // re-define the property as a value, next time around this
+                    // getter will only return the computed value
+                    Object.defineProperty(this, name, { value });
+                }
+                catch {
+                    // ignore any errors, since this _should_ not happen due to
+                    // the "configurable" property above. But if it ever does
+                    // from here-on we will be the cached value the next time
+                    // around (with a very slight dip in performance)
+                }
+            }
+            return value;
+        }
+    });
+}
+/**
+ * @name lazyMethods
+ * @description
+ * Creates lazy, on-demand getters for the specific values.
+ */
+function lazyMethods(result, items, creator, getName) {
+    for (let i = 0, count = items.length; i < count; i++) {
+        lazyMethod(result, items[i], creator, getName, i);
+    }
+    return result;
+}

package/cjs/logger.d.ts

@@ -0,0 +1,17 @@
+import type { Logger } from './types.js';
+export declare function loggerFormat(value: unknown): unknown;
+/**
+ * @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 declare function logger(origin: string): Logger;