refactor: implement typescript

dcoa · dcoa · commit 4fb83f9213d7 · 2026-04-09T14:52:11.000+10:00
diff --git a/src/i18n/index.ts b/src/i18n/index.ts
diff --git a/src/i18n/languageApi.test.ts b/src/i18n/languageApi.test.ts
@@ -10,14 +10,14 @@ const LMS_BASE_URL = 'http://test.lms';
 describe('languageApi', () => {
   beforeEach(() => {
     jest.clearAllMocks();
-    getConfig.mockReturnValue({ LMS_BASE_URL });
-    getAuthenticatedUser.mockReturnValue({ username: 'testuser', userId: '123' });
+    (getConfig as jest.Mock).mockReturnValue({ LMS_BASE_URL });
+    (getAuthenticatedUser as jest.Mock).mockReturnValue({ username: 'testuser', userId: '123' });
   });
 
   describe('updateAuthenticatedUserPreferences', () => {
     it('should send a PATCH request with correct data', async () => {
       const patchMock = jest.fn().mockResolvedValue({});
-      getAuthenticatedHttpClient.mockReturnValue({ patch: patchMock });
+      (getAuthenticatedHttpClient as jest.Mock).mockReturnValue({ patch: patchMock });
 
       await updateAuthenticatedUserPreferences({ prefLang: 'es' });
 
@@ -30,8 +30,8 @@ describe('languageApi', () => {
 
     it('should return early if no authenticated user', async () => {
       const patchMock = jest.fn().mockResolvedValue({});
-      getAuthenticatedHttpClient.mockReturnValue({ patch: patchMock });
-      getAuthenticatedUser.mockReturnValue(null);
+      (getAuthenticatedHttpClient as jest.Mock).mockReturnValue({ patch: patchMock });
+      (getAuthenticatedUser as jest.Mock).mockReturnValue(null);
 
       await updateAuthenticatedUserPreferences({ prefLang: 'es' });
 
@@ -42,7 +42,7 @@ describe('languageApi', () => {
   describe('setSessionLanguage', () => {
     it('should send a POST request to setlang endpoint', async () => {
       const postMock = jest.fn().mockResolvedValue({});
-      getAuthenticatedHttpClient.mockReturnValue({ post: postMock });
+      (getAuthenticatedHttpClient as jest.Mock).mockReturnValue({ post: postMock });
 
       await setSessionLanguage('ar');
 
diff --git a/src/i18n/languageApi.ts b/src/i18n/languageApi.ts
@@ -2,18 +2,23 @@ import { getConfig } from '../config';
 import { getAuthenticatedHttpClient, getAuthenticatedUser } from '../auth';
 import { convertKeyNames, snakeCaseObject } from '../utils';
 
+interface PreferenceData {
+  prefLang: string;
+  [key: string]: string;
+}
+
 /**
  * Updates user language preferences via the preferences API.
  *
  * This function gets the authenticated user, converts preference data to snake_case
  * and formats specific keys according to backend requirements before sending the PATCH request.
  * If no user is authenticated, the function returns early without making the API call.
  *
- * @param {Object} preferenceData - The preference parameters to update (e.g., { prefLang: 'en' }).
+ * @param {PreferenceData} preferenceData - The preference parameters to update (e.g., { prefLang: 'en' }).
  * @returns {Promise} - A promise that resolves when the API call completes successfully,
  *                      or rejects if there's an error with the request. Returns early if no user is authenticated.
  */
-export async function updateAuthenticatedUserPreferences(preferenceData) {
+export async function updateAuthenticatedUserPreferences(preferenceData: PreferenceData): Promise<void> {
   const user = getAuthenticatedUser();
   if (!user) {
     return Promise.resolve();
@@ -37,12 +42,13 @@ export async function updateAuthenticatedUserPreferences(preferenceData) {
  * This function sends a POST request to the LMS setlang endpoint to change
  * the language for the current user session.
  *
- * @param {string} languageCode - The language code to set (e.g., 'en', 'es', 'ar').
- *                               Should be a valid ISO language code supported by the platform.
+ * @param {string} languageCode - The selected language locale code (e.g., 'en', 'es-419', 'ar', 'de-de').
+ *                                Should be a valid ISO language code supported by the platform. For reference:
+ *                                https://github.com/openedx/openedx-platform/blob/master/openedx/envs/common.py#L231
  * @returns {Promise} - A promise that resolves when the API call completes successfully,
  *                      or rejects if there's an error with the request.
  */
-export async function setSessionLanguage(languageCode) {
+export async function setSessionLanguage(languageCode: string): Promise<void> {
   const formData = new FormData();
   formData.append('language', languageCode);
 
diff --git a/src/i18n/languageManager.test.ts b/src/i18n/languageManager.test.ts
@@ -10,7 +10,7 @@ jest.mock('../pubSub');
 jest.mock('./languageApi');
 
 describe('languageManager', () => {
-  let mockReload;
+  let mockReload: jest.Mock;
 
   beforeEach(() => {
     jest.clearAllMocks();
@@ -22,8 +22,8 @@ describe('languageManager', () => {
       value: { reload: mockReload },
     });
 
-    updateAuthenticatedUserPreferences.mockResolvedValue({});
-    setSessionLanguage.mockResolvedValue({});
+    (updateAuthenticatedUserPreferences as jest.Mock).mockResolvedValue({});
+    (setSessionLanguage as jest.Mock).mockResolvedValue({});
   });
 
   describe('changeUserSessionLanguage', () => {
@@ -33,13 +33,13 @@ describe('languageManager', () => {
         prefLang: 'fr',
       });
       expect(setSessionLanguage).toHaveBeenCalledWith('fr');
-      expect(handleRtl).toHaveBeenCalledWith('fr');
+      expect(handleRtl).toHaveBeenCalled();
       expect(publish).toHaveBeenCalledWith(LOCALE_CHANGED, 'fr');
       expect(mockReload).not.toHaveBeenCalled();
     });
 
     it('should handle errors gracefully', async () => {
-      updateAuthenticatedUserPreferences.mockRejectedValue(new Error('fail'));
+      (updateAuthenticatedUserPreferences as jest.Mock).mockRejectedValue(new Error('fail'));
       await changeUserSessionLanguage('es', true);
       expect(logError).toHaveBeenCalled();
     });
diff --git a/src/i18n/languageManager.ts b/src/i18n/languageManager.ts
@@ -12,22 +12,23 @@ import { updateAuthenticatedUserPreferences, setSessionLanguage } from './langua
  * 3. Updates the session language through the setlang endpoint
  * 4. Publishes a locale change event to notify other parts of the application
  *
- * @param {string} languageCode - The selected language locale code (e.g., 'en', 'es', 'ar').
- *                               Should be a valid ISO language code supported by the platform.
+ * @param {string} languageCode - The selected language locale code (e.g., 'en', 'es-419', 'ar', 'de-de').
+ *                                Should be a valid ISO language code supported by the platform. For reference:
+ *                                https://github.com/openedx/openedx-platform/blob/master/openedx/envs/common.py#L231
  * @param {boolean} [forceReload=false] - Whether to force a page reload after changing the language.
  * @returns {Promise} - A promise that resolves when all operations complete.
  *
  */
 export async function changeUserSessionLanguage(
-  languageCode,
-  forceReload = false,
-) {
+  languageCode: string,
+  forceReload: boolean = false,
+): Promise<void> {
   try {
     await updateAuthenticatedUserPreferences({ prefLang: languageCode });
     await setSessionLanguage(languageCode);
-    handleRtl(languageCode);
+    handleRtl();
     publish(LOCALE_CHANGED, languageCode);
-  } catch (error) {
+  } catch (error: any) {
     logError(error);
   }
 
diff --git a/src/i18n/lib.test.ts b/src/i18n/lib.test.ts
@@ -15,15 +15,15 @@ jest.mock('universal-cookie');
 
 describe('lib', () => {
   describe('configure', () => {
-    let originalWarn = null;
+    let originalWarn: typeof console.warn | null = null;
 
     beforeEach(() => {
       originalWarn = console.warn;
       console.warn = jest.fn();
     });
 
     afterEach(() => {
-      console.warn = originalWarn;
+      console.warn = originalWarn!;
     });
 
     it('should not call console.warn in production', () => {
@@ -177,11 +177,11 @@ describe('lib', () => {
     });
 
     it('should return the messages for the provided locale', () => {
-      expect(getMessages('en-us').message).toEqual('en-us-hah');
+      expect(getMessages('en-us')!.message).toEqual('en-us-hah');
     });
 
     it('should return the messages for the preferred locale if no argument is passed', () => {
-      expect(getMessages().message).toEqual('es-hah');
+      expect(getMessages()!.message).toEqual('es-hah');
     });
   });
 
@@ -231,15 +231,15 @@ describe('lib', () => {
   });
 
   describe('handleRtl', () => {
-    let setAttribute;
+    let setAttribute: jest.Mock;
     beforeEach(() => {
       setAttribute = jest.fn();
 
       global.document.getElementsByTagName = jest.fn(() => [
         {
           setAttribute,
         },
-      ]);
+      ]) as any;
     });
 
     it('should do the right thing for non-RTL languages', () => {
@@ -310,7 +310,7 @@ describe('mergeMessages', () => {
         ar: { message: 'ar-hah' },
       },
     });
-    const result = mergeMessages([{ foo: 'bar' }, { buh: 'baz' }, { gah: 'wut' }]);
+    const result = mergeMessages([{ foo: 'bar' }, { buh: 'baz' }, { gah: 'wut' }] as any);
     expect(result).toEqual({
       ar: { message: 'ar-hah' },
       foo: 'bar',
@@ -331,7 +331,7 @@ describe('mergeMessages', () => {
         es: { init: 'inicial' },
       },
     });
-    const messages = [
+    const msgs: import('./lib').I18nMessages[] = [
       {
         en: { hello: 'hello' },
         es: { hello: 'hola' },
@@ -342,7 +342,7 @@ describe('mergeMessages', () => {
       },
     ];
 
-    const result = mergeMessages(messages);
+    const result = mergeMessages(msgs);
     expect(result).toEqual({
       en: {
         init: 'initial',
diff --git a/src/i18n/lib.ts b/src/i18n/lib.ts
