@dxos/util 0.8.2-main.30e4dbb → 0.8.2-main.4c6cf53

package/src/index.ts

@@ -2,43 +2,48 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './array';
 export * from './array-to-hex';
+export * from './array';
 export * from './binder';
 export * from './bitfield';
-export * from './callback';
 export * from './callback-collection';
+export * from './callback';
 export * from './case';
 export * from './chunk-array';
 export * from './circular-buffer';
+export * from './clear-undefined';
 export * from './complex';
-export * from './defer';
-export * from './defer-function';
 export * from './deep';
+export * from './defer-function';
+export * from './defer';
 export * from './entry';
 export * from './first-two-chars';
 export * from './for-each-async';
 export * from './human-hash';
-export * from './interval';
 export * from './instance-id';
+export * from './interval';
 export * from './join-tables';
 export * from './json';
-export * from './map';
 export * from './map-values';
+export * from './map';
 export * from './no-infer';
-export * from './order';
+export * from './object';
 export * from './order-keys';
+export * from './order';
 export * from './pick';
 export * from './platform';
 export * from './position';
 export * from './random';
 export * from './range';
 export * from './reducers';
+export * from './remove-undefined-keys';
 export * from './safe-await';
 export * from './safe-instanceof';
 export * from './safe-parse';
 export * from './sliding-window-summary';
+export * from './sliding-window-summary';
 export * from './sort';
+export * from './string';
 export * from './sum';
 export * from './throw-unhandled-error';
 export * from './to-fallback';
@@ -47,7 +52,3 @@ export * from './tree';
 export * from './types';
 export * from './uint8array';
 export * from './weak';
-export * from './sliding-window-summary';
-export * from './string';
-export * from './remove-undefined-keys';
-export * from './clear-undefined';

package/src/map-values.ts

@@ -124,3 +124,17 @@ class DeepMapperAsync {
     }
   };
 }
+
+/**
+ * Visits all values on an object or every item in an array.
+ * No-op if the value is not an object or array.
+ */
+export const visitValues = (object: unknown, visitor: (value: unknown, key: string | number) => void) => {
+  if (Array.isArray(object)) {
+    object.forEach((item, index) => visitor(item, index));
+  } else if (typeof object === 'object' && object !== null) {
+    for (const [key, value] of Object.entries(object)) {
+      visitor(value, key);
+    }
+  }
+};

package/src/object.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export const keys = <R>(obj: R): (keyof R)[] => Object.keys(obj as any) as (keyof R)[];
+
+export const entries = <R>(obj: R): [keyof R, R[keyof R]][] => Object.entries(obj as any) as [keyof R, any][];

package/src/position.ts

@@ -2,9 +2,10 @@
 // Copyright 2025 DXOS.org
 //
 
+// TODO(burdon): This shouldn't be in this low-level util? Move to app-framework?
+
 /**
- * Determines priority order.
- *
+ * Determines priority order:
  * - `static` - Remain in natural order.
  * - `hoist` - Placed before `static`.
  * - `fallback` - Placed after `static`.
@@ -15,17 +16,17 @@ export type Position = 'static' | 'hoist' | 'fallback';
 /**
  * Sorting function for sorting by position.
  */
-export const byPosition = <T extends { position?: Position }>(a: T, b: T) => {
-  const aPosition = a.position ?? 'static';
-  const bPosition = b.position ?? 'static';
-
-  if (aPosition === bPosition) {
+export const byPosition = <T extends { position?: Position }>(
+  { position: a = 'static' }: T,
+  { position: b = 'static' }: T,
+) => {
+  if (a === b) {
     return 0;
-  } else if (aPosition === 'hoist' || bPosition === 'fallback') {
+  } else if (a === 'hoist' || b === 'fallback') {
     return -1;
-  } else if (bPosition === 'hoist' || aPosition === 'fallback') {
+  } else if (b === 'hoist' || a === 'fallback') {
     return 1;
+  } else {
+    return 0;
   }
-
-  return 0;
 };

package/src/sliding-window-summary.ts

@@ -28,12 +28,12 @@ export class SlidingWindowSummary {
     }
   }
 
-  public record(value: number) {
+  public record(value: number): void {
     const evicted = this._buffer.push(value);
     this._sum += value - (evicted ?? 0);
   }
 
-  public average() {
+  public average(): number {
     return this._buffer.elementCount === 0 ? 0 : this._withPrecision(this._sum / this._buffer.elementCount);
   }
 
@@ -58,7 +58,7 @@ export class SlidingWindowSummary {
     return { mean, median, p90, stdDev, histogram };
   }
 
-  private _withPrecision(value: number) {
+  private _withPrecision(value: number): number {
     if (this._precision == null) {
       return value;
     }

package/src/tracer.ts

@@ -32,7 +32,7 @@ export class Tracer {
     return this._recording;
   }
 
-  keys() {
+  keys(): string[] {
     return Array.from(this._events.keys());
   }
 
@@ -45,21 +45,21 @@ export class Tracer {
     return events;
   }
 
-  clear() {
+  clear(): void {
     this._events.clear();
   }
 
-  start() {
+  start(): this {
     this._recording = true;
     return this;
   }
 
-  stop() {
+  stop(): this {
     this._recording = false;
     return this;
   }
 
-  emit(id: string, value?: any) {
+  emit(id: string, value?: any): void {
     this._post(this._createEvent(id, value));
   }
 
@@ -84,7 +84,7 @@ export class Tracer {
     return event;
   }
 
-  private _post(event: Event) {
+  private _post(event: Event): void {
     if (this._recording) {
       defaultMap(this._events, event.id, []).push(event);
     }

package/src/weak.ts

@@ -96,7 +96,7 @@ export class WeakDictionary<K, V extends object> implements Map<K, V> {
     });
   }
 
-  private _register(key: K, value: V) {
+  private _register(key: K, value: V): void {
     this._finalization.register(
       value,
       () => {
@@ -106,7 +106,7 @@ export class WeakDictionary<K, V extends object> implements Map<K, V> {
     );
   }
 
-  private _unregister(value: V) {
+  private _unregister(value: V): void {
     this._finalization.unregister(value);
   }
 }