@dxos/util 0.8.4-main.fffef41 → 0.8.4-staging.ac66bdf99f

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 (75) hide show
  1. package/dist/lib/browser/index.mjs +311 -70
  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 +311 -70
  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/array.d.ts +3 -2
  8. package/dist/types/src/array.d.ts.map +1 -1
  9. package/dist/types/src/browser-storage.d.ts +9 -0
  10. package/dist/types/src/browser-storage.d.ts.map +1 -0
  11. package/dist/types/src/circular-buffer.d.ts +1 -0
  12. package/dist/types/src/circular-buffer.d.ts.map +1 -1
  13. package/dist/types/src/complex.d.ts +15 -0
  14. package/dist/types/src/complex.d.ts.map +1 -1
  15. package/dist/types/src/composite-key.d.ts +10 -0
  16. package/dist/types/src/composite-key.d.ts.map +1 -0
  17. package/dist/types/src/composite-key.test.d.ts +2 -0
  18. package/dist/types/src/composite-key.test.d.ts.map +1 -0
  19. package/dist/types/src/deep.d.ts +0 -3
  20. package/dist/types/src/deep.d.ts.map +1 -1
  21. package/dist/types/src/defer.d.ts +1 -1
  22. package/dist/types/src/defer.d.ts.map +1 -1
  23. package/dist/types/src/di-key.d.ts +7 -5
  24. package/dist/types/src/di-key.d.ts.map +1 -1
  25. package/dist/types/src/error-format.d.ts +5 -0
  26. package/dist/types/src/error-format.d.ts.map +1 -0
  27. package/dist/types/src/filename.d.ts +9 -0
  28. package/dist/types/src/filename.d.ts.map +1 -0
  29. package/dist/types/src/index.d.ts +5 -0
  30. package/dist/types/src/index.d.ts.map +1 -1
  31. package/dist/types/src/platform.d.ts +4 -1
  32. package/dist/types/src/platform.d.ts.map +1 -1
  33. package/dist/types/src/retry.d.ts +32 -0
  34. package/dist/types/src/retry.d.ts.map +1 -0
  35. package/dist/types/src/safe-parse.d.ts +7 -4
  36. package/dist/types/src/safe-parse.d.ts.map +1 -1
  37. package/dist/types/src/safe-stringify.d.ts +10 -1
  38. package/dist/types/src/safe-stringify.d.ts.map +1 -1
  39. package/dist/types/src/safe-stringify.test.d.ts +2 -0
  40. package/dist/types/src/safe-stringify.test.d.ts.map +1 -0
  41. package/dist/types/src/to-fallback.d.ts +18 -4
  42. package/dist/types/src/to-fallback.d.ts.map +1 -1
  43. package/dist/types/src/types.d.ts +23 -5
  44. package/dist/types/src/types.d.ts.map +1 -1
  45. package/dist/types/src/unit.d.ts.map +1 -1
  46. package/dist/types/src/weak.d.ts +15 -0
  47. package/dist/types/src/weak.d.ts.map +1 -1
  48. package/dist/types/tsconfig.tsbuildinfo +1 -1
  49. package/package.json +11 -10
  50. package/src/array.ts +9 -2
  51. package/src/browser-storage.ts +60 -0
  52. package/src/circular-buffer.test.ts +26 -0
  53. package/src/circular-buffer.ts +5 -0
  54. package/src/complex.ts +32 -0
  55. package/src/composite-key.test.ts +31 -0
  56. package/src/composite-key.ts +16 -0
  57. package/src/deep.ts +2 -6
  58. package/src/defer.ts +1 -1
  59. package/src/di-key.ts +10 -8
  60. package/src/error-format.ts +22 -0
  61. package/src/filename.ts +16 -0
  62. package/src/index.ts +5 -0
  63. package/src/platform.ts +35 -3
  64. package/src/retry.ts +74 -0
  65. package/src/safe-parse.ts +27 -16
  66. package/src/safe-stringify.test.ts +96 -0
  67. package/src/safe-stringify.ts +74 -25
  68. package/src/to-fallback.ts +39 -156
  69. package/src/types.test.ts +11 -1
  70. package/src/types.ts +39 -11
  71. package/src/unit.ts +1 -0
  72. package/src/weak.ts +52 -14
  73. package/dist/types/src/explicit-resource-management-polyfill.d.ts +0 -1
  74. package/dist/types/src/explicit-resource-management-polyfill.d.ts.map +0 -1
  75. package/src/explicit-resource-management-polyfill.ts +0 -13
package/package.json CHANGED
@@ -1,9 +1,13 @@
1
1
  {
2
2
  "name": "@dxos/util",
3
- "version": "0.8.4-main.fffef41",
3
+ "version": "0.8.4-staging.ac66bdf99f",
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",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "https://github.com/dxos/dxos"
10
+ },
7
11
  "license": "MIT",
8
12
  "author": "DXOS.org",
9
13
  "sideEffects": false,
@@ -27,17 +31,14 @@
27
31
  "src"
28
32
  ],
29
33
  "dependencies": {
30
- "lodash.get": "^4.4.2",
31
- "lodash.set": "^4.3.2",
32
- "@dxos/debug": "0.8.4-main.fffef41",
33
- "@dxos/invariant": "0.8.4-main.fffef41",
34
- "@dxos/keys": "0.8.4-main.fffef41",
35
- "@dxos/node-std": "0.8.4-main.fffef41"
34
+ "@hazae41/symbol-dispose-polyfill": "^1.0.2",
35
+ "@dxos/invariant": "0.8.4-staging.ac66bdf99f",
36
+ "@dxos/keys": "0.8.4-staging.ac66bdf99f",
37
+ "@dxos/debug": "0.8.4-staging.ac66bdf99f",
38
+ "@dxos/node-std": "0.8.4-staging.ac66bdf99f"
36
39
  },
37
40
  "devDependencies": {
38
- "@types/lodash.get": "^4.4.9",
39
- "@types/lodash.set": "^4.3.9",
40
- "@dxos/crypto": "0.8.4-main.fffef41"
41
+ "@dxos/crypto": "0.8.4-staging.ac66bdf99f"
41
42
  },
42
43
  "publishConfig": {
43
44
  "access": "public"
package/src/array.ts CHANGED
@@ -42,14 +42,14 @@ export const diff = <A, B = A>(
42
42
  return result;
43
43
  };
44
44
 
45
- export const intersection = <A, B = A>(a: A[], b: B[], comparator: Comparator<A, B>): A[] =>
45
+ export const intersection = <A, B = A>(a: readonly A[], b: readonly B[], comparator: Comparator<A, B>): A[] =>
46
46
  a.filter((a) => b.find((b) => comparator(a, b)) !== undefined);
47
47
 
48
48
  /**
49
49
  * Returns a new array with only the first instance of each unique item
50
50
  * based on a specified property.
51
51
  *
52
- * @typeParam T - The type of items in the input array.
52
+ * @typeProp T - The type of items in the input array.
53
53
  * @param array - The array to filter for distinct items.
54
54
  * @param key - The property key to determine uniqueness for each item.
55
55
  * @returns A new array with only distinct items based on the specified property.
@@ -130,3 +130,10 @@ export const intersectBy = <T, K>(arrays: T[][], selector: (item: T) => K): T[]
130
130
  return lookups.every((lookup) => lookup.has(key));
131
131
  });
132
132
  };
133
+
134
+ export const coerceArray = <T>(arr: T | T[] | undefined): T[] => {
135
+ if (arr === undefined) {
136
+ return [];
137
+ }
138
+ return Array.isArray(arr) ? arr : [arr];
139
+ };
@@ -0,0 +1,60 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ /** Delete all IndexedDB databases for this origin. */
6
+ export const clearIndexedDB = async (): Promise<void> => {
7
+ const dbs = await indexedDB.databases();
8
+ const results = await Promise.allSettled(
9
+ dbs
10
+ .filter((db) => db.name != null)
11
+ .map(
12
+ (db) =>
13
+ new Promise<void>((resolve, reject) => {
14
+ const request = indexedDB.deleteDatabase(db.name!);
15
+ request.onsuccess = () => resolve();
16
+ request.onerror = () => reject(request.error);
17
+ request.onblocked = () => reject(new Error(`IndexedDB deletion blocked: ${db.name}`));
18
+ }),
19
+ ),
20
+ );
21
+ const failures = results.filter((r): r is PromiseRejectedResult => r.status === 'rejected');
22
+ if (failures.length > 0) {
23
+ throw new AggregateError(
24
+ failures.map((r) => r.reason),
25
+ 'Failed to delete some IndexedDB databases',
26
+ );
27
+ }
28
+ };
29
+
30
+ /** Remove all entries from the Origin Private File System. */
31
+ export const clearOPFS = async (): Promise<void> => {
32
+ const root = await navigator.storage.getDirectory();
33
+ const errors: unknown[] = [];
34
+ for await (const [name] of root.entries()) {
35
+ try {
36
+ await root.removeEntry(name, { recursive: true });
37
+ } catch (err) {
38
+ errors.push(err);
39
+ }
40
+ }
41
+ if (errors.length > 0) {
42
+ throw new AggregateError(errors, 'Failed to remove some OPFS entries');
43
+ }
44
+ };
45
+
46
+ /** Unregister all service workers for this origin. */
47
+ export const clearServiceWorkers = async (): Promise<void> => {
48
+ const regs = await navigator.serviceWorker.getRegistrations();
49
+ for (const reg of regs) {
50
+ await reg.unregister();
51
+ }
52
+ };
53
+
54
+ /** Delete all HTTP caches for this origin. */
55
+ export const clearCaches = async (): Promise<void> => {
56
+ const keys = await caches.keys();
57
+ for (const key of keys) {
58
+ await caches.delete(key);
59
+ }
60
+ };
@@ -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;
package/src/complex.ts CHANGED
@@ -214,6 +214,38 @@ export class ComplexMap<K, V> implements Map<K, V> {
214
214
  return this;
215
215
  }
216
216
 
217
+ /**
218
+ * Returns the value for the given key if present, otherwise inserts and returns the default value.
219
+ * @param key - The key to look up or insert.
220
+ * @param defaultValue - The value to insert if the key is not present.
221
+ * @returns The existing or newly inserted value.
222
+ */
223
+ getOrInsert(key: K, defaultValue: V): V {
224
+ const primitive = this._keyProjection(key);
225
+ if (this._values.has(primitive)) {
226
+ return this._values.get(primitive)!;
227
+ }
228
+ this.set(key, defaultValue);
229
+ return defaultValue;
230
+ }
231
+
232
+ /**
233
+ * Returns the value for the given key if present, otherwise computes, inserts, and returns a new value.
234
+ * The callback is only invoked when the key is missing.
235
+ * @param key - The key to look up or insert.
236
+ * @param callbackfn - Function to compute the value if the key is not present.
237
+ * @returns The existing or newly computed value.
238
+ */
239
+ getOrInsertComputed(key: K, callbackfn: (key: K) => V): V {
240
+ const primitive = this._keyProjection(key);
241
+ if (this._values.has(primitive)) {
242
+ return this._values.get(primitive)!;
243
+ }
244
+ const value = callbackfn(key);
245
+ this.set(key, value);
246
+ return value;
247
+ }
248
+
217
249
  get size(): number {
218
250
  return this._keys.size;
219
251
  }
@@ -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.
@@ -19,6 +13,8 @@ export const setDeep = <T>(obj: any, path: readonly (string | number)[], value:
19
13
  let parent = obj;
20
14
  for (const key of path.slice(0, -1)) {
21
15
  if (parent[key] === undefined) {
16
+ // TODO(wittjosiah): This logic is flawed. This shouldn't be used for initializing arrays.
17
+ // Prefer `Obj.setValue` for ECHO objects.
22
18
  const isArrayIndex = !isNaN(Number(key));
23
19
  parent[key] = isArrayIndex ? [] : {};
24
20
  }
package/src/defer.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
- import './explicit-resource-management-polyfill';
5
+ import '@hazae41/symbol-dispose-polyfill';
6
6
 
7
7
  /**
8
8
  * Run function on scope exit. Go style.
package/src/di-key.ts CHANGED
@@ -47,7 +47,7 @@ export type DiKey<T> =
47
47
  }
48
48
  | SymbolDiKey<T>;
49
49
 
50
- export const DiKey = new (class DiKeyConstructor {
50
+ class DiKeyConstructor {
51
51
  /**
52
52
  * Needed to ensure referential equality of combined keys.
53
53
  *
@@ -57,7 +57,7 @@ export const DiKey = new (class DiKeyConstructor {
57
57
  */
58
58
  // TODO(dmaretskyi): Disable private members lowering for dev env.
59
59
  // TODO(dmaretskyi): Could be a weak map after a NodeJS upgrade.
60
- #combinedRegistry = new WeakMap();
60
+ private _combinedRegistry = new WeakMap();
61
61
 
62
62
  define<T>(name: string): DiKey<T> {
63
63
  return new SymbolDiKey(name);
@@ -88,24 +88,26 @@ export const DiKey = new (class DiKeyConstructor {
88
88
  * Maintains referential equality: `DiKey.combine(A, B) === DiKey.combine(A, B)`
89
89
  */
90
90
  combine(...ids: DiKey<any>[]) {
91
- const map = this.#lookupCombined(this.#combinedRegistry, ids);
92
- return defaultMap(this.#combinedRegistry, map, () => this.#combinedDescription(ids));
91
+ const map = this._lookupCombined(this._combinedRegistry, ids);
92
+ return defaultMap(this._combinedRegistry, map, () => this._combinedDescription(ids));
93
93
  }
94
94
 
95
95
  getSingletonFactory<T>(id: DiKey<T>): SingletonFactory<T> | undefined {
96
96
  return (id as any)[symbolSingleton];
97
97
  }
98
98
 
99
- #lookupCombined(map: WeakMap<any, any>, [first, ...rest]: DiKey<any>[]): WeakMap<any, any> {
99
+ private _lookupCombined(map: WeakMap<any, any>, [first, ...rest]: DiKey<any>[]): WeakMap<any, any> {
100
100
  const value = defaultMap(map, first, () => new Map());
101
101
  if (rest.length > 0) {
102
- return this.#lookupCombined(value, rest);
102
+ return this._lookupCombined(value, rest);
103
103
  } else {
104
104
  return value;
105
105
  }
106
106
  }
107
107
 
108
- #combinedDescription([first, ...rest]: DiKey<any>[]) {
108
+ private _combinedDescription([first, ...rest]: DiKey<any>[]) {
109
109
  return `${this.stringify(first)}<${rest.map(this.stringify).join(', ')}>`;
110
110
  }
111
- })();
111
+ }
112
+
113
+ export const DiKey = new DiKeyConstructor();
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Formats an error with its cause chain.
3
+ */
4
+ //
5
+ // Copyright 2025 DXOS.org
6
+ //
7
+
8
+ export const formatErrorWithCauses = (error: Error): string => {
9
+ const lines: string[] = [];
10
+ let current: Error | undefined = error;
11
+ let level = 0;
12
+
13
+ while (current) {
14
+ const prefix = level === 0 ? '' : `Caused by: `;
15
+ lines.push(prefix + (current.stack ?? String(current)));
16
+ if (!(current.cause instanceof Error)) break;
17
+ current = current.cause;
18
+ level += 1;
19
+ }
20
+
21
+ return lines.join('\n\n');
22
+ };
@@ -0,0 +1,16 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ /**
6
+ * Creates a unique filename.
7
+ */
8
+ export const createFilename = ({
9
+ parts = [],
10
+ ext,
11
+ date = new Date(),
12
+ }: {
13
+ parts?: string[];
14
+ ext?: string;
15
+ date?: Date;
16
+ }) => [date.toISOString().replace(/[:.]/g, '-'), ...parts].join('_') + (ext ? `.${ext}` : '');
package/src/index.ts CHANGED
@@ -7,6 +7,7 @@ export * from './array';
7
7
  export * from './assume';
8
8
  export * from './binder';
9
9
  export * from './bitfield';
10
+ export * from './browser-storage';
10
11
  export * from './callback-collection';
11
12
  export * from './callback';
12
13
  export * from './case';
@@ -14,10 +15,13 @@ export * from './chunk-array';
14
15
  export * from './circular-buffer';
15
16
  export * from './clear-undefined';
16
17
  export * from './complex';
18
+ export * from './composite-key';
17
19
  export * from './deep';
18
20
  export * from './defer-function';
19
21
  export * from './defer';
20
22
  export * from './entry';
23
+ export * from './error-format';
24
+ export * from './filename';
21
25
  export * from './for-each-async';
22
26
  export * from './human-hash';
23
27
  export * from './instance-id';
@@ -37,6 +41,7 @@ export * from './random';
37
41
  export * from './range';
38
42
  export * from './reducers';
39
43
  export * from './remove-undefined-keys';
44
+ export * from './retry';
40
45
  export * from './safe-await';
41
46
  export * from './safe-instanceof';
42
47
  export * from './safe-parse';
package/src/platform.ts CHANGED
@@ -5,12 +5,44 @@
5
5
  // NOTE: `!=` is required.
6
6
  export const isNode = () => typeof process !== 'undefined' && process.versions != null && process.versions.node != null;
7
7
 
8
+ export const isBun = () => (globalThis as any).Bun !== undefined;
9
+
10
+ export const isTauri = () => !!(globalThis as any).__TAURI__;
11
+
8
12
  /* eslint-disable */
9
13
 
10
14
  // From https://stackoverflow.com/a/11381730/2804332.
11
- export const mobileAndTabletCheck = () => {
15
+ export const isMobile = () => {
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
+ };
31
+
32
+ export const isMobileOrTablet = () => {
12
33
  let check = false;
13
- ((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);
14
46
  return check;
15
47
  };
16
48
 
@@ -34,7 +66,7 @@ export const safariCheck = () =>
34
66
  */
35
67
  // From https://flaming.codes/posts/how-to-determine-os-in-browser.
36
68
  export const getHostPlatform = () => {
37
- if (!('navigator' in window)) {
69
+ if (!('navigator' in globalThis)) {
38
70
  return 'unknown';
39
71
  }
40
72
 
package/src/retry.ts ADDED
@@ -0,0 +1,74 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ export interface RetryOptions<T> {
6
+ /**
7
+ * @default 3
8
+ */
9
+ count?: number;
10
+
11
+ /**
12
+ * @default 100
13
+ */
14
+ delayMs?: number;
15
+
16
+ /**
17
+ * Factor to increase delay by.
18
+ * @default 2
19
+ */
20
+ exponent?: number;
21
+
22
+ /**
23
+ * Retry if error matches the predicate.
24
+ * @default () => true
25
+ */
26
+ retryOnError?: (error: unknown) => Promise<boolean>;
27
+
28
+ /**
29
+ * Retry if value matches the predicate.
30
+ * @default () => false
31
+ */
32
+ retryOnValue?: (value: T) => Promise<boolean>;
33
+ }
34
+
35
+ const DEFAULT_RETRY_OPTIONS: Required<RetryOptions<unknown>> = {
36
+ count: 3,
37
+ delayMs: 100,
38
+ exponent: 2,
39
+ retryOnError: async () => true,
40
+ retryOnValue: async () => false,
41
+ };
42
+
43
+ /**
44
+ * Retries the operation a number of times.
45
+ * @returns The result of the succesfull invocation
46
+ * @throws Last error if all retries failed
47
+ */
48
+ export const retry = async <T>(options: RetryOptions<T>, cb: () => Promise<T>): Promise<T> => {
49
+ const fullOptions: Required<RetryOptions<T>> = { ...DEFAULT_RETRY_OPTIONS, ...options };
50
+
51
+ let numRetries = 0,
52
+ currentDelay = fullOptions.delayMs;
53
+ while (true) {
54
+ let result: T;
55
+ try {
56
+ result = await cb();
57
+ } catch (err) {
58
+ if (numRetries > fullOptions.count || !(await fullOptions.retryOnError(err))) {
59
+ throw err;
60
+ }
61
+ await new Promise((resolve) => setTimeout(resolve, currentDelay));
62
+ currentDelay *= fullOptions.exponent;
63
+ numRetries++;
64
+ continue;
65
+ }
66
+ if (!(await fullOptions.retryOnValue(result))) {
67
+ return result;
68
+ }
69
+ await new Promise((resolve) => setTimeout(resolve, currentDelay));
70
+ currentDelay *= fullOptions.exponent;
71
+ numRetries++;
72
+ continue;
73
+ }
74
+ };
package/src/safe-parse.ts CHANGED
@@ -2,34 +2,45 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
- export const safeParseInt = (value: string | undefined, defaultValue?: number) => {
5
+ export function safeParseInt(str: string | undefined, defaultValue: number): number;
6
+ export function safeParseInt(str: string | undefined): number | undefined;
7
+ export function safeParseInt(str: string | undefined, defaultValue?: number): number | undefined {
6
8
  try {
7
- const n = parseInt(value ?? '');
8
- return isNaN(n) ? defaultValue : n;
9
+ const value = parseInt(str ?? '');
10
+ return isNaN(value) ? defaultValue : value;
9
11
  } catch {
10
12
  return defaultValue;
11
13
  }
12
- };
14
+ }
13
15
 
14
- export const safeParseFloat = (str: string, defaultValue?: number): number | undefined => {
16
+ export function safeParseFloat(str: string | undefined, defaultValue: number): number;
17
+ export function safeParseFloat(str: string | undefined): number | undefined;
18
+ export function safeParseFloat(str: string | undefined, defaultValue?: number): number | undefined {
15
19
  try {
16
- return parseFloat(str);
20
+ const value = parseFloat(str ?? '');
21
+ return isNaN(value) ? defaultValue : value;
17
22
  } catch {
18
- return defaultValue ?? 0;
23
+ return defaultValue;
19
24
  }
20
- };
25
+ }
21
26
 
22
27
  export const safeParseJson: {
23
- <T extends object>(data: string | undefined | null, defaultValue: T): T;
24
- <T extends object>(data: string | undefined | null): T | undefined;
25
- } = <T extends object = any>(data: string | undefined | null, defaultValue?: T): T | undefined => {
26
- if (data && data.length > 0) {
28
+ <T extends object>(str: string | undefined | null, defaultValue: T): T;
29
+ <T extends object>(str: string | undefined | null): T | undefined;
30
+ } = <T extends object = any>(str: string | undefined | null, defaultValue?: T): T | undefined => {
31
+ if (str && str.length > 0) {
27
32
  try {
28
- return JSON.parse(data);
29
- } catch {
30
- // no-op.
31
- }
33
+ return JSON.parse(str);
34
+ } catch {}
32
35
  }
33
36
 
34
37
  return defaultValue;
35
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
+ };