Skip to main content

CmsIntegration

Overview

CmsIntegration defines the interface for integrating with a CMS system within the High Velocity application. It provides methods to normalize content, retrieve layout content, fetch all content of a type, get specific content, and retrieve navigation menus.

Attributes

normalize

type: <TContentTypeKey extends [ContentTypeKey](./ContentTypeKey)>(contentType: TContentTypeKey, rawContent?: any) => Promise<[ContentTypes](./ContentTypes)[TContentTypeKey] | undefined>

Normalizes raw content from the CMS into the application's content model.

getLayoutContent

type: () => Promise<[LayoutContent](./LayoutContent)>

Retrieves the layout content for the application.

getAll

type: <TContentTypeKey extends [ContentTypeKey](./ContentTypeKey)>(contentType: TContentTypeKey) => Promise<[ContentTypes](./ContentTypes)[TContentTypeKey][]>

Fetches all content items of a specific content type.

getContent

type: <TContentTypeKey extends [ContentTypeKey](./ContentTypeKey)>(contentType: TContentTypeKey, context?: [ContentContext](./ContentContext)) => Promise<[ContentTypes](./ContentTypes)[TContentTypeKey] | undefined>

Retrieves specific content based on the content type and context.

getContentById

type: <TContentTypeKey extends [ContentTypeKey](./ContentTypeKey)>(contentType: TContentTypeKey, id: string) => Promise<[ContentTypes](./ContentTypes)[TContentTypeKey] | undefined>

Fetches content by its unique identifier.

getNavigation

type: <TContentTypeKey extends [ContentTypeKey](./ContentTypeKey)>(contentType: TContentTypeKey, context?: [ContentContext](./ContentContext)) => Promise<[ContentTypes](./ContentTypes)[TContentTypeKey] | undefined>

Retrieves the navigation menu, potentially merging CMS and catalog navigation.