@liveblocks/emails 2.21.0-emails2 → 2.21.0-emails3

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { BaseUserMeta, DU, ResolveUsersArgs, Awaitable, DRI, CommentBodyParagraph, CommentBodyText, CommentBodyLink, CommentBodyMention } from '@liveblocks/core';
+import { BaseUserMeta, DU, ResolveUsersArgs, Awaitable, DRI, CommentBodyText, CommentBodyLink, CommentBodyMention } from '@liveblocks/core';
 export { ResolveUsersArgs } from '@liveblocks/core';
 import { ReactNode, ComponentType } from 'react';
 import { Properties } from 'csstype';
@@ -209,75 +209,6 @@ type TextMentionNotificationEmailDataAsHtml = TextMentionNotificationEmailData<B
  */
 declare function prepareTextMentionNotificationEmailAsHtml(client: Liveblocks, event: TextMentionNotificationEvent, options?: PrepareTextMentionNotificationEmailAsHtmlOptions<BaseUserMeta>): Promise<TextMentionNotificationEmailDataAsHtml | null>;
 
-type CommentBodyContainerElementArgs<T> = {
-    /**
-     * The blocks of the comment body
-     */
-    children: T[];
-};
-type CommentBodyParagraphElementArgs<T> = {
-    /**
-     * The paragraph element.
-     */
-    element: CommentBodyParagraph;
-    /**
-     * The text content of the paragraph.
-     */
-    children: T[];
-};
-type CommentBodyTextElementArgs = {
-    /**
-     * The text element.
-     */
-    element: CommentBodyText;
-};
-type CommentBodyLinkElementArgs = {
-    /**
-     * The link element.
-     */
-    element: CommentBodyLink;
-    /**
-     * The absolute URL of the link.
-     */
-    href: string;
-};
-type CommentBodyMentionElementArgs<U extends BaseUserMeta = DU> = {
-    /**
-     * The mention element.
-     */
-    element: CommentBodyMention;
-    /**
-     * The mention's user info, if the `resolvedUsers` option was provided.
-     */
-    user?: U["info"];
-};
-/**
- * Protocol:
- * Comment body elements to be converted to a custom format `T`
- */
-type ConvertCommentBodyElements<T, U extends BaseUserMeta = DU> = {
-    /**
-     * The container element used to display comment body blocks.
-     */
-    container: (args: CommentBodyContainerElementArgs<T>) => T;
-    /**
-     * The paragraph element used to display paragraphs.
-     */
-    paragraph: (args: CommentBodyParagraphElementArgs<T>, index: number) => T;
-    /**
-     * The text element used to display text elements.
-     */
-    text: (args: CommentBodyTextElementArgs, index: number) => T;
-    /**
-     * The link element used to display links.
-     */
-    link: (args: CommentBodyLinkElementArgs, index: number) => T;
-    /**
-     * The mention element used to display mentions.
-     */
-    mention: (args: CommentBodyMentionElementArgs<U>, index: number) => T;
-};
-
 type CommentEmailData<BodyType, U extends BaseUserMeta = DU> = {
     id: string;
     threadId: string;
@@ -304,7 +235,7 @@ type CommentEmailAsReactData<U extends BaseUserMeta = DU> = CommentEmailData<Rea
     /** @deprecated Use `body` property instead. */
     reactBody: ReactNode;
 };
-type PrepareThreadNotificationEmailOptions<BodyType, U extends BaseUserMeta = DU> = {
+type PrepareThreadNotificationEmailOptions<U extends BaseUserMeta = DU> = {
     /**
      * A function that returns room info from room IDs.
      */
@@ -313,10 +244,6 @@ type PrepareThreadNotificationEmailOptions<BodyType, U extends BaseUserMeta = DU
      * A function that returns info from user IDs.
      */
     resolveUsers?: (args: ResolveUsersArgs) => Awaitable<(U["info"] | undefined)[] | undefined>;
-    /**
-     * Comments body elements customizations.
-     */
-    elements: ConvertCommentBodyElements<BodyType, U>;
 };
 /**
  * The styles used to customize the html elements in the resulting html safe string.
@@ -344,7 +271,7 @@ type ConvertCommentBodyAsHtmlStyles = {
      */
     link: CSSProperties;
 };
-type PrepareThreadNotificationEmailAsHtmlOptions<BodyType, U extends BaseUserMeta = DU> = Omit<PrepareThreadNotificationEmailOptions<BodyType, U>, "elements"> & {
+type PrepareThreadNotificationEmailAsHtmlOptions<U extends BaseUserMeta = DU> = PrepareThreadNotificationEmailOptions<U> & {
     /**
      * The styles used to customize the html elements in the resulting html safe string inside a comment body.
      * Each styles has priority over the base styles inherited.
@@ -378,7 +305,7 @@ type ThreadNotificationEmailDataAsHtml<U extends BaseUserMeta = DU> = ThreadNoti
  * )
  *
  */
-declare function prepareThreadNotificationEmailAsHtml(client: Liveblocks, event: ThreadNotificationEvent, options?: PrepareThreadNotificationEmailAsHtmlOptions<string, BaseUserMeta>): Promise<ThreadNotificationEmailDataAsHtml | null>;
+declare function prepareThreadNotificationEmailAsHtml(client: Liveblocks, event: ThreadNotificationEvent, options?: PrepareThreadNotificationEmailAsHtmlOptions<BaseUserMeta>): Promise<ThreadNotificationEmailDataAsHtml | null>;
 type CommentBodyContainerComponentProps = {
     /**
      * The blocks of the comment body
@@ -440,7 +367,7 @@ type ConvertCommentBodyAsReactComponents<U extends BaseUserMeta = DU> = {
      */
     Mention: ComponentType<CommentBodyMentionComponentProps<U>>;
 };
-type PrepareThreadNotificationEmailAsReactOptions<BodyType, U extends BaseUserMeta = DU> = Omit<PrepareThreadNotificationEmailOptions<BodyType, U>, "elements"> & {
+type PrepareThreadNotificationEmailAsReactOptions<U extends BaseUserMeta = DU> = PrepareThreadNotificationEmailOptions<U> & {
     /**
      * The components used to customize the resulting React nodes inside a comment body.
      * Each components has priority over the base components inherited internally defined.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { BaseUserMeta, DU, ResolveUsersArgs, Awaitable, DRI, CommentBodyParagraph, CommentBodyText, CommentBodyLink, CommentBodyMention } from '@liveblocks/core';
+import { BaseUserMeta, DU, ResolveUsersArgs, Awaitable, DRI, CommentBodyText, CommentBodyLink, CommentBodyMention } from '@liveblocks/core';
 export { ResolveUsersArgs } from '@liveblocks/core';
 import { ReactNode, ComponentType } from 'react';
 import { Properties } from 'csstype';
@@ -209,75 +209,6 @@ type TextMentionNotificationEmailDataAsHtml = TextMentionNotificationEmailData<B
  */
 declare function prepareTextMentionNotificationEmailAsHtml(client: Liveblocks, event: TextMentionNotificationEvent, options?: PrepareTextMentionNotificationEmailAsHtmlOptions<BaseUserMeta>): Promise<TextMentionNotificationEmailDataAsHtml | null>;
 
-type CommentBodyContainerElementArgs<T> = {
-    /**
-     * The blocks of the comment body
-     */
-    children: T[];
-};
-type CommentBodyParagraphElementArgs<T> = {
-    /**
-     * The paragraph element.
-     */
-    element: CommentBodyParagraph;
-    /**
-     * The text content of the paragraph.
-     */
-    children: T[];
-};
-type CommentBodyTextElementArgs = {
-    /**
-     * The text element.
-     */
-    element: CommentBodyText;
-};
-type CommentBodyLinkElementArgs = {
-    /**
-     * The link element.
-     */
-    element: CommentBodyLink;
-    /**
-     * The absolute URL of the link.
-     */
-    href: string;
-};
-type CommentBodyMentionElementArgs<U extends BaseUserMeta = DU> = {
-    /**
-     * The mention element.
-     */
-    element: CommentBodyMention;
-    /**
-     * The mention's user info, if the `resolvedUsers` option was provided.
-     */
-    user?: U["info"];
-};
-/**
- * Protocol:
- * Comment body elements to be converted to a custom format `T`
- */
-type ConvertCommentBodyElements<T, U extends BaseUserMeta = DU> = {
-    /**
-     * The container element used to display comment body blocks.
-     */
-    container: (args: CommentBodyContainerElementArgs<T>) => T;
-    /**
-     * The paragraph element used to display paragraphs.
-     */
-    paragraph: (args: CommentBodyParagraphElementArgs<T>, index: number) => T;
-    /**
-     * The text element used to display text elements.
-     */
-    text: (args: CommentBodyTextElementArgs, index: number) => T;
-    /**
-     * The link element used to display links.
-     */
-    link: (args: CommentBodyLinkElementArgs, index: number) => T;
-    /**
-     * The mention element used to display mentions.
-     */
-    mention: (args: CommentBodyMentionElementArgs<U>, index: number) => T;
-};
-
 type CommentEmailData<BodyType, U extends BaseUserMeta = DU> = {
     id: string;
     threadId: string;
@@ -304,7 +235,7 @@ type CommentEmailAsReactData<U extends BaseUserMeta = DU> = CommentEmailData<Rea
     /** @deprecated Use `body` property instead. */
     reactBody: ReactNode;
 };
-type PrepareThreadNotificationEmailOptions<BodyType, U extends BaseUserMeta = DU> = {
+type PrepareThreadNotificationEmailOptions<U extends BaseUserMeta = DU> = {
     /**
      * A function that returns room info from room IDs.
      */
@@ -313,10 +244,6 @@ type PrepareThreadNotificationEmailOptions<BodyType, U extends BaseUserMeta = DU
      * A function that returns info from user IDs.
      */
     resolveUsers?: (args: ResolveUsersArgs) => Awaitable<(U["info"] | undefined)[] | undefined>;
-    /**
-     * Comments body elements customizations.
-     */
-    elements: ConvertCommentBodyElements<BodyType, U>;
 };
 /**
  * The styles used to customize the html elements in the resulting html safe string.
@@ -344,7 +271,7 @@ type ConvertCommentBodyAsHtmlStyles = {
      */
     link: CSSProperties;
 };
-type PrepareThreadNotificationEmailAsHtmlOptions<BodyType, U extends BaseUserMeta = DU> = Omit<PrepareThreadNotificationEmailOptions<BodyType, U>, "elements"> & {
+type PrepareThreadNotificationEmailAsHtmlOptions<U extends BaseUserMeta = DU> = PrepareThreadNotificationEmailOptions<U> & {
     /**
      * The styles used to customize the html elements in the resulting html safe string inside a comment body.
      * Each styles has priority over the base styles inherited.
@@ -378,7 +305,7 @@ type ThreadNotificationEmailDataAsHtml<U extends BaseUserMeta = DU> = ThreadNoti
  * )
  *
  */
-declare function prepareThreadNotificationEmailAsHtml(client: Liveblocks, event: ThreadNotificationEvent, options?: PrepareThreadNotificationEmailAsHtmlOptions<string, BaseUserMeta>): Promise<ThreadNotificationEmailDataAsHtml | null>;
+declare function prepareThreadNotificationEmailAsHtml(client: Liveblocks, event: ThreadNotificationEvent, options?: PrepareThreadNotificationEmailAsHtmlOptions<BaseUserMeta>): Promise<ThreadNotificationEmailDataAsHtml | null>;
 type CommentBodyContainerComponentProps = {
     /**
      * The blocks of the comment body
@@ -440,7 +367,7 @@ type ConvertCommentBodyAsReactComponents<U extends BaseUserMeta = DU> = {
      */
     Mention: ComponentType<CommentBodyMentionComponentProps<U>>;
 };
-type PrepareThreadNotificationEmailAsReactOptions<BodyType, U extends BaseUserMeta = DU> = Omit<PrepareThreadNotificationEmailOptions<BodyType, U>, "elements"> & {
+type PrepareThreadNotificationEmailAsReactOptions<U extends BaseUserMeta = DU> = PrepareThreadNotificationEmailOptions<U> & {
     /**
      * The components used to customize the resulting React nodes inside a comment body.
      * Each components has priority over the base components inherited internally defined.

package/dist/index.js

@@ -3,7 +3,7 @@ import { detectDupes } from "@liveblocks/core";
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/emails";
-var PKG_VERSION = "2.21.0-emails2";
+var PKG_VERSION = "2.21.0-emails3";
 var PKG_FORMAT = "esm";
 
 // ../../node_modules/lib0/map.js
@@ -8500,7 +8500,7 @@ var extractThreadNotificationData = async ({
     comments: unreadComments
   };
 };
-async function prepareThreadNotificationEmail(client, event, options) {
+async function prepareThreadNotificationEmail(client, event, options, elements, callerName) {
   const data = await extractThreadNotificationData({ client, event });
   if (data === null) {
     return null;
@@ -8512,7 +8512,7 @@ async function prepareThreadNotificationEmail(client, event, options) {
   };
   const batchUsersResolver = createBatchUsersResolver({
     resolveUsers: options.resolveUsers,
-    callerName: "prepareThreadNotificationEmail"
+    callerName
   });
   switch (data.type) {
     case "unreadMention": {
@@ -8523,7 +8523,7 @@ async function prepareThreadNotificationEmail(client, event, options) {
       });
       const commentBodyPromise = convertCommentBody(comment.body, {
         resolveUsers: batchUsersResolver.resolveUsers,
-        elements: options.elements
+        elements
       });
       await batchUsersResolver.resolve();
       const [authorsInfo, commentBody] = await Promise.all([
@@ -8561,7 +8561,7 @@ async function prepareThreadNotificationEmail(client, event, options) {
       const commentBodiesPromises = comments.map(
         (c) => convertCommentBody(c.body, {
           resolveUsers: batchUsersResolver.resolveUsers,
-          elements: options.elements
+          elements
         })
       );
       await batchUsersResolver.resolve();
@@ -8623,40 +8623,41 @@ async function prepareThreadNotificationEmailAsHtml(client, event, options = {})
     event,
     {
       resolveUsers: options.resolveUsers,
-      resolveRoomInfo: options.resolveRoomInfo,
-      elements: {
-        container: ({ children }) => children.join("\n"),
-        paragraph: ({ children }) => {
-          const unsafe = children.join("");
-          return unsafe ? html2`<p style="${toInlineCSSString(styles.paragraph)}">${htmlSafe2(unsafe)}</p>` : unsafe;
-        },
-        text: ({ element }) => {
-          let children = element.text;
-          if (!children) {
-            return html2`${children}`;
-          }
-          if (element.bold) {
-            children = html2`<strong style="${toInlineCSSString(styles.strong)}">${children}</strong>`;
-          }
-          if (element.italic) {
-            children = html2`<em>${children}</em>`;
-          }
-          if (element.strikethrough) {
-            children = html2`<s>${children}</s>`;
-          }
-          if (element.code) {
-            children = html2`<code style="${toInlineCSSString(styles.code)}">${children}</code>`;
-          }
+      resolveRoomInfo: options.resolveRoomInfo
+    },
+    {
+      container: ({ children }) => children.join("\n"),
+      paragraph: ({ children }) => {
+        const unsafe = children.join("");
+        return unsafe ? html2`<p style="${toInlineCSSString(styles.paragraph)}">${htmlSafe2(unsafe)}</p>` : unsafe;
+      },
+      text: ({ element }) => {
+        let children = element.text;
+        if (!children) {
           return html2`${children}`;
-        },
-        link: ({ element, href }) => {
-          return html2`<a href="${href}" target="_blank" rel="noopener noreferrer" style="${toInlineCSSString(styles.link)}">${element.text ? html2`${element.text}` : element.url}</a>`;
-        },
-        mention: ({ element, user }) => {
-          return html2`<span data-mention style="${toInlineCSSString(styles.mention)}">${MENTION_CHARACTER}${user?.name ? html2`${user?.name}` : element.id}</span>`;
         }
+        if (element.bold) {
+          children = html2`<strong style="${toInlineCSSString(styles.strong)}">${children}</strong>`;
+        }
+        if (element.italic) {
+          children = html2`<em>${children}</em>`;
+        }
+        if (element.strikethrough) {
+          children = html2`<s>${children}</s>`;
+        }
+        if (element.code) {
+          children = html2`<code style="${toInlineCSSString(styles.code)}">${children}</code>`;
+        }
+        return html2`${children}`;
+      },
+      link: ({ element, href }) => {
+        return html2`<a href="${href}" target="_blank" rel="noopener noreferrer" style="${toInlineCSSString(styles.link)}">${element.text ? html2`${element.text}` : element.url}</a>`;
+      },
+      mention: ({ element, user }) => {
+        return html2`<span data-mention style="${toInlineCSSString(styles.mention)}">${MENTION_CHARACTER}${user?.name ? html2`${user?.name}` : element.id}</span>`;
       }
-    }
+    },
+    "prepareThreadNotificationEmailAsHtml"
   );
   if (data === null) {
     return null;
@@ -8711,35 +8712,36 @@ async function prepareThreadNotificationEmailAsReact(client, event, options = {}
     event,
     {
       resolveUsers: options.resolveUsers,
-      resolveRoomInfo: options.resolveRoomInfo,
-      elements: {
-        container: ({ children }) => /* @__PURE__ */ jsx2(Components.Container, { children }, "lb-comment-body-container"),
-        paragraph: ({ children }, index) => /* @__PURE__ */ jsx2(Components.Paragraph, { children }, `lb-comment-body-paragraph-${index}`),
-        text: ({ element }, index) => /* @__PURE__ */ jsx2(
-          Components.Text,
-          {
-            element
-          },
-          `lb-comment-body-text-${index}`
-        ),
-        link: ({ element, href }, index) => /* @__PURE__ */ jsx2(
-          Components.Link,
-          {
-            element,
-            href
-          },
-          `lb-comment-body-link-${index}`
-        ),
-        mention: ({ element, user }, index) => element.id ? /* @__PURE__ */ jsx2(
-          Components.Mention,
-          {
-            element,
-            user
-          },
-          `lb-comment-body-mention-${index}`
-        ) : null
-      }
-    }
+      resolveRoomInfo: options.resolveRoomInfo
+    },
+    {
+      container: ({ children }) => /* @__PURE__ */ jsx2(Components.Container, { children }, "lb-comment-body-container"),
+      paragraph: ({ children }, index) => /* @__PURE__ */ jsx2(Components.Paragraph, { children }, `lb-comment-body-paragraph-${index}`),
+      text: ({ element }, index) => /* @__PURE__ */ jsx2(
+        Components.Text,
+        {
+          element
+        },
+        `lb-comment-body-text-${index}`
+      ),
+      link: ({ element, href }, index) => /* @__PURE__ */ jsx2(
+        Components.Link,
+        {
+          element,
+          href
+        },
+        `lb-comment-body-link-${index}`
+      ),
+      mention: ({ element, user }, index) => element.id ? /* @__PURE__ */ jsx2(
+        Components.Mention,
+        {
+          element,
+          user
+        },
+        `lb-comment-body-mention-${index}`
+      ) : null
+    },
+    "prepareThreadNotificationEmailAsReact"
   );
   if (data === null) {
     return null;