@zeropress/build-core 0.6.1 → 0.6.3

package/README.md

@@ -14,9 +14,9 @@ This package is the canonical rendering core for preview-data and theme packages
 Public contract references:
 
 - [Preview Data v0.6 Spec](https://zeropress.dev/spec/preview-data-v0.6.html)
-- [Preview Data v0.6 Schema](https://zeropress.dev/schemas/preview-data.v0.6.schema.json)
+- [Preview Data v0.6 Schema](https://schemas.zeropress.dev/preview-data/v0.6/schema.json)
 - [Theme Runtime v0.6 Spec](https://zeropress.dev/spec/theme-runtime-v0.6.html)
-- [Theme Runtime v0.6 Schema](https://zeropress.dev/schemas/theme.v0.6.runtime.schema.json)
+- [Theme Runtime v0.6 Schema](https://schemas.zeropress.dev/theme-runtime/v0.6/schema.json)
 
 It accepts canonical preview-data plus a validated theme package and produces static HTML artifacts through a writer interface.
 
@@ -56,9 +56,9 @@ import {
   - `sitemap.xml`
   - `feed.xml`
   - fallback `robots.txt`
-  - `/_zeropress/comment-policy.json`
-  - `/_zeropress/search.json`
-  - `/_zeropress/search.js`
+  - `/_zeropress/search.json` when native search is enabled
+  - `/_zeropress/search.js` when native search is enabled
+  - `/_zeropress/search_pagefind.js` when native search is enabled
 - writing outputs through a pluggable writer
 
 It does not:
@@ -191,10 +191,6 @@ Build-core derives:
 - `reading_time`
 - `comments_enabled`
 
-It also emits a comments allowlist artifact:
-
-- `/_zeropress/comment-policy.json`
-
 Comment availability is derived from preview-data policy:
 
 - `site.disallow_comments`
@@ -212,6 +208,9 @@ The canonical `preview-data v0.6` site contract uses:
 - `site.disallow_comments`
 - `site.indexing`
 - `site.expose_generator`
+- `site.search`
+
+Native search artifacts are emitted only when preview-data does not set `site.search: false` and the active theme declares `features.search: true`. `search_pagefind.js` is a Pagefind adapter that can replace `search.js` after a post-build Pagefind step.
 
 Optional route templates behave as rendering capabilities, not guaranteed outputs:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeropress/build-core",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "Shared ZeroPress build core",
   "type": "module",
   "license": "MIT",
@@ -34,9 +34,9 @@
   },
   "dependencies": {
     "@zeropress/slug-policy": "0.1.0",
-    "@zeropress/preview-data-validator": "0.6.1",
-    "@zeropress/theme-validator": "0.6.1",
-    "highlight.js": "^11.11.1",
+    "@zeropress/preview-data-validator": "0.6.3",
+    "@zeropress/theme-validator": "0.6.3",
+    "highlight.js": "11.11.1",
     "markdown-it": "^14.1.0",
     "markdown-it-anchor": "^9.2.0"
   }

package/src/api/build-site.js

@@ -37,9 +37,9 @@ const DEFAULT_POST_INDEX = Object.freeze({
   paginate: true,
 });
 const PERMALINK_OUTPUT_STYLES = new Set(['directory', 'html-extension']);
-const COMMENT_POLICY_OUTPUT_PATH = '_zeropress/comment-policy.json';
 const SEARCH_INDEX_OUTPUT_PATH = '_zeropress/search.json';
 const SEARCH_ADAPTER_OUTPUT_PATH = '_zeropress/search.js';
+const SEARCH_PAGEFIND_ADAPTER_OUTPUT_PATH = '_zeropress/search_pagefind.js';
 const OUTPUT_PATH_CONTROL_CHAR_PATTERN = /[\u0000-\u001F\u007F]/;
 const SAFE_MEDIA_PROTOCOLS = new Set(['http:', 'https:']);
 const SAFE_LINK_PROTOCOLS = new Set(['http:', 'https:', 'mailto:', 'tel:']);
@@ -99,17 +99,13 @@ export async function buildSite(input) {
     await writeOutput(state.writer, state.summaries, assetOutput.path, assetOutput.content, assetOutput.contentType);
   }
 
-  await writeOutput(
-    state.writer,
-    state.summaries,
-    COMMENT_POLICY_OUTPUT_PATH,
-    state.commentPolicyContent,
-    'application/json',
-  );
-
-  if (options.generateSpecialFiles) {
+  if (shouldGenerateSearchArtifacts(state, options)) {
     await writeOutput(state.writer, state.summaries, SEARCH_INDEX_OUTPUT_PATH, buildSearchIndexJson(state), 'application/json');
     await writeOutput(state.writer, state.summaries, SEARCH_ADAPTER_OUTPUT_PATH, buildSearchAdapterJs(), 'application/javascript');
+    await writeOutput(state.writer, state.summaries, SEARCH_PAGEFIND_ADAPTER_OUTPUT_PATH, buildSearchPagefindAdapterJs(), 'application/javascript');
+  }
+
+  if (options.generateSpecialFiles) {
     await maybeRenderNotFoundPage(state);
     if (hasCanonicalSiteUrl(state.previewData.site.url)) {
       await writeOutput(
@@ -168,7 +164,6 @@ async function createBuildState(input, options) {
     customHtml: previewData.custom_html,
     favicon: previewData.site.favicon,
     exposeGenerator: previewData.site.expose_generator !== false,
-    commentPolicyContent: buildCommentPolicyManifest(renderData.posts),
     options,
     generatedAt: new Date(),
     emitted: {
@@ -234,7 +229,9 @@ async function renderRoute(state, templateName, route) {
       route: routeContext,
       meta: buildPageMeta(state.previewData.site, {
         currentUrl,
-        title: state.previewData.site.title,
+        title: route.is_front_page === true
+          ? buildFrontPageTitle(state.previewData.site)
+          : state.previewData.site.title,
         description: state.previewData.site.description,
         ogType: 'website',
       }),
@@ -281,7 +278,7 @@ async function renderFrontPage(state, route) {
         route: routeContext,
         meta: buildPageMeta(state.previewData.site, {
           currentUrl,
-          title: buildDocumentTitle(page.title, state.previewData.site.title),
+          title: buildFrontPageTitle(state.previewData.site),
           description: page.excerpt,
           ogType: 'website',
           image: page.featured_image,
@@ -314,7 +311,7 @@ async function renderFrontPage(state, route) {
       route: routeContext,
       meta: buildPageMeta(state.previewData.site, {
         currentUrl,
-        title: state.previewData.site.title,
+        title: buildFrontPageTitle(state.previewData.site),
         description: state.previewData.site.description,
         ogType: 'website',
       }),
@@ -436,13 +433,17 @@ async function maybeRenderNotFoundPage(state) {
 }
 
 function normalizePreviewData(previewData, options = {}) {
+  const media_base_url = normalizeOptionalString(previewData.site.media_base_url);
   const normalizedSite = {
     ...previewData.site,
-    media_base_url: normalizeOptionalString(previewData.site.media_base_url),
+    media_base_url,
     media_delivery_mode: MEDIA_DELIVERY_MODES.has(previewData.site.media_delivery_mode)
       ? previewData.site.media_delivery_mode
       : 'none',
-    favicon: normalizeSiteFavicon(previewData.site.favicon || options.favicon),
+    favicon: previewData.site.favicon
+      ? normalizeSiteFavicon(previewData.site.favicon, media_base_url)
+      : normalizeSiteFavicon(options.favicon, ''),
+    logo: normalizeSiteLogo(previewData.site.logo, media_base_url),
     posts_per_page: Number.isInteger(previewData.site.posts_per_page) && previewData.site.posts_per_page > 0
       ? previewData.site.posts_per_page
       : DEFAULT_POSTS_PER_PAGE,
@@ -459,6 +460,7 @@ function normalizePreviewData(previewData, options = {}) {
     locale: normalizeLocale(previewData.site.locale || DEFAULT_LOCALE),
     disallow_comments: previewData.site.disallow_comments === true,
     expose_generator: previewData.site.expose_generator !== false,
+    search: previewData.site.search !== false,
     indexing: previewData.site.indexing !== false,
     permalinks: normalizePermalinks(previewData.site.permalinks),
     front_page: normalizeFrontPage(previewData.site.front_page),
@@ -732,7 +734,7 @@ function normalizeCustomHtml(customHtml) {
   };
 }
 
-function normalizeSiteFavicon(favicon) {
+function normalizeSiteFavicon(favicon, media_base_url) {
   if (!favicon || typeof favicon !== 'object') {
     return undefined;
   }
@@ -741,13 +743,30 @@ function normalizeSiteFavicon(favicon) {
   for (const key of ['icon', 'svg', 'png', 'apple_touch_icon']) {
     const value = normalizeOptionalString(favicon[key]);
     if (value) {
-      normalized[key] = value;
+      normalized[key] = normalizeMediaField(value, media_base_url);
     }
   }
 
   return Object.keys(normalized).length ? normalized : undefined;
 }
 
+function normalizeSiteLogo(logo, media_base_url) {
+  if (!logo || typeof logo !== 'object') {
+    return undefined;
+  }
+
+  const src = normalizeMediaField(logo.src, media_base_url);
+  if (!src) {
+    return undefined;
+  }
+
+  const alt = normalizeOptionalString(logo.alt);
+  return {
+    src,
+    ...(alt ? { alt } : {}),
+  };
+}
+
 function normalizePermalinks(permalinks) {
   const source = permalinks && typeof permalinks === 'object' ? permalinks : {};
   const outputStyle = typeof source.output_style === 'string' && PERMALINK_OUTPUT_STYLES.has(source.output_style)
@@ -794,6 +813,8 @@ function normalizePostIndex(post_index) {
 function createRenderData(previewData, themeMetadata = {}) {
   const themeSupportsComments = themeMetadata?.features?.comments === true;
   const themeSupportsPostIndex = themeMetadata?.features?.post_index !== false;
+  const themeSupportsSearch = themeMetadata?.features?.search === true;
+  previewData.site.search = previewData.site.search !== false && themeSupportsSearch;
   const authorsById = new Map(previewData.content.authors.map((author) => [author.id, author]));
   const categoriesBySlug = new Map(previewData.content.categories.map((category) => [category.slug, category]));
   const tagsBySlug = new Map(previewData.content.tags.map((tag) => [tag.slug, tag]));
@@ -1426,18 +1447,6 @@ function preparePost(post, site, authorsById, categoriesBySlug, tagsBySlug, them
   };
 }
 
-function buildCommentPolicyManifest(posts) {
-  const commentablePosts = posts
-    .filter((post) => post.status === 'published' && post.comments_enabled === true)
-    .map((post) => post.public_id)
-    .filter((value) => Number.isInteger(value) && value > 0);
-
-  return JSON.stringify({
-    version: 1,
-    commentable_posts: commentablePosts,
-  }, null, 2);
-}
-
 function buildTaxonomyRoutes(options) {
   const routes = [];
 
@@ -2086,6 +2095,12 @@ function buildDocumentTitle(contentTitle, siteTitle) {
   return `${resolvedContentTitle} - ${resolvedSiteTitle}`;
 }
 
+function buildFrontPageTitle(site) {
+  const resolvedSiteTitle = normalizeNonEmptyString(site.title, '');
+  const resolvedDescription = normalizeOptionalString(site.description);
+  return resolvedDescription ? `${resolvedSiteTitle} - ${resolvedDescription}` : resolvedSiteTitle;
+}
+
 function buildMetaHeadTags(meta) {
   const tags = [];
 
@@ -2390,11 +2405,13 @@ function assertPlannedOutputPathsSafe(state) {
   const plannedPaths = [
     ...routeEntries.map((entry) => entry.outputPath),
     ...state.assetOutputs.map((assetOutput) => assetOutput.path),
-    COMMENT_POLICY_OUTPUT_PATH,
   ];
 
+  if (shouldGenerateSearchArtifacts(state, state.options)) {
+    plannedPaths.push(SEARCH_INDEX_OUTPUT_PATH, SEARCH_ADAPTER_OUTPUT_PATH, SEARCH_PAGEFIND_ADAPTER_OUTPUT_PATH);
+  }
+
   if (state.options.generateSpecialFiles) {
-    plannedPaths.push(SEARCH_INDEX_OUTPUT_PATH, SEARCH_ADAPTER_OUTPUT_PATH);
     plannedPaths.push('404.html');
     if (shouldGenerateRobotsTxt(state.options)) {
       plannedPaths.push('robots.txt');
@@ -2965,6 +2982,88 @@ function normalizeLimit(value) {
 `;
 }
 
+function buildSearchPagefindAdapterJs() {
+  return `let pagefindPromise;
+
+export async function preload() {
+  if (!pagefindPromise) {
+    pagefindPromise = import(new URL('./pagefind/pagefind.js', import.meta.url).href).then(async (pagefind) => {
+      if (typeof pagefind.options === 'function') {
+        await pagefind.options({ baseUrl: '/' });
+      }
+      return pagefind;
+    });
+  }
+
+  return pagefindPromise;
+}
+
+export async function search(query, options = {}) {
+  const pagefind = await preload();
+  const result = await pagefind.search(query, options);
+  const limit = normalizeLimit(options.limit);
+  if (!Array.isArray(result?.results)) {
+    return result;
+  }
+
+  const results = result.results.map(normalizeResult);
+  return {
+    ...result,
+    results: limit ? results.slice(0, limit) : results,
+  };
+}
+
+function normalizeResult(result) {
+  if (!result || typeof result.data !== 'function') {
+    return result;
+  }
+
+  return {
+    ...result,
+    data: async () => normalizeResultData(await result.data()),
+  };
+}
+
+function normalizeResultData(data) {
+  if (!data || typeof data !== 'object') {
+    return data;
+  }
+
+  return {
+    ...data,
+    url: normalizeUrl(data.url),
+    sub_results: Array.isArray(data.sub_results)
+      ? data.sub_results.map((item) => ({ ...item, url: normalizeUrl(item.url) }))
+      : data.sub_results,
+  };
+}
+
+function normalizeUrl(value) {
+  const url = String(value || '');
+  if (url.startsWith('/_zeropress/') && !url.startsWith('/_zeropress/pagefind/')) {
+    return url.replace(/^\\/_zeropress/, '') || '/';
+  }
+  if (url.startsWith('_zeropress/') && !url.startsWith('_zeropress/pagefind/')) {
+    return url.replace(/^_zeropress/, '') || '/';
+  }
+  return url;
+}
+
+function normalizeLimit(value) {
+  if (value === undefined || value === null) {
+    return null;
+  }
+
+  const limit = Number(value);
+  if (!Number.isFinite(limit) || limit <= 0) {
+    return null;
+  }
+
+  return Math.floor(limit);
+}
+`;
+}
+
 function buildSitemapXml(site, emitted, generatedAt, stylesheetHref = '') {
   const entries = [
     ...(emitted.frontPage && emitted.frontPage.includeInSitemap !== false
@@ -3045,6 +3144,10 @@ function shouldGenerateRobotsTxt(options) {
   return options.generateSpecialFiles && options.generateRobotsTxt !== false;
 }
 
+function shouldGenerateSearchArtifacts(state, options) {
+  return options.generateSpecialFiles && state.previewData.site.search === true;
+}
+
 function getContentType(assetPath) {
   const ext = assetPath.split('.').pop()?.toLowerCase();
   const contentTypes = {