feat!: remove onlySenderCanEdit prop from MessageProps (#3098)

BREAKING CHANGE: remove onlySenderCanEdit from MessageProps

Author: MartinCupela

src/components/Message/Message.tsx

@@ -152,7 +152,6 @@ const MessageWithContext = (props: MessageWithContextProps) => {
   const {
     canPin: canPinPropToNotPass, // eslint-disable-line @typescript-eslint/no-unused-vars
     messageActions: messageActionsPropToNotPass, // eslint-disable-line @typescript-eslint/no-unused-vars
-    onlySenderCanEdit: onlySenderCanEditPropToNotPass, // eslint-disable-line @typescript-eslint/no-unused-vars
     onUserClick: onUserClickPropToNotPass, // eslint-disable-line @typescript-eslint/no-unused-vars
     onUserHover: onUserHoverPropToNotPass, // eslint-disable-line @typescript-eslint/no-unused-vars
     userRoles: userRolesPropToNotPass, // eslint-disable-line @typescript-eslint/no-unused-vars
@@ -193,7 +192,6 @@ export const Message = (props: MessageProps) => {
     closeReactionSelectorOnClick,
     disableQuotedMessages,
     message,
-    onlySenderCanEdit = false,
     onMentionsClick: propOnMentionsClick,
     onMentionsHover: propOnMentionsHover,
     openThread: propOpenThread,
@@ -208,7 +206,7 @@ export const Message = (props: MessageProps) => {
   const handleOpenThread = useOpenThreadHandler(message, propOpenThread);
   const handleReaction = useReactionHandler(message);
   const handleRetry = useRetryHandler(propRetrySendMessage);
-  const userRoles = useUserRole(message, onlySenderCanEdit, disableQuotedMessages);
+  const userRoles = useUserRole(message, disableQuotedMessages);
 
   const handleFetchReactions = useReactionsFetcher(message);
 

src/components/Message/hooks/__tests__/useUserRole.test.tsx

@@ -29,14 +29,12 @@ async function renderUserRoleHook(
     clientContextValue = {},
     disableQuotedMessages = undefined as any,
     message = generateMessage(),
-    onlySenderCanEdit = false,
   } = {} as {
     channelProps?: GenerateChannelOptions & Record<string, unknown>;
     channelStateContextValue?: Partial<ChannelStateContextValue>;
     clientContextValue?: Partial<ChatContextValue>;
     disableQuotedMessages?: boolean;
     message?: LocalMessage;
-    onlySenderCanEdit?: boolean;
   },
 ) {
   const client = await getTestClientWithUser(alice);
@@ -59,7 +57,7 @@ async function renderUserRoleHook(
   );
 
   const { result } = renderHook(
-    () => useUserRole(message as any, onlySenderCanEdit, disableQuotedMessages),
+    () => useUserRole(message as any, disableQuotedMessages),
     { wrapper },
   );
   return result.current;
@@ -231,31 +229,17 @@ describe('useUserRole custom hook', () => {
 
   describe('canDo flags', () => {
     it.each([
-      [true, true, true, alice, true],
-      [true, true, true, bob, false],
-      [false, true, true, alice, true],
-      [false, true, true, bob, true],
-      [true, false, true, alice, true],
-      [true, false, true, bob, false],
-      [true, true, false, alice, false],
-      [true, true, false, bob, false],
-      [false, false, true, alice, true],
-      [false, false, true, bob, false],
-      [false, true, false, alice, true],
-      [false, true, false, bob, true],
-      [true, false, false, alice, false],
-      [true, false, false, bob, false],
-      [false, false, false, alice, false],
-      [false, false, false, bob, false],
+      [true, true, alice, true],
+      [true, true, bob, true],
+      [false, true, alice, true],
+      [false, true, bob, false],
+      [true, false, alice, true],
+      [true, false, bob, true],
+      [false, false, alice, false],
+      [false, false, bob, false],
     ])(
       'determine message edit permission',
-      async (
-        onlySenderCanEdit,
-        updateAnyPermission,
-        updateOwnPermission,
-        messageAuthor,
-        expected,
-      ) => {
+      async (updateAnyPermission, updateOwnPermission, messageAuthor, expected) => {
         const message = generateMessage({ user: messageAuthor });
         const { canEdit } = await renderUserRoleHook({
           channelStateContextValue: {
@@ -265,7 +249,6 @@ describe('useUserRole custom hook', () => {
             },
           },
           message,
-          onlySenderCanEdit,
         });
         expect(canEdit).toBe(expected);
       },

src/components/Message/hooks/useUserRole.ts

@@ -2,11 +2,7 @@ import { useChannelStateContext } from '../../../context/ChannelStateContext';
 import { useChatContext } from '../../../context/ChatContext';
 import type { LocalMessage } from 'stream-chat';
 
-export const useUserRole = (
-  message: LocalMessage,
-  onlySenderCanEdit?: boolean,
-  disableQuotedMessages?: boolean,
-) => {
+export const useUserRole = (message: LocalMessage, disableQuotedMessages?: boolean) => {
   const { channel, channelCapabilities = {} } = useChannelStateContext('useUserRole');
   const { client } = useChatContext('useUserRole');
 
@@ -39,7 +35,7 @@ export const useUserRole = (
   const canEdit =
     !message.poll &&
     message.command !== 'giphy' &&
-    ((!onlySenderCanEdit && channelCapabilities['update-any-message']) ||
+    (channelCapabilities['update-any-message'] ||
       (isMyMessage && channelCapabilities['update-own-message']));
 
   const canDelete =

src/components/Message/types.ts

@@ -47,8 +47,6 @@ export type MessageProps = {
   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/) */

src/components/MessageList/MessageList.tsx

@@ -210,7 +210,6 @@ const MessageListWithContext = (props: MessageListWithContextProps) => {
       Message: props.Message,
       messageActions,
       messageListRect: wrapperRect,
-      onlySenderCanEdit: props.onlySenderCanEdit,
       onMentionsClick: props.onMentionsClick,
       onMentionsHover: props.onMentionsHover,
       onUserClick: props.onUserClick,
@@ -467,7 +466,6 @@ type PropsDrilledToMessage =
   | 'formatDate'
   | 'Message'
   | 'messageActions'
-  | 'onlySenderCanEdit'
   | 'onMentionsClick'
   | 'onMentionsHover'
   | 'onUserClick'