lightnet 4.0.8 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # lightnet
 
+## 4.1.0
+
+### Minor Changes
+
+- [#386](https://github.com/LightNetDev/LightNet/pull/386) [`3297d11`](https://github.com/LightNetDev/LightNet/commit/3297d11b8ae2d5d569291f72048f06ce0a99b556) Thanks [@vilgax-the-villain-with-99bugs](https://github.com/vilgax-the-villain-with-99bugs)! - Added customizable footer text and links.
+
+- [#387](https://github.com/LightNetDev/LightNet/pull/387) [`d7969dc`](https://github.com/LightNetDev/LightNet/commit/d7969dcaa65417316b129f50602d3473813f52fe) Thanks [@smn-cds](https://github.com/smn-cds)! - Add `tConfigField` and `tContentField` to LightNet's i18n locals to distinguish
+  between inline translation maps from config fields and content fields.
+
+  These helpers resolve inline translation maps for the current locale while
+  preserving the existing `tMap` helper for cases where the field context is
+  provided manually.
+
+### Patch Changes
+
+- [#387](https://github.com/LightNetDev/LightNet/pull/387) [`d7969dc`](https://github.com/LightNetDev/LightNet/commit/d7969dcaa65417316b129f50602d3473813f52fe) Thanks [@smn-cds](https://github.com/smn-cds)! - Update dependencies
+
 ## 4.0.8
 
 ### Patch Changes

package/exports/content.ts

@@ -1,10 +1,8 @@
-export {
-  createCategorySchema as categorySchema,
-  LIGHTNET_COLLECTIONS,
-  mediaCollectionSchema,
-  createMediaItemSchema as mediaItemSchema,
-  mediaTypeSchema,
-} from "../src/content/content-schema"
+export { LIGHTNET_COLLECTIONS } from "../src/content/content-schema"
+export { createCategorySchema as categorySchema } from "../src/content/schema/category"
+export { mediaCollectionSchema } from "../src/content/schema/media-collection"
+export { createMediaItemSchema as mediaItemSchema } from "../src/content/schema/media-item"
+export { mediaTypeSchema } from "../src/content/schema/media-type"
 
 import { type CollectionEntry, getCollection } from "astro:content"
 

package/package.json

@@ -3,7 +3,7 @@
   "description": "LightNet makes it easy to run your own digital media library.",
   "type": "module",
   "license": "MIT",
-  "version": "4.0.8",
+  "version": "4.1.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/LightNetDev/lightnet",
@@ -51,8 +51,8 @@
     "tailwindcss": ">=3.4.0 <4.0.0"
   },
   "dependencies": {
-    "@astrojs/react": "^5.0.3",
-    "@iconify-json/lucide": "^1.2.102",
+    "@astrojs/react": "^5.0.4",
+    "@iconify-json/lucide": "^1.2.105",
     "@iconify-json/mdi": "^1.2.3",
     "@iconify/tailwind": "^1.2.0",
     "@tailwindcss/typography": "^0.5.19",
@@ -61,19 +61,19 @@
     "embla-carousel": "^8.6.0",
     "embla-carousel-wheel-gestures": "^8.1.0",
     "fuse.js": "^7.3.0",
-    "i18next": "^26.0.6",
-    "lucide-react": "^1.8.0",
-    "marked": "^18.0.2",
-    "postcss": "^8.5.10",
+    "i18next": "^26.0.8",
+    "lucide-react": "^1.14.0",
+    "marked": "^18.0.3",
+    "postcss": "^8.5.14",
     "postcss-load-config": "^6.0.1",
-    "yaml": "^2.8.3"
+    "yaml": "^2.8.4"
   },
   "devDependencies": {
     "@playwright/test": "^1.59.1",
     "@types/react": "^19.2.14",
-    "astro": "^6.1.8",
-    "typescript": "^5.9.3",
-    "vitest": "^4.1.4",
+    "astro": "^6.2.2",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.5",
     "@internal/e2e-test-utils": "^0.0.1"
   },
   "engines": {

package/src/astro-integration/config.ts

@@ -1,25 +1,9 @@
 import { z } from "astro/zod"
 
 import { isBcp47 } from "../i18n/bcp-47"
-import { validateInlineTranslations } from "./validators/validate-inline-translations"
+import { translationMapSchema } from "../i18n/translation-map-schema"
 import { validateLanguages } from "./validators/validate-languages"
 
-/**
- * Translations by BCP-47 tags.
- * We can only do basic validation here because we cannot access locales
- * from the same config.
- *
- * @example
- * {
- *   de: "Hallo",
- *   en: "Hello"
- * }
- */
-export const inlineTranslationSchema = z.record(
-  z.string(),
-  z.string().nonempty(),
-)
-
 /**
  * Link Schema.
  */
@@ -35,7 +19,7 @@ const linkSchema = z.object({
    * Must define a value for the default site locale.
    * Other configured site locales are optional.
    */
-  label: inlineTranslationSchema,
+  label: translationMapSchema,
   /**
    * If this is set to true the currentLocale will be appended to
    * the href path. Eg. for href="/about"
@@ -61,7 +45,7 @@ const languageSchema = z
     /**
      * Display name for this language.
      */
-    label: inlineTranslationSchema,
+    label: translationMapSchema,
     /**
      * Whether this language should be exposed as a site UI language.
      */
@@ -116,7 +100,7 @@ export const configSchema = z.object({
   /**
    * Title of the web site.
    */
-  title: inlineTranslationSchema,
+  title: translationMapSchema,
   /**
    * Languages supported by this site.
    */
@@ -129,6 +113,15 @@ export const configSchema = z.object({
    * Enable displaying a “Powered by LightNet” link in your site’s footer.
    */
   credits: z.boolean().default(false),
+  /**
+   * Optional localized text to display in your site's footer.
+   */
+  footerText: translationMapSchema.optional(),
+  /**
+   * Optional links to display in your site's footer.
+   */
+  footerLinks: z.array(linkSchema).optional(),
+
   /**
    * Link to manifest file within public/ folder
    */
@@ -151,7 +144,7 @@ export const configSchema = z.object({
        * Must define a value for the default site locale.
        * Other configured site locales are optional.
        */
-      alt: inlineTranslationSchema.optional(),
+      alt: translationMapSchema.optional(),
       /**
        * Size in px to use for the logo on the header bar.
        * The size will be applied to the shorter side of your logo image.
@@ -217,16 +210,13 @@ export const configSchema = z.object({
   experimental: z.object({}).optional(),
 })
 
-export const extendedConfigSchema = configSchema.transform((config, ctx) => {
+export const extendedConfigSchema = configSchema.transform((config) => {
   const locales = config.languages
     .filter((language) => language.isSiteLanguage)
     .map((language) => language.code)
   const defaultLocale =
     config.languages.find((language) => language.isDefaultSiteLanguage)?.code ??
     ""
-
-  validateInlineTranslations(config, locales, defaultLocale, ctx)
-
   return {
     ...config,
     locales,

package/src/components/CategoriesSection.astro

@@ -12,10 +12,10 @@ type Props = Omit<SectionProps, "maxWidth"> & {
 }
 
 const { title, layout = "carousel", ...props } = Astro.props
-const { t, tMap, currentLocale } = Astro.locals.i18n
+const { t, tContentField, currentLocale } = Astro.locals.i18n
 const resolvedTitle = title ?? t("ln.categories")
 
-const categories = await getUsedCategories(currentLocale, tMap)
+const categories = await getUsedCategories(currentLocale, tContentField)
 type Category = (typeof categories)[number]
 
 function getImage({ image, id }: Category) {

package/src/components/MediaGallerySection.astro

@@ -2,7 +2,7 @@
 import type { ImageMetadata } from "astro"
 import { Image } from "astro:assets"
 
-import { getMediaTypes } from "../content/get-media-types"
+import { getTranslatedMediaTypes } from "../content/get-media-types"
 import { detailsPagePath } from "../utils/paths"
 import CarouselSection from "./CarouselSection.astro"
 import CoverImageDecorator from "./CoverImageDecorator"
@@ -31,17 +31,12 @@ const {
   ...sectionProps
 } = Astro.props
 
-const { currentLocale, tMap } = Astro.locals.i18n
+const { currentLocale, tContentField } = Astro.locals.i18n
 
 const types = Object.fromEntries(
-  (await getMediaTypes()).map((type) => [
+  (await getTranslatedMediaTypes(currentLocale, tContentField)).map((type) => [
     type.id,
-    {
-      ...type.data,
-      labelText: tMap(type.data.label, {
-        path: ["media-types", type.id, "label"],
-      }),
-    },
+    type,
   ]),
 )
 

package/src/components/MediaList.astro

@@ -3,7 +3,7 @@ import type { ImageMetadata } from "astro"
 import { Image } from "astro:assets"
 import { ChevronRightIcon } from "lucide-react"
 
-import { getMediaTypes } from "../content/get-media-types"
+import { getTranslatedMediaTypes } from "../content/get-media-types"
 import { detailsPagePath } from "../utils/paths"
 import CoverImageDecorator from "./CoverImageDecorator"
 import Icon from "./Icon"
@@ -28,20 +28,20 @@ interface Props {
 // this is in the return type of getEntry
 const items = Astro.props.items.filter((item) => !!item)
 
-const { direction, currentLocale, tMap } = Astro.locals.i18n
+const { direction, currentLocale, tContentField } = Astro.locals.i18n
 
 const mediaTypes = Object.fromEntries(
-  (await getMediaTypes()).map((type) => [
-    type.id,
-    {
-      id: type.id,
-      labelText: tMap(type.data.label, {
-        path: ["media-types", type.id, "label"],
-      }),
-      icon: type.data.icon,
-      coverImageStyle: type.data.coverImageStyle,
-    },
-  ]),
+  (await getTranslatedMediaTypes(currentLocale, tContentField)).map(
+    ({ id, labelText, icon, coverImageStyle }) => [
+      id,
+      {
+        id,
+        labelText,
+        icon,
+        coverImageStyle,
+      },
+    ],
+  ),
 )
 const iconDirectionClass = direction === "rtl" ? "scale-x-[-1]" : ""
 ---

package/src/content/content-schema.ts

@@ -1,273 +1,10 @@
 import { glob } from "astro/loaders"
-import { z } from "astro/zod"
-import type { SchemaContext } from "astro:content"
-import { defineCollection, reference } from "astro:content"
+import { defineCollection } from "astro:content"
 
-import { imageSchema } from "./astro-image"
-
-/**
- * Translations by BCP-47 tag
- * Must contain at least one localized value.
- *
- * @example
- * {
- *    de: "Hallo",
- *    en: "Hello"
- * }
- */
-export const inlineTranslationSchema = z
-  .record(z.string(), z.string())
-  .refine((value) => Object.keys(value).length > 0, {
-    message: "Inline translations must contain at least one entry",
-  })
-
-/**
- * Category Schema
- */
-export const categorySchema = z.object({
-  /**
-   * Name of the category.
-   *
-   * Label translated for the default locale. Other configured site locales are optional.
-   */
-  label: inlineTranslationSchema,
-
-  /* Relative path to the thumbnail image of this category.
-   *
-   * The image is expected to be inside the `images` folder next to category definition json.
-   * It can have one of these file types: png, jpg, tiff, webp, gif, svg, avif.
-   * We suggest to give it a size of at least 1000px for it's longer side.
-   *
-   * @example "./images/devotionals.jpg"
-   */
-  image: imageSchema.optional(),
-})
-
-/**
- * Media Collection Schema
- */
-export const mediaCollectionSchema = z.object({
-  /**
-   * Name of the collection.
-   *
-   * Label translated for the default locale. Other configured site locales are optional.
-   */
-  label: inlineTranslationSchema,
-  /**
-   * Ordered list of media items included in this collection.
-   * The array order defines how items are shown when querying by collection.
-   *
-   * @example ["my-book--en", "my-video--en"]
-   */
-  mediaItems: z.array(reference("media")),
-})
-
-/**
- * Media Item Schema
- */
-export const mediaItemSchema = z.object({
-  /**
-   * Optional identifier used to link translated variants of a media item.
-   * If other media items share the same commonId they will show up as translations.
-   * If omitted, the media item is treated as standalone and has no translations.
-   * The common id will show up in the media item's url combined with it's language.
-   *
-   * We suggest you use the english name of the media item, all lower case, words separated with hyphens.
-   *
-   * @example "a-book-about-love"
-   */
-  commonId: z.string().optional(),
-  /**
-   * Title of this media item.
-   * This is expected to be in the language that is defined by the 'language' property.
-   *
-   * @example "A book about love"
-   */
-  title: z.string(),
-  /**
-   * References one media-type by its filename without .json suffix.
-   *
-   * @example "book"
-   */
-  type: reference("media-types"),
-  /**
-   *Describes this media item. You can use markdown syntax to add formatting.
-   * This is expected to be in the language that is defined by the 'language' property.
-   *
-   * @example "This is a book about **love**..."
-   */
-  description: z.string().optional(),
-  /**
-   * List of authors of this media item.
-   *
-   * @example ["George Miller", "Timothy Meier"]
-   */
-  authors: z.array(z.string()).nullish(),
-  /**
-   * Date this media item has been created on this lightnet instance.
-   * Format is YYYY-MM-DD
-   *
-   * @example 2024-09-10
-   */
-  dateCreated: z.iso.date(),
-  /**
-   * List of categories of this media item.
-   *
-   * @example ["family"]
-   */
-  categories: z.array(reference("categories")).nullish(),
-  /**
-   * BCP-47 language code of this media item.
-   *
-   * @example "en"
-   */
-  language: z.string().nonempty(),
-  /**
-   * Relative path to the image of this media item. Eg. a book cover or video thumbnail.
-   *
-   * The image is expected to be inside the `images` folder next to the media item definition json.
-   * This image will be used for previews and on the media item detail page.
-   * It can have one of these file types: png, jpg, tiff, webp, gif, svg, avif.
-   * We suggest to give it a size of at least 1000px for it's longer side.
-   *
-   * @example "./images/a-book-about-love--en.jpg"
-   */
-  image: imageSchema,
-  /**
-   * List of objects defining the content of this media item.
-   */
-  content: z
-    .array(
-      z.object({
-        /**
-         * Storage kind for this content item.
-         *
-         * - `"upload"`: a file managed by this LightNet site (typically a relative path like `/files/...`)
-         * - `"link"`: an external URL (typically `https://...`)
-         *
-         * @example "upload"
-         */
-        type: z.enum(["upload", "link"]),
-        /**
-         * Urls might be:
-         * - links to youtube videos
-         * - links to vimeo videos
-         * - links to .mp4 video files
-         * - links to .mp3 audio files
-         * - links to external websites
-         * - links to pdfs (might be hosted inside the public/files/ folder)
-         * - links to epubs (might be hosted inside the public/files/ folder)
-         *
-         * @example "/files/a-book-about-love.pdf"
-         */
-        url: z.string(),
-        /**
-         * The name of the content translated for the default locale.
-         * Other configured site locales are optional.
-         * If this is not set, the file name from URL will be used.
-         */
-        label: inlineTranslationSchema.optional(),
-      }),
-    )
-    .min(1),
-})
-
-/**
- * MediaItemSchema above defines the shape of a media item.
- * We need this function to accept the astro content's image function that
- * is available inside defineCollection.
- *
- * @param schemaContext that is passed by astro's defineCollection schema.
- * @returns schema with image mixed in.
- */
-export const createMediaItemSchema = ({ image }: SchemaContext) =>
-  mediaItemSchema.extend({
-    image: image(),
-  })
-
-export const createCategorySchema = ({ image }: SchemaContext) =>
-  categorySchema.extend({
-    image: image().optional(),
-  })
-
-/**
- * Media Type Schema
- */
-export const mediaTypeSchema = z.object({
-  /**
-   * Name of this media type that will be shown on the pages.
-   *
-   * Label translated for the default locale. Other configured site locales are optional.
-   */
-  label: inlineTranslationSchema,
-  /**
-   * Defines how the cover image for a media item of this type is rendered.
-   *
-   * Options:
-   * - `"default"` — Renders the media item image with no modifications.
-   * - `"book"` — Adds a book fold effect and sharper edges, styled like a book cover.
-   * - `"video"` — Constrains the image to a 16:9 aspect ratio with a black background.
-   *
-   * @default "default"
-   */
-  coverImageStyle: z.enum(["default", "book", "video"]).default("default"),
-  /**
-   * What media item details page to use for media items with this type.
-   *
-   */
-  detailsPage: z
-    .discriminatedUnion("layout", [
-      z.object({
-        /**
-         * Details page for all media types.
-         */
-        layout: z.literal("default"),
-        /**
-         * Label for the open action button. Use this if you want to change the text
-         * of the "Open" button to be more matching to your media item.
-         * For example you could change the text to be "Read" for a book media type.
-         *
-         * Label translated for the default locale. Other configured site locales are optional.
-         */
-        openActionLabel: inlineTranslationSchema.optional(),
-      }),
-      z.object({
-        /**
-         * Custom details page.
-         */
-        layout: z.literal("custom"),
-        /**
-         * This references a custom component name to be used for the
-         * details page. The custom component has be located at src/details-pages/
-         *
-         * @example "MyArticleDetails.astro"
-         */
-        customComponent: z.string(),
-      }),
-      z.object({
-        /**
-         * Detail page for videos.
-         */
-        layout: z.literal("video"),
-      }),
-      z.object({
-        /**
-         * Detail page for audio files.
-         *
-         * This only supports mp3 files.
-         */
-        layout: z.literal("audio"),
-      }),
-    ])
-    .optional(),
-  /**
-   * Pick the media type's icon from https://lucide.dev/icons/
-   * Prefix it's name with "lucide--"
-   *
-   * @example "lucide--book-open"
-   */
-  icon: z.string(),
-})
+import { createCategorySchema } from "./schema/category"
+import { mediaCollectionSchema } from "./schema/media-collection"
+import { createMediaItemSchema } from "./schema/media-item"
+import { mediaTypeSchema } from "./schema/media-type"
 
 export const LIGHTNET_COLLECTIONS = {
   categories: defineCollection({
@@ -296,27 +33,3 @@ export const LIGHTNET_COLLECTIONS = {
     schema: mediaTypeSchema,
   }),
 }
-
-export const mediaItemEntrySchema = z.object({
-  id: z.string(),
-  data: mediaItemSchema,
-})
-
-export type MediaItemEntry = z.infer<typeof mediaItemEntrySchema>
-
-export const mediaTypeEntrySchema = z.object({
-  id: z.string(),
-  data: mediaTypeSchema,
-})
-
-export const categoryEntrySchema = z.object({
-  id: z.string(),
-  data: categorySchema,
-})
-
-export const mediaCollectionEntrySchema = z.object({
-  id: z.string(),
-  data: mediaCollectionSchema,
-})
-
-export type MediaCollectionEntry = z.infer<typeof mediaCollectionEntrySchema>

package/src/content/get-categories.ts

@@ -1,34 +1,34 @@
 import { AstroError } from "astro/errors"
 import { getCollection } from "astro:content"
 
-import type { TranslateMapFn } from "../i18n/translate-map"
+import type { TranslateContentFieldFn } from "../i18n/translate-map"
 import { lazy } from "../utils/lazy"
 import { verifySchemaAsync } from "../utils/verify-schema"
-import { categoryEntrySchema } from "./content-schema"
 import { getMediaItems } from "./get-media-items"
+import { categoryEntrySchema } from "./schema/category"
 
 const categoriesById = lazy(async () =>
   Object.fromEntries(
-    (await loadCategories()).map(({ id, data }) => [id, data]),
+    (await loadCategories()).map((category) => [category.id, category]),
   ),
 )
 
-const contentCategories = lazy(async () => {
+const contentCategoryIds = lazy(async () => {
   const categories = await categoriesById.get()
-  return Object.fromEntries(
+  return new Set<string>(
     (await getMediaItems())
       .flatMap((item) => item.data.categories ?? [])
-      .map((c) => {
-        const category = categories[c.id]
+      .map(({ id }) => {
+        const category = categories[id]
         if (!category) {
           throw new AstroError(
             "Missing Category",
-            `A media item references a non-existent category: "${c.id}".\n` +
+            `A media item references a non-existent category: "${id}".\n` +
               `To fix this, create a category file at:\n` +
-              `src/content/categories/${c.id}.json`,
+              `src/content/categories/${id}.json`,
           )
         }
-        return [c.id, category]
+        return id
       }),
   )
 })
@@ -42,18 +42,13 @@ const contentCategories = lazy(async () => {
  */
 export async function getUsedCategories(
   currentLocale: string,
-  tMap: TranslateMapFn,
+  tContentField: TranslateContentFieldFn,
 ) {
-  const categories = await contentCategories.get()
-  return [...Object.entries(categories)]
-    .map(([id, data]) => ({
-      id,
-      ...data,
-      labelText: tMap(data.label, {
-        path: ["categories", id, "label"],
-      }),
-    }))
-    .sort((a, b) => a.labelText.localeCompare(b.labelText, currentLocale))
+  const usedIds = await contentCategoryIds.get()
+  // we intentionally translate all categories because we want
+  // to record translations also for unreferenced categories
+  const categories = await getCategories(currentLocale, tContentField)
+  return categories.filter(({ id }) => usedIds.has(id))
 }
 
 /**
@@ -66,21 +61,22 @@ export async function getUsedCategories(
  */
 export async function getCategories(
   currentLocale: string,
-  tMap: TranslateMapFn,
+  tContentField: TranslateContentFieldFn,
 ) {
   const categories = await categoriesById.get()
   return [...Object.entries(categories)]
-    .map(([id, data]) => ({
+    .map(([id, category]) => ({
       id,
-      ...data,
-      labelText: tMap(data.label, {
-        path: ["categories", id, "label"],
-      }),
+      ...category.data,
+      labelText: tContentField(category.data.label, category),
     }))
     .sort((a, b) => a.labelText.localeCompare(b.labelText, currentLocale))
 }
 
-export async function getCategory(id: string) {
+export async function getCategory(
+  id: string,
+  tContentField: TranslateContentFieldFn,
+) {
   const category = (await categoriesById.get())[id]
   if (!category) {
     throw new AstroError(
@@ -90,7 +86,8 @@ export async function getCategory(id: string) {
   }
   return {
     id,
-    ...category,
+    ...category.data,
+    labelText: tContentField(category.data.label, category),
   }
 }