diff --git a/aidlc-docs/active-features.md b/aidlc-docs/active-features.md index fd126a0..1c67f21 100644 --- a/aidlc-docs/active-features.md +++ b/aidlc-docs/active-features.md @@ -17,4 +17,4 @@ | Feature | asf-packages-cms | ✅ Complete (closed 2026-11-16; PR to master after the CMS PR; no production release) | feature/asf-packages-cms (worktree ../AndreaSlopFotografie-packages, based on feature/contact-form-cms) | web/config (offerings, fetchOfferings), web/src/content (packages, snapshot, types), Pricing + PriceBanner + PriceTopBar (two banners, centred card rows), PackagesProvider (live refresh), CI build-test job and nightly test build, docs/ (CMS integration, deploy and CI, go-live checklist) | 2026-11-12 | | Feature | asf-cms-host-injection | ✅ Complete on the ASF side (2026-11-16, delivered with asf-packages-cms; host side by SMC) | feature/asf-packages-cms | web (PackagesProvider, build markers, neutral HTML), preview server stand-in injector, e2e/contract tests; host side in the SlpModularCms repo | 2026-11-15 | | Feature | asf-translation-files | ✅ Complete on the ASF side (2026-11-16, delivered with asf-packages-cms) | feature/asf-packages-cms | web/src/i18n (nl.json, helpers), content modules, components, ESLint rules, baseline tool, docs/translations.md | 2026-11-15 | -| Feature | hero-module | 🔵 Inception (requirements questions to Bryan) | (none yet) | Hero as a manageable CMS module (SMC builds the module, ASF consumes it); LCP in the first HTML via host injection or prerender; static hero texts move into it | 2026-11-16 | +| Feature | hero-module | 🟡 Construction (ASF side built; waiting for the CMS test run) | feature/hero-module | Hero as a manageable CMS module (SMC builds the module, ASF consumes it); LCP in the first HTML via host injection or prerender; static hero texts move into it | 2026-11-16 | diff --git a/docs/cms-integration.md b/docs/cms-integration.md index 0e0f5fc..c012d37 100644 --- a/docs/cms-integration.md +++ b/docs/cms-integration.md @@ -32,6 +32,16 @@ Both follow the same rules as the packages: baked into the HTML at build time, r **Layout shift:** a banner that was not active at the last build is not in the HTML. When it appears live, the content below it moves down by its height once (for the top bar, the cards move). Rebuilding with the banner active (the nightly test build does this) removes the shift. The same holds in reverse when a baked banner is switched off. +## Hero (CMS module) + +The hero of the homepage comes from the CMS hero module (`GET /api/v1/hero`); the build bakes one in as the fallback (`web/src/content/heroContent.ts`, texts in `nl.json` under `hero.baked`). + +- **Markers.** `index.html` has `…` (first photo as ``, the `h1` with tagline and title, the buttons) and, in the head, `…` (the preload links). The head markers are added to the finished HTML by `config/heroPreload.ts` (React cannot write a comment into the head), as part of `config/externalizeInlineScripts.ts`. The host rewrites both from live data; the contract is `web/contract/host-injection/hero/` (README, seed, golden files shared with the CMS repo). Code: `src/lib/hero.ts` (mapping), `src/lib/heroHtml.ts` (HTML and preload). +- **Data block.** `#cms-data` gets a `hero` key (the answer of `/api/v1/hero`). After hydration `src/components/Hero/useHero.ts` takes it; without a host block the site asks `/api/v1/hero` itself (8 s time-out). A missing block, a 204, an error or an answer without a usable slide keeps the baked hero (fail open). +- **Until hydration** the hero is the plain HTML between the markers, styled by the global CSS `.cms-hero-*` in `src/theme.ts`; the slider (arrows, pause, progress) only exists after hydration, so a visitor without JavaScript sees the first photo and no dead controls. Slides after the first also get AVIF ``s; the first and the preload are WebP only. +- **Images.** Ratios `wide` (3:2) and `tall` (4:5; portrait screens), chosen by `(orientation: portrait)`; the focus point is `object-position`. Alt texts and the slider's aria texts are in `nl.json` (`hero`); a decorative photo has `alt=""`. +- **Stand-in host.** `config/hostInjector.ts` (preview server and e2e) writes the hero regions and the `hero` key like the real host; `e2e/hostInjection.e2e.ts` covers it. + ## Contact form `GET /api/v1/contact-messages/token` and `POST /api/v1/contact-messages` through the headless `web/src/cms-client`. The form is behind the switch `contactForm.enabled` in `web/src/content/siteContent.ts` (off means the "Binnenkort" gate and no request to the server). Details and the go-live conditions are in `aidlc-docs/features/contact-form-cms/` and [go-live-checklist.md](go-live-checklist.md). Friendly Captcha is off at go-live. diff --git a/docs/translations.md b/docs/translations.md index 4abbb7b..ac1eaf0 100644 --- a/docs/translations.md +++ b/docs/translations.md @@ -4,12 +4,12 @@ The texts of the site live in language files, not in the components. Dutch is th ## Where things are -- `web/src/i18n/nl.json`: all Dutch texts of the site in one file, in blocks per area in the order of the site: `common`, `site`, `home`, `about`, `contact`, `shoots`, `portfolio`, `instagram`, `testimonials`, `seo`, `cmsClient`. The file is the source of the types. A second language is `web/src/i18n/en.json` with the same keys. +- `web/src/i18n/nl.json`: all Dutch texts of the site in one file, in blocks per area in the order of the site: `common`, `site`, `hero`, `home`, `about`, `contact`, `shoots`, `portfolio`, `instagram`, `testimonials`, `seo`, `cmsClient`. The file is the source of the types. A second language is `web/src/i18n/en.json` with the same keys. - `web/src/i18n/index.ts`: `t(key, params?)` for a text, `tList(key)` for a list of texts, `tPlural(key, count, params?)` for a text with a singular and a plural form, `locales`, `locale` and `Messages`. - `web/src/i18n/compare.ts`: the checks the tests use (same keys and parameters, nothing empty). - The typed content modules in `web/src/content` keep their structure, images and paths; the words come from the language files. -Not in the language files: the hero (becomes a CMS module), the privacy statement (separate feature), and everything that comes from the CMS (packages, banners, later the gallery). +Not in the language files: the privacy statement (separate feature), and everything that comes from the CMS (packages, banners, later the gallery). ## Keys @@ -42,7 +42,7 @@ Dotted paths: the block (`common`, `home`, ...), then the page or section, then The block `cmsClient` holds the texts of the shared `src/cms-client` package, per part of the package: `cmsClient.contact` has the form's field errors, fallback, waiting time (`rateLimited.one/other` with `{minutes}`), too-large, captcha-required, failure (`{address}`) and the sending label. `src/i18n/cmsClientMessages.ts` builds the `ContactMessages` object from it and `ContactForm` passes it to `useContactForm({ messages })`. The package keeps its own Dutch defaults (`messages.nl.ts`) as a fallback and a test checks that both say the same. Parts that come later (offerings) get their own part of the block. -Not here: the hero, the privacy statement and everything from the CMS. +Not here: the privacy statement and everything from the CMS. ## Importing the language files diff --git a/web/config/externalizeInlineScripts.ts b/web/config/externalizeInlineScripts.ts index 476947c..7d107fd 100644 --- a/web/config/externalizeInlineScripts.ts +++ b/web/config/externalizeInlineScripts.ts @@ -28,6 +28,7 @@ import { externalizeInlineScripts, findExecutableInlineScripts, } from './inlineScripts.ts'; +import { injectHeroPreload } from './heroPreload.ts'; import { NOT_FOUND_FILE, pageFile } from './pageFiles.ts'; export type ViolationCode = @@ -179,7 +180,7 @@ export function planExternalization( let result; try { - result = scripts.externalize(html); + result = scripts.externalize(injectHeroPreload(html)); } catch (error) { if (!(error instanceof ScriptError)) throw error; add(file, error.code, detailOf(error)); diff --git a/web/config/heroPreload.test.ts b/web/config/heroPreload.test.ts new file mode 100644 index 0000000..f4c438d --- /dev/null +++ b/web/config/heroPreload.test.ts @@ -0,0 +1,36 @@ +import { describe, expect, it } from 'vitest'; +import { injectHeroPreload } from './heroPreload.ts'; + +const page = (body: string, head = 't') => + `${head}${body}`; + +describe('injectHeroPreload', () => { + it('writes the preload of the first photo between markers before ', () => { + const out = injectHeroPreload( + page( + '', + ), + ); + expect(out).toContain( + 't', + ); + }); + + it('finds the image when src comes before class', () => { + const out = injectHeroPreload( + page(''), + ); + expect(out).toContain('href="/a.jpg"'); + }); + + it('leaves a page without a hero, without a head and a done page alone', () => { + const plain = page(''); + expect(injectHeroPreload(plain)).toBe(plain); + const noHead = ''; + expect(injectHeroPreload(noHead)).toBe(noHead); + const once = injectHeroPreload( + page(''), + ); + expect(injectHeroPreload(once)).toBe(once); + }); +}); diff --git a/web/config/heroPreload.ts b/web/config/heroPreload.ts new file mode 100644 index 0000000..45ef030 --- /dev/null +++ b/web/config/heroPreload.ts @@ -0,0 +1,45 @@ +import { heroPreloadHtml } from '../src/lib/heroHtml.ts'; + +// The preload link of the hero in the head of a prerendered page, between the +// markers the CMS host rewrites (). React cannot write +// a comment into the head, so the build step adds it to the finished HTML, +// from the baked first photo of the page. Pages without a hero stay as they +// are, and so does a page that already has the markers (running twice is fine). + +const MARK = ''; +const HERO_IMAGE = + /]*\bclass="cms-hero-image"[^>]*\bsrc="([^"]+)"|]*\bsrc="([^"]+)"[^>]*\bclass="cms-hero-image"/; + +export function injectHeroPreload(html: string): string { + if (html.includes(MARK)) return html; + const found = HERO_IMAGE.exec(html); + const src = found?.[1] ?? found?.[2]; + const end = html.indexOf(''); + if (src === undefined || end === -1) return html; + // The src is already escaped in the HTML; the link is built from the same + // text, so it is written back unchanged + const link = heroPreloadHtml({ + display: 'single', + title: '', + buttons: [], + slides: [ + { + id: 'baked', + alt: '', + decorative: false, + image: { + width: 1, + height: 1, + focus: null, + src: '', + variants: [], + }, + }, + ], + }).replace('href=""', `href="${src}"`); + return ( + html.slice(0, end) + + `${MARK}${link}` + + html.slice(end) + ); +} diff --git a/web/config/hostInjector.test.ts b/web/config/hostInjector.test.ts index 474ca98..12ce2b2 100644 --- a/web/config/hostInjector.test.ts +++ b/web/config/hostInjector.test.ts @@ -54,6 +54,45 @@ describe('injectCms regions', () => { }); }); +describe('injectCms hero', () => { + const hero = { + title: 'Titel', + slides: [ + { + id: 'a', + alt: 'Alt', + decorative: false, + image: { width: 10, height: 8, src: '/m/a.webp' }, + }, + ], + }; + const regions = + 'oldold'; + + it('writes the hero and its preload and puts the hero in the data block', () => { + const out = run( + page( + regions + + '', + ), + { ...live([]), hero }, + ); + expect(out).toContain('

'); + expect(out).toContain( + ' { + for (const data of [live([]), { ...live([]), hero: { title: 'x' } }]) { + const out = run(page(regions), data); + expect(out).toBe(page(regions)); + } + }); +}); + describe('injectCms data block', () => { const baked = ''; diff --git a/web/config/hostInjector.ts b/web/config/hostInjector.ts index ac17832..fa50b2e 100644 --- a/web/config/hostInjector.ts +++ b/web/config/hostInjector.ts @@ -9,6 +9,8 @@ // matches that code. import { bannerHtml, offeringsHtml } from '../src/lib/cmsHtml.ts'; import { scriptJson } from '../src/lib/cmsData.ts'; +import { mapHero } from '../src/lib/hero.ts'; +import { heroHtml, heroPreloadHtml } from '../src/lib/heroHtml.ts'; import { formatPrice } from '../src/lib/formatPrice.ts'; import { mapBanner, mapOfferings, mapTopBanner } from '../src/lib/offerings.ts'; @@ -16,6 +18,8 @@ export interface LiveData { // The answers as the public API gives them offerings: unknown; banners: { top: unknown; bottom: unknown }; + // The answer of GET /api/v1/hero; absent or unusable leaves the baked hero + hero?: unknown; } export interface InjectOptions { @@ -33,7 +37,7 @@ const jsonLd = (value: unknown) => .replace(/&/g, '\\u0026'); const REGION = - /[\s\S]*?/g; + /[\s\S]*?/g; const DATA_BLOCK = /(?:`, ) .replace(OFFER_JSON_LD, (match, slug: string, json: string) => { diff --git a/web/config/normalizeInjected.ts b/web/config/normalizeInjected.ts index 416fd21..c43a281 100644 --- a/web/config/normalizeInjected.ts +++ b/web/config/normalizeInjected.ts @@ -11,7 +11,7 @@ import { readFileSync, writeFileSync } from 'node:fs'; const REGION = - /()[\s\S]*?()/g; + /()[\s\S]*?()/g; const DATA_BLOCK = /(?:)?