@liveblocks/core 2.15.2 → 2.16.0-rc1

package/dist/index.mjs

@@ -6,7 +6,7 @@ var __export = (target, all) => {
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/core";
-var PKG_VERSION = "2.15.2";
+var PKG_VERSION = "2.16.0-rc1";
 var PKG_FORMAT = "esm";
 
 // src/dupe-detection.ts
@@ -166,13 +166,18 @@ function wrapWithTitle(method) {
 var warnWithTitle = wrapWithTitle("warn");
 var errorWithTitle = wrapWithTitle("error");
 
+// src/lib/guards.ts
+function isPlainObject(blob) {
+  return blob !== null && typeof blob === "object" && Object.prototype.toString.call(blob) === "[object Object]";
+}
+function isStartsWithOperator(blob) {
+  return isPlainObject(blob) && typeof blob.startsWith === "string";
+}
+
 // src/lib/utils.ts
 function raise(msg) {
   throw new Error(msg);
 }
-function isPlainObject(blob) {
-  return blob !== null && typeof blob === "object" && Object.prototype.toString.call(blob) === "[object Object]";
-}
 function entries(obj) {
   return Object.entries(obj);
 }
@@ -254,13 +259,48 @@ function memoizeOnSuccess(factoryFn) {
 }
 
 // src/lib/autoRetry.ts
-var HttpError = class extends Error {
-  constructor(message, status, details) {
+var HttpError = class _HttpError extends Error {
+  response;
+  details;
+  constructor(message, response, details) {
     super(message);
-    this.message = message;
-    this.status = status;
+    this.name = "HttpError";
+    this.response = response;
     this.details = details;
   }
+  static async fromResponse(response) {
+    let bodyAsText;
+    try {
+      bodyAsText = await response.text();
+    } catch {
+    }
+    const bodyAsJson = bodyAsText ? tryParseJson(bodyAsText) : void 0;
+    let bodyAsJsonObject;
+    if (isPlainObject(bodyAsJson)) {
+      bodyAsJsonObject = bodyAsJson;
+    }
+    let message = "";
+    message ||= typeof bodyAsJsonObject?.message === "string" ? bodyAsJsonObject.message : "";
+    message ||= typeof bodyAsJsonObject?.error === "string" ? bodyAsJsonObject.error : "";
+    if (bodyAsJson === void 0) {
+      message ||= bodyAsText || "";
+    }
+    message ||= response.statusText;
+    let path;
+    try {
+      path = new URL(response.url).pathname;
+    } catch {
+    }
+    message += path !== void 0 ? ` (got status ${response.status} from ${path})` : ` (got status ${response.status})`;
+    const details = bodyAsJsonObject;
+    return new _HttpError(message, response, details);
+  }
+  /**
+   * Convenience accessor for response.status.
+   */
+  get status() {
+    return this.response.status;
+  }
 };
 var DONT_RETRY_4XX = (x) => x instanceof HttpError && x.status >= 400 && x.status < 500;
 async function autoRetry(promiseFn, maxTries, backoff, shouldStopRetrying = DONT_RETRY_4XX) {
@@ -326,7 +366,12 @@ function makeEventSource() {
     }).finally(() => unsub?.());
   }
   function notify(event) {
-    _observers.forEach((callback) => callback(event));
+    let called = false;
+    for (const callback of _observers) {
+      callback(event);
+      called = true;
+    }
+    return called;
   }
   function count() {
     return _observers.size;
@@ -367,8 +412,9 @@ function makeBufferableEventSource() {
   function notifyOrBuffer(event) {
     if (_buffer !== null) {
       _buffer.push(event);
+      return false;
     } else {
-      eventSource2.notify(event);
+      return eventSource2.notify(event);
     }
   }
   return {
@@ -673,32 +719,15 @@ var MutableSignal = class extends AbstractSignal {
 };
 
 // src/lib/stringify.ts
-var EXPLICIT_UNDEFINED_PLACEHOLDER = "_explicit_undefined";
 function replacer(_key, value) {
   return value !== null && typeof value === "object" && !Array.isArray(value) ? Object.keys(value).sort().reduce((sorted, key) => {
     sorted[key] = value[key];
     return sorted;
-  }, {}) : value === void 0 ? EXPLICIT_UNDEFINED_PLACEHOLDER : value;
-}
-function reviver(key, value) {
-  if (!key && value === EXPLICIT_UNDEFINED_PLACEHOLDER) {
-    return void 0;
-  }
-  if (value && typeof value === "object") {
-    for (const k in value) {
-      if (value[k] === EXPLICIT_UNDEFINED_PLACEHOLDER) {
-        Object.defineProperty(value, k, { value: void 0 });
-      }
-    }
-  }
-  return value;
+  }, {}) : value;
 }
 function stringify(value) {
   return JSON.stringify(value, replacer);
 }
-function unstringify(value) {
-  return JSON.parse(value, reviver);
-}
 
 // src/lib/batch.ts
 var DEFAULT_SIZE = 50;
@@ -928,10 +957,12 @@ function objectToQuery(obj) {
     }
     if (isSimpleValue(value)) {
       keyValuePairs.push([key, value]);
-    } else if (isValueWithOperator(value)) {
-      keyValuePairsWithOperator.push([key, value]);
-    } else if (typeof value === "object" && !("startsWith" in value)) {
-      indexedKeys.push([key, value]);
+    } else if (isPlainObject(value)) {
+      if (isStartsWithOperator(value)) {
+        keyValuePairsWithOperator.push([key, value]);
+      } else {
+        indexedKeys.push([key, value]);
+      }
     }
   });
   filterList = [
@@ -948,7 +979,7 @@ function objectToQuery(obj) {
       }
       if (isSimpleValue(nestedValue)) {
         nKeyValuePairs.push([formatFilterKey(key, nestedKey), nestedValue]);
-      } else if (isValueWithOperator(nestedValue)) {
+      } else if (isStartsWithOperator(nestedValue)) {
         nKeyValuePairsWithOperator.push([
           formatFilterKey(key, nestedKey),
           nestedValue
@@ -961,9 +992,7 @@ function objectToQuery(obj) {
       ...getFiltersFromKeyValuePairsWithOperator(nKeyValuePairsWithOperator)
     ];
   });
-  return filterList.map(
-    ({ key, operator, value }) => formatFilter(key, operator, formatFilterValue(value))
-  ).join(" AND ");
+  return filterList.map(({ key, operator, value }) => `${key}${operator}${quote(value)}`).join(" ");
 }
 var getFiltersFromKeyValuePairs = (keyValuePairs) => {
   const filters = [];
@@ -990,38 +1019,20 @@ var getFiltersFromKeyValuePairsWithOperator = (keyValuePairsWithOperator) => {
   return filters;
 };
 var isSimpleValue = (value) => {
-  if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
-    return true;
-  }
-  return false;
-};
-var isValueWithOperator = (value) => {
-  if (typeof value === "object" && value !== null && "startsWith" in value) {
-    return true;
-  }
-  return false;
-};
-var formatFilter = (key, operator, value) => {
-  return `${key}${operator}${value}`;
+  return typeof value === "string" || typeof value === "number" || typeof value === "boolean" || value === null;
 };
 var formatFilterKey = (key, nestedKey) => {
   if (nestedKey) {
-    return `${key}[${JSON.stringify(nestedKey)}]`;
+    return `${key}[${quote(nestedKey)}]`;
   }
   return key;
 };
-var formatFilterValue = (value) => {
-  if (typeof value === "string") {
-    if (isStringEmpty(value)) {
-      throw new Error("Value cannot be empty");
-    }
-    return JSON.stringify(value);
-  }
-  return value.toString();
-};
 var isStringEmpty = (value) => {
   return !value || value.toString().trim() === "";
 };
+function quote(value) {
+  return typeof value !== "string" || value.includes("'") ? JSON.stringify(value) : `'${value}'`;
+}
 
 // src/lib/url.ts
 function toURLSearchParams(params) {
@@ -1846,14 +1857,7 @@ var HttpClient = class {
   async #fetch(endpoint, authValue, options, params) {
     const response = await this.#rawFetch(endpoint, authValue, options, params);
     if (!response.ok) {
-      let error3;
-      try {
-        const errorBody = await response.json();
-        error3 = new HttpError(errorBody.message, response.status, errorBody);
-      } catch {
-        error3 = new HttpError(response.statusText, response.status);
-      }
-      throw error3;
+      throw await HttpError.fromResponse(response);
     }
     let body;
     try {
@@ -2480,6 +2484,7 @@ function toNewConnectionStatus(machine) {
       return machine.context.successCount > 0 ? "reconnecting" : "connecting";
     case "@idle.failed":
       return "disconnected";
+    // istanbul ignore next
     default:
       return assertNever(state, "Unknown state");
   }
@@ -2496,13 +2501,6 @@ var StopRetrying = class extends Error {
     super(reason);
   }
 };
-var LiveblocksError = class extends Error {
-  /** @internal */
-  constructor(message, code) {
-    super(message);
-    this.code = code;
-  }
-};
 function nextBackoffDelay(currentDelay, delays) {
   return delays.find((delay) => delay > currentDelay) ?? delays[delays.length - 1];
 }
@@ -2612,11 +2610,10 @@ var assign = (patch) => (ctx) => ctx.patch(patch);
 function createConnectionStateMachine(delegates, options) {
   const onMessage = makeBufferableEventSource();
   onMessage.pause();
-  const onLiveblocksError = makeEventSource();
-  function fireErrorEvent(errmsg, errcode) {
+  const onConnectionError = makeEventSource();
+  function fireErrorEvent(message, code) {
     return () => {
-      const err = new LiveblocksError(errmsg, errcode);
-      onLiveblocksError.notify(err);
+      onConnectionError.notify({ message, code });
     };
   }
   const initialContext = {
@@ -2974,7 +2971,7 @@ function createConnectionStateMachine(delegates, options) {
       didConnect,
       didDisconnect,
       onMessage: onMessage.observable,
-      onLiveblocksError: onLiveblocksError.observable
+      onConnectionError: onConnectionError.observable
     }
   };
 }
@@ -3360,6 +3357,12 @@ function setupDevTools(getAllRooms) {
   _devtoolsSetupHasRun = true;
   onMessageFromPanel.subscribe((msg) => {
     switch (msg.msg) {
+      // When a devtool panel sends an explicit "connect" message back to this
+      // live running client (in response to the "wake-up-devtools" message,
+      // or when the devtool panel is opened for the first time), it means that it's okay to
+      // start emitting messages.
+      // Before this explicit acknowledgement, any call to sendToPanel() will
+      // be a no-op.
       case "connect": {
         activateBridge(true);
         for (const roomId of getAllRooms()) {
@@ -3500,6 +3503,8 @@ function linkDevTools(roomId, room) {
     // roomChannelListeners registry
     onMessageFromPanel.subscribe((msg) => {
       switch (msg.msg) {
+        // Sent by the devtool panel when it wants to receive the sync stream
+        // for a room
         case "room::subscribe": {
           if (msg.roomId === roomId) {
             startSyncStream(room);
@@ -6230,6 +6235,83 @@ var ManagedOthers = class {
   }
 };
 
+// src/types/LiveblocksError.ts
+var LiveblocksError = class _LiveblocksError extends Error {
+  context;
+  constructor(message, context, cause) {
+    super(message, { cause });
+    this.context = context;
+    this.name = "LiveblocksError";
+  }
+  /** Convenience accessor for error.context.roomId (if available) */
+  get roomId() {
+    return this.context.roomId;
+  }
+  /** @deprecated Prefer using `context.code` instead, to enable type narrowing */
+  get code() {
+    return this.context.code;
+  }
+  /**
+   * Creates a LiveblocksError from a generic error, by attaching Liveblocks
+   * contextual information like room ID, thread ID, etc.
+   */
+  static from(context, cause) {
+    return new _LiveblocksError(
+      defaultMessageFromContext(context),
+      context,
+      cause
+    );
+  }
+};
+function defaultMessageFromContext(context) {
+  switch (context.type) {
+    case "ROOM_CONNECTION_ERROR": {
+      switch (context.code) {
+        case 4001:
+          return "Not allowed to connect to the room";
+        case 4005:
+          return "Room is already full";
+        case 4006:
+          return "Kicked out of the room, because the room ID changed";
+        default:
+          return "Could not connect to the room";
+      }
+    }
+    case "CREATE_THREAD_ERROR":
+      return "Could not create new thread";
+    case "DELETE_THREAD_ERROR":
+      return "Could not delete thread";
+    case "EDIT_THREAD_METADATA_ERROR":
+      return "Could not edit thread metadata";
+    case "MARK_THREAD_AS_RESOLVED_ERROR":
+      return "Could not mark thread as resolved";
+    case "MARK_THREAD_AS_UNRESOLVED_ERROR":
+      return "Could not mark thread as unresolved";
+    case "CREATE_COMMENT_ERROR":
+      return "Could not create new comment";
+    case "EDIT_COMMENT_ERROR":
+      return "Could not edit comment";
+    case "DELETE_COMMENT_ERROR":
+      return "Could not delete comment";
+    case "ADD_REACTION_ERROR":
+      return "Could not add reaction";
+    case "REMOVE_REACTION_ERROR":
+      return "Could not remove reaction";
+    case "MARK_INBOX_NOTIFICATION_AS_READ_ERROR":
+      return "Could not mark inbox notification as read";
+    case "DELETE_INBOX_NOTIFICATION_ERROR":
+      return "Could not delete inbox notification";
+    case "MARK_ALL_INBOX_NOTIFICATIONS_AS_READ_ERROR":
+      return "Could not mark all inbox notifications as read";
+    case "DELETE_ALL_INBOX_NOTIFICATIONS_ERROR":
+      return "Could not delete all inbox notifications";
+    case "UPDATE_NOTIFICATION_SETTINGS_ERROR":
+      return "Could not update notification settings";
+    default:
+      return assertNever(context, "Unhandled case");
+  }
+}
+
 // src/room.ts
 var MAX_SOCKET_MESSAGE_SIZE = 1024 * 1024 - 1024;
 function makeIdFactory(connectionId) {
@@ -6394,13 +6476,17 @@ function createRoom(options, config) {
   managedSocket.events.statusDidChange.subscribe(handleConnectionLossEvent);
   managedSocket.events.didConnect.subscribe(onDidConnect);
   managedSocket.events.didDisconnect.subscribe(onDidDisconnect);
-  managedSocket.events.onLiveblocksError.subscribe((err) => {
-    if (process.env.NODE_ENV !== "production") {
-      error2(
-        `Connection to websocket server closed. Reason: ${err.message} (code: ${err.code}).`
-      );
+  managedSocket.events.onConnectionError.subscribe(({ message, code }) => {
+    const type = "ROOM_CONNECTION_ERROR";
+    const err = new LiveblocksError(message, { type, code, roomId });
+    const didNotify = config.errorEventSource.notify(err);
+    if (!didNotify) {
+      if (process.env.NODE_ENV !== "production") {
+        error2(
+          `Connection to websocket server closed. Reason: ${message} (code: ${code}).`
+        );
+      }
     }
-    eventHub.error.notify(err);
   });
   const pool = {
     roomId: config.roomId,
@@ -6463,7 +6549,6 @@ function createRoom(options, config) {
     self: makeEventSource(),
     myPresence: makeEventSource(),
     others: makeEventSource(),
-    error: makeEventSource(),
     storageBatch: makeEventSource(),
     history: makeEventSource(),
     storageDidLoad: makeEventSource(),
@@ -6942,6 +7027,7 @@ function createRoom(options, config) {
           processInitialStorage(message);
           break;
         }
+        // Write event
         case 201 /* UPDATE_STORAGE */: {
           const applyResult = applyOps(message.ops, false);
           for (const [key, value] of applyResult.updates.storageUpdates) {
@@ -6952,6 +7038,11 @@ function createRoom(options, config) {
           }
           break;
         }
+        // Receiving a RejectedOps message in the client means that the server is no
+        // longer in sync with the client. Trying to synchronize the client again by
+        // rolling back particular Ops may be hard/impossible. It's fine to not try and
+        // accept the out-of-sync reality and throw an error. We look at this kind of bug
+        // as a developer-owned bug. In production, these errors are not expected to happen.
         case 299 /* REJECT_STORAGE_OP */: {
           errorWithTitle(
             "Storage mutation rejection error",
@@ -7295,7 +7386,6 @@ ${Array.from(traces).join("\n\n")}`
     others: eventHub.others.observable,
     self: eventHub.self.observable,
     myPresence: eventHub.myPresence.observable,
-    error: eventHub.error.observable,
     /** @deprecated */
     storage: eventHub.storageBatch.observable,
     storageBatch: eventHub.storageBatch.observable,
@@ -7486,7 +7576,11 @@ ${Array.from(traces).join("\n\n")}`
         attachmentUrlsStore: httpClient.getOrCreateAttachmentUrlsStore(roomId)
       },
       id: config.roomId,
-      subscribe: makeClassicSubscribeFn(events),
+      subscribe: makeClassicSubscribeFn(
+        config.roomId,
+        events,
+        config.errorEventSource
+      ),
       connect: () => managedSocket.connect(),
       reconnect: () => managedSocket.reconnect(),
       disconnect: () => managedSocket.disconnect(),
@@ -7555,7 +7649,7 @@ ${Array.from(traces).join("\n\n")}`
     { enumerable: false }
   );
 }
-function makeClassicSubscribeFn(events) {
+function makeClassicSubscribeFn(roomId, events, errorEvents) {
   function subscribeToLiveStructureDeeply(node, callback) {
     return events.storageBatch.subscribe((updates) => {
       const relatedUpdates = updates.filter(
@@ -7595,8 +7689,13 @@ function makeClassicSubscribeFn(events) {
             return cb(others, internalEvent);
           });
         }
-        case "error":
-          return events.error.subscribe(callback);
+        case "error": {
+          return errorEvents.subscribe((err) => {
+            if (err.roomId === roomId) {
+              return callback(err);
+            }
+          });
+        }
         case "status":
           return events.status.subscribe(callback);
         case "lost-connection":
@@ -7613,6 +7712,7 @@ function makeClassicSubscribeFn(events) {
           return events.comments.subscribe(
             callback
           );
+        // istanbul ignore next
         default:
           return assertNever(
             first,
@@ -7767,6 +7867,7 @@ function createClient(options) {
         },
         enableDebugLogging: clientOptions.enableDebugLogging,
         baseUrl,
+        errorEventSource: liveblocksErrorSource,
         unstable_fallbackToHTTP: !!clientOptions.unstable_fallbackToHTTP,
         unstable_streamData: !!clientOptions.unstable_streamData,
         roomHttpClient: httpClient,
@@ -7849,6 +7950,7 @@ function createClient(options) {
   }
   const syncStatusSources = [];
   const syncStatusSignal = new Signal("synchronized");
+  const liveblocksErrorSource = makeEventSource();
   function getSyncStatus() {
     const status = syncStatusSignal.get();
     return status === "synchronizing" ? status : "synchronized";
@@ -7908,6 +8010,7 @@ function createClient(options) {
       },
       getSyncStatus,
       events: {
+        error: liveblocksErrorSource,
         syncStatus: syncStatusSignal
       },
       // Internal
@@ -7923,7 +8026,14 @@ function createClient(options) {
         httpClient,
         // Type-level helper only, it's effectively only an identity-function at runtime
         as: () => client,
-        createSyncSource
+        createSyncSource,
+        emitError: (context, cause) => {
+          const error3 = LiveblocksError.from(context, cause);
+          const didNotify = liveblocksErrorSource.notify(error3);
+          if (!didNotify) {
+            error2(error3.message);
+          }
+        }
       }
     },
     kInternal,
@@ -8901,6 +9011,7 @@ export {
   LiveList,
   LiveMap,
   LiveObject,
+  LiveblocksError,
   MutableSignal,
   NotificationsApiError,
   OpCode,
@@ -8950,6 +9061,7 @@ export {
   isLiveNode,
   isPlainObject,
   isRootCrdt,
+  isStartsWithOperator,
   kInternal,
   legacy_patchImmutableObject,
   lsonToJson,
@@ -8971,7 +9083,6 @@ export {
   toAbsoluteUrl,
   toPlainLson,
   tryParseJson,
-  unstringify,
   url,
   urljoin,
   wait,