lightnet 3.1.2 → 3.3.0

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # lightnet
 
+## 3.3.0
+
+### Minor Changes
+
+- [#250](https://github.com/LightNetDev/LightNet/pull/250) [`bc728aa`](https://github.com/LightNetDev/LightNet/commit/bc728aae93cdba4383167488536e5c6ab3654523) Thanks [@smn-cds](https://github.com/smn-cds)! - Introduce DetailsPage wrapper component
+
+  ‼️ BREAKING CHANGE on experimental custom details page API.
+
+  With this change all custom details pages need to be wrapped by
+  a `DetailsPage` component. This component is exported by `@lightnet/experimental-details-page`.
+  Previously custom details pages were automatically wrapped by LightNet.
+
+  This is how to create a custom details page:
+
+  ```astro
+  ---
+  import { DetailsPage } from "@lightNet/experimental-details-page"
+  type Props = {
+    mediaId
+  }
+  ---
+
+  <DetailsPage mediaId={Astro.props.mediaId}>
+    {/* Your custom details page components go here */}
+  </DetailsPage>
+  ```
+
+## 3.2.0
+
+### Minor Changes
+
+- [#246](https://github.com/LightNetDev/LightNet/pull/246) [`7c59151`](https://github.com/LightNetDev/LightNet/commit/7c59151a0d2eb698eff9891d0ba780ab29a6efe5) Thanks [@smn-cds](https://github.com/smn-cds)! - Add config option to set a footer component.
+
 ## 3.1.2
 
 ### Patch Changes

package/__e2e__/fixtures/basics/node_modules/.bin/astro

@@ -6,9 +6,9 @@ case `uname` in
 esac
 
 if [ -z "$NODE_PATH" ]; then
-  export NODE_PATH="/home/runner/work/LightNet/LightNet/node_modules/.pnpm/astro@5.6.0_@types+node@22.14.0_jiti@2.4.2_lightningcss@1.29.1_rollup@4.39.0_terser@5.39.0_typescript@5.8.2_yaml@2.7.1/node_modules/astro/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/astro@5.6.0_@types+node@22.14.0_jiti@2.4.2_lightningcss@1.29.1_rollup@4.39.0_terser@5.39.0_typescript@5.8.2_yaml@2.7.1/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/node_modules"
+  export NODE_PATH="/home/runner/work/LightNet/LightNet/node_modules/.pnpm/astro@5.6.1_@types+node@22.14.0_jiti@2.4.2_lightningcss@1.29.1_rollup@4.39.0_terser@5.39.0_typescript@5.8.3_yaml@2.7.1/node_modules/astro/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/astro@5.6.1_@types+node@22.14.0_jiti@2.4.2_lightningcss@1.29.1_rollup@4.39.0_terser@5.39.0_typescript@5.8.3_yaml@2.7.1/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/node_modules"
 else
-  export NODE_PATH="/home/runner/work/LightNet/LightNet/node_modules/.pnpm/astro@5.6.0_@types+node@22.14.0_jiti@2.4.2_lightningcss@1.29.1_rollup@4.39.0_terser@5.39.0_typescript@5.8.2_yaml@2.7.1/node_modules/astro/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/astro@5.6.0_@types+node@22.14.0_jiti@2.4.2_lightningcss@1.29.1_rollup@4.39.0_terser@5.39.0_typescript@5.8.2_yaml@2.7.1/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/node_modules:$NODE_PATH"
+  export NODE_PATH="/home/runner/work/LightNet/LightNet/node_modules/.pnpm/astro@5.6.1_@types+node@22.14.0_jiti@2.4.2_lightningcss@1.29.1_rollup@4.39.0_terser@5.39.0_typescript@5.8.3_yaml@2.7.1/node_modules/astro/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/astro@5.6.1_@types+node@22.14.0_jiti@2.4.2_lightningcss@1.29.1_rollup@4.39.0_terser@5.39.0_typescript@5.8.3_yaml@2.7.1/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/node_modules:$NODE_PATH"
 fi
 if [ -x "$basedir/node" ]; then
   exec "$basedir/node"  "$basedir/../astro/astro.js" "$@"

package/__e2e__/fixtures/basics/node_modules/.bin/tsc

@@ -6,9 +6,9 @@ case `uname` in
 esac
 
 if [ -z "$NODE_PATH" ]; then
-  export NODE_PATH="/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/bin/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.2/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/node_modules"
+  export NODE_PATH="/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/bin/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.3/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/node_modules"
 else
-  export NODE_PATH="/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/bin/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.2/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/node_modules:$NODE_PATH"
+  export NODE_PATH="/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/bin/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.3/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/node_modules:$NODE_PATH"
 fi
 if [ -x "$basedir/node" ]; then
   exec "$basedir/node"  "$basedir/../typescript/bin/tsc" "$@"

package/__e2e__/fixtures/basics/node_modules/.bin/tsserver

@@ -6,9 +6,9 @@ case `uname` in
 esac
 
 if [ -z "$NODE_PATH" ]; then
-  export NODE_PATH="/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/bin/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.2/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/node_modules"
+  export NODE_PATH="/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/bin/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.3/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/node_modules"
 else
-  export NODE_PATH="/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/bin/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.2/node_modules/typescript/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.2/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/node_modules:$NODE_PATH"
+  export NODE_PATH="/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/bin/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/typescript@5.8.3/node_modules:/home/runner/work/LightNet/LightNet/node_modules/.pnpm/node_modules:$NODE_PATH"
 fi
 if [ -x "$basedir/node" ]; then
   exec "$basedir/node"  "$basedir/../typescript/bin/tsserver" "$@"

package/__e2e__/fixtures/basics/package.json

@@ -7,12 +7,12 @@
     "@astrojs/react": "^4.2.3",
     "@astrojs/tailwind": "^6.0.2",
     "@lightnet/decap-admin": "^3.1.0",
-    "astro": "^5.6.0",
-    "lightnet": "^3.1.1",
+    "astro": "^5.6.1",
+    "lightnet": "^3.3.0",
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
     "sharp": "^0.33.5",
     "tailwindcss": "^3.4.17",
-    "typescript": "^5.8.2"
+    "typescript": "^5.8.3"
   }
 }

package/exports/details-page.ts

@@ -4,6 +4,7 @@
  */
 export { default as ContentSection } from "../src/pages/details-page/components/ContentSection.astro"
 export { default as DescriptionSection } from "../src/pages/details-page/components/DescriptionSection.astro"
+export { default as DetailsPage } from "../src/pages/details-page/components/DetailsPage.astro"
 export { default as OpenButton } from "../src/pages/details-page/components/main-details/OpenButton.astro"
 export { default as ShareButton } from "../src/pages/details-page/components/main-details/ShareButton.astro"
 export { default as MainDetailsSection } from "../src/pages/details-page/components/MainDetailsSection.astro"

package/package.json

@@ -2,7 +2,7 @@
   "name": "lightnet",
   "type": "module",
   "license": "MIT",
-  "version": "3.1.2",
+  "version": "3.3.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/LightNetDev/lightnet",
@@ -25,10 +25,10 @@
     "./locals": "./src/i18n/locals.ts",
     "./tailwind.config.ts": "./tailwind.config.ts",
     "./layouts/MarkdownPage.astro": "./src/layouts/MarkdownPage.astro",
-    "./pages/404.astro": "./src/pages/404.astro",
-    "./pages/RedirectToDefaultLocale.astro": "./src/pages/RedirectToDefaultLocale.astro",
-    "./pages/SearchPage.astro": "./src/pages/search-page/SearchPage.astro",
-    "./pages/DetailsPage.astro": "./src/pages/details-page/DetailsPage.astro",
+    "./pages/404Route.astro": "./src/pages/404Route.astro",
+    "./pages/RootRoute.astro": "./src/pages/RootRoute.astro",
+    "./pages/SearchPageRoute.astro": "./src/pages/search-page/SearchPageRoute.astro",
+    "./pages/DetailsPageRoute.astro": "./src/pages/details-page/DetailsPageRoute.astro",
     "./pages/api/search.ts": "./src/pages/api/search.ts"
   },
   "peerDependencies": {

package/src/astro-integration/config.ts

@@ -180,12 +180,18 @@ export const configSchema = z.object({
    */
   internalDomains: z.array(z.string()).default([]),
   /**
-   * Path to an Astro component to be added to the HTML head element of all pages.
+   * Path to an Astro component to be added into the HTML head element of all pages.
    * For example use this if you need to add an analytics script to every page.
    *
    * @example "./src/components/MyHeadTag.astro"
    */
   headComponent: z.string().optional(),
+  /**
+   * Path to an Astro component to be added at the bottom of all pages.
+   *
+   * @example "./src/components/MyFooter.astro"
+   */
+  footerComponent: z.string().optional(),
   /**
    * Configure search page behavior
    */

package/src/astro-integration/integration.ts

@@ -28,19 +28,19 @@ export function lightnet(lightnetConfig: LightnetConfig): AstroIntegration {
 
         injectRoute({
           pattern: "404",
-          entrypoint: "lightnet/pages/404.astro",
+          entrypoint: "lightnet/pages/404Route.astro",
           prerender: true,
         })
 
         injectRoute({
           pattern: "",
-          entrypoint: "lightnet/pages/RedirectToDefaultLocale.astro",
+          entrypoint: "lightnet/pages/RootRoute.astro",
           prerender: true,
         })
 
         injectRoute({
           pattern: "/[locale]/media",
-          entrypoint: "lightnet/pages/SearchPage.astro",
+          entrypoint: "lightnet/pages/SearchPageRoute.astro",
           prerender: true,
         })
 
@@ -52,7 +52,7 @@ export function lightnet(lightnetConfig: LightnetConfig): AstroIntegration {
 
         injectRoute({
           pattern: "/[locale]/media/[mediaId]",
-          entrypoint: "lightnet/pages/DetailsPage.astro",
+          entrypoint: "lightnet/pages/DetailsPageRoute.astro",
           prerender: true,
         })
 

package/src/astro-integration/virtual.d.ts

@@ -13,7 +13,12 @@ declare module "virtual:lightnet/project-context" {
   export default context
 }
 
-declare module "virtual:lightnet/components/CustomHeadComponent" {
-  const CustomHeadComponent: ((props: Record<string, any>) => any) | undefined
-  export default CustomHeadComponent
+declare module "virtual:lightnet/components/CustomHead" {
+  const CustomHead: ((props: Record<string, any>) => any) | undefined
+  export default CustomHead
+}
+
+declare module "virtual:lightnet/components/CustomFooter" {
+  const CustomFooter: ((props: Record<string, any>) => any) | undefined
+  export default CustomFooter
 }

package/src/astro-integration/vite-plugin-lightnet-config.ts

@@ -8,13 +8,15 @@ import { type LightnetConfig } from "./config"
 const CONFIG = "virtual:lightnet/config"
 const LOGO = "virtual:lightnet/logo"
 const PROJECT_CONTEXT = "virtual:lightnet/project-context"
-const CUSTOM_HEAD_COMPONENT = "virtual:lightnet/components/CustomHeadComponent"
+const CUSTOM_HEAD = "virtual:lightnet/components/CustomHead"
+const CUSTOM_FOOTER = "virtual:lightnet/components/CustomFooter"
 
 const VIRTUAL_MODULES = [
   CONFIG,
   LOGO,
   PROJECT_CONTEXT,
-  CUSTOM_HEAD_COMPONENT,
+  CUSTOM_HEAD,
+  CUSTOM_FOOTER,
 ] as const
 
 export function vitePluginLightnetConfig(
@@ -52,10 +54,14 @@ export function vitePluginLightnetConfig(
             : "export default undefined;"
         case PROJECT_CONTEXT:
           return `export default ${JSON.stringify({ root, srcDir, site })}`
-        case CUSTOM_HEAD_COMPONENT:
+        case CUSTOM_HEAD:
           return config.headComponent
             ? `export { default } from ${resolveFilePath(config.headComponent)};`
             : "export default undefined;"
+        case CUSTOM_FOOTER:
+          return config.footerComponent
+            ? `export { default } from ${resolveFilePath(config.footerComponent)};`
+            : "export default undefined;"
       }
     },
   }

package/src/layouts/Page.astro

@@ -1,6 +1,7 @@
 ---
 import { ClientRouter } from "astro:transitions"
-import CustomHeadComponent from "virtual:lightnet/components/CustomHeadComponent"
+import CustomFooter from "virtual:lightnet/components/CustomFooter"
+import CustomHead from "virtual:lightnet/components/CustomHead"
 import config from "virtual:lightnet/config"
 
 import { resolveLanguage } from "../i18n/resolve-language"
@@ -26,7 +27,7 @@ const language = resolveLanguage(currentLocale)
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    {CustomHeadComponent && <CustomHeadComponent />}
+    {CustomHead && <CustomHead />}
     <title>{title ? `${title} | ${configTitle}` : configTitle}</title>
     {description && <meta name="description" content={description} />}
     {config.manifest && <link rel="manifest" href={config.manifest} />}
@@ -34,7 +35,9 @@ const language = resolveLanguage(currentLocale)
     <Favicon />
     <ClientRouter />
   </head>
-  <body class="overflow-y-scroll bg-gray-50 text-gray-900">
+  <body
+    class="flex min-h-screen flex-col overflow-y-scroll bg-gray-50 text-gray-900"
+  >
     <header
       class="fixed top-0 z-50 h-14 w-full bg-white shadow-lg sm:h-20"
       transition:animate="none"
@@ -46,9 +49,10 @@ const language = resolveLanguage(currentLocale)
         <PageNavigation />
       </div>
     </header>
-    <main class="mx-auto min-h-screen pb-8 pt-14 sm:py-20">
+    <main class="grow pb-8 pt-14 sm:py-20">
       <slot />
     </main>
+    {CustomFooter && <CustomFooter />}
     <PreloadReact client:idle />
   </body>
 </html>

package/src/pages/details-page/AudioDetailsPage.astro

@@ -2,6 +2,7 @@
 import { getMediaItem } from "../../content/get-media-items"
 import ContentSection from "./components/ContentSection.astro"
 import DescriptionSection from "./components/DescriptionSection.astro"
+import DetailsPage from "./components/DetailsPage.astro"
 import AudioPlayer from "./components/main-details/AudioPlayer.astro"
 import ShareButton from "./components/main-details/ShareButton.astro"
 import MainDetailsSection from "./components/MainDetailsSection.astro"
@@ -16,11 +17,13 @@ const { mediaId } = Astro.props
 const audioSrc = (await getMediaItem(mediaId)).data.content[0].url
 ---
 
-<MainDetailsSection mediaId={mediaId}>
-  <AudioPlayer src={audioSrc} className="mt-10 w-full" />
-  <ShareButton className="mt-4 min-w-40" />
-</MainDetailsSection>
-<DescriptionSection mediaId={mediaId} />
-<ContentSection mediaId={mediaId} />
-<MediaCollectionsSection mediaId={mediaId} />
-<MoreDetailsSection mediaId={mediaId} />
+<DetailsPage mediaId={mediaId}>
+  <MainDetailsSection mediaId={mediaId}>
+    <AudioPlayer src={audioSrc} className="mt-10 w-full" />
+    <ShareButton className="mt-4 min-w-40" />
+  </MainDetailsSection>
+  <DescriptionSection mediaId={mediaId} />
+  <ContentSection mediaId={mediaId} />
+  <MediaCollectionsSection mediaId={mediaId} />
+  <MoreDetailsSection mediaId={mediaId} />
+</DetailsPage>

package/src/pages/details-page/DefaultDetailsPage.astro

@@ -1,6 +1,7 @@
 ---
 import ContentSection from "./components/ContentSection.astro"
 import DescriptionSection from "./components/DescriptionSection.astro"
+import DetailsPage from "./components/DetailsPage.astro"
 import OpenButton from "./components/main-details/OpenButton.astro"
 import ShareButton from "./components/main-details/ShareButton.astro"
 import MainDetailsSection from "./components/MainDetailsSection.astro"
@@ -16,13 +17,15 @@ export type Props = {
 const { mediaId, coverStyle, openActionLabel = "ln.details.open" } = Astro.props
 ---
 
-<MainDetailsSection mediaId={mediaId} coverStyle={coverStyle}>
-  <div class="mt-10 flex flex-col justify-center gap-4 sm:justify-start">
-    <OpenButton mediaId={mediaId} openActionLabel={openActionLabel} />
-    <ShareButton />
-  </div>
-</MainDetailsSection>
-<DescriptionSection mediaId={mediaId} />
-<ContentSection mediaId={mediaId} />
-<MediaCollectionsSection mediaId={mediaId} />
-<MoreDetailsSection mediaId={mediaId} />
+<DetailsPage mediaId={mediaId}>
+  <MainDetailsSection mediaId={mediaId} coverStyle={coverStyle}>
+    <div class="mt-10 flex flex-col justify-center gap-4 sm:justify-start">
+      <OpenButton mediaId={mediaId} openActionLabel={openActionLabel} />
+      <ShareButton />
+    </div>
+  </MainDetailsSection>
+  <DescriptionSection mediaId={mediaId} />
+  <ContentSection mediaId={mediaId} />
+  <MediaCollectionsSection mediaId={mediaId} />
+  <MoreDetailsSection mediaId={mediaId} />
+</DetailsPage>

package/src/pages/details-page/{DetailsPage.astro → DetailsPageRoute.astro}

@@ -6,8 +6,6 @@ import config from "virtual:lightnet/config"
 import { getMediaItem, getMediaItems } from "../../content/get-media-items"
 import { getMediaType } from "../../content/get-media-types"
 import { resolveLocales } from "../../i18n/resolve-locales"
-import Page from "../../layouts/Page.astro"
-import { markdownToText } from "../../utils/markdown"
 import AudioDetailsPage from "./AudioDetailsPage.astro"
 import DefaultDetailsPage from "./DefaultDetailsPage.astro"
 import VideoDetailsPage from "./VideoDetailsPage.astro"
@@ -43,24 +41,11 @@ if (detailsPage?.layout === "custom") {
 }
 ---
 
-<Page
-  title={mediaItem.title}
-  description={markdownToText(mediaItem.description)}
->
-  {
-    layout === "default" && (
-      <DefaultDetailsPage mediaId={mediaId} {...detailsPage} />
-    )
-  }
-  {
-    layout === "video" && (
-      <VideoDetailsPage mediaId={mediaId} {...detailsPage} />
-    )
-  }
-  {
-    layout === "audio" && (
-      <AudioDetailsPage mediaId={mediaId} {...detailsPage} />
-    )
-  }
-  {CustomDetails && <CustomDetails mediaId={mediaId} {...detailsPage} />}
-</Page>
+{
+  layout === "default" && (
+    <DefaultDetailsPage mediaId={mediaId} {...detailsPage} />
+  )
+}
+{layout === "video" && <VideoDetailsPage mediaId={mediaId} {...detailsPage} />}
+{layout === "audio" && <AudioDetailsPage mediaId={mediaId} {...detailsPage} />}
+{CustomDetails && <CustomDetails mediaId={mediaId} {...detailsPage} />}

package/src/pages/details-page/VideoDetailsPage.astro

@@ -1,6 +1,7 @@
 ---
 import ContentSection from "./components/ContentSection.astro"
 import DescriptionSection from "./components/DescriptionSection.astro"
+import DetailsPage from "./components/DetailsPage.astro"
 import MediaCollectionsSection from "./components/MediaCollectionsSection.astro"
 import MoreDetailsSection from "./components/MoreDetailsSection.astro"
 import VideoDetailsSection from "./components/VideoDetailsSection.astro"
@@ -12,8 +13,10 @@ export type Props = {
 const { mediaId } = Astro.props
 ---
 
-<VideoDetailsSection mediaId={mediaId} />
-<DescriptionSection mediaId={mediaId} />
-<ContentSection mediaId={mediaId} />
-<MediaCollectionsSection mediaId={mediaId} />
-<MoreDetailsSection mediaId={mediaId} />
+<DetailsPage mediaId={mediaId}>
+  <VideoDetailsSection mediaId={mediaId} />
+  <DescriptionSection mediaId={mediaId} />
+  <ContentSection mediaId={mediaId} />
+  <MediaCollectionsSection mediaId={mediaId} />
+  <MoreDetailsSection mediaId={mediaId} />
+</DetailsPage>

package/src/pages/details-page/components/DetailsPage.astro

@@ -0,0 +1,18 @@
+---
+import { getMediaItem } from "../../../content/get-media-items"
+import Page from "../../../layouts/Page.astro"
+import { markdownToText } from "../../../utils/markdown"
+
+type Props = {
+  mediaId: string
+}
+
+const mediaItem = (await getMediaItem(Astro.props.mediaId)).data
+---
+
+<Page
+  title={mediaItem.title}
+  description={markdownToText(mediaItem.description)}
+>
+  <slot />
+</Page>