medusa-storefront-data 2.5.5 → 2.5.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "medusa-storefront-data",
-  "version": "2.5.5",
+  "version": "2.5.7",
   "type": "module",
   "description": "Medusa storefront server data layer extracted from Next.js storefront",
   "license": "MIT",
@@ -172,6 +172,11 @@
       "types": "./dist/server/help-sections/help-faq.d.ts",
       "import": "./src/server/help-sections/help-faq.ts",
       "default": "./src/server/help-sections/help-faq.ts"
+    },
+    "./storefront-cms": {
+      "types": "./src/server/storefront-cms.ts",
+      "import": "./src/server/storefront-cms.ts",
+      "default": "./src/server/storefront-cms.ts"
     }
   },
   "main": "./dist/server/index.js",

package/src/server/dynamic-config.ts

@@ -675,11 +675,64 @@ export function getFaqsFromPageInput(
 }
 
 
+export type PromoAnnouncementsConfig = {
+  messages: string[]
+  icon?: string
+  iconAlt?: string
+  ariaLabel: string
+  separator?: string
+}
+
+function parsePromoAnnouncementsUi(
+  ...sources: Array<Record<string, unknown> | null | undefined>
+): Pick<PromoAnnouncementsConfig, "icon" | "iconAlt" | "ariaLabel" | "separator"> {
+  const pick = (key: string, alt?: string) => {
+    for (const src of sources) {
+      if (!src) continue
+      const value = normalizeCmsText(src[key] ?? (alt ? src[alt] : undefined))
+      if (value) return value
+    }
+    return undefined
+  }
+  return {
+    icon: pick("icon", "ticker-icon"),
+    iconAlt: pick("iconAlt", "icon-alt"),
+    ariaLabel: pick("ariaLabel", "aria-label") ?? "Store announcements",
+    separator: pick("separator", "message-separator"),
+  }
+}
+
+/** Promo ticker messages + UI copy (icon, aria label, separator). */
+export function getPromoAnnouncementsFromPageInput(
+  pageInput?: HomepageConfig | null
+): PromoAnnouncementsConfig {
+  const homepageConfig = resolvePageInput(pageInput)
+  const block = getMergedSectionBlock("promoAnnouncements", pageInput)
+  const promoUi =
+    (homepageConfig.promoUi as Record<string, unknown> | undefined) ??
+    (homepageConfig["promo-ui"] as Record<string, unknown> | undefined)
+
+  let messages = parseAnnouncementMessages(block)
+  if (messages.length === 0) {
+    const legacy =
+      homepageConfig["announcement-messages"] ??
+      homepageConfig["announcement-bar"]
+    if (Array.isArray(legacy)) {
+      messages = legacy
+        .map((m) => (typeof m === "string" ? m.trim() : ""))
+        .filter(Boolean)
+    }
+  }
+
+  const ui = parsePromoAnnouncementsUi(promoUi, block)
+  return { messages, ...ui }
+}
+
+/** @deprecated Use {@link getPromoAnnouncementsFromPageInput}. */
 export function getAnnouncementMessagesFromPageInput(
   pageInput?: HomepageConfig | null
 ): string[] {
-  const block = getMergedSectionBlock("promoAnnouncements", pageInput)
-  return parseAnnouncementMessages(block)
+  return getPromoAnnouncementsFromPageInput(pageInput).messages
 }
 
 
@@ -734,14 +787,11 @@ export type BrandPillarConfig = {
   href?: string
 }
 
-export function getBrandPillarsFromPageInput(
-  pageInput?: HomepageConfig | null
-): { sectionTitle: string; pillars: BrandPillarConfig[] } {
-  const block = getMergedSectionBlock("brandPillars", pageInput)
-  const copy = parseSectionCopy(block)
-  const sectionTitle = copy.title ?? copy.name ?? ""
+function parseBrandPillarsFromBlock(
+  block: Record<string, unknown>
+): BrandPillarConfig[] {
   const raw = block.pillars ?? block["brand-pillars"] ?? []
-  const pillars = (Array.isArray(raw) ? raw : [])
+  return (Array.isArray(raw) ? raw : [])
     .map((item: unknown) => {
       if (!item || typeof item !== "object") return null
       const row = (item as Record<string, unknown>)["pillar"] ?? item
@@ -749,9 +799,26 @@ export function getBrandPillarsFromPageInput(
       const title = String(p.title ?? p.name ?? "").trim()
       const description = String(p.description ?? p.text ?? "").trim()
       const image = (p.image ?? p.icon) as string | undefined
-      return title && description ? { title, description, image } : null
+      const href = (p.href ?? p.link ?? p.url) as string | undefined
+      return title && description
+        ? { title, description, image, href: href ? String(href) : undefined }
+        : null
     })
     .filter(Boolean) as BrandPillarConfig[]
+}
+
+export function getBrandPillarsFromPageInput(
+  pageInput?: HomepageConfig | null
+): { sectionTitle: string; pillars: BrandPillarConfig[] } {
+  const block = getMergedSectionBlock("brandPillars", pageInput)
+  const copy = parseSectionCopy(block)
+  const sectionTitle = copy.title ?? copy.name ?? ""
+  let pillars = parseBrandPillarsFromBlock(block)
+  if (pillars.length === 0) {
+    pillars = parseBrandPillarsFromBlock(
+      DEFAULT_HOMEPAGE_SECTIONS.brandPillars as Record<string, unknown>
+    )
+  }
   return { sectionTitle, pillars }
 }
 

package/src/server/home-sections/promo-announcements.ts

@@ -1,17 +1,19 @@
 import "server-only"
 
-import { getAnnouncementMessagesFromPageInput } from "../dynamic-config"
+import { getPromoAnnouncementsFromPageInput } from "../dynamic-config"
 import type { SectionLoaderOptions } from "./shared"
 
 export type PromoAnnouncementsSectionData = {
   messages: string[]
+  icon?: string
+  iconAlt?: string
+  ariaLabel: string
+  separator?: string
 }
 
 export async function loadPromoAnnouncementsSectionData(
   _countryCode: string,
   options?: SectionLoaderOptions
 ): Promise<PromoAnnouncementsSectionData> {
-  return {
-    messages: getAnnouncementMessagesFromPageInput(options?.pageInput ?? null),
-  }
+  return getPromoAnnouncementsFromPageInput(options?.pageInput ?? null)
 }

package/src/server/home.ts

@@ -10,7 +10,10 @@ import type {
 } from "./dynamic-config"
 import type { ShoppableLook } from "./shoppable-looks"
 
-/** Shape returned by the legacy `loadHomePageData` loader (removed — use per-section loaders). */
+/**
+ * Shared homepage data shape used by `medusa-storefront-compose`.
+ * This is a type-only module (no runtime loaders).
+ */
 export type HomePageData = {
   region: HttpTypes.StoreRegion | null
   collections: Array<Record<string, unknown>>
@@ -48,3 +51,4 @@ export type HomePageData = {
     features: Array<{ name: string; icon: string }>
   }
 }
+

package/src/server/homepage-config.types.ts

@@ -23,6 +23,18 @@ export type HomepagePromoAnnouncementsSection = HomepageSectionCopyFields & {
   messages?: string[]
   items?: Array<string | { message?: string; text?: string }>
   "announcement-messages"?: string[]
+  /** Optional icon shown before the ticker. */
+  icon?: string
+  iconAlt?: string
+  ariaLabel?: string
+  separator?: string
+}
+
+export type HomepagePromoUiConfig = {
+  icon?: string
+  iconAlt?: string
+  ariaLabel?: string
+  separator?: string
 }
 
 export type HomepagePromoCountdownSection = HomepageSectionCopyFields & {
@@ -277,6 +289,84 @@ export type HomepagePromoBarConfig = {
   "promo-active"?: boolean
 }
 
+export type HomepageHeaderNavStaticItem = {
+  type?: "static"
+  label?: string
+  href?: string
+  icon?: string
+  iconSrc?: string
+}
+
+export type HomepageHeaderNavCategoriesItem = {
+  type: "categories"
+  /** Limit how many categories to include (after filtering). */
+  limit?: number
+  /** Show only these category handles (in this exact order). */
+  handles?: string[]
+  /** Only include top-level categories (no parent). Default: true */
+  topLevelOnly?: boolean
+  /** Optional prefix label like "Shop by category" (not used in desktop links). */
+  label?: string
+}
+
+export type HomepageHeaderNavItem =
+  | HomepageHeaderNavStaticItem
+  | HomepageHeaderNavCategoriesItem
+
+export type HomepageHeaderNavConfig = {
+  items?: HomepageHeaderNavItem[]
+}
+
+export type HomepageFooterNavLink = {
+  label?: string
+  href?: string
+}
+
+export type HomepageFooterNavColumn = {
+  title?: string
+  links?: HomepageFooterNavLink[]
+}
+
+export type HomepageFooterNavConfig = {
+  columns?: HomepageFooterNavColumn[]
+}
+
+export type HomepageFooterUiConfig = {
+  shopColumnTitle?: string
+  contactTitle?: string
+  newsletterBlurb?: string
+  newsletterPlaceholder?: string
+  newsletterSubmitLabel?: string
+  newsletterInvalidEmail?: string
+  newsletterErrorMessage?: string
+  /** Supports `{siteName}` token. */
+  copyrightText?: string
+  icons?: {
+    phone?: string
+    email?: string
+    address?: string
+  }
+  social?: {
+    facebook?: string
+    linkedin?: string
+    instagram?: string
+    youtube?: string
+  }
+}
+
+export type HomepageHeaderUiConfig = {
+  icons?: {
+    cart?: string
+    account?: string
+    search?: string
+  }
+  search?: {
+    placeholder?: string
+    title?: string
+    emptyStateText?: string
+  }
+}
+
 export type HomepageFaqEntry = {
   "faq-category"?: string
   "faq-question"?: string
@@ -292,6 +382,29 @@ export type HomepageConfig = {
   "website-description"?: string
   website_description?: string
 
+  /**
+   * Header navigation (desktop + mobile).
+   * Use `type: "static"` for hardcoded links, or `type: "categories"` to auto-populate from product categories.
+   */
+  headerNav?: HomepageHeaderNavConfig
+  "header-nav"?: HomepageHeaderNavConfig
+
+  /** Footer navigation columns + links. */
+  footerNav?: HomepageFooterNavConfig
+  "footer-nav"?: HomepageFooterNavConfig
+
+  /** Footer static copy + icon overrides. */
+  footerUi?: HomepageFooterUiConfig
+  "footer-ui"?: HomepageFooterUiConfig
+
+  /** Header icons + search copy. */
+  headerUi?: HomepageHeaderUiConfig
+  "header-ui"?: HomepageHeaderUiConfig
+
+  /** Promo ticker icon + accessibility copy (merged with `sections.promoAnnouncements`). */
+  promoUi?: HomepagePromoUiConfig
+  "promo-ui"?: HomepagePromoUiConfig
+
   /** Hero carousel — used by `hero` section (not `sections.hero`). */
   "homepage-banner-array"?: HomepageBannerEntry[]
 

package/src/server/index.ts

@@ -5,7 +5,6 @@ export * from "./customer-registration"
 export * from "./customer"
 export * from "./dynamic-config"
 export * from "./page-input"
-export * from "./resolve-home-segment-data"
 export * from "./fulfillment"
 export * from "./guest"
 export * from "./locale-actions"
@@ -22,3 +21,5 @@ export * from "./swaps"
 export * from "./variants"
 export * from "./wishlist"
 export * from "./home"
+export * from "./shoppable-looks"
+export * from "./storefront-cms"

package/src/server/normalize-homepage-config.ts

@@ -263,6 +263,44 @@ export function normalizeHomepageConfig(input: unknown): HomepageConfig {
     sections: sections as HomepageConfig["sections"],
   }
 
+  const headerNav =
+    asObject(site?.headerNav) ?? asObject(site?.["header-nav"]) ?? asObject(site?.nav)
+  if (headerNav) {
+    legacy.headerNav = headerNav as never
+  }
+
+  const footerNav =
+    asObject(site?.footerNav) ??
+    asObject(site?.["footer-nav"]) ??
+    asObject(site?.footer)
+  if (footerNav) {
+    legacy.footerNav = footerNav as never
+  }
+
+  const footerUi =
+    asObject(site?.footerUi) ??
+    asObject(site?.["footer-ui"]) ??
+    asObject(site?.footer)
+  if (footerUi) {
+    legacy.footerUi = footerUi as never
+  }
+
+  const headerUi =
+    asObject(site?.headerUi) ??
+    asObject(site?.["header-ui"]) ??
+    asObject(site?.header)
+  if (headerUi) {
+    legacy.headerUi = headerUi as never
+  }
+
+  const promoUi =
+    asObject(site?.promoUi) ??
+    asObject(site?.["promo-ui"]) ??
+    asObject(site?.promo)
+  if (promoUi) {
+    legacy.promoUi = promoUi as never
+  }
+
   if (desktop.length) legacy["homepage-banner-array"] = desktop as never
   if (mobile.length) legacy["app-banner-array"] = mobile as never
 

package/src/server/page-input.ts

@@ -86,6 +86,7 @@ export function simplifiedHomepageConfigFromDynamicResponse(
   const site: Loose = {}
   if (siteBranding) {
     if (siteBranding.logo != null) site.logo = siteBranding.logo
+    if (siteBranding.brandName != null) site.brandName = siteBranding.brandName
     if (siteBranding.description != null) {
       site.description = siteBranding.description
     }

package/src/server/storefront-cms.ts

@@ -0,0 +1,46 @@
+import "server-only"
+
+import { cache } from "react"
+import type { StorefrontPageInput } from "./page-input"
+import {
+  getContactInfoFromPageInput,
+  getHelpFaqFromPageInput,
+} from "./dynamic-config"
+import { getDynamicConfig, homepageConfigFromDynamicResponse } from "./dynamic-config"
+
+type Maybe<T> = T | null | undefined
+
+/** Cached CMS merge for the storefront (fetch once per request). */
+export const loadStorefrontPageInput = cache(
+  async (): Promise<StorefrontPageInput> => {
+    const raw = await getDynamicConfig()
+    return homepageConfigFromDynamicResponse(raw)
+  }
+)
+
+export async function resolveStorefrontPageInput(
+  pageInput?: Maybe<StorefrontPageInput>
+): Promise<StorefrontPageInput> {
+  return (pageInput ?? (await loadStorefrontPageInput())) as StorefrontPageInput
+}
+
+export async function loadContactInfoFromStorefrontInput(
+  pageInput?: Maybe<StorefrontPageInput>
+) {
+  const resolved = await resolveStorefrontPageInput(pageInput)
+  return getContactInfoFromPageInput(resolved)
+}
+
+export async function loadContactEmailFromStorefrontInput(
+  pageInput?: Maybe<StorefrontPageInput>
+): Promise<string> {
+  const info = await loadContactInfoFromStorefrontInput(pageInput)
+  return info?.email ?? ""
+}
+
+export async function loadHelpFaqFromStorefrontInput(
+  pageInput?: Maybe<StorefrontPageInput>
+) {
+  const resolved = await resolveStorefrontPageInput(pageInput)
+  return getHelpFaqFromPageInput(resolved)
+}

package/src/server/resolve-home-segment-data.ts

@@ -1,63 +0,0 @@
-import "server-only"
-
-import type { HomepageConfig } from "./homepage-config.types"
-import {
-  getAboutBrandFromPageInput,
-  getAnnouncementMessagesFromPageInput,
-  getAppBannersFromPageInput,
-  getBlogPostsFromPageInput,
-  getBrandPillarsFromPageInput,
-  getFeaturesFromPageInput,
-  getHomeBannersFromPageInput,
-  getHomeSectionsCopyFromPageInput,
-  getInstagramPostsFromPageInput,
-  getPromoCountdownFromPageInput,
-  getTestimonialsFromPageInput,
-  getTrustFeaturesFromPageInput,
-  getVideoStoriesFromPageInput,
-  type AboutBrandConfig,
-  type BlogPostConfig,
-  type BrandPillarConfig,
-  type HomepageBanner,
-  type HomeSectionsCopy,
-  type InstagramPostsData,
-  type TrustFeaturesConfig,
-} from "./dynamic-config"
-
-/** Config-driven homepage fields (no Medusa catalog APIs). */
-export type HomeSegmentConfigData = {
-  homeBanners: HomepageBanner[] | null
-  appBanners: HomepageBanner[] | null
-  whyChooseUsFeatures: ReturnType<typeof getFeaturesFromPageInput>
-  testimonials: ReturnType<typeof getTestimonialsFromPageInput>
-  videoStories: ReturnType<typeof getVideoStoriesFromPageInput>
-  announcementMessages: string[]
-  promoCountdown: ReturnType<typeof getPromoCountdownFromPageInput>
-  aboutBrand: AboutBrandConfig
-  brandPillars: { sectionTitle: string; pillars: BrandPillarConfig[] }
-  blogPosts: BlogPostConfig[]
-  instagramPosts: InstagramPostsData
-  sectionsCopy: HomeSectionsCopy
-  trustFeatures: TrustFeaturesConfig
-}
-
-/** Resolve all segment JSON from `pageInput` (package defaults when omitted). */
-export function resolveHomeSegmentConfigData(
-  pageInput?: HomepageConfig | null
-): HomeSegmentConfigData {
-  return {
-    homeBanners: getHomeBannersFromPageInput(pageInput),
-    appBanners: getAppBannersFromPageInput(pageInput),
-    whyChooseUsFeatures: getFeaturesFromPageInput(pageInput),
-    testimonials: getTestimonialsFromPageInput(pageInput),
-    videoStories: getVideoStoriesFromPageInput(pageInput),
-    announcementMessages: getAnnouncementMessagesFromPageInput(pageInput),
-    promoCountdown: getPromoCountdownFromPageInput(pageInput),
-    aboutBrand: getAboutBrandFromPageInput(pageInput),
-    brandPillars: getBrandPillarsFromPageInput(pageInput),
-    blogPosts: getBlogPostsFromPageInput(pageInput),
-    instagramPosts: getInstagramPostsFromPageInput(pageInput),
-    sectionsCopy: getHomeSectionsCopyFromPageInput(pageInput),
-    trustFeatures: getTrustFeaturesFromPageInput(pageInput),
-  }
-}