@dxos/util 0.4.7-main.33db07e → 0.4.7-main.340e96b

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/util",
-  "version": "0.4.7-main.33db07e",
+  "version": "0.4.7-main.340e96b",
   "description": "Temporary bucket for misc functions, which should graduate into separate packages.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -16,13 +16,13 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/debug": "0.4.7-main.33db07e",
-    "@dxos/invariant": "0.4.7-main.33db07e",
-    "@dxos/keys": "0.4.7-main.33db07e",
-    "@dxos/node-std": "0.4.7-main.33db07e"
+    "@dxos/debug": "0.4.7-main.340e96b",
+    "@dxos/invariant": "0.4.7-main.340e96b",
+    "@dxos/keys": "0.4.7-main.340e96b",
+    "@dxos/node-std": "0.4.7-main.340e96b"
   },
   "devDependencies": {
-    "@dxos/crypto": "0.4.7-main.33db07e"
+    "@dxos/crypto": "0.4.7-main.340e96b"
   },
   "publishConfig": {
     "access": "public"

package/src/circular-buffer.test.ts

@@ -0,0 +1,33 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { describe, test, expect } from 'vitest';
+
+import { CircularBuffer } from './circular-buffer';
+
+describe('CircularBuffer', () => {
+  test('single element', () => {
+    const buffer = new CircularBuffer<number>(1);
+    for (let i = 0; i < 3; i++) {
+      buffer.push(i);
+      expect([...buffer]).toStrictEqual([i]);
+      expect(buffer.getLast()).toStrictEqual(i);
+    }
+  });
+
+  test('full cycle', () => {
+    const maxSize = 10;
+    const regularArray: number[] = [];
+    const buffer = new CircularBuffer<number>(maxSize);
+    for (let i = 0; i < maxSize * 2 + 2; i++) {
+      expect([...buffer]).toStrictEqual(regularArray);
+      buffer.push(i);
+      regularArray.push(i);
+      if (regularArray.length > maxSize) {
+        regularArray.splice(0, 1);
+      }
+      expect(buffer.getLast()).toStrictEqual(i);
+    }
+  });
+});

package/src/circular-buffer.ts

@@ -0,0 +1,54 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { invariant } from '@dxos/invariant';
+
+export class CircularBuffer<T> {
+  private readonly _buffer: T[];
+  private _nextIndex = 0;
+  private _elementCount = 0;
+
+  constructor(size: number) {
+    invariant(size >= 1);
+    this._buffer = new Array(size);
+  }
+
+  public push(element: T) {
+    this._buffer[this._nextIndex] = element;
+    this._nextIndex = (this._nextIndex + 1) % this._buffer.length;
+    this._elementCount = Math.min(this._buffer.length, this._elementCount + 1);
+  }
+
+  public getLast(): T | undefined {
+    if (this._elementCount === 0) {
+      return undefined;
+    }
+    if (this._nextIndex === 0) {
+      return this._buffer[this._buffer.length - 1];
+    }
+    return this._buffer[this._nextIndex - 1];
+  }
+
+  [Symbol.iterator](): IterableIterator<T> {
+    return this.values();
+  }
+
+  public *values(): IterableIterator<T> {
+    if (this._elementCount === 0) {
+      return;
+    }
+    if (this._elementCount < this._buffer.length) {
+      for (let i = 0; i < this._elementCount; i++) {
+        yield this._buffer[i];
+      }
+      return;
+    }
+    for (let i = this._nextIndex; i < this._buffer.length; i++) {
+      yield this._buffer[i];
+    }
+    for (let i = 0; i < this._nextIndex; i++) {
+      yield this._buffer[i];
+    }
+  }
+}

package/src/index.ts

@@ -8,6 +8,7 @@ export * from './bitfield';
 export * from './callback';
 export * from './complex';
 export * from './defer-function';
+export * from './to-fallback';
 export * from './entry';
 export * from './human-hash';
 export * from './interval';
@@ -30,3 +31,4 @@ export * from './for-each-async';
 export * from './weak';
 export * from './map-values';
 export * from './defer';
+export * from './circular-buffer';

package/src/instance-id.ts

@@ -37,7 +37,7 @@ export const getPrototypeSpecificInstanceId = (instance: any): number => {
 };
 
 export const getDebugName = (instance: any): string => {
-  if (instance === null) {
+  if (instance == null) {
     return 'null';
   }
 

package/src/to-fallback.ts

@@ -0,0 +1,195 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type PublicKey } from '@dxos/keys';
+
+export const idEmoji = [
+  // When changing this set, please check the result in a console or e.g. RunKit (https://runkit.com/thure/642214441dd6ae000855a8de)
+  // Emoji sometimes use a combination of code points, and some code points aren't visible on their own, so by adding or deleting you may unintentionally create non-visible items.
+  // This set was chosen from the characters in Unicode Emoji v15.0 based on the following criteria:
+  // – not people or isolated anthropomorphic faces
+  // – not flags
+  // – more concrete than abstract
+  // – less culturally specific
+  // – less easily confused with another emoji in the set
+  // – requires less special knowledge to identify
+  // – less likely to evoke negative feelings (no meat, no drugs, no weapons, etc)
+  // – less common as a signifier in UX
+  // NOTE that this is intentionally an array of strings because of the way emoji graphemes work.
+  '👹',
+  '👻',
+  '👽',
+  '🤖',
+  '🎃',
+  '🦾',
+  '🦿',
+  '🦷',
+  '👣',
+  '👁️',
+  '🧶',
+  '👑',
+  '🐒',
+  '🦆',
+  '🦉',
+  '🐴',
+  '🦄',
+  '🐝',
+  '🦋',
+  '🐞',
+  '🪲',
+  '🐢',
+  '🦎',
+  '🦕',
+  '🦑',
+  '🦀',
+  '🐠',
+  '🐬',
+  '🐋',
+  '🦭',
+  '🐅',
+  '🐆',
+  '🦓',
+  '🦍',
+  '🦧',
+  '🐘',
+  '🐫',
+  '🦒',
+  '🦘',
+  '🦬',
+  '🐖',
+  '🐏',
+  '🦌',
+  '🐕',
+  '🐈',
+  '🐓',
+  '🦚',
+  '🦜',
+  '🦢',
+  '🦩',
+  '🦦',
+  '🐁',
+  '🐿️',
+  '🌵',
+  '🌲',
+  '🌳',
+  '🪵',
+  '🌱',
+  '🍁',
+  '🪺',
+  '🍄',
+  '🐚',
+  '🪸',
+  '🪨',
+  '🌾',
+  '🌷',
+  '🌻',
+  '☀️',
+  '🌙',
+  '🪐',
+  '⭐️',
+  '⚡️',
+  '☄️',
+  '🔥',
+  '🌈',
+  '☁️',
+  '💧',
+  '⛱️',
+  '🌊',
+  '🍎',
+  '🍋',
+  '🍉',
+  '🍇',
+  '🫐',
+  '🍈',
+  '🍒',
+  '🍑',
+  '🥭',
+  '🍍',
+  '🥥',
+  '🥝',
+  '🥑',
+  '🌶️',
+  '🌽',
+  '🥕',
+  '🍬',
+  '🥜',
+  '🫖',
+  '☕️',
+  '🍵',
+  '🧊',
+  '🧂',
+  '🏔️',
+  '⚓️',
+  '🛟',
+  '🏝️',
+  '🛶',
+  '🚀',
+  '🛰️',
+  '⛲️',
+  '🏰',
+  '🚲',
+  '⛺️',
+  '🎙️',
+  '🧲',
+  '⚙️',
+  '🔩',
+  '🔮',
+  '🔭',
+  '🔬',
+  '🧬',
+  '🌡️',
+  '🧺',
+  '🛎️',
+  '🔑',
+  '🪑',
+  '🧸',
+  '🎈',
+  '🎀',
+  '🎊',
+  '♻️',
+  '🎵',
+];
+
+export const idHue = [
+  'red' as const,
+  // 'orange' as const, /* More shades in these palettes are considered “ugly” */
+  'amber' as const, // Amber arcs between red-orange and yellow as it gets lighter, so improves aesthetics.
+  // 'yellow' as const, /* More shades in these palettes are considered “ugly” */
+  'lime' as const,
+  'green' as const,
+  'emerald' as const,
+  'teal' as const,
+  'cyan' as const,
+  // 'sky' as const, /* Omitted since it is quite similar to the primary accent palette */
+  // 'blue' as const, /* Omitted since it is quite similar to the primary accent palette */
+  // 'indigo' as const, /* Omitted since it is quite similar to the primary accent palette */
+  'violet' as const,
+  'purple' as const,
+  'fuchsia' as const,
+  'pink' as const,
+  'rose' as const,
+];
+
+export const keyToEmoji = (key: PublicKey) => hexToEmoji(key.toHex());
+
+export const hexToEmoji = (hex: string) => toEmoji(parseInt(hex, 16));
+
+export const toEmoji = (hash: number) => idEmoji[hash % idEmoji.length];
+
+export const keyToHue = (key: PublicKey) => hexToHue(key.toHex());
+
+export const hexToHue = (hex: string) => toHue(parseInt(hex, 16));
+
+export const toHue = (hash: number) => idHue[hash % idHue.length];
+
+export type FallbackValue = {
+  emoji: string;
+  hue: (typeof idHue)[number];
+};
+
+export const keyToFallback = (key: PublicKey) => hexToFallback(key.toHex());
+
+export const hexToFallback = (hex: string) => toFallback(parseInt(hex, 16));
+
+export const toFallback = (hash: number): FallbackValue => ({ emoji: toEmoji(hash), hue: toHue(hash) });