lightnet 4.0.7 → 4.1.0

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/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: لنک کاپی ہو گیا

package/src/i18n/translations/zh.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.ts

@@ -1,3 +1,4 @@
+import { z } from "astro/zod"
 import YAML from "yaml"
 
 const builtInTranslations = {
@@ -19,6 +20,8 @@ const builtInTranslations = {
 
 type BuiltInLanguage = keyof typeof builtInTranslations
 
+const translationFileSchema = z.record(z.string(), z.string())
+
 const userTranslations = Object.fromEntries(
   Object.entries(
     import.meta.glob(["/src/translations/*.(yml|yaml)"], {
@@ -52,7 +55,7 @@ const loadBuiltInTranslations = async (
     return {}
   }
   const yml = (await translationMap[bcp47]()).default
-  return YAML.parse(yml)
+  return translationFileSchema.parse(YAML.parse(yml))
 }
 
 const loadUserTranslations = async (bcp47: string) => {
@@ -60,7 +63,7 @@ const loadUserTranslations = async (bcp47: string) => {
     return {}
   }
   const yml = (await userTranslations[bcp47]()) as string
-  return YAML.parse(yml)
+  return translationFileSchema.parse(YAML.parse(yml))
 }
 
 export type LightNetTranslationKey =

package/src/layouts/Page.astro

@@ -20,10 +20,9 @@ interface Props {
 }
 
 const { title, description, mainClass, locale } = Astro.props
-const currentLocale = locale ?? Astro.locals.i18n.currentLocale
-const configTitle = Astro.locals.i18n.tMap(config.title, {
-  path: ["config", "title"],
-})
+const { currentLocale: pathCurrentLocale, tConfigField } = Astro.locals.i18n
+const currentLocale = locale ?? pathCurrentLocale
+const configTitle = tConfigField(config.title, config)
 const { direction } = resolveLanguage(currentLocale)
 ---
 

package/src/layouts/components/Footer.astro

@@ -1,24 +1,86 @@
 ---
 import config from "virtual:lightnet/config"
 
+import { localizePath } from "../../utils/paths"
+import { isExternalUrl } from "../../utils/urls"
 import LightNetLogo from "./LightNetLogo.svg"
 
-if (!config.credits) {
+const { t, tConfigField, currentLocale } = Astro.locals.i18n
+
+// Resolve optional footer text for the current locale.
+const footerText = config.footerText
+  ? tConfigField(config.footerText, config)
+  : undefined
+
+// Prepare footer links using the same locale rules as the main menu.
+const footerLinks = (config.footerLinks ?? []).map(
+  ({ href, label, requiresLocale }) => {
+    const isExternal = isExternalUrl(href)
+
+    return {
+      href:
+        isExternal || !requiresLocale
+          ? href
+          : localizePath(currentLocale, href),
+      label: tConfigField(label, config),
+      isExternal,
+    }
+  },
+)
+
+// Hide the footer entirely when there is nothing to show.
+const shouldRenderFooter =
+  config.credits || Boolean(footerText) || footerLinks.length > 0
+
+if (!shouldRenderFooter) {
   return
 }
 ---
 
-<footer class="w-full border-t border-gray-300">
+<footer class="w-full border-t border-gray-200 bg-white">
   <div
-    class="mx-auto flex w-full max-w-screen-xl justify-end px-4 py-4 md:px-8"
+    class="mx-auto flex w-full max-w-screen-xl flex-col items-center justify-between gap-4 px-4 py-6 md:flex-row md:px-8"
   >
-    <a
-      class="flex items-center gap-2 py-2 text-sm text-gray-800 hover:underline"
-      href="https://lightnet.community"
-      target="_blank"
+    <div
+      class="flex flex-wrap items-center justify-center gap-2 text-sm text-gray-700 md:justify-start"
     >
-      <img src={LightNetLogo.src} alt="" class="h-5 w-auto" loading="lazy" />
-      {Astro.locals.i18n.t("ln.footer.powered-by-lightnet")}
-    </a>
+      {footerText && <span>{footerText}</span>}
+
+      {
+        footerLinks.map((link, index) => (
+          <Fragment>
+            {(footerText || index > 0) && <span class="text-gray-400">·</span>}
+            <a
+              href={link.href}
+              target={link.isExternal ? "_blank" : undefined}
+              rel={link.isExternal ? "noopener noreferrer" : undefined}
+              class="underline-offset-4 hover:underline"
+            >
+              {link.label}
+            </a>
+          </Fragment>
+        ))
+      }
+    </div>
+
+    {
+      config.credits && (
+        <div class="flex items-center text-sm">
+          <a
+            class="flex items-center gap-2 text-gray-800 underline-offset-4 hover:underline"
+            href="https://lightnet.community"
+            target="_blank"
+          >
+            <img
+              src={LightNetLogo.src}
+              alt=""
+              class="h-5 w-auto"
+              loading="lazy"
+            />
+            <span>{t("ln.footer.powered-by-lightnet")}</span>
+          </a>
+        </div>
+      )
+    }
   </div>
 </footer>

package/src/layouts/components/LanguagePicker.astro

@@ -6,7 +6,7 @@ import { localizePath, pathWithoutBase } from "../../utils/paths"
 import Menu from "./Menu.astro"
 import MenuItem from "./MenuItem.astro"
 
-const { locales, currentLocale, tMap } = Astro.locals.i18n
+const { locales, currentLocale, tConfigField } = Astro.locals.i18n
 
 const currentPath = pathWithoutBase(Astro.url.pathname)
 const hasLocale =
@@ -18,7 +18,7 @@ const translations = (
   await Promise.all(
     locales.map(async (locale) => ({
       locale,
-      label: resolveTranslatedLanguage(locale, tMap).labelText,
+      label: resolveTranslatedLanguage(locale, tConfigField).labelText,
       active: locale === currentLocale,
       href: currentPathWithLocale(locale),
     })),