@pezkuwi/util 14.0.22 → 14.0.23

package/build/cjs/object/copy.d.ts

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

package/build/cjs/object/copy.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectCopy = objectCopy;
+const spread_js_1 = require("./spread.js");
+/**
+ * @name objectCopy
+ * @summary Creates a shallow clone of the input object
+ */
+function objectCopy(source) {
+    return (0, spread_js_1.objectSpread)({}, source);
+}

package/build/cjs/object/entries.d.ts

@@ -0,0 +1,9 @@
+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/cjs/object/entries.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectEntries = objectEntries;
+/**
+ * @name objectEntries
+ * @summary A version of Object.entries that is typed for TS
+ */
+function objectEntries(obj) {
+    return Object.entries(obj);
+}

package/build/cjs/object/index.d.ts

@@ -0,0 +1,7 @@
+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/cjs/object/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectValues = exports.objectSpread = exports.objectProperty = exports.objectProperties = exports.objectKeys = exports.objectEntries = exports.objectCopy = exports.objectClear = void 0;
+var clear_js_1 = require("./clear.js");
+Object.defineProperty(exports, "objectClear", { enumerable: true, get: function () { return clear_js_1.objectClear; } });
+var copy_js_1 = require("./copy.js");
+Object.defineProperty(exports, "objectCopy", { enumerable: true, get: function () { return copy_js_1.objectCopy; } });
+var entries_js_1 = require("./entries.js");
+Object.defineProperty(exports, "objectEntries", { enumerable: true, get: function () { return entries_js_1.objectEntries; } });
+var keys_js_1 = require("./keys.js");
+Object.defineProperty(exports, "objectKeys", { enumerable: true, get: function () { return keys_js_1.objectKeys; } });
+var property_js_1 = require("./property.js");
+Object.defineProperty(exports, "objectProperties", { enumerable: true, get: function () { return property_js_1.objectProperties; } });
+Object.defineProperty(exports, "objectProperty", { enumerable: true, get: function () { return property_js_1.objectProperty; } });
+var spread_js_1 = require("./spread.js");
+Object.defineProperty(exports, "objectSpread", { enumerable: true, get: function () { return spread_js_1.objectSpread; } });
+var values_js_1 = require("./values.js");
+Object.defineProperty(exports, "objectValues", { enumerable: true, get: function () { return values_js_1.objectValues; } });

package/build/cjs/object/keys.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @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/cjs/object/keys.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectKeys = objectKeys;
+/**
+ * @name objectKeys
+ * @summary A version of Object.keys that is typed for TS
+ */
+function objectKeys(value) {
+    return Object.keys(value);
+}

package/build/cjs/object/property.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @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/cjs/object/property.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectProperty = objectProperty;
+exports.objectProperties = objectProperties;
+/**
+ * @name objectProperty
+ * @summary Assign a get property on the input object
+ */
+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
+ */
+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/cjs/object/spread.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @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/cjs/object/spread.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectSpread = objectSpread;
+/**
+ * @name objectSpread
+ * @summary Concats all sources into the destination
+ * @description Spreads object properties while maintaining object integrity
+ */
+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/cjs/object/values.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @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/cjs/object/values.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectValues = objectValues;
+/**
+ * @name objectValues
+ * @summary A version of Object.values that is typed for TS
+ */
+function objectValues(obj) {
+    return Object.values(obj);
+}

package/build/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/build/cjs/packageDetect.d.ts

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

package/build/cjs/packageDetect.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const x_textdecoder_1 = require("@pezkuwi/x-textdecoder");
+const x_textencoder_1 = require("@pezkuwi/x-textencoder");
+const detectPackage_js_1 = require("./detectPackage.js");
+const packageInfo_js_1 = require("./packageInfo.js");
+(0, detectPackage_js_1.detectPackage)(packageInfo_js_1.packageInfo, null, [x_textdecoder_1.packageInfo, x_textencoder_1.packageInfo]);

package/build/cjs/packageInfo.d.ts

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

package/build/cjs/packageInfo.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.packageInfo = void 0;
+exports.packageInfo = { name: '@pezkuwi/util', path: typeof __dirname === 'string' ? __dirname : 'auto', type: 'cjs', version: '14.0.23' };

package/build/cjs/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/cjs/promisify.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promisify = promisify;
+/**
+ * @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!`
+ * ```
+ */
+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/cjs/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/cjs/string/camelCase.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringPascalCase = exports.stringCamelCase = exports.CC_TO_LO = exports.CC_TO_UP = void 0;
+exports.CC_TO_UP = new Array(256);
+exports.CC_TO_LO = new Array(256);
+for (let i = 0, count = exports.CC_TO_UP.length; i < count; i++) {
+    exports.CC_TO_LO[i] = String.fromCharCode(i).toLowerCase();
+    exports.CC_TO_UP[i] = String.fromCharCode(i).toUpperCase();
+}
+/** @internal */
+function formatAllCaps(w) {
+    return w.slice(0, w.length - 1).toLowerCase() + exports.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
+ */
+exports.stringCamelCase = converter((w, i) => 
+(i ? exports.CC_TO_UP[w.charCodeAt(0)] : exports.CC_TO_LO[w.charCodeAt(0)]) + w.slice(1));
+/**
+ * @name stringPascalCase
+ * @summary Convert a dash/dot/underscore/space separated Ascii string/String to PascalCase
+ */
+exports.stringPascalCase = converter((w) => 
+exports.CC_TO_UP[w.charCodeAt(0)] + w.slice(1));

package/build/cjs/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/cjs/string/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringToU8a = exports.stringToHex = exports.stringShorten = exports.stringUpperFirst = exports.stringLowerFirst = exports.stringPascalCase = exports.stringCamelCase = void 0;
+/**
+ * @summary Utility methods to convert to work with `string` values
+ */
+var camelCase_js_1 = require("./camelCase.js");
+Object.defineProperty(exports, "stringCamelCase", { enumerable: true, get: function () { return camelCase_js_1.stringCamelCase; } });
+Object.defineProperty(exports, "stringPascalCase", { enumerable: true, get: function () { return camelCase_js_1.stringPascalCase; } });
+var lowerFirst_js_1 = require("./lowerFirst.js");
+Object.defineProperty(exports, "stringLowerFirst", { enumerable: true, get: function () { return lowerFirst_js_1.stringLowerFirst; } });
+Object.defineProperty(exports, "stringUpperFirst", { enumerable: true, get: function () { return lowerFirst_js_1.stringUpperFirst; } });
+var shorten_js_1 = require("./shorten.js");
+Object.defineProperty(exports, "stringShorten", { enumerable: true, get: function () { return shorten_js_1.stringShorten; } });
+var toHex_js_1 = require("./toHex.js");
+Object.defineProperty(exports, "stringToHex", { enumerable: true, get: function () { return toHex_js_1.stringToHex; } });
+var toU8a_js_1 = require("./toU8a.js");
+Object.defineProperty(exports, "stringToU8a", { enumerable: true, get: function () { return toU8a_js_1.stringToU8a; } });

package/build/cjs/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/cjs/string/lowerFirst.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringUpperFirst = exports.stringLowerFirst = void 0;
+const camelCase_js_1 = require("./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'
+ * ```
+ */
+exports.stringLowerFirst = converter(camelCase_js_1.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'
+ * ```
+ */
+exports.stringUpperFirst = converter(camelCase_js_1.CC_TO_UP);

package/build/cjs/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/cjs/string/shorten.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringShorten = stringShorten;
+/**
+ * @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
+ * ```
+ */
+function stringShorten(value, prefixLength = 6) {
+    return value.length <= 2 + 2 * prefixLength
+        ? value.toString()
+        : `${value.substring(0, prefixLength)}…${value.slice(-prefixLength)}`;
+}

package/build/cjs/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/cjs/string/toHex.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringToHex = stringToHex;
+const toHex_js_1 = require("../u8a/toHex.js");
+const toU8a_js_1 = require("./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
+ * ```
+ */
+function stringToHex(value) {
+    return (0, toHex_js_1.u8aToHex)((0, toU8a_js_1.stringToU8a)(value));
+}

package/build/cjs/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/cjs/string/toU8a.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringToU8a = stringToU8a;
+const x_textencoder_1 = require("@pezkuwi/x-textencoder");
+const encoder = new x_textencoder_1.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]
+ * ```
+ */
+function stringToU8a(value) {
+    return value
+        ? encoder.encode(value.toString())
+        : new Uint8Array();
+}

package/build/cjs/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/cjs/stringify.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringify = stringify;
+const bigInt_js_1 = require("./is/bigInt.js");
+/** @internal */
+function replacer(_, v) {
+    return (0, bigInt_js_1.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.
+ */
+function stringify(value, space) {
+    return JSON.stringify(value, replacer, space);
+}