@contentstack/live-preview-utils/dist/modern/visualBuilder/utils/collabUtils.d.ts

Contentstack provides the Live Preview SDK to establish a communication channel between the various Contentstack SDKs and your website, transmitting live changes to the preview pane.

import { IUserDTO, IMentionedList, IMentionItem, IMessageDTO, IUserState, ICommentState } from '../types/collab.types.js';

/**
 * Generates the title for the thread based on the number of comments.
 * @param {number} commentCount - The number of comments.
 * @returns {string} The title for the thread.
 */
declare const getThreadTitle: (commentCount: number) => string;
/**
 * returns the available email.
 * @param {IUserDTO} user - The user object.
 * @returns {string} The user's email.
 */
declare const getUserName: (user: IUserDTO) => string;
/**
 * Validates the comment length and the number of mentions.
 * @param {string} comment - The comment message.
 * @param {IMentionedList} toUsers - The list of mentioned users.
 * @returns {string} The error message if validation fails, otherwise an empty string.
 */
declare const validateCommentAndMentions: (comment: string, toUsers: IMentionedList) => string;
/**
 * Removes mentions that no longer exist in the message.
 * @param {string} message - The comment message.
 * @param {IMentionedList} toUsers - The list of mentioned users.
 * @returns {Object} The updated lists of mentioned users.
 */
declare const filterOutInvalidMentions: (message: string, toUsers: IMentionedList) => {
    toUsers: IMentionItem[];
};
/**
 * Replaces mention placeholders with display names in the comment message.
 * @param {IMessageDTO | undefined} comment - The comment object.
 * @param {IUserState} userState - The user state containing user and role maps.
 * @param {"text" | "html"} profile - The format for the output message, either plain text or HTML.
 * @returns {string | undefined} The formatted message or undefined if the comment is not provided.
 */
declare const getMessageWithDisplayName: (comment: IMessageDTO | undefined | null, userState: IUserState, profile: "text" | "html") => string | undefined;
/**
 * Sanitizes HTML content to prevent XSS attacks.
 * @param {any} dirty - The unsanitized HTML content.
 * @returns {string} The sanitized HTML content.
 */
declare const sanitizeData: (dirty: any) => string;
/**
 * Constructs the comment body with mentions replaced by their unique identifiers.
 * @param {ICommentState} state - The state containing the comment and mentions.
 * @returns {Object} The comment body containing the sanitized message and mentioned users.
 */
declare const getCommentBody: (state: ICommentState) => ICommentState;
declare function normalizePath(path: string): string;
declare function fixSvgXPath(xpath: string | null): string;
/**
 * populate the position of the thread based on edges of the screen.
 * @param position
 * @param options
 * @returns
 */
declare function adjustPositionToViewport(position: {
    top: number;
    left: number;
}, options?: {
    threadWidth?: number;
    safeMargin?: number;
    topSafeMargin?: number;
}): {
    top: number;
    left: number;
};
declare function formatDate(dateString: string): string;
/**
 * Calculates and updates tooltip position based on available viewport space.
 */
declare const positionTooltip: (tooltipRef: React.RefObject<HTMLDivElement>, targetRef: React.RefObject<HTMLDivElement>, position: "top" | "bottom" | "left" | "right", setActualPosition: (position: "top" | "bottom" | "left" | "right") => void) => void;

export { adjustPositionToViewport, filterOutInvalidMentions, fixSvgXPath, formatDate, getCommentBody, getMessageWithDisplayName, getThreadTitle, getUserName, normalizePath, positionTooltip, sanitizeData, validateCommentAndMentions };