@zeropress/build-core 0.6.1 → 0.6.2

package/README.md

@@ -57,8 +57,9 @@ import {
   - `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:
@@ -212,6 +213,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.2",
   "description": "Shared ZeroPress build core",
   "type": "module",
   "license": "MIT",
@@ -34,8 +34,8 @@
   },
   "dependencies": {
     "@zeropress/slug-policy": "0.1.0",
-    "@zeropress/preview-data-validator": "0.6.1",
-    "@zeropress/theme-validator": "0.6.1",
+    "@zeropress/preview-data-validator": "0.6.2",
+    "@zeropress/theme-validator": "0.6.2",
     "highlight.js": "^11.11.1",
     "markdown-it": "^14.1.0",
     "markdown-it-anchor": "^9.2.0"

package/src/api/build-site.js

@@ -40,6 +40,7 @@ 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:']);
@@ -107,9 +108,13 @@ export async function buildSite(input) {
     '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(
@@ -459,6 +464,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),
@@ -794,6 +800,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]));
@@ -2393,8 +2401,11 @@ function assertPlannedOutputPathsSafe(state) {
     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 +2976,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 +3138,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 = {