Merge branch 'main' into release2

Author: abose

.eslintignore

@@ -12,6 +12,7 @@ src/**/*-min.js
 src/**/*.min.js
 src/virtual-server-main.js
 src/service-worker.js
+src/mdViewer/**
 
 test/perf/*-files/**/*.js
 test/spec/*-files/**/*.js

.github/workflows/tranlate-languages.yml

@@ -21,7 +21,14 @@ jobs:
       - name: Check translation errors file
         id: check-errors
         run: |
+          ERRORS=""
           if [ -f src/nls/errors.txt ]; then
+            ERRORS="true"
+          fi
+          if [ -f src-mdviewer/src/md-nls-autogenerated/errors.txt ]; then
+            ERRORS="true"
+          fi
+          if [ -n "$ERRORS" ]; then
             echo "errors_found=true" >> $GITHUB_ENV
           else
             echo "errors_found=false" >> $GITHUB_ENV
@@ -37,10 +44,13 @@ jobs:
           title: '[Translations BOT] Update String translations'
           add-paths: |
             src/nls/**
+            src-mdviewer/src/md-nls-autogenerated/**
+            src-mdviewer/src/locales/**
           body: |
             Update string translations
             - Auto-generated by `tranlate-languages.yml` action
-            
+            - Includes Phoenix NLS (`src/nls/`) and mdviewer locales (`src-mdviewer/src/locales/`)
+
             Errors:
              ${{ env.errors_found == 'true' && 'Errors: Some errors were found, please see GitHub Actions logs.' || 'No Translation Errors. All good!' }}
       - name: Check outputs

.gitignore

@@ -28,6 +28,10 @@ Thumbs.db
 # ignore node_modules inside src
 /src/node_modules
 /src-node/node_modules
+/src-mdviewer/node_modules
+
+# ignore mdViewer build output
+/src/mdViewer
 /src/JSUtils/node_modules
 /src/JSUtils/node/node_modules
 
@@ -92,6 +96,7 @@ test/thirdparty/jasmine-reporters
 
 # translations
 /src/nls/errors.txt
+/src-mdviewer/src/md-nls-autogenerated/errors.txt
 
 
 # ignore everything in the dev extension directory EXCEPT the README

gulpfile.js/index.js

@@ -145,7 +145,8 @@ function makeJSDist() {
         "!src/thirdparty/no-minify/**/*", "!src/thirdparty/xterm/**/*",
         "!src/LiveDevelopment/BrowserScripts/RemoteFunctions.js",
         "!src/extensionsIntegrated/phoenix-pro/onboarding/**/*",
-        "!src/extensionsIntegrated/phoenix-pro/unit-tests/**/*"])
+        "!src/extensionsIntegrated/phoenix-pro/unit-tests/**/*",
+        "!src/mdViewer/**/*"])
         .pipe(minify({
             ext:{
                 min:'.js'
@@ -180,7 +181,8 @@ function makeNonMinifyDist() {
         "src/thirdparty/xterm/**/*",
         "src/LiveDevelopment/BrowserScripts/RemoteFunctions.js",
         "src/extensionsIntegrated/phoenix-pro/onboarding/**/*",
-        "src/extensionsIntegrated/phoenix-pro/unit-tests/**/*"], {base: 'src'})
+        "src/extensionsIntegrated/phoenix-pro/unit-tests/**/*",
+        "src/mdViewer/**/*"], {base: 'src'})
         .pipe(dest('dist'));
 }
 
@@ -428,6 +430,7 @@ function releaseProd() {
 function translateStrings() {
     return new Promise(async (resolve)=>{ // eslint-disable-line
         await Translate.translate();
+        await Translate.translateMdviewer();
         resolve();
     });
 }
@@ -706,7 +709,7 @@ function _makeBracketsConcatJSInternal(isDevBuild = true) {
             `${srcDir}preferences/PreferencesImpl.js` // tests does require magic on prefs, so exclude
         ];
         const pathsToMerge = [];
-        const PathsToIgnore = ["assets", "thirdparty", "extensions"];
+        const PathsToIgnore = ["assets", "thirdparty", "extensions", "mdViewer"];
         for(let dir of fs.readdirSync(srcDir, {withFileTypes: true})){
             if(dir.isDirectory() && !PathsToIgnore.includes(dir.name)){
                 pathsToMerge.push(dir.name);

gulpfile.js/translateStrings.js

@@ -20,6 +20,7 @@
 
 /* eslint-env node */
 const fs = require('fs');
+const path = require('path');
 const CORE_AI_TRANSLATE_API_KEY = process.env.CORE_AI_TRANSLATE_API_KEY;
 
 // A global accumulator object initialized to zero
@@ -83,7 +84,7 @@ function aggregateUtilizationMetrics(obj) {
 const translationContext =
 `This is a bunch of strings extracted from a JavaScript file used to develop our product with is a text editor.
 Some strings may have HTML or templates(mustache library used).
-The brand name “Phoenix Pro” must remain in English and should never be translated. 
+The brand name "Phoenix Pro" must remain in English and should never be translated.
 Please translate these strings accurately.
 `;
 
@@ -131,11 +132,11 @@ async function getTranslation(apiInput) {
     }
 }
 
-function _getAllNLSFolders() {
-    let names = fs.readdirSync('src/nls');
+function _getAllNLSFolders(nlsDir) {
+    let names = fs.readdirSync(nlsDir);
     let nlsFolders =[];
     for(let name of names){
-        let stat = fs.statSync(`src/nls/${name}`);
+        let stat = fs.statSync(path.join(nlsDir, name));
         if(stat.isDirectory()){
             nlsFolders.push(name);
         }
@@ -180,18 +181,18 @@ const FILE_HEADER = `/*
  */
 
 define(`,
-FILE_FOOTER = ');';
+    FILE_FOOTER = ');';
 
-function _isTranslatableKey(key) {
+function _isTranslatableKey(key, sourceStrings) {
     const doNotTranslateDirective = '_DO_NOT_TRANSLATE';
     const translationDisabledForKey = `${key}${doNotTranslateDirective}`;
-    if(key.endsWith(doNotTranslateDirective) || rootStrings[translationDisabledForKey] === 'true'){
+    if(key.endsWith(doNotTranslateDirective) || sourceStrings[translationDisabledForKey] === 'true'){
         return false;
     }
     return true;
 }
 
-async function coreAiTranslate(stringsToTranslate, lang) {
+async function coreAiTranslate(stringsToTranslate, lang, errorsFile) {
     if(!Object.keys(stringsToTranslate).length){
         return {};
     }
@@ -203,7 +204,7 @@ async function coreAiTranslate(stringsToTranslate, lang) {
     if(translations.failedLanguages.length){
         const errorStr = `Error translating ${lang}. it has failures `;
         console.error(errorStr);
-        fs.writeFileSync(`src/nls/errors.txt`, errorStr);
+        fs.writeFileSync(errorsFile, errorStr);
         // this is oke to continue in case of partial translations.
     }
     let translationForLanguage = translations.translations[lang];
@@ -214,7 +215,7 @@ async function coreAiTranslate(stringsToTranslate, lang) {
     if(!translationForLanguage){
         const errorStr = `Error translating. AI response doesnt have the language ${lang} translated!`;
         console.error(errorStr);
-        fs.writeFileSync(`src/nls/errors.txt`, errorStr);
+        fs.writeFileSync(errorsFile, errorStr);
         return {};
     }
     return translationForLanguage;
@@ -272,24 +273,35 @@ function getSortedObject(obj) {
  *
  * Finally, we update all the autogenerated translations to disk.
  *
- * @param lang
+ * @param {string} lang - locale code
+ * @param {object} config - { nlsDir, sourceStrings, format, errorsFile }
  * @return {Promise<void>}
  * @private
  */
-async function _processLang(lang) {
+async function _processLang(lang, config) {
     if(lang === 'root'){
         return;
     }
-    const expertTranslations = _getJson(`src/nls/${lang}/expertTranslations.json`, 'utf8');
-    let lastTranslated = _getJson(`src/nls/${lang}/lastTranslated.json`, 'utf8');
-    require(`../src/nls/${lang}/strings`);
-    let localeStringsJS = requireDefinedStrings;
+    const { nlsDir, sourceStrings, format, errorsFile } = config;
+    const langDir = path.join(nlsDir, lang);
+
+    const expertTranslations = _getJson(path.join(langDir, 'expertTranslations.json'));
+    let lastTranslated = _getJson(path.join(langDir, 'lastTranslated.json'));
+
+    let localeStringsJS;
+    if (format === 'json') {
+        localeStringsJS = _getJson(path.join(langDir, 'strings.json'));
+    } else {
+        require(path.resolve(langDir, 'strings'));
+        localeStringsJS = requireDefinedStrings;
+    }
+
     let translations = {}, updatedLastTranslatedJSON={}, pendingTranslate = {};
-    for(let rootKey of Object.keys(rootStrings)){
-        if(!_isTranslatableKey(rootKey)){
+    for(let rootKey of Object.keys(sourceStrings)){
+        if(!_isTranslatableKey(rootKey, sourceStrings)){
             continue; // move on to next string
         }
-        let englishStringToTranslate = rootStrings[rootKey];
+        let englishStringToTranslate = sourceStrings[rootKey];
         let lastTranslatedEnglishString = lastTranslated[rootKey];
         if(englishStringToTranslate === lastTranslatedEnglishString){
             // we have already translated this in the last pass.
@@ -316,54 +328,169 @@ async function _processLang(lang) {
     }
     //let translatedText = await _translateString(englishStringToTranslate, lang);
     console.log(`Translating ${Object.keys(pendingTranslate).length} strings to`, lang);
-    const aiTranslations = await coreAiTranslate(pendingTranslate, lang);
-    const allRootKeys = new Set(Object.keys(rootStrings));
+    const aiTranslations = await coreAiTranslate(pendingTranslate, lang, errorsFile);
+    const allRootKeys = new Set(Object.keys(sourceStrings));
     for(let rootKey of Object.keys(pendingTranslate)){
         if(!allRootKeys.has(rootKey)){
             // AI hallucinated a root key?
             const errorStr = `AI translated for a root key that doesnt exist!!! in ${lang}: ${rootKey} \nTranslation: ${aiTranslations[rootKey]}`;
             console.error(errorStr);
-            fs.writeFileSync(`src/nls/errors.txt`, errorStr);
+            fs.writeFileSync(errorsFile, errorStr);
             continue;
         }
-        let englishStringToTranslate = rootStrings[rootKey];
+        let englishStringToTranslate = sourceStrings[rootKey];
         const translatedText = aiTranslations[rootKey];
         if(translatedText){
             translations[rootKey] = translatedText;
             updatedLastTranslatedJSON[rootKey] = englishStringToTranslate;
         }
     }
     // now detect any keys that has not yet been translated
-    const allKeys = Object.keys(rootStrings).filter(_isTranslatableKey);
+    const allKeys = Object.keys(sourceStrings).filter(k => _isTranslatableKey(k, sourceStrings));
     const translatedKeys = Object.keys(translations);
     const notTranslated = allKeys.filter(key => !translatedKeys.includes(key));
     if(notTranslated.length){
         const errorStr = `Some strings not translated in ${lang}\n${notTranslated}`;
         console.error(errorStr);
-        fs.writeFileSync(`src/nls/errors.txt`, errorStr);
+        fs.writeFileSync(errorsFile, errorStr);
     }
 
-    let translatedStringsJSON = JSON.stringify(translations, null, 2);
-    let fileToWrite = `${FILE_HEADER}${translatedStringsJSON}${FILE_FOOTER}`;
-    if(!shallowEqual(translations, localeStringsJS)){
-        fs.writeFileSync(`src/nls/${lang}/strings.js`, fileToWrite);
+    if (format === 'json') {
+        // Write plain JSON
+        if(!shallowEqual(translations, localeStringsJS)){
+            fs.writeFileSync(path.join(langDir, 'strings.json'),
+                JSON.stringify(translations, null, 2));
+        }
+    } else {
+        // Write define()-wrapped JS
+        let translatedStringsJSON = JSON.stringify(translations, null, 2);
+        let fileToWrite = `${FILE_HEADER}${translatedStringsJSON}${FILE_FOOTER}`;
+        if(!shallowEqual(translations, localeStringsJS)){
+            fs.writeFileSync(path.join(langDir, 'strings.js'), fileToWrite);
+        }
     }
     if(!shallowEqual(updatedLastTranslatedJSON, lastTranslated)){
         const sortedList = getSortedObject(updatedLastTranslatedJSON);
-        fs.writeFileSync(`src/nls/${lang}/lastTranslated.json`, JSON.stringify(sortedList, null, 2));
+        fs.writeFileSync(path.join(langDir, 'lastTranslated.json'),
+            JSON.stringify(sortedList, null, 2));
     }
 }
 
+// ---- Phoenix NLS translation ----
+
 async function translate() {
     console.log("please make sure that core.ai lang translation service credentials are available as env vars.");
     return new Promise(async (resolve)=>{
-        let langs = _getAllNLSFolders();
+        const nlsDir = 'src/nls';
+        let langs = _getAllNLSFolders(nlsDir);
         console.log(langs);
+        const config = {
+            nlsDir,
+            sourceStrings: rootStrings,
+            format: 'js',
+            errorsFile: 'src/nls/errors.txt'
+        };
         for(let lang of langs){
-            await _processLang(lang);
+            await _processLang(lang, config);
         }
         resolve();
     });
 }
 
+// ---- mdviewer translation ----
+
+/**
+ * Flatten a nested object into dot-notation keys.
+ * { toolbar: { done: "Done" } } → { "toolbar.done": "Done" }
+ */
+function _flattenObject(obj, prefix = '') {
+    const result = {};
+    for (const key of Object.keys(obj)) {
+        const fullKey = prefix ? `${prefix}.${key}` : key;
+        if (typeof obj[key] === 'object' && obj[key] !== null && !Array.isArray(obj[key])) {
+            Object.assign(result, _flattenObject(obj[key], fullKey));
+        } else {
+            result[fullKey] = obj[key];
+        }
+    }
+    return result;
+}
+
+/**
+ * Unflatten dot-notation keys back into a nested object.
+ * { "toolbar.done": "Done" } → { toolbar: { done: "Done" } }
+ */
+function _unflattenObject(obj) {
+    const result = {};
+    for (const flatKey of Object.keys(obj)) {
+        const parts = flatKey.split('.');
+        let current = result;
+        for (let i = 0; i < parts.length - 1; i++) {
+            if (!current[parts[i]] || typeof current[parts[i]] !== 'object') {
+                current[parts[i]] = {};
+            }
+            current = current[parts[i]];
+        }
+        current[parts[parts.length - 1]] = obj[flatKey];
+    }
+    return result;
+}
+
+async function translateMdviewer() {
+    const mdNlsDir = 'src-mdviewer/src/md-nls-autogenerated';
+    const localesDir = 'src-mdviewer/src/locales';
+    const enJsonPath = path.join(localesDir, 'en.json');
+    const rootStringsPath = path.join(mdNlsDir, 'root', 'strings.json');
+
+    if (!fs.existsSync(enJsonPath)) {
+        console.log("[mdviewer] en.json not found, skipping mdviewer translation.");
+        return;
+    }
+
+    // Flatten en.json → root/strings.json (source of truth → NLS format)
+    const enNested = _getJson(enJsonPath);
+    const enFlat = getSortedObject(_flattenObject(enNested));
+    if (!fs.existsSync(path.join(mdNlsDir, 'root'))) {
+        fs.mkdirSync(path.join(mdNlsDir, 'root'), { recursive: true });
+    }
+    fs.writeFileSync(rootStringsPath, JSON.stringify(enFlat, null, 2));
+    console.log(`[mdviewer] Flattened en.json → root/strings.json (${Object.keys(enFlat).length} keys)`);
+
+    const mdRootStrings = enFlat;
+
+    console.log("[mdviewer] Starting mdviewer locale translation...");
+    let langs = _getAllNLSFolders(mdNlsDir);
+    console.log("[mdviewer] Locales:", langs);
+
+    const config = {
+        nlsDir: mdNlsDir,
+        sourceStrings: mdRootStrings,
+        format: 'json',
+        errorsFile: path.join(mdNlsDir, 'errors.txt')
+    };
+
+    for (let lang of langs) {
+        await _processLang(lang, config);
+    }
+
+    // Copy translated flat JSON → nested locale files for mdviewer runtime
+    console.log("[mdviewer] Copying translations to locales folder...");
+    for (let lang of langs) {
+        if (lang === 'root') continue;
+        const flatStrings = _getJson(path.join(mdNlsDir, lang, 'strings.json'));
+        if (!Object.keys(flatStrings).length) continue;
+        const nested = _unflattenObject(flatStrings);
+        fs.writeFileSync(
+            path.join(localesDir, `${lang}.json`),
+            JSON.stringify(nested, null, 2) + '\n'
+        );
+    }
+
+    console.log("[mdviewer] mdviewer locale translation complete.");
+}
+
 exports.translate = translate;
+exports.translateMdviewer = translateMdviewer;
+exports.coreAiTranslate = coreAiTranslate;
+exports.shallowEqual = shallowEqual;
+exports.getSortedObject = getSortedObject;