@dxos/util 0.8.4-main.72ec0f3 → 0.8.4-main.765dc60934

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 (123) hide show
  1. package/LICENSE +102 -5
  2. package/dist/lib/browser/index.mjs +368 -154
  3. package/dist/lib/browser/index.mjs.map +4 -4
  4. package/dist/lib/browser/meta.json +1 -1
  5. package/dist/lib/node-esm/index.mjs +368 -154
  6. package/dist/lib/node-esm/index.mjs.map +4 -4
  7. package/dist/lib/node-esm/meta.json +1 -1
  8. package/dist/types/src/array-to-hex.d.ts.map +1 -1
  9. package/dist/types/src/array.d.ts +3 -2
  10. package/dist/types/src/array.d.ts.map +1 -1
  11. package/dist/types/src/binder.d.ts.map +1 -1
  12. package/dist/types/src/bitfield.d.ts.map +1 -1
  13. package/dist/types/src/browser-storage.d.ts +9 -0
  14. package/dist/types/src/browser-storage.d.ts.map +1 -0
  15. package/dist/types/src/callback-collection.d.ts.map +1 -1
  16. package/dist/types/src/callback.d.ts.map +1 -1
  17. package/dist/types/src/case.d.ts.map +1 -1
  18. package/dist/types/src/chunk-array.d.ts.map +1 -1
  19. package/dist/types/src/circular-buffer.d.ts +1 -0
  20. package/dist/types/src/circular-buffer.d.ts.map +1 -1
  21. package/dist/types/src/clear-undefined.d.ts.map +1 -1
  22. package/dist/types/src/complex.d.ts +15 -0
  23. package/dist/types/src/complex.d.ts.map +1 -1
  24. package/dist/types/src/composite-key.d.ts +10 -0
  25. package/dist/types/src/composite-key.d.ts.map +1 -0
  26. package/dist/types/src/composite-key.test.d.ts +2 -0
  27. package/dist/types/src/composite-key.test.d.ts.map +1 -0
  28. package/dist/types/src/deep.d.ts +0 -3
  29. package/dist/types/src/deep.d.ts.map +1 -1
  30. package/dist/types/src/defer-function.d.ts.map +1 -1
  31. package/dist/types/src/defer.d.ts +1 -1
  32. package/dist/types/src/defer.d.ts.map +1 -1
  33. package/dist/types/src/di-container.d.ts.map +1 -1
  34. package/dist/types/src/di-key.d.ts +7 -5
  35. package/dist/types/src/di-key.d.ts.map +1 -1
  36. package/dist/types/src/entry.d.ts.map +1 -1
  37. package/dist/types/src/error-format.d.ts +5 -0
  38. package/dist/types/src/error-format.d.ts.map +1 -0
  39. package/dist/types/src/filename.d.ts +9 -0
  40. package/dist/types/src/filename.d.ts.map +1 -0
  41. package/dist/types/src/for-each-async.d.ts.map +1 -1
  42. package/dist/types/src/human-hash.d.ts.map +1 -1
  43. package/dist/types/src/id.d.ts +30 -0
  44. package/dist/types/src/id.d.ts.map +1 -0
  45. package/dist/types/src/id.test.d.ts +2 -0
  46. package/dist/types/src/id.test.d.ts.map +1 -0
  47. package/dist/types/src/index.d.ts +6 -0
  48. package/dist/types/src/index.d.ts.map +1 -1
  49. package/dist/types/src/instance-id.d.ts.map +1 -1
  50. package/dist/types/src/interval.d.ts.map +1 -1
  51. package/dist/types/src/join-tables.d.ts.map +1 -1
  52. package/dist/types/src/json.d.ts.map +1 -1
  53. package/dist/types/src/map-values.d.ts.map +1 -1
  54. package/dist/types/src/map.d.ts.map +1 -1
  55. package/dist/types/src/object.d.ts.map +1 -1
  56. package/dist/types/src/order-keys.d.ts.map +1 -1
  57. package/dist/types/src/order.d.ts.map +1 -1
  58. package/dist/types/src/pick.d.ts.map +1 -1
  59. package/dist/types/src/platform.d.ts +5 -2
  60. package/dist/types/src/platform.d.ts.map +1 -1
  61. package/dist/types/src/position.d.ts +1 -1
  62. package/dist/types/src/position.d.ts.map +1 -1
  63. package/dist/types/src/random.d.ts.map +1 -1
  64. package/dist/types/src/range.d.ts.map +1 -1
  65. package/dist/types/src/reducers.d.ts.map +1 -1
  66. package/dist/types/src/remove-undefined-keys.d.ts.map +1 -1
  67. package/dist/types/src/retry.d.ts +32 -0
  68. package/dist/types/src/retry.d.ts.map +1 -0
  69. package/dist/types/src/safe-await.d.ts.map +1 -1
  70. package/dist/types/src/safe-instanceof.d.ts.map +1 -1
  71. package/dist/types/src/safe-parse.d.ts +7 -4
  72. package/dist/types/src/safe-parse.d.ts.map +1 -1
  73. package/dist/types/src/safe-stringify.d.ts +10 -1
  74. package/dist/types/src/safe-stringify.d.ts.map +1 -1
  75. package/dist/types/src/safe-stringify.test.d.ts +2 -0
  76. package/dist/types/src/safe-stringify.test.d.ts.map +1 -0
  77. package/dist/types/src/sliding-window-summary.d.ts.map +1 -1
  78. package/dist/types/src/sort.d.ts.map +1 -1
  79. package/dist/types/src/string.d.ts.map +1 -1
  80. package/dist/types/src/sum.d.ts.map +1 -1
  81. package/dist/types/src/throw-unhandled-error.d.ts.map +1 -1
  82. package/dist/types/src/to-fallback.d.ts +18 -4
  83. package/dist/types/src/to-fallback.d.ts.map +1 -1
  84. package/dist/types/src/tracer.d.ts.map +1 -1
  85. package/dist/types/src/tree.d.ts.map +1 -1
  86. package/dist/types/src/types.d.ts +23 -5
  87. package/dist/types/src/types.d.ts.map +1 -1
  88. package/dist/types/src/uint8array.d.ts.map +1 -1
  89. package/dist/types/src/unit.d.ts.map +1 -1
  90. package/dist/types/src/url.d.ts.map +1 -1
  91. package/dist/types/src/weak.d.ts +15 -0
  92. package/dist/types/src/weak.d.ts.map +1 -1
  93. package/dist/types/tsconfig.tsbuildinfo +1 -1
  94. package/package.json +12 -14
  95. package/src/array.ts +9 -2
  96. package/src/browser-storage.ts +60 -0
  97. package/src/circular-buffer.test.ts +26 -0
  98. package/src/circular-buffer.ts +5 -0
  99. package/src/complex.ts +32 -0
  100. package/src/composite-key.test.ts +31 -0
  101. package/src/composite-key.ts +16 -0
  102. package/src/deep.ts +2 -6
  103. package/src/defer.ts +1 -1
  104. package/src/di-key.ts +10 -8
  105. package/src/error-format.ts +24 -0
  106. package/src/filename.ts +16 -0
  107. package/src/id.test.ts +109 -0
  108. package/src/id.ts +48 -0
  109. package/src/index.ts +6 -0
  110. package/src/platform.ts +35 -3
  111. package/src/retry.ts +74 -0
  112. package/src/safe-parse.ts +27 -16
  113. package/src/safe-stringify.test.ts +96 -0
  114. package/src/safe-stringify.ts +74 -25
  115. package/src/string.ts +6 -2
  116. package/src/to-fallback.ts +39 -156
  117. package/src/types.test.ts +11 -1
  118. package/src/types.ts +39 -11
  119. package/src/unit.ts +7 -2
  120. package/src/weak.ts +52 -14
  121. package/dist/types/src/explicit-resource-management-polyfill.d.ts +0 -1
  122. package/dist/types/src/explicit-resource-management-polyfill.d.ts.map +0 -1
  123. package/src/explicit-resource-management-polyfill.ts +0 -13
package/src/types.ts CHANGED
@@ -10,15 +10,33 @@ 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;
14
-
15
- export type DeepReadonly<T> = {
16
- readonly [P in keyof T]: T[P] extends Record<string, any>
17
- ? DeepReadonly<T[P]>
18
- : T[P] extends Array<infer U>
19
- ? ReadonlyArray<DeepReadonly<U>>
20
- : T[P];
21
- };
13
+ export type GuardedType<T> = T extends ((value: any) => value is infer R) ? R : never;
14
+
15
+ /**
16
+ * Removes readonly modifiers from top-level properties of T.
17
+ * Also converts readonly arrays at the top level to mutable arrays.
18
+ * For nested properties, mutability depends on the schema definition.
19
+ */
20
+ export type ToMutable<T> = T extends object
21
+ ? { -readonly [K in keyof T]: T[K] extends readonly (infer U)[] ? U[] : T[K] }
22
+ : T;
23
+
24
+ export type Intersection<Types extends readonly unknown[]> = Types extends [infer First, ...infer Rest]
25
+ ? First & Intersection<Rest>
26
+ : unknown;
27
+
28
+ /**
29
+ * Recursively makes all properties of T readonly.
30
+ * Primitives (including branded types like `string & { __brand: true }`) are returned as-is.
31
+ * Arrays become ReadonlyArrays with deeply readonly elements.
32
+ */
33
+ export type DeepReadonly<T> = T extends string | number | boolean | bigint | symbol | null | undefined
34
+ ? T // Primitives (including branded primitives) stay as-is.
35
+ : T extends Array<infer U>
36
+ ? ReadonlyArray<DeepReadonly<U>>
37
+ : T extends object
38
+ ? { readonly [P in keyof T]: DeepReadonly<T[P]> }
39
+ : T;
22
40
 
23
41
  export type DeepWriteable<T> = { -readonly [K in keyof T]: T[K] extends object ? DeepWriteable<T[K]> : T[K] };
24
42
 
@@ -104,9 +122,19 @@ export const sortKeys = <T extends object>(obj: T): T =>
104
122
  }, {} as T);
105
123
 
106
124
  /**
107
- * Swap position of element within array.
125
+ * Move element within array.
108
126
  */
109
- export const arrayMove = <T>(array: T[], from: number, to: number): Array<T> => {
127
+ export const arrayMove = <T>(array: T[], from: number, to: number): T[] => {
110
128
  array.splice(to < 0 ? array.length + to : to, 0, array.splice(from, 1)[0]);
111
129
  return array;
112
130
  };
131
+
132
+ /**
133
+ * Swap position of element within array.
134
+ */
135
+ export function arraySwap<T>(array: T[], from: number, to: number): T[] {
136
+ const current = array[from];
137
+ array[from] = array[to];
138
+ array[to] = current;
139
+ return array;
140
+ }
package/src/unit.ts CHANGED
@@ -20,11 +20,15 @@ export type UnitFormat<T = any> = (n: number, precision?: number) => UnitValue<T
20
20
  const createFormat = (unit: Unit): UnitFormat<string> => {
21
21
  return (n: number, precision = unit.precision ?? 0) => {
22
22
  const value = n / unit.quotient;
23
+ const formattedValue = value.toLocaleString('en-US', {
24
+ minimumFractionDigits: precision,
25
+ maximumFractionDigits: precision,
26
+ });
23
27
  return {
24
28
  unit,
25
29
  value,
26
- formattedValue: value.toFixed(precision),
27
- toString: () => `${value.toFixed(precision)}${unit.symbol}`,
30
+ formattedValue,
31
+ toString: () => `${formattedValue}${unit.symbol}`,
28
32
  };
29
33
  };
30
34
  };
@@ -42,6 +46,7 @@ export const Unit: Record<string, UnitFormat> = {
42
46
  Gigabyte: createFormat({ symbol: 'GB', quotient: 1_000 * 1_000 * 1_000, precision: 2 }),
43
47
  Megabyte: createFormat({ symbol: 'MB', quotient: 1_000 * 1_000, precision: 2 }),
44
48
  Kilobyte: createFormat({ symbol: 'KB', quotient: 1_000, precision: 2 }),
49
+ Byte: createFormat({ symbol: 'B', quotient: 1 }),
45
50
 
46
51
  // Time.
47
52
  Hour: createFormat({ symbol: 'h', quotient: MS_HOURS }),
package/src/weak.ts CHANGED
@@ -7,13 +7,20 @@
7
7
  */
8
8
  export class WeakDictionary<K, V extends object> implements Map<K, V> {
9
9
  private readonly _internal = new Map<K, WeakRef<V>>();
10
- private readonly _finalization = new FinalizationRegistry((cleanUpCallback: () => void) => {
11
- cleanUpCallback();
10
+ private readonly _finalization = new FinalizationRegistry<{ key: K; ref: WeakRef<V> }>(({ key, ref }) => {
11
+ if (this._internal.get(key) === ref) {
12
+ this._internal.delete(key);
13
+ }
12
14
  });
13
15
 
14
16
  constructor(entries?: [K, V][]) {
15
- this._internal = new Map(entries?.map(([key, value]) => [key, new WeakRef(value)]));
16
- entries?.forEach(([key, value]) => this._register(key, value));
17
+ if (entries) {
18
+ for (const [key, value] of entries) {
19
+ const ref = new WeakRef(value);
20
+ this._internal.set(key, ref);
21
+ this._register(key, value, ref);
22
+ }
23
+ }
17
24
  }
18
25
 
19
26
  *entries(): SetIterator<[K, V]> {
@@ -55,11 +62,48 @@ export class WeakDictionary<K, V extends object> implements Map<K, V> {
55
62
  }
56
63
 
57
64
  set(key: K, value: V): this {
58
- this._internal.set(key, new WeakRef(value));
59
- this._register(key, value);
65
+ const previous = this._internal.get(key)?.deref();
66
+ if (previous) {
67
+ this._unregister(previous);
68
+ }
69
+ const ref = new WeakRef(value);
70
+ this._internal.set(key, ref);
71
+ this._register(key, value, ref);
60
72
  return this;
61
73
  }
62
74
 
75
+ /**
76
+ * Returns the value for the given key if present, otherwise inserts and returns the default value.
77
+ * @param key - The key to look up or insert.
78
+ * @param defaultValue - The value to insert if the key is not present.
79
+ * @returns The existing or newly inserted value.
80
+ */
81
+ getOrInsert(key: K, defaultValue: V): V {
82
+ const existing = this.get(key);
83
+ if (existing !== undefined) {
84
+ return existing;
85
+ }
86
+ this.set(key, defaultValue);
87
+ return defaultValue;
88
+ }
89
+
90
+ /**
91
+ * Returns the value for the given key if present, otherwise computes, inserts, and returns a new value.
92
+ * The callback is only invoked when the key is missing.
93
+ * @param key - The key to look up or insert.
94
+ * @param callbackfn - Function to compute the value if the key is not present.
95
+ * @returns The existing or newly computed value.
96
+ */
97
+ getOrInsertComputed(key: K, callbackfn: (key: K) => V): V {
98
+ const existing = this.get(key);
99
+ if (existing !== undefined) {
100
+ return existing;
101
+ }
102
+ const value = callbackfn(key);
103
+ this.set(key, value);
104
+ return value;
105
+ }
106
+
63
107
  has(key: K): boolean {
64
108
  return this._internal.has(key) && this._internal.get(key)!.deref() !== undefined;
65
109
  }
@@ -96,14 +140,8 @@ export class WeakDictionary<K, V extends object> implements Map<K, V> {
96
140
  });
97
141
  }
98
142
 
99
- private _register(key: K, value: V): void {
100
- this._finalization.register(
101
- value,
102
- () => {
103
- this._internal.delete(key);
104
- },
105
- value,
106
- );
143
+ private _register(key: K, value: V, ref: WeakRef<V>): void {
144
+ this._finalization.register(value, { key, ref }, value);
107
145
  }
108
146
 
109
147
  private _unregister(value: V): void {
@@ -1 +0,0 @@
1
- //# sourceMappingURL=explicit-resource-management-polyfill.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"explicit-resource-management-polyfill.d.ts","sourceRoot":"","sources":["../../../src/explicit-resource-management-polyfill.ts"],"names":[],"mappings":""}
@@ -1,13 +0,0 @@
1
- //
2
- // Copyright 2023 DXOS.org
3
- //
4
-
5
- // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html
6
-
7
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
8
- // @ts-ignore
9
- Symbol.dispose ??= Symbol('Symbol.dispose');
10
-
11
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
12
- // @ts-ignore
13
- Symbol.asyncDispose ??= Symbol('Symbol.asyncDispose');