@faststore/core 3.22.3 → 3.24.0

package/.turbo/turbo-build.log

@@ -1,23 +1,23 @@
 
-> @faststore/core@3.22.2 prebuild /home/runner/work/faststore/faststore/packages/core
+> @faststore/core@3.23.0 prebuild /home/runner/work/faststore/faststore/packages/core
 > na run partytown && na run generate
 
 
-> @faststore/core@3.22.2 partytown /home/runner/work/faststore/faststore/packages/core
+> @faststore/core@3.23.0 partytown /home/runner/work/faststore/faststore/packages/core
 > partytown copylib ./public/~partytown
 
 Partytown lib copied to: /home/runner/work/faststore/faststore/packages/core/public/~partytown
 
-> @faststore/core@3.22.2 generate /home/runner/work/faststore/faststore/packages/core
+> @faststore/core@3.23.0 generate /home/runner/work/faststore/faststore/packages/core
 > na run generate:schema && na run generate:codegen && na run format:generated
 
 
-> @faststore/core@3.22.2 generate:schema /home/runner/work/faststore/faststore/packages/core
+> @faststore/core@3.23.0 generate:schema /home/runner/work/faststore/faststore/packages/core
 > tsx src/server/generator/generateGraphQLSchemaFile.ts
 
 Schema GraphQL file generated successfully
 
-> @faststore/core@3.22.2 generate:codegen /home/runner/work/faststore/faststore/packages/core
+> @faststore/core@3.23.0 generate:codegen /home/runner/work/faststore/faststore/packages/core
 > graphql-codegen
 
 [STARTED] Parse Configuration
@@ -37,11 +37,11 @@ Running lifecycle hook "afterStart" scripts...
 [CLI] Loading Documents
 [CLI] Generating output
 
-> @faststore/core@3.22.2 format:generated /home/runner/work/faststore/faststore/packages/core
+> @faststore/core@3.23.0 format:generated /home/runner/work/faststore/faststore/packages/core
 > prettier --write "@generated/**/*.{ts,js,tsx,jsx,json}" --loglevel error
 
 
-> @faststore/core@3.22.2 build /home/runner/work/faststore/faststore/packages/core
+> @faststore/core@3.23.0 build /home/runner/work/faststore/faststore/packages/core
 > next build
 
 ⚠ No build cache found. Please configure build caching for faster rebuilds. Read more: https://nextjs.org/docs/messages/no-cache
@@ -58,11 +58,17 @@ https://nextjs.org/telemetry
  ✓ Compiled successfully
    Collecting page data ...
    Generating static pages (0/7) ...
+BannerText not found. Add a new component for this section or remove it from the CMS
+BannerText not found. Add a new component for this section or remove it from the CMS
 
   Generating static pages (1/7) 
-
   Generating static pages (3/7) 
 Warning: Dynamic Content not found for the page: home. Refer to the Dynamic Content documentation at https://developers.vtex.com/docs/guides/faststore/dynamic-content-overview for mapping the page and the corresponding data-fetching function.
-CustomModalFooterSection not found. Add a new component for this section or remove it from the CMS
+BannerText not found. Add a new component for this section or remove it from the CMS
+
   Generating static pages (3/7) 
+BannerText not found. Add a new component for this section or remove it from the CMS
+BannerText not found. Add a new component for this section or remove it from the CMS
 
   Generating static pages (5/7) 
+CustomModalFooterSection not found. Add a new component for this section or remove it from the CMS
+BannerText not found. Add a new component for this section or remove it from the CMS
 
 ✓ Generating static pages (7/7) 
    Finalizing page optimization ...
    Collecting build traces ...
@@ -90,7 +96,7 @@ Route (pages)                              Size     First Load JS
   ├ chunks/framework-807b0f81cbc129f0.js   45.4 kB
   ├ chunks/main-1617ca75abfe1b79.js        33.1 kB
   ├ chunks/pages/_app-859f97f9c8a57799.js  10.2 kB
-  ├ chunks/webpack-73f875a3fea96a4a.js     3.58 kB
+  ├ chunks/webpack-0d600424e508dae8.js     3.58 kB
   └ css/2eafb8997a3946dc.css               3.07 kB
 
 λ  (Server)  server-side renders at runtime (uses getInitialProps or getServerSideProps)

package/.turbo/turbo-test.log

@@ -1,13 +1,14 @@
 
-> @faststore/core@3.22.2 test /home/runner/work/faststore/faststore/packages/core
+> @faststore/core@3.23.0 test /home/runner/work/faststore/faststore/packages/core
 > jest
 
-PASS test/utils/multipleTemplates.test.ts (28.841 s)
-PASS test/server/cms/index.test.ts (29.666 s)
-PASS test/server/index.test.ts (33.771 s)
+PASS test/server/cms/global.test.ts (29.677 s)
+PASS test/utils/multipleTemplates.test.ts (29.737 s)
+PASS test/server/cms/index.test.ts
+PASS test/server/index.test.ts (34.962 s)
 
-Test Suites: 3 passed, 3 total
-Tests:       19 passed, 19 total
+Test Suites: 4 passed, 4 total
+Tests:       22 passed, 22 total
 Snapshots:   0 total
-Time:        34.961 s
+Time:        36.265 s
 Ran all test suites.

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.24.0](https://github.com/vtex/faststore/compare/v3.23.0...v3.24.0) (2025-02-26)
+
+### Features
+
+- Multiple global content types ([#2668](https://github.com/vtex/faststore/issues/2668)) ([8555310](https://github.com/vtex/faststore/commit/85553101b1d8f3ec510259007ff1d594ec33c338))
+
+# [3.23.0](https://github.com/vtex/faststore/compare/v3.22.3...v3.23.0) (2025-02-26)
+
+**Note:** Version bump only for package @faststore/core
+
 ## [3.22.3](https://github.com/vtex/faststore/compare/v3.22.2...v3.22.3) (2025-02-24)
 
 ### Bug Fixes

package/cms/faststore/content-types.json

@@ -6,6 +6,20 @@
     "configurationSchemaSets": [],
     "isSingleton": true
   },
+  {
+    "id": "globalHeaderSections",
+    "name": "Global Header Sections",
+    "scopes": ["global"],
+    "configurationSchemaSets": [],
+    "isSingleton": true
+  },
+  {
+    "id": "globalFooterSections",
+    "name": "Global Footer Sections",
+    "scopes": ["global"],
+    "configurationSchemaSets": [],
+    "isSingleton": true
+  },
   {
     "id": "landingPage",
     "name": "Landing Page",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/core",
-  "version": "3.22.3",
+  "version": "3.24.0",
   "license": "MIT",
   "repository": "vtex/faststore",
   "browserslist": "supports es6-module and not dead",
@@ -44,7 +44,7 @@
     "@envelop/graphql-jit": "^8.0.3",
     "@envelop/parser-cache": "^6.0.2",
     "@envelop/validation-cache": "^6.0.2",
-    "@faststore/api": "^3.22.2",
+    "@faststore/api": "^3.23.0",
     "@faststore/components": "^3.22.2",
     "@faststore/graphql-utils": "^3.22.2",
     "@faststore/lighthouse": "^3.22.2",
@@ -104,5 +104,5 @@
     "ts-jest": "29.1.1",
     "typescript": "5.3.2"
   },
-  "gitHead": "b218413fdfbcc051aacab14d6f95d1fe82fc8bd1"
+  "gitHead": "02a79fb627a9ca1edf65b576102322fd5968e271"
 }

package/src/components/cms/GlobalSections.tsx

@@ -3,21 +3,24 @@ import storeConfig from 'discovery.config'
 import { type PageContentType, getPage } from 'src/server/cms'
 
 export const GLOBAL_SECTIONS_CONTENT_TYPE = 'globalSections'
+export const GLOBAL_SECTIONS_HEADER_CONTENT_TYPE = 'globalHeaderSections'
+export const GLOBAL_SECTIONS_FOOTER_CONTENT_TYPE = 'globalFooterSections'
 
 export type GlobalSectionsData = {
   sections: Section[]
 }
 
-export const getGlobalSectionsData = async (
-  previewData: Locator
+export const getGlobalSectionsByType = async (
+  previewData: Locator,
+  contentType: string
 ): Promise<GlobalSectionsData> => {
   if (storeConfig.cms.data) {
     const cmsData = JSON.parse(storeConfig.cms.data)
-    const page = cmsData[GLOBAL_SECTIONS_CONTENT_TYPE][0]
+    const page = cmsData[contentType][0]
 
     if (page) {
       const pageData = getPage<PageContentType>({
-        contentType: GLOBAL_SECTIONS_CONTENT_TYPE,
+        contentType: contentType,
         documentId: page.documentId,
         versionId: page.versionId,
       })
@@ -27,10 +30,28 @@ export const getGlobalSectionsData = async (
   }
 
   const pageData = getPage<PageContentType>({
-    ...(previewData?.contentType === GLOBAL_SECTIONS_CONTENT_TYPE &&
-      previewData),
-    contentType: GLOBAL_SECTIONS_CONTENT_TYPE,
+    ...(previewData?.contentType === contentType && previewData),
+    contentType: contentType,
   })
 
   return pageData
 }
+
+export const getGlobalSectionsData = (
+  previewData: Locator
+): Promise<GlobalSectionsData>[] => {
+  const globalSections = getGlobalSectionsByType(
+    previewData,
+    GLOBAL_SECTIONS_CONTENT_TYPE
+  )
+  const globalHeaderSections = getGlobalSectionsByType(
+    previewData,
+    GLOBAL_SECTIONS_HEADER_CONTENT_TYPE
+  )
+  const globalFooterSections = getGlobalSectionsByType(
+    previewData,
+    GLOBAL_SECTIONS_FOOTER_CONTENT_TYPE
+  )
+
+  return [globalSections, globalHeaderSections, globalFooterSections]
+}

package/src/experimental/searchServerSideFunctions/getServerSideProps.ts

@@ -1,10 +1,11 @@
 import type { GetServerSideProps } from 'next'
 import type { SearchPageProps } from './getStaticProps'
 
-import { getGlobalSectionsData } from 'src/components/cms/GlobalSections'
-import { type SearchContentType, getPage } from 'src/server/cms'
 import type { Locator } from '@vtex/client-cms'
 import storeConfig from 'discovery.config'
+import { getGlobalSectionsData } from 'src/components/cms/GlobalSections'
+import { type SearchContentType, getPage } from 'src/server/cms'
+import { injectGlobalSections } from 'src/server/cms/global'
 
 export const getServerSideProps: GetServerSideProps<
   SearchPageProps,
@@ -14,26 +15,62 @@ export const getServerSideProps: GetServerSideProps<
   const { previewData, query, res } = context
   const searchTerm = (query.q as string)?.split('+').join(' ')
 
-  const globalSections = await getGlobalSectionsData(previewData)
+  const [
+    globalSectionsPromise,
+    globalSectionsHeaderPromise,
+    globalSectionsFooterPromise,
+  ] = getGlobalSectionsData(previewData)
 
   if (storeConfig.cms.data) {
     const cmsData = JSON.parse(storeConfig.cms.data)
     const page = cmsData['search'][0]
     if (page) {
-      const pageData = await getPage<SearchContentType>({
-        contentType: 'search',
-        documentId: page.documentId,
-        versionId: page.versionId,
+      const [
+        pageData,
+        globalSections,
+        globalSectionsHeader,
+        globalSectionsFooter,
+      ] = await Promise.all([
+        getPage<SearchContentType>({
+          contentType: 'search',
+          documentId: page.documentId,
+          versionId: page.versionId,
+        }),
+        globalSectionsPromise,
+        globalSectionsHeaderPromise,
+        globalSectionsFooterPromise,
+      ])
+
+      const globalSectionsResult = injectGlobalSections({
+        globalSections,
+        globalSectionsHeader,
+        globalSectionsFooter,
       })
       return {
-        props: { page: pageData, globalSections, searchTerm },
+        props: {
+          page: pageData,
+          globalSections: globalSectionsResult,
+          searchTerm,
+        },
       }
     }
   }
 
-  const page = await getPage<SearchContentType>({
-    ...(previewData?.contentType === 'search' ? previewData : null),
-    contentType: 'search',
+  const [page, globalSections, globalSectionsHeader, globalSectionsFooter] =
+    await Promise.all([
+      getPage<SearchContentType>({
+        ...(previewData?.contentType === 'search' ? previewData : null),
+        contentType: 'search',
+      }),
+      globalSectionsPromise,
+      globalSectionsHeaderPromise,
+      globalSectionsFooterPromise,
+    ])
+
+  const globalSectionsResult = injectGlobalSections({
+    globalSections,
+    globalSectionsHeader,
+    globalSectionsFooter,
   })
 
   res.setHeader(
@@ -44,7 +81,7 @@ export const getServerSideProps: GetServerSideProps<
   return {
     props: {
       page,
-      globalSections,
+      globalSections: globalSectionsResult,
       searchTerm,
     },
   }

package/src/experimental/searchServerSideFunctions/getStaticProps.ts

@@ -1,11 +1,12 @@
+import type { Locator } from '@vtex/client-cms'
+import storeConfig from 'discovery.config'
 import type { GetStaticProps } from 'next'
 import {
   getGlobalSectionsData,
   type GlobalSectionsData,
 } from 'src/components/cms/GlobalSections'
-import { type SearchContentType, getPage } from 'src/server/cms'
-import type { Locator } from '@vtex/client-cms'
-import storeConfig from 'discovery.config'
+import { getPage, type SearchContentType } from 'src/server/cms'
+import { injectGlobalSections } from 'src/server/cms/global'
 
 export type SearchPageProps = {
   page: SearchContentType
@@ -13,8 +14,8 @@ export type SearchPageProps = {
   searchTerm?: string
 }
 
-/* 
-  Depending on the value of the storeConfig.experimental.enableSearchSSR flag, the function used will be getServerSideProps (./getServerSideProps). 
+/*
+  Depending on the value of the storeConfig.experimental.enableSearchSSR flag, the function used will be getServerSideProps (./getServerSideProps).
   Our CLI that does this process of converting from getStaticProps to getServerSideProps.
 */
 export const getStaticProps: GetStaticProps<
@@ -24,34 +25,66 @@ export const getStaticProps: GetStaticProps<
 > = async (context) => {
   const { previewData } = context
 
-  const globalSections = await getGlobalSectionsData(previewData)
+  const [
+    globalSectionsPromise,
+    globalSectionsHeaderPromise,
+    globalSectionsFooterPromise,
+  ] = getGlobalSectionsData(previewData)
 
   if (storeConfig.cms.data) {
     const cmsData = JSON.parse(storeConfig.cms.data)
     const page = cmsData['search'][0]
 
     if (page) {
-      const pageData = await getPage<SearchContentType>({
-        contentType: 'search',
-        documentId: page.documentId,
-        versionId: page.versionId,
+      const [
+        pageData,
+        globalSections,
+        globalSectionsHeader,
+        globalSectionsFooter,
+      ] = await Promise.all([
+        getPage<SearchContentType>({
+          contentType: 'search',
+          documentId: page.documentId,
+          versionId: page.versionId,
+        }),
+        globalSectionsPromise,
+        globalSectionsHeaderPromise,
+        globalSectionsFooterPromise,
+      ])
+
+      const globalSectionsResult = injectGlobalSections({
+        globalSections,
+        globalSectionsHeader,
+        globalSectionsFooter,
       })
 
       return {
-        props: { page: pageData, globalSections },
+        props: { page: pageData, globalSections: globalSectionsResult },
       }
     }
   }
 
-  const page = await getPage<SearchContentType>({
-    ...(previewData?.contentType === 'search' ? previewData : null),
-    contentType: 'search',
+  const [page, globalSections, globalSectionsHeader, globalSectionsFooter] =
+    await Promise.all([
+      getPage<SearchContentType>({
+        ...(previewData?.contentType === 'search' ? previewData : null),
+        contentType: 'search',
+      }),
+      globalSectionsPromise,
+      globalSectionsHeaderPromise,
+      globalSectionsFooterPromise,
+    ])
+
+  const globalSectionsResult = injectGlobalSections({
+    globalSections,
+    globalSectionsHeader,
+    globalSectionsFooter,
   })
 
   return {
     props: {
       page,
-      globalSections,
+      globalSections: globalSectionsResult,
     },
   }
 }

package/src/pages/404.tsx

@@ -10,9 +10,10 @@ import {
 import { default as GLOBAL_COMPONENTS } from 'src/components/cms/global/Components'
 import RenderSections from 'src/components/cms/RenderSections'
 import { OverriddenDefaultEmptyState as EmptyState } from 'src/components/sections/EmptyState/OverriddenDefaultEmptyState'
-import PLUGINS_COMPONENTS from 'src/plugins'
 import CUSTOM_COMPONENTS from 'src/customizations/src/components'
+import PLUGINS_COMPONENTS from 'src/plugins'
 import { type PageContentType, getPage } from 'src/server/cms'
+import { injectGlobalSections } from 'src/server/cms/global'
 
 /* A list of components that can be used in the CMS. */
 const COMPONENTS: Record<string, ComponentType<any>> = {
@@ -56,16 +57,31 @@ export const getStaticProps: GetStaticProps<
   Record<string, string>,
   Locator
 > = async ({ previewData }) => {
-  const [page, globalSections] = await Promise.all([
-    getPage<PageContentType>({
-      ...(previewData?.contentType === '404' && previewData),
-      contentType: '404',
-    }),
-    getGlobalSectionsData(previewData),
-  ])
+  const [
+    globalSectionsPromise,
+    globalSectionsHeaderPromise,
+    globalSectionsFooterPromise,
+  ] = getGlobalSectionsData(previewData)
+
+  const [page, globalSections, globalSectionsHeader, globalSectionsFooter] =
+    await Promise.all([
+      getPage<PageContentType>({
+        ...(previewData?.contentType === '404' && previewData),
+        contentType: '404',
+      }),
+      globalSectionsPromise,
+      globalSectionsHeaderPromise,
+      globalSectionsFooterPromise,
+    ])
+
+  const globalSectionsResult = injectGlobalSections({
+    globalSections,
+    globalSectionsHeader,
+    globalSectionsFooter,
+  })
 
   return {
-    props: { page, globalSections },
+    props: { page, globalSections: globalSectionsResult },
   }
 }
 

package/src/pages/500.tsx

@@ -10,9 +10,10 @@ import {
 import { default as GLOBAL_COMPONENTS } from 'src/components/cms/global/Components'
 import RenderSections from 'src/components/cms/RenderSections'
 import { OverriddenDefaultEmptyState as EmptyState } from 'src/components/sections/EmptyState/OverriddenDefaultEmptyState'
-import PLUGINS_COMPONENTS from 'src/plugins'
 import CUSTOM_COMPONENTS from 'src/customizations/src/components'
+import PLUGINS_COMPONENTS from 'src/plugins'
 import { type PageContentType, getPage } from 'src/server/cms'
+import { injectGlobalSections } from 'src/server/cms/global'
 
 /* A list of components that can be used in the CMS. */
 const COMPONENTS: Record<string, ComponentType<any>> = {
@@ -57,16 +58,31 @@ export const getStaticProps: GetStaticProps<
   Record<string, string>,
   Locator
 > = async ({ previewData }) => {
-  const [page, globalSections] = await Promise.all([
-    getPage<PageContentType>({
-      ...(previewData?.contentType === '500' && previewData),
-      contentType: '500',
-    }),
-    getGlobalSectionsData(previewData),
-  ])
+  const [
+    globalSectionsPromise,
+    globalSectionsHeaderPromise,
+    globalSectionsFooterPromise,
+  ] = getGlobalSectionsData(previewData)
+
+  const [page, globalSections, globalSectionsHeader, globalSectionsFooter] =
+    await Promise.all([
+      getPage<PageContentType>({
+        ...(previewData?.contentType === '500' && previewData),
+        contentType: '500',
+      }),
+      globalSectionsPromise,
+      globalSectionsHeaderPromise,
+      globalSectionsFooterPromise,
+    ])
+
+  const globalSectionsResult = injectGlobalSections({
+    globalSections,
+    globalSectionsHeader,
+    globalSectionsFooter,
+  })
 
   return {
-    props: { page, globalSections },
+    props: { page, globalSections: globalSectionsResult },
   }
 }
 

package/src/pages/[...slug].tsx

@@ -24,6 +24,7 @@ import ProductListingPage, {
 } from 'src/components/templates/ProductListingPage'
 import { getRedirect } from 'src/sdk/redirects'
 import type { PageContentType } from 'src/server/cms'
+import { injectGlobalSections } from 'src/server/cms/global'
 import { getPLP, type PLPContentType } from 'src/server/cms/plp'
 import { getDynamicContent } from 'src/utils/dynamicContent'
 
@@ -102,23 +103,39 @@ export const getStaticProps: GetStaticProps<
   const slug = params?.slug.join('/') ?? ''
   const rewrites = (await storeConfig.rewrites?.()) ?? []
 
-  const [landingPagePromise, globalSectionsPromise] = [
-    getLandingPageBySlug(slug, previewData),
-    getGlobalSectionsData(previewData),
-  ]
+  const [
+    globalSectionsPromise,
+    globalSectionsHeaderPromise,
+    globalSectionsFooterPromise,
+  ] = getGlobalSectionsData(previewData)
+
+  const landingPagePromise = getLandingPageBySlug(slug, previewData)
 
   const landingPage = await landingPagePromise
 
   if (landingPage) {
-    const [serverData, globalSections] = await Promise.all([
+    const [
+      serverData,
+      globalSections,
+      globalSectionsHeader,
+      globalSectionsFooter,
+    ] = await Promise.all([
       getDynamicContent({ pageType: slug }),
       globalSectionsPromise,
+      globalSectionsHeaderPromise,
+      globalSectionsFooterPromise,
     ])
 
+    const globalSectionsResult = injectGlobalSections({
+      globalSections,
+      globalSectionsHeader,
+      globalSectionsFooter,
+    })
+
     return {
       props: {
         page: landingPage,
-        globalSections,
+        globalSections: globalSectionsResult,
         type: 'page',
         slug,
         serverData,
@@ -126,7 +143,13 @@ export const getStaticProps: GetStaticProps<
     }
   }
 
-  const [{ data, errors = [] }, cmsPage, globalSections] = await Promise.all([
+  const [
+    { data, errors = [] },
+    cmsPage,
+    globalSections,
+    globalSectionsHeader,
+    globalSectionsFooter,
+  ] = await Promise.all([
     execute<
       ServerCollectionPageQueryQueryVariables,
       ServerCollectionPageQueryQuery
@@ -136,6 +159,8 @@ export const getStaticProps: GetStaticProps<
     }),
     getPLP(slug, previewData, rewrites),
     globalSectionsPromise,
+    globalSectionsHeaderPromise,
+    globalSectionsFooterPromise,
   ])
 
   const notFound = errors.find(isNotFoundError)
@@ -161,11 +186,17 @@ export const getStaticProps: GetStaticProps<
     throw errors[0]
   }
 
+  const globalSectionsResult = injectGlobalSections({
+    globalSections,
+    globalSectionsHeader,
+    globalSectionsFooter,
+  })
+
   return {
     props: {
       data,
       page: cmsPage,
-      globalSections,
+      globalSections: globalSectionsResult,
       type: 'plp',
       key: slug,
     },