Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 | import IntlMessageFormat from "intl-messageformat"; import get from "lodash/get"; import merge from "lodash/merge"; import { makeAutoObservable, runInAction } from "mobx"; // constants import { FALLBACK_LANGUAGE, SUPPORTED_LANGUAGES, LANGUAGE_STORAGE_KEY, ETranslationFiles } from "../constants"; // core translations imports import { enCore, locales } from "../locales"; // types import { TLanguage, ILanguageOption, ITranslations } from "../types"; /** * Mobx store class for handling translations and language changes in the application * Provides methods to translate keys with params and change the language * Uses IntlMessageFormat to format the translations */ export class TranslationStore { // Core translations that are always loaded private coreTranslations: ITranslations = { en: enCore, }; // List of translations for each language private translations: ITranslations = {}; // Cache for IntlMessageFormat instances private messageCache: Map<string, IntlMessageFormat> = new Map(); // Current language currentLocale: TLanguage = FALLBACK_LANGUAGE; // Loading state isLoading: boolean = true; isInitialized: boolean = false; // Set of loaded languages private loadedLanguages: Set<TLanguage> = new Set(); /** * Constructor for the TranslationStore class */ constructor() { makeAutoObservable(this); // Initialize with core translations immediately this.translations = this.coreTranslations; // Initialize language this.initializeLanguage(); // Load all the translations this.loadTranslations(); } /** Initializes the language based on the local storage or browser language */ private initializeLanguage() { if (typeof window === "undefined") return; const savedLocale = localStorage.getItem(LANGUAGE_STORAGE_KEY) as TLanguage; if (this.isValidLanguage(savedLocale)) { this.setLanguage(savedLocale); return; } // Fallback to default language this.setLanguage(FALLBACK_LANGUAGE); } /** Loads the translations for the current language */ private async loadTranslations(): Promise<void> { try { // Set initialized to true (Core translations are already loaded) runInAction(() => { this.isInitialized = true; }); // Load current and fallback languages in parallel await this.loadPrimaryLanguages(); // Load all remaining languages in parallel this.loadRemainingLanguages(); } catch (error) { console.error("Failed in translation initialization:", error); runInAction(() => { this.isLoading = false; }); } } private async loadPrimaryLanguages(): Promise<void> { try { // Load current and fallback languages in parallel const languagesToLoad = new Set<TLanguage>([this.currentLocale]); // Add fallback language only if different from current if (this.currentLocale !== FALLBACK_LANGUAGE) { languagesToLoad.add(FALLBACK_LANGUAGE); } // Load all primary languages in parallel const loadPromises = Array.from(languagesToLoad).map((lang) => this.loadLanguageTranslations(lang)); await Promise.all(loadPromises); // Update loading state runInAction(() => { this.isLoading = false; }); } catch (error) { console.error("Failed to load primary languages:", error); runInAction(() => { this.isLoading = false; }); } } private loadRemainingLanguages(): void { const remainingLanguages = SUPPORTED_LANGUAGES.map((lang) => lang.value).filter( (lang) => !this.loadedLanguages.has(lang as TLanguage) && lang !== this.currentLocale && lang !== FALLBACK_LANGUAGE ); // Load all remaining languages in parallel Promise.all(remainingLanguages.map((lang) => this.loadLanguageTranslations(lang as TLanguage))).catch((error) => { console.error("Failed to load some remaining languages:", error); }); } private async loadLanguageTranslations(language: TLanguage): Promise<void> { // Skip if already loaded if (this.loadedLanguages.has(language)) return; try { const translations = await this.importLanguageFile(language); runInAction(() => { // Use lodash merge for deep merging this.translations[language] = merge({}, this.coreTranslations[language] || {}, translations.default); // Add to loaded languages this.loadedLanguages.add(language); // Clear cache this.messageCache.clear(); }); } catch (error) { console.error(`Failed to load translations for ${language}:`, error); } } /** * Helper function to import and merge multiple translation files for a language * @param language - The language code * @param files - Array of file names to import (without .json extension) * @returns Promise that resolves to merged translations */ private async importAndMergeFiles(language: TLanguage, files: string[]) { try { const localeData = locales[language as keyof typeof locales]; if (!localeData) { throw new Error(`Locale data not found for language: ${language}`); } // Filter out files that don't exist for this language const availableFiles = files.filter((file) => { const fileKey = file as keyof typeof localeData; return fileKey in localeData; }); const importPromises = availableFiles.map((file) => { const fileKey = file as keyof typeof localeData; return localeData[fileKey](); }); const modules = await Promise.all(importPromises); const merged = modules.reduce((acc: any, module: any) => merge(acc, module.default), {}); return { default: merged }; } catch (error) { throw new Error(`Failed to import and merge files for ${language}: ${error}`); } } /** * Imports the translations for the given language * @param language - The language to import the translations for * @returns {Promise<any>} */ private async importLanguageFile(language: TLanguage) { const files = Object.values(ETranslationFiles); return this.importAndMergeFiles(language, files); } /** Checks if the language is valid based on the supported languages */ private isValidLanguage(lang: string | null): lang is TLanguage { return lang !== null && this.availableLanguages.some((l) => l.value === lang); } /** * Gets the cache key for the given key and locale * @param key - the key to get the cache key for * @param locale - the locale to get the cache key for * @returns the cache key for the given key and locale */ private getCacheKey(key: string, locale: TLanguage): string { return `${locale}:${key}`; } /** * Gets the IntlMessageFormat instance for the given key and locale * Returns cached instance if available */ private getMessageInstance(key: string, locale: TLanguage): IntlMessageFormat | null { const cacheKey = this.getCacheKey(key, locale); // Check if the cache already has the key if (this.messageCache.has(cacheKey)) { return this.messageCache.get(cacheKey) || null; } // Get the message from the translations const message = get(this.translations[locale], key); if (typeof message !== "string") return null; try { const formatter = new IntlMessageFormat(message, locale); this.messageCache.set(cacheKey, formatter); return formatter; } catch (error) { console.error(`Failed to create message formatter for key "${key}":`, error); return null; } } /** * Translates a key with params using the current locale * Falls back to the default language if the translation is not found * Returns the key itself if the translation is not found * @param key - The key to translate * @param params - The params to format the translation with * @returns The translated string */ t(key: string, params?: Record<string, unknown>): string { try { // Try current locale let formatter = this.getMessageInstance(key, this.currentLocale); // Fallback to default language if necessary if (!formatter && this.currentLocale !== FALLBACK_LANGUAGE) { formatter = this.getMessageInstance(key, FALLBACK_LANGUAGE); } // If we have a formatter, use it if (formatter) { return formatter.format(params || {}) as string; } // Last resort: return the key itself return key; } catch (error) { console.error(`Translation error for key "${key}":`, error); return key; } } /** * Sets the current language and updates the translations * @param lng - The new language */ async setLanguage(lng: TLanguage): Promise<void> { try { if (!this.isValidLanguage(lng)) { throw new Error(`Invalid language: ${lng}`); } // Safeguard in case background loading failed if (!this.loadedLanguages.has(lng)) { await this.loadLanguageTranslations(lng); } if (typeof window !== "undefined") { localStorage.setItem(LANGUAGE_STORAGE_KEY, lng); document.documentElement.lang = lng; } runInAction(() => { this.currentLocale = lng; this.messageCache.clear(); // Clear cache when language changes }); } catch (error) { console.error("Failed to set language:", error); } } /** * Gets the available language options for the dropdown * @returns An array of language options */ get availableLanguages(): ILanguageOption[] { return SUPPORTED_LANGUAGES; } } |