Refreshes the reverse engineering docs after the homepage sections and records the requirements, execution plan and application design for the Over mij page: live texts in the design's structure, an indexed page with its own structured data and preview image, and shared building blocks (PageSection, MediaText, Eyebrow) reused by the homepage. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
83 lines
5.3 KiB
Markdown
83 lines
5.3 KiB
Markdown
# API Documentation
|
|
|
|
## REST APIs
|
|
None. There is no back-end yet (`api/` is empty). The static design README anticipates these endpoints on a .NET API:
|
|
- `POST /api/contact` — contact form, payload `{ naam, email, onderwerp, bericht }` (maps to a C# `ContactRequest` record)
|
|
- `/api/pages`, `/api/portfolio`, `/api/packages` — CMS content
|
|
|
|
## Internal APIs
|
|
|
|
### Routes (TanStack Router, file-based)
|
|
| Path | File | Head | Component | Indexed |
|
|
|------|------|------|-----------|---------|
|
|
| (root) | `routes/__root.tsx` | `siteHead(siteContent)` | `AppShell` | — |
|
|
| `/` | `routes/index.tsx` | `pageHead('/')` | `Hero` + six home sections; search `?pakket=` | yes |
|
|
| `/over-mij` | `routes/over-mij.tsx` | `pageHead(...)` | `PageIntro` placeholder | no |
|
|
| `/portfolio` | `routes/portfolio.tsx` | `pageHead(...)` | `PageIntro` placeholder | no |
|
|
| `/soorten-fotoshoots` | `routes/soorten-fotoshoots.tsx` | `pageHead(...)` | `PageIntro` placeholder | no |
|
|
| `/contact` | `routes/contact.tsx` | `pageHead(...)` | `PageIntro` placeholder | no |
|
|
| `/privacyverklaring` | `routes/privacyverklaring.tsx` | `pageHead(...)` | `PageIntro` placeholder | no |
|
|
| (not found) | — | — | `NotFound` | — |
|
|
|
|
### seo.ts / sitePages.ts / sitemap.ts
|
|
- `pageHead(path: RoutePath)` → `{ meta, links }` (title, description, robots noindex if not indexed, OG tags, canonical)
|
|
- `siteHead(content: SiteContent)` → `{ meta, scripts }` (OG basics, JSON-LD ProfessionalService)
|
|
- `canonicalUrl(path, base?)`, `jsonLdScript(data)`, `professionalService(content)`
|
|
- `sitePages: Record<RoutePath, PageMeta>`, `pageList(pages)`
|
|
- `sitemapXml(...)` — used by `config/sitemapPlugin.ts`
|
|
|
|
### Components (props)
|
|
- `AppShell()`, `NavigationBar()`, `BackToTop()`, `NotFound()` — no props
|
|
- `MobileNav({ id, open, onClose })`, `NavLink(RouterLink props)`
|
|
- `Footer({ content: SiteContent })`, `FooterColumn({ title, children })`, `FooterLink(LinkProps)`
|
|
- `Hero({ content: HeroContent, socials: SocialLink[] })`, `HeroArrows({ onPrev, onNext })`, `HeroPauseButton({ stopped, onToggle })`, `HeroSocials({ socials })`
|
|
- `PageIntro({ title, eyebrow?, children? })` — renders the page's only h1
|
|
- `PageSection({ labelledBy, id?, tone?: 'paper' | 'alt', width?: 'default' | 'narrow' | 'full', spacing?: 'default' | 'tight' | 'flushTop', 'data-testid'?, children })` (was `HomeSection`)
|
|
- `MediaText({ image, aspectRatio, 'data-testid'?, children })` — framed photo next to a text column
|
|
- `Eyebrow(TextProps & { as?: 'p' | 'span' | 'h2' | 'h3' | 'h4' })` — accent label, optionally a heading
|
|
- `SectionHeading({ id, title, eyebrow?, lead?, align?: 'center' | 'start', spacing?: 'default' | 'compact', focusable? })` — renders an h2
|
|
- `FramedImage({ image: ContentImage, aspectRatio })`, `DeferredImage(ImageProps & { image, near? })`, `Reveal(BoxProps & { delay? })`
|
|
- `IntroGallery({ content })`, `AboutBlock({ content })`, `Pricing({ content, packages })`, `PriceCard(...)`, `Testimonials({ content, testimonials })`, `ContactSection({ content, packages, enabled, email, pakket? })`, `InstagramGrid({ content, profileUrl })`
|
|
- `ContactForm(...)`, `ContactFormGate({ enabled, email, ... })`
|
|
- `StatusPage({ title, children, actions? })`, `ErrorPage({ error, reset })`
|
|
- `LinkButton(RouterLink props & { variant?: 'outline' | 'accent' | 'light' })`
|
|
- `UmamiAnalytics({ hostname? })`
|
|
|
|
### Hooks
|
|
- `useHeroSlider(count)` → slider state, controls, handlers, `HeroAnnouncement`
|
|
- `useScrolledPast(getThreshold)` → boolean (stable `getThreshold` required)
|
|
- `useRouteFocus()` — focuses `<main>` after navigation
|
|
- `useInView({ rootMargin, skip })` → `{ ref, inView }`; `usePageLoaded()` → boolean; `useReveal()` → `{ ref, visible }`
|
|
|
|
### Pure helpers (`lib/`)
|
|
- `emailAddress({ user, domain }): string | null`
|
|
- `visibleSocials(socials): SocialLink[]` — only valid https links
|
|
- `copyrightLine(year): string`
|
|
- `slidesToLoad(active, count): number[]`
|
|
- `backToTopThreshold(viewportHeight): number`
|
|
- `slideLabel`, `formatPrice`, `bookLabel`, `visiblePackages`, `visibleTestimonials`, `packageFromSearch`, `shootOptions`, `mailSubject`/`mailtoLink`, `validateField`/`validateContact`, `isLikelySpam`, `toContactPayload`, `contactFormReducer`
|
|
|
|
### Monitoring
|
|
- `monitoringFor(hostname): Monitoring | null`, `startSentry(hostname?)`, `reportError(error)`
|
|
|
|
## Data Models
|
|
### SiteContent (`content/types.ts`)
|
|
- **Fields**: `footerIntro: string`, `socials: SocialLink[]`, `email: EmailAddress`, `contactForm: { enabled: boolean }`
|
|
### ContentImage
|
|
- **Fields**: `src`, `alt`, `width`, `height` (intrinsic size, reserves space)
|
|
### HomeContent
|
|
- **Fields**: `intro`, `about` (`eyebrow`, `title`, `paragraphs[]`, `image`, `link: { label, to: RoutePath }`), `pricing`, `testimonials`, `contact`, `instagram`
|
|
### PricingPackage / Testimonial
|
|
- **Fields**: `id`, `name`, `price`, `features[]` / `id`, `shoot`, `quote`, `author`, `image`
|
|
### SocialLink
|
|
- **Fields**: `platform: SocialPlatform` (`facebook` | `instagram`), `href: string`
|
|
- **Validation**: shown only if `href` is a valid https URL
|
|
### EmailAddress
|
|
- **Fields**: `user`, `domain` — assembled only in the browser; invalid parts → hidden
|
|
### HeroContent
|
|
- **Fields**: `title`, `tagline`, `cta: { label, to }`, `slides: { id, src, alt }[]`
|
|
### NavItem (`navigation.ts`)
|
|
- **Fields**: `to: RoutePath`, `label: string`
|
|
### PageMeta (`sitePages.ts`)
|
|
- **Fields**: `title`, `description`, `indexed`, `ogImage?`
|