From 9cf5e3f20708759cf9097d09fddbc6d48dc8eaf7 Mon Sep 17 00:00:00 2001 From: Ryan Miller Date: Mon, 2 Sep 2024 09:27:18 +1000 Subject: [PATCH] fix: type safety for generated i18n args --- .../message-item/GroupUpdateMessage.tsx | 18 +++++++----------- .../message/reactions/ReactionPopup.tsx | 4 ++-- ts/components/dialog/SessionConfirm.tsx | 6 +++--- .../blockOrUnblock/BlockOrUnblockDialog.tsx | 6 ++++-- ts/models/groupUpdate.ts | 15 +++++++++++---- ts/types/Localizer.ts | 2 ++ 6 files changed, 29 insertions(+), 22 deletions(-) diff --git a/ts/components/conversation/message/message-item/GroupUpdateMessage.tsx b/ts/components/conversation/message/message-item/GroupUpdateMessage.tsx index adbf1f26a..65be36115 100644 --- a/ts/components/conversation/message/message-item/GroupUpdateMessage.tsx +++ b/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) => { +const ChangeItemJoined = (added: Array): I18nPropsObject => { const groupName = useSelectedNicknameOrProfileNameOrShortenedPubkey(); if (!added.length) { @@ -27,7 +26,7 @@ const ChangeItemJoined = (added: Array) => { return getJoinedGroupUpdateChangeStr(added, groupName); }; -const ChangeItemKicked = (kicked: Array) => { +const ChangeItemKicked = (kicked: Array): I18nPropsObject => { if (!kicked.length) { throw new Error('Group update kicked is missing details'); } @@ -36,7 +35,7 @@ const ChangeItemKicked = (kicked: Array) => { return getKickedGroupUpdateStr(kicked, groupName); }; -const ChangeItemLeft = (left: Array) => { +const ChangeItemLeft = (left: Array): I18nPropsObject => { const groupName = useSelectedNicknameOrProfileNameOrShortenedPubkey(); if (!left.length) { @@ -46,7 +45,7 @@ const ChangeItemLeft = (left: Array) => { 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 null; + return { token: 'groupUpdated' }; } }; export const GroupUpdateMessage = (props: PropsForGroupUpdate) => { const { change, messageId } = props; - // TODO: clean up this typing - const changeItem = ChangeItem(change) as I18nProps | null; + const changeItem = ChangeItem(change); return ( => { +): I18nPropsObject => { const name = contacts[0]; const other_name = contacts[1]; const emoji_name = emojiName ? `:${emojiName}:` : emoji; diff --git a/ts/components/dialog/SessionConfirm.tsx b/ts/components/dialog/SessionConfirm.tsx index 18a2c4dd6..a09df3101 100644 --- a/ts/components/dialog/SessionConfirm.tsx +++ b/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; - i18nMessageSub?: I18nProps; + i18nMessage?: I18nPropsObject; + i18nMessageSub?: I18nPropsObject; title?: string; radioOptions?: SessionRadioItems; onOk?: any; diff --git a/ts/components/dialog/blockOrUnblock/BlockOrUnblockDialog.tsx b/ts/components/dialog/blockOrUnblock/BlockOrUnblockDialog.tsx index 46c9b3f2d..be09a0774 100644 --- a/ts/components/dialog/blockOrUnblock/BlockOrUnblockDialog.tsx +++ b/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; -function getUnblockTokenAndArgs(names: Array) { +function getUnblockTokenAndArgs(names: Array): I18nPropsObject { // multiple unblock is supported switch (names.length) { case 1: @@ -36,7 +37,7 @@ function getUnblockTokenAndArgs(names: Array) { function useBlockUnblockI18nDescriptionArgs({ action, pubkeys, -}: Pick) { +}: Pick): 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 ( diff --git a/ts/models/groupUpdate.ts b/ts/models/groupUpdate.ts index 750e85486..145983672 100644 --- a/ts/models/groupUpdate.ts +++ b/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) { @@ -11,7 +12,7 @@ function usAndXOthers(arr: Array) { return { us: false, others: arr }; } -export function getKickedGroupUpdateStr(kicked: Array, groupName: string) { +export function getKickedGroupUpdateStr(kicked: Array, groupName: string): I18nPropsObject { const { others, us } = usAndXOthers(kicked); const othersNames = others.map( getConversationController().getContactProfileNameOrShortenedPubKey @@ -43,7 +44,7 @@ export function getKickedGroupUpdateStr(kicked: Array, 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, groupName: string } } -export function getLeftGroupUpdateChangeStr(left: Array, _groupName: string) { +export function getLeftGroupUpdateChangeStr( + left: Array, + _groupName: string +): I18nPropsObject { const { others, us } = usAndXOthers(left); if (left.length !== 1) { @@ -69,7 +73,10 @@ export function getLeftGroupUpdateChangeStr(left: Array, _groupName: str }; } -export function getJoinedGroupUpdateChangeStr(joined: Array, _groupName: string) { +export function getJoinedGroupUpdateChangeStr( + joined: Array, + _groupName: string +): I18nPropsObject { const { others, us } = usAndXOthers(joined); const othersNames = others.map( getConversationController().getContactProfileNameOrShortenedPubKey diff --git a/ts/types/Localizer.ts b/ts/types/Localizer.ts index 146e2dc1e..aa35c7002 100644 --- a/ts/types/Localizer.ts +++ b/ts/types/Localizer.ts @@ -62,6 +62,8 @@ export type I18nProps = T extends LocalizerToken : I18nBaseProps & { args: ArgsRecordExcludingDefaults } : never; +export type I18nPropsObject = I18nProps; + export type I18nMethods = { /** @see {@link window.i18n.stripped} */ stripped: (