@graphcommerce/docs 8.1.0-canary.41 → 8.1.0-canary.43

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 8.1.0-canary.43
+
+## 8.1.0-canary.42
+
 ## 8.1.0-canary.41
 
 ### Patch Changes

package/framework/config.md

@@ -181,6 +181,8 @@ Enable customer account deletion through the account section
 
 #### dataLayer: [DatalayerConfig](#DatalayerConfig)
 
+Datalayer config
+
 #### debug: [GraphCommerceDebugConfig](#GraphCommerceDebugConfig)
 
 Debug configuration for GraphCommerce

package/framework/preview-mode.md

@@ -0,0 +1,31 @@
+# Preview mode
+
+GraphCommerce implements Next.js' preview mode which allows you to view the
+realtime data from Magento and Hygraph.
+
+You can select whether to view Hygraph content in the DRAFT of PUBLISHED stage
+(or other if configured).
+
+You can Revalidate / Regenerate a page to make sure it is always up to date when
+viewing.
+
+It bypasses all caches from Next.js, Magento and Hygraph (this means that
+Preview Mode is expdcted to be slower but does show your changes directly).
+
+## Accessing preview mode
+
+To enter preview mode press `ALT + Backtick` (\`) on your keyboard. This will
+open the preview mode toolbar on the bottom of the screen.
+
+![Toolbar requesting secret](https://github.com/graphcommerce-org/graphcommerce/assets/1244416/5064dbf0-e491-4d14-9c44-17754941d193)
+
+Fill in the secret and press the chevron button to enter preview mode.
+
+You are now greeted with the preview mode toolbar:
+
+![Scherm­afbeelding 2024-07-04 om 21 09 58](https://github.com/graphcommerce-org/graphcommerce/assets/1244416/f6a2224b-ad0a-429d-bd1b-ad924a3f81e5)
+
+## Enabling preview mode
+
+Configure the `previewSecret` in your `graphcommerce.config.js` file to enable
+preview mode.

package/framework/static-generation.md

@@ -43,8 +43,10 @@ data needed to render the layout (header, footer, menu etc.)
 
 export const getStaticProps: GetPageStaticProps = async ({ locale }) => {
  ...
-
-  const layout = staticClient.query({ query: LayoutDocument, fetchPolicy: 'cache-first' })
+  const layout = staticClient.query({
+    query: LayoutDocument,
+    fetchPolicy: cacheFirst(staticClient),
+  })
 
   return {
     props: {

package/getting-started/pages.md

@@ -93,9 +93,9 @@ AboutUs.pageOptions = pageOptions
 
 export default AboutUs
 
-export const getStaticProps: GetPageStaticProps = async ({ locale }) => {
-  const client = graphqlSharedClient(locale)
-  const staticClient = graphqlSsrClient(locale)
+export const getStaticProps: GetPageStaticProps = async (context) => {
+  const client = graphqlSharedClient(context)
+  const staticClient = graphqlSsrClient(context)
 
   const conf = client.query({ query: StoreConfigDocument })
   const layout = staticClient.query({
@@ -210,9 +210,9 @@ AboutUs.pageOptions = pageOptions
 
 export default AboutUs
 
-export const getStaticProps: GetPageStaticProps = async ({ locale }) => {
-  const client = graphqlSharedClient(locale)
-  const staticClient = graphqlSsrClient(locale)
+export const getStaticProps: GetPageStaticProps = async (context) => {
+  const client = graphqlSharedClient(context)
+  const staticClient = graphqlSsrClient(context)
 
   const conf = client.query({ query: StoreConfigDocument })
   const page = hygraphPageContent(staticClient, 'about/about-us')
@@ -259,12 +259,10 @@ export const getStaticPaths: GetPageStaticPaths = (context) => ({
   fallback: 'blocking',
 })
 
-export const getStaticProps: GetPageStaticProps = async ({
-  locale,
-  params,
-}) => {
-  const client = graphqlSharedClient(locale)
-  const staticClient = graphqlSsrClient(locale)
+export const getStaticProps: GetPageStaticProps = async (context) => {
+  const { params } = context
+  const client = graphqlSharedClient(context)
+  const staticClient = graphqlSsrClient(context)
 
   const conf = client.query({ query: StoreConfigDocument })
   const page = hygraphPageContent(staticClient, `about/${params?.url}`)

package/package.json

@@ -2,10 +2,10 @@
   "name": "@graphcommerce/docs",
   "homepage": "https://www.graphcommerce.org/docs",
   "repository": "github:graphcommerce-org/graphcommerce/docs",
-  "version": "8.1.0-canary.41",
+  "version": "8.1.0-canary.43",
   "sideEffects": true,
   "peerDependencies": {
-    "@graphcommerce/prettier-config-pwa": "^8.1.0-canary.41"
+    "@graphcommerce/prettier-config-pwa": "^8.1.0-canary.43"
   },
   "prettier": "@graphcommerce/prettier-config-pwa"
 }