@liveblocks/core 3.23.2-exp1 → 3.24.0

package/dist/index.cjs

@@ -6,7 +6,7 @@ var __export = (target, all) => {
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/core";
-var PKG_VERSION = "3.23.2-exp1";
+var PKG_VERSION = "3.24.0";
 var PKG_FORMAT = "cjs";
 
 // src/dupe-detection.ts
@@ -1108,6 +1108,39 @@ function* nodeStreamToCompactNodes(nodes) {
 // src/internal.ts
 var kInternal = /* @__PURE__ */ Symbol();
 
+// src/lib/fancy-console.ts
+var fancy_console_exports = {};
+__export(fancy_console_exports, {
+  error: () => error2,
+  errorWithTitle: () => errorWithTitle,
+  warn: () => warn,
+  warnWithTitle: () => warnWithTitle
+});
+var badge = "background:#0e0d12;border-radius:9999px;color:#fff;padding:3px 7px;font-family:sans-serif;font-weight:600;";
+var bold = "font-weight:600";
+function wrap(method) {
+  return typeof window === "undefined" || process.env.NODE_ENV === "test" ? console[method] : (
+    /* istanbul ignore next */
+    (message, ...args) => console[method]("%cLiveblocks", badge, message, ...args)
+  );
+}
+var warn = wrap("warn");
+var error2 = wrap("error");
+function wrapWithTitle(method) {
+  return typeof window === "undefined" || process.env.NODE_ENV === "test" ? console[method] : (
+    /* istanbul ignore next */
+    (title, message, ...args) => console[method](
+      `%cLiveblocks%c ${title}`,
+      badge,
+      bold,
+      message,
+      ...args
+    )
+  );
+}
+var warnWithTitle = wrapWithTitle("warn");
+var errorWithTitle = wrapWithTitle("error");
+
 // src/lib/position.ts
 var MIN_CODE = 32;
 var MAX_CODE = 126;
@@ -1403,6 +1436,8 @@ ${parentKey}`;
 };
 
 // src/crdts/AbstractCrdt.ts
+var warnedOrphanedNodes = /* @__PURE__ */ new WeakSet();
+var ORPHANED_NODE_WARNING = "Cannot sync changes made to this Live structure because it is no longer part of Storage. Retrieve the current value from its parent before mutating it.";
 function createManagedPool(options) {
   const {
     getCurrentConnectionId,
@@ -1494,6 +1529,17 @@ var AbstractCrdt = class {
     return this.#parent;
   }
   /** @internal */
+  _warnIfOrphaned() {
+    const node = crdtAsLiveNode(this);
+    if (this.parent.type === "Orphaned" && !warnedOrphanedNodes.has(node)) {
+      warnedOrphanedNodes.add(node);
+      warn(ORPHANED_NODE_WARNING, {
+        type: node.constructor.name,
+        formerParentKey: this.parent.oldKey
+      });
+    }
+  }
+  /** @internal */
   get _parentKey() {
     switch (this.parent.type) {
       case "HasParent":
@@ -1725,39 +1771,6 @@ var LiveFile = class _LiveFile extends AbstractCrdt {
   }
 };
 
-// src/lib/fancy-console.ts
-var fancy_console_exports = {};
-__export(fancy_console_exports, {
-  error: () => error2,
-  errorWithTitle: () => errorWithTitle,
-  warn: () => warn,
-  warnWithTitle: () => warnWithTitle
-});
-var badge = "background:#0e0d12;border-radius:9999px;color:#fff;padding:3px 7px;font-family:sans-serif;font-weight:600;";
-var bold = "font-weight:600";
-function wrap(method) {
-  return typeof window === "undefined" || process.env.NODE_ENV === "test" ? console[method] : (
-    /* istanbul ignore next */
-    (message, ...args) => console[method]("%cLiveblocks", badge, message, ...args)
-  );
-}
-var warn = wrap("warn");
-var error2 = wrap("error");
-function wrapWithTitle(method) {
-  return typeof window === "undefined" || process.env.NODE_ENV === "test" ? console[method] : (
-    /* istanbul ignore next */
-    (title, message, ...args) => console[method](
-      `%cLiveblocks%c ${title}`,
-      badge,
-      bold,
-      message,
-      ...args
-    )
-  );
-}
-var warnWithTitle = wrapWithTitle("warn");
-var errorWithTitle = wrapWithTitle("error");
-
 // src/lib/guards.ts
 function isDefined(value) {
   return value !== null && value !== void 0;
@@ -7722,6 +7735,7 @@ var LiveList = class _LiveList extends AbstractCrdt {
    * instead of resolving its position against the client's stale view.
    */
   #injectAt(element, index, intent) {
+    this._warnIfOrphaned();
     _optionalChain([this, 'access', _181 => _181._pool, 'optionalAccess', _182 => _182.assertStorageIsWritable, 'call', _183 => _183()]);
     if (index < 0 || index > this.#items.length) {
       throw new Error(
@@ -7753,6 +7767,7 @@ var LiveList = class _LiveList extends AbstractCrdt {
    * @param targetIndex The index where the element should be after moving.
    */
   move(index, targetIndex) {
+    this._warnIfOrphaned();
     _optionalChain([this, 'access', _192 => _192._pool, 'optionalAccess', _193 => _193.assertStorageIsWritable, 'call', _194 => _194()]);
     if (targetIndex < 0) {
       throw new Error("targetIndex cannot be less than 0");
@@ -7813,6 +7828,7 @@ var LiveList = class _LiveList extends AbstractCrdt {
    * @param index The index of the element to delete
    */
   delete(index) {
+    this._warnIfOrphaned();
     _optionalChain([this, 'access', _203 => _203._pool, 'optionalAccess', _204 => _204.assertStorageIsWritable, 'call', _205 => _205()]);
     if (index < 0 || index >= this.#items.length) {
       throw new Error(
@@ -7846,6 +7862,7 @@ var LiveList = class _LiveList extends AbstractCrdt {
     }
   }
   clear() {
+    this._warnIfOrphaned();
     _optionalChain([this, 'access', _206 => _206._pool, 'optionalAccess', _207 => _207.assertStorageIsWritable, 'call', _208 => _208()]);
     if (this._pool) {
       const ops = [];
@@ -7883,6 +7900,7 @@ var LiveList = class _LiveList extends AbstractCrdt {
     }
   }
   set(index, item) {
+    this._warnIfOrphaned();
     _optionalChain([this, 'access', _209 => _209._pool, 'optionalAccess', _210 => _210.assertStorageIsWritable, 'call', _211 => _211()]);
     if (index < 0 || index >= this.#items.length) {
       throw new Error(
@@ -8297,6 +8315,7 @@ var LiveMap = class _LiveMap extends AbstractCrdt {
    * @param value The value of the element to add. Should be serializable to JSON.
    */
   set(key, value) {
+    this._warnIfOrphaned();
     _optionalChain([this, 'access', _216 => _216._pool, 'optionalAccess', _217 => _217.assertStorageIsWritable, 'call', _218 => _218()]);
     const oldValue = this.#map.get(key);
     if (oldValue) {
@@ -8344,6 +8363,7 @@ var LiveMap = class _LiveMap extends AbstractCrdt {
    * @returns true if an element existed and has been removed, or false if the element does not exist.
    */
   delete(key) {
+    this._warnIfOrphaned();
     _optionalChain([this, 'access', _219 => _219._pool, 'optionalAccess', _220 => _220.assertStorageIsWritable, 'call', _221 => _221()]);
     const item = this.#map.get(key);
     if (item === void 0) {
@@ -8963,6 +8983,7 @@ var LiveObject = (_class2 = class _LiveObject extends AbstractCrdt {
    * Caveat: this method will not add changes to the undo/redo stack.
    */
   setLocal(key, value) {
+    this._warnIfOrphaned();
     _optionalChain([this, 'access', _222 => _222._pool, 'optionalAccess', _223 => _223.assertStorageIsWritable, 'call', _224 => _224()]);
     const deleteResult = this.#prepareDelete(key);
     this.#local.set(key, value);
@@ -8997,6 +9018,7 @@ var LiveObject = (_class2 = class _LiveObject extends AbstractCrdt {
    * #synced or pool/id are unavailable. Does NOT dispatch.
    */
   #prepareDelete(key) {
+    this._warnIfOrphaned();
     _optionalChain([this, 'access', _229 => _229._pool, 'optionalAccess', _230 => _230.assertStorageIsWritable, 'call', _231 => _231()]);
     const k = key;
     if (this.#local.has(k) && !this.#synced.has(k)) {
@@ -9083,6 +9105,7 @@ var LiveObject = (_class2 = class _LiveObject extends AbstractCrdt {
    * @param patch The object used to overrides properties
    */
   update(patch) {
+    this._warnIfOrphaned();
     _optionalChain([this, 'access', _235 => _235._pool, 'optionalAccess', _236 => _236.assertStorageIsWritable, 'call', _237 => _237()]);
     if (_LiveObject.detectLargeObjects) {
       const data = {};
@@ -10078,6 +10101,7 @@ var LiveText = class _LiveText extends AbstractCrdt {
     if (ops.length === 0) {
       return;
     }
+    this._warnIfOrphaned();
     _optionalChain([this, 'access', _241 => _241._pool, 'optionalAccess', _242 => _242.assertStorageIsWritable, 'call', _243 => _243()]);
     const attached = this._pool !== void 0 && this._id !== void 0;
     const reverse = attached ? this.#invertOperations(ops) : [];