@dxos/util 0.8.4-main.c1de068 → 0.8.4-main.dedc0f3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/util",
-  "version": "0.8.4-main.c1de068",
+  "version": "0.8.4-main.dedc0f3",
   "description": "Temporary bucket for misc functions, which should graduate into separate packages.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -10,12 +10,12 @@
   "type": "module",
   "exports": {
     ".": {
+      "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": {
         "require": "./dist/lib/node/index.cjs",
         "default": "./dist/lib/node-esm/index.mjs"
-      },
-      "types": "./dist/types/src/index.d.ts"
+      }
     }
   },
   "types": "dist/types/src/index.d.ts",
@@ -29,15 +29,15 @@
   "dependencies": {
     "lodash.get": "^4.4.2",
     "lodash.set": "^4.3.2",
-    "@dxos/debug": "0.8.4-main.c1de068",
-    "@dxos/invariant": "0.8.4-main.c1de068",
-    "@dxos/keys": "0.8.4-main.c1de068",
-    "@dxos/node-std": "0.8.4-main.c1de068"
+    "@dxos/debug": "0.8.4-main.dedc0f3",
+    "@dxos/node-std": "0.8.4-main.dedc0f3",
+    "@dxos/invariant": "0.8.4-main.dedc0f3",
+    "@dxos/keys": "0.8.4-main.dedc0f3"
   },
   "devDependencies": {
     "@types/lodash.get": "^4.4.9",
     "@types/lodash.set": "^4.3.9",
-    "@dxos/crypto": "0.8.4-main.c1de068"
+    "@dxos/crypto": "0.8.4-main.dedc0f3"
   },
   "publishConfig": {
     "access": "public"

package/src/array.test.ts

@@ -4,7 +4,7 @@
 
 import { describe, expect, test } from 'vitest';
 
-import { diff, intersection, distinctBy, partition } from './array';
+import { diff, distinctBy, intersection, partition } from './array';
 
 describe('diff', () => {
   test('returns the difference between two sets', () => {

package/src/circular-buffer.test.ts

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { describe, test, expect } from 'vitest';
+import { describe, expect, test } from 'vitest';
 
 import { CircularBuffer } from './circular-buffer';
 

package/src/complex.test.ts

@@ -6,7 +6,7 @@ import { expect, test } from 'vitest';
 
 import { PublicKey } from '@dxos/keys';
 
-import { makeSet, makeMap } from './complex';
+import { makeMap, makeSet } from './complex';
 
 const PulicKeySet = makeSet<PublicKey>(PublicKey.hash);
 

package/src/human-hash.test.ts

@@ -4,7 +4,7 @@
 
 import { expect, test } from 'vitest';
 
-import { createKeyPair, createId } from '@dxos/crypto';
+import { createId, createKeyPair } from '@dxos/crypto';
 import { PublicKey } from '@dxos/keys';
 
 import { humanize } from './human-hash';

package/src/index.ts

@@ -51,5 +51,6 @@ export * from './tracer';
 export * from './tree';
 export * from './types';
 export * from './uint8array';
+export * from './unit';
 export * from './url';
 export * from './weak';

package/src/position.test.ts

@@ -2,9 +2,9 @@
 // Copyright 2025 DXOS.org
 //
 
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
 
-import { byPosition, type Position } from './position';
+import { type Position, byPosition } from './position';
 
 type TestItem = {
   id: number;

package/src/safe-parse.ts

@@ -6,7 +6,7 @@ export const safeParseInt = (value: string | undefined, defaultValue?: number) =
   try {
     const n = parseInt(value ?? '');
     return isNaN(n) ? defaultValue : n;
-  } catch (err) {
+  } catch {
     return defaultValue;
   }
 };
@@ -22,13 +22,14 @@ export const safeParseFloat = (str: string, defaultValue?: number): number | und
 export const safeParseJson: {
   <T extends object>(data: string | undefined | null, defaultValue: T): T;
   <T extends object>(data: string | undefined | null): T | undefined;
-} = <T extends object>(data: string | undefined | null, defaultValue?: T) => {
+} = <T extends object = any>(data: string | undefined | null, defaultValue?: T): T | undefined => {
   if (data && data.length > 0) {
     try {
       return JSON.parse(data);
-    } catch (err) {
+    } catch {
       // no-op.
     }
   }
+
   return defaultValue;
 };

package/src/sort.test.ts

@@ -4,7 +4,7 @@
 
 import { describe, expect, test } from 'vitest';
 
-import { compareMulti, compareScalar, compareObject, compareString } from './sort';
+import { compareMulti, compareObject, compareScalar, compareString } from './sort';
 
 const data = [
   { i: 0, idx: 1, label: 'apple' },

package/src/string.test.ts

@@ -14,6 +14,6 @@ describe('string', () => {
         - 3
     `;
 
-    expect(text).to.eq('- 1\n- 2\n  - 3\n');
+    expect(text).to.eq('- 1\n- 2\n  - 3');
   });
 });

package/src/string.ts

@@ -16,9 +16,28 @@ export const capitalize = (str: string): string => {
 /**
  * Remove leading space from multi-line strings.
  */
-export const trim = (strings: TemplateStringsArray, ...values: any[]) => {
-  const full = String.raw(strings, ...values);
-  const lines = full.replace(/^\n/, '').split('\n');
-  const indent = Math.min(...lines.filter((l) => l.trim()).map((l) => l.match(/^ */)![0].length));
-  return lines.map((l) => l.slice(indent)).join('\n');
-};
+export function trim(strings: TemplateStringsArray, ...values: any[]) {
+  // First, build the raw result with relative indentation.
+  const raw = strings.reduce((out, str, i) => {
+    out += str;
+    if (i < values.length) {
+      const match = str.match(/(^|\n)([ \t]*)$/);
+      const baseIndent = match ? match[2] : '';
+      const val = String(values[i]).replace(/\r?\n/g, '\n' + baseIndent);
+      out += val;
+    }
+    return out;
+  }, '');
+
+  // Split into lines and trim leading/trailing blank lines.
+  const lines = raw.split('\n');
+
+  while (lines.length && !lines[0].trim()) lines.shift();
+  while (lines.length && !lines[lines.length - 1].trim()) lines.pop();
+
+  // Find smallest indent across all non-blank lines.
+  const minIndent = Math.min(...lines.filter((l) => l.trim()).map((l) => l.match(/^[ \t]*/)?.[0].length ?? 0));
+
+  // Remove that indent from all lines.
+  return lines.map((l) => l.slice(minIndent)).join('\n');
+}

package/src/tree.test.ts

@@ -6,7 +6,7 @@ import { describe, test } from 'vitest';
 
 import { PublicKey } from '@dxos/keys';
 
-import { stringifyTree, type TreeNode } from './tree';
+import { type TreeNode, stringifyTree } from './tree';
 
 describe('Tree logging', () => {
   test('simple', () => {

package/src/types.ts

@@ -47,6 +47,7 @@ export type Falsy = false | 0 | '' | null | undefined;
  * Use with filter chaining instead of filter(Boolean) to preserve type.
  * NOTE: To filter by type:
  * items.filter((item: any): item is RangeSet<Decoration> => item instanceof RangeSet)
+ * @deprecated Replace with Predicate.isTruthy
  */
 export const isNotFalsy = <T>(value: T): value is Exclude<T, Falsy> => !!value;
 export const isNonNullable = <T>(value: T | null | undefined): value is T => value != null;

package/src/uint8array.test.ts

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

package/src/unit.test.ts

@@ -0,0 +1,25 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { describe, it } from 'vitest';
+
+import { Unit } from './unit';
+
+describe('url', () => {
+  it('duration', ({ expect }) => {
+    const tests: [number, string][] = [
+      [0, '0ms'],
+      [1, '1ms'],
+      [1_000, '1.0s'],
+      [2_887, '2.9s'],
+      [1_000 * 60, '1m'],
+      [1_000 * 60 + 1_000 * 5, '1m 5s'],
+      [1_000 * 60 * 60 + 1_000 * 60 * 5, '1h 5m'],
+    ];
+
+    tests.forEach(([input, output]) => {
+      expect(Unit.Duration(input)).toBe(output);
+    });
+  });
+});

package/src/unit.ts

@@ -0,0 +1,52 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+type Unit = {
+  symbol: string;
+  quotient: number;
+};
+
+type Format = (n: number, precision?: number) => string;
+
+const Formatter = (unit: Unit): Format => {
+  return (n: number, precision = 2) => {
+    const value = n / unit.quotient;
+    return `${value.toFixed(precision)}${unit.symbol}`;
+  };
+};
+
+export const Unit = {
+  // ms.
+  Hour: Formatter({ symbol: 'h', quotient: 60 * 60 * 1_000 }),
+  Minute: Formatter({ symbol: 'm', quotient: 60 * 1_000 }),
+  Second: Formatter({ symbol: 's', quotient: 1_000 }),
+  Millisecond: Formatter({ symbol: 'ms', quotient: 1 }),
+  Duration: (n: number) => {
+    const hours = Math.floor(n / (60 * 60 * 1_000));
+    const minutes = Math.floor((n % (60 * 60 * 1_000)) / (60 * 1_000));
+    if (hours) {
+      return minutes ? `${hours}h ${minutes}m` : `${hours}h`;
+    }
+
+    const seconds = Math.floor((n % (60 * 1_000)) / 1_000);
+    if (minutes) {
+      return seconds ? `${minutes}m ${seconds}s` : `${minutes}m`;
+    }
+
+    if (seconds) {
+      return `${(n / 1_000).toFixed(1)}s`;
+    }
+
+    return `${n}ms`;
+  },
+
+  // bytes (note KB via KiB).
+  Gigabyte: Formatter({ symbol: 'GB', quotient: 1_000 * 1_000 * 1_000 }),
+  Megabyte: Formatter({ symbol: 'MB', quotient: 1_000 * 1_000 }),
+  Kilobyte: Formatter({ symbol: 'KB', quotient: 1_000 }),
+
+  // general.
+  Thousand: Formatter({ symbol: 'k', quotient: 1_000 }),
+  Percent: Formatter({ symbol: '%', quotient: 1 / 100 }),
+};

package/src/weak.test.ts

@@ -2,7 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import { test, expect, describe } from 'vitest';
+import { describe, expect, test } from 'vitest';
 
 import { WeakDictionary } from './weak';