Files
AndreaSlopFotografie/aidlc-docs/_shared/reverse-engineering/api-documentation.md
T
SluijsensandClaude Opus 5.5 9efa7fc596 Adds the portfolio page
The ten live photos in a filterable masonry grid with an accessible
lightbox, filters per shoot type kept in the URL (?shoot=), the shared
Instagram block, and an indexed page with image gallery structured data
and its own preview image. Soorten fotoshoots now only links to the
portfolio for shoot types that have photos there.

The filter bar stays on one row, so the web font loading no longer
shifts the photos below it, and no photo loads before the page has: the
grid fades in, so loading its photos early only delayed the fonts and the
intro text.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-27 19:05:13 +01:00

8.6 KiB
Raw Blame History

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; the design README names the payload { naam, email, onderwerp, bericht }, the code sends { naam, email, shoot, bericht } (homepage-sections turned onderwerp into the shoot choice); 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('/over-mij') + AboutPage JSON-LD PageIntro, AboutIntro, StorySection ×2, PhotoDuo, LinkButton yes
/portfolio routes/portfolio.tsx pageHead('/portfolio') + ImageGallery JSON-LD; search ?shoot= (ShootTypeId) PageIntro, PortfolioGallery, InstagramGrid yes
/soorten-fotoshoots routes/soorten-fotoshoots.tsx pageHead('/soorten-fotoshoots') + WebPage JSON-LD (webPage() + shootServices()) PageIntro, shoots/ShootList (5× ShootBlock), CallToAction, RichParagraph, LinkButton yes
/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), structuredDataScript(data), professionalService(content) (with @id businessId and founder → personId), person(content, site, image), aboutPage(path, content, site)
  • 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, priority?, reverse?, frameColor?, 'data-testid'?, children }) — framed photo next to a text column; reverse puts the photo right from lg, frameColor colours the block behind it (default sand)
  • CallToAction({ title, titleId, lead?, 'data-testid'?, children }) — closing block of a page: h2, lead, action, on paper.alt
  • RichParagraph({ paragraph: RichText }) — paragraph with inline links (moved from about/)
  • 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: InstagramContent, profileUrl }) (shared, components/InstagramGrid/)
  • ContactForm(...), ContactFormGate({ enabled, email, ... })
  • PhotoDuo({ photos: [ContentImage, ContentImage], label, 'data-testid'? })
  • PortfolioGrid({ items: GalleryItem[], eagerCount = 3, onOpen(index), onIntent?(), 'data-testid'? }), Lightbox({ items, index: number | null, onIndexChange, onClose, label?, finalFocusEl? }) (default export, lazy-loadable), FilterBar({ options: FilterOption[], value, onChange, label })
  • about/AboutIntro({ content }), about/StorySection({ content, titleId, tone?, spacing?, children? }), shoots/ShootList({ shoots, packages, portfolioShoots }) (types that link to the portfolio), shoots/ShootBlock({ shoot, packages, reverse, priority, portfolioLink }), portfolio/PortfolioGallery({ photos, shootTypes, shoot, onShootChange })
  • StatusPage({ title, children, actions? }), ErrorPage({ error, reset })
  • LinkButton(RouterLink props & { variant?: 'outline' | 'accent' | 'light' })
  • UmamiAnalytics({ hostname? })

Hooks

  • useHeroSlider(count) → slider state, controls, handlers, HeroAnnouncement (swipe via useSwipe, wrap via wrapIndex)
  • useSwipe({ onPrev, onNext, enabled? }) → { onTouchStart, onTouchEnd } (threshold and direction from lib/swipeDirection)
  • 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
  • Portfolio (lib/portfolioFilters.ts): isShootTypeId, shootTypesWithPhotos(shootTypes, photos), shootFromSearch(value, available), filterPhotos(photos, shoot), filterOptions(shootTypes, allLabel), toGalleryItems(photos, shootTypes), photoCountLabel(n); seo.ts: galleryImages(photos)
  • Gallery (portfolio-page): wrapIndex(index, count), swipeDirection(start, end, threshold = 50), masonryRowSpan({ width, height }, K = 40, gapRows = 2), neighbourIndexes(index, count, radius = 2), lightboxReducer(state, event) (+ LightboxState, LightboxEvent)

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

InstagramContent

  • Fields: title, handle, photos: ContentImage[] (the intro photos followed by the review photos, instagramContent.ts)
  • Fields: { to: RoutePath; hash? }; InlineLink adds text; RichText = (string | InlineLink)[]

PortfolioContent / PortfolioPhoto

  • Fields: intro (eyebrow, title, text), photos: PortfolioPhoto[] — { id, shootType: ShootTypeId, thumb: ContentImage (800 px wide), full: ImageSource (1600 px long side) }

GalleryItem / FilterOption

  • Fields: { id, thumb, full, caption? } / { id, label } (generic, for the gallery blocks)

AboutPageContent

  • Fields: head, intro (eyebrow, title, paragraphs: RichText[], image), background, photos, personal, booking (label + LinkTarget), person (name, jobTitle, knowsAbout)

PricingPackage / Testimonial

  • Fields: id, name, price, features[] / id, shoot, quote, author, image
  • 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?