feat: support manifest translations (DHIS2-19443) (backport v42) (#3084)

* fix(translations): sync translations from transifex (master) (#3078)

* fix(translations): sync translations from transifex (master)

* fix(translations): sync translations from transifex (master)

* fix(translations): sync translations from transifex (master)

* fix(translations): sync translations from transifex (master)

* fix(translations): sync translations from transifex (master)

* fix(translations): sync translations from transifex (master)

* fix(translations): sync translations from transifex (master)

* fix(translations): sync translations from transifex (master)

* chore: support manifest translations (DHIS2-19443) (#3073)

* chore: support manifest translations

* refactor: update format of manifest translations file

---------

Co-authored-by: @dhis2-bot <apps@dhis2.org>

Author: kabaros

package.json

@@ -17,7 +17,7 @@
         "build": "npm test && NODE_ENV=production webpack --progress && npm run manifest",
         "postbuild": "cp -r src/i18n icon.png package.json ./build/ && yarn copy-ckeditor",
         "validate": "npm ls --depth 0",
-        "manifest": "d2-manifest package.json build/manifest.webapp",
+        "manifest": "d2-manifest package.json build/manifest.webapp && node ./scripts/generate-manifest-translations.js",
         "lint": "eslint ./src",
         "profile": "npm run start -- --profile",
         "copy-ckeditor": "mkdir ./build/vendor && cp -r ./node_modules/ckeditor ./build/vendor",
@@ -69,6 +69,7 @@
         "node-sass": "npm:sass@^1.58.0",
         "precommit-hook": "^3.0.0",
         "prettier": "^1.13.7",
+        "properties-file": "^3.5.12",
         "recompose": "^0.23.1",
         "redux-logger": "^3.0.6",
         "sass-loader": "^6.0.5",

scripts/generate-manifest-translations.js

@@ -0,0 +1,91 @@
+/**
+ * This is a script used as part of the build process to generate manifest translations
+ *
+ * This script is specific to the maintenance app - other apps that use the platform tools have this support
+ * through @dhis2/cli-app-scripts (and i18next under the hood) - so this script adapts to the specifics of the maintenance app
+ * in order to support translations for shortcuts.
+ *
+ * In general, it performs three steps:
+ * 
+ * 1. It reads the i18n_module_en.properties which is the source of truth for translation keys (not "en.pot")
+ * 2. It looks for keys that start with MANIFEST_ prefix (this is an internal convention)
+ * 3. It generates manifest.webapp.translations.json file in the format expected by the backend
+ *
+ */
+const { readFileSync, readdirSync, writeFileSync } = require('node:fs');
+const { getProperties } = require('properties-file');
+
+try {
+    const SOURCE_DIR = 'src/i18n';
+
+    console.debug('---- generating manifest translations');
+
+    // i18n_module_en.properties is our template file (equivalent to .pot)
+    // we use it to find the manifest keys that should be translated
+    const keyToMatch = /^MANIFEST_/;
+    const baseLanguageProperties = getProperties(readFileSync(`${SOURCE_DIR}/i18n_module_en.properties`))
+    const shortcutKeys = Object.keys(
+        baseLanguageProperties
+    ).filter(key => {
+        return keyToMatch.exec(key);
+    });
+    console.debug(`${shortcutKeys.length} keys with MANIFEST_ prefix found.`);
+
+    // Finding all the .properties file for all languages
+    const propsFiles = readdirSync(SOURCE_DIR).filter(fn =>
+        fn.endsWith('.properties')
+    );
+
+    console.debug(`${propsFiles.length} .properties files found.`);
+
+    const keyMap = {
+        "APP_TITLE": "title",
+        "APP_DESCRIPTION": "description"
+    }
+    const result = propsFiles.map(file => {
+        // read the properties file using getProperties library
+        const properties = getProperties(readFileSync('src/i18n/' + file));
+        const locale = file
+            .replace(/^i18n_module_/, '')
+            .replace('.properties', '');
+        const foundTranslations = Object.entries(properties).filter(
+            ([key, value]) => {
+                return shortcutKeys.includes(key);
+            }
+        );
+        // change the translations to the format expected by the backend
+        const translations = foundTranslations.reduce((prev, curr) => {
+            const [key, value] = curr
+
+            // For shortcuts, the key should be in the format of SHORTCUT_NAME_VALUE where NAME_VALUE is the "name" property for a shortcut in d2.config or manifest.webapp
+            // the java .properties file do not use spaces for the keys (unlike pot files) so we're getting that value manually here instead of relying on the key as we do in app-platform
+            let keyToUse = baseLanguageProperties[key]
+            
+            let cleaned_key = key?.replace(/MANIFEST_/, '')
+
+            if(cleaned_key.startsWith('SHORTCUT')) {
+                prev.shortcuts[keyToUse] = value
+            } else if (cleaned_key.startsWith('APP')) {
+                prev[keyMap[cleaned_key]] = value
+            }
+            
+            return prev;
+        }, {shortcuts: {}});
+
+        return {
+            locale,
+            ...translations,
+        };
+    });
+
+    writeFileSync(
+        './build/manifest.webapp.translations.json',
+        JSON.stringify(result, null, 2)
+    );
+    console.log(
+        `---- generated "./build/manifest.webapp.translations.json" file`
+    );
+} catch (err) {
+    console.error('Generating the manifest.webapp translations failed.');
+    console.error(err);
+}

src/i18n/i18n_module_ar.properties

@@ -2396,3 +2396,54 @@ ownership=Ownership
 validation_result=\u0646\u062a\u064a\u062c\u0629 \u0627\u0644\u062a\u062d\u0642\u0642
 sql=SQL
 categories_cannot_be_empty=Categories cannot be empty
+
+# Translations for shortcuts and app title in the manifest file
+MANIFEST_APP_TITLE=\u062a\u0637\u0628\u064a\u0642 \u0627\u0644\u0635\u064a\u0627\u0646\u0629
+MANIFEST_APP_DESCRIPTION=DHIS2 Maintenance app
+MANIFEST_SHORTCUT_Categories=\u0627\u0644\u0641\u0626\u0627\u062a
+MANIFEST_SHORTCUT_Category_options=\u062e\u064a\u0627\u0631\u0627\u062a \u0627\u0644\u0641\u0626\u0629
+MANIFEST_SHORTCUT_Category_combinations=Category combinations
+MANIFEST_SHORTCUT_Category_option_combinations=Category option combinations
+MANIFEST_SHORTCUT_Category_option_groups=Category option groups
+MANIFEST_SHORTCUT_Category_option_group_sets=Category option group sets
+MANIFEST_SHORTCUT_Data_elements=\u0639\u0646\u0627\u0635\u0631 \u0627\u0644\u0628\u064a\u0627\u0646\u0627\u062a
+MANIFEST_SHORTCUT_Data_element_groups_=\u0645\u062c\u0645\u0648\u0639\u0627\u062a \u0639\u0646\u0627\u0635\u0631 \u0627\u0644\u0628\u064a\u0627\u0646\u0627\u062a
+MANIFEST_SHORTCUT_Data_element_group_sets=Data element group sets
+MANIFEST_SHORTCUT_Data_sets=\u062d\u0632\u0645 \u0627\u0644\u0628\u064a\u0627\u0646\u0627\u062a
+MANIFEST_SHORTCUT_Data_set_notifications=\u0625\u0634\u0639\u0627\u0631\u0627\u062a \u062d\u0632\u0645\u0629 \u0627\u0644\u0628\u064a\u0627\u0646\u0627\u062a
+MANIFEST_SHORTCUT_Indicators=\u0627\u0644\u0645\u0624\u0634\u0631\u0627\u062a
+MANIFEST_SHORTCUT_Indicator_types=\u0623\u0646\u0648\u0627\u0639 \u0627\u0644\u0645\u0624\u0634\u0631\u0627\u062a
+MANIFEST_SHORTCUT_Indicator_groups=\u0645\u062c\u0645\u0648\u0639\u0627\u062a \u0627\u0644\u0645\u0624\u0634\u0631\u0627\u062a
+MANIFEST_SHORTCUT_Indicator_group_sets=Indicator group sets
+MANIFEST_SHORTCUT_Program_indicators=\u0645\u0624\u0634\u0631\u0627\u062a \u0627\u0644\u0628\u0631\u0646\u0627\u0645\u062c
+MANIFEST_SHORTCUT_Program_indicator_groups=Program indicator groups
+MANIFEST_SHORTCUT_Organisation_units=\u0627\u0644\u0648\u062d\u062f\u0627\u062a \u0627\u0644\u062a\u0646\u0638\u064a\u0645\u064a\u0629
+MANIFEST_SHORTCUT_Organisaiton_unit_groups=Organisaiton unit groups
+MANIFEST_SHORTCUT_Organisation_unit_group_sets=Organisation unit group sets
+MANIFEST_SHORTCUT_Organisation_unit_levels=\u0645\u0633\u062a\u0648\u064a\u0627\u062a \u0627\u0644\u0648\u062d\u062f\u0629 \u0627\u0644\u062a\u0646\u0638\u064a\u0645\u064a\u0629
+MANIFEST_SHORTCUT_Hierarchy_operations=\u0639\u0645\u0644\u064a\u0627\u062a \u0627\u0644\u062a\u0633\u0644\u0633\u0644 \u0627\u0644\u0647\u0631\u0645\u064a
+MANIFEST_SHORTCUT_Programs=\u0627\u0644\u0628\u0631\u0627\u0645\u062c
+MANIFEST_SHORTCUT_Tracked_entity_attributes=Tracked entity attributes
+MANIFEST_SHORTCUT_Relationship_types=\u0623\u0646\u0648\u0627\u0639 \u0627\u0644\u0639\u0644\u0627\u0642\u0627\u062a
+MANIFEST_SHORTCUT_Tracked_entity_types=\u0623\u0646\u0648\u0627\u0639 \u0627\u0644\u0643\u064a\u0627\u0646\u0627\u062a \u0627\u0644\u0645\u062a\u0639\u0642\u0628\u0629
+MANIFEST_SHORTCUT_Program_rules=Program rules
+MANIFEST_SHORTCUT_Program_rule_variables=Program rule variables
+MANIFEST_SHORTCUT_Validation_rules=\u0642\u0648\u0627\u0639\u062f \u0627\u0644\u062a\u062d\u0642\u0642
+MANIFEST_SHORTCUT_Validation_rule_groups=Validation rule groups
+MANIFEST_SHORTCUT_Validation_notifications=Validation notifications
+MANIFEST_SHORTCUT_Constants=\u0627\u0644\u062b\u0648\u0627\u0628\u062a
+MANIFEST_SHORTCUT_Attributes=\u0627\u0644\u0633\u0645\u0627\u062a
+MANIFEST_SHORTCUT_Option_sets=Option sets
+MANIFEST_SHORTCUT_Option_groups=Option groups
+MANIFEST_SHORTCUT_Option_group_sets=Option group sets
+MANIFEST_SHORTCUT_Legends=\u0645\u0641\u0627\u062a\u064a\u062d \u0625\u064a\u0636\u0627\u062d\u064a\u0629
+MANIFEST_SHORTCUT_Predictors=Predictors
+MANIFEST_SHORTCUT_Predictor_groups=Predictor groups
+MANIFEST_SHORTCUT_Push_analysis=\u062a\u062d\u0644\u064a\u0644 \u0627\u0644\u062f\u0641\u0639
+MANIFEST_SHORTCUT_External_map_layers=\u0637\u0628\u0642\u0627\u062a \u062e\u0631\u064a\u0637\u0629 \u062e\u0627\u0631\u062c\u064a\u0629
+MANIFEST_SHORTCUT_Data_approval_levels=\u0645\u0633\u062a\u0648\u064a\u0627\u062a \u0627\u0644\u0645\u0648\u0627\u0641\u0642\u0629 \u0639\u0644\u0649 \u0627\u0644\u0628\u064a\u0627\u0646\u0627\u062a
+MANIFEST_SHORTCUT_Data_approval_workflows=\u0633\u064a\u0631 \u0639\u0645\u0644 \u0627\u0644\u0645\u0648\u0627\u0641\u0642\u0629 \u0639\u0644\u0649 \u0627\u0644\u0628\u064a\u0627\u0646\u0627\u062a
+MANIFEST_SHORTCUT_Locales=\u0644\u063a\u0627\u062a
+MANIFEST_SHORTCUT_SQL_views=SQL views
+MANIFEST_SHORTCUT_Icons=Icons
+MANIFEST_SHORTCUT_Analytics_table_hooks=Analytics table hooks

src/i18n/i18n_module_ar_IQ.properties

@@ -2082,7 +2082,7 @@ failed_to_save_organisation_unit=Failed to save organisation unit
 last_average_org_unit=\u0627\u0644\u0642\u064a\u0645\u0629 \u0627\u0644\u0623\u062e\u064a\u0631\u0629 (\u0627\u0644\u0645\u062a\u0648\u0633\u0637 \u0641\u064a \u0627\u0644\u062a\u0633\u0644\u0633\u0644 \u0627\u0644\u0647\u0631\u0645\u064a \u0644\u0644\u0648\u062d\u062f\u0629 \u0627\u0644\u062a\u0646\u0638\u064a\u0645\u064a\u0629)
 last=Last value (sum in org unit hierarchy)
 first=First value (sum in org unit hierarchy)
-first_average_org_unit=First value (averge in org unit hierarchy)
+first_average_org_unit=First value (average in org unit hierarchy)
 last_in_period=Last value in period (sum in org unit hierarchy)
 last_in_period_average_org_unit=Last value in period (average in org unit hierarchy)
 last_last_org_unit=Last value in period (last value in org unit hierarchy)
@@ -2377,17 +2377,17 @@ skip_in_analytics=Skip in analytics
 analytics_table_hook=Analytics table hooks
 intro_analytics_table_hook=Configure hooks in SQL that run during the analytics process
 analytics_table_hook_management=Analytics table hooks management
-phase=Phase that the SQL script should be invoked
-resource_table_populated=After the temporary resource tables have been populated
-analytics_table_populated=After the temporary analytics tables have been populated
-resource_table_type=Resource table
+phase=After population of which temporary tables should the SQL script be invoked?
+resource_table_populated=Resource tables
+analytics_table_populated=Analytics tables
+resource_table_type=Which resource table
 org_unit_structure=Organisation unit structure
 data_set_org_unit_category=Data set organisation unit category
 category_option_combo_name=Category option combo name
 org_unit_group_set_structure=Organisation unit group set structure
 data_approval_remap_level=Data approval remap level
 data_approval_min_level=Data approval minimum level
-analytics_table_type=Analytics table
+analytics_table_type=Which analytics table
 data_value=Data value
 completeness=Completeness
 completeness_target=Completeness target
@@ -2396,3 +2396,54 @@ ownership=Ownership
 validation_result=Validation result
 sql=SQL
 categories_cannot_be_empty=Categories cannot be empty
+
+# Translations for shortcuts and app title in the manifest file
+MANIFEST_APP_TITLE=Maintenance app
+MANIFEST_APP_DESCRIPTION=DHIS2 Maintenance app
+MANIFEST_SHORTCUT_Categories=\u0627\u0644\u0641\u0626\u0627\u062a
+MANIFEST_SHORTCUT_Category_options=Category options
+MANIFEST_SHORTCUT_Category_combinations=Category combinations
+MANIFEST_SHORTCUT_Category_option_combinations=Category option combinations
+MANIFEST_SHORTCUT_Category_option_groups=Category option groups
+MANIFEST_SHORTCUT_Category_option_group_sets=Category option group sets
+MANIFEST_SHORTCUT_Data_elements=\u0639\u0646\u0627\u0635\u0631 \u0627\u0644\u0628\u064a\u0627\u0646\u0627\u062a
+MANIFEST_SHORTCUT_Data_element_groups_=Data element groups
+MANIFEST_SHORTCUT_Data_element_group_sets=Data element group sets
+MANIFEST_SHORTCUT_Data_sets=\u062d\u0632\u0645 \u0627\u0644\u0628\u064a\u0627\u0646\u0627\u062a
+MANIFEST_SHORTCUT_Data_set_notifications=Data set notifications
+MANIFEST_SHORTCUT_Indicators=\u0627\u0644\u0645\u0624\u0634\u0631\u0627\u062a
+MANIFEST_SHORTCUT_Indicator_types=Indicator types
+MANIFEST_SHORTCUT_Indicator_groups=Indicator groups
+MANIFEST_SHORTCUT_Indicator_group_sets=Indicator group sets
+MANIFEST_SHORTCUT_Program_indicators=Program indicators
+MANIFEST_SHORTCUT_Program_indicator_groups=Program indicator groups
+MANIFEST_SHORTCUT_Organisation_units=\u0627\u0644\u0648\u062d\u062f\u0627\u062a \u0627\u0644\u062a\u0646\u0638\u064a\u0645\u064a\u0629
+MANIFEST_SHORTCUT_Organisaiton_unit_groups=Organisaiton unit groups
+MANIFEST_SHORTCUT_Organisation_unit_group_sets=Organisation unit group sets
+MANIFEST_SHORTCUT_Organisation_unit_levels=Organisation unit levels
+MANIFEST_SHORTCUT_Hierarchy_operations=Hierarchy operations
+MANIFEST_SHORTCUT_Programs=Programs
+MANIFEST_SHORTCUT_Tracked_entity_attributes=Tracked entity attributes
+MANIFEST_SHORTCUT_Relationship_types=Relationship types
+MANIFEST_SHORTCUT_Tracked_entity_types=Tracked entity types
+MANIFEST_SHORTCUT_Program_rules=Program rules
+MANIFEST_SHORTCUT_Program_rule_variables=Program rule variables
+MANIFEST_SHORTCUT_Validation_rules=Validation rules
+MANIFEST_SHORTCUT_Validation_rule_groups=Validation rule groups
+MANIFEST_SHORTCUT_Validation_notifications=Validation notifications
+MANIFEST_SHORTCUT_Constants=Constants
+MANIFEST_SHORTCUT_Attributes=Attributes
+MANIFEST_SHORTCUT_Option_sets=Option sets
+MANIFEST_SHORTCUT_Option_groups=Option groups
+MANIFEST_SHORTCUT_Option_group_sets=Option group sets
+MANIFEST_SHORTCUT_Legends=Legends
+MANIFEST_SHORTCUT_Predictors=Predictors
+MANIFEST_SHORTCUT_Predictor_groups=Predictor groups
+MANIFEST_SHORTCUT_Push_analysis=Push analysis
+MANIFEST_SHORTCUT_External_map_layers=External map layers
+MANIFEST_SHORTCUT_Data_approval_levels=Data approval levels
+MANIFEST_SHORTCUT_Data_approval_workflows=Data approval workflows
+MANIFEST_SHORTCUT_Locales=Locales
+MANIFEST_SHORTCUT_SQL_views=SQL views
+MANIFEST_SHORTCUT_Icons=Icons
+MANIFEST_SHORTCUT_Analytics_table_hooks=Analytics table hooks