@liveblocks/emails 2.20.0 → 2.21.0-emails2

package/dist/index.d.ts

@@ -1,100 +1,9 @@
-import { CommentBodyText, CommentBodyLink, BaseUserMeta, DU, CommentBodyMention, ResolveUsersArgs, Awaitable, DRI, CommentBody } 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';
 import { Liveblocks, TextMentionNotificationEvent, ThreadNotificationEvent } from '@liveblocks/node';
 
-/**
- * CSS properties object.
- * Type alias for DX purposes.
- *
- */
-type CSSProperties = Properties;
-
-type CommentBodyContainerComponentProps = {
-    /**
-     * The blocks of the comment body
-     */
-    children: ReactNode;
-};
-type CommentBodyParagraphComponentProps = {
-    /**
-     * The text content of the paragraph.
-     */
-    children: ReactNode;
-};
-type CommentBodyTextComponentProps = {
-    /**
-     * The text element.
-     */
-    element: CommentBodyText;
-};
-type CommentBodyLinkComponentProps = {
-    /**
-     * The link element.
-     */
-    element: CommentBodyLink;
-    /**
-     * The absolute URL of the link.
-     */
-    href: string;
-};
-type CommentBodyMentionComponentProps<U extends BaseUserMeta = DU> = {
-    /**
-     * The mention element.
-     */
-    element: CommentBodyMention;
-    /**
-     * The mention's user info, if the `resolvedUsers` option was provided.
-     */
-    user?: U["info"];
-};
-type ConvertCommentBodyAsReactComponents<U extends BaseUserMeta = DU> = {
-    /**
-     *
-     * The component used to act as a container to wrap comment body blocks,
-     */
-    Container: ComponentType<CommentBodyContainerComponentProps>;
-    /**
-     * The component used to display paragraphs.
-     */
-    Paragraph: ComponentType<CommentBodyParagraphComponentProps>;
-    /**
-     * The component used to display text elements.
-     */
-    Text: ComponentType<CommentBodyTextComponentProps>;
-    /**
-     * The component used to display links.
-     */
-    Link: ComponentType<CommentBodyLinkComponentProps>;
-    /**
-     * The component used to display mentions.
-     */
-    Mention: ComponentType<CommentBodyMentionComponentProps<U>>;
-};
-type ConvertCommentBodyAsHtmlStyles = {
-    /**
-     * The default inline CSS styles used to display paragraphs.
-     */
-    paragraph: CSSProperties;
-    /**
-     * The default inline CSS styles used to display text `<strong />` elements.
-     */
-    strong: CSSProperties;
-    /**
-     * The default inline CSS styles used to display text `<code />` elements.
-     */
-    code: CSSProperties;
-    /**
-     * The default inline CSS styles used to display links.
-     */
-    mention: CSSProperties;
-    /**
-     * The default inline CSS styles used to display mentions.
-     */
-    link: CSSProperties;
-};
-
 type ResolveRoomInfoArgs = {
     /**
      * The ID of the room to resolve
@@ -102,6 +11,13 @@ type ResolveRoomInfoArgs = {
     roomId: string;
 };
 
+/**
+ * CSS properties object.
+ * Type alias for DX purposes.
+ *
+ */
+type CSSProperties = Properties;
+
 /**
  * Liveblocks Text Editor
  *
@@ -293,52 +209,149 @@ type TextMentionNotificationEmailDataAsHtml = TextMentionNotificationEmailData<B
  */
 declare function prepareTextMentionNotificationEmailAsHtml(client: Liveblocks, event: TextMentionNotificationEvent, options?: PrepareTextMentionNotificationEmailAsHtmlOptions<BaseUserMeta>): Promise<TextMentionNotificationEmailDataAsHtml | null>;
 
-type CommentEmailBaseData = {
-    id: string;
-    threadId: string;
-    roomId: string;
-    userId: string;
-    createdAt: Date;
-    url?: string;
-    rawBody: CommentBody;
+type CommentBodyContainerElementArgs<T> = {
+    /**
+     * The blocks of the comment body
+     */
+    children: T[];
 };
-type PrepareThreadNotificationEmailBaseDataOptions = {
+type CommentBodyParagraphElementArgs<T> = {
     /**
-     * A function that returns room info from room IDs.
+     * The paragraph element.
      */
-    resolveRoomInfo?: (args: ResolveRoomInfoArgs) => Awaitable<DRI | undefined>;
+    element: CommentBodyParagraph;
+    /**
+     * The text content of the paragraph.
+     */
+    children: T[];
 };
-type CommentEmailAsHtmlData<U extends BaseUserMeta = DU> = Omit<CommentEmailBaseData, "userId" | "rawBody"> & {
-    author: U;
-    htmlBody: string;
+type CommentBodyTextElementArgs = {
+    /**
+     * The text element.
+     */
+    element: CommentBodyText;
+};
+type CommentBodyLinkElementArgs = {
+    /**
+     * The link element.
+     */
+    element: CommentBodyLink;
+    /**
+     * The absolute URL of the link.
+     */
+    href: string;
 };
-type CommentEmailAsReactData<U extends BaseUserMeta = DU> = Omit<CommentEmailBaseData, "userId" | "rawBody"> & {
+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;
+    roomId: string;
+    createdAt: Date;
+    url?: string;
     author: U;
-    reactBody: ReactNode;
+    body: BodyType;
 };
-type ThreadNotificationEmailUnreadRepliesData<U extends BaseUserMeta, C extends CommentEmailAsHtmlData<U> | CommentEmailAsReactData<U>> = {
+type ThreadNotificationEmailData<BodyType, U extends BaseUserMeta = DU, C extends CommentEmailData<BodyType, U> = CommentEmailData<BodyType, U>> = ({
     type: "unreadReplies";
     comments: C[];
-};
-type ThreadNotificationEmailUnreadMentionsData<U extends BaseUserMeta, C extends CommentEmailAsHtmlData<U> | CommentEmailAsReactData<U>> = {
+} | {
     type: "unreadMention";
     comment: C;
-};
-type ThreadNotificationEmailData<U extends BaseUserMeta, C extends CommentEmailAsHtmlData<U> | CommentEmailAsReactData<U>> = (ThreadNotificationEmailUnreadRepliesData<U, C> | ThreadNotificationEmailUnreadMentionsData<U, C>) & {
+}) & {
     roomInfo: DRI;
 };
-type PrepareThreadNotificationEmailAsHtmlOptions<U extends BaseUserMeta = DU> = PrepareThreadNotificationEmailBaseDataOptions & {
+type CommentEmailAsHtmlData<U extends BaseUserMeta = DU> = CommentEmailData<string, U> & {
+    /** @deprecated Use `body` property instead. */
+    htmlBody: string;
+};
+type CommentEmailAsReactData<U extends BaseUserMeta = DU> = CommentEmailData<ReactNode, U> & {
+    /** @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.
+ */
+type ConvertCommentBodyAsHtmlStyles = {
+    /**
+     * The default inline CSS styles used to display paragraphs.
+     */
+    paragraph: CSSProperties;
+    /**
+     * The default inline CSS styles used to display text `<strong />` elements.
+     */
+    strong: CSSProperties;
+    /**
+     * The default inline CSS styles used to display text `<code />` elements.
+     */
+    code: CSSProperties;
+    /**
+     * The default inline CSS styles used to display links.
+     */
+    mention: CSSProperties;
+    /**
+     * The default inline CSS styles used to display mentions.
+     */
+    link: CSSProperties;
+};
+type PrepareThreadNotificationEmailAsHtmlOptions<BodyType, U extends BaseUserMeta = DU> = Omit<PrepareThreadNotificationEmailOptions<BodyType, U>, "elements"> & {
     /**
      * 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.
      */
     styles?: Partial<ConvertCommentBodyAsHtmlStyles>;
 };
-type ThreadNotificationEmailDataAsHtml = ThreadNotificationEmailData<BaseUserMeta, CommentEmailAsHtmlData>;
+type ThreadNotificationEmailDataAsHtml<U extends BaseUserMeta = DU> = ThreadNotificationEmailData<string, U, CommentEmailAsHtmlData<U>>;
 /**
  * Prepares data from a `ThreadNotificationEvent` and convert comment bodies as an html safe string.
  *
@@ -365,19 +378,76 @@ type ThreadNotificationEmailDataAsHtml = ThreadNotificationEmailData<BaseUserMet
  * )
  *
  */
-declare function prepareThreadNotificationEmailAsHtml(client: Liveblocks, event: ThreadNotificationEvent, options?: PrepareThreadNotificationEmailAsHtmlOptions<BaseUserMeta>): Promise<ThreadNotificationEmailDataAsHtml | null>;
-type PrepareThreadNotificationEmailAsReactOptions<U extends BaseUserMeta = DU> = PrepareThreadNotificationEmailBaseDataOptions & {
+declare function prepareThreadNotificationEmailAsHtml(client: Liveblocks, event: ThreadNotificationEvent, options?: PrepareThreadNotificationEmailAsHtmlOptions<string, BaseUserMeta>): Promise<ThreadNotificationEmailDataAsHtml | null>;
+type CommentBodyContainerComponentProps = {
     /**
-     * A function that returns info from user IDs.
+     * The blocks of the comment body
      */
-    resolveUsers?: (args: ResolveUsersArgs) => Awaitable<(U["info"] | undefined)[] | undefined>;
+    children: ReactNode;
+};
+type CommentBodyParagraphComponentProps = {
+    /**
+     * The text content of the paragraph.
+     */
+    children: ReactNode;
+};
+type CommentBodyTextComponentProps = {
+    /**
+     * The text element.
+     */
+    element: CommentBodyText;
+};
+type CommentBodyLinkComponentProps = {
+    /**
+     * The link element.
+     */
+    element: CommentBodyLink;
+    /**
+     * The absolute URL of the link.
+     */
+    href: string;
+};
+type CommentBodyMentionComponentProps<U extends BaseUserMeta = DU> = {
+    /**
+     * The mention element.
+     */
+    element: CommentBodyMention;
+    /**
+     * The mention's user info, if the `resolvedUsers` option was provided.
+     */
+    user?: U["info"];
+};
+type ConvertCommentBodyAsReactComponents<U extends BaseUserMeta = DU> = {
+    /**
+     *
+     * The component used to act as a container to wrap comment body blocks,
+     */
+    Container: ComponentType<CommentBodyContainerComponentProps>;
+    /**
+     * The component used to display paragraphs.
+     */
+    Paragraph: ComponentType<CommentBodyParagraphComponentProps>;
+    /**
+     * The component used to display text elements.
+     */
+    Text: ComponentType<CommentBodyTextComponentProps>;
+    /**
+     * The component used to display links.
+     */
+    Link: ComponentType<CommentBodyLinkComponentProps>;
+    /**
+     * The component used to display mentions.
+     */
+    Mention: ComponentType<CommentBodyMentionComponentProps<U>>;
+};
+type PrepareThreadNotificationEmailAsReactOptions<BodyType, U extends BaseUserMeta = DU> = Omit<PrepareThreadNotificationEmailOptions<BodyType, U>, "elements"> & {
     /**
      * The components used to customize the resulting React nodes inside a comment body.
      * Each components has priority over the base components inherited internally defined.
      */
     components?: Partial<ConvertCommentBodyAsReactComponents<U>>;
 };
-type ThreadNotificationEmailDataAsReact = ThreadNotificationEmailData<BaseUserMeta, CommentEmailAsReactData>;
+type ThreadNotificationEmailDataAsReact<U extends BaseUserMeta = DU> = ThreadNotificationEmailData<ReactNode, U, CommentEmailAsReactData<U>>;
 /**
  * Prepares data from a `ThreadNotificationEvent` and convert comment bodies as React nodes.
  *