@liveblocks/node 1.8.1 → 1.8.3-oss1

package/dist/index.js

@@ -1,11 +1,16 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { newObj[key] = obj[key]; } } } newObj.default = obj; return newObj; } } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }// src/utils.ts
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { newObj[key] = obj[key]; } } } newObj.default = obj; return newObj; } } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }// src/index.ts
+var _core = require('@liveblocks/core');
+
+// src/version.ts
+var PKG_NAME = "@liveblocks/node";
+var PKG_VERSION = "1.8.3-oss1";
+var PKG_FORMAT = "cjs";
+
+// src/utils.ts
 var DEFAULT_BASE_URL = "https://api.liveblocks.io";
 async function fetchPolyfill() {
   return typeof globalThis.fetch !== "undefined" ? globalThis.fetch : (await Promise.resolve().then(() => _interopRequireWildcard(require("node-fetch")))).default;
 }
-function isSomething(input) {
-  return input !== null && input !== void 0;
-}
 function isNonEmpty(value) {
   return typeof value === "string" && value.length > 0;
 }
@@ -96,6 +101,13 @@ function buildLiveblocksAuthorizeEndpoint(options, roomId) {
   return urljoin(options.baseUrl || DEFAULT_BASE_URL, path);
 }
 
+// src/client.ts
+
+
+
+
+
+
 // src/Session.ts
 var ALL_PERMISSIONS = Object.freeze([
   "room:write",
@@ -276,6 +288,7 @@ var Liveblocks = class {
   /** @internal */
   async get(path, params) {
     const url2 = urljoin(this._baseUrl, path, params);
+    console.log("url", url2);
     const headers = {
       Authorization: `Bearer ${this._secret}`
     };
@@ -303,7 +316,7 @@ var Liveblocks = class {
    *
    */
   prepareSession(userId, options) {
-    return new Session(this.post.bind(this), userId, _optionalChain([options, 'optionalAccess', _2 => _2.userInfo]));
+    return new Session(this.post.bind(this), userId, _optionalChain([options, 'optionalAccess', _ => _.userInfo]));
   }
   /**
    * Call this to authenticate the user as an actor you want to allow to use
@@ -348,7 +361,7 @@ var Liveblocks = class {
         userId,
         groupIds,
         // Optional metadata
-        userInfo: _optionalChain([options, 'optionalAccess', _3 => _3.userInfo])
+        userInfo: _optionalChain([options, 'optionalAccess', _2 => _2.userInfo])
       });
       return {
         status: normalizeStatusCode(resp.status),
@@ -758,12 +771,17 @@ var Liveblocks = class {
    */
   async getThreads(params) {
     const { roomId } = params;
-    const res = await this.get(url`/v2/rooms/${roomId}/threads`);
+    const res = await this.get(url`/v2/rooms/${roomId}/threads`, {
+      "metadata.resolved": "false"
+    });
     if (!res.ok) {
       const text = await res.text();
       throw new LiveblocksError(res.status, text);
     }
-    return await res.json();
+    const { data } = await res.json();
+    return {
+      data: data.map((thread) => _core.convertToThreadData.call(void 0, thread))
+    };
   }
   /**
    * Gets a thread.
@@ -779,7 +797,9 @@ var Liveblocks = class {
       const text = await res.text();
       throw new LiveblocksError(res.status, text);
     }
-    return await res.json();
+    return _core.convertToThreadData.call(void 0, 
+      await res.json()
+    );
   }
   /**
    * Gets a thread's participants.
@@ -819,319 +839,181 @@ var Liveblocks = class {
       const text = await res.text();
       throw new LiveblocksError(res.status, text);
     }
-    return await res.json();
+    return _core.convertToCommentData.call(void 0, await res.json());
   }
-};
-var LiveblocksError = class extends Error {
-  constructor(status, message = "") {
-    super(message);
-    this.name = "LiveblocksError";
-    this.status = status;
-  }
-};
-
-// src/comment-body.ts
-function isCommentBodyParagraph(element) {
-  return "type" in element && element.type === "mention";
-}
-function isCommentBodyText(element) {
-  return "text" in element && typeof element.text === "string";
-}
-function isCommentBodyMention(element) {
-  return "type" in element && element.type === "mention";
-}
-function isCommentBodyLink(element) {
-  return "type" in element && element.type === "link";
-}
-var commentBodyElementsGuards = {
-  paragraph: isCommentBodyParagraph,
-  text: isCommentBodyText,
-  link: isCommentBodyLink,
-  mention: isCommentBodyMention
-};
-var commentBodyElementsTypes = {
-  paragraph: "block",
-  text: "inline",
-  link: "inline",
-  mention: "inline"
-};
-function traverseCommentBody(body, elementOrVisitor, possiblyVisitor) {
-  if (!body || !_optionalChain([body, 'optionalAccess', _4 => _4.content])) {
-    return;
-  }
-  const element = typeof elementOrVisitor === "string" ? elementOrVisitor : void 0;
-  const type = element ? commentBodyElementsTypes[element] : "all";
-  const guard = element ? commentBodyElementsGuards[element] : () => true;
-  const visitor = typeof elementOrVisitor === "function" ? elementOrVisitor : possiblyVisitor;
-  for (const block of body.content) {
-    if (type === "all" || type === "block") {
-      if (guard(block)) {
-        _optionalChain([visitor, 'optionalCall', _5 => _5(block)]);
+  /**
+   * Creates a comment.
+   *
+   * @param params.roomId The room ID to create the comment in.
+   * @param params.threadId The thread ID to create the comment in.
+   * @param params.data.userId The user ID of the user who is set to create the comment.
+   * @param params.data.createdAt (optional) The date the comment is set to be created.
+   * @param params.data.body The body of the comment.
+   * @returns The created comment.
+   */
+  async createComment(params) {
+    const { roomId, threadId, data } = params;
+    const res = await this.post(
+      url`/v2/rooms/${roomId}/threads/${threadId}/comments`,
+      {
+        ...data,
+        createdAt: _optionalChain([data, 'access', _3 => _3.createdAt, 'optionalAccess', _4 => _4.toISOString, 'call', _5 => _5()])
       }
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
     }
-    if (type === "all" || type === "inline") {
-      for (const inline of block.children) {
-        if (guard(inline)) {
-          _optionalChain([visitor, 'optionalCall', _6 => _6(inline)]);
-        }
+    return _core.convertToCommentData.call(void 0, await res.json());
+  }
+  /**
+   * Edits a comment.
+   * @param params.roomId The room ID to edit the comment in.
+   * @param params.threadId The thread ID to edit the comment in.
+   * @param params.commentId The comment ID to edit.
+   * @param params.data.body The body of the comment.
+   * @param params.data.editedAt (optional) The date the comment was edited.
+   * @returns The edited comment.
+   */
+  async editComment(params) {
+    const { roomId, threadId, commentId, data } = params;
+    const res = await this.post(
+      url`/v2/rooms/${roomId}/threads/${threadId}/comments/${commentId}`,
+      {
+        ...data,
+        editedAt: _optionalChain([data, 'access', _6 => _6.editedAt, 'optionalAccess', _7 => _7.toISOString, 'call', _8 => _8()])
       }
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
     }
+    return _core.convertToCommentData.call(void 0, await res.json());
   }
-}
-function getMentionedIdsFromCommentBody(body) {
-  const mentionedIds = /* @__PURE__ */ new Set();
-  traverseCommentBody(
-    body,
-    "mention",
-    (mention) => mentionedIds.add(mention.id)
-  );
-  return Array.from(mentionedIds);
-}
-async function resolveUsersInCommentBody(body, resolveUsers) {
-  const resolvedUsers = /* @__PURE__ */ new Map();
-  if (!resolveUsers) {
-    return resolvedUsers;
-  }
-  const userIds = getMentionedIdsFromCommentBody(body);
-  const users = await resolveUsers({
-    userIds
-  });
-  for (const [index, userId] of userIds.entries()) {
-    const user = _optionalChain([users, 'optionalAccess', _7 => _7[index]]);
-    if (user) {
-      resolvedUsers.set(userId, user);
+  /**
+   * Deletes a comment. Deletes a comment. If there are no remaining comments in the thread, the thread is also deleted.
+   * @param params.roomId The room ID to delete the comment in.
+   * @param params.threadId The thread ID to delete the comment in.
+   * @param params.commentId The comment ID to delete.
+   */
+  async deleteComment(params) {
+    const { roomId, threadId, commentId } = params;
+    const res = await this.delete(
+      url`/v2/rooms/${roomId}/threads/${threadId}/comments/${commentId}`
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
     }
   }
-  return resolvedUsers;
-}
-var htmlEscapables = {
-  "&": "&amp;",
-  "<": "&lt;",
-  ">": "&gt;",
-  '"': "&quot;",
-  "'": "&#39;"
-};
-var htmlEscapablesRegex = new RegExp(
-  Object.keys(htmlEscapables).map((entity) => `\\${entity}`).join("|"),
-  "g"
-);
-function htmlSafe(value) {
-  return new HtmlSafeString([String(value)], []);
-}
-function joinHtml(strings) {
-  if (strings.length <= 0) {
-    return new HtmlSafeString([""], []);
-  }
-  return new HtmlSafeString(
-    ["", ...Array(strings.length - 1).fill(""), ""],
-    strings
-  );
-}
-function escapeHtml(value) {
-  if (value instanceof HtmlSafeString) {
-    return value.toString();
-  }
-  if (Array.isArray(value)) {
-    return joinHtml(value).toString();
-  }
-  return String(value).replace(
-    htmlEscapablesRegex,
-    (character) => htmlEscapables[character]
-  );
-}
-var HtmlSafeString = class {
-  constructor(strings, values) {
-    this._strings = strings;
-    this._values = values;
-  }
-  toString() {
-    return this._strings.reduce((result, str, i) => {
-      return result + escapeHtml(this._values[i - 1]) + str;
-    });
-  }
-};
-function html(strings, ...values) {
-  return new HtmlSafeString(strings, values);
-}
-var markdownEscapables = {
-  _: "\\_",
-  "*": "\\*",
-  "#": "\\#",
-  "`": "\\`",
-  "~": "\\~",
-  "!": "\\!",
-  "|": "\\|",
-  "(": "\\(",
-  ")": "\\)",
-  "{": "\\{",
-  "}": "\\}",
-  "[": "\\[",
-  "]": "\\]"
-};
-var markdownEscapablesRegex = new RegExp(
-  Object.keys(markdownEscapables).map((entity) => `\\${entity}`).join("|"),
-  "g"
-);
-function joinMarkdown(strings) {
-  if (strings.length <= 0) {
-    return new MarkdownSafeString([""], []);
-  }
-  return new MarkdownSafeString(
-    ["", ...Array(strings.length - 1).fill(""), ""],
-    strings
-  );
-}
-function escapeMarkdown(value) {
-  if (value instanceof MarkdownSafeString) {
-    return value.toString();
-  }
-  if (Array.isArray(value)) {
-    return joinMarkdown(value).toString();
-  }
-  return String(value).replace(
-    markdownEscapablesRegex,
-    (character) => markdownEscapables[character]
-  );
-}
-var MarkdownSafeString = class {
-  constructor(strings, values) {
-    this._strings = strings;
-    this._values = values;
-  }
-  toString() {
-    return this._strings.reduce((result, str, i) => {
-      return result + escapeMarkdown(this._values[i - 1]) + str;
+  /**
+   * Creates a new thread. The thread will be created with the specified comment as its first comment.
+   * If the thread already exists, a `LiveblocksError` will be thrown with status code 409.
+   * @param params.roomId The room ID to create the thread in.
+   * @param params.thread.metadata (optional) The metadata for the thread. Supports upto a maximum of 10 entries. Value must be a string, boolean or number
+   * @param params.thread.comment.userId The user ID of the user who created the comment.
+   * @param params.thread.comment.createdAt (optional) The date the comment was created.
+   * @param params.thread.comment.body The body of the comment.
+   * @returns The created thread. The thread will be created with the specified comment as its first comment.
+   */
+  async createThread(params) {
+    const { roomId, data } = params;
+    const res = await this.post(url`/v2/rooms/${roomId}/threads`, {
+      ...data,
+      comment: {
+        ...data.comment,
+        createdAt: _optionalChain([data, 'access', _9 => _9.comment, 'access', _10 => _10.createdAt, 'optionalAccess', _11 => _11.toISOString, 'call', _12 => _12()])
+      }
     });
-  }
-};
-function markdown(strings, ...values) {
-  return new MarkdownSafeString(strings, values);
-}
-function toAbsoluteUrl(url2) {
-  if (url2.startsWith("http://") || url2.startsWith("https://")) {
-    return url2;
-  } else if (url2.startsWith("www.")) {
-    return "https://" + url2;
-  }
-  return;
-}
-var stringifyCommentBodyPlainElements = {
-  paragraph: ({ children }) => children,
-  text: ({ element }) => element.text,
-  link: ({ element }) => element.url,
-  mention: ({ element, user }) => {
-    return `@${_nullishCoalesce(_optionalChain([user, 'optionalAccess', _8 => _8.name]), () => ( element.id))}`;
-  }
-};
-var stringifyCommentBodyHtmlElements = {
-  paragraph: ({ children }) => {
-    return children ? html`<p>${htmlSafe(children)}</p>` : children;
-  },
-  text: ({ element }) => {
-    let children = element.text;
-    if (!children) {
-      return children;
-    }
-    if (element.bold) {
-      children = html`<strong>${children}</strong>`;
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
     }
-    if (element.italic) {
-      children = html`<em>${children}</em>`;
+    return _core.convertToThreadData.call(void 0, 
+      await res.json()
+    );
+  }
+  /**
+   * Updates the metadata of the specified thread in a room.
+   * @param params.roomId The room ID to update the thread in.
+   * @param params.threadId The thread ID to update.
+   * @param params.data.metadata The metadata for the thread. Value must be a string, boolean or number
+   * @param params.data.userId The user ID of the user who updated the thread.
+   * @param params.data.updatedAt (optional) The date the thread is set to be updated.
+   * @returns The updated thread.
+   */
+  async editThreadMetadata(params) {
+    const { roomId, threadId, data } = params;
+    const res = await this.post(
+      url`/v2/rooms/${roomId}/threads/${threadId}/metadata`,
+      {
+        ...data,
+        updatedAt: _optionalChain([data, 'access', _13 => _13.updatedAt, 'optionalAccess', _14 => _14.toISOString, 'call', _15 => _15()])
+      }
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
     }
-    if (element.strikethrough) {
-      children = html`<s>${children}</s>`;
+    return await res.json();
+  }
+  /**
+   * Adds a new comment reaction to a comment.
+   * @param params.roomId The room ID to add the comment reaction in.
+   * @param params.threadId The thread ID to add the comment reaction in.
+   * @param params.commentId The comment ID to add the reaction in.
+   * @param params.data.emoji The (emoji) reaction to add.
+   * @param params.data.userId The user ID of the user associated with the reaction.
+   * @param params.data.createdAt (optional) The date the reaction is set to be created.
+   * @returns The created comment reaction.
+   */
+  async addCommentReaction(params) {
+    const { roomId, threadId, commentId, data } = params;
+    const res = await this.post(
+      url`/v2/rooms/${roomId}/threads/${threadId}/comments/${commentId}/add-reaction`,
+      {
+        ...data,
+        createdAt: _optionalChain([data, 'access', _16 => _16.createdAt, 'optionalAccess', _17 => _17.toISOString, 'call', _18 => _18()])
+      }
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
     }
-    if (element.code) {
-      children = html`<code>${children}</code>`;
+    const reaction = await res.json();
+    return _core.convertToCommentUserReaction.call(void 0, reaction);
+  }
+  /**
+   * Removes a reaction from a comment.
+   * @param params.roomId The room ID to remove the comment reaction from.
+   * @param params.threadId The thread ID to remove the comment reaction from.
+   * @param params.commentId The comment ID to remove the reaction from.
+   * @param params.data.emoji The (emoji) reaction to remove.
+   * @param params.data.userId The user ID of the user associated with the reaction.
+   * @param params.data.removedAt (optional) The date the reaction is set to be removed.
+   */
+  async removeCommentReaction(params) {
+    const { roomId, threadId, data } = params;
+    const res = await this.post(
+      url`/v2/rooms/${roomId}/threads/${threadId}/comments/${params.commentId}/remove-reaction`,
+      {
+        ...data,
+        removedAt: _optionalChain([data, 'access', _19 => _19.removedAt, 'optionalAccess', _20 => _20.toISOString, 'call', _21 => _21()])
+      }
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
     }
-    return children;
-  },
-  link: ({ element, href }) => {
-    return html`<a href="${href}" target="_blank" rel="noopener noreferrer">${element.url}</a>`;
-  },
-  mention: ({ element, user }) => {
-    return html`<span data-mention>@${_nullishCoalesce(_optionalChain([user, 'optionalAccess', _9 => _9.name]), () => ( element.id))}</span>`;
   }
 };
-var stringifyCommentBodyMarkdownElements = {
-  paragraph: ({ children }) => {
-    return children;
-  },
-  text: ({ element }) => {
-    let children = element.text;
-    if (!children) {
-      return children;
-    }
-    if (element.bold) {
-      children = markdown`**${children}**`;
-    }
-    if (element.italic) {
-      children = markdown`_${children}_`;
-    }
-    if (element.strikethrough) {
-      children = markdown`~~${children}~~`;
-    }
-    if (element.code) {
-      children = markdown`\`${children}\``;
-    }
-    return children;
-  },
-  link: ({ element, href }) => {
-    return markdown`[${element.url}](${href})`;
-  },
-  mention: ({ element, user }) => {
-    return markdown`@${_nullishCoalesce(_optionalChain([user, 'optionalAccess', _10 => _10.name]), () => ( element.id))}`;
+var LiveblocksError = class extends Error {
+  constructor(status, message = "") {
+    super(message);
+    this.name = "LiveblocksError";
+    this.status = status;
   }
 };
-async function stringifyCommentBody(body, options) {
-  const format = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _11 => _11.format]), () => ( "plain"));
-  const separator = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _12 => _12.separator]), () => ( (format === "markdown" ? "\n\n" : "\n")));
-  const elements = {
-    ...format === "html" ? stringifyCommentBodyHtmlElements : format === "markdown" ? stringifyCommentBodyMarkdownElements : stringifyCommentBodyPlainElements,
-    ..._optionalChain([options, 'optionalAccess', _13 => _13.elements])
-  };
-  const resolvedUsers = await resolveUsersInCommentBody(
-    body,
-    _optionalChain([options, 'optionalAccess', _14 => _14.resolveUsers])
-  );
-  const blocks = body.content.map((block, blockIndex) => {
-    switch (block.type) {
-      case "paragraph": {
-        const paragraph = block.children.map((inline, inlineIndex) => {
-          if (isCommentBodyMention(inline)) {
-            return inline.id ? elements.mention(
-              {
-                element: inline,
-                user: resolvedUsers.get(inline.id)
-              },
-              inlineIndex
-            ) : null;
-          }
-          if (isCommentBodyLink(inline)) {
-            return elements.link(
-              {
-                element: inline,
-                href: _nullishCoalesce(toAbsoluteUrl(inline.url), () => ( inline.url))
-              },
-              inlineIndex
-            );
-          }
-          if (isCommentBodyText(inline)) {
-            return elements.text({ element: inline }, inlineIndex);
-          }
-          return null;
-        }).filter(isSomething).join("");
-        return elements.paragraph(
-          { element: block, children: paragraph },
-          blockIndex
-        );
-      }
-      default:
-        return null;
-    }
-  });
-  return blocks.filter(isSomething).join(separator);
-}
 
 // src/webhooks.ts
 var _base64 = require('@stablelib/base64'); var base64 = _interopRequireWildcard(_base64);
@@ -1151,11 +1033,15 @@ var _WebhookHandler = class _WebhookHandler {
    * Verifies a webhook request and returns the event
    */
   verifyRequest(request) {
-    const { webhookId, timestamp, rawSignatures } = this.verifyHeaders(
-      request.headers
-    );
+    const { headers, rawBody } = request;
+    const { webhookId, timestamp, rawSignatures } = this.verifyHeaders(headers);
+    if (typeof rawBody !== "string") {
+      throw new Error(
+        `Invalid rawBody field, must be a string, got "${typeof rawBody}" instead. It is likely that you need to JSON.stringify the body before passing it.`
+      );
+    }
     this.verifyTimestamp(timestamp);
-    const signature = this.sign(`${webhookId}.${timestamp}.${request.rawBody}`);
+    const signature = this.sign(`${webhookId}.${timestamp}.${rawBody}`);
     const expectedSignatures = rawSignatures.split(" ").map((rawSignature) => {
       const [, parsedSignature] = rawSignature.split(",");
       return parsedSignature;
@@ -1166,7 +1052,7 @@ var _WebhookHandler = class _WebhookHandler {
           ", "
         )}, got ${signature}`
       );
-    const event = JSON.parse(request.rawBody);
+    const event = JSON.parse(rawBody);
     this.verifyWebhookEventType(event);
     return event;
   }
@@ -1248,10 +1134,17 @@ var WebhookHandler = _WebhookHandler;
 var WEBHOOK_TOLERANCE_IN_SECONDS = 5 * 60;
 var isNotUndefined = (value) => value !== void 0;
 
+// src/index.ts
+
+
+
+
+_core.detectDupes.call(void 0, PKG_NAME, PKG_VERSION, PKG_FORMAT);
+
 
 
 
 
 
-exports.Liveblocks = Liveblocks; exports.WebhookHandler = WebhookHandler; exports.authorize = authorize; exports.getMentionedIdsFromCommentBody = getMentionedIdsFromCommentBody; exports.stringifyCommentBody = stringifyCommentBody;
+exports.Liveblocks = Liveblocks; exports.WebhookHandler = WebhookHandler; exports.authorize = authorize; exports.getMentionedIdsFromCommentBody = _core.getMentionedIdsFromCommentBody; exports.stringifyCommentBody = _core.stringifyCommentBody;
 //# sourceMappingURL=index.js.map