@dxos/util 0.8.4-main.bc674ce โ†’ 0.8.4-main.bd9b33e6c8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/dist/lib/browser/index.mjs +41 -30
  2. package/dist/lib/browser/index.mjs.map +4 -4
  3. package/dist/lib/browser/meta.json +1 -1
  4. package/dist/lib/node-esm/index.mjs +41 -30
  5. package/dist/lib/node-esm/index.mjs.map +4 -4
  6. package/dist/lib/node-esm/meta.json +1 -1
  7. package/dist/types/src/circular-buffer.d.ts +1 -0
  8. package/dist/types/src/circular-buffer.d.ts.map +1 -1
  9. package/dist/types/src/composite-key.d.ts +10 -0
  10. package/dist/types/src/composite-key.d.ts.map +1 -0
  11. package/dist/types/src/composite-key.test.d.ts +2 -0
  12. package/dist/types/src/composite-key.test.d.ts.map +1 -0
  13. package/dist/types/src/deep.d.ts +0 -3
  14. package/dist/types/src/deep.d.ts.map +1 -1
  15. package/dist/types/src/index.d.ts +1 -0
  16. package/dist/types/src/index.d.ts.map +1 -1
  17. package/dist/types/src/platform.d.ts.map +1 -1
  18. package/dist/types/src/safe-parse.d.ts +1 -0
  19. package/dist/types/src/safe-parse.d.ts.map +1 -1
  20. package/dist/types/src/safe-stringify.d.ts +1 -1
  21. package/dist/types/src/safe-stringify.d.ts.map +1 -1
  22. package/dist/types/src/safe-stringify.test.d.ts +2 -0
  23. package/dist/types/src/safe-stringify.test.d.ts.map +1 -0
  24. package/dist/types/src/to-fallback.d.ts +18 -4
  25. package/dist/types/src/to-fallback.d.ts.map +1 -1
  26. package/dist/types/src/types.d.ts +1 -1
  27. package/dist/types/src/types.d.ts.map +1 -1
  28. package/dist/types/tsconfig.tsbuildinfo +1 -1
  29. package/package.json +6 -10
  30. package/src/circular-buffer.test.ts +26 -0
  31. package/src/circular-buffer.ts +5 -0
  32. package/src/composite-key.test.ts +31 -0
  33. package/src/composite-key.ts +16 -0
  34. package/src/deep.ts +0 -6
  35. package/src/index.ts +1 -0
  36. package/src/platform.ts +28 -6
  37. package/src/safe-parse.ts +8 -0
  38. package/src/safe-stringify.test.ts +96 -0
  39. package/src/safe-stringify.ts +15 -8
  40. package/src/to-fallback.ts +39 -156
  41. package/src/types.ts +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dxos/util",
3
- "version": "0.8.4-main.bc674ce",
3
+ "version": "0.8.4-main.bd9b33e6c8",
4
4
  "description": "Temporary bucket for misc functions, which should graduate into separate packages.",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
@@ -32,17 +32,13 @@
32
32
  ],
33
33
  "dependencies": {
34
34
  "@hazae41/symbol-dispose-polyfill": "^1.0.2",
35
- "lodash.get": "^4.4.2",
36
- "lodash.set": "^4.3.2",
37
- "@dxos/debug": "0.8.4-main.bc674ce",
38
- "@dxos/keys": "0.8.4-main.bc674ce",
39
- "@dxos/node-std": "0.8.4-main.bc674ce",
40
- "@dxos/invariant": "0.8.4-main.bc674ce"
35
+ "@dxos/invariant": "0.8.4-main.bd9b33e6c8",
36
+ "@dxos/keys": "0.8.4-main.bd9b33e6c8",
37
+ "@dxos/debug": "0.8.4-main.bd9b33e6c8",
38
+ "@dxos/node-std": "0.8.4-main.bd9b33e6c8"
41
39
  },
42
40
  "devDependencies": {
43
- "@types/lodash.get": "^4.4.9",
44
- "@types/lodash.set": "^4.3.9",
45
- "@dxos/crypto": "0.8.4-main.bc674ce"
41
+ "@dxos/crypto": "0.8.4-main.bd9b33e6c8"
46
42
  },
47
43
  "publishConfig": {
48
44
  "access": "public"
@@ -16,6 +16,32 @@ describe('CircularBuffer', () => {
16
16
  }
17
17
  });
18
18
 
19
+ test('clear resets buffer', () => {
20
+ const buffer = new CircularBuffer<number>(5);
21
+ buffer.push(1);
22
+ buffer.push(2);
23
+ buffer.push(3);
24
+ expect(buffer.elementCount).toBe(3);
25
+
26
+ buffer.clear();
27
+ expect(buffer.elementCount).toBe(0);
28
+ expect([...buffer]).toStrictEqual([]);
29
+ expect(buffer.getLast()).toBeUndefined();
30
+ });
31
+
32
+ test('clear allows reuse', () => {
33
+ const buffer = new CircularBuffer<number>(3);
34
+ buffer.push(10);
35
+ buffer.push(20);
36
+ buffer.clear();
37
+
38
+ buffer.push(30);
39
+ buffer.push(40);
40
+ expect(buffer.elementCount).toBe(2);
41
+ expect([...buffer]).toStrictEqual([30, 40]);
42
+ expect(buffer.getLast()).toBe(40);
43
+ });
44
+
19
45
  test('full cycle', () => {
20
46
  const maxSize = 10;
21
47
  const regularArray: number[] = [];
@@ -26,6 +26,11 @@ export class CircularBuffer<T> {
26
26
  return this._elementCount;
27
27
  }
28
28
 
29
+ public clear(): void {
30
+ this._nextIndex = 0;
31
+ this._elementCount = 0;
32
+ }
33
+
29
34
  public getLast(): T | undefined {
30
35
  if (this._elementCount === 0) {
31
36
  return undefined;
@@ -0,0 +1,31 @@
1
+ //
2
+ // Copyright 2026 DXOS.org
3
+ //
4
+
5
+ import { describe, test } from 'vitest';
6
+
7
+ import { compositeKey, splitCompositeKey } from './composite-key';
8
+
9
+ describe('compositeKey', () => {
10
+ test('joins parts with colon', ({ expect }) => {
11
+ expect(compositeKey('a', 'b', 'c')).to.eq('a:b:c');
12
+ });
13
+
14
+ test('single part returns as-is', ({ expect }) => {
15
+ expect(compositeKey('only')).to.eq('only');
16
+ });
17
+
18
+ test('handles empty strings in parts', ({ expect }) => {
19
+ expect(compositeKey('', 'b')).to.eq(':b');
20
+ });
21
+ });
22
+
23
+ describe('splitCompositeKey', () => {
24
+ test('splits on colon', ({ expect }) => {
25
+ expect(splitCompositeKey('a:b:c')).to.deep.eq(['a', 'b', 'c']);
26
+ });
27
+
28
+ test('single part returns array of one', ({ expect }) => {
29
+ expect(splitCompositeKey('only')).to.deep.eq(['only']);
30
+ });
31
+ });
@@ -0,0 +1,16 @@
1
+ //
2
+ // Copyright 2026 DXOS.org
3
+ //
4
+
5
+ const SEPARATOR = ':';
6
+
7
+ /**
8
+ * Build a composite key from string parts joined by a colon separator.
9
+ * Parts must not contain the separator character.
10
+ */
11
+ export const compositeKey = (...parts: string[]): string => parts.join(SEPARATOR);
12
+
13
+ /**
14
+ * Split a composite key back into its parts.
15
+ */
16
+ export const splitCompositeKey = (key: string): string[] => key.split(SEPARATOR);
package/src/deep.ts CHANGED
@@ -2,14 +2,8 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
- import get from 'lodash.get';
6
- import set from 'lodash.set';
7
-
8
5
  import { invariant } from '@dxos/invariant';
9
6
 
10
- // TODO(burdon): Re-export most common utils? (isEqual, defaultsDeep, merge, omit, pick, etc.)
11
- export { get, set };
12
-
13
7
  /**
14
8
  * Initialize a deeply nested object.
15
9
  * @returns The value of the prop after assignment.
package/src/index.ts CHANGED
@@ -14,6 +14,7 @@ export * from './chunk-array';
14
14
  export * from './circular-buffer';
15
15
  export * from './clear-undefined';
16
16
  export * from './complex';
17
+ export * from './composite-key';
17
18
  export * from './deep';
18
19
  export * from './defer-function';
19
20
  export * from './defer';
package/src/platform.ts CHANGED
@@ -13,14 +13,36 @@ export const isTauri = () => !!(globalThis as any).__TAURI__;
13
13
 
14
14
  // From https://stackoverflow.com/a/11381730/2804332.
15
15
  export const isMobile = () => {
16
- let check = false;
17
- (function(a){if(/(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino/i.test(a)||/1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i.test(a.substr(0,4))) { check = true; } })(navigator.userAgent || navigator.vendor || (window as any).opera);
18
- return check;
19
- };
16
+ let check = false;
17
+ (function (a) {
18
+ if (
19
+ /(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino/i.test(
20
+ a,
21
+ ) ||
22
+ /1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i.test(
23
+ a.substr(0, 4),
24
+ )
25
+ ) {
26
+ check = true;
27
+ }
28
+ })(navigator.userAgent || navigator.vendor || (window as any).opera);
29
+ return check;
30
+ };
20
31
 
21
32
  export const isMobileOrTablet = () => {
22
33
  let check = false;
23
- ((a) => { if (/(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino|android|ipad|playbook|silk/i.test(a) || /1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i.test(a.substr(0,4))) { check = true; } })(navigator.userAgent || navigator.vendor || (window as any).opera);
34
+ ((a) => {
35
+ if (
36
+ /(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino|android|ipad|playbook|silk/i.test(
37
+ a,
38
+ ) ||
39
+ /1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i.test(
40
+ a.substr(0, 4),
41
+ )
42
+ ) {
43
+ check = true;
44
+ }
45
+ })(navigator.userAgent || navigator.vendor || (window as any).opera);
24
46
  return check;
25
47
  };
26
48
 
@@ -44,7 +66,7 @@ export const safariCheck = () =>
44
66
  */
45
67
  // From https://flaming.codes/posts/how-to-determine-os-in-browser.
46
68
  export const getHostPlatform = () => {
47
- if (!('navigator' in window)) {
69
+ if (!('navigator' in globalThis)) {
48
70
  return 'unknown';
49
71
  }
50
72
 
package/src/safe-parse.ts CHANGED
@@ -36,3 +36,11 @@ export const safeParseJson: {
36
36
 
37
37
  return defaultValue;
38
38
  };
39
+
40
+ export const safeUrl = (str: string | undefined | null): URL | undefined => {
41
+ try {
42
+ return new URL(str ?? '');
43
+ } catch {
44
+ return undefined;
45
+ }
46
+ };
@@ -0,0 +1,96 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { describe, test } from 'vitest';
6
+
7
+ import { SKIP, createReplacer, safeStringify } from './safe-stringify';
8
+
9
+ describe('safeStringify', () => {
10
+ test('stringifies plain nested objects', ({ expect }) => {
11
+ const data = { a: 1, b: { c: 'hello' } };
12
+ const result = safeStringify(data);
13
+ expect(result).to.include('"a": 1');
14
+ expect(result).to.include('"b"');
15
+ expect(result).to.include('"c": "hello"');
16
+ });
17
+
18
+ test('handles circular references (Cycle story)', ({ expect }) => {
19
+ const cycle: Record<string, unknown> = { a: 1, b: [] };
20
+ (cycle.b as unknown[]).push(cycle);
21
+
22
+ const result = safeStringify(cycle);
23
+ expect(result).to.include('"a": 1');
24
+ expect(result).to.include('=> $]');
25
+ expect(result).to.match(/\[\$\.b\.\d+ => \$\]/);
26
+ });
27
+
28
+ test('handles multiple circular references', ({ expect }) => {
29
+ const obj: Record<string, unknown> = { x: 1 };
30
+ obj.self = obj;
31
+
32
+ const result = safeStringify(obj);
33
+ expect(result).to.include('"x": 1');
34
+ expect(result).to.include('[$.self => $]');
35
+ });
36
+
37
+ test('filters functions', ({ expect }) => {
38
+ const data = { a: 1, fn: () => {} };
39
+ const result = safeStringify(data);
40
+ expect(result).to.include('"a": 1');
41
+ expect(result).not.to.include('fn');
42
+ });
43
+
44
+ test('filters exotic objects', ({ expect }) => {
45
+ class Custom {}
46
+ const data = { a: 1, exotic: new Custom() };
47
+ const result = safeStringify(data);
48
+ expect(result).to.include('"a": 1');
49
+ expect(result).not.to.include('exotic');
50
+ });
51
+
52
+ test('preserves arrays', ({ expect }) => {
53
+ const data = { arr: [1, 2, 3] };
54
+ const result = safeStringify(data);
55
+ expect(result).to.include('"arr"');
56
+ expect(result).to.include('1');
57
+ expect(result).to.include('2');
58
+ expect(result).to.include('3');
59
+ });
60
+ });
61
+
62
+ describe('createReplacer', () => {
63
+ test('maxArrayLen truncates long arrays (Large story)', ({ expect }) => {
64
+ const data = { arr: Array.from({ length: 15 }, (_, index) => index) };
65
+ const result = safeStringify(data, createReplacer({ maxArrayLen: 10 }));
66
+ expect(result).to.include('"[length: 15]"');
67
+ });
68
+
69
+ test('maxStringLen truncates long strings (Large story)', ({ expect }) => {
70
+ const data = { str: 'a'.repeat(20) };
71
+ const result = safeStringify(data, createReplacer({ maxStringLen: 10 }));
72
+ expect(result).to.include('"aaaaaaaaaa..."');
73
+ });
74
+
75
+ test('omit skips specified keys', ({ expect }) => {
76
+ const data = { a: 1, secret: 'hide', b: 2 };
77
+ const result = safeStringify(data, createReplacer({ omit: ['secret'] }));
78
+ expect(result).to.include('"a": 1');
79
+ expect(result).to.include('"b": 2');
80
+ expect(result).not.to.include('secret');
81
+ });
82
+
83
+ test('parse parses JSON string values', ({ expect }) => {
84
+ const data = { nested: '{"x":1}' };
85
+ const result = safeStringify(data, createReplacer({ parse: ['nested'] }));
86
+ expect(result).to.include('"x": 1');
87
+ });
88
+
89
+ test('SKIP return value removes key from output', ({ expect }) => {
90
+ const customReplacer = (_key: string, value: unknown) => (_key === 'skip' ? SKIP : value);
91
+ const data = { a: 1, skip: 'hidden' };
92
+ const result = safeStringify(data, customReplacer);
93
+ expect(result).to.include('"a": 1');
94
+ expect(result).not.to.include('skip');
95
+ });
96
+ });
@@ -12,7 +12,7 @@ export type StringifyReplacer = (key: string, value: any) => typeof SKIP | any;
12
12
  /**
13
13
  * Safely stringifies an object.
14
14
  */
15
- export function safeStringify(obj: any, filter: StringifyReplacer = defaultFilter, indent = 2) {
15
+ export function safeStringify(obj: any, filter: StringifyReplacer | undefined = defaultFilter, indent = 2) {
16
16
  const seen = new WeakMap<object, string>();
17
17
 
18
18
  // NOTE: Called for the root object with undefined key.
@@ -21,6 +21,9 @@ export function safeStringify(obj: any, filter: StringifyReplacer = defaultFilte
21
21
  let path = key;
22
22
  if (!key) {
23
23
  path = '$';
24
+ if (value != null && typeof value === 'object') {
25
+ seen.set(value, path);
26
+ }
24
27
  return value;
25
28
  } else if (this) {
26
29
  const parentPath = seen.get(this);
@@ -38,7 +41,7 @@ export function safeStringify(obj: any, filter: StringifyReplacer = defaultFilte
38
41
  }
39
42
 
40
43
  // Ignore exotic objects (non-plain objects like DOM elements, class instances, etc.)
41
- if (typeof value === 'object' && Object.getPrototypeOf(value) !== Object.prototype) {
44
+ if (typeof value === 'object' && Object.getPrototypeOf(value) !== Object.prototype && !Array.isArray(value)) {
42
45
  return undefined;
43
46
  }
44
47
 
@@ -65,7 +68,11 @@ export function safeStringify(obj: any, filter: StringifyReplacer = defaultFilte
65
68
  }
66
69
  }
67
70
 
68
- return JSON.stringify(obj, replacer, indent);
71
+ try {
72
+ return JSON.stringify(obj, replacer, indent);
73
+ } catch (error: any) {
74
+ return `ERROR: ${error.message}`;
75
+ }
69
76
  }
70
77
 
71
78
  export type CreateReplacerProps = {
@@ -105,6 +112,11 @@ export const createReplacer = ({
105
112
  return SKIP;
106
113
  }
107
114
 
115
+ // Show array length.
116
+ if (maxArrayLen != null && Array.isArray(value) && value.length > maxArrayLen) {
117
+ return `[length: ${value.length}]`;
118
+ }
119
+
108
120
  // Store depth for this object.
109
121
  if (value && typeof value === 'object') {
110
122
  depthMap.set(value, currentDepth);
@@ -129,11 +141,6 @@ export const createReplacer = ({
129
141
  }
130
142
  }
131
143
 
132
- // Show array length.
133
- if (maxArrayLen != null && Array.isArray(value) && value.length > maxArrayLen) {
134
- return `[length: ${value.length}]`;
135
- }
136
-
137
144
  // Truncate strings.
138
145
  if (maxStringLen != null && typeof value === 'string' && value.length > maxStringLen) {
139
146
  return value.slice(0, maxStringLen) + '...';
@@ -4,166 +4,55 @@
4
4
 
5
5
  import { type PublicKey } from '@dxos/keys';
6
6
 
7
+ /**
8
+ * When changing this set, please check the result in a console or e.g. RunKit (https://runkit.com/thure/642214441dd6ae000855a8de)
9
+ * 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.
10
+ * This set was chosen from the characters in Unicode Emoji v15.0 based on the following criteria:
11
+ * โ€“ not people or isolated anthropomorphic faces
12
+ * โ€“ not flags
13
+ * โ€“ more concrete than abstract
14
+ * โ€“ less culturally specific
15
+ * โ€“ less easily confused with another emoji in the set
16
+ * โ€“ requires less special knowledge to identify
17
+ * โ€“ less likely to evoke negative feelings (no meat, no drugs, no weapons, etc)
18
+ * โ€“ less common as a signifier in UX
19
+ * NOTE that this is intentionally an array of strings because of the way emoji graphemes work.
20
+ */
21
+ // prettier-ignore
7
22
  export const idEmoji = [
8
- // When changing this set, please check the result in a console or e.g. RunKit (https://runkit.com/thure/642214441dd6ae000855a8de)
9
- // 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.
10
- // This set was chosen from the characters in Unicode Emoji v15.0 based on the following criteria:
11
- // โ€“ not people or isolated anthropomorphic faces
12
- // โ€“ not flags
13
- // โ€“ more concrete than abstract
14
- // โ€“ less culturally specific
15
- // โ€“ less easily confused with another emoji in the set
16
- // โ€“ requires less special knowledge to identify
17
- // โ€“ less likely to evoke negative feelings (no meat, no drugs, no weapons, etc)
18
- // โ€“ less common as a signifier in UX
19
- // NOTE that this is intentionally an array of strings because of the way emoji graphemes work.
20
- '๐Ÿ‘ป',
21
- '๐Ÿ‘น',
22
- '๐Ÿ‘ฝ',
23
- '๐Ÿค–',
24
- '๐ŸŽƒ',
25
- '๐Ÿฆพ',
26
- '๐Ÿฆฟ',
27
- '๐Ÿฆท',
28
- '๐Ÿ‘ฃ',
29
- '๐Ÿ‘๏ธ',
30
- '๐Ÿงถ',
31
- '๐Ÿ‘‘',
32
- '๐Ÿ’',
33
- '๐Ÿฆ†',
34
- '๐Ÿฆ‰',
35
- '๐Ÿด',
36
- '๐Ÿฆ„',
37
- '๐Ÿ',
38
- '๐Ÿฆ‹',
39
- '๐Ÿž',
40
- '๐Ÿชฒ',
41
- '๐Ÿข',
42
- '๐ŸฆŽ',
43
- '๐Ÿฆ•',
44
- '๐Ÿฆ‘',
45
- '๐Ÿฆ€',
46
- '๐Ÿ ',
47
- '๐Ÿฌ',
48
- '๐Ÿ‹',
49
- '๐Ÿฆญ',
50
- '๐Ÿ…',
51
- '๐Ÿ†',
52
- '๐Ÿฆ“',
53
- '๐Ÿฆ',
54
- '๐Ÿฆง',
55
- '๐Ÿ˜',
56
- '๐Ÿซ',
57
- '๐Ÿฆ’',
58
- '๐Ÿฆ˜',
59
- '๐Ÿฆฌ',
60
- '๐Ÿ–',
61
- '๐Ÿ',
62
- '๐ŸฆŒ',
63
- '๐Ÿ•',
64
- '๐Ÿˆ',
65
- '๐Ÿ“',
66
- '๐Ÿฆš',
67
- '๐Ÿฆœ',
68
- '๐Ÿฆข',
69
- '๐Ÿฆฉ',
70
- '๐Ÿฆฆ',
71
- '๐Ÿ',
72
- '๐Ÿฟ๏ธ',
73
- '๐ŸŒต',
74
- '๐ŸŒฒ',
75
- '๐ŸŒณ',
76
- '๐Ÿชต',
77
- '๐ŸŒฑ',
78
- '๐Ÿ',
79
- '๐Ÿชบ',
80
- '๐Ÿ„',
81
- '๐Ÿš',
82
- '๐Ÿชธ',
83
- '๐Ÿชจ',
84
- '๐ŸŒพ',
85
- '๐ŸŒท',
86
- '๐ŸŒป',
87
- 'โ˜€๏ธ',
88
- '๐ŸŒ™',
89
- '๐Ÿช',
90
- 'โญ๏ธ',
91
- 'โšก๏ธ',
92
- 'โ˜„๏ธ',
93
- '๐Ÿ”ฅ',
94
- '๐ŸŒˆ',
95
- 'โ˜๏ธ',
96
- '๐Ÿ’ง',
97
- 'โ›ฑ๏ธ',
98
- '๐ŸŒŠ',
99
- '๐ŸŽ',
100
- '๐Ÿ‹',
101
- '๐Ÿ‰',
102
- '๐Ÿ‡',
103
- '๐Ÿซ',
104
- '๐Ÿˆ',
105
- '๐Ÿ’',
106
- '๐Ÿ‘',
107
- '๐Ÿฅญ',
108
- '๐Ÿ',
109
- '๐Ÿฅฅ',
110
- '๐Ÿฅ',
111
- '๐Ÿฅ‘',
112
- '๐ŸŒถ๏ธ',
113
- '๐ŸŒฝ',
114
- '๐Ÿฅ•',
115
- '๐Ÿฌ',
116
- '๐Ÿฅœ',
117
- '๐Ÿซ–',
118
- 'โ˜•๏ธ',
119
- '๐Ÿต',
120
- '๐ŸงŠ',
121
- '๐Ÿง‚',
122
- '๐Ÿ”๏ธ',
123
- 'โš“๏ธ',
124
- '๐Ÿ›Ÿ',
125
- '๐Ÿ๏ธ',
126
- '๐Ÿ›ถ',
127
- '๐Ÿš€',
128
- '๐Ÿ›ฐ๏ธ',
129
- 'โ›ฒ๏ธ',
130
- '๐Ÿฐ',
131
- '๐Ÿšฒ',
132
- 'โ›บ๏ธ',
133
- '๐ŸŽ™๏ธ',
134
- '๐Ÿงฒ',
135
- 'โš™๏ธ',
136
- '๐Ÿ”ฉ',
137
- '๐Ÿ”ฎ',
138
- '๐Ÿ”ญ',
139
- '๐Ÿ”ฌ',
140
- '๐Ÿงฌ',
141
- '๐ŸŒก๏ธ',
142
- '๐Ÿงบ',
143
- '๐Ÿ›Ž๏ธ',
144
- '๐Ÿ”‘',
145
- '๐Ÿช‘',
146
- '๐Ÿงธ',
147
- '๐ŸŽˆ',
148
- '๐ŸŽ€',
149
- '๐ŸŽŠ',
150
- 'โ™ป๏ธ',
151
- '๐ŸŽต',
23
+ '๐Ÿ‘ป', '๐Ÿ‘น', '๐Ÿ‘ฝ', '๐Ÿค–', '๐ŸŽƒ', '๐Ÿฆพ', '๐Ÿฆฟ', '๐Ÿฆท',
24
+ '๐Ÿ‘ฃ', '๐Ÿ‘๏ธ', '๐Ÿงถ', '๐Ÿ‘‘', '๐Ÿ’', '๐Ÿฆ†', '๐Ÿฆ‰', '๐Ÿด',
25
+ '๐Ÿฆ„', '๐Ÿ', '๐Ÿฆ‹', '๐Ÿž', '๐Ÿชฒ', '๐Ÿข', '๐ŸฆŽ', '๐Ÿฆ•',
26
+ '๐Ÿฆ‘', '๐Ÿฆ€', '๐Ÿ ', '๐Ÿฌ', '๐Ÿ‹', '๐Ÿฆญ', '๐Ÿ…', '๐Ÿ†',
27
+ '๐Ÿฆ“', '๐Ÿฆ', '๐Ÿฆง', '๐Ÿ˜', '๐Ÿซ', '๐Ÿฆ’', '๐Ÿฆ˜', '๐Ÿฆฌ',
28
+ '๐Ÿ–', '๐Ÿ', '๐ŸฆŒ', '๐Ÿ•', '๐Ÿˆ', '๐Ÿ“', '๐Ÿฆš', '๐Ÿฆœ',
29
+ '๐Ÿฆข', '๐Ÿฆฉ', '๐Ÿฆฆ', '๐Ÿ', '๐Ÿฟ๏ธ', '๐ŸŒต', '๐ŸŒฒ', '๐ŸŒณ',
30
+ '๐Ÿชต', '๐ŸŒฑ', '๐Ÿ', '๐Ÿชบ', '๐Ÿ„', '๐Ÿš', '๐Ÿชธ', '๐Ÿชจ',
31
+ '๐ŸŒพ', '๐ŸŒท', '๐ŸŒป', 'โ˜€๏ธ', '๐ŸŒ™', '๐Ÿช', 'โญ๏ธ', 'โšก๏ธ',
32
+ 'โ˜„๏ธ', '๐Ÿ”ฅ', '๐ŸŒˆ', 'โ˜๏ธ', '๐Ÿ’ง', 'โ›ฑ๏ธ', '๐ŸŒŠ', '๐ŸŽ',
33
+ '๐Ÿ‹', '๐Ÿ‰', '๐Ÿ‡', '๐Ÿซ', '๐Ÿˆ', '๐Ÿ’', '๐Ÿ‘', '๐Ÿฅญ',
34
+ '๐Ÿ', '๐Ÿฅฅ', '๐Ÿฅ', '๐Ÿฅ‘', '๐ŸŒถ๏ธ', '๐ŸŒฝ', '๐Ÿฅ•', '๐Ÿฌ',
35
+ '๐Ÿฅœ', '๐Ÿซ–', 'โ˜•๏ธ', '๐Ÿต', '๐ŸงŠ', '๐Ÿง‚', '๐Ÿ”๏ธ', 'โš“๏ธ',
36
+ '๐Ÿ›Ÿ', '๐Ÿ๏ธ', '๐Ÿ›ถ', '๐Ÿš€', '๐Ÿ›ฐ๏ธ', 'โ›ฒ๏ธ', '๐Ÿฐ', '๐Ÿšฒ',
37
+ 'โ›บ๏ธ', '๐ŸŽ™๏ธ', '๐Ÿงฒ', 'โš™๏ธ', '๐Ÿ”ฉ', '๐Ÿ”ฎ', '๐Ÿ”ญ', '๐Ÿ”ฌ',
38
+ '๐Ÿงฌ', '๐ŸŒก๏ธ', '๐Ÿงบ', '๐Ÿ›Ž๏ธ', '๐Ÿ”‘', '๐Ÿช‘', '๐Ÿงธ', '๐ŸŽˆ',
39
+ '๐ŸŽ€', '๐ŸŽŠ', 'โ™ป๏ธ', '๐ŸŽต',
152
40
  ];
153
41
 
154
42
  export const idHue = [
155
43
  'red' as const,
156
- // 'orange' as const, /* More shades in these palettes are considered โ€œuglyโ€ */
157
- 'amber' as const, // Amber arcs between red-orange and yellow as it gets lighter, so improves aesthetics.
158
- // 'yellow' as const, /* More shades in these palettes are considered โ€œuglyโ€ */
44
+ 'orange' as const,
45
+ 'amber' as const,
46
+ 'yellow' as const,
159
47
  'lime' as const,
160
48
  'green' as const,
161
49
  'emerald' as const,
162
50
  'teal' as const,
163
51
  'cyan' as const,
164
- // 'sky' as const, /* Omitted since it is quite similar to the primary accent palette */
165
- // 'blue' as const, /* Omitted since it is quite similar to the primary accent palette */
166
- // 'indigo' as const, /* Omitted since it is quite similar to the primary accent palette */
52
+ // Omit colors similar to primary accent.
53
+ // 'sky' as const,
54
+ // 'blue' as const,
55
+ // 'indigo' as const,
167
56
  'violet' as const,
168
57
  'purple' as const,
169
58
  'fuchsia' as const,
@@ -171,17 +60,11 @@ export const idHue = [
171
60
  'rose' as const,
172
61
  ];
173
62
 
174
- // TODO(wittjosiah): Do we need all of these variants?
175
63
  export const keyToEmoji = (key: PublicKey) => keyToFallback(key).emoji;
176
-
177
64
  export const hexToEmoji = (hex: string) => hexToFallback(hex).emoji;
178
-
179
65
  export const toEmoji = (hash: number) => toFallback(hash).emoji;
180
-
181
66
  export const keyToHue = (key: PublicKey) => keyToFallback(key).hue;
182
-
183
67
  export const hexToHue = (hex: string) => hexToFallback(hex).hue;
184
-
185
68
  export const toHue = (hash: number) => toFallback(hash).hue;
186
69
 
187
70
  export type FallbackValue = {
package/src/types.ts CHANGED
@@ -10,7 +10,7 @@ export type MaybeProvider<T, V = void> = T | ((arg: V) => T);
10
10
 
11
11
  export type MaybePromise<T> = T | Promise<T>;
12
12
 
13
- export type GuardedType<T> = T extends (value: any) => value is infer R ? R : never;
13
+ export type GuardedType<T> = T extends ((value: any) => value is infer R) ? R : never;
14
14
 
15
15
  /**
16
16
  * Removes readonly modifiers from top-level properties of T.