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.3 on the 0.8 docs line.
Import
ts
import { THEME_PRESET_META, createSectionRegistry, getBuiltInWebsiteSections } from '@system-core/core/cms-client'Entry
| Field | Value |
|---|---|
| Import path | @system-core/core/cms-client |
| Package export | ./cms-client |
| Source entry | core/cms-client/index.ts |
| Exported symbols | 152 |
| 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-contractswhen wiring renderer or editor contracts.
Public Surface
Functions
| Export | Kind | Source |
|---|---|---|
applyCanonicalPageFlow | function | core/cms/site-builder/index.ts |
applyThemeToDom | function | core/cms/theme/css.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 |
generateFaviconHtml | function | core/cms/brand/index.ts |
generatePwaManifestIcons | function | core/cms/brand/index.ts |
generateThemeInlineScript | function | core/cms/theme/css.ts |
generateWebManifest | function | core/cms/brand/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 |
resolveLogo | function | core/cms/brand/index.ts |
resolveLogoText | function | core/cms/brand/index.ts |
tokensToCssVariables | function | core/cms/theme/css.ts |
validateBrandAssets | function | core/cms/brand/index.ts |
validateThemeTokens | function | core/cms/types/index.ts |
Consts
| Export | Kind | Source |
|---|---|---|
BUILT_IN_WEBSITE_SECTION_DEFINITIONS | const | core/cms/site-builder/index.ts |
FOOTER_SETTINGS_DEFAULTS | const | core/cms/sections/footer-schema.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 |
THEME_PRESET_META | const | core/cms/theme/presets.ts |
THEME_PRESETS | const | core/cms/theme/presets.ts |
Interfaces
| Export | Kind | Source |
|---|---|---|
BackgroundQueueAdapter | interface | core/platform/queue.ts |
BrandAssets | interface | core/cms/types/index.ts |
BrandDeps | interface | core/cms/brand/index.ts |
BrandValidationResult | interface | core/cms/brand/index.ts |
Cart | interface | core/cms/products/cart.ts |
CartItem | interface | core/cms/products/cart.ts |
CartTotals | interface | core/cms/products/cart.ts |
CdnAdapter | interface | core/cms/media/cdn.ts |
CmsEvent | interface | core/cms/events/api.ts |
ConsentCategory | interface | core/cms/compliance/gdpr.ts |
CookieConsent | interface | core/cms/compliance/gdpr.ts |
EventFilter | interface | core/cms/events/api.ts |
Faq | interface | core/cms/faqs/api.ts |
FaqFilter | interface | core/cms/faqs/api.ts |
FooterBottomBar | interface | core/cms/types/index.ts |
FooterBottomLink | interface | core/cms/types/index.ts |
FooterBrandBlock | interface | core/cms/types/index.ts |
FooterColumn | interface | core/cms/types/index.ts |
FooterCtaStrip | interface | core/cms/types/index.ts |
FooterLink | interface | core/cms/types/index.ts |
FooterNewsletterConfig | interface | core/cms/types/index.ts |
FooterPaymentIcon | interface | core/cms/types/index.ts |
FooterSettings | interface | core/cms/types/index.ts |
FooterSocialLink | interface | core/cms/types/index.ts |
HeaderSettings | interface | core/cms/types/index.ts |
HeroColorBackground | interface | core/cms/types/index.ts |
HeroContent | interface | core/cms/types/index.ts |
HeroContentBlock | interface | core/cms/types/index.ts |
HeroCta | interface | core/cms/types/index.ts |
HeroImageBackground | interface | core/cms/types/index.ts |
HeroOverlay | interface | core/cms/types/index.ts |
HeroSlide | interface | core/cms/types/index.ts |
HeroSliderBackground | interface | core/cms/types/index.ts |
HeroVideoBackground | interface | core/cms/types/index.ts |
Job | interface | core/cms/jobs/api.ts |
JobContext | interface | core/platform/queue.ts |
JobFilter | interface | core/cms/jobs/api.ts |
JobPayload | interface | core/platform/queue.ts |
LogoPair | interface | core/cms/types/index.ts |
Media | interface | core/cms/types/index.ts |
MediaExportEntry | interface | core/cms/import-export/export.ts |
MediaValue | interface | core/cms/types/index.ts |
MegaMenuColumn | interface | core/cms/types/index.ts |
MenuItem | interface | core/cms/types/index.ts |
NavCta | interface | core/cms/types/index.ts |
NavigationMenu | interface | core/cms/types/index.ts |
Notification | interface | core/cms/types/index.ts |
NotificationDelivery | interface | core/cms/types/index.ts |
NotificationTemplate | interface | core/cms/types/index.ts |
Page | interface | core/cms/types/index.ts |
PageSection | interface | core/cms/types/index.ts |
PortfolioFilter | interface | core/cms/portfolio/api.ts |
PortfolioItem | interface | core/cms/portfolio/api.ts |
Post | interface | core/cms/posts/api.ts |
PostFilter | interface | core/cms/posts/api.ts |
PostListResult | interface | core/cms/posts/api.ts |
Product | interface | core/cms/products/api.ts |
ProductDimensions | interface | core/cms/products/api.ts |
ProductFilter | interface | core/cms/products/api.ts |
ProductVariantOption | interface | core/cms/products/api.ts |
PwaManifestIcon | interface | core/cms/brand/index.ts |
RetentionConfig | interface | core/cms/compliance/retention.ts |
RetentionPolicy | interface | core/cms/compliance/retention.ts |
SectionDefinition | interface | core/cms/types/index.ts |
SectionFieldDef | interface | core/cms/types/index.ts |
SiteExport | interface | core/cms/import-export/export.ts |
SiteSettings | interface | core/cms/types/index.ts |
Slide | interface | core/cms/types/index.ts |
SocialLinks | interface | core/cms/types/index.ts |
TeamMember | interface | core/cms/team/api.ts |
TeamMemberFilter | interface | core/cms/team/api.ts |
Testimonial | interface | core/cms/testimonials/api.ts |
TestimonialFilter | interface | core/cms/testimonials/api.ts |
ThemeBackgroundColors | interface | core/cms/types/index.ts |
ThemeBorderColors | interface | core/cms/types/index.ts |
ThemeBrandColors | interface | core/cms/types/index.ts |
ThemeCategoryColors | interface | core/cms/types/index.ts |
ThemeConfig | interface | core/cms/types/index.ts |
ThemeFontSource | interface | core/cms/types/index.ts |
ThemeFontSources | interface | core/cms/types/index.ts |
ThemeFooterColors | interface | core/cms/types/index.ts |
ThemeHeaderColors | interface | core/cms/types/index.ts |
ThemeInteractiveColors | interface | core/cms/types/index.ts |
ThemePresetDefinition | interface | core/cms/types/index.ts |
ThemeSpacing | interface | core/cms/types/index.ts |
ThemeStatusColors | interface | core/cms/types/index.ts |
ThemeTextColors | interface | core/cms/types/index.ts |
ThemeTokens | interface | core/cms/types/index.ts |
TopBarItem | interface | core/cms/types/index.ts |
Types
| Export | Kind | Source |
|---|---|---|
BrandContext | type | core/cms/brand/index.ts |
ColorScheme | type | core/cms/brand/index.ts |
ContentStatus | type | core/cms/types/index.ts |
EventStatus | type | core/cms/events/api.ts |
FooterBottomBarAlignment | type | core/cms/types/index.ts |
FooterColumnSpan | type | core/cms/types/index.ts |
FooterColumnType | type | core/cms/types/index.ts |
FooterLayout | type | core/cms/types/index.ts |
HeaderLayout | type | core/cms/types/index.ts |
HeroBackgroundMode | type | core/cms/types/index.ts |
HeroContentLayout | type | core/cms/types/index.ts |
HeroSliderDirection | type | core/cms/types/index.ts |
HeroSliderTransition | type | core/cms/types/index.ts |
HeroVerticalAlign | type | core/cms/types/index.ts |
JobLevel | type | core/cms/jobs/api.ts |
JobLocation | type | core/cms/jobs/api.ts |
JobStatus | type | core/cms/jobs/api.ts |
JobType | type | core/cms/jobs/api.ts |
Locale | type | core/cms/types/index.ts |
LocalizedFieldMap | type | core/cms/types/index.ts |
MediaStorageType | type | core/cms/types/index.ts |
MobileNavStyle | type | core/cms/types/index.ts |
NotificationChannel | type | core/cms/types/index.ts |
NotificationDeliveryStatus | type | core/cms/types/index.ts |
PortfolioStatus | type | core/cms/portfolio/api.ts |
PostStatus | type | core/cms/posts/api.ts |
ProductStatus | type | core/cms/products/api.ts |
SectionFieldType | type | core/cms/types/index.ts |
ThemeFontProvider | type | core/cms/types/index.ts |
ThemePreset | type | core/cms/types/index.ts |
UnknownSectionFieldPolicy | type | core/cms/types/index.ts |