@pezkuwi/util 14.0.1

package/src/object/property.spec.ts

@@ -0,0 +1,149 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@polkadot/dev-test/globals.d.ts" />
+
+import { perf } from '../test/index.js';
+import { objectProperties, objectProperty } from './index.js';
+
+describe('objectProperty/objectProperties', (): void => {
+  it('sets a property', (): void => {
+    const test: { a?: unknown } = {};
+
+    expect(test.a).toEqual(undefined);
+
+    objectProperty(test, 'a', () => 2);
+
+    expect(Object.prototype.hasOwnProperty.call(test, 'a')).toBe(true);
+    expect('a' in test).toEqual(true);
+    expect(test.a).toEqual(2);
+  });
+
+  it('does not override an existing property (record)', (): void => {
+    const test = { a: 1 };
+
+    expect(test.a).toEqual(1);
+
+    objectProperty(test, 'a', () => 2);
+
+    expect(test.a).toEqual(1);
+  });
+
+  it('does not override an existing property (class)', (): void => {
+    class Test {
+      b = 1;
+
+      get a () {
+        return 1 + 0;
+      }
+    }
+
+    const test = new Test();
+
+    expect(test.a).toEqual(1);
+    expect(test.b).toEqual(1);
+
+    objectProperty(test, 'a', () => 2);
+    objectProperty(test, 'b', () => 2);
+
+    expect(test.a).toEqual(1);
+    expect(test.b).toEqual(1);
+  });
+
+  it('does not override an existing property (inherited)', (): void => {
+    class Parent extends Map<string, unknown> {
+      constructor () {
+        super();
+
+        this.set('a', 1);
+      }
+
+      get a (): unknown {
+        return this.get('a');
+      }
+    }
+
+    class Child extends Parent {
+      constructor () {
+        super();
+
+        this.set('b', 1);
+      }
+
+      get b (): unknown {
+        return this.get('b');
+      }
+    }
+
+    const test = new Child() as unknown as { a: number; b: number; c?: number };
+
+    expect(test.a).toEqual(1);
+    expect(test.b).toEqual(1);
+    expect(test.c).toEqual(undefined);
+
+    objectProperties(test, ['a', 'b', 'c'], () => 2);
+
+    expect(test.a).toEqual(1);
+    expect(test.b).toEqual(1);
+    expect(test.c).toEqual(2);
+  });
+
+  it('works with this used in classes', (): void => {
+    class Test extends Map<string, unknown> {
+      constructor () {
+        super();
+
+        this.set('a', 1);
+
+        objectProperty(this, 'a', (k) => this.get(k));
+      }
+    }
+
+    const test = new Test() as unknown as { a: number };
+
+    expect(test.a).toEqual(1);
+  });
+
+  it('works with this used in classes (multiples)', (): void => {
+    class Test extends Map<string, unknown> {
+      constructor () {
+        super();
+
+        this.set('a', 1);
+        this.set('b', 2);
+
+        objectProperties(this, ['a', 'b'], (k) => this.get(k));
+      }
+    }
+
+    const test = new Test() as unknown as { a: number; b: number };
+
+    expect(test.a).toEqual(1);
+    expect(test.b).toEqual(2);
+  });
+
+  it('calls back with the key name (single)', (): void => {
+    const test: { a?: number } = {};
+    const getter = jest.fn(() => 123);
+
+    objectProperty(test, 'a', getter);
+
+    expect(getter).not.toHaveBeenCalled();
+    expect(test.a).toEqual(123);
+    expect(getter).toHaveBeenCalledWith('a', 0, expect.objectContaining({}));
+  });
+
+  it('calls back with the key name & index (numtiple)', (): void => {
+    const test: { a?: number; b?: number; c?: number } = {};
+    const getter = jest.fn(() => 123);
+
+    objectProperties(test, ['a', 'b', 'c'], getter);
+
+    expect(getter).not.toHaveBeenCalled();
+    expect(test.b).toEqual(123);
+    expect(getter).toHaveBeenCalledWith('b', 1, expect.objectContaining({}));
+  });
+
+  perf('objectProperties (obj)', 50_000, [[]], () => objectProperties({}, ['foo', 'bar', 'baz'], (k) => k));
+  perf('objectProperties (map)', 50_000, [[]], () => objectProperties(new Map(), ['foo', 'bar', 'baz'], (k) => k));
+});

package/src/object/property.ts

@@ -0,0 +1,39 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @name objectProperty
+ * @summary Assign a get property on the input object
+ */
+export function objectProperty <S> (that: object, key: string, getter: (key: string, index: number, self: S) => unknown, getName?: (key: string, index: number) => string, index = 0): void {
+  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 (): unknown {
+        return getter(key, index, this as S);
+      }
+    });
+  }
+}
+
+/**
+ * @name objectProperties
+ * @summary Assign get properties on the input object
+ */
+export function objectProperties <S> (that: object, keys: string[], getter: (key: string, index: number, self: S) => unknown, getName?: (key: string, index: number) => string): void {
+  for (let i = 0, count = keys.length; i < count; i++) {
+    objectProperty(that, keys[i], getter, getName, i);
+  }
+}

package/src/object/spread.spec.ts

@@ -0,0 +1,36 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@polkadot/dev-test/globals.d.ts" />
+
+import { perf } from '../test/index.js';
+import { objectSpread } from './index.js';
+
+describe('objectSpread', (): void => {
+  it('spreads obj sources', (): void => {
+    expect(
+      objectSpread({}, { a: 1, b: 2, c: 3 }, { d: 4, e: 5, f: 6 })
+    ).toEqual({ a: 1, b: 2, c: 3, d: 4, e: 5, f: 6 });
+  });
+
+  it('spreads map sources', (): void => {
+    expect(
+      objectSpread({}, new Map<string, number>([['a', 1], ['b', 2], ['c', 3]]), new Map<string, number>([['d', 4], ['e', 5], ['f', 6]]))
+    ).toEqual({ a: 1, b: 2, c: 3, d: 4, e: 5, f: 6 });
+  });
+
+  it('spreads an object from multiple sources', (): void => {
+    expect(
+      objectSpread({ a: 1 }, { b: 2 }, { a: 2, c: { d: 3, e: 4 } }, new Map<string, unknown>([['f', 5], ['g', 6], ['h', { i: 7, k: 8 }]]))
+    ).toEqual({ a: 2, b: 2, c: { d: 3, e: 4 }, f: 5, g: 6, h: { i: 7, k: 8 } });
+  });
+
+  it('spreads an object from multiple sources (with null & undefined)', (): void => {
+    expect(
+      objectSpread({ a: 1 }, null, { b: 2 }, undefined, { a: 2, c: { d: 3, e: 4 } })
+    ).toEqual({ a: 2, b: 2, c: { d: 3, e: 4 } });
+  });
+
+  perf('objectSpread (obj)', 350_000, [[{}, { a: 1, b: 2, c: 3 }, { d: 4, e: 5, f: 6 }]], objectSpread);
+  perf('objectSpread (map)', 350_000, [[{}, new Map<string, number>([['a', 1], ['b', 2], ['c', 3]]), new Map<string, number>([['d', 4], ['e', 5], ['f', 6]])]], objectSpread);
+});

package/src/object/spread.ts

@@ -0,0 +1,38 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @name objectSpread
+ * @summary Concats all sources into the destination
+ * @description Spreads object properties while maintaining object integrity
+ */
+export function objectSpread <T extends object> (dest: object, ...sources: (object | undefined | null)[]): T {
+  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 as Map<string, unknown>).entries === 'function') {
+        for (const [key, value] of (src as Map<string, unknown>).entries()) {
+          if (!filterProps.has(key)) {
+            (dest as Record<string, unknown>)[key] = value;
+          }
+        }
+      } else {
+        // Create a clean copy of the source object
+        const sanitizedSrc = Object.create(null) as Record<string, unknown>;
+
+        for (const [key, value] of Object.entries(src)) {
+          if (!filterProps.has(key)) {
+            sanitizedSrc[key] = value;
+          }
+        }
+
+        Object.assign(dest, sanitizedSrc);
+      }
+    }
+  }
+
+  return dest as T;
+}

package/src/object/values.spec.ts

@@ -0,0 +1,19 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@polkadot/dev-test/globals.d.ts" />
+
+import { objectValues } from './index.js';
+
+describe('objectValues', (): void => {
+  it('extracts all values', (): void => {
+    const o = { a: 1, b: 2, c: 3 };
+    const values = objectValues(o);
+
+    expect(values).toEqual([1, 2, 3]);
+
+    for (const v of values) {
+      expect(v).toBeDefined();
+    }
+  });
+});

package/src/object/values.ts

@@ -0,0 +1,10 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @name objectValues
+ * @summary A version of Object.values that is typed for TS
+ */
+export function objectValues<T extends object> (obj: T): T[keyof T][] {
+  return Object.values(obj) as T[keyof T][];
+}

package/src/packageDetect.ts

@@ -0,0 +1,13 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// Do not edit, auto-generated by @polkadot/dev
+// (packageInfo imports will be kept as-is, user-editable)
+
+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/src/packageInfo.ts

@@ -0,0 +1,6 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// Do not edit, auto-generated by @polkadot/dev
+
+export const packageInfo = { name: '@polkadot/util', path: 'auto', type: 'auto', version: '14.0.1' };

package/src/promisify.spec.ts

@@ -0,0 +1,50 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@polkadot/dev-test/globals.d.ts" />
+
+import { promisify } from './index.js';
+
+describe('promisify', (): void => {
+  it('handles functions with no parameters (resolve)', (): Promise<void> => {
+    const fn = (cb: (error: null, value: [boolean, string, number]) => void): void =>
+      cb(null, [true, 'test', 1]);
+
+    return promisify(null, fn).then((result): void => {
+      expect(result).toEqual([true, 'test', 1]);
+    });
+  });
+
+  it('handles functions with no parameters (reject)', (): Promise<void> => {
+    const fn = (cb: (error: Error, result?: boolean) => void): void =>
+      cb(new Error('test reject'));
+
+    return promisify(null, fn)
+      .then((): void => {
+        throw new Error('Received unexpected result');
+      })
+      .catch((error: Error): void => {
+        // eslint-disable-next-line jest/no-conditional-expect
+        expect(error.message).toEqual('test reject');
+      });
+  });
+
+  it('handles functions with parameters (resolve)', (): Promise<void> => {
+    const fn = (a: number, b: boolean, cb: (error: Error | null, result?: [number, boolean]) => void): void =>
+      cb(null, [a, b]);
+
+    return promisify(null, fn, 2, false).then((result: [number, boolean]): void => {
+      expect(result).toEqual([2, false]);
+    });
+  });
+
+  it('handles functions with parameters (reject)', (): Promise<void> => {
+    const fn = (a: number, b: boolean, c: string, cb: (error: Error | null, result?: [number, boolean, string]) => void): void =>
+      cb(new Error(`test reject: ${a},${b.toString()},${c}`));
+
+    return promisify(null, fn, 3, 'string', true).catch((error: Error): void => {
+      // eslint-disable-next-line jest/no-conditional-expect
+      expect(error.message).toEqual('test reject: 3,string,true');
+    });
+  });
+});

package/src/promisify.ts

@@ -0,0 +1,30 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @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!`
+ * ```
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function promisify <R = any> (self: unknown, fn: (...params: any[]) => any, ...params: any[]): Promise<R> {
+  return new Promise((resolve, reject): void => {
+    fn.apply(self, params.concat((error: Error | null, result?: R): void => {
+      if (error) {
+        reject(error);
+      } else {
+        resolve(result as R);
+      }
+    }));
+  });
+}

package/src/string/camelCase.spec.ts

@@ -0,0 +1,119 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@polkadot/dev-test/globals.d.ts" />
+
+import { getRandomValues } from '@pezkuwi/x-randomvalues';
+
+import { arrayRange } from '../array/index.js';
+import { perf } from '../test/index.js';
+import { stringCamelCase, stringUpperFirst } from './index.js';
+
+const SEPS = [' ', '_', '-', '.', ','];
+const words = 'bring|brisk|broccoli|broken|bronze|broom|brother|brown|brush|bubble|buddy|budget|buffalo|build|bulb|bulk|bullet|bundle|bunker|burden'.split('|');
+
+function randomAsNumber (): number {
+  const rand = getRandomValues(new Uint8Array(4));
+
+  return rand.reduce((v, t) => (v * t) + v, 0);
+}
+
+const randomWords = arrayRange(256).map((): [string] => {
+  let result = '';
+
+  for (let i = 0; i < 6; i++) {
+    let word = words[randomAsNumber() % words.length];
+
+    if (randomAsNumber() % 2) {
+      word = stringUpperFirst(word);
+    }
+
+    if (i === 0) {
+      result = word;
+    } else {
+      result += `${SEPS[randomAsNumber() % SEPS.length]}${word}`;
+    }
+  }
+
+  return [result];
+});
+
+describe('stringCamelCase', (): void => {
+  it('works correctly', (): void => {
+    expect(
+      stringCamelCase('Snake_case-...SomethingSomething    spaced')
+    ).toBe('snakeCaseSomethingSomethingSpaced');
+  });
+
+  it('works correctly for String (class', (): void => {
+    expect(
+      stringCamelCase(String('Foo_bar-baz---test-_ spaced....Extra'))
+    ).toBe('fooBarBazTestSpacedExtra');
+  });
+
+  it('adjusts all-uppercase', (): void => {
+    expect(
+      stringCamelCase('DEDUP_KEY_PREFIX')
+    ).toEqual('dedupKeyPrefix');
+    expect(
+      stringCamelCase(String('DEDUP_KEY_PREFIX'))
+    ).toEqual('dedupKeyPrefix');
+    expect(
+      stringCamelCase('SOMETHING')
+    ).toEqual('something');
+    expect(
+      stringCamelCase('NMap')
+    ).toEqual('nMap');
+  });
+
+  it('adjusts all-uppercase + digits', (): void => {
+    expect(
+      stringCamelCase('SS58 PreFIX')
+    ).toEqual('ss58PreFIX');
+    expect(
+      stringCamelCase('SS58Prefix')
+    ).toEqual('ss58Prefix');
+    expect(
+      stringCamelCase('UUID64')
+    ).toEqual('uuid64');
+    expect(
+      stringCamelCase('BLAKE2B')
+    ).toEqual('blake2b');
+    expect(
+      stringCamelCase('NFTOrder')
+    ).toEqual('nftOrder');
+    expect(
+      stringCamelCase('EVM')
+    ).toEqual('evm');
+    expect(
+      stringCamelCase('A')
+    ).toEqual('a');
+    expect(
+      stringCamelCase('A1')
+    ).toEqual('a1');
+    expect(
+      stringCamelCase('A1b')
+    ).toEqual('a1b');
+    expect(
+      stringCamelCase('A1B')
+    ).toEqual('a1b');
+    expect(
+      stringCamelCase('RawVRFOutput')
+    ).toEqual('rawVRFOutput');
+  });
+
+  it('adjusts with leading _', (): void => {
+    expect(
+      stringCamelCase('_reserved')
+    ).toEqual('reserved');
+  });
+
+  it('adjusts with minimal chars per part', (): void => {
+    expect(
+      stringCamelCase('_a_b_c_def')
+    ).toEqual('aBCDef');
+  });
+
+  perf('stringCamelCase (random)', 100_000, randomWords, stringCamelCase);
+  perf('stringCamelCase (NFTOrder)', 100_000, [['NFTOrder']], stringCamelCase);
+});

package/src/string/camelCase.ts

@@ -0,0 +1,79 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { AnyString } from '../types.js';
+
+export const CC_TO_UP = new Array<string>(256);
+export const CC_TO_LO = new Array<string>(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: string): string {
+  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: (w: string, i: number) => string): (value: AnyString) => string {
+  return (value: AnyString): string => {
+    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) =>
+  // lowercase for first letter/first word, else uppercase first, rest unchanged
+  (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) =>
+  // uppercase the first character, leave the rest unchanged
+  CC_TO_UP[w.charCodeAt(0)] + w.slice(1)
+);

package/src/string/index.ts

@@ -0,0 +1,12 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @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/src/string/lowerFirst.spec.ts

@@ -0,0 +1,41 @@
+// Copyright 2017-2025 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@polkadot/dev-test/globals.d.ts" />
+
+import { perf } from '../test/index.js';
+import { stringLowerFirst } from './index.js';
+
+describe('stringLowerFirst', (): void => {
+  it("lowers the first letter if it's a capital letter", (): void => {
+    expect(
+      stringLowerFirst('ABC')
+    ).toBe('aBC');
+  });
+
+  it("lowers the first letter if it's a capital letter (String)", (): void => {
+    expect(
+      stringLowerFirst(String('ABC'))
+    ).toBe('aBC');
+  });
+
+  it("lowers the first letter if it's a lowercase letter", (): void => {
+    expect(
+      stringLowerFirst('abc')
+    ).toBe('abc');
+  });
+
+  it('returns undefined as empty', (): void => {
+    expect(
+      stringLowerFirst()
+    ).toBe('');
+  });
+
+  it('returns null as empty', (): void => {
+    expect(
+      stringLowerFirst(null)
+    ).toBe('');
+  });
+
+  perf('stringLowerFirst', 1_000_000, [['HelloWorldSomething']], stringLowerFirst);
+});