fix: type safety for generated i18n args

ts/components/conversation/message/message-item/GroupUpdateMessage.tsx

@@ -9,15 +9,14 @@ import {
   PropsForGroupUpdateType,
 } from '../../../../state/ducks/conversations';
 import { useSelectedNicknameOrProfileNameOrShortenedPubkey } from '../../../../state/selectors/selectedConversation';
-import { assertUnreachable } from '../../../../types/sqlSharedTypes';
 import { ExpirableReadableMessage } from './ExpirableReadableMessage';
 import { NotificationBubble } from './notification-bubble/NotificationBubble';
 import { I18n } from '../../../basic/I18n';
-import { I18nProps, LocalizerToken } from '../../../../types/Localizer';
+import { type I18nPropsObject } from '../../../../types/Localizer';
 
 // This component is used to display group updates in the conversation view.
 
-const ChangeItemJoined = (added: Array<string>) => {
+const ChangeItemJoined = (added: Array<string>): I18nPropsObject => {
   const groupName = useSelectedNicknameOrProfileNameOrShortenedPubkey();
 
   if (!added.length) {
@@ -27,7 +26,7 @@ const ChangeItemJoined = (added: Array<string>) => {
   return getJoinedGroupUpdateChangeStr(added, groupName);
 };
 
-const ChangeItemKicked = (kicked: Array<string>) => {
+const ChangeItemKicked = (kicked: Array<string>): I18nPropsObject => {
   if (!kicked.length) {
     throw new Error('Group update kicked is missing details');
   }
@@ -36,7 +35,7 @@ const ChangeItemKicked = (kicked: Array<string>) => {
   return getKickedGroupUpdateStr(kicked, groupName);
 };
 
-const ChangeItemLeft = (left: Array<string>) => {
+const ChangeItemLeft = (left: Array<string>): I18nPropsObject => {
   const groupName = useSelectedNicknameOrProfileNameOrShortenedPubkey();
 
   if (!left.length) {
@@ -46,7 +45,7 @@ const ChangeItemLeft = (left: Array<string>) => {
   return getLeftGroupUpdateChangeStr(left, groupName);
 };
 
-const ChangeItem = (change: PropsForGroupUpdateType) => {
+const ChangeItem = (change: PropsForGroupUpdateType): I18nPropsObject => {
   const { type } = change;
   switch (type) {
     case 'name':
@@ -62,18 +61,15 @@ const ChangeItem = (change: PropsForGroupUpdateType) => {
       return ChangeItemKicked(change.kicked);
 
     case 'general':
-      return { token: 'groupUpdated' };
     default:
-      assertUnreachable(type, `ChangeItem: Missing case error "${type}"`);
+      return { token: 'groupUpdated' };
-      return null;
   }
 };
 
 export const GroupUpdateMessage = (props: PropsForGroupUpdate) => {
   const { change, messageId } = props;
 
-  // TODO: clean up this typing
+  const changeItem = ChangeItem(change);
-  const changeItem = ChangeItem(change) as I18nProps<LocalizerToken> | null;
 
   return (
     <ExpirableReadableMessage

ts/components/conversation/message/reactions/ReactionPopup.tsx

@@ -5,7 +5,7 @@ import { PubKey } from '../../../../session/types/PubKey';
 
 import { I18n } from '../../../basic/I18n';
 import { nativeEmojiData } from '../../../../util/emoji';
-import { I18nProps, LocalizerToken } from '../../../../types/Localizer';
+import { type I18nPropsObject } from '../../../../types/Localizer';
 
 export type TipPosition = 'center' | 'left' | 'right';
 
@@ -86,7 +86,7 @@ const getI18nComponentProps = (
   numberOfReactors: number,
   emoji: string,
   emojiName?: string
-): I18nProps<LocalizerToken> => {
+): I18nPropsObject => {
   const name = contacts[0];
   const other_name = contacts[1];
   const emoji_name = emojiName ? `:${emojiName}:` : emoji;

ts/components/dialog/SessionConfirm.tsx

@@ -10,13 +10,13 @@ import { SessionButton, SessionButtonColor, SessionButtonType } from '../basic/S
 import { SessionRadioGroup, SessionRadioItems } from '../basic/SessionRadioGroup';
 import { SpacerLG } from '../basic/Text';
 import { SessionSpinner } from '../loading';
-import { I18nProps, LocalizerToken } from '../../types/Localizer';
+import { type I18nPropsObject } from '../../types/Localizer';
 
 import { StyledI18nSubText } from '../basic/StyledI18nSubText';
 
 export interface SessionConfirmDialogProps {
-  i18nMessage?: I18nProps<LocalizerToken>;
+  i18nMessage?: I18nPropsObject;
-  i18nMessageSub?: I18nProps<LocalizerToken>;
+  i18nMessageSub?: I18nPropsObject;
   title?: string;
   radioOptions?: SessionRadioItems;
   onOk?: any;

ts/components/dialog/blockOrUnblock/BlockOrUnblockDialog.tsx

@@ -14,10 +14,11 @@ import { I18n } from '../../basic/I18n';
 import { SessionButton, SessionButtonColor, SessionButtonType } from '../../basic/SessionButton';
 import { StyledModalDescriptionContainer } from '../shared/ModalDescriptionContainer';
 import { BlockOrUnblockModalState } from './BlockOrUnblockModalState';
+import type { I18nPropsObject } from '../../../types/Localizer';
 
 type ModalState = NonNullable<BlockOrUnblockModalState>;
 
-function getUnblockTokenAndArgs(names: Array<string>) {
+function getUnblockTokenAndArgs(names: Array<string>): I18nPropsObject {
   // multiple unblock is supported
   switch (names.length) {
     case 1:
@@ -36,7 +37,7 @@ function getUnblockTokenAndArgs(names: Array<string>) {
 function useBlockUnblockI18nDescriptionArgs({
   action,
   pubkeys,
-}: Pick<ModalState, 'action' | 'pubkeys'>) {
+}: Pick<ModalState, 'action' | 'pubkeys'>): I18nPropsObject {
   const names = useConversationsNicknameRealNameOrShortenPubkey(pubkeys);
   if (!pubkeys.length) {
     throw new Error('useI18nDescriptionArgsForAction called with empty list of pubkeys');
@@ -81,6 +82,7 @@ export const BlockOrUnblockDialog = ({ pubkeys, action, onConfirmed }: NonNullab
     closeModal();
     return null;
   }
+  
   return (
     <SessionWrapperModal showExitIcon={true} title={localizedAction} onClose={closeModal}>
       <StyledModalDescriptionContainer>

ts/models/groupUpdate.ts

@@ -1,5 +1,6 @@
 import { getConversationController } from '../session/conversations';
 import { UserUtils } from '../session/utils';
+import type { I18nPropsObject } from '../types/Localizer';
 
 // to remove after merge with groups
 function usAndXOthers(arr: Array<string>) {
@@ -11,7 +12,7 @@ function usAndXOthers(arr: Array<string>) {
   return { us: false, others: arr };
 }
 
-export function getKickedGroupUpdateStr(kicked: Array<string>, groupName: string) {
+export function getKickedGroupUpdateStr(kicked: Array<string>, groupName: string): I18nPropsObject {
   const { others, us } = usAndXOthers(kicked);
   const othersNames = others.map(
     getConversationController().getContactProfileNameOrShortenedPubKey
@@ -43,7 +44,7 @@ export function getKickedGroupUpdateStr(kicked: Array<string>, groupName: string
       };
     default:
       return {
-        token: 'groupRemovedMore',
+        token: 'groupRemovedMultiple',
         args: {
           name: others[0],
           count: othersNames.length - 1,
@@ -52,7 +53,10 @@ export function getKickedGroupUpdateStr(kicked: Array<string>, groupName: string
   }
 }
 
-export function getLeftGroupUpdateChangeStr(left: Array<string>, _groupName: string) {
+export function getLeftGroupUpdateChangeStr(
+  left: Array<string>,
+  _groupName: string
+): I18nPropsObject {
   const { others, us } = usAndXOthers(left);
 
   if (left.length !== 1) {
@@ -69,7 +73,10 @@ export function getLeftGroupUpdateChangeStr(left: Array<string>, _groupName: str
       };
 }
 
-export function getJoinedGroupUpdateChangeStr(joined: Array<string>, _groupName: string) {
+export function getJoinedGroupUpdateChangeStr(
+  joined: Array<string>,
+  _groupName: string
+): I18nPropsObject {
   const { others, us } = usAndXOthers(joined);
   const othersNames = others.map(
     getConversationController().getContactProfileNameOrShortenedPubKey

ts/types/Localizer.ts

@@ -62,6 +62,8 @@ export type I18nProps<T extends LocalizerToken> = T extends LocalizerToken
       : I18nBaseProps<T> & { args: ArgsRecordExcludingDefaults<T> }
   : never;
 
+export type I18nPropsObject = I18nProps<LocalizerToken>;
+
 export type I18nMethods = {
   /** @see {@link window.i18n.stripped} */
   stripped: <T extends LocalizerToken, R extends LocalizerDictionary[T]>(