stream-chat-react 13.14.2 → 14.0.0-beta.1

package/dist/components/Message/renderText/remarkPlugins/remarkIgnoreMarkdown.js

@@ -1,11 +0,0 @@
-/**
- * Replace the parsed Markdown tree with a single paragraph containing the
- * original source as a plain text node. No Markdown formatting is interpreted.
- * React will escape it.
- */
-export const remarkIgnoreMarkdown = () => (tree, file) => {
-    const source = String(file.value ?? '');
-    const text = { type: 'text', value: source };
-    const paragraph = { children: [text], type: 'paragraph' };
-    tree.children = [paragraph];
-};

package/dist/components/Message/renderText/renderText.d.ts

@@ -1,19 +0,0 @@
-import React from 'react';
-import type { ComponentType } from 'react';
-import type { Options } from 'react-markdown/lib';
-import type { UserResponse } from 'stream-chat';
-import type { PluggableList } from 'unified';
-import type { MentionProps } from './componentRenderers';
-export type RenderTextPluginConfigurator = (defaultPlugins: PluggableList) => PluggableList;
-export declare const defaultAllowedTagNames: Array<keyof JSX.IntrinsicElements | 'emoji' | 'mention'>;
-export declare const markDownRenderers: RenderTextOptions['customMarkDownRenderers'];
-export type RenderTextOptions = {
-    allowedTagNames?: Array<keyof JSX.IntrinsicElements | 'emoji' | 'mention' | (string & {})>;
-    customMarkDownRenderers?: Options['components'] & Partial<{
-        emoji: ComponentType;
-        mention: ComponentType<MentionProps>;
-    }>;
-    getRehypePlugins?: RenderTextPluginConfigurator;
-    getRemarkPlugins?: RenderTextPluginConfigurator;
-};
-export declare const renderText: (text?: string, mentionedUsers?: UserResponse[], { allowedTagNames, customMarkDownRenderers, getRehypePlugins, getRemarkPlugins, }?: RenderTextOptions) => React.JSX.Element | null;

package/dist/components/Message/renderText/renderText.js

@@ -1,140 +0,0 @@
-import React from 'react';
-import ReactMarkdown, { defaultUrlTransform } from 'react-markdown';
-import { find } from 'linkifyjs';
-import remarkGfm from 'remark-gfm';
-import { Anchor, Emoji, Mention } from './componentRenderers';
-import { detectHttp, matchMarkdownLinks, messageCodeBlocks } from './regex';
-import { emojiMarkdownPlugin, mentionsMarkdownPlugin } from './rehypePlugins';
-import { htmlToTextPlugin, imageToLink, keepLineBreaksPlugin, plusPlusToEmphasis, } from './remarkPlugins';
-import { ErrorBoundary } from '../../UtilityComponents';
-export const defaultAllowedTagNames = [
-    'html',
-    'text',
-    'br',
-    'p',
-    'em',
-    'strong',
-    'a',
-    'ol',
-    'ul',
-    'li',
-    'code',
-    'pre',
-    'blockquote',
-    'del',
-    'table',
-    'thead',
-    'tbody',
-    'th',
-    'tr',
-    'td',
-    'tfoot',
-    // custom types (tagNames)
-    'emoji',
-    'mention',
-    'h1',
-    'h2',
-    'h3',
-    'h4',
-    'h5',
-    'h6',
-    'ins',
-];
-function formatUrlForDisplay(url) {
-    try {
-        return decodeURIComponent(url).replace(detectHttp, '');
-    }
-    catch (e) {
-        return url;
-    }
-}
-function encodeDecode(url) {
-    try {
-        return encodeURI(decodeURIComponent(url));
-    }
-    catch (error) {
-        return url;
-    }
-}
-const urlTransform = (uri) => uri.startsWith('app://') ? uri : defaultUrlTransform(uri);
-const getPluginsForward = (plugins) => plugins;
-export const markDownRenderers = {
-    a: Anchor,
-    emoji: Emoji,
-    mention: Mention,
-};
-export const renderText = (text, mentionedUsers, { allowedTagNames = defaultAllowedTagNames, customMarkDownRenderers, getRehypePlugins = getPluginsForward, getRemarkPlugins = getPluginsForward, } = {}) => {
-    // take the @ mentions and turn them into markdown?
-    // translate links
-    if (!text)
-        return null;
-    if (text.trim().length === 1)
-        return React.createElement(React.Fragment, null, text);
-    let newText = text;
-    const markdownLinks = matchMarkdownLinks(newText);
-    const codeBlocks = messageCodeBlocks(newText);
-    // Extract all valid links/emails within text and replace it with proper markup
-    // Revert the link order to avoid getting out of sync of the original start and end positions of links
-    // - due to the addition of new characters when creating Markdown links
-    const links = [...find(newText, 'email'), ...find(newText, 'url')];
-    for (let i = links.length - 1; i >= 0; i--) {
-        const { end, href, start, type, value } = links[i];
-        const linkIsInBlock = codeBlocks.some((block) => block?.includes(value));
-        // check if message is already  markdown
-        const noParsingNeeded = markdownLinks &&
-            markdownLinks.filter((text) => {
-                const strippedHref = href?.replace(detectHttp, '');
-                const strippedText = text?.replace(detectHttp, '');
-                if (!strippedHref || !strippedText)
-                    return false;
-                return strippedHref.includes(strippedText) || strippedText.includes(strippedHref);
-            });
-        if (noParsingNeeded.length > 0 || linkIsInBlock)
-            continue;
-        try {
-            // special case for mentions:
-            // it could happen that a user's name matches with an e-mail format pattern.
-            // in that case, we check whether the found e-mail is actually a mention
-            // by naively checking for an existence of @ sign in front of it.
-            if (type === 'email' && mentionedUsers) {
-                const emailMatchesWithName = mentionedUsers.find((u) => u.name === value);
-                if (emailMatchesWithName) {
-                    // FIXME: breaks if the mention symbol is not '@'
-                    const isMention = newText.charAt(start - 1) === '@';
-                    // in case of mention, we leave the match in its original form,
-                    // and we let `mentionsMarkdownPlugin` to do its job
-                    newText =
-                        newText.slice(0, start) +
-                            (isMention ? value : `[${value}](${encodeDecode(href)})`) +
-                            newText.slice(end);
-                }
-            }
-            else {
-                const displayLink = type === 'email' ? value : formatUrlForDisplay(href);
-                newText =
-                    newText.slice(0, start) +
-                        `[${displayLink}](${encodeDecode(href)})` +
-                        newText.slice(end);
-            }
-        }
-        catch (e) {
-            void e;
-        }
-    }
-    const remarkPlugins = [
-        htmlToTextPlugin,
-        keepLineBreaksPlugin,
-        [remarkGfm, { singleTilde: false }],
-        plusPlusToEmphasis,
-        imageToLink,
-    ];
-    const rehypePlugins = [emojiMarkdownPlugin];
-    if (mentionedUsers?.length) {
-        rehypePlugins.push(mentionsMarkdownPlugin(mentionedUsers));
-    }
-    return (React.createElement(ErrorBoundary, { fallback: React.createElement(React.Fragment, null, text) },
-        React.createElement(ReactMarkdown, { allowedElements: allowedTagNames, components: {
-                ...markDownRenderers,
-                ...customMarkDownRenderers,
-            }, rehypePlugins: getRehypePlugins(rehypePlugins), remarkPlugins: getRemarkPlugins(remarkPlugins), skipHtml: true, unwrapDisallowed: true, urlTransform: urlTransform }, newText)));
-};

package/dist/components/Message/renderText/types.d.ts

@@ -1,2 +0,0 @@
-import type { Content, Root } from 'hast';
-export type HNode = Content | Root;

package/dist/components/Message/renderText/types.js

@@ -1 +0,0 @@
-export {};

package/dist/components/Message/types.d.ts

@@ -1,111 +0,0 @@
-import type { TFunction } from 'i18next';
-import type { ReactNode } from 'react';
-import type { ReactionSort, UserResponse } from 'stream-chat';
-import type { PinPermissions, UserEventHandler } from './hooks';
-import type { MessageActionsArray } from './utils';
-import type { LocalMessage } from 'stream-chat';
-import type { GroupStyle } from '../MessageList/utils';
-import type { MessageInputProps } from '../MessageInput/MessageInput';
-import type { ReactionDetailsComparator, ReactionsComparator } from '../Reactions/types';
-import type { ChannelActionContextValue } from '../../context/ChannelActionContext';
-import type { ComponentContextValue } from '../../context/ComponentContext';
-import type { MessageContextValue } from '../../context/MessageContext';
-import type { RenderTextOptions } from './renderText';
-export type ReactEventHandler = (event: React.BaseSyntheticEvent) => Promise<void> | void;
-export type MessageProps = {
-    /** The message object */
-    message: LocalMessage;
-    /** Additional props for underlying MessageInput component, [available props](https://getstream.io/chat/docs/sdk/react/message-input-components/message_input/#props) */
-    additionalMessageInputProps?: MessageInputProps;
-    /** Call this function to keep message list scrolled to the bottom when the scroll height increases, e.g. an element appears below the last message (only used in the `VirtualizedMessageList`) */
-    autoscrollToBottom?: () => void;
-    /** If true, picking a reaction from the `ReactionSelector` component will close the selector */
-    closeReactionSelectorOnClick?: boolean;
-    /** Object containing custom message actions and function handlers */
-    customMessageActions?: MessageContextValue['customMessageActions'];
-    /** An array of user IDs that have confirmed the message delivery to their device */
-    deliveredTo?: UserResponse[];
-    /** If true, disables the ability for users to quote messages, defaults to false */
-    disableQuotedMessages?: boolean;
-    /** When true, the message is the last one in a group sent by a specific user (only used in the `VirtualizedMessageList`) */
-    endOfGroup?: boolean;
-    /** When true, the message is the first one in a group sent by a specific user (only used in the `VirtualizedMessageList`) */
-    firstOfGroup?: boolean;
-    /** Override the default formatting of the date. This is a function that has access to the original date object, returns a string  */
-    formatDate?: (date: Date) => string;
-    /** Function that returns the notification text to be displayed when a delete message request fails */
-    getDeleteMessageErrorNotification?: (message: LocalMessage) => string;
-    /** Function that returns the notification text to be displayed when loading message reactions fails */
-    getFetchReactionsErrorNotification?: (message: LocalMessage) => string;
-    /** Function that returns the notification text to be displayed when a flag message request fails */
-    getFlagMessageErrorNotification?: (message: LocalMessage) => string;
-    /** Function that returns the notification text to be displayed when a flag message request succeeds */
-    getFlagMessageSuccessNotification?: (message: LocalMessage) => string;
-    /** Function that returns the notification text to be displayed when mark channel messages unread request fails */
-    getMarkMessageUnreadErrorNotification?: (message: LocalMessage) => string;
-    /** Function that returns the notification text to be displayed when mark channel messages unread request succeeds */
-    getMarkMessageUnreadSuccessNotification?: (message: LocalMessage) => string;
-    /** Function that returns the notification text to be displayed when a mute user request fails */
-    getMuteUserErrorNotification?: (user: UserResponse) => string;
-    /** Function that returns the notification text to be displayed when a mute user request succeeds */
-    getMuteUserSuccessNotification?: (user: UserResponse) => string;
-    /** Function that returns the notification text to be displayed when a pin message request fails */
-    getPinMessageErrorNotification?: (message: LocalMessage) => string;
-    /** If true, group messages sent by each user (only used in the `VirtualizedMessageList`) */
-    groupedByUser?: boolean;
-    /** A list of styles to apply to this message, i.e. top, bottom, single */
-    groupStyles?: GroupStyle[];
-    /** Whether to highlight and focus the message on load */
-    highlighted?: boolean;
-    /** Whether the threaded message is the first in the thread list */
-    initialMessage?: boolean;
-    /** Latest own message in currently displayed message set. */
-    lastOwnMessage?: LocalMessage;
-    /** Latest message id on current channel */
-    lastReceivedId?: string | null;
-    /** UI component to display a Message in MessageList, overrides value in [ComponentContext](https://getstream.io/chat/docs/sdk/react/contexts/component_context/#message) */
-    Message?: ComponentContextValue['Message'];
-    /** Array of allowed message actions (ex: ['edit', 'delete', 'flag', 'mute', 'pin', 'quote', 'react', 'reply']). To disable all actions, provide an empty array. */
-    messageActions?: MessageActionsArray;
-    /** DOMRect object for parent MessageList component */
-    messageListRect?: DOMRect;
-    /** If true, only the sender of the message has editing privileges */
-    onlySenderCanEdit?: boolean;
-    /** Custom mention click handler to override default in [ChannelActionContext](https://getstream.io/chat/docs/sdk/react/contexts/channel_action_context/) */
-    onMentionsClick?: ChannelActionContextValue['onMentionsClick'];
-    /** Custom mention hover handler to override default in [ChannelActionContext](https://getstream.io/chat/docs/sdk/react/contexts/channel_action_context/) */
-    onMentionsHover?: ChannelActionContextValue['onMentionsHover'];
-    /** Custom function to run on user avatar click */
-    onUserClick?: UserEventHandler;
-    /** Custom function to run on user avatar hover */
-    onUserHover?: UserEventHandler;
-    /** Custom open thread handler to override default in [ChannelActionContext](https://getstream.io/chat/docs/sdk/react/contexts/channel_action_context/) */
-    openThread?: ChannelActionContextValue['openThread'];
-    /** @deprecated in favor of `channelCapabilities - The user roles allowed to pin messages in various channel types */
-    pinPermissions?: PinPermissions;
-    /** Sort options to provide to a reactions query */
-    reactionDetailsSort?: ReactionSort;
-    /** A list of users that have read this Message if the message is the last one and was posted by my user */
-    readBy?: UserResponse[];
-    /** Custom function to render message text content, defaults to the renderText function: [utils](https://github.com/GetStream/stream-chat-react/blob/master/src/utils.ts) */
-    renderText?: (text?: string, mentioned_users?: UserResponse[], options?: RenderTextOptions) => ReactNode;
-    /** Custom retry send message handler to override default in [ChannelActionContext](https://getstream.io/chat/docs/sdk/react/contexts/channel_action_context/) */
-    retrySendMessage?: ChannelActionContextValue['retrySendMessage'];
-    /** Keep track of read receipts for each message sent by the user. When disabled, only the last own message delivery / read status is rendered. */
-    returnAllReadData?: boolean;
-    /** Comparator function to sort the list of reacted users
-     * @deprecated use `reactionDetailsSort` instead
-     */
-    sortReactionDetails?: ReactionDetailsComparator;
-    /** Comparator function to sort reactions, defaults to chronological order */
-    sortReactions?: ReactionsComparator;
-    /** Whether the Message is in a Thread */
-    threadList?: boolean;
-    /** render HTML instead of markdown. Posting HTML is only allowed server-side */
-    unsafeHTML?: boolean;
-};
-export type MessageUIComponentProps = Partial<MessageContextValue>;
-export type PinIndicatorProps = {
-    message?: LocalMessage;
-    t?: TFunction;
-};

package/dist/components/Message/types.js

@@ -1 +0,0 @@
-export {};

package/dist/components/Message/utils.d.ts

@@ -1,85 +0,0 @@
-import type { TFunction } from 'i18next';
-import type { ChannelConfigWithInfo, LocalMessage, MessageResponse, Mute, StreamChat, UserResponse } from 'stream-chat';
-import type { PinPermissions } from './hooks';
-import type { MessageProps } from './types';
-import type { ComponentContextValue, CustomMessageActions, MessageContextValue } from '../../context';
-/**
- * Following function validates a function which returns notification message.
- * It validates if the first parameter is function and also if return value of function is string or no.
- */
-export declare const validateAndGetMessage: <T extends unknown[]>(func: (...args: T) => unknown, args: T) => string | null;
-/**
- * Tell if the owner of the current message is muted
- */
-export declare const isUserMuted: (message: LocalMessage, mutes?: Mute[]) => boolean;
-export declare const OPTIONAL_MESSAGE_ACTIONS: {
-    deleteForMe: string;
-};
-export declare const MESSAGE_ACTIONS: {
-    delete: string;
-    edit: string;
-    flag: string;
-    markUnread: string;
-    mute: string;
-    pin: string;
-    quote: string;
-    react: string;
-    remindMe: string;
-    reply: string;
-    saveForLater: string;
-};
-export type MessageActionsArray<T extends string = string> = Array<keyof typeof MESSAGE_ACTIONS | keyof typeof OPTIONAL_MESSAGE_ACTIONS | T>;
-export declare const defaultPinPermissions: PinPermissions;
-export type Capabilities = {
-    canDelete?: boolean;
-    canEdit?: boolean;
-    canFlag?: boolean;
-    canMarkUnread?: boolean;
-    canMute?: boolean;
-    canPin?: boolean;
-    canQuote?: boolean;
-    canReact?: boolean;
-    canReply?: boolean;
-};
-export declare const getMessageActions: (actions: MessageActionsArray | boolean, { canDelete, canEdit, canFlag, canMarkUnread, canMute, canPin, canQuote, canReact, canReply, }: Capabilities, channelConfig?: ChannelConfigWithInfo) => MessageActionsArray<string>;
-export declare const ACTIONS_NOT_WORKING_IN_THREAD: string[];
-/**
- * @deprecated use `shouldRenderMessageActions` instead
- */
-export declare const showMessageActionsBox: (actions: MessageActionsArray<string>, inThread?: boolean | undefined) => boolean;
-export declare const shouldRenderMessageActions: ({ customMessageActions, CustomMessageActionsList, inThread, messageActions, }: {
-    messageActions: MessageActionsArray;
-    customMessageActions?: CustomMessageActions;
-    CustomMessageActionsList?: ComponentContextValue['CustomMessageActionsList'];
-    inThread?: boolean;
-}) => boolean;
-export declare const areMessagePropsEqual: (prevProps: MessageProps & {
-    mutes?: Mute[];
-    showDetailedReactions?: boolean;
-}, nextProps: MessageProps & {
-    mutes?: Mute[];
-    showDetailedReactions?: boolean;
-}) => boolean;
-export declare const areMessageUIPropsEqual: (prevProps: MessageContextValue & {
-    showDetailedReactions?: boolean;
-}, nextProps: MessageContextValue & {
-    showDetailedReactions?: boolean;
-}) => boolean;
-export declare const messageHasReactions: (message?: LocalMessage) => boolean;
-export declare const messageHasAttachments: (message?: LocalMessage) => boolean;
-export declare const getImages: (message?: MessageResponse) => import("stream-chat").Attachment[];
-export declare const getNonImageAttachments: (message?: MessageResponse) => import("stream-chat").Attachment[];
-export interface TooltipUsernameMapper {
-    (user: UserResponse): string;
-}
-/**
- * Default Tooltip Username mapper implementation.
- *
- * @param user the user.
- */
-export declare const mapToUserNameOrId: TooltipUsernameMapper;
-export declare const getReadByTooltipText: (users: UserResponse[], t: TFunction, client: StreamChat, tooltipUserNameMapper: TooltipUsernameMapper) => string;
-export declare const isOnlyEmojis: (text?: string) => boolean;
-export declare const isMessageBounced: (message: Pick<LocalMessage, 'type' | 'moderation' | 'moderation_details'>) => boolean;
-export declare const isMessageBlocked: (message: Pick<LocalMessage, 'type' | 'moderation' | 'moderation_details'>) => boolean;
-export declare const isMessageEdited: (message: Pick<LocalMessage, 'message_text_updated_at'>) => boolean;