lightnet 4.0.8 → 4.1.1

package/src/i18n/resolve-language.ts

@@ -2,7 +2,7 @@ import { AstroError } from "astro/errors"
 import i18next from "i18next"
 import config from "virtual:lightnet/config"
 
-import type { TranslateMapFn } from "./translate-map"
+import type { TranslateConfigFieldFn } from "./translate-map"
 
 const languages = Object.fromEntries(
   config.languages.map((language) => [language.code, language]),
@@ -25,13 +25,20 @@ export const resolveLanguage = (bcp47: string) => {
 
 export const resolveTranslatedLanguage = (
   bcp47: string,
-  tMap: TranslateMapFn,
+  tConfigField: TranslateConfigFieldFn,
 ) => {
   const language = resolveLanguage(bcp47)
   return {
     ...language,
-    labelText: tMap(language.label, {
-      path: ["languages", bcp47, "label"],
-    }),
+    labelText: tConfigField(language.label, config),
   }
 }
+
+export async function getTranslatedLanguages(
+  currentLocale: string,
+  tConfigField: TranslateConfigFieldFn,
+) {
+  return config.languages
+    .map(({ code }) => resolveTranslatedLanguage(code, tConfigField))
+    .sort((a, b) => a.labelText.localeCompare(b.labelText, currentLocale))
+}

package/src/i18n/translate-map.ts

@@ -1,6 +1,10 @@
 import { AstroError } from "astro/errors"
+import type { CollectionKey } from "astro:content"
 import config from "virtual:lightnet/config"
 
+import type { ExtendedLightnetConfig } from "../astro-integration/config"
+import { recordTranslation } from "./record-translation"
+
 /**
  * A map of translated values keyed by locale code.
  *
@@ -12,14 +16,6 @@ import config from "virtual:lightnet/config"
  */
 export type TranslationMap = Record<string, string | undefined>
 
-/**
- * Describes where a translation map comes from so missing-value
- * errors can point to the exact field in config or content.
- */
-export type TranslationMapContext = {
-  path: (string | number)[]
-}
-
 /**
  * Resolve a translation map for the current locale, falling back
  * to configured default locale when needed.
@@ -32,7 +28,37 @@ export type TranslationMapContext = {
  */
 export type TranslateMapFn = (
   translationMap: TranslationMap,
-  context: TranslationMapContext,
+  /**
+   * Describes where a translation map comes from so translation logs
+   * can point to the exact field in config or content.
+   */
+  context: { path: (string | number)[] },
+) => string
+
+/**
+ * Resolve an inline translation map that belongs to a content entry.
+ *
+ * The entry is only used to provide a stable fallback path when translation-map
+ * metadata is missing during the current refactor.
+ */
+export type TranslateContentFieldFn = (
+  translationMap: TranslationMap,
+  contentEntry: {
+    id: string
+    collection: CollectionKey
+    data: Record<PropertyKey, unknown>
+  },
+) => string
+
+/**
+ * Resolve an inline translation map that belongs to the LightNet config.
+ *
+ * The config object is only used to keep the API explicit and to provide a
+ * stable fallback path when translation-map metadata is missing.
+ */
+export type TranslateConfigFieldFn = (
+  translationMap: TranslationMap,
+  config: ExtendedLightnetConfig,
 ) => string
 
 /**
@@ -45,26 +71,110 @@ export type TranslateMapFn = (
  * @param currentLocale The locale that should be resolved first before
  * falling back to LightNet's configured default locale.
  */
-export function useTranslateMap(currentLocale: string): TranslateMapFn {
-  return (translationMap: TranslationMap, context: TranslationMapContext) => {
-    const currentLocaleValue = translationMap[currentLocale]
-    if (currentLocaleValue) {
-      return currentLocaleValue
+export function useTranslateMap(currentLocale: string) {
+  const tMap: TranslateMapFn = (translationMap, context) => {
+    const getKey = () => {
+      const keyCacheSymbol = Symbol.for("ln.key-cache")
+      if (hasOwnProperty(translationMap, keyCacheSymbol)) {
+        return translationMap[keyCacheSymbol] as string
+      }
+      const value = context.path.join(".")
+      Object.defineProperty(translationMap, keyCacheSymbol, { value })
+      return value
+    }
+    const key = getKey()
+    recordTranslation({ key, values: translationMap, type: "map" })
+
+    const currentLocaleTranslation = translationMap[currentLocale]
+    if (currentLocaleTranslation) {
+      return currentLocaleTranslation
     }
 
-    const defaultLocaleValue = translationMap[config.defaultLocale]
-    if (defaultLocaleValue) {
-      return defaultLocaleValue
+    const defaultLocaleTranslation = translationMap[config.defaultLocale]
+    if (defaultLocaleTranslation) {
+      return defaultLocaleTranslation
     }
 
-    const availableLocales = Object.keys(translationMap)
+    const availableLocales = Object.keys(translationMap).filter(
+      (key) => key !== "path",
+    )
     const availableLocalesText = availableLocales.length
       ? availableLocales.map((locale) => `"${locale}"`).join(", ")
       : "none"
 
     throw new AstroError(
-      `Missing translation map value for "${context.path.join(".")}" in locales "${currentLocale}" and "${config.defaultLocale}"`,
+      `Missing translation map value for "${key}" in locales "${currentLocale}" and "${config.defaultLocale}"`,
       `Available locales: ${availableLocalesText}. Add a value for "${currentLocale}" or "${config.defaultLocale}" to this inline translation map.`,
     )
   }
+
+  const tContentField: TranslateContentFieldFn = (
+    translationMap,
+    contentEntry,
+  ) => {
+    return tMap(translationMap, {
+      path: getMapPath(translationMap, contentEntry.data, [
+        "content",
+        contentEntry.collection,
+        contentEntry.id,
+      ]),
+    })
+  }
+
+  const tConfigField: TranslateConfigFieldFn = (translationMap, _config) => {
+    return tMap(translationMap, {
+      path: getMapPath(translationMap, _config, ["config"]),
+    })
+  }
+
+  return { tMap, tContentField, tConfigField }
+}
+
+function getMapPath(
+  translationMap: TranslationMap,
+  data: unknown,
+  path: string[],
+) {
+  const pathCacheSymbol = Symbol.for("ln.path-cache")
+
+  if (hasOwnProperty(translationMap, pathCacheSymbol)) {
+    return translationMap[pathCacheSymbol] as string[]
+  }
+
+  const findPath: (_data: unknown, _path: string[]) => string[] | undefined = (
+    _data,
+    _path,
+  ) => {
+    if (!_data || typeof _data !== "object") {
+      return
+    }
+    if (_data === translationMap) {
+      return _path
+    }
+    for (const [key, value] of Object.entries(_data)) {
+      const p = findPath(value, [..._path, key])
+      if (p) {
+        return p as string[]
+      }
+    }
+  }
+
+  const resolvedPath = findPath(data, path)
+  if (!resolvedPath) {
+    throw new AstroError(
+      `Invalid map context provided ${path} for could not find path for object ${JSON.stringify(translationMap)}`,
+      `Provided object ${JSON.stringify(data)}`,
+    )
+  }
+  Object.defineProperty(translationMap, pathCacheSymbol, {
+    value: resolvedPath,
+  })
+  return resolvedPath
+}
+
+function hasOwnProperty<K extends PropertyKey>(
+  obj: unknown,
+  key: K,
+): obj is Record<K, unknown> {
+  return !!obj && typeof obj === "object" && Object.hasOwn(obj, key)
 }

package/src/i18n/translate.ts

@@ -3,6 +3,7 @@ import i18next, { type TOptions } from "i18next"
 import config from "virtual:lightnet/config"
 
 import { lazy } from "../utils/lazy"
+import { recordTranslation } from "./record-translation"
 import { type LightNetTranslationKey, loadTranslations } from "./translations"
 
 // We add (string & NonNullable<unknown>) to preserve typescript autocompletion for known keys
@@ -68,6 +69,7 @@ export async function useTranslate(
   const resolvedLocale = bcp47 ?? config.defaultLocale
   const translations = await i18nextTranslations.get()
   const availableTranslationKeys = new Set(await translationKeys.get())
+  recordAllTranslations()
 
   const i18n = i18next.createInstance()
 
@@ -100,3 +102,39 @@ export async function useTranslate(
     return value
   }
 }
+
+async function recordAllTranslations() {
+  if (!import.meta.env.PROD) {
+    // only record translations during build time
+    return
+  }
+
+  const { locales } = config
+  const localesIncludingEnglish = [...locales.filter((l) => l !== "en"), "en"]
+  const keys = await translationKeys.get()
+  const translations = await i18nextTranslations.get()
+
+  const collectValues = (key: string, locales: string[]) => {
+    const values = {} as Record<string, string | undefined>
+    for (const locale of locales) {
+      values[locale] = translations[locale]?.translation[key]
+    }
+    return values
+  }
+
+  for (const key of keys) {
+    if (key.startsWith("ln.")) {
+      recordTranslation({
+        key,
+        values: collectValues(key, localesIncludingEnglish),
+        type: "lightnet",
+      })
+    } else {
+      recordTranslation({
+        key,
+        values: collectValues(key, locales),
+        type: "user",
+      })
+    }
+  }
+}

package/src/i18n/translation-map-schema.ts

@@ -0,0 +1,17 @@
+import { z } from "astro/zod"
+
+/**
+ * Translations by BCP-47 tag
+ * Must contain at least one localized value.
+ *
+ * @example
+ * {
+ *    de: "Hallo",
+ *    en: "Hello"
+ * }
+ */
+export const translationMapSchema = z
+  .record(z.string(), z.string().nonempty())
+  .refine((value) => Object.keys(value).length > 0, {
+    message: "Inline translations must contain at least one entry",
+  })

package/src/i18n/translations/TRANSLATION-STATUS.md

@@ -4,21 +4,15 @@ This autogenerated report shows all built-in languages and the current status of
 
 ## **AR** ([ar.yml](./ar.yml))
 
-Missing keys:
-
-- ln.details.edit
+All keys have been translated. ✅
 
 ## **BN** ([bn.yml](./bn.yml))
 
-Missing keys:
-
-- ln.details.edit
+All keys have been translated. ✅
 
 ## **DE** ([de.yml](./de.yml))
 
-Missing keys:
-
-- ln.details.edit
+All keys have been translated. ✅
 
 ## **EN** ([en.yml](./en.yml))
 
@@ -26,62 +20,40 @@ All keys have been translated. ✅
 
 ## **ES** ([es.yml](./es.yml))
 
-Missing keys:
-
-- ln.details.edit
+All keys have been translated. ✅
 
 ## **FI** ([fi.yml](./fi.yml))
 
-Missing keys:
-
-- ln.details.edit
+All keys have been translated. ✅
 
 ## **FR** ([fr.yml](./fr.yml))
 
-Missing keys:
-
-- ln.details.edit
+All keys have been translated. ✅
 
 ## **HI** ([hi.yml](./hi.yml))
 
-Missing keys:
-
-- ln.details.edit
+All keys have been translated. ✅
 
 ## **KK** ([kk.yml](./kk.yml))
 
-Missing keys:
-
-- ln.previous
-- ln.next
-- ln.details.edit
+All keys have been translated. ✅
 
 ## **PT** ([pt.yml](./pt.yml))
 
-Missing keys:
-
-- ln.details.edit
+All keys have been translated. ✅
 
 ## **RU** ([ru.yml](./ru.yml))
 
-Missing keys:
-
-- ln.details.edit
+All keys have been translated. ✅
 
 ## **UK** ([uk.yml](./uk.yml))
 
-Missing keys:
-
-- ln.details.edit
+All keys have been translated. ✅
 
 ## **UR** ([ur.yml](./ur.yml))
 
-Missing keys:
-
-- ln.details.edit
+All keys have been translated. ✅
 
 ## **ZH** ([zh.yml](./zh.yml))
 
-Missing keys:
-
-- ln.details.edit
+All keys have been translated. ✅

package/src/i18n/translations/ar.yml

@@ -17,6 +17,7 @@ ln.search.all-categories: جميع الفئات
 ln.search.no-results: لا توجد نتائج
 ln.details.open: فتح
 ln.details.share: مشاركة
+ln.details.edit: تحرير
 ln.details.part-of-collection: جزء من مجموعة
 ln.details.download: تنزيل
 ln.share.url-copied-to-clipboard: تم نسخ الرابط إلى الحافظة

package/src/i18n/translations/bn.yml

@@ -17,6 +17,7 @@ ln.search.all-categories: সকল বিভাগ
 ln.search.no-results: কোনো ফলাফল নেই
 ln.details.open: খুলুন
 ln.details.share: শেয়ার করুন
+ln.details.edit: সম্পাদনা করুন
 ln.details.part-of-collection: সংগ্রহের অংশ
 ln.details.download: ডাউনলোড করুন
 ln.share.url-copied-to-clipboard: লিঙ্ক ক্লিপবোর্ডে কপি হয়েছে

package/src/i18n/translations/de.yml

@@ -11,6 +11,7 @@ ln.external-link: Externer Link
 ln.details.open: Öffnen
 ln.details.part-of-collection: Teil der Sammlung
 ln.details.download: Download
+ln.details.edit: Bearbeiten
 ln.details.share: Teilen
 ln.header.open-main-menu: Öffne Hauptmenü
 ln.header.select-language: Sprache auswählen

package/src/i18n/translations/en.yml

@@ -2,104 +2,106 @@
 # This is only "visible" to a screen-reader.
 #
 # English: Open main menu
-# Used on: https://sk8-ministries.pages.dev/en (not visible)
+# Used on: https://kuuluu.org/en (not visible)
 ln.header.open-main-menu: Open main menu
 
 # Accessibility label for the language menu.
 # This is only "visible" to a screen-reader.
 #
 # English: Select language
-# Used on: https://sk8-ministries.pages.dev/en (not visible)
+# Used on: https://kuuluu.org/en (not visible)
 ln.header.select-language: Select language
 
 # Display name for the home page.
 #
 # English: Home
-# Used on: https://sk8-ministries.pages.dev/en (first item in the main menu)
+# Used on: https://kuuluu.org/en (first item in the main menu)
 ln.home.title: Home
 
 # Label for a single media item category.
 #
 # English: Category
-# Used on: https://sk8-ministries.pages.dev/en/media
+# Used on: https://kuuluu.org/en/media
 ln.category: Category
 
 # Label for multiple media item categories.
 #
 # English: Categories
-# Used on: https://sk8-ministries.pages.dev/en/media/how-to-360-flip--en/
+# Used on: https://kuuluu.org/en/media/how-to-360-flip--en/
 ln.categories: Categories
 
 # Label for a single language.
 #
 # English: Language
-# Used on: https://sk8-ministries.pages.dev/en/media
+# Used on: https://kuuluu.org/en/media
 ln.language: Language
 
 # Label for multiple languages.
 #
 # English: Languages
-# Used on: https://sk8-ministries.pages.dev/en/media/how-to-kickflip--en/
+# Used on: https://kuuluu.org/en/media/how-to-kickflip--en/
 ln.languages: Languages
 
 # Label for a single media type.
 #
 # English: Type
-# Used on: https://sk8-ministries.pages.dev/en/media
+# Used on: https://kuuluu.org/en/media
 ln.type: Type
 
 # Accessibility label for buttons to show the previous items.
 # This is used on the carousel arrow button.
 #
 # English: Previous
+# Used on: https://kuuluu.org/en (not visible)
 ln.previous: Previous
 
 # Accessibility label for buttons to show the next items.
 # This is used on the carousel arrow button.
 #
 # English: Next
+# Used on: https://kuuluu.org/en (not visible)
 ln.next: Next
 
 # Hint for an external link.
 #
 # English: External link - opens in a new tab
-# Used on: https://sk8-ministries.pages.dev/en/media/ollie-with-integrity--en/
+# Used on: https://kuuluu.org/en/media/ollie-with-integrity--en/
 ln.external-link: External link - opens in a new tab
 
 # Title for the search page.
 #
 # English: Search
-# Used on: https://sk8-ministries.pages.dev/en/media/ (not visible)
+# Used on: https://kuuluu.org/en/media/ (not visible)
 ln.search.title: Search
 
 # Placeholder text for the search input to search for media items.
 # English: Search media
 #
-# Used on: https://sk8-ministries.pages.dev/en/media/
+# Used on: https://kuuluu.org/en/media/
 ln.search.placeholder: Search media
 
 # Filter option to display content in all languages.
 #
 # English: All languages
-# Used on: https://sk8-ministries.pages.dev/en/media/
+# Used on: https://kuuluu.org/en/media/
 ln.search.all-languages: All languages
 
 # Filter option to display all media types.
 #
 # English: All types
-# Used on: https://sk8-ministries.pages.dev/en/media/
+# Used on: https://kuuluu.org/en/media/
 ln.search.all-types: All types
 
 # Filter option to display all media item categories.
 #
 # English: All categories
-# Used on: https://sk8-ministries.pages.dev/en/media/
+# Used on: https://kuuluu.org/en/media/
 ln.search.all-categories: All categories
 
 # Message displayed when no search results are found.
 #
 # English: No results
-# Used on: https://sk8-ministries.pages.dev/en/media/?language=de&type=book
+# Used on: https://kuuluu.org/en/media/?language=de&type=book
 ln.search.no-results: No results
 
 # Button label to open a media item's main content.
@@ -110,7 +112,7 @@ ln.details.open: Open
 # Button label to share a media item.
 #
 # English: Share
-# Used on: https://sk8-ministries.pages.dev/en/media/ollie-with-integrity--en/
+# Used on: https://kuuluu.org/en/media/ollie-with-integrity--en/
 ln.details.share: Share
 
 # Button label to start editing an item
@@ -121,32 +123,33 @@ ln.details.edit: Edit
 # Label for indicating that the media item belongs to a collection.
 #
 # English: Part of collection
-# Used on: https://sk8-ministries.pages.dev/en/media/ollie-with-integrity--en/
+# Used on: https://kuuluu.org/en/media/ollie-with-integrity--en/
 ln.details.part-of-collection: Part of collection
 
 # Button label for downloading a media item.
 #
 # English: Download
-# Used on: https://sk8-ministries.pages.dev/en/media/ride-the-ramp-of-faith--en/
+# Used on: https://kuuluu.org/en/media/ride-the-ramp-of-faith--en/
 ln.details.download: Download
 
 # Notification message indicating that the link has been copied to the clipboard.
 #
 # English: Link copied to clipboard
-# Used on: https://sk8-ministries.pages.dev/en/media/ride-the-ramp-of-faith--en/ (Firefox)
+# Used on: https://kuuluu.org/en/media/ride-the-ramp-of-faith--en/ (Firefox)
 ln.share.url-copied-to-clipboard: Link copied to clipboard
 
 # Title for the 404-error page. This page is displayed when a path does not exist.
 #
 # English: Page not found
-# Used on: https://sk8-ministries.pages.dev/unexisting-path
+# Used on: https://kuuluu.org/unexisting-path
 ln.404.page-not-found: Page not found
 
 # Button label on the 404-error page for returning to the home page.
 #
 # English: Go to Home page
-# Used on: https://sk8-ministries.pages.dev/unexisting-path
+# Used on: https://kuuluu.org/unexisting-path
 ln.404.go-to-the-home-page: Go to Home page
 
 # Footer text to give credits to LightNet
+# Used on: https://kuuluu.org/en
 ln.footer.powered-by-lightnet: Powered by LightNet

package/src/i18n/translations/es.yml

@@ -17,6 +17,7 @@ ln.search.all-categories: Todas las categorías
 ln.search.no-results: Sin resultados
 ln.details.open: Abrir
 ln.details.share: Compartir
+ln.details.edit: Editar
 ln.details.part-of-collection: Parte de la colección
 ln.details.download: Descargar
 ln.share.url-copied-to-clipboard: Enlace copiado al portapapeles

package/src/i18n/translations/fi.yml

@@ -17,6 +17,7 @@ ln.search.all-categories: Kaikki kategoriat
 ln.search.no-results: Ei tuloksia
 ln.details.open: Avaa
 ln.details.share: Jaa
+ln.details.edit: Muokkaa
 ln.details.part-of-collection: Osa kokoelmaa
 ln.details.download: Lataa
 ln.share.url-copied-to-clipboard: Linkki kopioitu leikepöydälle

package/src/i18n/translations/fr.yml

@@ -17,6 +17,7 @@ ln.search.all-categories: Toutes les catégories
 ln.search.no-results: Aucun résultat
 ln.details.open: Ouvrir
 ln.details.share: Partager
+ln.details.edit: Modifier
 ln.details.part-of-collection: Fait partie de la collection
 ln.details.download: Télécharger
 ln.share.url-copied-to-clipboard: Lien copié dans le presse-papiers

package/src/i18n/translations/hi.yml

@@ -17,6 +17,7 @@ ln.search.all-categories: सभी श्रेणियाँ
 ln.search.no-results: कोई परिणाम नहीं मिला
 ln.details.open: खोलें
 ln.details.share: साझा करें
+ln.details.edit: संपादित करें
 ln.details.part-of-collection: संग्रह का भाग
 ln.details.download: डाउनलोड करें
 ln.share.url-copied-to-clipboard: लिंक क्लिपबोर्ड पर कॉपी हो गया है

package/src/i18n/translations/kk.yml

@@ -6,6 +6,8 @@ ln.categories: Барлық санаттар
 ln.language: Тіл
 ln.languages: Тілдер
 ln.type: Түрі
+ln.previous: Алдыңғы
+ln.next: Келесі
 ln.external-link: Сыртқы сілтеме
 ln.search.title: Іздеу
 ln.search.placeholder: Медиа іздеу
@@ -15,6 +17,7 @@ ln.search.all-categories: Барлық санаттар
 ln.search.no-results: Нәтижие жоқ
 ln.details.open: Ашу
 ln.details.share: Бөлісу
+ln.details.edit: Өңдеу
 ln.details.part-of-collection: Жинақ бөлімі
 ln.details.download: Жүктеу
 ln.share.url-copied-to-clipboard: Жүктеме көшірілді

package/src/i18n/translations/pt.yml

@@ -17,6 +17,7 @@ ln.search.all-categories: Todas as categorias
 ln.search.no-results: Nenhum resultado
 ln.details.open: Abrir
 ln.details.share: Partilhar
+ln.details.edit: Editar
 ln.details.part-of-collection: Parte da coleção
 ln.details.download: Transferir
 ln.share.url-copied-to-clipboard: Ligação copiada para a área de transferência

package/src/i18n/translations/ru.yml

@@ -17,6 +17,7 @@ ln.search.all-categories: Все категории
 ln.search.no-results: Нет результатов
 ln.details.open: Открыть
 ln.details.share: Поделиться
+ln.details.edit: Редактировать
 ln.details.part-of-collection: Часть коллекции
 ln.details.download: Скачать
 ln.share.url-copied-to-clipboard: Ссылка скопированa в буфер

package/src/i18n/translations/uk.yml

@@ -17,6 +17,7 @@ ln.search.all-categories: Усі категорії
 ln.search.no-results: Немає результатів
 ln.details.open: Відкрити
 ln.details.share: Поділитися
+ln.details.edit: Редагувати
 ln.details.part-of-collection: Частина колекції
 ln.details.download: Завантажити
 ln.share.url-copied-to-clipboard: Посилання скопійовано до буферу обміну

package/src/i18n/translations/ur.yml

@@ -17,6 +17,7 @@ ln.search.all-categories: تمام زمرے
 ln.search.no-results: کوئی نتیجہ نہیں ملا
 ln.details.open: کھولیں
 ln.details.share: شیئر کریں
+ln.details.edit: ترمیم کریں
 ln.details.part-of-collection: مجموعے کا حصہ
 ln.details.download: ڈاؤن لوڈ کریں
 ln.share.url-copied-to-clipboard: لنک کاپی ہو گیا