@marvalt/digivalt-core 0.2.8 → 0.2.9

package/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.9] - 2026-04-03
+
+### Added
+- **Template + init:** **`functions/sitemap.xml.ts`** — Cloudflare Pages handler for **`/sitemap.xml`** using **`VITE_SEO_SITE_URL`** / **`SITE_URL`** and **`public/sitemap-paths.json`** (no WordPress). Default **`template/public/sitemap-paths.json`**. Listed in **`TEMPLATE_MANAGED_FILES`** for `--force-template` refresh of the handler only.
+
+### Changed
+- **Docs:** `DIGIVALT_SETUP.md`, **`docs/SEO-PERFORMANCE.md`** — sitemap section.
+
 ## [0.2.8] - 2026-04-03
 
 ### Changed

package/bin/init.cjs

@@ -24,6 +24,7 @@ const TEMPLATE_MANAGED_FILES = new Set([
   '.dev.vars.example',
   'DIGIVALT_SETUP.md',
   'functions/api/fetch-with-access.ts',
+  'functions/sitemap.xml.ts',
   'functions/api/gravity-forms-submit.ts',
   'functions/api/mautic-submit.ts',
   'functions/api/webhook.js',

package/docs/SEO-PERFORMANCE.md

@@ -41,6 +41,10 @@ Read via `getPerformanceConfig()` from `@marvalt/digivalt-core/config`. Set to `
 - `VITE_PERF_SERVICE_WORKER` (default off)
 - `VITE_PERF_CACHING` (default on)
 
+## Sitemap (`/sitemap.xml`)
+
+DigiValt apps ship a **Cloudflare Pages Function** at **`functions/sitemap.xml.ts`** that responds at **`/sitemap.xml`**. It reads **`VITE_SEO_SITE_URL`** (or **`SITE_URL`**) for canonical `<loc>` values and loads path slugs from **`public/sitemap-paths.json`** (shape: `{ "paths": ["/", "/pricing"] }`). Update that JSON when you add marketing routes; avoid a static **`public/sitemap.xml`** file, which would override the Function.
+
 ## Imports
 
 ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@marvalt/digivalt-core",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "description": "Core glue logic and shared context for DigiVAlt frontend applications",
   "license": "GPL-3.0-or-later",
   "main": "dist/index.cjs",

package/template/DIGIVALT_SETUP.md

@@ -84,6 +84,7 @@ Init will:
 1. Install **`react-helmet-async`** and wrap your app with **`HelmetProvider`** at the root (next to the router).
 2. Set at least **`VITE_SEO_SITE_URL`** (no trailing slash), **`VITE_SEO_SITE_NAME`**, **`VITE_SEO_DEFAULT_TITLE`**, **`VITE_SEO_DEFAULT_DESCRIPTION`**, and **`VITE_SEO_DEFAULT_OG_IMAGE`** in Cloudflare Pages / `.env.local`.
 3. Import **`DigiValtSeoHead`** and **`JsonLd`** from **`@marvalt/digivalt-core/seo`** in your layouts or page components; pass **`pathname`** per route for correct canonical URLs.
-4. Read the full guide shipped with the package: **`node_modules/@marvalt/digivalt-core/docs/SEO-PERFORMANCE.md`** (or in the repo: `digivalt-npm-packages/digivalt-core/docs/SEO-PERFORMANCE.md`).
+4. **Sitemap:** After init, **`/sitemap.xml`** is served by **`functions/sitemap.xml.ts`** (Cloudflare Pages). Canonical URLs use **`VITE_SEO_SITE_URL`** (or **`SITE_URL`**); edit **`public/sitemap-paths.json`** (`{ "paths": ["/", "/about"] }`) when you add public routes. Do not add a static **`public/sitemap.xml`** (it would shadow the Function).
+5. Read the full guide shipped with the package: **`node_modules/@marvalt/digivalt-core/docs/SEO-PERFORMANCE.md`** (or in the repo: `digivalt-npm-packages/digivalt-core/docs/SEO-PERFORMANCE.md`).
 
 You are fully onboarded and ready to develop offline!

package/template/functions/sitemap.xml.ts

@@ -0,0 +1,65 @@
+/**
+ * Serves /sitemap.xml from canonical site URL + public/sitemap-paths.json (no WordPress).
+ * Set VITE_SEO_SITE_URL (or SITE_URL) on Cloudflare Pages for production canonical hosts.
+ */
+
+function normalizeBase(raw: string | undefined): string | null {
+  if (!raw || typeof raw !== 'string') return null;
+  const t = raw.trim().replace(/\/+$/, '');
+  return t || null;
+}
+
+function escapeXml(s: string): string {
+  return s.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
+}
+
+async function loadPaths(request: Request): Promise<string[]> {
+  try {
+    const jsonUrl = new URL('/sitemap-paths.json', request.url);
+    const res = await fetch(jsonUrl.toString());
+    if (!res.ok) return ['/'];
+    const data: unknown = await res.json();
+    const list: string[] = [];
+    if (Array.isArray(data)) {
+      for (const p of data) {
+        if (typeof p === 'string' && p.startsWith('/')) list.push(p);
+      }
+    } else if (data && typeof data === 'object' && Array.isArray((data as { paths?: unknown }).paths)) {
+      for (const p of (data as { paths: unknown[] }).paths) {
+        if (typeof p === 'string' && p.startsWith('/')) list.push(p);
+      }
+    }
+    return list.length ? list : ['/'];
+  } catch {
+    return ['/'];
+  }
+}
+
+function buildSitemap(base: string, paths: string[]): string {
+  const lines = paths.map((p) => {
+    const loc = p === '/' ? base : `${base}${p.startsWith('/') ? p : `/${p}`}`;
+    return `  <url><loc>${escapeXml(loc)}</loc></url>`;
+  });
+  return `<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+${lines.join('\n')}
+</urlset>`;
+}
+
+export async function onRequestGet(context: { request: Request; env: Record<string, string | undefined> }) {
+  const { request, env } = context;
+  const fromEnv = normalizeBase(env.VITE_SEO_SITE_URL || env.SITE_URL);
+  const origin = new URL(request.url).origin.replace(/\/+$/, '');
+  const base = fromEnv || origin;
+
+  const rawPaths = await loadPaths(request);
+  const paths = [...new Set(rawPaths.length ? rawPaths : ['/'])];
+
+  const xml = buildSitemap(base, paths);
+  return new Response(xml, {
+    headers: {
+      'Content-Type': 'application/xml; charset=utf-8',
+      'Cache-Control': 'public, max-age=300',
+    },
+  });
+}

package/template/public/sitemap-paths.json

@@ -0,0 +1,3 @@
+{
+  "paths": ["/"]
+}