@faststore/core 3.0.10 → 3.0.12

package/.turbo/turbo-build.log

@@ -1,7 +1,7 @@
 $ yarn partytown & yarn generate && next build
-$ faststore generate-graphql -c
 $ partytown copylib ./public/~partytown
 Partytown lib copied to: /home/runner/work/faststore/faststore/packages/core/public/~partytown
+$ faststore generate-graphql -c
 success - GraphQL schema, types, and optimizations successfully generated 🎉
 ⚠ No build cache found. Please configure build caching for faster rebuilds. Read more: https://nextjs.org/docs/messages/no-cache
 Attention: Next.js now collects completely anonymous telemetry regarding usage.
@@ -53,7 +53,7 @@ Route (pages)                              Size     First Load JS
 + First Load JS shared by all              96.5 kB
   ├ chunks/framework-8e279965036b6169.js   45.4 kB
   ├ chunks/main-6f63f6746cc029db.js        33.1 kB
-  ├ chunks/pages/_app-6516d0c2c7e0e686.js  12.5 kB
+  ├ chunks/pages/_app-ad8623e78bc5b766.js  12.5 kB
   ├ chunks/webpack-b4a2fdf4ef127bb7.js     2.45 kB
   └ css/5d1f64b61ea581f4.css               3.05 kB
 

package/.turbo/turbo-test.log

@@ -1,23 +1,23 @@
 $ jest
-PASS test/server/index.test.ts (20.888 s)
+PASS test/server/index.test.ts (21.304 s)
   FastStore GraphQL Layer
     @faststore/api
-      ✓ should return a valid GraphQL schema (8 ms)
-      ✓ should return a valid GraphQL schema contain all expected types (25 ms)
+      ✓ should return a valid GraphQL schema (6 ms)
+      ✓ should return a valid GraphQL schema contain all expected types (5 ms)
       ✓ should return a valid GraphQL schema contain all expected queries (1 ms)
       ✓ should return a valid GraphQL schema contain all expected mutations (1 ms)
     VTEX API Extension
-      ✓ getTypeDefsFromFolder function should return an Array (22 ms)
+      ✓ getTypeDefsFromFolder function should return an Array (5 ms)
     Third Party API Extension
-      ✓ getTypeDefsFromFolder function should return an Array (9 ms)
+      ✓ getTypeDefsFromFolder function should return an Array (4 ms)
     Final Schema after merging
-      ✓ should return a valid merged GraphQL schema (65 ms)
+      ✓ should return a valid merged GraphQL schema (29 ms)
     Envelop
-      ✓ should exist with its plugins (68 ms)
-      ✓ should handle options and execute (234 ms)
+      ✓ should exist with its plugins (32 ms)
+      ✓ should handle options and execute (125 ms)
 
 Test Suites: 1 passed, 1 total
 Tests:       9 passed, 9 total
 Snapshots:   0 total
-Time:        20.958 s
+Time:        21.349 s
 Ran all test suites.

package/cms/faststore/content-types.json

@@ -2,12 +2,14 @@
   {
     "id": "globalSections",
     "name": "Global Sections",
+    "scopes": ["global"],
     "configurationSchemaSets": [],
     "isSingleton": true
   },
   {
     "id": "landingPage",
     "name": "Landing Page",
+    "scopes": ["landing", "custom"],
     "configurationSchemaSets": [
       {
         "name": "Settings",
@@ -53,6 +55,7 @@
   {
     "id": "home",
     "name": "Home",
+    "scopes": ["home"],
     "isSingleton": true,
     "configurationSchemaSets": [
       {
@@ -99,12 +102,14 @@
   {
     "id": "pdp",
     "name": "Product Page",
+    "scopes": ["pdp"],
     "isSingleton": true,
     "configurationSchemaSets": []
   },
   {
     "id": "plp",
     "name": "Product List Page",
+    "scopes": ["plp"],
     "isSingleton": true,
     "configurationSchemaSets": [
       {
@@ -158,6 +163,7 @@
   {
     "id": "search",
     "name": "Search Page",
+    "scopes": ["plp", "search"],
     "isSingleton": true,
     "configurationSchemaSets": [
       {

package/cms/faststore/sections.json

@@ -1,6 +1,7 @@
 [
   {
     "name": "Search",
+    "requiredScopes": [],
     "schema": {
       "title": "Search Bar",
       "type": "object",
@@ -145,6 +146,7 @@
   },
   {
     "name": "Navbar",
+    "requiredScopes": [],
     "schema": {
       "title": "Navbar",
       "type": "object",
@@ -369,6 +371,7 @@
   },
   {
     "name": "Alert",
+    "requiredScopes": [],
     "schema": {
       "title": "Alert",
       "description": "Add an alert",
@@ -416,6 +419,7 @@
   },
   {
     "name": "Footer",
+    "requiredScopes": [],
     "schema": {
       "title": "Footer",
       "description": "Footer displayed on all pages",
@@ -661,6 +665,7 @@
   },
   {
     "name": "BannerText",
+    "requiredScopes": [],
     "schema": {
       "title": "Banner Text",
       "description": "Add a quick promotion with a text/action pair",
@@ -712,6 +717,7 @@
   },
   {
     "name": "Hero",
+    "requiredScopes": [],
     "schema": {
       "title": "Hero",
       "description": "Add a quick promotion with an image/action pair",
@@ -779,6 +785,7 @@
   },
   {
     "name": "Incentives",
+    "requiredScopes": [],
     "schema": {
       "title": "Incentives",
       "description": "Add Incentives to your shopper",
@@ -836,6 +843,7 @@
   },
   {
     "name": "ProductShelf",
+    "requiredScopes": [],
     "schema": {
       "title": "Product Shelf",
       "description": "Add custom shelves to your store",
@@ -937,6 +945,7 @@
   },
   {
     "name": "CrossSellingShelf",
+    "requiredScopes": ["pdp", "custom"],
     "schema": {
       "title": "Cross Selling Shelf",
       "description": "Add cross selling product data to your users",
@@ -971,6 +980,7 @@
   },
   {
     "name": "ProductTiles",
+    "requiredScopes": [],
     "schema": {
       "title": "Product Tiles",
       "description": "Add custom highlights to your store",
@@ -1050,6 +1060,7 @@
   },
   {
     "name": "Newsletter",
+    "requiredScopes": [],
     "schema": {
       "title": "Newsletter",
       "description": "Allow users to subscribe to your updates",
@@ -1191,6 +1202,7 @@
   },
   {
     "name": "BannerNewsletter",
+    "requiredScopes": [],
     "schema": {
       "title": "Banner Newsletter",
       "description": "Add newsletter with a banner",
@@ -1374,6 +1386,7 @@
   },
   {
     "name": "Breadcrumb",
+    "requiredScopes": ["pdp", "plp"],
     "schema": {
       "title": "Breadcrumb",
       "description": "Configure the breadcrumb icon and depth",
@@ -1395,6 +1408,7 @@
   },
   {
     "name": "ProductDetails",
+    "requiredScopes": ["pdp"],
     "schema": {
       "title": "Product Details",
       "type": "object",
@@ -1530,6 +1544,7 @@
   },
   {
     "name": "ProductGallery",
+    "requiredScopes": ["plp", "search"],
     "schema": {
       "title": "Product Gallery",
       "type": "object",
@@ -1726,6 +1741,7 @@
   },
   {
     "name": "CartSidebar",
+    "requiredScopes": [],
     "schema": {
       "title": "Cart Sidebar",
       "type": "object",
@@ -1821,6 +1837,7 @@
   },
   {
     "name": "RegionBar",
+    "requiredScopes": [],
     "schema": {
       "title": "Region Bar",
       "type": "object",
@@ -1878,6 +1895,7 @@
   },
   {
     "name": "RegionModal",
+    "requiredScopes": [],
     "schema": {
       "title": "Region Modal",
       "type": "object",

package/faststore.config.default.js

@@ -88,6 +88,10 @@ module.exports = {
     gtmContainerId: 'GTM-PGHZ95N',
   },
 
+  cms: {
+    data: process.env.CMS_DATA,
+  },
+
   experimental: {
     cypressVersion: 12,
     enableCypressExtension: false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/core",
-  "version": "3.0.10",
+  "version": "3.0.12",
   "license": "MIT",
   "repository": "vtex/faststore",
   "browserslist": "supports es6-module and not dead",
@@ -128,5 +128,5 @@
     "node": "18.19.0",
     "yarn": "1.19.1"
   },
-  "gitHead": "2df34675b10544e4e87d2c94392d281ed79c27bb"
+  "gitHead": "110cdfee8c6b8149f44606b7de82d5488ce90420"
 }

package/src/components/cms/GlobalSections.tsx

@@ -1,8 +1,9 @@
 import { Locator, Section } from '@vtex/client-cms'
 import type { ComponentType } from 'react'
 import { PropsWithChildren, lazy } from 'react'
+import storeConfig from 'faststore.config'
 import CUSTOM_COMPONENTS from 'src/customizations/src/components'
-import { PageContentType, getPage } from 'src/server/cms'
+import { PageContentType, getPage, getPageByVersionId } from 'src/server/cms'
 
 import Toast from 'src/components/common/Toast'
 import RenderSections from './RenderSections'
@@ -50,6 +51,21 @@ export default GlobalSections
 export const getGlobalSectionsData = async (
   previewData: Locator
 ): Promise<GlobalSectionsData> => {
+  if (storeConfig.cms.data) {
+    const cmsData = JSON.parse(storeConfig.cms.data)
+    const page = cmsData[GLOBAL_SECTIONS_CONTENT_TYPE][0]
+
+    if (page) {
+      const pageData = await getPageByVersionId<PageContentType>({
+        contentType: GLOBAL_SECTIONS_CONTENT_TYPE,
+        documentId: page.documentId,
+        versionId: page.versionId,
+      })
+
+      return pageData
+    }
+  }
+
   const { sections } = await getPage<PageContentType>({
     ...(previewData?.contentType === GLOBAL_SECTIONS_CONTENT_TYPE &&
       previewData),

package/src/components/templates/LandingPage/LandingPage.tsx

@@ -10,11 +10,11 @@ import { OverriddenDefaultNewsletter as Newsletter } from 'src/components/sectio
 import { OverriddenDefaultProductShelf as ProductShelf } from 'src/components/sections/ProductShelf/OverriddenDefaultProductShelf'
 import Incentives from 'src/components/sections/Incentives'
 import ProductTiles from 'src/components/sections/ProductTiles'
-import { getPage } from 'src/server/cms'
+import { getPage, getPageByVersionId } from 'src/server/cms'
 import type { PageContentType } from 'src/server/cms'
 import CUSTOM_COMPONENTS from 'src/customizations/src/components'
 
-import storeConfig from '../../../../faststore.config'
+import storeConfig from 'faststore.config'
 
 /* A list of components that can be used in the CMS. */
 const COMPONENTS: Record<string, ComponentType<any>> = {
@@ -85,6 +85,23 @@ export const getLandingPageBySlug = async (
   previewData: Locator
 ) => {
   try {
+    if (storeConfig.cms.data) {
+      const cmsData = JSON.parse(storeConfig.cms.data)
+      const pageBySlug = cmsData['landingPage'].find((page) => {
+        slug === page.settings?.seo?.slug
+      })
+
+      if (pageBySlug) {
+        const landingPageData = await getPageByVersionId<PageContentType>({
+          contentType: 'landingPage',
+          documentId: pageBySlug.documentId,
+          versionId: pageBySlug.versionId,
+        })
+
+        return landingPageData
+      }
+    }
+
     const landingPageData = await getPage<PageContentType>({
       ...(previewData?.contentType === 'landingPage'
         ? previewData

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

@@ -1,5 +1,6 @@
 import { isNotFoundError } from '@faststore/api'
 import type { GetStaticPaths, GetStaticProps } from 'next'
+import storeConfig from 'faststore.config'
 
 import { gql } from '@generated'
 import type {
@@ -14,7 +15,12 @@ import GlobalSections, {
   getGlobalSectionsData,
   GlobalSectionsData,
 } from 'src/components/cms/GlobalSections'
-import { getPage, PageContentType, PLPContentType } from 'src/server/cms'
+import {
+  getPage,
+  getPageByVersionId,
+  PageContentType,
+  PLPContentType,
+} from 'src/server/cms'
 import ProductListingPage, {
   ProductListingPageProps,
 } from 'src/components/templates/ProductListingPage'
@@ -100,7 +106,7 @@ export const getStaticProps: GetStaticProps<
     }
   }
 
-  const [{ data, errors = [] }, page] = await Promise.all([
+  const [{ data, errors = [] }] = await Promise.all([
     execute<
       ServerCollectionPageQueryQueryVariables,
       ServerCollectionPageQueryQuery
@@ -108,11 +114,27 @@ export const getStaticProps: GetStaticProps<
       variables: { slug },
       operation: query,
     }),
-    getPage<PLPContentType>({
+  ])
+
+  let pageData
+
+  if (storeConfig.cms.data) {
+    const cmsData = JSON.parse(storeConfig.cms.data)
+    const page = cmsData['plp'][0]
+
+    if (page) {
+      pageData = await getPageByVersionId<PLPContentType>({
+        contentType: 'plp',
+        documentId: page.documentId,
+        versionId: page.versionId,
+      })
+    }
+  } else {
+    pageData = await getPage<PLPContentType>({
       ...(previewData?.contentType === 'plp' ? previewData : null),
       contentType: 'plp',
-    }),
-  ])
+    })
+  }
 
   const notFound = errors.find(isNotFoundError)
 
@@ -130,7 +152,7 @@ export const getStaticProps: GetStaticProps<
   return {
     props: {
       data,
-      page,
+      page: pageData,
       globalSections: await globalSectionsPromise,
       type: 'plp',
       key: slug,

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

@@ -21,13 +21,13 @@ import { useSession } from 'src/sdk/session'
 import { mark } from 'src/sdk/tests/mark'
 import { execute } from 'src/server'
 import type { PDPContentType } from 'src/server/cms'
-import { getPage } from 'src/server/cms'
+import { getPage, getPageByVersionId } from 'src/server/cms'
 
 import GlobalSections, {
   GlobalSectionsData,
   getGlobalSectionsData,
 } from 'src/components/cms/GlobalSections'
-import storeConfig from '../../../faststore.config'
+import storeConfig from 'faststore.config'
 import { useProductQuery } from 'src/sdk/product/useProductQuery'
 import PageProvider, { PDPContext } from 'src/sdk/overrides/PageProvider'
 
@@ -200,18 +200,34 @@ export const getStaticProps: GetStaticProps<
   Locator
 > = async ({ params, previewData }) => {
   const slug = params?.slug ?? ''
-  const [searchResult, cmsPage, globalSections] = await Promise.all([
+  const [searchResult, globalSections] = await Promise.all([
     execute<ServerProductQueryQueryVariables, ServerProductQueryQuery>({
       variables: { locator: [{ key: 'slug', value: slug }] },
       operation: query,
     }),
-    getPage<PDPContentType>({
-      ...(previewData?.contentType === 'pdp' ? previewData : null),
-      contentType: 'pdp',
-    }),
     getGlobalSectionsData(previewData),
   ])
 
+  let cmsPage
+
+  if (storeConfig.cms.data) {
+    const cmsData = JSON.parse(storeConfig.cms.data)
+    const page = cmsData['pdp'][0]
+
+    if (page) {
+      cmsPage = getPageByVersionId<PDPContentType>({
+        contentType: 'pdp',
+        documentId: page.documentId,
+        versionId: page.versionId,
+      })
+    }
+  } else {
+    cmsPage = getPage<PDPContentType>({
+      ...(previewData?.contentType === 'pdp' ? previewData : null),
+      contentType: 'pdp',
+    })
+  }
+
   const { data, errors = [] } = searchResult
 
   const notFound = errors.find(isNotFoundError)

package/src/pages/index.tsx

@@ -13,7 +13,7 @@ import ProductTiles from 'src/components/sections/ProductTiles'
 import CUSTOM_COMPONENTS from 'src/customizations/src/components'
 import { mark } from 'src/sdk/tests/mark'
 import type { PageContentType } from 'src/server/cms'
-import { getPage } from 'src/server/cms'
+import { getPage, getPageByVersionId } from 'src/server/cms'
 
 import GlobalSections, {
   GlobalSectionsData,
@@ -85,13 +85,29 @@ export const getStaticProps: GetStaticProps<
   Record<string, string>,
   Locator
 > = async ({ previewData }) => {
-  const [page, globalSections] = await Promise.all([
-    getPage<PageContentType>({
-      ...(previewData?.contentType === 'home' && previewData),
-      contentType: 'home',
-    }),
-    getGlobalSectionsData(previewData),
-  ])
+  const globalSections = await getGlobalSectionsData(previewData)
+
+  if (storeConfig.cms.data) {
+    const cmsData = JSON.parse(storeConfig.cms.data)
+    const page = cmsData['home'][0]
+
+    if (page) {
+      const pageData = await getPageByVersionId<PageContentType>({
+        contentType: 'home',
+        documentId: page.documentId,
+        versionId: page.versionId,
+      })
+
+      return {
+        props: { page: pageData, globalSections },
+      }
+    }
+  }
+
+  const page = await getPage<PageContentType>({
+    ...(previewData?.contentType === 'home' && previewData),
+    contentType: 'home',
+  })
 
   return {
     props: { page, globalSections },

package/src/pages/s.tsx

@@ -19,8 +19,8 @@ import GlobalSections, {
   getGlobalSectionsData,
   GlobalSectionsData,
 } from 'src/components/cms/GlobalSections'
-import { getPage, SearchContentType } from 'src/server/cms'
-import storeConfig from '../../faststore.config'
+import { getPage, getPageByVersionId, SearchContentType } from 'src/server/cms'
+import storeConfig from 'faststore.config'
 import SearchPage from 'src/components/templates/SearchPage/SearchPage'
 
 type Props = {
@@ -118,13 +118,29 @@ export const getStaticProps: GetStaticProps<
   Record<string, string>,
   Locator
 > = async ({ previewData }) => {
-  const [page, globalSections] = await Promise.all([
-    getPage<SearchContentType>({
-      ...(previewData?.contentType === 'search' ? previewData : null),
-      contentType: 'search',
-    }),
-    getGlobalSectionsData(previewData),
-  ])
+  const globalSections = await getGlobalSectionsData(previewData)
+
+  if (storeConfig.cms.data) {
+    const cmsData = JSON.parse(storeConfig.cms.data)
+    const page = cmsData['search'][0]
+
+    if (page) {
+      const pageData = await getPageByVersionId<SearchContentType>({
+        contentType: 'search',
+        documentId: page.documentId,
+        versionId: page.versionId,
+      })
+
+      return {
+        props: { page: pageData, globalSections },
+      }
+    }
+  }
+
+  const page = await getPage<SearchContentType>({
+    ...(previewData?.contentType === 'search' ? previewData : null),
+    contentType: 'search',
+  })
 
   return {
     props: {

package/src/server/cms.ts

@@ -39,6 +39,32 @@ export const getPage = async <T extends ContentData>(options: Options) => {
   return pages[0] as T
 }
 
+export type VersionOptions = {
+  contentType: string
+  documentId: string
+  versionId: string
+}
+
+export const getPageByVersionId = async <T extends ContentData>(
+  options: VersionOptions
+) => {
+  const result = await clientCMS
+    .getCMSPage(options)
+    .then((page) => ({ data: [page] }))
+
+  const pages = result.data
+
+  if (!pages[0]) {
+    throw new MissingContentError(options)
+  }
+
+  if (pages.length !== 1) {
+    throw new MultipleContentError(options)
+  }
+
+  return pages[0] as T
+}
+
 type ProductGallerySettings = {
   settings: {
     productGallery: {