fix: change Block user action to Ban user action

GetStream · Sep 2, 2024 · 781ba1d · 781ba1d
1 parent 0b9f18a
commit 781ba1d
Show file tree

Hide file tree

Showing 25 changed files with 70 additions and 70 deletions.
diff --git a/...components/channel/props/handle_block.mdx → ...i-components/channel/props/handle_ban.mdx b/...components/channel/props/handle_block.mdx → ...i-components/channel/props/handle_ban.mdx
@@ -1,5 +1,5 @@
-Function called when the _Block User_ action is invoked from message actions list.
-This function does not override the default behavior of the _Block User_ action.
+Function called when the _Ban User_ action is invoked from message actions list.
+This function does not override the default behavior of the _Ban User_ action.
 Please refer to [the guide on customizing message actions](../../../../guides/custom-message-actions.mdx) for details.
 
 | Type     |

diff --git a/docusaurus/docs/reactnative/contexts/messages-context.mdx b/docusaurus/docs/reactnative/contexts/messages-context.mdx
@@ -25,7 +25,7 @@ import FormatDate from '../common-content/ui-components/channel/props/format_dat
 import Gallery from '../common-content/ui-components/channel/props/gallery.mdx';
 import Giphy from '../common-content/ui-components/channel/props/giphy.mdx';
 import GiphyVersion from '../common-content/ui-components/channel/props/giphy_version.mdx';
-import HandleBlock from '../common-content/ui-components/channel/props/handle_block.mdx';
+import HandleBan from '../common-content/ui-components/channel/props/handle_ban.mdx';
 import HandleCopy from '../common-content/ui-components/channel/props/handle_copy.mdx';
 import HandleDelete from '../common-content/ui-components/channel/props/handle_delete.mdx';
 import HandleEdit from '../common-content/ui-components/channel/props/handle_edit.mdx';
@@ -110,9 +110,9 @@ Id of current channel.
 
 <FormatDate />
 
-### <div class="label description">_forwarded from [Channel](../../core-components/channel#handleblock)_ props</div> `handleBlock` {#handleblock}
+### <div class="label description">_forwarded from [Channel](../../core-components/channel#handleban)_ props</div> `handleBan` {#handleban}
 
-<HandleBlock />
+<HandleBan />
 
 ### <div class="label description">_forwarded from [Channel](../../core-components/channel#handlecopy)_ props</div> `handleCopy` {#handlecopy}
 

diff --git a/docusaurus/docs/reactnative/core-components/channel.mdx b/docusaurus/docs/reactnative/core-components/channel.mdx
@@ -64,7 +64,7 @@ import Giphy from '../common-content/ui-components/channel/props/giphy.mdx';
 import GiphyEnabled from '../common-content/ui-components/channel/props/giphy_enabled.mdx';
 import GiphyVersion from '../common-content/ui-components/channel/props/giphy_version.mdx';
 import HandleAttachButtonPress from '../common-content/ui-components/channel/props/handle_attach_button_press.mdx';
-import HandleBlock from '../common-content/ui-components/channel/props/handle_block.mdx';
+import HandleBan from '../common-content/ui-components/channel/props/handle_ban.mdx';
 import HandleCopy from '../common-content/ui-components/channel/props/handle_copy.mdx';
 import HandleDelete from '../common-content/ui-components/channel/props/handle_delete.mdx';
 import HandleEdit from '../common-content/ui-components/channel/props/handle_edit.mdx';
@@ -486,9 +486,9 @@ The max allowable is 255, which when reached displays as `255+`.
 
 <HandleAttachButtonPress />
 
-### `handleBlock`
+### `handleBan`
 
-<HandleBlock />
+<HandleBan />
 
 ### `handleCopy`
 

diff --git a/docusaurus/docs/reactnative/guides/custom-message-actions.mdx b/docusaurus/docs/reactnative/guides/custom-message-actions.mdx
@@ -390,7 +390,7 @@ These functions will be called right before the underlying default handlers.
 Please note that these intercepts will neither change the standard functions nor block them.
 :::
 
-- `handleBlock`
+- `handleBan`
 - `handleCopy`
 - `handleDelete`
 - `handleEdit`

diff --git a/docusaurus/docs/reactnative/object-types/message_action.mdx b/docusaurus/docs/reactnative/object-types/message_action.mdx
@@ -30,9 +30,9 @@ Callback when user presses the action button.
 
 Type of the action performed.
 
-| Type                                                                                                                                                                                        |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| enum('blockUser', 'copyMessage', 'deleteMessage', 'editMessage', 'flagMessage', 'muteUser', 'pinMessage', 'selectReaction', 'reply', 'retry', 'quotedReply', 'threadReply', 'unpinMessage') |
+| Type                                                                                                                                                                                      |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| enum('banUser', 'copyMessage', 'deleteMessage', 'editMessage', 'flagMessage', 'muteUser', 'pinMessage', 'selectReaction', 'reply', 'retry', 'quotedReply', 'threadReply', 'unpinMessage') |
 
 ### icon
 

diff --git a/package/src/components/Channel/Channel.tsx b/package/src/components/Channel/Channel.tsx
@@ -271,7 +271,7 @@ export type ChannelPropsWithContext<
       | 'getMessagesGroupStyles'
       | 'Giphy'
       | 'giphyVersion'
-      | 'handleBlock'
+      | 'handleBan'
       | 'handleCopy'
       | 'handleDelete'
       | 'handleEdit'
@@ -481,7 +481,7 @@ const ChannelWithContext = <
     giphyEnabled,
     giphyVersion = 'fixed_height',
     handleAttachButtonPress,
-    handleBlock,
+    handleBan,
     handleCopy,
     handleDelete,
     handleEdit,
@@ -660,7 +660,9 @@ const ChannelWithContext = <
 
       if (messageId) {
         loadChannelAroundMessage({ messageId });
-      } else if (
+      }
+      // The condition, where if the count of unread messages is greater than 4, then scroll to the first unread message.
+      else if (
         initialScrollToFirstUnreadMessage &&
         channel.countUnread() > scrollToFirstUnreadThreshold
       ) {
@@ -2310,7 +2312,7 @@ const ChannelWithContext = <
     getMessagesGroupStyles,
     Giphy,
     giphyVersion,
-    handleBlock,
+    handleBan,
     handleCopy,
     handleDelete,
     handleEdit,

diff --git a/package/src/components/Channel/__tests__/ownCapabilities.test.js b/package/src/components/Channel/__tests__/ownCapabilities.test.js
@@ -107,17 +107,17 @@ describe('Own capabilities', () => {
   });
 
   describe(`${allOwnCapabilities.banChannelMembers} capability`, () => {
-    it(`should render "Block User" message action when ${allOwnCapabilities.banChannelMembers} capability is enabled`, async () => {
+    it(`should render "Ban User" message action when ${allOwnCapabilities.banChannelMembers} capability is enabled`, async () => {
       await generateChannelWithCapabilities([allOwnCapabilities.banChannelMembers]);
       const { queryByTestId } = await renderChannelAndOpenMessageActionsList(receivedMessage);
-      expect(!!queryByTestId('blockUser-list-item')).toBeTruthy();
+      expect(!!queryByTestId('banUser-list-item')).toBeTruthy();
     });
 
-    it(`should not render "Block User" message action when ${allOwnCapabilities.banChannelMembers} capability is disabled`, async () => {
+    it(`should not render "Ban User" message action when ${allOwnCapabilities.banChannelMembers} capability is disabled`, async () => {
       await generateChannelWithCapabilities();
 
       const { queryByTestId } = await renderChannelAndOpenMessageActionsList(receivedMessage);
-      expect(!!queryByTestId('blockUser-list-item')).toBeFalsy();
+      expect(!!queryByTestId('banUser-list-item')).toBeFalsy();
     });
 
     it(`should override capability from "overrideOwnCapability.banChannelMembers" prop`, async () => {
@@ -128,7 +128,7 @@ describe('Own capabilities', () => {
           banChannelMembers: false,
         },
       });
-      expect(!!queryByTestId('blockUser-list-item')).toBeFalsy();
+      expect(!!queryByTestId('banUser-list-item')).toBeFalsy();
     });
   });
 

diff --git a/package/src/components/Channel/hooks/useCreateMessagesContext.ts b/package/src/components/Channel/hooks/useCreateMessagesContext.ts
@@ -31,7 +31,7 @@ export const useCreateMessagesContext = <
   getMessagesGroupStyles,
   Giphy,
   giphyVersion,
-  handleBlock,
+  handleBan,
   handleCopy,
   handleDelete,
   handleEdit,
@@ -128,7 +128,7 @@ export const useCreateMessagesContext = <
       getMessagesGroupStyles,
       Giphy,
       giphyVersion,
-      handleBlock,
+      handleBan,
       handleCopy,
       handleDelete,
       handleEdit,

diff --git a/package/src/components/Message/Message.tsx b/package/src/components/Message/Message.tsx
@@ -142,7 +142,7 @@ export type MessagePropsWithContext<
     | 'deleteMessage'
     | 'dismissKeyboardOnMessageTouch'
     | 'forceAlignMessages'
-    | 'handleBlock'
+    | 'handleBan'
     | 'handleCopy'
     | 'handleDelete'
     | 'handleEdit'
@@ -249,7 +249,7 @@ const MessageWithContext = <
     forceAlignMessages = false,
     goToMessage,
     groupStyles = ['bottom'],
-    handleBlock,
+    handleBan,
     handleCopy,
     handleDelete,
     handleEdit,
@@ -507,7 +507,7 @@ const MessageWithContext = <
   });
 
   const {
-    blockUser,
+    banUser,
     copyMessage,
     deleteMessage,
     editMessage,
@@ -525,7 +525,7 @@ const MessageWithContext = <
     deleteMessage: deleteMessageFromContext,
     deleteReaction,
     enforceUniqueReaction,
-    handleBlock,
+    handleBan,
     handleCopy,
     handleDelete,
     handleEdit,
@@ -564,7 +564,7 @@ const MessageWithContext = <
       typeof messageActionsProp !== 'function'
         ? messageActionsProp
         : messageActionsProp({
-            blockUser,
+            banUser,
             copyMessage,
             deleteMessage,
             dismissOverlay,

diff --git a/package/src/components/Message/hooks/useMessageActions.tsx b/package/src/components/Message/hooks/useMessageActions.tsx
@@ -39,7 +39,7 @@ export const useMessageActions = <
   deleteMessage: deleteMessageFromContext,
   deleteReaction,
   enforceUniqueReaction,
-  handleBlock,
+  handleBan,
   handleCopy,
   handleDelete,
   handleEdit,
@@ -65,7 +65,7 @@ export const useMessageActions = <
   MessagesContextValue<StreamChatGenerics>,
   | 'deleteMessage'
   | 'sendReaction'
-  | 'handleBlock'
+  | 'handleBan'
   | 'handleCopy'
   | 'handleDelete'
   | 'handleEdit'
@@ -138,20 +138,20 @@ export const useMessageActions = <
     (mute) => mute.user.id === client.userID && mute.target.id === message.user?.id,
   );
 
-  const blockUser: MessageActionType = {
+  const banUser: MessageActionType = {
     action: async () => {
       setOverlay('none');
       if (message.user?.id) {
-        if (handleBlock) {
-          handleBlock(message);
+        if (handleBan) {
+          handleBan(message);
         }
 
         await handleToggleBanUser();
       }
     },
-    actionType: 'blockUser',
+    actionType: 'banUser',
     icon: <UserDelete pathFill={grey} />,
-    title: message.user?.banned ? t('Unblock User') : t('Block User'),
+    title: message.user?.banned ? t('Unban User') : t('Ban User'),
   };
 
   const copyMessage: MessageActionType | undefined =
@@ -307,7 +307,7 @@ export const useMessageActions = <
   };
 
   return {
-    blockUser,
+    banUser,
     copyMessage,
     deleteMessage,
     editMessage,

diff --git a/package/src/components/Message/utils/messageActions.ts b/package/src/components/Message/utils/messageActions.ts
@@ -6,7 +6,7 @@ import type { MessageActionType } from '../../MessageOverlay/MessageActionListIt
 export type MessageActionsParams<
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,
 > = {
-  blockUser: MessageActionType;
+  banUser: MessageActionType;
   deleteMessage: MessageActionType;
   dismissOverlay: () => void;
   editMessage: MessageActionType;
@@ -31,7 +31,7 @@ export type MessageActionsProp<
 export const messageActions = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,
 >({
-  blockUser,
+  banUser,
   copyMessage,
   deleteMessage,
   editMessage,
@@ -89,9 +89,7 @@ export const messageActions = <
     actions.push(unpinMessage);
   }
 
-  if (!isMyMessage && ownCapabilities.banChannelMembers) {
-    actions.push(blockUser);
-  }
+  actions.push(banUser);
 
   if (
     (isMyMessage && ownCapabilities.deleteOwnMessage) ||

diff --git a/package/src/components/MessageOverlay/MessageActionListItem.tsx b/package/src/components/MessageOverlay/MessageActionListItem.tsx
@@ -11,7 +11,7 @@ import type { DefaultStreamChatGenerics } from '../../types/types';
 import type { MessageOverlayPropsWithContext } from '../MessageOverlay/MessageOverlay';
 
 export type ActionType =
-  | 'blockUser'
+  | 'banUser'
   | 'copyMessage'
   | 'deleteMessage'
   | 'editMessage'
@@ -32,7 +32,7 @@ export type MessageActionType = {
   action: () => void;
   /**
    * Type of the action performed.
-   * Eg: 'blockUser', 'copyMessage', 'deleteMessage', 'editMessage', 'flagMessage', 'muteUser', 'pinMessage', 'selectReaction', 'reply', 'retry', 'quotedReply', 'threadReply', 'unpinMessage'
+   * Eg: 'banUser', 'copyMessage', 'deleteMessage', 'editMessage', 'flagMessage', 'muteUser', 'pinMessage', 'selectReaction', 'reply', 'retry', 'quotedReply', 'threadReply', 'unpinMessage'
    */
   actionType: ActionType;
   /**

diff --git a/package/src/contexts/messagesContext/MessagesContext.tsx b/package/src/contexts/messagesContext/MessagesContext.tsx
@@ -316,7 +316,7 @@ export type MessagesContextValue<
    */
   forceAlignMessages?: Alignment | boolean;
   getMessagesGroupStyles?: typeof getGroupStyles;
-  handleBlock?: (message: MessageType<StreamChatGenerics>) => Promise<void>;
+  handleBan?: (message: MessageType<StreamChatGenerics>) => Promise<void>;
   /** Handler to access when a copy message action is invoked */
   handleCopy?: (message: MessageType<StreamChatGenerics>) => Promise<void>;
   /** Handler to access when a delete message action is invoked */
@@ -380,7 +380,7 @@ export type MessagesContextValue<
    * ```
    * <Channel
    *   messageActions={({
-   *     blockUser,
+   *     banUser,
    *     copyMessage,
    *     deleteMessage,
    *     editMessage,

diff --git a/package/src/i18n/en.json b/package/src/i18n/en.json
@@ -6,7 +6,7 @@
   "Also send to channel": "Also send to channel",
   "Are you sure you want to permanently delete this message?": "Are you sure you want to permanently delete this message?",
   "Are you sure?": "Are you sure?",
-  "Block User": "Block User",
+  "Ban User": "Ban User",
   "Cancel": "Cancel",
   "Cannot Flag Message": "Cannot Flag Message",
   "Consider how your comment might make others feel and be sure to follow our Community Guidelines": "Consider how your comment might make others feel and be sure to follow our Community Guidelines",
@@ -67,7 +67,7 @@
   "Slow mode ON": "Slow mode ON",
   "The message has been reported to a moderator.": "The message has been reported to a moderator.",
   "Thread Reply": "Thread Reply",
-  "Unblock User": "Unblock User",
+  "Unban User": "Unban User",
   "Unknown User": "Unknown User",
   "Unmute User": "Unmute User",
   "Unpin from Conversation": "Unpin from Conversation",

diff --git a/package/src/i18n/es.json b/package/src/i18n/es.json
@@ -6,7 +6,7 @@
   "Also send to channel": "También enviar al canal",
   "Are you sure you want to permanently delete this message?": "¿Estás seguro de que deseas eliminar permanentemente este mensaje?",
   "Are you sure?": "¿Estás seguro?",
-  "Block User": "Bloquear usuario",
+  "Ban User": "Bloquear Usuario",
   "Cancel": "Cancelar",
   "Cannot Flag Message": "No se puede reportar el mensaje",
   "Consider how your comment might make others feel and be sure to follow our Community Guidelines": "Considera cómo tu comentario podría hacer sentir a los demás y asegúrate de seguir nuestras Normas de la Comunidad",
@@ -67,8 +67,8 @@
   "Slow mode ON": "Modo lento ACTIVADO",
   "The message has been reported to a moderator.": "El mensaje ha sido reportado a un moderador.",
   "Thread Reply": "Respuesta de hilo",
-  "Unblock User": "Desbloquear usuario",
-  "Unknown User": "Usuario desconocido",
+  "Unban User": "Desbloquear usuario",
+  "Unknown User": "Desbloquear Usuario",
   "Unmute User": "Activar sonido del usuario",
   "Unpin from Conversation": "Desmarcar de la conversación",
   "Unread Messages": "Mensajes no leídos",

diff --git a/package/src/i18n/fr.json b/package/src/i18n/fr.json
@@ -6,7 +6,7 @@
   "Also send to channel": "Envoyer également à la chaîne",
   "Are you sure you want to permanently delete this message?": "Êtes-vous sûr de vouloir supprimer définitivement ce message?",
   "Are you sure?": "Es-tu sûr ?",
-  "Block User": "Bloquer un utilisateur",
+  "Ban User": "Bannir Utilisateur",
   "Cancel": "Annuler",
   "Cannot Flag Message": "Impossible de signaler le message",
   "Consider how your comment might make others feel and be sure to follow our Community Guidelines": "Considérez comment votre commentaire pourrait faire sentir les autres et assurez-vous de suivre nos directives communautaires",
@@ -67,7 +67,7 @@
   "Slow mode ON": "Mode lent activé",
   "The message has been reported to a moderator.": "Le message a été signalé à un modérateur.",
   "Thread Reply": "Réponse à la discussion",
-  "Unblock User": "Débloquer Utilisateur",
+  "Unban User": "Débannir Utilisateur",
   "Unknown User": "Utilisateur inconnu",
   "Unmute User": "Activer le son de Utilisateur",
   "Unpin from Conversation": "Décrocher de la conversation",

diff --git a/package/src/i18n/he.json b/package/src/i18n/he.json
@@ -6,7 +6,7 @@
   "Also send to channel": "שלח/י הודעה לשיחה",
   "Are you sure you want to permanently delete this message?": "האם את/ה בטוח/ה שאת/ה רוצה למחוק את ההודעה הזו לצמיתות?",
   "Are you sure?": "האם אתה בטוח?",
-  "Block User": "חסום משתמש",
+  "Ban User": "לחסום משתמש",
   "Cancel": "ביטול",
   "Cannot Flag Message": "סימון הודעה לא אפשרי",
   "Consider how your comment might make others feel and be sure to follow our Community Guidelines": "שקול איך התגובה שלך עשויה להשפיע על אחרים ווודא שאתה עוקב אחר ההנחיות של הקהילה שלנו",
@@ -67,7 +67,7 @@
   "Slow mode ON": "מצב איטי מופעל",
   "The message has been reported to a moderator.": "ההודעה דווחה למנהל",
   "Thread Reply": "הגב/י בשרשור",
-  "Unblock User": "בטל/י חסימת משתמש",
+  "Unban User": "לבטל חסימת משתמש",
   "Unknown User": "משתמש לא ידוע",
   "Unmute User": "בטל/י השתקת משתמש",
   "Unpin from Conversation": "בטל/י הצמדה לשיחה",