@dxos/util 0.6.13 → 0.6.14-main.1366248

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@dxos/util",
-  "version": "0.6.13",
+  "version": "0.6.14-main.1366248",
   "description": "Temporary bucket for misc functions, which should graduate into separate packages.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
   "license": "MIT",
   "author": "DXOS.org",
+  "sideEffects": true,
   "exports": {
     ".": {
       "browser": "./dist/lib/browser/index.mjs",
       "node": {
-        "default": "./dist/lib/node/index.cjs"
+        "require": "./dist/lib/node/index.cjs",
+        "default": "./dist/lib/node-esm/index.mjs"
       },
       "types": "./dist/types/src/index.d.ts"
     }
@@ -24,15 +26,13 @@
     "src"
   ],
   "dependencies": {
-    "@effect/schema": "^0.67.16",
-    "xcase": "^2.0.1",
-    "@dxos/debug": "0.6.13",
-    "@dxos/invariant": "0.6.13",
-    "@dxos/node-std": "0.6.13",
-    "@dxos/keys": "0.6.13"
+    "@dxos/debug": "0.6.14-main.1366248",
+    "@dxos/invariant": "0.6.14-main.1366248",
+    "@dxos/keys": "0.6.14-main.1366248",
+    "@dxos/node-std": "0.6.14-main.1366248"
   },
   "devDependencies": {
-    "@dxos/crypto": "0.6.13"
+    "@dxos/crypto": "0.6.14-main.1366248"
   },
   "publishConfig": {
     "access": "public"

package/src/array-to-hex.ts

@@ -0,0 +1,23 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+// https://stackoverflow.com/a/59416332
+
+// Precomputed octet list.
+const byteToHex: string[] = [];
+for (let n = 0; n <= 0xff; ++n) {
+  const hexOctet = n.toString(16).padStart(2, '0');
+  byteToHex.push(hexOctet);
+}
+
+export const arrayToHex = (buf: ArrayBuffer) => {
+  const buff = new Uint8Array(buf);
+  const hexOctets = []; // new Array(buff.length) is even faster (preallocates necessary array size), then use hexOctets[i] instead of .push()
+
+  for (let i = 0; i < buff.length; ++i) {
+    hexOctets.push(byteToHex[buff[i]]);
+  }
+
+  return hexOctets.join('');
+};

package/src/array.test.ts

@@ -2,8 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { expect } from 'chai';
-import { describe, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 
 import { diff, intersection, distinctBy } from './array';
 

package/src/bitfield.test.ts

@@ -2,8 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import { expect } from 'chai';
-import { describe, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 
 import { BitField } from './bitfield';
 

package/src/callback.test.ts

@@ -2,8 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-import { expect } from 'chai';
-import { describe, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 
 import { createSetDispatch } from './callback';
 

package/src/case.test.ts

@@ -0,0 +1,14 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { describe, expect, test } from 'vitest';
+
+import { decamelize, hyphenize } from './case';
+
+describe('util', () => {
+  test('decamelize', () => {
+    expect(decamelize('fooBar')).to.eq('foo_bar');
+    expect(hyphenize('fooBar')).to.eq('foo-bar');
+  });
+});

package/src/case.ts

@@ -0,0 +1,45 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+const LOW_DASH = '_'.codePointAt(0)!;
+const HI_DASH = '-'.codePointAt(0)!;
+const SMALL_A = 'a'.codePointAt(0)!;
+const CAPITAL_A = 'A'.codePointAt(0)!;
+const SMALL_Z = 'z'.codePointAt(0)!;
+const CAPITAL_Z = 'Z'.codePointAt(0)!;
+
+const isLower = (char: number) => char >= SMALL_A && char <= SMALL_Z;
+
+const isUpper = (char: number) => char >= CAPITAL_A && char <= CAPITAL_Z;
+
+const toLower = (char: number) => char + 0x20;
+
+/**
+ * NOTE: Removed `xcase` due to CF dependency conflicts.
+ */
+const changeCase = (str: string, delim: number) => {
+  const firstChar = str.charCodeAt(0);
+  if (!isLower(firstChar)) {
+    return str;
+  }
+
+  const length = str.length;
+  let changed = false;
+  const out: number[] = [];
+  for (let i = 0; i < length; ++i) {
+    const c = str.charCodeAt(i);
+    if (isUpper(c)) {
+      out.push(delim);
+      out.push(toLower(c));
+      changed = true;
+    } else {
+      out.push(c);
+    }
+  }
+
+  return changed ? String.fromCharCode.apply(undefined, out) : str;
+};
+
+export const decamelize = (str: string) => changeCase(str, LOW_DASH);
+export const hyphenize = (str: string) => changeCase(str, HI_DASH);

package/src/complex.test.ts

@@ -2,8 +2,7 @@
 // Copyright 2020 DXOS.org
 //
 
-import { expect } from 'chai';
-import { test } from 'vitest';
+import { expect, test } from 'vitest';
 
 import { PublicKey } from '@dxos/keys';
 

package/src/complex.ts

@@ -78,21 +78,21 @@ export class ComplexSet<T> implements Set<T> {
     return this._values.size;
   }
 
-  [Symbol.iterator](): IterableIterator<T> {
+  [Symbol.iterator](): SetIterator<T> {
     return this._values.values();
   }
 
-  *entries(): IterableIterator<[T, T]> {
+  *entries(): SetIterator<[T, T]> {
     for (const value of this._values.values()) {
       yield [value, value];
     }
   }
 
-  keys(): IterableIterator<T> {
+  keys(): SetIterator<T> {
     return this[Symbol.iterator]();
   }
 
-  values(): IterableIterator<T> {
+  values(): SetIterator<T> {
     return this[Symbol.iterator]();
   }
 
@@ -218,22 +218,22 @@ export class ComplexMap<K, V> implements Map<K, V> {
     return this._keys.size;
   }
 
-  *[Symbol.iterator](): IterableIterator<[K, V]> {
+  *[Symbol.iterator](): SetIterator<[K, V]> {
     for (const [primitive, key] of this._keys) {
       const value = this._values.get(primitive) ?? raise(new Error('Map corrupted.'));
       yield [key, value];
     }
   }
 
-  entries(): IterableIterator<[K, V]> {
+  entries(): SetIterator<[K, V]> {
     return this[Symbol.iterator]();
   }
 
-  keys(): IterableIterator<K> {
+  keys(): SetIterator<K> {
     return this._keys.values();
   }
 
-  values(): IterableIterator<V> {
+  values(): SetIterator<V> {
     return this._values.values();
   }
 

package/src/defer.test.ts

@@ -2,8 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { expect } from 'chai';
-import { describe, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 
 import { defer, deferAsync } from './defer';
 

package/src/human-hash.test.ts

@@ -2,8 +2,7 @@
 // Copyright 2020 DXOS.org
 //
 
-import { expect } from 'chai';
-import { test } from 'vitest';
+import { expect, test } from 'vitest';
 
 import { createKeyPair, createId } from '@dxos/crypto';
 import { PublicKey } from '@dxos/keys';

package/src/index.ts

@@ -7,6 +7,9 @@ export * from './assign';
 export * from './binder';
 export * from './bitfield';
 export * from './callback';
+export * from './callback-collection';
+export * from './case';
+export * from './chunk-array';
 export * from './circular-buffer';
 export * from './complex';
 export * from './defer';
@@ -21,7 +24,6 @@ export * from './json';
 export * from './map';
 export * from './map-values';
 export * from './order';
-export * from './params';
 export * from './pick';
 export * from './platform';
 export * from './random';
@@ -30,14 +32,16 @@ export * from './reducers';
 export * from './safe-await';
 export * from './safe-instanceof';
 export * from './safe-parse-json';
+export * from './sliding-window-summary';
 export * from './sort';
+export * from './sum';
 export * from './throw-unhandled-error';
 export * from './to-fallback';
 export * from './tracer';
 export * from './types';
 export * from './uint8array';
-export * from './sum';
 export * from './weak';
 export * from './sliding-window-summary';
-export * from './callback-collection';
 export * from './chunk-array';
+export * from './array-to-hex';
+export * from './remove-undefined-keys';

package/src/join-tables.test.ts

@@ -2,8 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { expect } from 'chai';
-import { describe, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 
 import { joinTables } from './join-tables';
 

package/src/map-values.ts

@@ -14,21 +14,30 @@ export const mapValues = <T, U>(obj: Record<string, T>, fn: (value: T, key: stri
  * Recursively maps values traversing arrays and objects.
  * @param fn Function to apply to each value. Second argument is a function to recurse into the value.
  */
-export const deepMapValues = (value: any, fn: (value: any, recurse: (value: any) => any) => any): any => {
+export const deepMapValues = (
+  value: any,
+  fn: (value: any, recurse: (value: any) => any, key: string | number | undefined) => any,
+): any => {
   return new DeepMapper(fn).map(value);
 };
 
 class DeepMapper {
   private readonly _cyclic = new Map<any, any>();
 
-  constructor(private readonly _fn: (value: any, recurse: (value: any) => any) => any) {}
+  constructor(
+    private readonly _fn: (value: any, recurse: (value: any) => any, key: string | number | undefined) => any,
+  ) {}
 
   map(value: any): any {
+    return this._map(value, undefined);
+  }
+
+  private _map(value: any, key: string | number | undefined): any {
     if (this._cyclic.has(value)) {
       return this._cyclic.get(value);
     }
 
-    return this._fn(value, this._recurse);
+    return this._fn(value, this._recurse, key);
   }
 
   private _recurse = (value: any) => {
@@ -40,14 +49,14 @@ class DeepMapper {
       const res = new Array(value.length);
       this._cyclic.set(value, res);
       for (let i = 0; i < value.length; i++) {
-        res[i] = this.map(value[i]);
+        res[i] = this._map(value[i], i);
       }
       return res;
     } else if (value !== null && typeof value === 'object') {
       const res: any = {};
       this._cyclic.set(value, res);
       for (const key in value) {
-        res[key] = this.map(value[key]);
+        res[key] = this._map(value[key], key);
       }
       return res;
     } else {
@@ -63,7 +72,7 @@ class DeepMapper {
  */
 export const deepMapValuesAsync = (
   value: any,
-  fn: (value: any, recurse: (value: any) => Promise<any>) => Promise<any>,
+  fn: (value: any, recurse: (value: any) => Promise<any>, key: string | number | undefined) => Promise<any>,
 ): Promise<any> => {
   return new DeepMapperAsync(fn).map(value);
 };
@@ -71,14 +80,24 @@ export const deepMapValuesAsync = (
 class DeepMapperAsync {
   private readonly _cyclic = new Map<any, any>();
 
-  constructor(private readonly _fn: (value: any, recurse: (value: any) => Promise<any>) => Promise<any>) {}
+  constructor(
+    private readonly _fn: (
+      value: any,
+      recurse: (value: any) => Promise<any>,
+      key: string | number | undefined,
+    ) => Promise<any>,
+  ) {}
 
   map(value: any): Promise<any> {
+    return this._map(value, undefined);
+  }
+
+  private _map(value: any, key: string | number | undefined): Promise<any> {
     if (this._cyclic.has(value)) {
       return this._cyclic.get(value);
     }
 
-    return this._fn(value, this._recurse);
+    return this._fn(value, this._recurse, key);
   }
 
   private _recurse = async (value: any) => {
@@ -90,14 +109,14 @@ class DeepMapperAsync {
       const res = new Array(value.length);
       this._cyclic.set(value, res);
       for (let i = 0; i < value.length; i++) {
-        res[i] = await this.map(value[i]);
+        res[i] = await this._map(value[i], i);
       }
       return res;
     } else if (value !== null && typeof value === 'object') {
       const res: any = {};
       this._cyclic.set(value, res);
       for (const key in value) {
-        res[key] = await this.map(value[key]);
+        res[key] = await this._map(value[key], key);
       }
       return res;
     } else {

package/src/order.test.ts

@@ -2,8 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import { expect } from 'chai';
-import { describe, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 
 import { inferObjectOrder, inferRecordOrder } from './order';
 

package/src/platform.browser.test.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+import { expect, test } from 'vitest';
+
+import { isNode } from './platform';
+
+test('knows when running in node', () => {
+  expect(isNode()).to.be.false;
+});

package/src/platform.node.test.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+import { expect, test } from 'vitest';
+
+import { isNode } from './platform';
+
+test('knows when running in node', () => {
+  expect(isNode()).to.be.true;
+});

package/src/random.ts

@@ -4,7 +4,7 @@
 
 // TODO(burdon): Random class utility.
 // TODO(burdon): Make object { min, max }.
-export const randomInt = (max: number, min: number) => {
+export const randomInt = (max: number, min = 0) => {
   min = Math.ceil(min);
   max = Math.floor(max);
   return Math.floor(Math.random() * (max - min + 1)) + min;

package/src/reducers.test.ts

@@ -2,8 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import { expect } from 'chai';
-import { describe, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 
 import { median, numericalValues } from './reducers';
 

package/src/remove-undefined-keys.ts

@@ -0,0 +1,13 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export const removeUndefinedProperties = <T extends {}>(object: T): T => {
+  for (const prop of [...Object.getOwnPropertyNames(object), ...Object.getOwnPropertySymbols(object)]) {
+    if ((object as any)[prop] === undefined) {
+      delete (object as any)[prop];
+    }
+  }
+
+  return object;
+};

package/src/safe-instanceof.test.ts

@@ -2,8 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-import { expect } from 'chai';
-import { describe, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 
 import { safeInstanceof } from './safe-instanceof';
 

package/src/sort.test.ts

@@ -2,8 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-import { expect } from 'chai';
-import { describe, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 
 import { compareMulti, compareScalar, compareObject, compareString } from './sort';
 

package/src/tracer.test.ts

@@ -2,9 +2,9 @@
 // Copyright 2023 DXOS.org
 //
 
-import { expect } from 'chai';
-import { describe, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 
+import { randomInt } from './random';
 import { createBucketReducer, numericalValues, reduceGroupBy, reduceSeries, reduceSet } from './reducers';
 import { Tracer } from './tracer';
 
@@ -22,7 +22,7 @@ describe('Tracer', () => {
     const n = 20;
     for (let i = 0; i < n; i++) {
       tracer.emit(key);
-      await sleep(Math.random() * 10);
+      await sleep(randomInt(10));
     }
 
     const events = tracer.get('test')!;

package/src/types.test.ts

@@ -2,8 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-import { expect } from 'chai';
-import { describe, test } from 'vitest';
+import { describe, expect, test } from 'vitest';
 
 import { nonNullable } from './types';
 

package/src/uint8array.test.ts

@@ -2,8 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import { expect } from 'chai';
-import { test, describe } from 'vitest';
+import { test, expect, describe } from 'vitest';
 
 import { arrayToBuffer, arrayToString, bufferToArray, stringToArray } from './uint8array';
 

package/src/weak.test.ts

@@ -2,16 +2,14 @@
 // Copyright 2023 DXOS.org
 //
 
-import { expect } from 'chai';
-import { test, describe } from 'vitest';
-import waitForExpect from 'wait-for-expect';
+import { test, expect, describe } from 'vitest';
 
 import { WeakDictionary } from './weak';
 
 describe('WeakDictionary', () => {
   // Skipped because it takes a long time for garbage collection to kick in (~8 sec)
   // but it works otherwise.
-  test.skip('unref item gets garbage collected', async () => {
+  test.skip('unref item gets garbage collected', { timeout: 20_000 }, async () => {
     const map = new WeakDictionary<string, any>();
     const key = 'key';
 
@@ -32,10 +30,8 @@ describe('WeakDictionary', () => {
 
     setValue();
     // Garbage collection should remove the item because no references exist.
-    await waitForExpect(() => {
-      expect(map.size).to.equal(0);
-    }, 20000);
+    await expect.poll(() => map.size, { timeout: 20_000 }).toEqual(0);
 
     expect(map.has(key)).to.equal(false);
-  }, 20_000);
+  });
 });

package/src/weak.ts

@@ -16,17 +16,17 @@ export class WeakDictionary<K, V extends object> implements Map<K, V> {
     entries?.forEach(([key, value]) => this._register(key, value));
   }
 
-  *entries(): IterableIterator<[K, V]> {
+  *entries(): SetIterator<[K, V]> {
     for (const [key, value] of this._internal) {
       yield [key, value.deref()!];
     }
   }
 
-  keys(): IterableIterator<K> {
+  keys(): SetIterator<K> {
     return this._internal.keys();
   }
 
-  *values(): IterableIterator<V> {
+  *values(): SetIterator<V> {
     for (const value of this._internal.values()) {
       const deref = value.deref();
       if (!deref) {
@@ -36,7 +36,7 @@ export class WeakDictionary<K, V extends object> implements Map<K, V> {
     }
   }
 
-  *[Symbol.iterator](): IterableIterator<[K, V]> {
+  *[Symbol.iterator](): SetIterator<[K, V]> {
     for (const [key, value] of this._internal) {
       yield [key, value.deref()!];
     }

package/dist/types/src/params.d.ts

@@ -1,22 +0,0 @@
-import type * as S from '@effect/schema/Schema';
-import { type Annotable } from '@effect/schema/Schema';
-type ParamKeyAnnotationType = string;
-export declare const ParamKeyAnnotation: (value: ParamKeyAnnotationType) => <S extends Annotable.All>(self: S) => Annotable.Self<S>;
-/**
- * HTTP params parser.
- */
-export declare class Params<T extends Record<string, any>> {
-    private readonly _schema;
-    constructor(_schema: S.Struct<T>);
-    /**
-     * Parse URL params.
-     * @param url
-     */
-    parse(url: URL): T;
-    /**
-     * Update URL with params.
-     */
-    params(url: URL, values: T): URL;
-}
-export {};
-//# sourceMappingURL=params.d.ts.map

package/dist/types/src/params.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["../../../src/params.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,KAAK,CAAC,MAAM,uBAAuB,CAAC;AAEhD,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAMvD,KAAK,sBAAsB,GAAG,MAAM,CAAC;AAErC,eAAO,MAAM,kBAAkB,UACrB,sBAAsB,MAC7B,CAAC,SAAS,SAAS,CAAC,GAAG,QAAQ,CAAC,KAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CACC,CAAC;AAExD;;GAEG;AACH,qBAAa,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IAEjD;;;OAGG;IACH,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC;IAqBlB;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,GAAG;CAYjC"}

package/dist/types/src/params.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=params.test.d.ts.map

package/dist/types/src/params.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"params.test.d.ts","sourceRoot":"","sources":["../../../src/params.test.ts"],"names":[],"mappings":""}

package/dist/types/src/platform.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=platform.test.d.ts.map

package/dist/types/src/platform.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"platform.test.d.ts","sourceRoot":"","sources":["../../../src/platform.test.ts"],"names":[],"mappings":""}