keejef
/
session-desktop
mirror of https://github.com/oxen-io/session-desktop
2
0
Fork 0
Code Issues 8 Projects Releases Wiki Activity

fix: address PR review

Browse Source
pull/3206/head
Audric Ackermann 7 months ago
parent d8e1e3da71
commit 9c2ef47988
No known key found for this signature in database
38 changed files with 145 additions and 216 deletions
Show Stats Download Patch File Download Diff File

4
_locales/en/messages.json
Unescape Escape View File

@ -639,6 +639,7 @@
"passwordSet": "Set Password",
"passwordSetDescription": "Your password has been set. Please keep it safe.",
"paste": "Paste",
"permissionMusicAudioDenied": "{app_name} needs music and audio access in order to send files, music and audio, but it has been permanently denied. Tap Settings -> Permissions, and turn \"Music and audio\" on.",
"permissionsAppleMusic": "{app_name} needs to use Apple Music to play media attachments.",
"permissionsAutoUpdate": "Auto Update",
"permissionsAutoUpdateDescription": "Automatically check for updates on startup.",
@ -652,8 +653,9 @@
"permissionsMicrophoneAccessRequiredDesktop": "You can enable microphone access in {app_name}'s privacy settings",
"permissionsMicrophoneAccessRequiredIos": "{app_name} needs microphone access to make calls and record audio messages.",
"permissionsMicrophoneDescription": "Allow access to microphone.",
"permissionsMusicAudio": "{app_name} needs music and audio access in order to send files, music and audio.",
"permissionsRequired": "Permission required",
"permissionsStorageDenied": "{app_name} needs storage access so you can send and save attachments. Tap Settings -> Permissions, and turn \"Files and media\" on.",
"permissionsStorageDenied": "{app_name} needs photo library access so you can send photos and videos, but it has been permanently denied. Tap Settings -> Permissions, and turn \"Photos and videos\" on.",
"permissionsStorageDeniedLegacy": "{app_name} needs storage access so you can send and save attachments. Tap Settings -> Permissions, and turn \"Storage\" on.",
"permissionsStorageSave": "{app_name} needs storage access to save attachments and media.",
"permissionsStorageSaveDenied": "{app_name} needs storage access to save photos and videos, but it has been permanently denied. Please continue to app settings, select \"Permissions\", and enable \"Storage\".",

3
crowdin.yml
Unescape Escape View File

@ -1,3 +0,0 @@
commit_message: '[CI SKIP]'
bundles:
- 12

1
package.json
Unescape Escape View File

@ -182,7 +182,6 @@
"chai": "^4.3.4",
"chai-as-promised": "^7.1.1",
"chai-bytes": "^0.1.2",
"concurrently": "^8.2.2",
"cross-env": "^6.0.3",
"css-loader": "^6.7.2",
"dmg-builder": "23.6.0",

3
ts/components/EmptyMessageView.tsx
Unescape Escape View File

@ -5,6 +5,7 @@ import { useIsDarkTheme } from '../state/selectors/theme';
import { isSignWithRecoveryPhrase } from '../util/storage';
import { Flex } from './basic/Flex';
import { Spacer2XL, SpacerXS } from './basic/Text';
import { Localizer } from './basic/Localizer';
const StyledPlaceholder = styled(Flex)`
background-color: var(--background-secondary-color);
@ -91,7 +92,7 @@ export const EmptyMessageView = () => {
<StyledSessionWelcome
color={isDarkTheme ? 'var(--primary-color)' : 'var(--text-primary-color)'}
>
{window.i18n('onboardingBubbleWelcomeToSession', { emoji: '👋' })}
<Localizer token="onboardingBubbleWelcomeToSession" args={{ emoji: '👋' }} />
</StyledSessionWelcome>
</>
) : (

2
ts/components/calling/IncomingCallDialog.tsx
Unescape Escape View File

@ -78,7 +78,7 @@ export const IncomingCallDialog = () => {
return (
<SessionWrapperModal
title={window.i18n('callsIncoming', {
name: from ?? 'unknown',
name: from ?? window.i18n('unknown'),
})}
>
<IncomingCallAvatarContainer>

2
ts/components/conversation/StagedAttachmentList.tsx
Unescape Escape View File

@ -83,7 +83,7 @@ export const StagedAttachmentList = (props: Props) => {
return (
<Image
key={imageKey}
alt={''}
alt="Staged Attachment" // TODO localize this (and others alt/aria-labels) via crowdin
attachment={attachment}
softCorners={true}
playIconOverlay={isVideoAttachment(attachment)}

2
ts/components/conversation/StagedLinkPreview.tsx
Unescape Escape View File

@ -77,7 +77,7 @@ export const StagedLinkPreview = (props: Props) => {
{isLoaded && image && isContentTypeImage ? (
<StyledImage>
<Image
alt={domain ?? ''}
alt={'Image of staged link preview'} // TODO this needs to be fixed via crowdin
attachment={image as any}
height={100}
width={100}

2
ts/components/conversation/TypingAnimation.tsx
Unescape Escape View File

@ -73,7 +73,7 @@ const StyledSpacer = styled.div`
export const TypingAnimation = () => {
return (
<StyledTypingContainer>
<StyledTypingContainer aria-label={window.i18n('typingIndicators')}>
<StyledTypingDot index={0} />
<StyledSpacer />
<StyledTypingDot index={1} />

8
ts/components/conversation/composition/CompositionBox.tsx
Unescape Escape View File

@ -391,9 +391,9 @@ class CompositionBoxInner extends Component<Props, State> {
const { showEmojiPanel } = this.state;
const { typingEnabled } = this.props;
// we can only send a message if the conversation allows writing in it
// - we've got a message body
// - or we've got a staged attachments
// we can only send a message if the conversation allows writing in it AND
// - we've got a message body OR
// - we've got a staged attachments
const showSendButton =
typingEnabled && (!isEmpty(this.state.draft) || !isEmpty(this.props.stagedAttachments));
@ -674,7 +674,7 @@ class CompositionBoxInner extends Component<Props, State> {
const onSave = (caption: string) => {
// eslint-disable-next-line no-param-reassign
attachment.caption = caption;
ToastUtils.pushToastInfo('saved', window.i18n('saved'));
ToastUtils.pushToastInfo('saved', window.i18n.stripped('saved'));
// close the lightbox on save
this.setState({
showCaptionEditor: undefined,

2
ts/components/conversation/message/message-content/MessageLinkPreview.tsx
Unescape Escape View File

@ -74,7 +74,7 @@ export const MessageLinkPreview = (props: Props) => {
<div className="module-message__link-preview__image_container">
<Image
softCorners={true}
alt={first.domain}
alt={`Link preview for ${first.domain}`} // TODO this needs to be fixed via crowdin
height={linkPreviewsImageSize}
width={linkPreviewsImageSize}
url={first.image.url}

25
ts/components/conversation/message/message-content/MessageReactBar.tsx
Unescape Escape View File

@ -104,18 +104,21 @@ function formatTimeLeft({ timeLeftMs }: { timeLeftMs: number }) {
}
const parts = formatAbbreviatedExpireDoubleTimer(timeLeftSeconds);
if (parts.length === 2) {
return window.i18n('disappearingMessagesCountdownBigSmall', {
time_large: parts[0],
time_small: parts[1],
});
switch (parts.length) {
case 2:
return window.i18n('disappearingMessagesCountdownBigSmall', {
time_large: parts[0],
time_small: parts[1],
});
case 1:
return window.i18n('disappearingMessagesCountdownBig', {
time_large: parts[0],
});
default:
throw new Error('formatTimeLeft unexpected duration given');
}
if (parts.length === 1) {
return window.i18n('disappearingMessagesCountdownBig', {
time_large: parts[0],
});
}
throw new Error('formatTimeLeft unexpected duration given');
}
const ExpiresInItem = ({ expirationTimestamp }: { expirationTimestamp?: number | null }) => {

2
ts/components/conversation/message/message-content/quote/QuoteText.tsx
Unescape Escape View File

@ -75,7 +75,7 @@ export const QuoteText = (
return (
<StyledQuoteText isIncoming={isIncoming} dir="auto">
<MessageBody
text={text ?? window.i18n('messageErrorOriginal')}
text={text || window.i18n('messageErrorOriginal')}
disableLinks={true}
disableJumbomoji={true}
isGroup={isGroup}

2
ts/components/conversation/message/message-item/DataExtractionNotification.tsx
Unescape Escape View File

@ -21,7 +21,7 @@ export const DataExtractionNotification = (props: PropsForDataExtractionNotifica
? 'attachmentsMediaSaved'
: 'screenshotTaken'
}
args={{ name: name ?? source }}
args={{ name: name || source }}
/>
</NotificationBubble>
</ExpirableReadableMessage>

9
ts/components/conversation/message/reactions/ReactionPopup.tsx
Unescape Escape View File

@ -117,13 +117,8 @@ type Props = {
export const ReactionPopup = (props: Props) => {
const { emoji, senders, tooltipPosition = 'center', count, onClick } = props;
const { emojiName, emojiAriaLabel } = useMemo(
() => ({
emojiName: nativeEmojiData?.ids?.[emoji],
emojiAriaLabel: nativeEmojiData?.ariaLabels?.[emoji],
}),
[emoji]
);
const emojiName = nativeEmojiData?.ids?.[emoji];
const emojiAriaLabel = nativeEmojiData?.ariaLabels?.[emoji];
const { contacts, hasMe } = useMemo(() => generateContactsString(senders), [senders]);

10
ts/components/dialog/EnterPasswordModal.tsx
Unescape Escape View File

@ -39,7 +39,10 @@ export const EnterPasswordModal = (props: EnterPasswordModalProps) => {
try {
const passwordValue = passwordInputRef.current?.value;
if (!passwordValue) {
ToastUtils.pushToastError('enterPasswordErrorToast', window.i18n('passwordIncorrect'));
ToastUtils.pushToastError(
'enterPasswordErrorToast',
window.i18n.stripped('passwordIncorrect')
);
return;
}
@ -51,7 +54,10 @@ export const EnterPasswordModal = (props: EnterPasswordModalProps) => {
onPasswordVerified();
} catch (e) {
window.log.error('window.onTryPassword failed with', e);
ToastUtils.pushToastError('enterPasswordErrorToast', window.i18n('passwordIncorrect'));
ToastUtils.pushToastError(
'enterPasswordErrorToast',
window.i18n.stripped('passwordIncorrect')
);
}
});

2
ts/components/dialog/InviteContactsDialog.tsx
Unescape Escape View File

@ -148,7 +148,7 @@ const InviteContactsDialogInner = (props: Props) => {
return event.key === 'Esc' || event.key === 'Escape';
}, closeDialog);
const titleText = `${window.i18n('membersInvite')}`;
const titleText = window.i18n('membersInvite');
const cancelText = window.i18n('cancel');
const okText = window.i18n('okay');

8
ts/components/dialog/SessionSetPasswordDialog.tsx
Unescape Escape View File

@ -218,8 +218,8 @@ export class SessionSetPasswordDialog extends Component<Props, State> {
ToastUtils.pushToastSuccess(
'setPasswordSuccessToast',
window.i18n('passwordSet'),
window.i18n('passwordSetDescription')
window.i18n.stripped('passwordSet'),
window.i18n.stripped('passwordSetDescription')
);
this.props.onOk();
@ -271,7 +271,7 @@ export class SessionSetPasswordDialog extends Component<Props, State> {
ToastUtils.pushToastSuccess(
'setPasswordSuccessToast',
window.i18n('passwordChangedDescription')
window.i18n.stripped('passwordChangedDescription')
);
this.props.onOk();
@ -310,7 +310,7 @@ export class SessionSetPasswordDialog extends Component<Props, State> {
ToastUtils.pushToastWarning(
'setPasswordSuccessToast',
window.i18n('passwordRemovedDescription')
window.i18n.stripped('passwordRemovedDescription')
);
this.props.onOk();

2
ts/components/leftpane/overlay/OverlayClosedGroup.tsx
Unescape Escape View File

@ -67,7 +67,7 @@ async function createClosedGroupWithErrorHandling(
): Promise<boolean> {
// Validate groupName and groupMembers length
if (groupName.length === 0) {
ToastUtils.pushToastError('invalidGroupName', window.i18n('groupNameEnterPlease'));
ToastUtils.pushToastError('invalidGroupName', window.i18n.stripped('groupNameEnterPlease'));
onError(window.i18n('groupNameEnterPlease'));
return false;

7
ts/components/settings/SettingsThemeSwitcher.tsx
Unescape Escape View File

@ -12,6 +12,7 @@ import { switchThemeTo } from '../../themes/switchTheme';
import { SessionRadio, SessionRadioPrimaryColors } from '../basic/SessionRadio';
import { SpacerLG, SpacerMD } from '../basic/Text';
import { StyledDescriptionSettingsItem, StyledTitleSettingsItem } from './SessionSettingListItem';
import { Localizer } from '../basic/Localizer';
const StyledSwitcherContainer = styled.div`
font-size: var(--font-size-md);
@ -112,13 +113,15 @@ export const SettingsThemeSwitcher = () => {
return (
<StyledSwitcherContainer>
<StyledTitleSettingsItem>{window.i18n('appearanceThemes')}</StyledTitleSettingsItem>
<StyledTitleSettingsItem>
<Localizer token="appearanceThemes" />
</StyledTitleSettingsItem>
<ThemesContainer>
<Themes />
</ThemesContainer>
<SpacerMD />
<StyledDescriptionSettingsItem>
{window.i18n('appearancePrimaryColor')}
<Localizer token="appearancePrimaryColor" />
</StyledDescriptionSettingsItem>
<SpacerMD />
<ThemesContainer style={{ marginInlineStart: 'var(--margins-xs)' }}>

2
ts/mains/main_node.ts
Unescape Escape View File

@ -162,7 +162,7 @@ import { setLastestRelease } from '../node/latest_desktop_release';
import { isDevProd, isTestIntegration } from '../shared/env_vars';
import { classicDark } from '../themes';
import type { SetupI18nReturnType } from '../types/Localizer';
import { getTranslationDictionary } from '../util/i18n/translationDictionaries';
import { getTranslationDictionary } from '../util/i18n/shared';
import { getLocale, isLocaleSet, type Locale } from '../util/i18n/shared';
import { loadLocalizedDictionary } from '../node/locale';

2
ts/models/conversation.ts
Unescape Escape View File

@ -2053,7 +2053,7 @@ export class ConversationModel extends Backbone.Model<ConversationAttributes> {
const roomInfo = OpenGroupData.getV2OpenGroupRoom(groupUrl);
if (!roomInfo || !roomInfo.serverPublicKey) {
ToastUtils.pushToastError('no-sogs-matching', window.i18n('communityJoinError'));
ToastUtils.pushToastError('no-sogs-matching', window.i18n.stripped('communityJoinError'));
window?.log?.error('Could not find room with matching server url', groupUrl);
throw new Error(`Could not find room with matching server url: ${groupUrl}`);
}

21
ts/session/apis/open_group_api/opengroupV2/JoinOpenGroupV2.ts
Unescape Escape View File

@ -140,7 +140,10 @@ export async function joinOpenGroupV2WithUIEvents(
const parsedRoom = parseOpenGroupV2(completeUrl);
if (!parsedRoom) {
if (showToasts) {
ToastUtils.pushToastError('connectToServer', window.i18n('communityEnterUrlErrorInvalid'));
ToastUtils.pushToastError(
'connectToServer',
window.i18n.stripped('communityEnterUrlErrorInvalid')
);
}
if (errorHandler) {
errorHandler(window.i18n('communityEnterUrlErrorInvalid'));
@ -155,7 +158,10 @@ export async function joinOpenGroupV2WithUIEvents(
await existingConvo.setIsApproved(true, false);
await existingConvo.commit();
if (showToasts) {
ToastUtils.pushToastError('communityJoinedAlready', window.i18n('communityJoinedAlready'));
ToastUtils.pushToastError(
'communityJoinedAlready',
window.i18n.stripped('communityJoinedAlready')
);
}
if (errorHandler) {
errorHandler(window.i18n('communityJoinedAlready'));
@ -163,7 +169,7 @@ export async function joinOpenGroupV2WithUIEvents(
return false;
}
if (showToasts) {
ToastUtils.pushToastInfo('connectingToServer', window.i18n('callsConnecting'));
ToastUtils.pushToastInfo('connectingToServer', window.i18n.stripped('callsConnecting'));
}
uiCallback?.({ loadingState: 'started', conversationKey: conversationID });
@ -172,14 +178,17 @@ export async function joinOpenGroupV2WithUIEvents(
if (convoCreated) {
if (showToasts) {
ToastUtils.pushToastSuccess('connectToServerSuccess', window.i18n('communityJoined'));
ToastUtils.pushToastSuccess(
'connectToServerSuccess',
window.i18n.stripped('communityJoined')
);
}
uiCallback?.({ loadingState: 'finished', conversationKey: convoCreated?.id });
return true;
}
if (showToasts) {
ToastUtils.pushToastError('communityJoinError', window.i18n('communityJoinError'));
ToastUtils.pushToastError('communityJoinError', window.i18n.stripped('communityJoinError'));
}
if (errorHandler) {
errorHandler(window.i18n('communityJoinError'));
@ -189,7 +198,7 @@ export async function joinOpenGroupV2WithUIEvents(
} catch (error) {
window?.log?.warn('got error while joining open group:', error.message);
if (showToasts) {
ToastUtils.pushToastError('communityJoinError', window.i18n('communityJoinError'));
ToastUtils.pushToastError('communityJoinError', window.i18n.stripped('communityJoinError'));
}
if (errorHandler) {
errorHandler(window.i18n('communityJoinError'));

4
ts/test/session/unit/onboarding/Onboarding_test.ts
Unescape Escape View File

@ -10,7 +10,7 @@ import {
} from '../../../../util/accountManager';
import { TestUtils } from '../../../test-utils';
import { stubWindow } from '../../../test-utils/utils';
import { resetTranslationDictionary } from '../../../../util/i18n/translationDictionaries';
import { resetLocaleAndTranslationDict } from '../../../../util/i18n/shared';
describe('Onboarding', () => {
const polledDisplayName = 'Hello World';
@ -26,7 +26,7 @@ describe('Onboarding', () => {
});
afterEach(() => {
resetTranslationDictionary();
resetLocaleAndTranslationDict();
Sinon.restore();
});

4
ts/test/session/unit/selectors/conversations_test.ts
Unescape Escape View File

@ -8,7 +8,7 @@ import {
_getSortedConversations,
} from '../../../../state/selectors/conversations';
import { TestUtils } from '../../../test-utils';
import { resetTranslationDictionary } from '../../../../util/i18n/translationDictionaries';
import { resetLocaleAndTranslationDict } from '../../../../util/i18n/shared';
describe('state/selectors/conversations', () => {
beforeEach(() => {
@ -16,7 +16,7 @@ describe('state/selectors/conversations', () => {
TestUtils.stubI18n();
});
afterEach(() => {
resetTranslationDictionary();
resetLocaleAndTranslationDict();
Sinon.restore();
});
describe('#getSortedConversationsList', () => {

4
ts/test/session/unit/utils/i18n/formatMessageWithArgs_test.ts
Unescape Escape View File

@ -3,7 +3,7 @@
import { expect } from 'chai';
import { initI18n, testDictionary } from './util';
import { resetTranslationDictionary } from '../../../../../util/i18n/translationDictionaries';
import { resetLocaleAndTranslationDict } from '../../../../../util/i18n/shared';
describe('formatMessageWithArgs', () => {
let i18n;
@ -11,7 +11,7 @@ describe('formatMessageWithArgs', () => {
i18n = initI18n(testDictionary);
});
afterEach(() => {
resetTranslationDictionary();
resetLocaleAndTranslationDict();
});
it('returns the message with args for a message', () => {

4
ts/test/session/unit/utils/i18n/getMessage_test.ts
Unescape Escape View File

@ -3,7 +3,7 @@
import { expect } from 'chai';
import { initI18n, testDictionary } from './util';
import { resetTranslationDictionary } from '../../../../../util/i18n/translationDictionaries';
import { resetLocaleAndTranslationDict } from '../../../../../util/i18n/shared';
describe('getMessage', () => {
let i18n;
@ -12,7 +12,7 @@ describe('getMessage', () => {
});
afterEach(() => {
resetTranslationDictionary();
resetLocaleAndTranslationDict();
});
it('returns the message for a token', () => {

4
ts/test/session/unit/utils/i18n/getRawMessage_test.ts
Unescape Escape View File

@ -3,7 +3,7 @@
import { expect } from 'chai';
import { initI18n, testDictionary } from './util';
import { resetTranslationDictionary } from '../../../../../util/i18n/translationDictionaries';
import { resetLocaleAndTranslationDict } from '../../../../../util/i18n/shared';
describe('getRawMessage', () => {
let i18n;
@ -12,7 +12,7 @@ describe('getRawMessage', () => {
});
afterEach(() => {
resetTranslationDictionary();
resetLocaleAndTranslationDict();
});
it('returns the raw message for a token', () => {

4
ts/test/session/unit/utils/i18n/setupI18n_test.ts
Unescape Escape View File

@ -1,10 +1,10 @@
import { expect } from 'chai';
import { initI18n } from './util';
import { resetTranslationDictionary } from '../../../../../util/i18n/translationDictionaries';
import { resetLocaleAndTranslationDict } from '../../../../../util/i18n/shared';
describe('setupI18n', () => {
afterEach(() => {
resetTranslationDictionary();
resetLocaleAndTranslationDict();
});
it('returns setupI18n with all methods defined', () => {
const setupI18nReturn = initI18n();

4
ts/test/session/unit/utils/i18n/stripped_test.ts
Unescape Escape View File

@ -3,7 +3,7 @@
import { expect } from 'chai';
import { initI18n, testDictionary } from './util';
import { resetTranslationDictionary } from '../../../../../util/i18n/translationDictionaries';
import { resetLocaleAndTranslationDict } from '../../../../../util/i18n/shared';
describe('stripped', () => {
let i18n;
@ -11,7 +11,7 @@ describe('stripped', () => {
i18n = initI18n(testDictionary);
});
afterEach(() => {
resetTranslationDictionary();
resetLocaleAndTranslationDict();
});
it('returns the stripped message for a token', () => {

2
ts/types/Attachment.ts
Unescape Escape View File

@ -319,7 +319,7 @@ export const getSuggestedFilename = ({
return attachment.fileName;
}
const prefix = 'session-attachment';
const suffix = timestamp ? `-${format(new Date(timestamp), 'yyyy-MM-dd-HHmmss')}` : '';
const suffix = timestamp ? format(new Date(timestamp), '-yyyy-MM-dd-HHmmss') : '';
const fileType = getFileExtension(attachment);
const extension = fileType ? `.${fileType}` : '';
const indexSuffix = index ? `_${padStart(index.toString(), 3, '0')}` : '';

3
ts/updater/common.ts
Unescape Escape View File

@ -43,12 +43,11 @@ export async function showUpdateDialog(
): Promise<boolean> {
const RESTART_BUTTON = 0;
const LATER_BUTTON = 1;
const options = {
const options: Electron.MessageBoxOptions = {
type: 'info' as const,
buttons: [i18n('restart'), i18n('later')],
title: i18n('updateSession'),
message: i18n('updateDownloaded'),
detail: i18n('updateDownloaded'),
defaultId: LATER_BUTTON,
cancelId: RESTART_BUTTON,
};

19
ts/util/i18n/functions/getMessage.ts
Unescape Escape View File

@ -13,17 +13,6 @@ import { inEnglish } from './inEnglish';
import { stripped } from './stripped';
import { localizeFromOld, type StringArgsRecord } from '../localizedString';
// /**
// * Checks if a string contains a dynamic variable.
// * @param localizedString - The string to check.
// * @returns `true` if the string contains a dynamic variable, otherwise `false`.
// *
// * TODO: Change this to a proper type assertion when the type is fixed.
// */
// const isStringWithArgs = <R extends DictionaryWithoutPluralStrings[LocalizerToken]>(
// localizedString: string
// ): localizedString is R => localizedString.includes('{');
/**
* Retrieves a localized message string, substituting variables where necessary.
*
@ -46,14 +35,6 @@ function getMessageDefault<T extends LocalizerToken, R extends LocalizerDictiona
): R | T {
try {
return localizeFromOld<T>(token as T, args as StringArgsRecord<R>).toString() as T | R;
// const rawMessage = getRawMessage<T, R>(...([token, args] as GetMessageArgs<T>));
//
// /** If a localized string does not have any arguments to substitute it is returned with no changes. */
// if (!isStringWithArgs<R>(rawMessage)) {
// return rawMessage;
// }
//
// return formatMessageWithArgs<T, R>(rawMessage, args as ArgsRecord<T>);
} catch (error) {
i18nLog(error.message);
return token as R;

21
ts/util/i18n/functions/getRawMessage.ts
Unescape Escape View File

@ -8,32 +8,13 @@ import {
PluralKey,
PluralString,
} from '../../../types/Localizer';
import { getLocale, i18nLog } from '../shared';
import { getTranslationDictionary } from '../translationDictionaries';
import { getTranslationDictionary, getLocale, getStringForCardinalRule, i18nLog } from '../shared';
function getPluralKey<R extends PluralKey | undefined>(string: PluralString): R {
const match = /{(\w+), plural, one \[.+\] other \[.+\]}/g.exec(string);
return (match?.[1] ?? undefined) as R;
}
function getStringForCardinalRule(
localizedString: string,
cardinalRule: Intl.LDMLPluralRule
): string | undefined {
// TODO: investigate if this is the best way to handle regex like this
const cardinalPluralRegex: Record<Intl.LDMLPluralRule, RegExp> = {
zero: /zero \[(.*?)\]/g,
one: /one \[(.*?)\]/g,
two: /two \[(.*?)\]/g,
few: /few \[(.*?)\]/g,
many: /many \[(.*?)\]/g,
other: /other \[(.*?)\]/g,
};
const regex = cardinalPluralRegex[cardinalRule];
const match = regex.exec(localizedString);
return match?.[1] ?? undefined;
}
const isPluralForm = (localizedString: string): localizedString is PluralString =>
/{\w+, plural, one \[.+\] other \[.+\]}/g.test(localizedString);

4
ts/util/i18n/i18n.ts
Unescape Escape View File

@ -4,7 +4,6 @@ import { isEmpty } from 'lodash';
import { LocalizerDictionary, SetupI18nReturnType } from '../../types/Localizer';
import { getMessage } from './functions/getMessage';
import { i18nLog, Locale, setInitialLocale } from './shared';
import { setTranslationDictionary } from './translationDictionaries';
/**
* Sets up the i18n function with the provided locale and messages.
@ -30,8 +29,7 @@ export const setupI18n = ({
throw new Error('translationDictionary was not provided');
}
setTranslationDictionary(translationDictionary);
setInitialLocale(locale);
setInitialLocale(locale, translationDictionary);
i18nLog(`Setup Complete with locale: ${locale}`);

28
ts/util/i18n/localizedString.ts
Unescape Escape View File

@ -1,6 +1,10 @@
import { getFallbackDictionary, getTranslationDictionary } from './translationDictionaries';
import { en } from '../../localization/locales';
import { getLocale } from './shared';
import {
getLocale,
getStringForCardinalRule,
getFallbackDictionary,
getTranslationDictionary,
} from './shared';
import { LOCALE_DEFAULTS } from '../../localization/constants';
import { deSanitizeHtmlTags, sanitizeArgs } from '../../components/basic/Localizer';
import type { LocalizerDictionary } from '../../types/Localizer';
@ -12,8 +16,6 @@ type RawString = ArgString | string;
type PluralString = `{${PluralKey}, plural, one [${RawString}] other [${RawString}]}`;
// type LocalizedString = string;
type GenericLocalizedDictionary = Record<string, RawString | PluralString>;
type TokenString<Dict extends GenericLocalizedDictionary> = keyof Dict extends string
@ -92,24 +94,6 @@ function getPluralKey<R extends PluralKey>(string: PluralString): R {
return match?.[1] as R;
}
function getStringForCardinalRule(
localizedString: string,
cardinalRule: Intl.LDMLPluralRule
): string | undefined {
// TODO: investigate if this is the best way to handle regex like this
const cardinalPluralRegex: Record<Intl.LDMLPluralRule, RegExp> = {
zero: /zero \[(.*?)\]/g,
one: /one \[(.*?)\]/g,
two: /two \[(.*?)\]/g,
few: /few \[(.*?)\]/g,
many: /many \[(.*?)\]/g,
other: /other \[(.*?)\]/g,
};
const regex = cardinalPluralRegex[cardinalRule];
const match = regex.exec(localizedString);
return match?.[1] ?? undefined;
}
const isPluralForm = (localizedString: string): localizedString is PluralString =>
/{\w+, plural, one \[.+\] other \[.+\]}/g.test(localizedString);

52
ts/util/i18n/shared.ts
Unescape Escape View File

@ -1,8 +1,36 @@
import { en } from '../../localization/locales';
import type { LocalizerDictionary } from '../../types/Localizer';
import { timeLocaleMap } from './timeLocaleMap';
let mappedBrowserLocaleDisplayed = false;
let initialLocale: Locale | undefined;
let translationDictionary: LocalizerDictionary | undefined;
/**
* Only exported for testing, reset the dictionary to use for translations and the locale set
*/
export function resetLocaleAndTranslationDict() {
translationDictionary = undefined;
initialLocale = undefined;
}
/**
* Returns the current dictionary to use for translations.
*/
export function getTranslationDictionary(): LocalizerDictionary {
if (translationDictionary) {
return translationDictionary;
}
i18nLog('getTranslationDictionary: dictionary not init yet. Using en.');
return en;
}
export function getFallbackDictionary(): LocalizerDictionary {
return en;
}
/**
* Logs an i18n message to the console.
* @param message - The message to log.
@ -53,10 +81,32 @@ export function getBrowserLocale() {
return mappingTo;
}
export function setInitialLocale(locale: Locale) {
export function setInitialLocale(locale: Locale, dictionary: LocalizerDictionary) {
if (translationDictionary) {
throw new Error('setInitialLocale: translationDictionary or initialLocale is already init');
}
translationDictionary = dictionary;
initialLocale = locale;
}
export function isLocaleSet() {
return initialLocale !== undefined;
}
export function getStringForCardinalRule(
localizedString: string,
cardinalRule: Intl.LDMLPluralRule
): string | undefined {
// TODO: investigate if this is the best way to handle regex like this
const cardinalPluralRegex: Record<Intl.LDMLPluralRule, RegExp> = {
zero: /zero \[(.*?)\]/g,
one: /one \[(.*?)\]/g,
two: /two \[(.*?)\]/g,
few: /few \[(.*?)\]/g,
many: /many \[(.*?)\]/g,
other: /other \[(.*?)\]/g,
};
const regex = cardinalPluralRegex[cardinalRule];
const match = regex.exec(localizedString);
return match?.[1] ?? undefined;
}

35
ts/util/i18n/translationDictionaries.ts
Unescape Escape View File

@ -1,35 +0,0 @@
import { en } from '../../localization/locales';
import type { LocalizerDictionary } from '../../types/Localizer';
import { i18nLog } from './shared';
let translationDictionary: LocalizerDictionary | undefined;
export function setTranslationDictionary(dictionary: LocalizerDictionary) {
if (translationDictionary) {
throw new Error('translationDictionary is already init');
}
translationDictionary = dictionary;
}
/**
* Only exported for testing, reset the dictionary to use for translations.
*/
export function resetTranslationDictionary() {
translationDictionary = undefined;
}
/**
* Returns the current dictionary to use for translations.
*/
export function getTranslationDictionary(): LocalizerDictionary {
if (translationDictionary) {
return translationDictionary;
}
i18nLog('getTranslationDictionary: dictionary not init yet. Using en.');
return en;
}
export function getFallbackDictionary(): LocalizerDictionary {
return en;
}

48
yarn.lock
Unescape Escape View File

@ -47,7 +47,7 @@
dependencies:
regenerator-runtime "^0.13.2"
"@babel/runtime@^7.1.2", "@babel/runtime@^7.10.1", "@babel/runtime@^7.10.2", "@babel/runtime@^7.12.1", "@babel/runtime@^7.12.5", "@babel/runtime@^7.18.3", "@babel/runtime@^7.21.0", "@babel/runtime@^7.3.4", "@babel/runtime@^7.5.5", "@babel/runtime@^7.7.2", "@babel/runtime@^7.8.7", "@babel/runtime@^7.9.2":
"@babel/runtime@^7.1.2", "@babel/runtime@^7.10.1", "@babel/runtime@^7.10.2", "@babel/runtime@^7.12.1", "@babel/runtime@^7.12.5", "@babel/runtime@^7.18.3", "@babel/runtime@^7.3.4", "@babel/runtime@^7.5.5", "@babel/runtime@^7.7.2", "@babel/runtime@^7.8.7", "@babel/runtime@^7.9.2":
version "7.25.0"
resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.25.0.tgz#3af9a91c1b739c569d5d80cc917280919c544ecb"
integrity sha512-7dRy4DwXwtzBrPbZflqxnvfxLF8kdZXPkhymtDeFoFqE6ldzjQFgYTtYIFARcLEYDrqfBfYcZt1WqFxRoyC9Rw==
@ -2394,21 +2394,6 @@ concat-map@0.0.1:
resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
integrity sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==
concurrently@^8.2.2:
version "8.2.2"
resolved "https://registry.yarnpkg.com/concurrently/-/concurrently-8.2.2.tgz#353141985c198cfa5e4a3ef90082c336b5851784"
integrity sha512-1dP4gpXFhei8IOtlXRE/T/4H88ElHgTiUzh71YUmtjTEHMSRS2Z/fgOxHSxxusGHogsRfxNq1vyAwxSC+EVyDg==
dependencies:
chalk "^4.1.2"
date-fns "^2.30.0"
lodash "^4.17.21"
rxjs "^7.8.1"
shell-quote "^1.8.1"
spawn-command "0.0.2"
supports-color "^8.1.1"
tree-kill "^1.2.2"
yargs "^17.7.2"
config@1.28.1:
version "1.28.1"
resolved "https://registry.yarnpkg.com/config/-/config-1.28.1.tgz#7625d2a1e4c90f131d8a73347982d93c3873282d"
@ -2644,13 +2629,6 @@ data-view-byte-offset@^1.0.0:
es-errors "^1.3.0"
is-data-view "^1.0.1"
date-fns@^2.30.0:
version "2.30.0"
resolved "https://registry.yarnpkg.com/date-fns/-/date-fns-2.30.0.tgz#f367e644839ff57894ec6ac480de40cae4b0f4d0"
integrity sha512-fnULvOpxnC5/Vg3NCiWelDsLiUc9bRwAPs/+LfTLNvetFCtCTN+yQz15C/fs4AwX1R9K5GLtLfn8QW+dWisaAw==
dependencies:
"@babel/runtime" "^7.21.0"
date-fns@^3.6.0:
version "3.6.0"
resolved "https://registry.yarnpkg.com/date-fns/-/date-fns-3.6.0.tgz#f20ca4fe94f8b754951b24240676e8618c0206bf"
@ -6705,13 +6683,6 @@ run-script-os@^1.1.6:
resolved "https://registry.yarnpkg.com/run-script-os/-/run-script-os-1.1.6.tgz#8b0177fb1b54c99a670f95c7fdc54f18b9c72347"
integrity sha512-ql6P2LzhBTTDfzKts+Qo4H94VUKpxKDFz6QxxwaUZN0mwvi7L3lpOI7BqPCq7lgDh3XLl0dpeXwfcVIitlrYrw==
rxjs@^7.8.1:
version "7.8.1"
resolved "https://registry.yarnpkg.com/rxjs/-/rxjs-7.8.1.tgz#6f6f3d99ea8044291efd92e7c7fcf562c4057543"
integrity sha512-AA3TVj+0A2iuIoQkWEK/tqFjBq2j+6PO6Y0zJcvzLAFhEFIO3HL0vls9hWLncZbAAbK0mar7oZ4V079I/qPMxg==
dependencies:
tslib "^2.1.0"
safe-array-concat@^1.1.2:
version "1.1.2"
resolved "https://registry.yarnpkg.com/safe-array-concat/-/safe-array-concat-1.1.2.tgz#81d77ee0c4e8b863635227c721278dd524c20edb"
@ -6945,11 +6916,6 @@ shebang-regex@^3.0.0:
resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172"
integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==
shell-quote@^1.8.1:
version "1.8.1"
resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.8.1.tgz#6dbf4db75515ad5bac63b4f1894c3a154c766680"
integrity sha512-6j1W9l1iAs/4xYBI1SYOVZyFcCis9b4KCLQ8fgAGG07QvzaRLVVRQvAy85yNmmZSjYjg4MWh4gNvlPujU/5LpA==
side-channel@^1.0.4, side-channel@^1.0.6:
version "1.0.6"
resolved "https://registry.yarnpkg.com/side-channel/-/side-channel-1.0.6.tgz#abd25fb7cd24baf45466406b1096b7831c9215f2"
@ -7038,11 +7004,6 @@ source-map@^0.7.4:
resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.7.4.tgz#a9bbe705c9d8846f4e08ff6765acf0f1b0898656"
integrity sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA==
spawn-command@0.0.2:
version "0.0.2"
resolved "https://registry.yarnpkg.com/spawn-command/-/spawn-command-0.0.2.tgz#9544e1a43ca045f8531aac1a48cb29bdae62338e"
integrity sha512-zC8zGoGkmc8J9ndvml8Xksr1Amk9qBujgbF0JAIWO7kXr43w0h/0GJNM/Vustixu+YE8N/MTrQ7N31FvHUACxQ==
spdx-correct@^3.0.0:
version "3.2.0"
resolved "https://registry.yarnpkg.com/spdx-correct/-/spdx-correct-3.2.0.tgz#4f5ab0668f0059e34f9c00dce331784a12de4e9c"
@ -7272,7 +7233,7 @@ sumchecker@^3.0.1:
dependencies:
debug "^4.1.0"
supports-color@8.1.1, supports-color@^8.0.0, supports-color@^8.1.1:
supports-color@8.1.1, supports-color@^8.0.0:
version "8.1.1"
resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-8.1.1.tgz#cd6fc17e28500cff56c1b86c0a7fd4a54a73005c"
integrity sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==
@ -7439,11 +7400,6 @@ tr46@~0.0.3:
resolved "https://registry.yarnpkg.com/tr46/-/tr46-0.0.3.tgz#8184fd347dac9cdc185992f3a6622e14b9d9ab6a"
integrity sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==
tree-kill@^1.2.2:
version "1.2.2"
resolved "https://registry.yarnpkg.com/tree-kill/-/tree-kill-1.2.2.tgz#4ca09a9092c88b73a7cdc5e8a01b507b0790a0cc"
integrity sha512-L0Orpi8qGpRG//Nd+H90vFB+3iHnue1zSSGmNOOCh1GLJ7rUKVwV2HvijphGQS2UmhUZewS9VgvxYIdgr+fG1A==
trim-newlines@^3.0.0:
version "3.0.1"
resolved "https://registry.yarnpkg.com/trim-newlines/-/trim-newlines-3.0.1.tgz#260a5d962d8b752425b32f3a7db0dcacd176c144"

Write Preview
Loading…
Cancel
Save