@liveblocks/emails 2.25.0-aiprivatebeta13 → 2.25.0-aiprivatebeta15

package/dist/index.d.cts

@@ -1,8 +1,8 @@
-import { BaseUserMeta, DU, ResolveUsersArgs, Awaitable, DRI, CommentBodyText, CommentBodyLink, CommentBodyMention } from '@liveblocks/core';
+import { Relax, BaseUserMeta, DU, MentionData, DRI, Awaitable, ResolveUsersArgs, CommentBodyText, CommentBodyLink, CommentBodyMention } from '@liveblocks/core';
 export { ResolveUsersArgs } from '@liveblocks/core';
+import { Liveblocks, TextMentionNotificationEvent, ThreadNotificationEvent } from '@liveblocks/node';
 import { ReactNode, ComponentType } from 'react';
 import { Properties } from 'csstype';
-import { Liveblocks, TextMentionNotificationEvent, ThreadNotificationEvent } from '@liveblocks/node';
 
 type ResolveRoomInfoArgs = {
     /**
@@ -35,24 +35,36 @@ type LiveblocksTextEditorTextNode = {
     type: "text";
     text: string;
 } & LiveblocksTextEditorTextFormat;
-type LiveblocksTextEditorMentionNode = {
+type LiveblocksTextEditorMentionNode = Relax<LiveblocksTextEditorUserMentionNode>;
+type LiveblocksTextEditorUserMentionNode = {
     type: "mention";
-    userId: string;
+    kind: "user";
+    id: string;
+};
+
+type MentionEmailData<ContentType, U extends BaseUserMeta = DU> = MentionData & {
+    textMentionId: string;
+    roomId: string;
+    author: U;
+    createdAt: Date;
+    content: ContentType;
+};
+type MentionEmailAsHtmlData<U extends BaseUserMeta = DU> = MentionEmailData<string, U>;
+type MentionEmailAsReactData<U extends BaseUserMeta = DU> = MentionEmailData<ReactNode, U>;
+type TextMentionNotificationEmailData<ContentType, U extends BaseUserMeta = DU, M extends MentionEmailData<ContentType, U> = MentionEmailData<ContentType, U>> = {
+    mention: M;
+    roomInfo: DRI;
+};
+type PrepareTextMentionNotificationEmailOptions<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>;
 };
-/**
- * -------------------------------------------------------------------------------------------------
- * `LiveblocksTextEditorNode` is common structure to represents text editor nodes coming from
- * like `Lexical`, `TipTap` or so.
- *
- * This (simple) structure is made to be scalable and to accommodate with other text editors we could potentially
- * want to support in the future.
- *
- * It allows to manipulate nodes more easily and converts them with ease either as React nodes or as an html safe string.
- * From a DX standpoint it provides to developers the same structure to use when using custom React components or inline css
- * to represents a text mention with its surrounding text.
- * -------------------------------------------------------------------------------------------------
- */
-type LiveblocksTextEditorNode = LiveblocksTextEditorTextNode | LiveblocksTextEditorMentionNode;
 type TextEditorContainerComponentProps = {
     /**
      * The nodes of the text editor
@@ -90,62 +102,14 @@ type ConvertTextEditorNodesAsReactComponents<U extends BaseUserMeta = DU> = {
      */
     Text: ComponentType<TextEditorTextComponentProps>;
 };
-type ConvertTextEditorNodesAsHtmlStyles = {
-    /**
-     * The default inline CSS styles used to display container element.
-     */
-    container: 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 mentions.
-     */
-    mention: CSSProperties;
-};
-
-type MentionEmailBaseData = {
-    id: string;
-    roomId: string;
-    userId: string;
-    textEditorNodes: LiveblocksTextEditorNode[];
-    createdAt: Date;
-};
-type PrepareTextMentionNotificationEmailBaseDataOptions = {
-    /**
-     * A function that returns room info from room IDs.
-     */
-    resolveRoomInfo?: (args: ResolveRoomInfoArgs) => Awaitable<DRI | undefined>;
-};
-type MentionEmailAsReactData<U extends BaseUserMeta = DU> = Omit<MentionEmailBaseData, "userId" | "textEditorNodes"> & {
-    author: U;
-    reactContent: ReactNode;
-};
-type MentionEmailAsHtmlData<U extends BaseUserMeta = DU> = Omit<MentionEmailBaseData, "userId" | "textEditorNodes"> & {
-    author: U;
-    htmlContent: string;
-};
-type PrepareTextMentionNotificationEmailAsReactOptions<U extends BaseUserMeta = DU> = PrepareTextMentionNotificationEmailBaseDataOptions & {
-    /**
-     * A function that returns info from user IDs.
-     */
-    resolveUsers?: (args: ResolveUsersArgs) => Awaitable<(U["info"] | undefined)[] | undefined>;
+type PrepareTextMentionNotificationEmailAsReactOptions<U extends BaseUserMeta = DU> = PrepareTextMentionNotificationEmailOptions & {
     /**
      * The components used to customize the resulting React nodes. Each components has
      * priority over the base components inherited.
      */
     components?: Partial<ConvertTextEditorNodesAsReactComponents<U>>;
 };
-type TextMentionNotificationEmailData<U extends BaseUserMeta, M extends MentionEmailAsReactData<U> | MentionEmailAsHtmlData<U>> = {
-    mention: M;
-    roomInfo: DRI;
-};
-type TextMentionNotificationEmailDataAsReact = TextMentionNotificationEmailData<BaseUserMeta, MentionEmailAsReactData>;
+type TextMentionNotificationEmailDataAsReact<U extends BaseUserMeta = DU> = TextMentionNotificationEmailData<ReactNode, U, MentionEmailAsReactData<U>>;
 /**
  * Prepares data from a `TextMentionNotificationEvent` and convert content as React nodes.
  *
@@ -171,18 +135,32 @@ type TextMentionNotificationEmailDataAsReact = TextMentionNotificationEmailData<
  * )
  */
 declare function prepareTextMentionNotificationEmailAsReact(client: Liveblocks, event: TextMentionNotificationEvent, options?: PrepareTextMentionNotificationEmailAsReactOptions<BaseUserMeta>): Promise<TextMentionNotificationEmailDataAsReact | null>;
-type PrepareTextMentionNotificationEmailAsHtmlOptions<U extends BaseUserMeta = DU> = PrepareTextMentionNotificationEmailBaseDataOptions & {
+type ConvertTextEditorNodesAsHtmlStyles = {
     /**
-     * A function that returns info from user IDs.
+     * The default inline CSS styles used to display container element.
      */
-    resolveUsers?: (args: ResolveUsersArgs) => Awaitable<(U["info"] | undefined)[] | undefined>;
+    container: 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 mentions.
+     */
+    mention: CSSProperties;
+};
+type PrepareTextMentionNotificationEmailAsHtmlOptions = PrepareTextMentionNotificationEmailOptions & {
     /**
      * The styles used to customize the html elements in the resulting html safe string.
      * Each styles has priority over the base styles inherited.
      */
     styles?: Partial<ConvertTextEditorNodesAsHtmlStyles>;
 };
-type TextMentionNotificationEmailDataAsHtml = TextMentionNotificationEmailData<BaseUserMeta, MentionEmailAsHtmlData>;
+type TextMentionNotificationEmailDataAsHtml<U extends BaseUserMeta = DU> = TextMentionNotificationEmailData<string, U, MentionEmailAsHtmlData<U>>;
 /**
  * Prepares data from a `TextMentionNotificationEvent` and convert content  as an html safe string.
  *
@@ -207,7 +185,7 @@ type TextMentionNotificationEmailDataAsHtml = TextMentionNotificationEmailData<B
  *  }
  * )
  */
-declare function prepareTextMentionNotificationEmailAsHtml(client: Liveblocks, event: TextMentionNotificationEvent, options?: PrepareTextMentionNotificationEmailAsHtmlOptions<BaseUserMeta>): Promise<TextMentionNotificationEmailDataAsHtml | null>;
+declare function prepareTextMentionNotificationEmailAsHtml(client: Liveblocks, event: TextMentionNotificationEvent, options?: PrepareTextMentionNotificationEmailAsHtmlOptions): Promise<TextMentionNotificationEmailDataAsHtml | null>;
 
 type CommentEmailData<BodyType, U extends BaseUserMeta = DU> = {
     id: string;
@@ -227,14 +205,8 @@ type ThreadNotificationEmailData<BodyType, U extends BaseUserMeta = DU, C extend
 }) & {
     roomInfo: DRI;
 };
-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 CommentEmailAsHtmlData<U extends BaseUserMeta = DU> = CommentEmailData<string, U>;
+type CommentEmailAsReactData<U extends BaseUserMeta = DU> = CommentEmailData<ReactNode, U>;
 type PrepareThreadNotificationEmailOptions<U extends BaseUserMeta = DU> = {
     /**
      * A function that returns room info from room IDs.

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { BaseUserMeta, DU, ResolveUsersArgs, Awaitable, DRI, CommentBodyText, CommentBodyLink, CommentBodyMention } from '@liveblocks/core';
+import { Relax, BaseUserMeta, DU, MentionData, DRI, Awaitable, ResolveUsersArgs, CommentBodyText, CommentBodyLink, CommentBodyMention } from '@liveblocks/core';
 export { ResolveUsersArgs } from '@liveblocks/core';
+import { Liveblocks, TextMentionNotificationEvent, ThreadNotificationEvent } from '@liveblocks/node';
 import { ReactNode, ComponentType } from 'react';
 import { Properties } from 'csstype';
-import { Liveblocks, TextMentionNotificationEvent, ThreadNotificationEvent } from '@liveblocks/node';
 
 type ResolveRoomInfoArgs = {
     /**
@@ -35,24 +35,36 @@ type LiveblocksTextEditorTextNode = {
     type: "text";
     text: string;
 } & LiveblocksTextEditorTextFormat;
-type LiveblocksTextEditorMentionNode = {
+type LiveblocksTextEditorMentionNode = Relax<LiveblocksTextEditorUserMentionNode>;
+type LiveblocksTextEditorUserMentionNode = {
     type: "mention";
-    userId: string;
+    kind: "user";
+    id: string;
+};
+
+type MentionEmailData<ContentType, U extends BaseUserMeta = DU> = MentionData & {
+    textMentionId: string;
+    roomId: string;
+    author: U;
+    createdAt: Date;
+    content: ContentType;
+};
+type MentionEmailAsHtmlData<U extends BaseUserMeta = DU> = MentionEmailData<string, U>;
+type MentionEmailAsReactData<U extends BaseUserMeta = DU> = MentionEmailData<ReactNode, U>;
+type TextMentionNotificationEmailData<ContentType, U extends BaseUserMeta = DU, M extends MentionEmailData<ContentType, U> = MentionEmailData<ContentType, U>> = {
+    mention: M;
+    roomInfo: DRI;
+};
+type PrepareTextMentionNotificationEmailOptions<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>;
 };
-/**
- * -------------------------------------------------------------------------------------------------
- * `LiveblocksTextEditorNode` is common structure to represents text editor nodes coming from
- * like `Lexical`, `TipTap` or so.
- *
- * This (simple) structure is made to be scalable and to accommodate with other text editors we could potentially
- * want to support in the future.
- *
- * It allows to manipulate nodes more easily and converts them with ease either as React nodes or as an html safe string.
- * From a DX standpoint it provides to developers the same structure to use when using custom React components or inline css
- * to represents a text mention with its surrounding text.
- * -------------------------------------------------------------------------------------------------
- */
-type LiveblocksTextEditorNode = LiveblocksTextEditorTextNode | LiveblocksTextEditorMentionNode;
 type TextEditorContainerComponentProps = {
     /**
      * The nodes of the text editor
@@ -90,62 +102,14 @@ type ConvertTextEditorNodesAsReactComponents<U extends BaseUserMeta = DU> = {
      */
     Text: ComponentType<TextEditorTextComponentProps>;
 };
-type ConvertTextEditorNodesAsHtmlStyles = {
-    /**
-     * The default inline CSS styles used to display container element.
-     */
-    container: 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 mentions.
-     */
-    mention: CSSProperties;
-};
-
-type MentionEmailBaseData = {
-    id: string;
-    roomId: string;
-    userId: string;
-    textEditorNodes: LiveblocksTextEditorNode[];
-    createdAt: Date;
-};
-type PrepareTextMentionNotificationEmailBaseDataOptions = {
-    /**
-     * A function that returns room info from room IDs.
-     */
-    resolveRoomInfo?: (args: ResolveRoomInfoArgs) => Awaitable<DRI | undefined>;
-};
-type MentionEmailAsReactData<U extends BaseUserMeta = DU> = Omit<MentionEmailBaseData, "userId" | "textEditorNodes"> & {
-    author: U;
-    reactContent: ReactNode;
-};
-type MentionEmailAsHtmlData<U extends BaseUserMeta = DU> = Omit<MentionEmailBaseData, "userId" | "textEditorNodes"> & {
-    author: U;
-    htmlContent: string;
-};
-type PrepareTextMentionNotificationEmailAsReactOptions<U extends BaseUserMeta = DU> = PrepareTextMentionNotificationEmailBaseDataOptions & {
-    /**
-     * A function that returns info from user IDs.
-     */
-    resolveUsers?: (args: ResolveUsersArgs) => Awaitable<(U["info"] | undefined)[] | undefined>;
+type PrepareTextMentionNotificationEmailAsReactOptions<U extends BaseUserMeta = DU> = PrepareTextMentionNotificationEmailOptions & {
     /**
      * The components used to customize the resulting React nodes. Each components has
      * priority over the base components inherited.
      */
     components?: Partial<ConvertTextEditorNodesAsReactComponents<U>>;
 };
-type TextMentionNotificationEmailData<U extends BaseUserMeta, M extends MentionEmailAsReactData<U> | MentionEmailAsHtmlData<U>> = {
-    mention: M;
-    roomInfo: DRI;
-};
-type TextMentionNotificationEmailDataAsReact = TextMentionNotificationEmailData<BaseUserMeta, MentionEmailAsReactData>;
+type TextMentionNotificationEmailDataAsReact<U extends BaseUserMeta = DU> = TextMentionNotificationEmailData<ReactNode, U, MentionEmailAsReactData<U>>;
 /**
  * Prepares data from a `TextMentionNotificationEvent` and convert content as React nodes.
  *
@@ -171,18 +135,32 @@ type TextMentionNotificationEmailDataAsReact = TextMentionNotificationEmailData<
  * )
  */
 declare function prepareTextMentionNotificationEmailAsReact(client: Liveblocks, event: TextMentionNotificationEvent, options?: PrepareTextMentionNotificationEmailAsReactOptions<BaseUserMeta>): Promise<TextMentionNotificationEmailDataAsReact | null>;
-type PrepareTextMentionNotificationEmailAsHtmlOptions<U extends BaseUserMeta = DU> = PrepareTextMentionNotificationEmailBaseDataOptions & {
+type ConvertTextEditorNodesAsHtmlStyles = {
     /**
-     * A function that returns info from user IDs.
+     * The default inline CSS styles used to display container element.
      */
-    resolveUsers?: (args: ResolveUsersArgs) => Awaitable<(U["info"] | undefined)[] | undefined>;
+    container: 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 mentions.
+     */
+    mention: CSSProperties;
+};
+type PrepareTextMentionNotificationEmailAsHtmlOptions = PrepareTextMentionNotificationEmailOptions & {
     /**
      * The styles used to customize the html elements in the resulting html safe string.
      * Each styles has priority over the base styles inherited.
      */
     styles?: Partial<ConvertTextEditorNodesAsHtmlStyles>;
 };
-type TextMentionNotificationEmailDataAsHtml = TextMentionNotificationEmailData<BaseUserMeta, MentionEmailAsHtmlData>;
+type TextMentionNotificationEmailDataAsHtml<U extends BaseUserMeta = DU> = TextMentionNotificationEmailData<string, U, MentionEmailAsHtmlData<U>>;
 /**
  * Prepares data from a `TextMentionNotificationEvent` and convert content  as an html safe string.
  *
@@ -207,7 +185,7 @@ type TextMentionNotificationEmailDataAsHtml = TextMentionNotificationEmailData<B
  *  }
  * )
  */
-declare function prepareTextMentionNotificationEmailAsHtml(client: Liveblocks, event: TextMentionNotificationEvent, options?: PrepareTextMentionNotificationEmailAsHtmlOptions<BaseUserMeta>): Promise<TextMentionNotificationEmailDataAsHtml | null>;
+declare function prepareTextMentionNotificationEmailAsHtml(client: Liveblocks, event: TextMentionNotificationEvent, options?: PrepareTextMentionNotificationEmailAsHtmlOptions): Promise<TextMentionNotificationEmailDataAsHtml | null>;
 
 type CommentEmailData<BodyType, U extends BaseUserMeta = DU> = {
     id: string;
@@ -227,14 +205,8 @@ type ThreadNotificationEmailData<BodyType, U extends BaseUserMeta = DU, C extend
 }) & {
     roomInfo: DRI;
 };
-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 CommentEmailAsHtmlData<U extends BaseUserMeta = DU> = CommentEmailData<string, U>;
+type CommentEmailAsReactData<U extends BaseUserMeta = DU> = CommentEmailData<ReactNode, U>;
 type PrepareThreadNotificationEmailOptions<U extends BaseUserMeta = DU> = {
     /**
      * A function that returns room info from room IDs.