medusa-storefront-data 2.5.3 → 2.5.5

package/HOMEPAGE_CONFIG.md

@@ -164,32 +164,39 @@ import { heroHomepageSectionField, bannerSlide } from "medusa-ui-home-config/sec
 
 Compose `options.configs` from `homepageSectionFields` or individual `*HomepageSectionField` exports. Merge API responses with `homepageConfigFromDynamicResponse` from `medusa-storefront-data/dynamic-config`.
 
-Help page FAQs use **`helpFaqHomepageSectionField`** from `medusa-ui-home-config/sections/helpFaq` (also included in `homepageSectionFields`). Store in `homepage-config.sections.helpFaq`:
+Help page FAQs use **`helpFaqHomepageSectionField`** from `medusa-ui-home-config/sections/helpFaq` (also included in `homepageSectionFields`).
+
+**Split dynamic-config keys** (Medusa plugin): store FAQs under `faqs.helpFaq`; homepage sections under `homepage-sections.sections`. `homepageConfigFromDynamicResponse` assembles these automatically:
 
 ```json
 {
-  "sections": {
+  "site-branding": { "logo": "https://…", "description": "" },
+  "contact": { "phone": "", "email": "", "whatsapp": "", "address": "" },
+  "faqs": {
     "helpFaq": {
       "eyebrow": "Knowledge Base",
       "title": "Frequently Asked",
       "titleHighlight": "Questions",
-      "subtitle": "Browse FAQs by topic.",
+      "subtitle": "Browse through our most common questions…",
       "categories": [
         {
-          "category": "Order & Delivery",
-          "icon": "🚚",
-          "color": "from-blue-500 to-cyan-400",
-          "items": [
-            { "question": "When will I receive my order?", "answer": "…" }
-          ]
+          "category": {
+            "category": "Order & Delivery",
+            "icon": "🚚",
+            "color": "from-blue-500 to-cyan-400",
+            "items": [
+              { "faq": { "question": "When will I receive my order?", "answer": "…" } }
+            ]
+          }
         }
       ]
     }
-  }
+  },
+  "homepage-sections": { "sections": { "newArrivals": { "title": "New Arrivals" } } }
 }
 ```
 
-Legacy flat `faq-array` entries are still supported and are grouped by `faq-category`.
+Legacy single `homepage-config` with `sections.helpFaq` (flat `items` or nested `category` / `faq` wrappers) still works. Legacy flat `faq-array` entries are grouped by `faq-category`.
 
 Storefront UI still imports from `medusa-ui-home/sections/<id>`.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "medusa-storefront-data",
-  "version": "2.5.3",
+  "version": "2.5.5",
   "type": "module",
   "description": "Medusa storefront server data layer extracted from Next.js storefront",
   "license": "MIT",
@@ -53,165 +53,125 @@
       "import": "./src/server/index.ts",
       "default": "./src/server/index.ts"
     },
-    "./cookies": {
-      "types": "./dist/cookies.d.ts",
-      "import": "./src/cookies.ts",
-      "default": "./src/cookies.ts"
-    },
-    "./config": {
-      "types": "./dist/config.d.ts",
-      "import": "./src/config.ts",
-      "default": "./src/config.ts"
-    },
-    "./locale-header": {
-      "types": "./dist/util/get-locale-header.d.ts",
-      "import": "./src/util/get-locale-header.ts",
-      "default": "./src/util/get-locale-header.ts"
-    },
-    "./medusa-error": {
-      "types": "./dist/util/medusa-error.d.ts",
-      "import": "./src/util/medusa-error.ts",
-      "default": "./src/util/medusa-error.ts"
-    },
-    "./sort-products": {
-      "types": "./dist/util/sort-products.d.ts",
-      "import": "./src/util/sort-products.ts",
-      "default": "./src/util/sort-products.ts"
-    },
-    "./middleware": {
-      "types": "./dist/middleware.d.ts",
-      "import": "./src/middleware.ts",
-      "default": "./src/middleware.ts"
-    },
-    "./edge": {
-      "types": "./dist/edge.d.ts",
-      "import": "./src/edge.ts",
-      "default": "./src/edge.ts"
-    },
-    "./cart": {
-      "types": "./dist/server/cart.d.ts",
-      "import": "./src/server/cart.ts",
-      "default": "./src/server/cart.ts"
-    },
-    "./categories": {
-      "types": "./dist/server/categories.d.ts",
-      "import": "./src/server/categories.ts",
-      "default": "./src/server/categories.ts"
-    },
-    "./collections": {
-      "types": "./dist/server/collections.d.ts",
-      "import": "./src/server/collections.ts",
-      "default": "./src/server/collections.ts"
-    },
-    "./contact": {
-      "types": "./dist/server/contact.d.ts",
-      "import": "./src/server/contact.ts",
-      "default": "./src/server/contact.ts"
-    },
-    "./customer": {
-      "types": "./dist/server/customer.d.ts",
-      "import": "./src/server/customer.ts",
-      "default": "./src/server/customer.ts"
-    },
-    "./customer-registration": {
-      "types": "./dist/server/customer-registration.d.ts",
-      "import": "./src/server/customer-registration.ts",
-      "default": "./src/server/customer-registration.ts"
-    },
-    "./dynamic-config": {
-      "types": "./dist/server/dynamic-config.d.ts",
-      "import": "./src/server/dynamic-config.ts",
-      "default": "./src/server/dynamic-config.ts"
+    "./home/sections/promoAnnouncements": {
+      "types": "./dist/server/home-sections/promo-announcements.d.ts",
+      "import": "./src/server/home-sections/promo-announcements.ts",
+      "default": "./src/server/home-sections/promo-announcements.ts"
+    },
+    "./home/sections/hero": {
+      "types": "./dist/server/home-sections/hero.d.ts",
+      "import": "./src/server/home-sections/hero.ts",
+      "default": "./src/server/home-sections/hero.ts"
+    },
+    "./home/sections/categoryPills": {
+      "types": "./dist/server/home-sections/category-pills.d.ts",
+      "import": "./src/server/home-sections/category-pills.ts",
+      "default": "./src/server/home-sections/category-pills.ts"
+    },
+    "./home/sections/newArrivals": {
+      "types": "./dist/server/home-sections/new-arrivals.d.ts",
+      "import": "./src/server/home-sections/new-arrivals.ts",
+      "default": "./src/server/home-sections/new-arrivals.ts"
+    },
+    "./home/sections/newArrivalsClassic": {
+      "types": "./dist/server/home-sections/new-arrivals-classic.d.ts",
+      "import": "./src/server/home-sections/new-arrivals-classic.ts",
+      "default": "./src/server/home-sections/new-arrivals-classic.ts"
+    },
+    "./home/sections/promoCountdown": {
+      "types": "./dist/server/home-sections/promo-countdown.d.ts",
+      "import": "./src/server/home-sections/promo-countdown.ts",
+      "default": "./src/server/home-sections/promo-countdown.ts"
+    },
+    "./home/sections/celebrityTrust": {
+      "types": "./dist/server/home-sections/celebrity-trust.d.ts",
+      "import": "./src/server/home-sections/celebrity-trust.ts",
+      "default": "./src/server/home-sections/celebrity-trust.ts"
+    },
+    "./home/sections/luxeFavourites": {
+      "types": "./dist/server/home-sections/luxe-favourites.d.ts",
+      "import": "./src/server/home-sections/luxe-favourites.ts",
+      "default": "./src/server/home-sections/luxe-favourites.ts"
+    },
+    "./home/sections/shopByCategory": {
+      "types": "./dist/server/home-sections/shop-by-category.d.ts",
+      "import": "./src/server/home-sections/shop-by-category.ts",
+      "default": "./src/server/home-sections/shop-by-category.ts"
+    },
+    "./home/sections/baptism": {
+      "types": "./dist/server/home-sections/baptism.d.ts",
+      "import": "./src/server/home-sections/baptism.ts",
+      "default": "./src/server/home-sections/baptism.ts"
+    },
+    "./home/sections/baptismPicks": {
+      "types": "./dist/server/home-sections/baptism-picks.d.ts",
+      "import": "./src/server/home-sections/baptism-picks.ts",
+      "default": "./src/server/home-sections/baptism-picks.ts"
+    },
+    "./home/sections/themeDresses": {
+      "types": "./dist/server/home-sections/theme-dresses.d.ts",
+      "import": "./src/server/home-sections/theme-dresses.ts",
+      "default": "./src/server/home-sections/theme-dresses.ts"
+    },
+    "./home/sections/brandMarquee": {
+      "types": "./dist/server/home-sections/brand-marquee.d.ts",
+      "import": "./src/server/home-sections/brand-marquee.ts",
+      "default": "./src/server/home-sections/brand-marquee.ts"
+    },
+    "./home/sections/aboutBrand": {
+      "types": "./dist/server/home-sections/about-brand.d.ts",
+      "import": "./src/server/home-sections/about-brand.ts",
+      "default": "./src/server/home-sections/about-brand.ts"
+    },
+    "./home/sections/testimonials": {
+      "types": "./dist/server/home-sections/testimonials.d.ts",
+      "import": "./src/server/home-sections/testimonials.ts",
+      "default": "./src/server/home-sections/testimonials.ts"
+    },
+    "./home/sections/brandPillars": {
+      "types": "./dist/server/home-sections/brand-pillars.d.ts",
+      "import": "./src/server/home-sections/brand-pillars.ts",
+      "default": "./src/server/home-sections/brand-pillars.ts"
+    },
+    "./home/sections/instagramPosts": {
+      "types": "./dist/server/home-sections/instagram-posts.d.ts",
+      "import": "./src/server/home-sections/instagram-posts.ts",
+      "default": "./src/server/home-sections/instagram-posts.ts"
+    },
+    "./home/sections/features": {
+      "types": "./dist/server/home-sections/features.d.ts",
+      "import": "./src/server/home-sections/features.ts",
+      "default": "./src/server/home-sections/features.ts"
+    },
+    "./home/sections/shopByAge": {
+      "types": "./dist/server/home-sections/shop-by-age.d.ts",
+      "import": "./src/server/home-sections/shop-by-age.ts",
+      "default": "./src/server/home-sections/shop-by-age.ts"
+    },
+    "./home/sections/whyChooseUs": {
+      "types": "./dist/server/home-sections/why-choose-us.d.ts",
+      "import": "./src/server/home-sections/why-choose-us.ts",
+      "default": "./src/server/home-sections/why-choose-us.ts"
+    },
+    "./home/sections/lovedByMoms": {
+      "types": "./dist/server/home-sections/loved-by-moms.d.ts",
+      "import": "./src/server/home-sections/loved-by-moms.ts",
+      "default": "./src/server/home-sections/loved-by-moms.ts"
+    },
+    "./home/sections/videoStories": {
+      "types": "./dist/server/home-sections/video-stories.d.ts",
+      "import": "./src/server/home-sections/video-stories.ts",
+      "default": "./src/server/home-sections/video-stories.ts"
+    },
+    "./home/sections/blogPosts": {
+      "types": "./dist/server/home-sections/blog-posts.d.ts",
+      "import": "./src/server/home-sections/blog-posts.ts",
+      "default": "./src/server/home-sections/blog-posts.ts"
     },
     "./help/sections/helpFaq": {
       "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"
-    },
-    "./fulfillment": {
-      "types": "./dist/server/fulfillment.d.ts",
-      "import": "./src/server/fulfillment.ts",
-      "default": "./src/server/fulfillment.ts"
-    },
-    "./guest": {
-      "types": "./dist/server/guest.d.ts",
-      "import": "./src/server/guest.ts",
-      "default": "./src/server/guest.ts"
-    },
-    "./home": {
-      "types": "./dist/server/home.d.ts",
-      "import": "./src/server/home.ts",
-      "default": "./src/server/home.ts"
-    },
-    "./locale-actions": {
-      "types": "./dist/server/locale-actions.d.ts",
-      "import": "./src/server/locale-actions.ts",
-      "default": "./src/server/locale-actions.ts"
-    },
-    "./locales": {
-      "types": "./dist/server/locales.d.ts",
-      "import": "./src/server/locales.ts",
-      "default": "./src/server/locales.ts"
-    },
-    "./notifications": {
-      "types": "./dist/server/notifications.d.ts",
-      "import": "./src/server/notifications.ts",
-      "default": "./src/server/notifications.ts"
-    },
-    "./onboarding": {
-      "types": "./dist/server/onboarding.d.ts",
-      "import": "./src/server/onboarding.ts",
-      "default": "./src/server/onboarding.ts"
-    },
-    "./orders": {
-      "types": "./dist/server/orders.d.ts",
-      "import": "./src/server/orders.ts",
-      "default": "./src/server/orders.ts"
-    },
-    "./payment": {
-      "types": "./dist/server/payment.d.ts",
-      "import": "./src/server/payment.ts",
-      "default": "./src/server/payment.ts"
-    },
-    "./payment-details": {
-      "types": "./dist/server/payment-details.d.ts",
-      "import": "./src/server/payment-details.ts",
-      "default": "./src/server/payment-details.ts"
-    },
-    "./pincode": {
-      "types": "./dist/server/pincode.d.ts",
-      "import": "./src/server/pincode.ts",
-      "default": "./src/server/pincode.ts"
-    },
-    "./products": {
-      "types": "./dist/server/products.d.ts",
-      "import": "./src/server/products.ts",
-      "default": "./src/server/products.ts"
-    },
-    "./regions": {
-      "types": "./dist/server/regions.d.ts",
-      "import": "./src/server/regions.ts",
-      "default": "./src/server/regions.ts"
-    },
-    "./returns": {
-      "types": "./dist/server/returns.d.ts",
-      "import": "./src/server/returns.ts",
-      "default": "./src/server/returns.ts"
-    },
-    "./swaps": {
-      "types": "./dist/server/swaps.d.ts",
-      "import": "./src/server/swaps.ts",
-      "default": "./src/server/swaps.ts"
-    },
-    "./variants": {
-      "types": "./dist/server/variants.d.ts",
-      "import": "./src/server/variants.ts",
-      "default": "./src/server/variants.ts"
-    },
-    "./wishlist": {
-      "types": "./dist/server/wishlist.d.ts",
-      "import": "./src/server/wishlist.ts",
-      "default": "./src/server/wishlist.ts"
     }
   },
   "main": "./dist/server/index.js",

package/src/server/dynamic-config.ts

@@ -16,6 +16,7 @@ export {
   mergePageInputWithDefaults,
   resolvePageInput,
   homepageConfigFromDynamicResponse,
+  simplifiedHomepageConfigFromDynamicResponse,
   type StorefrontPageInput,
 } from "./page-input"
 

package/src/server/page-input.ts

@@ -1,10 +1,19 @@
 import "server-only"
 
 import defaultPageInputJson from "../../segment-data/default-page-input.json"
-import type { HomepageConfig } from "./homepage-config.types"
+import type {
+  DynamicConfigResponse,
+  HomepageConfig,
+} from "./homepage-config.types"
 import { mergeSectionBlock } from "./config-merge"
 import { normalizeHomepageConfig } from "./normalize-homepage-config"
 
+type Loose = Record<string, unknown>
+
+function asObject(v: unknown): Loose | null {
+  return v && typeof v === "object" && !Array.isArray(v) ? (v as Loose) : null
+}
+
 /** Full `homepage-config` blob passed from the main project into pages and layout. */
 export type StorefrontPageInput = HomepageConfig
 
@@ -55,12 +64,57 @@ export function resolvePageInput(
   return mergePageInputWithDefaults(pageInput ?? null)
 }
 
+/**
+ * Medusa plugin split keys (`site-branding`, `contact`, `faqs`, `homepage-sections`)
+ * → simplified `{ site, sections }` for {@link normalizeHomepageConfig}.
+ */
+export function simplifiedHomepageConfigFromDynamicResponse(
+  response: DynamicConfigResponse | null | undefined
+): HomepageConfig | null {
+  if (!response || typeof response !== "object") return null
+
+  const siteBranding = asObject(response["site-branding"])
+  const contact = asObject(response.contact)
+  const faqsRoot = asObject(response.faqs)
+  const homepageSections = asObject(response["homepage-sections"])
+  const sectionsFromCms = asObject(homepageSections?.sections)
+
+  const hasSplitKeys =
+    siteBranding || contact || faqsRoot || sectionsFromCms
+  if (!hasSplitKeys) return null
+
+  const site: Loose = {}
+  if (siteBranding) {
+    if (siteBranding.logo != null) site.logo = siteBranding.logo
+    if (siteBranding.description != null) {
+      site.description = siteBranding.description
+    }
+  }
+  if (contact) site.contact = contact
+
+  const sections: Loose = sectionsFromCms ? { ...sectionsFromCms } : {}
+  const helpFaq = asObject(faqsRoot?.helpFaq)
+  if (helpFaq) sections.helpFaq = helpFaq
+
+  const simplified: Loose = {}
+  if (Object.keys(site).length) simplified.site = site
+  if (Object.keys(sections).length) simplified.sections = sections
+
+  return Object.keys(simplified).length
+    ? (simplified as HomepageConfig)
+    : null
+}
+
 /**
  * Build `homepage-config` from Medusa `GET /store/dynamic-config` (main project only).
+ * Supports legacy `homepage-config` or split plugin keys.
  */
 export function homepageConfigFromDynamicResponse(
-  response: { "homepage-config"?: HomepageConfig | null } | null | undefined
+  response: DynamicConfigResponse | null | undefined
 ): StorefrontPageInput {
-  const normalized = normalizeHomepageConfig(response?.["homepage-config"] ?? null)
+  const legacy = response?.["homepage-config"] ?? null
+  const fromSplit = simplifiedHomepageConfigFromDynamicResponse(response)
+  const raw = fromSplit ?? legacy
+  const normalized = normalizeHomepageConfig(raw)
   return mergePageInputWithDefaults(normalized)
 }