@dxos/util 0.5.3-main.bbd33a9 → 0.5.3-main.bfb5bca

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

@@ -12,4 +12,14 @@ export type DiffResult<A, B = A> = {
  */
 export declare const diff: <A, B = A>(previous: readonly A[], next: readonly B[], comparator: Comparator<A, B>) => DiffResult<A, B>;
 export declare const intersection: <A, B = A>(a: A[], b: B[], comparator: Comparator<A, B>) => A[];
+/**
+ * Returns a new array with only the first instance of each unique item
+ * based on a specified property.
+ *
+ * @typeParam T - The type of items in the input array.
+ * @param array - The array to filter for distinct items.
+ * @param key - The property key to determine uniqueness for each item.
+ * @returns A new array with only distinct items based on the specified property.
+ */
+export declare const distinctBy: <T, K>(array: T[], selector: (item: T) => K) => T[];
 //# sourceMappingURL=array.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../../src/array.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC;AAE3D,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI;IACjC,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,OAAO,EAAE,CAAC,EAAE,CAAC;IACb,OAAO,EAAE,CAAC,EAAE,CAAC;CACd,CAAC;AAEF;;;;;GAKG;AAEH,eAAO,MAAM,IAAI,uBACL,SAAS,CAAC,EAAE,QAChB,SAAS,CAAC,EAAE,cACN,WAAW,CAAC,EAAE,CAAC,CAAC,KAC3B,WAAW,CAAC,EAAE,CAAC,CAoBjB,CAAC;AAGF,eAAO,MAAM,YAAY,gBAAiB,CAAC,EAAE,KAAK,CAAC,EAAE,cAAc,WAAW,CAAC,EAAE,CAAC,CAAC,KAAG,CAAC,EACvB,CAAC"}
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../../src/array.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC;AAE3D,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI;IACjC,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,OAAO,EAAE,CAAC,EAAE,CAAC;IACb,OAAO,EAAE,CAAC,EAAE,CAAC;CACd,CAAC;AAEF;;;;;GAKG;AAEH,eAAO,MAAM,IAAI,uBACL,SAAS,CAAC,EAAE,QAChB,SAAS,CAAC,EAAE,cACN,WAAW,CAAC,EAAE,CAAC,CAAC,KAC3B,WAAW,CAAC,EAAE,CAAC,CAoBjB,CAAC;AAGF,eAAO,MAAM,YAAY,gBAAiB,CAAC,EAAE,KAAK,CAAC,EAAE,cAAc,WAAW,CAAC,EAAE,CAAC,CAAC,KAAG,CAAC,EACvB,CAAC;AAEjE;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,gBAAiB,CAAC,EAAE,YAAY,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAG,CAAC,EAYxE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/util",
-  "version": "0.5.3-main.bbd33a9",
+  "version": "0.5.3-main.bfb5bca",
   "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.5.3-main.bbd33a9",
-    "@dxos/invariant": "0.5.3-main.bbd33a9",
-    "@dxos/node-std": "0.5.3-main.bbd33a9",
-    "@dxos/keys": "0.5.3-main.bbd33a9"
+    "@dxos/debug": "0.5.3-main.bfb5bca",
+    "@dxos/keys": "0.5.3-main.bfb5bca",
+    "@dxos/invariant": "0.5.3-main.bfb5bca",
+    "@dxos/node-std": "0.5.3-main.bfb5bca"
   },
   "devDependencies": {
-    "@dxos/crypto": "0.5.3-main.bbd33a9"
+    "@dxos/crypto": "0.5.3-main.bfb5bca"
   },
   "publishConfig": {
     "access": "public"

package/src/array.test.ts

@@ -5,7 +5,7 @@
 import { expect } from 'chai';
 import { describe, test } from 'vitest';
 
-import { diff, intersection } from './array';
+import { diff, intersection, distinctBy } from './array';
 
 describe('diff', () => {
   test('returns the difference between two sets', () => {
@@ -40,3 +40,60 @@ describe('diff', () => {
     ).to.deep.eq([{ x: 2 }, { x: 3 }]);
   });
 });
+
+describe('distinctBy', () => {
+  test('filters distinct elements by a given key', () => {
+    {
+      const array = [1, 2, 2, 3, 4, 4, 5];
+      const distinct = distinctBy(array, (a) => a);
+      expect(distinct).to.deep.eq([1, 2, 3, 4, 5]);
+    }
+    {
+      const array = [{ x: 1 }, { x: 2 }, { x: 2 }, { x: 3 }, { x: 4 }, { x: 4 }, { x: 5 }];
+      const distinct = distinctBy(array, (a) => a.x);
+      expect(distinct).to.deep.eq([{ x: 1 }, { x: 2 }, { x: 3 }, { x: 4 }, { x: 5 }]);
+    }
+    {
+      const array = ['apple', 'banana', 'apple', 'orange', 'banana'];
+      const distinct = distinctBy(array, (a) => a);
+      expect(distinct).to.deep.eq(['apple', 'banana', 'orange']);
+    }
+  });
+
+  test('handles empty arrays', () => {
+    {
+      const array: number[] = [];
+      const distinct = distinctBy(array, (a) => a);
+      expect(distinct).to.deep.eq([]);
+    }
+    {
+      const array: { x: number }[] = [];
+      const distinct = distinctBy(array, (a) => a.x);
+      expect(distinct).to.deep.eq([]);
+    }
+  });
+
+  test('works with complex objects', () => {
+    {
+      const array = [{ x: { y: 1 } }, { x: { y: 2 } }, { x: { y: 1 } }];
+      const distinct = distinctBy(array, (a) => a.x.y);
+      expect(distinct).to.deep.eq([{ x: { y: 1 } }, { x: { y: 2 } }]);
+    }
+  });
+
+  test('case sensitivity', () => {
+    {
+      const array = ['apple', 'Apple', 'APPLE'];
+      const distinct = distinctBy(array, (a) => a.toLowerCase());
+      expect(distinct).to.deep.eq(['apple']);
+    }
+  });
+
+  test('null and undefined values', () => {
+    {
+      const array = [1, 2, null, 2, null, undefined, 3];
+      const distinct = distinctBy(array, (a) => a);
+      expect(distinct).to.deep.eq([1, 2, null, undefined, 3]);
+    }
+  });
+});

package/src/array.ts

@@ -46,3 +46,26 @@ export const diff = <A, B = A>(
 // TODO(burdon): Factor out.
 export const intersection = <A, B = A>(a: A[], b: B[], comparator: Comparator<A, B>): A[] =>
   a.filter((a) => b.find((b) => comparator(a, b)) !== undefined);
+
+/**
+ * Returns a new array with only the first instance of each unique item
+ * based on a specified property.
+ *
+ * @typeParam T - The type of items in the input array.
+ * @param array - The array to filter for distinct items.
+ * @param key - The property key to determine uniqueness for each item.
+ * @returns A new array with only distinct items based on the specified property.
+ */
+export const distinctBy = <T, K>(array: T[], selector: (item: T) => K): T[] => {
+  const seenKeys = new Set<K>();
+  return array.filter((item) => {
+    const key = selector(item);
+
+    if (seenKeys.has(key)) {
+      return false;
+    }
+
+    seenKeys.add(key);
+    return true;
+  });
+};