@kamod-ch/preactpress 1.0.0 → 1.0.3

package/src/client/useSiteSearch.ts

@@ -1,57 +1,57 @@
-import { useEffect, useMemo, useState } from 'preact/hooks'
-import { publicUrl } from '../shared/url.js'
+import { useEffect, useMemo, useState } from "preact/hooks";
+import { publicUrl } from "../shared/url.js";
 
 export interface SearchEntry {
-  route: string
-  locale?: string
-  title?: string
-  description?: string
-  excerpt?: string
-  tags?: string[]
+  route: string;
+  locale?: string;
+  title?: string;
+  description?: string;
+  excerpt?: string;
+  tags?: string[];
 }
 
 export function useSiteSearch(base: string, query: string, locale?: string): SearchEntry[] {
-  const [entries, setEntries] = useState<SearchEntry[]>([])
+  const [entries, setEntries] = useState<SearchEntry[]>([]);
 
   useEffect(() => {
-    let cancelled = false
-    fetch(publicUrl(base, 'preactpress-search.json'), { credentials: 'same-origin' })
-      .then((res) => res.ok ? res.json() : [])
+    let cancelled = false;
+    fetch(publicUrl(base, "preactpress-search.json"), { credentials: "same-origin" })
+      .then((res) => (res.ok ? res.json() : []))
       .then((data) => {
-        if (!cancelled && Array.isArray(data)) setEntries(data as SearchEntry[])
+        if (!cancelled && Array.isArray(data)) setEntries(data as SearchEntry[]);
       })
       .catch(() => {
-        if (!cancelled) setEntries([])
-      })
+        if (!cancelled) setEntries([]);
+      });
     return () => {
-      cancelled = true
-    }
-  }, [base])
+      cancelled = true;
+    };
+  }, [base]);
 
   return useMemo(() => {
-    const needle = query.trim().toLowerCase()
-    if (!needle) return []
+    const needle = query.trim().toLowerCase();
+    if (!needle) return [];
     return entries
       .filter((entry) => !locale || entry.locale === locale)
       .map((entry) => ({ entry, score: scoreEntry(entry, needle) }))
       .filter(({ score }) => score > 0)
       .sort((a, b) => b.score - a.score)
       .slice(0, 8)
-      .map(({ entry }) => entry)
-  }, [entries, locale, query])
+      .map(({ entry }) => entry);
+  }, [entries, locale, query]);
 }
 
 function scoreEntry(entry: SearchEntry, query: string): number {
-  const title = entry.title?.toLowerCase() ?? ''
-  const tags = entry.tags?.join(' ').toLowerCase() ?? ''
-  const description = entry.description?.toLowerCase() ?? ''
-  const excerpt = entry.excerpt?.toLowerCase() ?? ''
-  let score = 0
-  if (title === query) score += 20
-  if (title.includes(query)) score += 10
-  if (tags.includes(query)) score += 6
-  if (description.includes(query)) score += 4
-  if (excerpt.includes(query)) score += 2
-  if (entry.route.toLowerCase().includes(query)) score += 1
-  return score
+  const title = entry.title?.toLowerCase() ?? "";
+  const tags = entry.tags?.join(" ").toLowerCase() ?? "";
+  const description = entry.description?.toLowerCase() ?? "";
+  const excerpt = entry.excerpt?.toLowerCase() ?? "";
+  let score = 0;
+  if (title === query) score += 20;
+  if (title.includes(query)) score += 10;
+  if (tags.includes(query)) score += 6;
+  if (description.includes(query)) score += 4;
+  if (excerpt.includes(query)) score += 2;
+  if (entry.route.toLowerCase().includes(query)) score += 1;
+  return score;
 }

package/src/client/virtual.d.ts

@@ -1,103 +1,103 @@
 /// <reference types="vite/client" />
 
-declare module '@docsearch/css'
+declare module "@docsearch/css";
 
-declare module '*.mdx' {
-  import type { ComponentType } from 'preact'
+declare module "*.mdx" {
+  import type { ComponentType } from "preact";
   const MdxPage: ComponentType<{
-    components?: Record<string, ComponentType<Record<string, unknown>>>
-  }>
-  export default MdxPage
+    components?: Record<string, ComponentType<Record<string, unknown>>>;
+  }>;
+  export default MdxPage;
 }
 
-declare module 'virtual:preactpress-pages' {
-  import type { ComponentType } from 'preact'
+declare module "virtual:preactpress-pages" {
+  import type { ComponentType } from "preact";
 
   export const pages: Record<
     string,
     | {
-      kind: 'markdown'
-      meta: Record<string, unknown>
-      html: string
-      title?: string
-      description?: string
-      tags?: string[]
-      image?: string
-      pageType?: 'website' | 'article'
-      headings: { id: string; text: string; level: number }[]
-      relativePath?: string
-      lastUpdated?: string
-    }
+        kind: "markdown";
+        meta: Record<string, unknown>;
+        html: string;
+        title?: string;
+        description?: string;
+        tags?: string[];
+        image?: string;
+        pageType?: "website" | "article";
+        headings: { id: string; text: string; level: number }[];
+        relativePath?: string;
+        lastUpdated?: string;
+      }
     | {
-      kind: 'mdx'
-      Component: ComponentType<{
-        components?: Record<string, ComponentType<Record<string, unknown>>>
-      }>
-      meta: Record<string, unknown>
-      title?: string
-      description?: string
-      tags?: string[]
-      image?: string
-      pageType?: 'website' | 'article'
-      headings: { id: string; text: string; level: number }[]
-      relativePath?: string
-      lastUpdated?: string
-    }
-  >
+        kind: "mdx";
+        Component: ComponentType<{
+          components?: Record<string, ComponentType<Record<string, unknown>>>;
+        }>;
+        meta: Record<string, unknown>;
+        title?: string;
+        description?: string;
+        tags?: string[];
+        image?: string;
+        pageType?: "website" | "article";
+        headings: { id: string; text: string; level: number }[];
+        relativePath?: string;
+        lastUpdated?: string;
+      }
+  >;
   export const pagesMeta: Record<
     string,
     {
-      kind: 'markdown' | 'mdx'
-      meta: Record<string, unknown>
-      title?: string
-      description?: string
-      tags?: string[]
-      image?: string
-      pageType?: 'website' | 'article'
-      headings: { id: string; text: string; level: number }[]
-      relativePath?: string
-      lastUpdated?: string
+      kind: "markdown" | "mdx";
+      meta: Record<string, unknown>;
+      title?: string;
+      description?: string;
+      tags?: string[];
+      image?: string;
+      pageType?: "website" | "article";
+      headings: { id: string; text: string; level: number }[];
+      relativePath?: string;
+      lastUpdated?: string;
     }
-  >
+  >;
   export const mdxLoaders: Record<
     string,
     () => Promise<{
       default: ComponentType<{
-        components?: Record<string, ComponentType<Record<string, unknown>>>
-      }>
+        components?: Record<string, ComponentType<Record<string, unknown>>>;
+      }>;
     }>
-  >
-  export const routes: string[]
+  >;
+  export const routes: string[];
 }
 
-declare module 'virtual:preactpress-site' {
-  export const mpa: boolean
+declare module "virtual:preactpress-site" {
+  export const mpa: boolean;
   export const site: {
-    title: string
-    description: string
-    base: string
-    lang: string
-    url?: string
-  }
+    title: string;
+    description: string;
+    base: string;
+    lang: string;
+    url?: string;
+  };
   export const themeConfig: {
-    logo?: import('../node/siteConfig.js').ThemeLogo
-    labels?: import('../node/siteConfig.js').ThemeLabels
-    nav?: import('../node/siteConfig.js').NavItem[]
-    sidebar?: import('../node/siteConfig.js').SidebarConfig
-    outline?: boolean | import('../shared/pageChrome.js').PageOutlineConfig
-    search?: import('../shared/search.js').SearchConfig
-    socialLinks?: import('../shared/socialIcons.js').SocialLink[]
-    tags?: boolean
-    footer?: string
-    editLink?: { pattern: string; text?: string }
-    lastUpdated?: boolean
-  }
-  export const i18n: import('../node/siteConfig.js').ResolvedI18n | undefined
+    logo?: import("../node/siteConfig.js").ThemeLogo;
+    labels?: import("../node/siteConfig.js").ThemeLabels;
+    nav?: import("../node/siteConfig.js").NavItem[];
+    sidebar?: import("../node/siteConfig.js").SidebarConfig;
+    outline?: boolean | import("../shared/pageChrome.js").PageOutlineConfig;
+    search?: import("../shared/search.js").SearchConfig;
+    socialLinks?: import("../shared/socialIcons.js").SocialLink[];
+    tags?: boolean;
+    footer?: string;
+    editLink?: { pattern: string; text?: string };
+    lastUpdated?: boolean;
+  };
+  export const i18n: import("../node/siteConfig.js").ResolvedI18n | undefined;
 }
 
-declare module 'virtual:preactpress-layout' {
-  import type { FunctionalComponent } from 'preact'
-  import type { LayoutProps } from './types.js'
-  const Layout: FunctionalComponent<LayoutProps>
-  export default Layout
+declare module "virtual:preactpress-layout" {
+  import type { FunctionalComponent } from "preact";
+  import type { LayoutProps } from "./types.js";
+  const Layout: FunctionalComponent<LayoutProps>;
+  export default Layout;
 }

package/src/shared/contentChunk.ts

@@ -1,14 +1,14 @@
-export const CONTENT_CHUNK_DIR = 'preactpress-content'
+export const CONTENT_CHUNK_DIR = "preactpress-content";
 
 export function encodeContentRoute(route: string): string {
-  if (route === '/') return '_index.json'
-  const clean = route.replace(/^\/+|\/+$/g, '')
+  if (route === "/") return "_index.json";
+  const clean = route.replace(/^\/+|\/+$/g, "");
   return `${clean
-    .split('/')
+    .split("/")
     .map((part) => encodeURIComponent(part))
-    .join('__')}.json`
+    .join("__")}.json`;
 }
 
 export function contentChunkPath(route: string): string {
-  return `${CONTENT_CHUNK_DIR}/${encodeContentRoute(route)}`
+  return `${CONTENT_CHUNK_DIR}/${encodeContentRoute(route)}`;
 }

package/src/shared/contentSchema.ts

@@ -1,77 +1,79 @@
 /** Author metadata for articles, magazines, and blogs. */
 export interface Author {
-  name: string
-  slug?: string
-  avatar?: string
+  name: string;
+  slug?: string;
+  avatar?: string;
 }
 
 /** Category or rubric metadata for editorial content. */
 export interface ContentCategory {
-  name: string
-  slug?: string
+  name: string;
+  slug?: string;
 }
 
 /** Common article frontmatter fields beyond built-in page metadata. */
 export interface ArticleFrontmatter {
-  title?: string
-  description?: string
-  tags?: string[]
-  author?: string | Author
-  category?: string | ContentCategory
-  readTime?: string
-  draft?: boolean
+  title?: string;
+  description?: string;
+  tags?: string[];
+  author?: string | Author;
+  category?: string | ContentCategory;
+  readTime?: string;
+  draft?: boolean;
 }
 
 /** Normalized article record produced from content loaders or hooks. */
 export interface ArticlePost {
-  title: string
-  route: string
-  url: string
-  description?: string
-  tags?: string[]
-  author?: Author
-  category?: ContentCategory
-  readTime?: string
+  title: string;
+  route: string;
+  url: string;
+  description?: string;
+  tags?: string[];
+  author?: Author;
+  category?: ContentCategory;
+  readTime?: string;
 }
 
 export function parseAuthor(value: unknown): Author | undefined {
-  if (typeof value === 'string' && value.trim()) {
-    return { name: value.trim() }
+  if (typeof value === "string" && value.trim()) {
+    return { name: value.trim() };
   }
-  if (!value || typeof value !== 'object') return undefined
-  const record = value as Record<string, unknown>
-  const name = typeof record.name === 'string' ? record.name.trim() : ''
-  if (!name) return undefined
-  const slug = typeof record.slug === 'string' && record.slug.trim() ? record.slug.trim() : undefined
+  if (!value || typeof value !== "object") return undefined;
+  const record = value as Record<string, unknown>;
+  const name = typeof record.name === "string" ? record.name.trim() : "";
+  if (!name) return undefined;
+  const slug =
+    typeof record.slug === "string" && record.slug.trim() ? record.slug.trim() : undefined;
   const avatar =
-    typeof record.avatar === 'string' && record.avatar.trim() ? record.avatar.trim() : undefined
-  return { name, slug, avatar }
+    typeof record.avatar === "string" && record.avatar.trim() ? record.avatar.trim() : undefined;
+  return { name, slug, avatar };
 }
 
 export function parseCategory(value: unknown): ContentCategory | undefined {
-  if (typeof value === 'string' && value.trim()) {
-    return { name: value.trim() }
+  if (typeof value === "string" && value.trim()) {
+    return { name: value.trim() };
   }
-  if (!value || typeof value !== 'object') return undefined
-  const record = value as Record<string, unknown>
-  const name = typeof record.name === 'string' ? record.name.trim() : ''
-  if (!name) return undefined
-  const slug = typeof record.slug === 'string' && record.slug.trim() ? record.slug.trim() : undefined
-  return { name, slug }
+  if (!value || typeof value !== "object") return undefined;
+  const record = value as Record<string, unknown>;
+  const name = typeof record.name === "string" ? record.name.trim() : "";
+  if (!name) return undefined;
+  const slug =
+    typeof record.slug === "string" && record.slug.trim() ? record.slug.trim() : undefined;
+  return { name, slug };
 }
 
 export function articleFromFrontmatter(opts: {
-  route: string
-  url: string
-  title?: string
-  description?: string
-  tags?: string[]
-  frontmatter: Record<string, unknown>
+  route: string;
+  url: string;
+  title?: string;
+  description?: string;
+  tags?: string[];
+  frontmatter: Record<string, unknown>;
 }): ArticlePost {
-  const fm = opts.frontmatter as ArticleFrontmatter
-  const title = (opts.title ?? fm.title ?? 'Untitled').trim()
-  const description = (opts.description ?? fm.description)?.trim() || undefined
-  const tags = (opts.tags ?? fm.tags)?.filter((tag) => tag.trim()).map((tag) => tag.trim())
+  const fm = opts.frontmatter as ArticleFrontmatter;
+  const title = (opts.title ?? fm.title ?? "Untitled").trim();
+  const description = (opts.description ?? fm.description)?.trim() || undefined;
+  const tags = (opts.tags ?? fm.tags)?.filter((tag) => tag.trim()).map((tag) => tag.trim());
   return {
     title,
     route: opts.route,
@@ -80,6 +82,7 @@ export function articleFromFrontmatter(opts: {
     tags,
     author: parseAuthor(fm.author),
     category: parseCategory(fm.category) ?? (tags?.[0] ? { name: tags[0] } : undefined),
-    readTime: typeof fm.readTime === 'string' && fm.readTime.trim() ? fm.readTime.trim() : undefined
-  }
+    readTime:
+      typeof fm.readTime === "string" && fm.readTime.trim() ? fm.readTime.trim() : undefined,
+  };
 }

package/src/shared/deadLinks.ts

@@ -1,33 +1,33 @@
 export type IgnoreDeadLinks =
   | boolean
   | string[]
-  | ((href: string, ctx: { from: string; route?: string }) => boolean)
+  | ((href: string, ctx: { from: string; route?: string }) => boolean);
 
 function patternToRegExp(pattern: string): RegExp {
   const escaped = pattern
-    .replace(/[.+?^${}()|[\]\\]/g, '\\$&')
-    .replace(/\*\*/g, '§§')
-    .replace(/\*/g, '[^/]*')
-    .replace(/§§/g, '.*')
-  return new RegExp(`^${escaped}$`)
+    .replace(/[.+?^${}()|[\]\\]/g, "\\$&")
+    .replace(/\*\*/g, "§§")
+    .replace(/\*/g, "[^/]*")
+    .replace(/§§/g, ".*");
+  return new RegExp(`^${escaped}$`);
 }
 
 function matchesPattern(pattern: string, href: string, route?: string): boolean {
-  if (pattern === href || (route && pattern === route)) return true
-  if (pattern.includes('*')) {
-    const re = patternToRegExp(pattern)
-    return re.test(href) || (route ? re.test(route) : false)
+  if (pattern === href || (route && pattern === route)) return true;
+  if (pattern.includes("*")) {
+    const re = patternToRegExp(pattern);
+    return re.test(href) || (route ? re.test(route) : false);
   }
-  return href.includes(pattern) || (route ? route.includes(pattern) : false)
+  return href.includes(pattern) || (route ? route.includes(pattern) : false);
 }
 
 export function shouldIgnoreDeadLink(
   href: string,
   ignore: IgnoreDeadLinks | undefined,
-  ctx: { from: string; route?: string }
+  ctx: { from: string; route?: string },
 ): boolean {
-  if (!ignore) return false
-  if (ignore === true) return true
-  if (typeof ignore === 'function') return ignore(href, ctx)
-  return ignore.some((pattern) => matchesPattern(pattern, href, ctx.route))
+  if (!ignore) return false;
+  if (ignore === true) return true;
+  if (typeof ignore === "function") return ignore(href, ctx);
+  return ignore.some((pattern) => matchesPattern(pattern, href, ctx.route));
 }

package/src/shared/escapeHtml.ts

@@ -1,11 +1,11 @@
 export function escapeHtml(s: string): string {
   return s
-    .replaceAll('&', '&')
-    .replaceAll('<', '&lt;')
-    .replaceAll('>', '&gt;')
-    .replaceAll('"', '&quot;')
+    .replaceAll("&", "&amp;")
+    .replaceAll("<", "&lt;")
+    .replaceAll(">", "&gt;")
+    .replaceAll('"', "&quot;");
 }
 
 export function escapeAttr(s: string): string {
-  return escapeHtml(s)
+  return escapeHtml(s);
 }

package/src/shared/index.ts

@@ -1,5 +1,5 @@
-export { contentChunkPath, encodeContentRoute } from './contentChunk.js'
-export { escapeAttr, escapeHtml } from './escapeHtml.js'
+export { contentChunkPath, encodeContentRoute } from "./contentChunk.js";
+export { escapeAttr, escapeHtml } from "./escapeHtml.js";
 export {
   PAGE_LAYOUTS,
   DEFAULT_TITLE_TEMPLATE,
@@ -12,8 +12,8 @@ export {
   titleTemplateFromMeta,
   type PageFrontmatter,
   type PageLayout,
-  type PageMetaInput
-} from './pageMeta.js'
+  type PageMetaInput,
+} from "./pageMeta.js";
 export {
   articleFromFrontmatter,
   parseAuthor,
@@ -21,9 +21,9 @@ export {
   type ArticleFrontmatter,
   type ArticlePost,
   type Author,
-  type ContentCategory
-} from './contentSchema.js'
-export { headTagsFromMeta } from './pageHead.js'
+  type ContentCategory,
+} from "./contentSchema.js";
+export { headTagsFromMeta } from "./pageHead.js";
 export {
   allSidebarGroups,
   flattenNavLeafItems,
@@ -31,18 +31,14 @@ export {
   flattenSidebarLeafItems,
   isPathSidebarConfig,
   resolveSidebarForRoute,
-  type SidebarConfig
-} from './sidebar.js'
-export {
-  applyRouteRewrites,
-  normalizeRewriteRoute,
-  type RouteRewrites
-} from './rewrites.js'
+  type SidebarConfig,
+} from "./sidebar.js";
+export { applyRouteRewrites, normalizeRewriteRoute, type RouteRewrites } from "./rewrites.js";
 export {
   defaultLabelsForLang,
   resolveThemeLabels,
-  type ResolvedThemeLabels
-} from './themeLabels.js'
+  type ResolvedThemeLabels,
+} from "./themeLabels.js";
 export {
   filterHeadingsForOutline,
   parseFeatures,
@@ -56,8 +52,8 @@ export {
   type PageOutlineConfig,
   type PageOutlineLevels,
   type ResolvedPageChrome,
-  type ThemeableImage
-} from './pageChrome.js'
+  type ThemeableImage,
+} from "./pageChrome.js";
 export {
   algoliaOptionsFromSearch,
   getRelativeDocSearchUrl,
@@ -70,14 +66,14 @@ export {
   type AlgoliaSearchOptions,
   type LocalSearchConfig,
   type SearchConfig,
-  type SearchProvider
-} from './search.js'
+  type SearchProvider,
+} from "./search.js";
 export {
   socialIconSvg,
   socialLinkLabel,
   type SocialLink,
-  type SocialLinkIcon
-} from './socialIcons.js'
-export { normalizeRoute, routeFromPathname } from './route.js'
-export { slugifySegment, uniqueSlug } from './slug.js'
-export { slugifyTagSegment, tagIndexPageRoute } from './tags.js'
+  type SocialLinkIcon,
+} from "./socialIcons.js";
+export { normalizeRoute, routeFromPathname } from "./route.js";
+export { slugifySegment, uniqueSlug } from "./slug.js";
+export { slugifyTagSegment, tagIndexPageRoute } from "./tags.js";