@dxos/util 0.8.4-main.74a063c4e0 → 0.8.4-main.765dc60934

package/LICENSE

@@ -1,8 +1,105 @@
-MIT License 
-Copyright (c) 2022 DXOS
+# Functional Source License, Version 1.1, ALv2 Future License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+## Abbreviation
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+FSL-1.1-Apache-2.0
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+## Notice
+
+Copyright 2026 DXOS
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the Apache License, Version 2.0 that is effective on the second anniversary of
+the date we make the Software available. On or after that date, you may use the
+Software under the Apache License, Version 2.0, in which case the following
+will apply:
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License.
+
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

package/dist/lib/browser/index.mjs

@@ -119,7 +119,6 @@ var createBinder = (obj) => ({
 
 // src/bitfield.ts
 import { invariant } from "@dxos/invariant";
-var __dxlog_file = "/__w/dxos/dxos/packages/common/util/src/bitfield.ts";
 var BitField = class _BitField {
   static get(data, idx) {
     const bit = data[idx >> 3] >> 7 - idx % 8 & 1;
@@ -151,15 +150,7 @@ var BitField = class _BitField {
     return result;
   }
   static and(first, second) {
-    invariant(first.length === second.length, "Bitfields must be of the same length", {
-      F: __dxlog_file,
-      L: 52,
-      S: this,
-      A: [
-        "first.length === second.length",
-        "'Bitfields must be of the same length'"
-      ]
-    });
+    invariant(first.length === second.length, "Bitfields must be of the same length");
     const result = new Uint8Array(first.length);
     for (let i = 0; i < first.length; i++) {
       result[i] = first[i] & second[i];
@@ -187,6 +178,49 @@ var BitField = class _BitField {
   }
 };
 
+// src/browser-storage.ts
+var clearIndexedDB = async () => {
+  const dbs = await indexedDB.databases();
+  const results = await Promise.allSettled(dbs.filter((db) => db.name != null).map((db) => new Promise((resolve, reject) => {
+    const request = indexedDB.deleteDatabase(db.name);
+    request.onsuccess = () => resolve();
+    request.onerror = () => reject(request.error);
+    request.onblocked = () => reject(new Error(`IndexedDB deletion blocked: ${db.name}`));
+  })));
+  const failures = results.filter((r) => r.status === "rejected");
+  if (failures.length > 0) {
+    throw new AggregateError(failures.map((r) => r.reason), "Failed to delete some IndexedDB databases");
+  }
+};
+var clearOPFS = async () => {
+  const root = await navigator.storage.getDirectory();
+  const errors = [];
+  for await (const [name] of root.entries()) {
+    try {
+      await root.removeEntry(name, {
+        recursive: true
+      });
+    } catch (err) {
+      errors.push(err);
+    }
+  }
+  if (errors.length > 0) {
+    throw new AggregateError(errors, "Failed to remove some OPFS entries");
+  }
+};
+var clearServiceWorkers = async () => {
+  const regs = await navigator.serviceWorker.getRegistrations();
+  for (const reg of regs) {
+    await reg.unregister();
+  }
+};
+var clearCaches = async () => {
+  const keys2 = await caches.keys();
+  for (const key of keys2) {
+    await caches.delete(key);
+  }
+};
+
 // src/callback-collection.ts
 var CallbackCollection = class {
   #callbacks = [];
@@ -213,34 +247,17 @@ var CallbackCollection = class {
 
 // src/callback.ts
 import { invariant as invariant2 } from "@dxos/invariant";
-var __dxlog_file2 = "/__w/dxos/dxos/packages/common/util/src/callback.ts";
 var Callback = class {
   _callback;
   call(...args) {
-    invariant2(this._callback, "Callback not set", {
-      F: __dxlog_file2,
-      L: 20,
-      S: this,
-      A: [
-        "this._callback",
-        "'Callback not set'"
-      ]
-    });
+    invariant2(this._callback, "Callback not set");
     return this._callback(...args);
   }
   callIfSet(...args) {
     return this._callback?.(...args);
   }
   set(callback) {
-    invariant2(!this._callback, "Callback already set", {
-      F: __dxlog_file2,
-      L: 29,
-      S: this,
-      A: [
-        "!this._callback",
-        "'Callback already set'"
-      ]
-    });
+    invariant2(!this._callback, "Callback already set");
     this._callback = callback;
   }
   isSet() {
@@ -308,21 +325,12 @@ var chunkArray = (array, size) => {
 
 // src/circular-buffer.ts
 import { invariant as invariant3 } from "@dxos/invariant";
-var __dxlog_file3 = "/__w/dxos/dxos/packages/common/util/src/circular-buffer.ts";
 var CircularBuffer = class {
   _buffer;
   _nextIndex = 0;
   _elementCount = 0;
   constructor(size) {
-    invariant3(size >= 1, void 0, {
-      F: __dxlog_file3,
-      L: 13,
-      S: this,
-      A: [
-        "size >= 1",
-        ""
-      ]
-    });
+    invariant3(size >= 1);
     this._buffer = new Array(size);
   }
   push(element) {
@@ -532,6 +540,36 @@ var ComplexMap = class _ComplexMap {
     this._values.set(primitive, value);
     return this;
   }
+  /**
+  * Returns the value for the given key if present, otherwise inserts and returns the default value.
+  * @param key - The key to look up or insert.
+  * @param defaultValue - The value to insert if the key is not present.
+  * @returns The existing or newly inserted value.
+  */
+  getOrInsert(key, defaultValue) {
+    const primitive = this._keyProjection(key);
+    if (this._values.has(primitive)) {
+      return this._values.get(primitive);
+    }
+    this.set(key, defaultValue);
+    return defaultValue;
+  }
+  /**
+  * Returns the value for the given key if present, otherwise computes, inserts, and returns a new value.
+  * The callback is only invoked when the key is missing.
+  * @param key - The key to look up or insert.
+  * @param callbackfn - Function to compute the value if the key is not present.
+  * @returns The existing or newly computed value.
+  */
+  getOrInsertComputed(key, callbackfn) {
+    const primitive = this._keyProjection(key);
+    if (this._values.has(primitive)) {
+      return this._values.get(primitive);
+    }
+    const value = callbackfn(key);
+    this.set(key, value);
+    return value;
+  }
   get size() {
     return this._keys.size;
   }
@@ -578,17 +616,8 @@ var splitCompositeKey = (key) => key.split(SEPARATOR);
 
 // src/deep.ts
 import { invariant as invariant4 } from "@dxos/invariant";
-var __dxlog_file4 = "/__w/dxos/dxos/packages/common/util/src/deep.ts";
 var setDeep = (obj, path, value) => {
-  invariant4(path.length > 0, void 0, {
-    F: __dxlog_file4,
-    L: 12,
-    S: void 0,
-    A: [
-      "path.length > 0",
-      ""
-    ]
-  });
+  invariant4(path.length > 0);
   let parent = obj;
   for (const key of path.slice(0, -1)) {
     if (parent[key] === void 0) {
@@ -673,6 +702,23 @@ var MapEntry = class {
   }
 };
 
+// src/error-format.ts
+var formatErrorWithCauses = (error) => {
+  const lines = [];
+  let current = error;
+  let level = 0;
+  while (current) {
+    const prefix = level === 0 ? "" : `Caused by: `;
+    lines.push(prefix + (current.stack ?? String(current)));
+    if (!(current.cause instanceof Error)) {
+      break;
+    }
+    current = current.cause;
+    level += 1;
+  }
+  return lines.join("\n\n");
+};
+
 // src/filename.ts
 var createFilename = ({ parts = [], ext, date = /* @__PURE__ */ new Date() }) => [
   date.toISOString().replace(/[:.]/g, "-"),
@@ -1014,6 +1060,19 @@ var humanize = (value) => {
   return hasher.humanize(value);
 };
 
+// src/id.ts
+var PART = /^[a-zA-Z][a-zA-Z0-9]{0,62}$/;
+var ID = /^[a-zA-Z]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+(\.[a-zA-Z]([a-zA-Z0-9]{0,62})?)$/;
+function id(strings, ...values) {
+  const raw = strings.reduce((out, str, i) => out + str + (i < values.length ? String(values[i]) : ""), "");
+  if (!ID.test(raw)) {
+    throw new Error(`Invalid id (expected AT Protocol NSID): ${JSON.stringify(raw)}`);
+  }
+  return raw;
+}
+var isWellFormedId = (value) => ID.test(value);
+var isWellFormedIdPart = (value) => PART.test(value);
+
 // src/map.ts
 var defaultMap = (map, key, def) => {
   let value = map.get(key);
@@ -1033,12 +1092,12 @@ var getPrototypeSpecificInstanceId = (instance) => {
     nextId: 0,
     instanceIds: /* @__PURE__ */ new WeakMap()
   }));
-  let id = instanceCtx.instanceIds.get(instance);
-  if (id === void 0) {
-    id = instanceCtx.nextId++;
-    instanceCtx.instanceIds.set(instance, id);
+  let id2 = instanceCtx.instanceIds.get(instance);
+  if (id2 === void 0) {
+    id2 = instanceCtx.nextId++;
+    instanceCtx.instanceIds.set(instance, id2);
   }
-  return id;
+  return id2;
 };
 var getDebugName = (instance) => {
   if (instance == null) {
@@ -1319,27 +1378,27 @@ var orderKeys = (obj, order) => {
 
 // src/order.ts
 var inferObjectOrder = (objectMap, order = []) => {
-  const orderedObjects = order.reduce((acc, id) => {
-    if (id in objectMap) {
-      acc.objects.push(objectMap[id]);
-      acc.ids.add(id);
+  const orderedObjects = order.reduce((acc, id2) => {
+    if (id2 in objectMap) {
+      acc.objects.push(objectMap[id2]);
+      acc.ids.add(id2);
     }
     return acc;
   }, {
     objects: [],
     ids: /* @__PURE__ */ new Set()
   });
-  const { objects } = Object.keys(objectMap).reduce((acc, id) => {
-    if (!acc.ids.has(id)) {
-      acc.objects.push(objectMap[id]);
+  const { objects } = Object.keys(objectMap).reduce((acc, id2) => {
+    if (!acc.ids.has(id2)) {
+      acc.objects.push(objectMap[id2]);
     }
     return acc;
   }, orderedObjects);
   return objects;
 };
 var inferRecordOrder = (objectMap, order = []) => {
-  return Object.assign(order.filter((id) => id in objectMap).reduce((acc, id) => {
-    acc[id] = null;
+  return Object.assign(order.filter((id2) => id2 in objectMap).reduce((acc, id2) => {
+    acc[id2] = null;
     return acc;
   }, {}), objectMap);
 };
@@ -1583,6 +1642,43 @@ var removeProperties = (root, condition) => {
   return result;
 };
 
+// src/retry.ts
+var DEFAULT_RETRY_OPTIONS = {
+  count: 3,
+  delayMs: 100,
+  exponent: 2,
+  retryOnError: async () => true,
+  retryOnValue: async () => false
+};
+var retry = async (options, cb) => {
+  const fullOptions = {
+    ...DEFAULT_RETRY_OPTIONS,
+    ...options
+  };
+  let numRetries = 0, currentDelay = fullOptions.delayMs;
+  while (true) {
+    let result;
+    try {
+      result = await cb();
+    } catch (err) {
+      if (numRetries > fullOptions.count || !await fullOptions.retryOnError(err)) {
+        throw err;
+      }
+      await new Promise((resolve) => setTimeout(resolve, currentDelay));
+      currentDelay *= fullOptions.exponent;
+      numRetries++;
+      continue;
+    }
+    if (!await fullOptions.retryOnValue(result)) {
+      return result;
+    }
+    await new Promise((resolve) => setTimeout(resolve, currentDelay));
+    currentDelay *= fullOptions.exponent;
+    numRetries++;
+    continue;
+  }
+};
+
 // src/safe-await.ts
 var safeAwaitAll = async (source, taskFactory, onError) => {
   const failedItems = [];
@@ -1739,7 +1835,6 @@ var defaultFilter = createReplacer();
 
 // src/sliding-window-summary.ts
 import { invariant as invariant5 } from "@dxos/invariant";
-var __dxlog_file5 = "/__w/dxos/dxos/packages/common/util/src/sliding-window-summary.ts";
 var SlidingWindowSummary = class {
   _buffer;
   _sum = 0;
@@ -1747,15 +1842,7 @@ var SlidingWindowSummary = class {
   constructor(options) {
     this._buffer = new CircularBuffer(options.dataPoints);
     if (options.precision != null) {
-      invariant5(options.precision >= 0, void 0, {
-        F: __dxlog_file5,
-        L: 26,
-        S: this,
-        A: [
-          "options.precision >= 0",
-          ""
-        ]
-      });
+      invariant5(options.precision >= 0);
       this._precision = Math.pow(10, options.precision);
     }
   }
@@ -1836,8 +1923,12 @@ function trim(strings, ...values) {
     return out;
   }, "");
   const lines = raw.split("\n");
-  while (lines.length && !lines[0].trim()) lines.shift();
-  while (lines.length && !lines[lines.length - 1].trim()) lines.pop();
+  while (lines.length && !lines[0].trim()) {
+    lines.shift();
+  }
+  while (lines.length && !lines[lines.length - 1].trim()) {
+    lines.pop();
+  }
   const minIndent = Math.min(...lines.filter((l) => l.trim()).map((l) => l.match(/^[ \t]*/)?.[0].length ?? 0));
   return lines.map((l) => l.slice(minIndent)).join("\n");
 }
@@ -2040,8 +2131,8 @@ var Tracer = class {
   keys() {
     return Array.from(this._events.keys());
   }
-  get(id, filter) {
-    const events = this._events.get(id);
+  get(id2, filter) {
+    const events = this._events.get(id2);
     if (filter) {
       return events?.filter((event) => Object.entries(filter).every(([key, value]) => event?.value[key] === value));
     }
@@ -2058,11 +2149,11 @@ var Tracer = class {
     this._recording = false;
     return this;
   }
-  emit(id, value) {
-    this._post(this._createEvent(id, value));
+  emit(id2, value) {
+    this._post(this._createEvent(id2, value));
   }
-  mark(id, value) {
-    const event = this._createEvent(id, value);
+  mark(id2, value) {
+    const event = this._createEvent(id2, value);
     const start = performance.now();
     return {
       start,
@@ -2072,9 +2163,9 @@ var Tracer = class {
       }
     };
   }
-  _createEvent(id, value) {
+  _createEvent(id2, value) {
     const event = {
-      id,
+      id: id2,
       timestamp: Date.now()
     };
     if (value !== void 0) {
@@ -2172,11 +2263,15 @@ function arraySwap(array, from, to) {
 var createFormat = (unit) => {
   return (n, precision = unit.precision ?? 0) => {
     const value = n / unit.quotient;
+    const formattedValue = value.toLocaleString("en-US", {
+      minimumFractionDigits: precision,
+      maximumFractionDigits: precision
+    });
     return {
       unit,
       value,
-      formattedValue: value.toFixed(precision),
-      toString: () => `${value.toFixed(precision)}${unit.symbol}`
+      formattedValue,
+      toString: () => `${formattedValue}${unit.symbol}`
     };
   };
 };
@@ -2281,15 +2376,19 @@ var createUrl = (url, search) => {
 // src/weak.ts
 var WeakDictionary = class {
   _internal = /* @__PURE__ */ new Map();
-  _finalization = new FinalizationRegistry((cleanUpCallback) => {
-    cleanUpCallback();
+  _finalization = new FinalizationRegistry(({ key, ref }) => {
+    if (this._internal.get(key) === ref) {
+      this._internal.delete(key);
+    }
   });
   constructor(entries2) {
-    this._internal = new Map(entries2?.map(([key, value]) => [
-      key,
-      new WeakRef(value)
-    ]));
-    entries2?.forEach(([key, value]) => this._register(key, value));
+    if (entries2) {
+      for (const [key, value] of entries2) {
+        const ref = new WeakRef(value);
+        this._internal.set(key, ref);
+        this._register(key, value, ref);
+      }
+    }
   }
   *entries() {
     for (const [key, value] of this._internal) {
@@ -2329,10 +2428,45 @@ var WeakDictionary = class {
     return this._internal.get(key)?.deref();
   }
   set(key, value) {
-    this._internal.set(key, new WeakRef(value));
-    this._register(key, value);
+    const previous = this._internal.get(key)?.deref();
+    if (previous) {
+      this._unregister(previous);
+    }
+    const ref = new WeakRef(value);
+    this._internal.set(key, ref);
+    this._register(key, value, ref);
     return this;
   }
+  /**
+  * Returns the value for the given key if present, otherwise inserts and returns the default value.
+  * @param key - The key to look up or insert.
+  * @param defaultValue - The value to insert if the key is not present.
+  * @returns The existing or newly inserted value.
+  */
+  getOrInsert(key, defaultValue) {
+    const existing = this.get(key);
+    if (existing !== void 0) {
+      return existing;
+    }
+    this.set(key, defaultValue);
+    return defaultValue;
+  }
+  /**
+  * Returns the value for the given key if present, otherwise computes, inserts, and returns a new value.
+  * The callback is only invoked when the key is missing.
+  * @param key - The key to look up or insert.
+  * @param callbackfn - Function to compute the value if the key is not present.
+  * @returns The existing or newly computed value.
+  */
+  getOrInsertComputed(key, callbackfn) {
+    const existing = this.get(key);
+    if (existing !== void 0) {
+      return existing;
+    }
+    const value = callbackfn(key);
+    this.set(key, value);
+    return value;
+  }
   has(key) {
     return this._internal.has(key) && this._internal.get(key).deref() !== void 0;
   }
@@ -2363,67 +2497,16 @@ var WeakDictionary = class {
       }
     });
   }
-  _register(key, value) {
-    this._finalization.register(value, () => {
-      this._internal.delete(key);
+  _register(key, value, ref) {
+    this._finalization.register(value, {
+      key,
+      ref
     }, value);
   }
   _unregister(value) {
     this._finalization.unregister(value);
   }
 };
-
-// src/error-format.ts
-var formatErrorWithCauses = (error) => {
-  const lines = [];
-  let current = error;
-  let level = 0;
-  while (current) {
-    const prefix = level === 0 ? "" : `Caused by: `;
-    lines.push(prefix + (current.stack ?? String(current)));
-    if (!(current.cause instanceof Error)) break;
-    current = current.cause;
-    level += 1;
-  }
-  return lines.join("\n\n");
-};
-
-// src/retry.ts
-var DEFAULT_RETRY_OPTIONS = {
-  count: 3,
-  delayMs: 100,
-  exponent: 2,
-  retryOnError: async () => true,
-  retryOnValue: async () => false
-};
-var retry = async (options, cb) => {
-  const fullOptions = {
-    ...DEFAULT_RETRY_OPTIONS,
-    ...options
-  };
-  let numRetries = 0, currentDelay = fullOptions.delayMs;
-  while (true) {
-    let result;
-    try {
-      result = await cb();
-    } catch (err) {
-      if (numRetries > fullOptions.count || !await fullOptions.retryOnError(err)) {
-        throw err;
-      }
-      await new Promise((resolve) => setTimeout(resolve, currentDelay));
-      currentDelay *= fullOptions.exponent;
-      numRetries++;
-      continue;
-    }
-    if (!await fullOptions.retryOnValue(result)) {
-      return result;
-    }
-    await new Promise((resolve) => setTimeout(resolve, currentDelay));
-    currentDelay *= fullOptions.exponent;
-    numRetries++;
-    continue;
-  }
-};
 export {
   BitField,
   Callback,
@@ -2451,6 +2534,10 @@ export {
   capitalize,
   chunkArray,
   clamp,
+  clearCaches,
+  clearIndexedDB,
+  clearOPFS,
+  clearServiceWorkers,
   clearUndefined,
   coerceArray,
   compareMulti,
@@ -2493,6 +2580,7 @@ export {
   hexToHue,
   humanize,
   hyphenize,
+  id,
   idEmoji,
   idHue,
   inferObjectOrder,
@@ -2507,6 +2595,8 @@ export {
   isNonNullable,
   isTauri,
   isTruthy,
+  isWellFormedId,
+  isWellFormedIdPart,
   joinTables,
   jsonKeyReplacer,
   jsonReplacer,