Snapshot for
@system-core/core0.12.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.12.0 on the 0.12 docs line.
Import
ts
import { createSectionRegistry, SITE_PAGE_FLOWS, getBuiltInWebsiteSections } from '@system-core/core/site-client'Entry
| Field | Value |
|---|---|
| Import path | @system-core/core/site-client |
| Package export | ./site-client |
| Source entry | core/site-client/index.ts |
| Exported symbols | 57 |
| 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
themeandsectionsfor frontend rendering surfaces.
Public Surface
Functions
| Export | Kind | Source |
|---|---|---|
applyCanonicalPageFlow | function | core/cms/site-builder/index.ts |
buildBlogPostingLd | function | core/cms/seo/index.ts |
buildBreadcrumbLd | function | core/cms/seo/index.ts |
buildCanonicalUrl | function | core/cms/seo/index.ts |
buildEventLd | function | core/cms/seo/index.ts |
buildFaqLd | function | core/cms/seo/index.ts |
buildJobPostingLd | function | core/cms/seo/index.ts |
buildOrganizationLd | function | core/cms/seo/index.ts |
buildPageMeta | function | core/cms/seo/index.ts |
buildProductLd | function | core/cms/seo/index.ts |
buildStructuredData | function | core/cms/seo/index.ts |
createBuiltInSection | function | core/cms/site-builder/index.ts |
createPageFromBuiltInTemplate | function | core/cms/site-builder/index.ts |
createSectionRegistry | function | core/cms/sections/registry.ts |
createSectionsFromPageFlow | function | core/cms/site-builder/index.ts |
generateRobotsTxt | function | core/cms/seo/index.ts |
generateSitemap | function | core/cms/seo/index.ts |
getBuiltInWebsiteSection | function | core/cms/site-builder/index.ts |
getBuiltInWebsiteSections | function | core/cms/site-builder/index.ts |
heroContentToSection | function | core/cms/site-builder/index.ts |
heroSectionToContent | function | core/cms/site-builder/index.ts |
resolveLocalizedHeaderSettings | function | core/cms/site-builder/index.ts |
resolveLocalizedPageSection | function | core/cms/site-builder/index.ts |
Consts
| Export | Kind | Source |
|---|---|---|
BUILT_IN_WEBSITE_SECTION_DEFINITIONS | const | core/cms/site-builder/index.ts |
resolveLocalizedFooterSettings | const | core/cms/site-builder/index.ts |
resolveLocalizedHeroContent | const | core/cms/site-builder/index.ts |
resolveLocalizedMenuItem | const | core/cms/site-builder/index.ts |
resolveLocalizedNavCta | const | core/cms/site-builder/index.ts |
SITE_PAGE_FLOWS | const | core/cms/site-builder/index.ts |
SITE_PAGE_TEMPLATES | const | core/cms/site-builder/index.ts |
SITE_SECTION_GROUPS | const | core/cms/site-builder/index.ts |
Interfaces
| Export | Kind | Source |
|---|---|---|
BlogPostLdInput | interface | core/cms/seo/index.ts |
EventLdInput | interface | core/cms/seo/index.ts |
FooterSettings | interface | core/cms/types/index.ts |
HeaderSettings | interface | core/cms/types/index.ts |
HeroContent | interface | core/cms/types/index.ts |
JobPostingLdInput | interface | core/cms/seo/index.ts |
JsonLdInput | interface | core/cms/seo/index.ts |
MenuItem | interface | core/cms/types/index.ts |
NavCta | interface | core/cms/types/index.ts |
PageSection | interface | core/cms/types/index.ts |
ProductLdInput | interface | core/cms/seo/index.ts |
RobotsOptions | interface | core/cms/seo/index.ts |
SectionDefinition | interface | core/cms/types/index.ts |
SectionObjectFieldDef | interface | core/cms/types/index.ts |
SeoMeta | interface | core/cms/seo/index.ts |
SeoPageInput | interface | core/cms/seo/index.ts |
SeoSiteSettings | interface | core/cms/seo/index.ts |
SiteBuilderRuntime | interface | core/cms/site-builder/index.ts |
SitemapPage | interface | core/cms/seo/index.ts |
SitePageFlowDefinition | interface | core/cms/site-builder/index.ts |
SitePageTemplateDefinition | interface | core/cms/site-builder/index.ts |
SiteSectionGroup | interface | core/cms/site-builder/index.ts |
Types
| Export | Kind | Source |
|---|---|---|
JsonLdType | type | core/cms/seo/index.ts |
LocalizedFieldMap | type | core/cms/types/index.ts |
SectionFieldDef | type | core/cms/types/index.ts |
SectionFieldType | type | core/cms/types/index.ts |