livemark 0.18.0 → 0.20.0

package/source/helpers/section.unit.ts

@@ -1,5 +1,8 @@
 import { describe, expect, it } from "vite-plus/test"
+import type { Section } from "../models/section.ts"
 import {
+  activeSiteLink,
+  activeSiteSection,
   customSectionActive,
   matchSection,
   partitionBySection,
@@ -111,3 +114,111 @@ describe("customSectionActive", () => {
     expect(customSectionActive("/about#top", "/about/team/")).toBe(true)
   })
 })
+
+describe("activeSiteSection", () => {
+  const docs: Section = {
+    type: "article",
+    title: "Docs",
+    prefix: "/",
+    position: "header",
+  }
+  const blog: Section = {
+    type: "blog",
+    title: "Blog",
+    prefix: "/blog/",
+    position: "header",
+  }
+  const apiCustom: Section = {
+    type: "custom",
+    title: "API",
+    url: "/api/v2",
+    position: "header",
+  }
+  const githubCustom: Section = {
+    type: "custom",
+    title: "GitHub",
+    url: "https://github.com/example/repo",
+    position: "header",
+  }
+  const homeCustom: Section = {
+    type: "custom",
+    title: "Home",
+    url: "/",
+    position: "header",
+  }
+
+  it("should return the routed section matching by prefix", () => {
+    expect(activeSiteSection("/blog/post/", [docs, blog])?.title).toBe("Blog")
+  })
+
+  it("should return the custom section matching by internal url", () => {
+    expect(activeSiteSection("/api/v2/users/", [docs, apiCustom])?.title).toBe(
+      "API",
+    )
+  })
+
+  it("should pick the longest match among overlapping prefixes", () => {
+    expect(activeSiteSection("/blog/post/", [docs, blog])?.title).toBe("Blog")
+    expect(activeSiteSection("/api/v2/foo/", [docs, apiCustom])?.title).toBe(
+      "API",
+    )
+  })
+
+  it("should ignore custom sections with absolute URLs", () => {
+    expect(activeSiteSection("/anything/", [githubCustom])).toBeUndefined()
+  })
+
+  it("should match custom URL `/` only on the home page", () => {
+    expect(activeSiteSection("/", [homeCustom])?.title).toBe("Home")
+    expect(activeSiteSection("/about/", [homeCustom])).toBeUndefined()
+  })
+
+  it("should let routed `/` match descendants while custom `/` does not", () => {
+    expect(activeSiteSection("/about/", [docs, homeCustom])?.title).toBe("Docs")
+  })
+
+  it("should return undefined when no section matches", () => {
+    expect(activeSiteSection("/anything/", [blog, apiCustom])).toBeUndefined()
+  })
+})
+
+describe("activeSiteLink", () => {
+  const docs: Section = {
+    type: "article",
+    title: "Docs",
+    prefix: "/",
+    position: "header",
+  }
+  const blog: Section = {
+    type: "blog",
+    title: "Blog",
+    prefix: "/blog/",
+    position: "header",
+    siteLink: "/blog/",
+  }
+  const externalCustom: Section = {
+    type: "custom",
+    title: "GitHub",
+    url: "/github",
+    position: "header",
+    siteLink: "https://github.com/example/repo",
+  }
+
+  it("should default to '/' when no section matches", () => {
+    expect(activeSiteLink("/anything/", [blog])).toBe("/")
+  })
+
+  it("should default to '/' when matching section has no siteLink", () => {
+    expect(activeSiteLink("/about/", [docs])).toBe("/")
+  })
+
+  it("should return the matching section's siteLink", () => {
+    expect(activeSiteLink("/blog/post/", [blog])).toBe("/blog/")
+  })
+
+  it("should support absolute URLs as the siteLink", () => {
+    expect(activeSiteLink("/github/", [externalCustom])).toBe(
+      "https://github.com/example/repo",
+    )
+  })
+})

package/source/models/section.ts

@@ -4,6 +4,9 @@ const BaseSection = z.object({
   icon: z.string().optional(),
   title: z.string(),
   position: z.enum(["header", "sidebar"]).default("header"),
+  siteTitle: z.string().optional(),
+  siteDescription: z.string().optional(),
+  siteLink: z.string().optional(),
 })
 
 /** Default section: renders articles. */