feat(CSAF2.1): #403 add recommended test 6.2.39.2 - add regions and script code to translation

Author: rainer-exxcellent

lib/shared/languageSpecificTranslation.js

@@ -1,7 +1,7 @@
 import bcp47 from 'bcp47'
 import translations from '../../lib/language_specific_translation/translations.js'
 
-const translationMap = new Map(
+const csafTranslationMaps = new Map(
   Object.entries(translations.translation).map(([key, value]) => [
     key,
     new Map(Object.entries(value)),
@@ -46,12 +46,34 @@ export function containsOneNoteWithTitleAndCategory(
  * @param {string} i18nKey
  */
 export function getTranslationInDocumentLang(doc, i18nKey) {
-  if (!doc.document.lang) {
-    return undefined
-  }
-  const language = bcp47.parse(doc.document.lang)?.langtag.language.language
-  if (!language) {
-    return undefined
+  return doc.document.lang
+    ? getTranslationInMap(doc.document.lang, i18nKey, csafTranslationMaps)
+    : undefined
+}
+
+/**
+ * Get the language specific translation of the given i18nKey in translationMaps
+ * @param {string} langToTranslate
+ * @param {string} i18nKey
+ * @param {Map<string,Map<string,string>>} translationMaps
+ */
+export function getTranslationInMap(langToTranslate, i18nKey, translationMaps) {
+  const langtag = bcp47.parse(langToTranslate)?.langtag
+  const languageCode = langtag?.language.language
+  let transMapForLanguage
+  if (langtag && languageCode) {
+    if (langtag.region) {
+      if (langtag.script) {
+        transMapForLanguage = translationMaps.get(
+          `${languageCode}-${langtag.script}-${langtag.region}`
+        )
+      }
+      transMapForLanguage =
+        transMapForLanguage ??
+        translationMaps.get(`${languageCode}-${langtag.region}`)
+    }
+    transMapForLanguage =
+      transMapForLanguage ?? translationMaps.get(languageCode)
   }
-  return translationMap.get(language)?.get(i18nKey)
+  return transMapForLanguage?.get(i18nKey)
 }

tests/languageSpecificTranslation.js

@@ -0,0 +1,39 @@
+import { getTranslationInMap } from '../lib/shared/languageSpecificTranslation.js'
+import { expect } from 'chai'
+
+describe('test language specific translation', function () {
+  it('test getTranslationInMap', function () {
+    const translationMaps = new Map([
+      ['de', new Map([['I18nTestKey', 'translationDe']])],
+      ['de-AT', new Map([['I18nTestKey', 'translationAT']])],
+      ['en', new Map([['I18nTestKey', 'translationEn']])],
+      ['zh-Hans-CN', new Map([['I18nTestKey', 'translationZh-Hans-CN']])],
+      ['sr', new Map([['I18nTestKey', 'translationSr']])],
+    ])
+
+    expect(
+      getTranslationInMap('de', 'I18nTestKey', translationMaps),
+      'Translate language code de'
+    ).to.equal('translationDe')
+    expect(
+      getTranslationInMap('de-AT', 'I18nTestKey', translationMaps),
+      'Translate language and region code'
+    ).to.equal('translationAT')
+    expect(
+      getTranslationInMap('en', 'I18nTestKey', translationMaps),
+      'Translate language code en'
+    ).to.equal('translationEn')
+    expect(
+      getTranslationInMap('en-US', 'I18nTestKey', translationMaps),
+      'Fallback to language code en on region us'
+    ).to.equal('translationEn')
+    expect(
+      getTranslationInMap('zh-Hans-CN', 'I18nTestKey', translationMaps),
+      'Translate language, region and script code'
+    ).to.equal('translationZh-Hans-CN')
+    expect(
+      getTranslationInMap('sr-Cyrl-RS', 'I18nTestKey', translationMaps),
+      'Fallback to language code en on region an sript code'
+    ).to.equal('translationSr')
+  })
+})