@zeropress/build-core 0.5.1 → 0.6.1

package/README.md

@@ -4,12 +4,19 @@
 ![license](https://img.shields.io/npm/l/%40zeropress%2Fbuild-core)
 ![node](https://img.shields.io/node/v/%40zeropress%2Fbuild-core)
 
-Shared build core for ZeroPress.
+Shared deterministic rendering core for ZeroPress static output v0.6.
 
-This package is the deterministic rendering engine used by:
+This package is the canonical rendering core for preview-data and theme packages consumed directly by:
 
-- `zeropress-admin-api-v2`
-- [`@zeropress/build`](https://www.npmjs.com/package/@zeropress/build) package
+- [@zeropress/build](https://www.npmjs.com/package/@zeropress/build)
+- [@zeropress/theme](https://www.npmjs.com/package/@zeropress/theme)
+
+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)
+- [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)
 
 It accepts canonical preview-data plus a validated theme package and produces static HTML artifacts through a writer interface.
 
@@ -18,16 +25,12 @@ It accepts canonical preview-data plus a validated theme package and produces st
 - renderable preview-data entries
 - theme template capability
 
----
-
 ## Install
 
 ```bash
 npm install @zeropress/build-core
 ```
 
----
-
 ## Exports
 
 ```js
@@ -39,8 +42,6 @@ import {
 } from '@zeropress/build-core';
 ```
 
----
-
 ## Purpose
 
 `@zeropress/build-core` is responsible for:
@@ -54,7 +55,10 @@ import {
 - generating special files such as:
   - `sitemap.xml`
   - `feed.xml`
-  - `robots.txt`
+  - fallback `robots.txt`
+  - `/_zeropress/comment-policy.json`
+  - `/_zeropress/search.json`
+  - `/_zeropress/search.js`
 - writing outputs through a pluggable writer
 
 It does not:
@@ -64,8 +68,6 @@ It does not:
 - watch files, run a dev server, or perform deployment
 - talk to queues, KV, Durable Objects, R2, GitHub, or other infrastructure directly
 
----
-
 ## Core APIs
 
 ### `buildSite(input)`
@@ -119,7 +121,10 @@ Notes:
 - `previewData` must already satisfy the canonical preview-data contract
 - `themePackage` must already be a validated in-memory theme package
 - `sitemap.xml` and `feed.xml` are emitted only when `site.url` is a non-empty canonical URL
-- `robots.txt` is still emitted when `generateSpecialFiles` is enabled
+- callers may pass `sitemapStylesheetHref` to add an XML stylesheet processing instruction to generated `sitemap.xml`
+- fallback `robots.txt` is emitted when `generateSpecialFiles` is enabled and `generateRobotsTxt` is not `false`
+- fallback `robots.txt` uses `site.indexing`; `false` emits `Disallow: /`, while missing or `true` emits `Allow: /`
+- callers that disable fallback robots because a public `robots.txt` exists should copy that file as-is; sitemap directives in custom robots files are caller/user responsibility
 
 ### `buildSiteFromThemeDir(input)`
 
@@ -127,8 +132,6 @@ Loads a theme directory from disk and renders it using the same core pipeline.
 
 This is useful for local tooling that wants filesystem theme loading but still uses the same deterministic core renderer.
 
----
-
 ## Writers
 
 ### `MemoryWriter`
@@ -150,8 +153,6 @@ Best for:
 - local output generation
 - CLI workflows
 
----
-
 ## Input Contracts
 
 ### Preview Data
@@ -175,15 +176,18 @@ Theme validation is enforced through:
 
 `buildSiteFromThemeDir()` is the convenience entry point that loads a theme directory and converts it into the required in-memory `themePackage`.
 
-As of `preview-data v0.4`, the payload no longer carries `routes` arrays or raw HTML fragments such as `categories_html`.
+JavaScript theme assets are emitted as provided. Build-core may hash output filenames, but it does not rewrite or minify JavaScript content.
+
+In `preview-data v0.6`, the payload does not carry `routes` arrays or raw HTML fragments such as `categories_html`.
 
-Build-core now derives:
+Build-core derives:
 
 - index/archive/category/tag routes
 - post list HTML blocks
 - pagination HTML
 - taxonomy link HTML
 - formatted `published_at` / `updated_at`
+- datetime formatting from `site.locale`, `site.timezone`, `site.date_style`, and `site.time_style`
 - `reading_time`
 - `comments_enabled`
 
@@ -193,14 +197,21 @@ It also emits a comments allowlist artifact:
 
 Comment availability is derived from preview-data policy:
 
-- `site.disallowComments`
+- `site.disallow_comments`
 - `content.posts[].allow_comments`
 
-The canonical `preview-data v0.4` site contract uses:
+The canonical `preview-data v0.6` site contract uses:
 
+- `site.media_base_url`
+- `site.media_delivery_mode`
 - `site.locale`
 - `site.timezone`
-- `site.disallowComments`
+- `site.datetime_display`
+- `site.date_style`
+- `site.time_style`
+- `site.disallow_comments`
+- `site.indexing`
+- `site.expose_generator`
 
 Optional route templates behave as rendering capabilities, not guaranteed outputs:
 
@@ -211,14 +222,15 @@ Optional route templates behave as rendering capabilities, not guaranteed output
 
 If preview-data includes content that could produce archive/category/tag pages but the theme omits the matching optional template, build-core skips those outputs. Special files are derived from emitted outputs rather than raw preview-data alone.
 
----
-
 ## Build Options
 
 Supported options:
 
 - `assetHashing`
+- `favicon`
+- `sitemapStylesheetHref`
 - `generateSpecialFiles`
+- `generateRobotsTxt`
 - `writeManifest`
 
 These options apply to both full builds and partial renders where relevant.
@@ -227,25 +239,9 @@ Defaults:
 
 - `assetHashing: true`
 - `generateSpecialFiles: true`
+- `generateRobotsTxt: true`
 - `writeManifest: false`
 
----
-
-## Requirements
-
-- Node.js >= 18.18.0
-- ESM only
-
----
-
-## Related
-
-- [@zeropress/preview-data-validator](https://www.npmjs.com/package/@zeropress/preview-data-validator)
-- [@zeropress/theme-validator](https://www.npmjs.com/package/@zeropress/theme-validator)
-- [@zeropress/theme](https://www.npmjs.com/package/@zeropress/theme)
-
----
-
 ## License
 
 MIT

package/package.json

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