Skip to content

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

cms-client

Generated Reference

Browser-safe metadata and schemas for CMS-driven admin and editor interfaces. This page is generated from core/cms-client/index.ts against package version 0.8.1 on the 0.8 docs line.

Import

ts
import { THEME_PRESET_META, createSectionRegistry, getBuiltInWebsiteSections } from '@system-core/core/cms-client'

Entry

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

Use This Surface When

  • Use this for CMS admin UIs, forms, and editor scaffolding in the browser.
  • Keep frontend bundles on client-safe metadata instead of importing server runtime modules.
  • Pair it with packages/ui-contracts when wiring renderer or editor contracts.

Public Surface

Functions

ExportKindSource
applyCanonicalPageFlowfunctioncore/cms/site-builder/index.ts
applyThemeToDomfunctioncore/cms/theme/css.ts
createBuiltInSectionfunctioncore/cms/site-builder/index.ts
createPageFromBuiltInTemplatefunctioncore/cms/site-builder/index.ts
createSectionRegistryfunctioncore/cms/sections/registry.ts
createSectionsFromPageFlowfunctioncore/cms/site-builder/index.ts
generateThemeInlineScriptfunctioncore/cms/theme/css.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
tokensToCssVariablesfunctioncore/cms/theme/css.ts
validateThemeTokensfunctioncore/cms/types/index.ts

Consts

ExportKindSource
BUILT_IN_WEBSITE_SECTION_DEFINITIONSconstcore/cms/site-builder/index.ts
FOOTER_SETTINGS_DEFAULTSconstcore/cms/sections/footer-schema.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
THEME_PRESET_METAconstcore/cms/theme/presets.ts
THEME_PRESETSconstcore/cms/theme/presets.ts

Interfaces

ExportKindSource
BackgroundQueueAdapterinterfacecore/platform/queue.ts
Cartinterfacecore/cms/products/cart.ts
CartIteminterfacecore/cms/products/cart.ts
CartTotalsinterfacecore/cms/products/cart.ts
CdnAdapterinterfacecore/cms/media/cdn.ts
CmsEventinterfacecore/cms/events/api.ts
ConsentCategoryinterfacecore/cms/compliance/gdpr.ts
CookieConsentinterfacecore/cms/compliance/gdpr.ts
EventFilterinterfacecore/cms/events/api.ts
Faqinterfacecore/cms/faqs/api.ts
FaqFilterinterfacecore/cms/faqs/api.ts
FooterBottomBarinterfacecore/cms/types/index.ts
FooterBottomLinkinterfacecore/cms/types/index.ts
FooterBrandBlockinterfacecore/cms/types/index.ts
FooterColumninterfacecore/cms/types/index.ts
FooterCtaStripinterfacecore/cms/types/index.ts
FooterLinkinterfacecore/cms/types/index.ts
FooterNewsletterConfiginterfacecore/cms/types/index.ts
FooterPaymentIconinterfacecore/cms/types/index.ts
FooterSettingsinterfacecore/cms/types/index.ts
FooterSocialLinkinterfacecore/cms/types/index.ts
HeaderSettingsinterfacecore/cms/types/index.ts
HeroColorBackgroundinterfacecore/cms/types/index.ts
HeroContentinterfacecore/cms/types/index.ts
HeroContentBlockinterfacecore/cms/types/index.ts
HeroCtainterfacecore/cms/types/index.ts
HeroImageBackgroundinterfacecore/cms/types/index.ts
HeroOverlayinterfacecore/cms/types/index.ts
HeroSlideinterfacecore/cms/types/index.ts
HeroSliderBackgroundinterfacecore/cms/types/index.ts
HeroVideoBackgroundinterfacecore/cms/types/index.ts
Jobinterfacecore/cms/jobs/api.ts
JobContextinterfacecore/platform/queue.ts
JobFilterinterfacecore/cms/jobs/api.ts
JobPayloadinterfacecore/platform/queue.ts
Mediainterfacecore/cms/types/index.ts
MediaExportEntryinterfacecore/cms/import-export/export.ts
MediaValueinterfacecore/cms/types/index.ts
MegaMenuColumninterfacecore/cms/types/index.ts
MenuIteminterfacecore/cms/types/index.ts
NavCtainterfacecore/cms/types/index.ts
NavigationMenuinterfacecore/cms/types/index.ts
Notificationinterfacecore/cms/types/index.ts
NotificationDeliveryinterfacecore/cms/types/index.ts
NotificationTemplateinterfacecore/cms/types/index.ts
Pageinterfacecore/cms/types/index.ts
PageSectioninterfacecore/cms/types/index.ts
PortfolioFilterinterfacecore/cms/portfolio/api.ts
PortfolioIteminterfacecore/cms/portfolio/api.ts
Postinterfacecore/cms/posts/api.ts
PostFilterinterfacecore/cms/posts/api.ts
PostListResultinterfacecore/cms/posts/api.ts
Productinterfacecore/cms/products/api.ts
ProductDimensionsinterfacecore/cms/products/api.ts
ProductFilterinterfacecore/cms/products/api.ts
ProductVariantOptioninterfacecore/cms/products/api.ts
RetentionConfiginterfacecore/cms/compliance/retention.ts
RetentionPolicyinterfacecore/cms/compliance/retention.ts
SectionDefinitioninterfacecore/cms/types/index.ts
SectionFieldDefinterfacecore/cms/types/index.ts
SiteExportinterfacecore/cms/import-export/export.ts
SiteSettingsinterfacecore/cms/types/index.ts
Slideinterfacecore/cms/types/index.ts
SocialLinksinterfacecore/cms/types/index.ts
TeamMemberinterfacecore/cms/team/api.ts
TeamMemberFilterinterfacecore/cms/team/api.ts
Testimonialinterfacecore/cms/testimonials/api.ts
TestimonialFilterinterfacecore/cms/testimonials/api.ts
ThemeBackgroundColorsinterfacecore/cms/types/index.ts
ThemeBorderColorsinterfacecore/cms/types/index.ts
ThemeBrandColorsinterfacecore/cms/types/index.ts
ThemeCategoryColorsinterfacecore/cms/types/index.ts
ThemeConfiginterfacecore/cms/types/index.ts
ThemeFontSourceinterfacecore/cms/types/index.ts
ThemeFontSourcesinterfacecore/cms/types/index.ts
ThemeFooterColorsinterfacecore/cms/types/index.ts
ThemeHeaderColorsinterfacecore/cms/types/index.ts
ThemeInteractiveColorsinterfacecore/cms/types/index.ts
ThemePresetDefinitioninterfacecore/cms/types/index.ts
ThemeSpacinginterfacecore/cms/types/index.ts
ThemeStatusColorsinterfacecore/cms/types/index.ts
ThemeTextColorsinterfacecore/cms/types/index.ts
ThemeTokensinterfacecore/cms/types/index.ts
TopBarIteminterfacecore/cms/types/index.ts

Types

ExportKindSource
ContentStatustypecore/cms/types/index.ts
EventStatustypecore/cms/events/api.ts
FooterBottomBarAlignmenttypecore/cms/types/index.ts
FooterColumnSpantypecore/cms/types/index.ts
FooterColumnTypetypecore/cms/types/index.ts
FooterLayouttypecore/cms/types/index.ts
HeaderLayouttypecore/cms/types/index.ts
HeroBackgroundModetypecore/cms/types/index.ts
HeroContentLayouttypecore/cms/types/index.ts
HeroSliderDirectiontypecore/cms/types/index.ts
HeroSliderTransitiontypecore/cms/types/index.ts
HeroVerticalAligntypecore/cms/types/index.ts
JobLeveltypecore/cms/jobs/api.ts
JobLocationtypecore/cms/jobs/api.ts
JobStatustypecore/cms/jobs/api.ts
JobTypetypecore/cms/jobs/api.ts
Localetypecore/cms/types/index.ts
LocalizedFieldMaptypecore/cms/types/index.ts
MediaStorageTypetypecore/cms/types/index.ts
MobileNavStyletypecore/cms/types/index.ts
NotificationChanneltypecore/cms/types/index.ts
NotificationDeliveryStatustypecore/cms/types/index.ts
PortfolioStatustypecore/cms/portfolio/api.ts
PostStatustypecore/cms/posts/api.ts
ProductStatustypecore/cms/products/api.ts
SectionFieldTypetypecore/cms/types/index.ts
ThemeFontProvidertypecore/cms/types/index.ts
ThemePresettypecore/cms/types/index.ts
UnknownSectionFieldPolicytypecore/cms/types/index.ts

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