MOBILE-4901 lang: Sort deprecated code and improve types

Author: crazyserver

src/core/features/siteplugins/services/siteplugins.ts

@@ -19,7 +19,7 @@ import { CoreSite } from '@classes/sites/site';
 import { CoreCourseAnyModuleData } from '@features/course/services/course';
 import { CoreCourses } from '@features/courses/services/courses';
 import { CoreFilepool } from '@services/filepool';
-import { CoreLang, CoreLangFormat } from '@services/lang';
+import { CoreLang, CoreLangFormat, CoreLangTranslationByLanguage } from '@services/lang';
 import { CoreSites } from '@services/sites';
 import { CoreText } from '@singletons/text';
 import { CoreUtils } from '@singletons/utils';
@@ -812,7 +812,7 @@ export type CoreSitePluginsWSPlugin = {
  */
 export type CoreSitePluginsPlugin = CoreSitePluginsWSPlugin & {
     parsedHandlers?: Record<string, CoreSitePluginsHandlerData> | null;
-    parsedLang?: Record<string, string[]> | null;
+    parsedLang?: CoreLangTranslationByLanguage | null;
 };
 
 /**

src/core/services/lang.ts

@@ -37,11 +37,7 @@ export class CoreLangProvider {
     protected defaultLanguage = CoreConstants.CONFIG.default_lang || 'en'; // Lang to use if device lang not valid or is forced.
     protected currentLanguage?: string; // Save current language in a variable to speed up the get function.
     protected customStringsRaw?: string;
-    protected logger: CoreLogger;
-
-    constructor() {
-        this.logger = CoreLogger.getInstance('CoreLang');
-    }
+    protected logger: CoreLogger = CoreLogger.getInstance('CoreLang');
 
     async initialize(): Promise<void> {
         // Set fallback language and language to use until the app determines the right language to use.
@@ -78,12 +74,36 @@ export class CoreLangProvider {
     }
 
     /**
-     * Add a set of site plugins strings for a certain language.
+     * Add a set of site plugins strings in a certain language.
+     *
+     * @param lang Language to add the strings to.
+     * @param strings Strings to add.
+     * @param prefix A prefix to add to all keys.
+     * @deprecated since 5.2. Use the overload accepting langStrings object.
+     */
+    async addSitePluginsStrings(lang: string, strings: CoreLangTranslationObject, prefix?: string): Promise<void>;
+    /**
+     * Add a set of site plugins strings.
      *
      * @param langStrings Object with the strings to add in every language.
      * @param prefix A prefix to add to all keys.
      */
-    async addSitePluginsStrings(langStrings: Record<string, string[]>, prefix?: string): Promise<void> {
+    async addSitePluginsStrings(langStrings: CoreLangTranslationByLanguage, prefix?: string): Promise<void>;
+    async addSitePluginsStrings(
+        langStringsOrLang: string | CoreLangTranslationByLanguage,
+        stringsOrPrefix?:  CoreLangTranslationObject | string,
+        prefix?: string,
+    ): Promise<void> {
+        if (typeof langStringsOrLang === 'string') {
+            const lang = langStringsOrLang;
+            const strings = stringsOrPrefix as CoreLangTranslationObject;
+            await this.addSitePluginsStrings({ [lang]: strings }, prefix);
+
+            return;
+        }
+        const langStrings = langStringsOrLang;
+        prefix = stringsOrPrefix as string ?? '';
+
         const loadedStrings: { [lang: string]: TranslationObject } = {};
 
         for (let lang in langStrings) {
@@ -130,7 +150,7 @@ export class CoreLangProvider {
      * @returns Message if found, null otherwise.
      */
     async getMessage(key: string, lang: string): Promise<string | undefined>  {
-        const messages = await this.getTranslationTable(lang);
+        const messages = await this.getMessages(lang);
 
         return messages[key] as string | undefined;
     }
@@ -143,7 +163,16 @@ export class CoreLangProvider {
      * @returns Messages.
      */
     async getMessages(lang: string, keyPrefix = ''): Promise<TranslationObject> {
-        const table = this.getTranslationTable(lang);
+        // Create a promise to convert the observable into a promise.
+        const promise = new Promise<TranslationObject>((resolve, reject): void => {
+            CoreSubscriptions.once(
+                Translate.currentLoader.getTranslation(lang),
+                (table) => resolve(table),
+                reject,
+            );
+        });
+
+        const table = await promise;
 
         if (!keyPrefix) {
             return table;
@@ -277,7 +306,7 @@ export class CoreLangProvider {
      * @returns Custom strings.
      * @deprecated since 5.2. Not used anymore.
      */
-    getAllCustomStrings(): CoreLanguageObject {
+    getAllCustomStrings(): unknown {
         return {};
     }
 
@@ -287,7 +316,7 @@ export class CoreLangProvider {
      * @returns Site plugins strings.
      * @deprecated since 5.2. Not used anymore.
      */
-    getAllSitePluginsStrings(): CoreLanguageObject {
+    getAllSitePluginsStrings(): unknown {
         return {};
     }
 
@@ -428,16 +457,11 @@ export class CoreLangProvider {
      *
      * @param lang The language to check.
      * @returns Promise resolved when done.
+     *
+     * @deprecated since 5.2. Use getMessages instead.
      */
     getTranslationTable(lang: string): Promise<TranslationObject> {
-        // Create a promise to convert the observable into a promise.
-        return new Promise((resolve, reject): void => {
-            CoreSubscriptions.once(
-                Translate.currentLoader.getTranslation(lang),
-                (table) => resolve(table),
-                reject,
-            );
-        });
+        return this.getMessages(lang);
     }
 
     /**
@@ -518,10 +542,10 @@ export class CoreLangProvider {
      *
      * @param lang Language code.
      * @returns Promise resolved with the file contents.
-     * @deprecated since 5.0. Use getTranslationTable instead.
+     * @deprecated since 5.0. Use getMessages instead.
      */
     async readLangFile(lang: CoreLangLanguage): Promise<TranslationObject> {
-        return this.getTranslationTable(lang);
+        return this.getMessages(lang);
     }
 
     /**
@@ -547,7 +571,8 @@ export class CoreLangProvider {
      * @returns Whether the translation table was modified.
      * @deprecated since 5.2. Not used anymore.
      */
-    async loadLangStrings(langObject: CoreLanguageObject, lang: string): Promise<boolean> {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async loadLangStrings(langObject: unknown, lang: string): Promise<boolean> {
         return false;
     }
 
@@ -565,13 +590,5 @@ export const enum CoreLangFormat {
  */
 export type CoreLangLanguage = string;
 
-/**
- * Language object has two leves, first per language and second per string key.
- */
-type CoreLanguageObject = {
-    [lang: string]: { // Lang name.
-        [key: string]: { // String key.
-            value: string; // Value with replacings done.
-        };
-    };
-};
+export type CoreLangTranslationObject = Record<string, string>;
+export type CoreLangTranslationByLanguage = { [lang: string]: CoreLangTranslationObject };