@liveblocks/core 3.6.0 → 3.7.0-preview1

package/dist/index.js

@@ -6,7 +6,7 @@ var __export = (target, all) => {
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/core";
-var PKG_VERSION = "3.6.0";
+var PKG_VERSION = "3.7.0-preview1";
 var PKG_FORMAT = "esm";
 
 // src/dupe-detection.ts
@@ -851,6 +851,38 @@ function convertToSubscriptionDeleteInfo(data) {
     deletedAt
   };
 }
+function convertToGroupData(data) {
+  const createdAt = new Date(data.createdAt);
+  const updatedAt = new Date(data.updatedAt);
+  const members = data.members.map((member) => ({
+    ...member,
+    addedAt: new Date(member.addedAt)
+  }));
+  return {
+    ...data,
+    createdAt,
+    updatedAt,
+    members
+  };
+}
+
+// src/lib/assert.ts
+function assertNever(_value, errmsg) {
+  throw new Error(errmsg);
+}
+function assert(condition, errmsg) {
+  if (process.env.NODE_ENV !== "production") {
+    if (!condition) {
+      const err = new Error(errmsg);
+      err.name = "Assertion failure";
+      throw err;
+    }
+  }
+}
+function nn(value, errmsg = "Expected value to be non-nullable") {
+  assert(value !== null && value !== void 0, errmsg);
+  return value;
+}
 
 // src/lib/fancy-console.ts
 var fancy_console_exports = {};
@@ -1128,11 +1160,20 @@ function createBatchStore(batch2) {
       });
     }
   }
+  function fill(input, data) {
+    const cacheKey = getCacheKey(input);
+    update(cacheKey, { isLoading: false, data });
+  }
   function getItemState(input) {
     const cacheKey = getCacheKey(input);
     const cache = signal.get();
     return cache.get(cacheKey);
   }
+  function getData(input) {
+    const cacheKey = getCacheKey(input);
+    const cache = signal.get();
+    return cache.get(cacheKey)?.data;
+  }
   function _cacheKeys() {
     const cache = signal.get();
     return [...cache.keys()];
@@ -1140,7 +1181,9 @@ function createBatchStore(batch2) {
   return {
     subscribe: signal.subscribe,
     enqueue,
+    fill,
     getItemState,
+    getData,
     invalidate,
     batch: batch2,
     _cacheKeys
@@ -1962,6 +2005,9 @@ function createApiClient({
     return batch2.get(options.inboxNotificationId);
   }
   async function createTextMention(options) {
+    if (options.mention.kind !== "user" && options.mention.kind !== "group") {
+      return assertNever(options.mention, "Unexpected mention kind");
+    }
     await httpClient.rawPost(
       url`/v2/c/rooms/${options.roomId}/text-mentions`,
       await authManager.getAuthValue({
@@ -1969,7 +2015,9 @@ function createApiClient({
         roomId: options.roomId
       }),
       {
-        userId: options.userId,
+        userId: options.mention.kind === "user" ? options.mention.id : void 0,
+        groupId: options.mention.kind === "group" ? options.mention.id : void 0,
+        userIds: options.mention.kind === "group" ? options.mention.userIds : void 0,
         mentionId: options.mentionId
       }
     );
@@ -2108,6 +2156,10 @@ function createApiClient({
         limit: PAGE_SIZE
       }
     );
+    const groups = json.groups.map(convertToGroupData);
+    for (const group of groups) {
+      groupsStore.fill(group.id, group);
+    }
     return {
       inboxNotifications: json.inboxNotifications.map(
         convertToInboxNotificationData
@@ -2258,6 +2310,28 @@ function createApiClient({
       permissionHints: json.meta.permissionHints
     };
   }
+  const batchedGetGroups = new Batch(
+    async (batchedGroupIds) => {
+      const groupIds = batchedGroupIds.flat();
+      const { groups: plainGroups } = await httpClient.post(
+        url`/v2/c/groups/find`,
+        await authManager.getAuthValue({
+          requestedScope: "comments:read"
+        }),
+        { groupIds }
+      );
+      const groups = /* @__PURE__ */ new Map();
+      for (const group of plainGroups) {
+        groups.set(group.id, convertToGroupData(group));
+      }
+      return groupIds.map((groupId) => groups.get(groupId));
+    },
+    { delay: 50 }
+  );
+  const groupsStore = createBatchStore(batchedGetGroups);
+  function getGroup(groupId) {
+    return batchedGetGroups.get(groupId);
+  }
   return {
     // Room threads
     getThreads,
@@ -2311,6 +2385,9 @@ function createApiClient({
     // User threads
     getUserThreads_experimental,
     getUserThreadsSince_experimental,
+    // Groups
+    groupsStore,
+    getGroup,
     // AI
     executeContextualPrompt
   };
@@ -2468,24 +2545,6 @@ var HttpClient = class {
   }
 };
 
-// src/lib/assert.ts
-function assertNever(_value, errmsg) {
-  throw new Error(errmsg);
-}
-function assert(condition, errmsg) {
-  if (process.env.NODE_ENV !== "production") {
-    if (!condition) {
-      const err = new Error(errmsg);
-      err.name = "Assertion failure";
-      throw err;
-    }
-  }
-}
-function nn(value, errmsg = "Expected value to be non-nullable") {
-  assert(value !== null && value !== void 0, errmsg);
-  return value;
-}
-
 // src/lib/fsm.ts
 function distance(state1, state2) {
   if (state1 === state2) {
@@ -5121,6 +5180,7 @@ async function fetchAuthEndpoint(fetch, endpoint, body) {
 
 // src/constants.ts
 var DEFAULT_BASE_URL = "https://api.liveblocks.io";
+var MENTION_CHARACTER = "@";
 
 // src/devtools/bridge.ts
 var _bridgeActive = false;
@@ -5340,6 +5400,22 @@ function unlinkDevTools(roomId) {
   });
 }
 
+// src/lib/warnings.ts
+var _emittedWarnings = /* @__PURE__ */ new Set();
+function warnOnce(message, key = message) {
+  if (process.env.NODE_ENV !== "production") {
+    if (!_emittedWarnings.has(key)) {
+      _emittedWarnings.add(key);
+      warn(message);
+    }
+  }
+}
+function warnOnceIf(condition, message, key = message) {
+  if (typeof condition === "function" ? condition() : condition) {
+    warnOnce(message, key);
+  }
+}
+
 // src/protocol/NotificationSettings.ts
 var kPlain = Symbol("notification-settings-plain");
 function createNotificationSettings(plain) {
@@ -8554,8 +8630,8 @@ function createRoom(options, config) {
     comments: makeEventSource(),
     roomWillDestroy: makeEventSource()
   };
-  async function createTextMention(userId, mentionId) {
-    return httpClient.createTextMention({ roomId, userId, mentionId });
+  async function createTextMention(mentionId, mention) {
+    return httpClient.createTextMention({ roomId, mentionId, mention });
   }
   async function deleteTextMention(mentionId) {
     return httpClient.deleteTextMention({ roomId, mentionId });
@@ -9876,6 +9952,7 @@ var MAX_LOST_CONNECTION_TIMEOUT = 3e4;
 var DEFAULT_LOST_CONNECTION_TIMEOUT = 5e3;
 var RESOLVE_USERS_BATCH_DELAY = 50;
 var RESOLVE_ROOMS_INFO_BATCH_DELAY = 50;
+var RESOLVE_GROUPS_INFO_BATCH_DELAY = 50;
 function getBaseUrl(baseUrl) {
   if (typeof baseUrl === "string" && baseUrl.startsWith("http")) {
     return baseUrl;
@@ -10033,15 +10110,14 @@ function createClient(options) {
     }
   }
   const resolveUsers = clientOptions.resolveUsers;
-  const warnIfNoResolveUsers = createDevelopmentWarning(
-    () => !resolveUsers,
-    "Set the resolveUsers option in createClient to specify user info."
-  );
   const batchedResolveUsers = new Batch(
     async (batchedUserIds) => {
       const userIds = batchedUserIds.flat();
       const users = await resolveUsers?.({ userIds });
-      warnIfNoResolveUsers();
+      warnOnceIf(
+        !resolveUsers,
+        "Set the resolveUsers option in createClient to specify user info."
+      );
       return users ?? userIds.map(() => void 0);
     },
     { delay: RESOLVE_USERS_BATCH_DELAY }
@@ -10051,15 +10127,14 @@ function createClient(options) {
     usersStore.invalidate(userIds);
   }
   const resolveRoomsInfo = clientOptions.resolveRoomsInfo;
-  const warnIfNoResolveRoomsInfo = createDevelopmentWarning(
-    () => !resolveRoomsInfo,
-    "Set the resolveRoomsInfo option in createClient to specify room info."
-  );
   const batchedResolveRoomsInfo = new Batch(
     async (batchedRoomIds) => {
       const roomIds = batchedRoomIds.flat();
       const roomsInfo = await resolveRoomsInfo?.({ roomIds });
-      warnIfNoResolveRoomsInfo();
+      warnOnceIf(
+        !resolveRoomsInfo,
+        "Set the resolveRoomsInfo option in createClient to specify room info."
+      );
       return roomsInfo ?? roomIds.map(() => void 0);
     },
     { delay: RESOLVE_ROOMS_INFO_BATCH_DELAY }
@@ -10068,6 +10143,23 @@ function createClient(options) {
   function invalidateResolvedRoomsInfo(roomIds) {
     roomsInfoStore.invalidate(roomIds);
   }
+  const resolveGroupsInfo = clientOptions.resolveGroupsInfo;
+  const batchedResolveGroupsInfo = new Batch(
+    async (batchedGroupIds) => {
+      const groupIds = batchedGroupIds.flat();
+      const groupsInfo = await resolveGroupsInfo?.({ groupIds });
+      warnOnceIf(
+        !resolveGroupsInfo,
+        "Set the resolveGroupsInfo option in createClient to specify group info."
+      );
+      return groupsInfo ?? groupIds.map(() => void 0);
+    },
+    { delay: RESOLVE_GROUPS_INFO_BATCH_DELAY }
+  );
+  const groupsInfoStore = createBatchStore(batchedResolveGroupsInfo);
+  function invalidateResolvedGroupsInfo(groupIds) {
+    groupsInfoStore.invalidate(groupIds);
+  }
   const mentionSuggestionsCache = /* @__PURE__ */ new Map();
   function invalidateResolvedMentionSuggestions() {
     mentionSuggestionsCache.clear();
@@ -10143,6 +10235,7 @@ function createClient(options) {
       resolvers: {
         invalidateUsers: invalidateResolvedUsers,
         invalidateRoomsInfo: invalidateResolvedRoomsInfo,
+        invalidateGroupsInfo: invalidateResolvedGroupsInfo,
         invalidateMentionSuggestions: invalidateResolvedMentionSuggestions
       },
       getSyncStatus,
@@ -10158,6 +10251,7 @@ function createClient(options) {
         resolveMentionSuggestions: clientOptions.resolveMentionSuggestions,
         usersStore,
         roomsInfoStore,
+        groupsInfoStore,
         getRoomIds() {
           return Array.from(roomsById.keys());
         },
@@ -10209,20 +10303,6 @@ function getLostConnectionTimeout(value) {
     RECOMMENDED_MIN_LOST_CONNECTION_TIMEOUT
   );
 }
-function createDevelopmentWarning(condition, ...args) {
-  let hasWarned = false;
-  if (process.env.NODE_ENV !== "production") {
-    return () => {
-      if (!hasWarned && (typeof condition === "function" ? condition() : condition)) {
-        warn(...args);
-        hasWarned = true;
-      }
-    };
-  } else {
-    return () => {
-    };
-  }
-}
 
 // src/comments/comment-body.ts
 function isCommentBodyParagraph(element) {
@@ -10287,25 +10367,42 @@ function getMentionsFromCommentBody(body, predicate) {
   });
   return mentions;
 }
-async function resolveUsersInCommentBody(body, resolveUsers) {
+async function resolveMentionsInCommentBody(body, resolveUsers, resolveGroupsInfo) {
   const resolvedUsers = /* @__PURE__ */ new Map();
-  if (!resolveUsers) {
-    return resolvedUsers;
+  const resolvedGroupsInfo = /* @__PURE__ */ new Map();
+  if (!resolveUsers && !resolveGroupsInfo) {
+    return {
+      users: resolvedUsers,
+      groups: resolvedGroupsInfo
+    };
   }
-  const userIds = getMentionsFromCommentBody(
-    body,
-    (mention) => mention.kind === "user"
-  ).map((mention) => mention.id);
-  const users = await resolveUsers({
-    userIds
-  });
-  for (const [index, userId] of userIds.entries()) {
-    const user = users?.[index];
-    if (user) {
-      resolvedUsers.set(userId, user);
+  const mentions = getMentionsFromCommentBody(body);
+  const userIds = mentions.filter((mention) => mention.kind === "user").map((mention) => mention.id);
+  const groupIds = mentions.filter((mention) => mention.kind === "group").map((mention) => mention.id);
+  const [users, groups] = await Promise.all([
+    resolveUsers && userIds.length > 0 ? resolveUsers({ userIds }) : void 0,
+    resolveGroupsInfo && groupIds.length > 0 ? resolveGroupsInfo({ groupIds }) : void 0
+  ]);
+  if (users) {
+    for (const [index, userId] of userIds.entries()) {
+      const user = users[index];
+      if (user) {
+        resolvedUsers.set(userId, user);
+      }
+    }
+  }
+  if (groups) {
+    for (const [index, groupId] of groupIds.entries()) {
+      const group = groups[index];
+      if (group) {
+        resolvedGroupsInfo.set(groupId, group);
+      }
     }
   }
-  return resolvedUsers;
+  return {
+    users: resolvedUsers,
+    groups: resolvedGroupsInfo
+  };
 }
 var htmlEscapables = {
   "&": "&",
@@ -10418,8 +10515,8 @@ var stringifyCommentBodyPlainElements = {
   paragraph: ({ children }) => children,
   text: ({ element }) => element.text,
   link: ({ element }) => element.text ?? element.url,
-  mention: ({ element, user }) => {
-    return `@${user?.name ?? element.id}`;
+  mention: ({ element, user, group }) => {
+    return `@${user?.name ?? group?.name ?? element.id}`;
   }
 };
 var stringifyCommentBodyHtmlElements = {
@@ -10448,8 +10545,8 @@ var stringifyCommentBodyHtmlElements = {
   link: ({ element, href }) => {
     return html`<a href="${href}" target="_blank" rel="noopener noreferrer">${element.text ? html`${element.text}` : element.url}</a>`;
   },
-  mention: ({ element, user }) => {
-    return html`<span data-mention>@${user?.name ? html`${user?.name}` : element.id}</span>`;
+  mention: ({ element, user, group }) => {
+    return html`<span data-mention>@${user?.name ? html`${user?.name}` : group?.name ? html`${group?.name}` : element.id}</span>`;
   }
 };
 var stringifyCommentBodyMarkdownElements = {
@@ -10478,8 +10575,8 @@ var stringifyCommentBodyMarkdownElements = {
   link: ({ element, href }) => {
     return markdown`[${element.text ?? element.url}](${href})`;
   },
-  mention: ({ element, user }) => {
-    return markdown`@${user?.name ?? element.id}`;
+  mention: ({ element, user, group }) => {
+    return markdown`@${user?.name ?? group?.name ?? element.id}`;
   }
 };
 async function stringifyCommentBody(body, options) {
@@ -10489,9 +10586,10 @@ async function stringifyCommentBody(body, options) {
     ...format === "html" ? stringifyCommentBodyHtmlElements : format === "markdown" ? stringifyCommentBodyMarkdownElements : stringifyCommentBodyPlainElements,
     ...options?.elements
   };
-  const resolvedUsers = await resolveUsersInCommentBody(
+  const { users: resolvedUsers, groups: resolvedGroupsInfo } = await resolveMentionsInCommentBody(
     body,
-    options?.resolveUsers
+    options?.resolveUsers,
+    options?.resolveGroupsInfo
   );
   const blocks = body.content.flatMap((block, blockIndex) => {
     switch (block.type) {
@@ -10502,7 +10600,8 @@ async function stringifyCommentBody(body, options) {
               elements.mention(
                 {
                   element: inline,
-                  user: resolvedUsers.get(inline.id)
+                  user: inline.kind === "user" ? resolvedUsers.get(inline.id) : void 0,
+                  group: inline.kind === "group" ? resolvedGroupsInfo.get(inline.id) : void 0
                 },
                 inlineIndex
               )
@@ -11056,6 +11155,7 @@ export {
   LiveMap,
   LiveObject,
   LiveblocksError,
+  MENTION_CHARACTER,
   MutableSignal,
   OpCode,
   Permission,
@@ -11079,6 +11179,7 @@ export {
   fancy_console_exports as console,
   convertToCommentData,
   convertToCommentUserReaction,
+  convertToGroupData,
   convertToInboxNotificationData,
   convertToSubscriptionData,
   convertToThreadData,
@@ -11132,7 +11233,7 @@ export {
   patchLiveObjectKey,
   patchNotificationSettings,
   raise,
-  resolveUsersInCommentBody,
+  resolveMentionsInCommentBody,
   sanitizeUrl,
   shallow,
   shallow2,
@@ -11144,6 +11245,8 @@ export {
   url,
   urljoin,
   wait,
+  warnOnce,
+  warnOnceIf,
   withTimeout
 };
 //# sourceMappingURL=index.js.map