Skip to content

Snapshot for @system-core/core 0.8.x. Current docs live at /.

site-client

Generated Reference

Browser-safe website and page-builder metadata for public site composition. This page is generated from core/site-client/index.ts against package version 0.8.1 on the 0.8 docs line.

Import

ts
import { createSectionRegistry, SITE_PAGE_FLOWS, getBuiltInWebsiteSections } from '@system-core/core/site-client'

Entry

FieldValue
Import path@system-core/core/site-client
Package export./site-client
Source entrycore/site-client/index.ts
Exported symbols33
Runtime file./dist/site-client.js
Types file./dist/site-client.d.ts

Use This Surface When

  • Use this for public-site rendering, page-builder UIs, and section metadata in the browser.
  • Keep website composition on metadata contracts instead of server runtime helpers.
  • Pair it with theme and sections for frontend rendering surfaces.

Public Surface

Functions

ExportKindSource
applyCanonicalPageFlowfunctioncore/cms/site-builder/index.ts
createBuiltInSectionfunctioncore/cms/site-builder/index.ts
createPageFromBuiltInTemplatefunctioncore/cms/site-builder/index.ts
createSectionRegistryfunctioncore/cms/sections/registry.ts
createSectionsFromPageFlowfunctioncore/cms/site-builder/index.ts
getBuiltInWebsiteSectionfunctioncore/cms/site-builder/index.ts
getBuiltInWebsiteSectionsfunctioncore/cms/site-builder/index.ts
heroContentToSectionfunctioncore/cms/site-builder/index.ts
heroSectionToContentfunctioncore/cms/site-builder/index.ts
resolveLocalizedHeaderSettingsfunctioncore/cms/site-builder/index.ts
resolveLocalizedPageSectionfunctioncore/cms/site-builder/index.ts

Consts

ExportKindSource
BUILT_IN_WEBSITE_SECTION_DEFINITIONSconstcore/cms/site-builder/index.ts
resolveLocalizedFooterSettingsconstcore/cms/site-builder/index.ts
resolveLocalizedHeroContentconstcore/cms/site-builder/index.ts
resolveLocalizedMenuItemconstcore/cms/site-builder/index.ts
resolveLocalizedNavCtaconstcore/cms/site-builder/index.ts
SITE_PAGE_FLOWSconstcore/cms/site-builder/index.ts
SITE_PAGE_TEMPLATESconstcore/cms/site-builder/index.ts
SITE_SECTION_GROUPSconstcore/cms/site-builder/index.ts

Interfaces

ExportKindSource
FooterSettingsinterfacecore/cms/types/index.ts
HeaderSettingsinterfacecore/cms/types/index.ts
HeroContentinterfacecore/cms/types/index.ts
MenuIteminterfacecore/cms/types/index.ts
NavCtainterfacecore/cms/types/index.ts
PageSectioninterfacecore/cms/types/index.ts
SectionDefinitioninterfacecore/cms/types/index.ts
SectionFieldDefinterfacecore/cms/types/index.ts
SiteBuilderRuntimeinterfacecore/cms/site-builder/index.ts
SitePageFlowDefinitioninterfacecore/cms/site-builder/index.ts
SitePageTemplateDefinitioninterfacecore/cms/site-builder/index.ts
SiteSectionGroupinterfacecore/cms/site-builder/index.ts

Types

ExportKindSource
LocalizedFieldMaptypecore/cms/types/index.ts
SectionFieldTypetypecore/cms/types/index.ts

system-core documentation for maintainers, integrators, and AI build agents.