@liveblocks/emails 2.21.0-emails1 → 2.21.0-emails2

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { BaseUserMeta, DU, ResolveUsersArgs, Awaitable, DRI, CommentBodyText, CommentBodyLink, CommentBodyMention } from '@liveblocks/core';
+import { BaseUserMeta, DU, ResolveUsersArgs, Awaitable, DRI, CommentBodyParagraph, CommentBodyText, CommentBodyLink, CommentBodyMention } from '@liveblocks/core';
 export { ResolveUsersArgs } from '@liveblocks/core';
 import { ReactNode, ComponentType } from 'react';
 import { Properties } from 'csstype';
@@ -209,6 +209,75 @@ 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;
@@ -235,6 +304,20 @@ type CommentEmailAsReactData<U extends BaseUserMeta = DU> = CommentEmailData<Rea
     /** @deprecated Use `body` property instead. */
     reactBody: ReactNode;
 };
+type PrepareThreadNotificationEmailOptions<BodyType, U extends BaseUserMeta = DU> = {
+    /**
+     * A function that returns room info from room IDs.
+     */
+    resolveRoomInfo?: (args: ResolveRoomInfoArgs) => Awaitable<DRI | undefined>;
+    /**
+     * 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.
  * Each styles has priority over the base styles inherited.
@@ -358,10 +441,6 @@ type ConvertCommentBodyAsReactComponents<U extends BaseUserMeta = DU> = {
     Mention: ComponentType<CommentBodyMentionComponentProps<U>>;
 };
 type PrepareThreadNotificationEmailAsReactOptions<BodyType, U extends BaseUserMeta = DU> = Omit<PrepareThreadNotificationEmailOptions<BodyType, U>, "elements"> & {
-    /**
-     * A function that returns info from user IDs.
-     */
-    resolveUsers?: (args: ResolveUsersArgs) => Awaitable<(U["info"] | undefined)[] | undefined>;
     /**
      * 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, CommentBodyText, CommentBodyLink, CommentBodyMention } from '@liveblocks/core';
+import { BaseUserMeta, DU, ResolveUsersArgs, Awaitable, DRI, CommentBodyParagraph, CommentBodyText, CommentBodyLink, CommentBodyMention } from '@liveblocks/core';
 export { ResolveUsersArgs } from '@liveblocks/core';
 import { ReactNode, ComponentType } from 'react';
 import { Properties } from 'csstype';
@@ -209,6 +209,75 @@ 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;
@@ -235,6 +304,20 @@ type CommentEmailAsReactData<U extends BaseUserMeta = DU> = CommentEmailData<Rea
     /** @deprecated Use `body` property instead. */
     reactBody: ReactNode;
 };
+type PrepareThreadNotificationEmailOptions<BodyType, U extends BaseUserMeta = DU> = {
+    /**
+     * A function that returns room info from room IDs.
+     */
+    resolveRoomInfo?: (args: ResolveRoomInfoArgs) => Awaitable<DRI | undefined>;
+    /**
+     * 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.
  * Each styles has priority over the base styles inherited.
@@ -358,10 +441,6 @@ type ConvertCommentBodyAsReactComponents<U extends BaseUserMeta = DU> = {
     Mention: ComponentType<CommentBodyMentionComponentProps<U>>;
 };
 type PrepareThreadNotificationEmailAsReactOptions<BodyType, U extends BaseUserMeta = DU> = Omit<PrepareThreadNotificationEmailOptions<BodyType, U>, "elements"> & {
-    /**
-     * A function that returns info from user IDs.
-     */
-    resolveUsers?: (args: ResolveUsersArgs) => Awaitable<(U["info"] | undefined)[] | undefined>;
     /**
      * 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-emails1";
+var PKG_VERSION = "2.21.0-emails2";
 var PKG_FORMAT = "esm";
 
 // ../../node_modules/lib0/map.js