@graphcommerce/docs 10.0.0-canary.67 → 10.0.0-canary.72

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 10.0.0-canary.72
+
+## 10.0.0-canary.71
+
+## 10.0.0-canary.70
+
+## 10.0.0-canary.69
+
+## 10.0.0-canary.68
+
 ## 10.0.0-canary.67
 
 ## 10.0.0-canary.66

package/framework/config.md

@@ -1,5 +1,4 @@
 <!-- Automatically generated from Config.graphqls -->
-
 ### DatalayerConfig
 
 GoogleDatalayerConfig to allow enabling certain aspects of the datalayer
@@ -10,29 +9,20 @@ Enable core web vitals tracking for GraphCommerce
 
 # GraphCommerce configuration system
 
-Global GraphCommerce configuration can be configured in your
-`graphcommerce.config.js` file in the root of your project and are automatically
-validated on startup.
+Global GraphCommerce configuration can be configured in your `graphcommerce.config.js` file
+in the root of your project and are automatically validated on startup.
 
 ## Configuring with the configuration file.
 
-The configuration file is a javascript file that exports a `GraphCommerceConfig`
-object. See graphcommerce.config.js.example for an example.
+The configuration file is a javascript file that exports a `GraphCommerceConfig` object. See graphcommerce.config.js.example for an example.
 
 ## Using configuration
 
-Configuration can be accessed in your project with the
-`import.meta.graphCommerce` object.
+Configuration can be accessed in your project by importing the config from `@graphcommerce/next-config/config`.
 
 ```tsx
+import { storefrontAll, storefrontConfig, storefrontConfigDefault, useStorefrontConfig } from '@graphcommerce/next-ui'
 import { cartDisplayPricesInclTax } from '@graphcommerce/next-config/config'
-import {
-  storefrontAll,
-  storefrontConfig,
-  storefrontConfigDefault,
-  useStorefrontConfig,
-} from '@graphcommerce/next-ui'
-
 // Accessing a global value
 const globalConf = cartDisplayPricesInclTax
 
@@ -60,28 +50,25 @@ endpoint: '{graphCommerce.magentoEndpoint}'
 
 ## Environment variables to override configuration
 
-Configuration values can be overwriten by environment variables, with the
-following rules:
-
+Configuration values can be overwriten by environment variables, with the following rules:
 - Convert from camelCase to `SCREAMING_SNAKE_CASE`
 - Prefix with `GC_`
 - Arrays can be indexed with `_0`, `_1`, `_2`, etc.
 - Objects can be accessed with `_<key>`.
 
 Examples:
-
 - `limitSsg` -> `GC_LIMIT_SSG="1"`
 - `storefront[0].locale` -> `GC_STOREFRONT_0_LOCALE="en"`
 - `debug.pluginStatus` -> `GC_DEBUG_PLUGIN_STATUS="1"`
 
+
 ## Exporting current configuration to environment variables
 
 You can export configuration by running `yarn graphcommerce export-config`
 
 ## Extending the configuration in your project
 
-Create a graphql/Config.graphqls file in your project and extend the
-GraphCommerceConfig, GraphCommerceStorefrontConfig inputs to add configuration.
+Create a graphql/Config.graphqls file in your project and extend the GraphCommerceConfig, GraphCommerceStorefrontConfig inputs to add configuration.
 
 ```graphql
 extend input GraphCommerceConfig {
@@ -103,26 +90,15 @@ Below is a list of all possible configurations that can be set by GraphCommerce.
 The canonical base URL is used for SEO purposes.
 
 Examples:
-
 - https://example.com
 - https://example.com/en
 - https://example.com/en-US
 
-#### hygraphEndpoint: string (required)
-
-The Hygraph endpoint.
-
-> Read-only endpoint that allows low latency and high read-throughput content
-> delivery.
-
-Project settings -> API Access -> High Performance Read-only Content API
-
 #### magentoEndpoint: string (required)
 
 GraphQL Magento endpoint.
 
 Examples:
-
 - https://magento2.test/graphql
 
 #### magentoVersion: number (required)
@@ -141,8 +117,7 @@ Configuration for the SidebarGallery component
 
 #### cartDisplayPricesInclTax: boolean
 
-Due to a limitation of the GraphQL API it is not possible to determine if a cart
-should be displayed including or excluding tax.
+Due to a limitation of the GraphQL API it is not possible to determine if a cart should be displayed including or excluding tax.
 
 When Magento's StoreConfig adds this value, this can be replaced.
 
@@ -152,30 +127,25 @@ Use compare functionality
 
 #### compareVariant: CHECKBOX | ICON = `ICON`
 
-By default the compare feature is denoted with a 'compare ICON' (2 arrows facing
-one another). This may be fine for experienced users, but for more clarity it's
-also possible to present the compare feature as a CHECKBOX accompanied by the
-'Compare' label
+By default the compare feature is denoted with a 'compare ICON' (2 arrows facing one another).
+This may be fine for experienced users, but for more clarity it's also possible to present the compare feature as a CHECKBOX accompanied by the 'Compare' label
 
 #### configurableVariantForSimple: boolean = `false`
 
-If a simple product is part of a Configurable product page, should the simple
-product be rendered as a configured option of the configurable product page?
+If a simple product is part of a Configurable product page, should the simple product be
+rendered as a configured option of the configurable product page?
 
 How does this work:
 
-When the `products(filters: { url_key: { eq: 'simple-product' } }) { ... }`
-query is ran, Magento also returns the Simple product and the Configurable
-product the simple belongs to.
+When the `products(filters: { url_key: { eq: 'simple-product' } }) { ... }` query is ran,
+Magento also returns the Simple product and the Configurable product the simple belongs to.
 
-If that is the case we render the configurable product page instead of the
-simple product page but the options to select the simple product are
-pre-selected.
+If that is the case we render the configurable product page instead of the simple product page but
+the options to select the simple product are pre-selected.
 
 #### configurableVariantValues: [MagentoConfigurableVariantValues](#MagentoConfigurableVariantValues) = `{ content: true, url: true }`
 
-When a user selects a variant, it will switch the values on the configurable
-page with the values of the configured variant.
+When a user selects a variant, it will switch the values on the configurable page with the values of the configured variant.
 
 Enabling options here will allow switching of those variants.
 
@@ -189,16 +159,13 @@ Configures the max width of the shell (header, footer, overlays, etc.)
 
 #### crossSellsHideCartItems: boolean = `false`
 
-Determines if cross sell items should be shown when the user already has the
-product in their cart. This will result in a product will popping off the screen
-when you add it to the cart.
+Determines if cross sell items should be shown when the user already has the product in their cart. This will result in a product will popping off the screen when you add it to the cart.
 
 Default: 'false'
 
 #### crossSellsRedirectItems: boolean = `false`
 
-Determines if, after adding a cross-sell item to the cart, the user should be
-redirected to the cross-sell items of the product they just added.
+Determines if, after adding a cross-sell item to the cart, the user should be redirected to the cross-sell items of the product they just added.
 
 Default: 'false'
 
@@ -209,7 +176,6 @@ Enables the shipping notes field in the checkout
 #### customerCompanyFieldsEnable: boolean
 
 Enables company fields inside the checkout:
-
 - Company name
 - VAT ID
 
@@ -219,9 +185,7 @@ Enable customer account deletion through the account section
 
 #### customerXMagentoCacheIdDisable: boolean
 
-X-Magento-Cache-Id allows Varnish to cache requests that are made in the browser
-while users are logged in. For example the products query can now be cached for
-logged in users.
+X-Magento-Cache-Id allows Varnish to cache requests that are made in the browser while users are logged in. For example the products query can now be cached for logged in users.
 
 This can be disabled when Varnish is running out of available memory.
 
@@ -233,22 +197,13 @@ Datalayer config
 
 Debug configuration for GraphCommerce
 
-#### demoMode: boolean = `true`
-
-Enables some demo specific code that is probably not useful for a project:
-
-- Adds the "BY GC" to the product list items.
-- Adds "dominant_color" attribute swatches to the product list items.
-- Creates a big list items in the product list.
-
 #### enableGuestCheckoutLogin: boolean
 
-Enable Guest Checkout Login: During customer login, GraphCommerce queries
-Magento to determine whether the customer account already exists or not. If not,
-the sign-up form is shown instead.
+Enable Guest Checkout Login:
+During customer login, GraphCommerce queries Magento to determine whether
+the customer account already exists or not. If not, the sign-up form is shown instead.
 
-For Magento versions, 2.4.7, 2.4.6-p1 and up, 2.4.5-p3 and up, 2.4.4-p4 and up,
-the following setting must be set to Yes
+For Magento versions, 2.4.7, 2.4.6-p1 and up, 2.4.5-p3 and up, 2.4.4-p4 and up, the following setting must be set to Yes
 
 `Stores -> Configuration -> Sales -> Checkout -> Checkout Options -> Enable Guest Checkout Login`
 
@@ -266,42 +221,38 @@ To create an assetlinks.json file for the Android app.
 
 #### googleRecaptchaKey: string
 
-Google reCAPTCHA site key. When using reCAPTCHA, this value is required, even if
-you are configuring different values for each locale.
+Google reCAPTCHA site key.
+When using reCAPTCHA, this value is required, even if you are configuring different values for each locale.
 
-Get a site key and a secret key from
-https://developers.google.com/recaptcha/docs/v3
+Get a site key and a secret key from https://developers.google.com/recaptcha/docs/v3
 
-The secret key should be added in the Magento admin panel (Stores >
-Configuration > Security > Google ReCAPTCHA Storefront > reCAPTCHA v3 Invisible)
-ReCAPTCHA can then be enabled/disabled for the different forms, separately
-(Stores > Configuration > Security > Google ReCAPTCHA Storefront > Storefront)
+The secret key should be added in the Magento admin panel (Stores > Configuration > Security > Google ReCAPTCHA Storefront > reCAPTCHA v3 Invisible)
+ReCAPTCHA can then be enabled/disabled for the different forms, separately (Stores > Configuration > Security > Google ReCAPTCHA Storefront > Storefront)
 
 #### googleTagmanagerId: string
 
 The Google Tagmanager ID to be used on the site.
 
-This value is required even if you are configuring different values for each
-locale.
+This value is required even if you are configuring different values for each locale.
 
 #### graphqlMeshEditMode: boolean = `false`
 
-The GraphQL Mesh will be loaded once and any modifications to resolvers will be
-ignored. When developing new resolvers this should be set to true.
+The GraphQL Mesh will be loaded once and any modifications to resolvers will be ignored. When developing
+new resolvers this should be set to true.
 
 #### hygraphManagementApi: string
 
 Hygraph Management API. **Only used for migrations.**
 
-Optional: If the hygraphEndpoint is configured with the 'High Performance
-Content API', this field is not required.
+Optional: If the hygraphEndpoint is configured with the 'High Performance Content
+API', this field is not required.
 
 #### hygraphProjectId: string
 
 Hygraph Project ID. **Only used for migrations.**
 
-Optional: If the hygraphEndpoint is configured with the 'High Performance
-Content API', this field is not required.
+Optional: If the hygraphEndpoint is configured with the 'High Performance Content
+API', this field is not required.
 
 #### hygraphWriteAccessToken: string
 
@@ -309,28 +260,25 @@ Hygraph Management SDK Authorization Token. **Only used for migrations.**
 
 Project settings -> API Access -> Permanent Auth Tokens
 
-1. Click 'Add token' and give it a name, something like 'GraphCommerce Write
-   Access Token' and keep stage on 'Published'.
+1. Click  'Add token' and give it a name, something like 'GraphCommerce Write Access Token' and keep stage on 'Published'.
 2. Under 'Management API', click 'Yes, Initialize defaults'
-3. Click 'Edit Permissions' and enable: 'Update' and 'Delete' permissions for
-   'models', 'enumerations', 'fields', 'components' and 'sources'
-
-- Update existing models
-- Delete existing models
-- Update existing fields
-- Delete existing fields
-- Update existing enumerations
-- Delete existing enumerations
-- Update existing components
-- Delete existing components
-- Update remote sources
-- Delete remote sources
-- Read existing environments
-- Read public content views
-- Create public content views
-- Update public content views
-- Delete public content views
-- Can see schema view
+3. Click 'Edit Permissions' and enable: 'Update' and 'Delete' permissions for 'models', 'enumerations', 'fields', 'components' and 'sources'
+  - Update existing models
+  - Delete existing models
+  - Update existing fields
+  - Delete existing fields
+  - Update existing enumerations
+  - Delete existing enumerations
+  - Update existing components
+  - Delete existing components
+  - Update remote sources
+  - Delete remote sources
+  - Read existing environments
+  - Read public content views
+  - Create public content views
+  - Update public content views
+  - Delete public content views
+  - Can see schema view
 
 ```bash
 GC_HYGRAPH_WRITE_ACCESS_TOKEN="AccessTokenFromHygraph"
@@ -341,14 +289,11 @@ yarn graphcommerce hygraph-migrate
 
 Limit the static generation of SSG when building.
 
-By default GraphCommerce will statically generate all product and category pages
-during build. This can take quite a long time, to skip this step set this value
-to true.
+By default GraphCommerce will statically generate all product and category pages during build. This can take quite a long time, to skip this step set this value to true.
 
 #### permissions: [GraphCommercePermissions](#GraphCommercePermissions)
 
-Allows the option to require login or completely disable certain sections of the
-site, can be overriden per storeview with the storefrontConfig
+Allows the option to require login or completely disable certain sections of the site, can be overriden per storeview with the storefrontConfig
 
 #### previewSecret: string
 
@@ -356,9 +301,9 @@ To enable next.js' preview mode, configure the secret you'd like to use.
 
 #### productFiltersLayout: DEFAULT | SIDEBAR = `DEFAULT`
 
-Layout how the filters are rendered. DEFAULT: Will be rendered as horzontal
-chips on desktop and mobile SIDEBAR: Will be rendered as a sidebar on desktop
-and horizontal chips on mobile
+Layout how the filters are rendered.
+DEFAULT: Will be rendered as horzontal chips on desktop and mobile
+SIDEBAR: Will be rendered as a sidebar on desktop and horizontal chips on mobile
 
 #### productFiltersPro: boolean
 
@@ -368,14 +313,15 @@ Product filters with better UI for mobile and desktop.
 
 Pagination variant for the product listings.
 
-COMPACT means: "< Page X of Y >" EXTENDED means: "< 1 2 ... 4 [5] 6 ... 10 11 >"
+COMPACT means: "< Page X of Y >"
+EXTENDED means: "< 1 2 ... 4 [5] 6 ... 10 11 >"
 
 #### productRoute: string
 
-By default we route products to /p/[url] but you can change this to
-/product/[url] if you wish.
+By default we route products to /p/[url] but you can change this to /product/[url] if you wish.
 
-Default: '/p/' Example: '/product/'
+Default: '/p/'
+Example: '/product/'
 
 #### recentlyViewedProducts: [RecentlyViewedProductsConfig](#RecentlyViewedProductsConfig)
 
@@ -383,8 +329,8 @@ Settings for recently viewed products
 
 #### robotsAllow: boolean
 
-Allow the site to be indexed by search engines. If false, the robots.txt file
-will be set to disallow all.
+Allow the site to be indexed by search engines.
+If false, the robots.txt file will be set to disallow all.
 
 #### sidebarGallery: [SidebarGalleryConfig](#SidebarGalleryConfig)
 
@@ -416,27 +362,22 @@ Enable debugging interface to debug sessions
 
 #### webpackCircularDependencyPlugin: boolean
 
-Cyclic dependencies can cause memory issues and other strange bugs. This plugin
-will warn you when it detects a cyclic dependency.
+Cyclic dependencies can cause memory issues and other strange bugs.
+This plugin will warn you when it detects a cyclic dependency.
 
 When running into memory issues, it can be useful to enable this plugin.
 
 #### webpackDuplicatesPlugin: boolean
 
-When updating packages it can happen that the same package is included with
-different versions in the same project.
+When updating packages it can happen that the same package is included with different versions in the same project.
 
 Issues that this can cause are:
-
-- The same package is included multiple times in the bundle, increasing the
-  bundle size.
-- The Typescript types of the package are not compatible with each other,
-  causing Typescript errors.
+- The same package is included multiple times in the bundle, increasing the bundle size.
+- The Typescript types of the package are not compatible with each other, causing Typescript errors.
 
 ### GraphCommerceGooglePlaystoreConfig
 
-See
-https://developer.android.com/training/app-links/verify-android-applinks#web-assoc
+See https://developer.android.com/training/app-links/verify-android-applinks#web-assoc
 
 #### packageName: string (required)
 
@@ -456,18 +397,15 @@ Allows customers to change their billing address or locks it down.
 
 #### cart: CUSTOMER_ONLY | DISABLED | ENABLED
 
-Changes the availability of the add to cart buttons and the cart page to either
-customer only or completely disables it.
+Changes the availability of the add to cart buttons and the cart page to either customer only or completely disables it.
 
 #### checkout: CUSTOMER_ONLY | DISABLED | ENABLED
 
-Changes the availability of the checkout to either customer only or completely
-disables it.
+Changes the availability of the checkout to either customer only or completely disables it.
 
 #### customerAccount: DISABLED | DISABLE_REGISTRATION | ENABLED
 
-Enables / disabled the account section of the website. DISABLE_REGISTRATION will
-only disable the registration page.
+Enables / disabled the account section of the website. DISABLE_REGISTRATION will only disable the registration page.
 
 #### website: ENABLED
 
@@ -479,12 +417,9 @@ All storefront configuration for the project
 
 #### locale: string (required)
 
-Must be a
-[locale string](https://www.unicode.org/reports/tr35/tr35-59/tr35.html#Identifiers)
-for automatic redirects to work.
+Must be a [locale string](https://www.unicode.org/reports/tr35/tr35-59/tr35.html#Identifiers) for automatic redirects to work.
 
-This value can be used as a sub-path identifier only, make sure linguiLocale is
-configured for each URL.
+This value can be used as a sub-path identifier only, make sure linguiLocale is configured for each URL.
 
 #### magentoStoreCode: string (required)
 
@@ -493,7 +428,6 @@ Magento store code.
 Stores => All Stores => [Store View] => Store View Code
 
 Examples:
-
 - default
 - en-us
 - b2b-us
@@ -503,27 +437,23 @@ Examples:
 The canonical base URL is used for SEO purposes.
 
 Examples:
-
 - https://example.com
 - https://example.com/en
 - https://example.com/en-US
 
 #### cartDisplayPricesInclTax: boolean
 
-Due to a limitation of the GraphQL API it is not possible to determine if a cart
-should be displayed including or excluding tax.
+Due to a limitation of the GraphQL API it is not possible to determine if a cart should be displayed including or excluding tax.
 
 #### customerCompanyFieldsEnable: boolean
 
 Enables company fields inside the checkout:
-
 - Company name
 - VAT ID
 
 #### defaultLocale: boolean
 
 There can only be one entry with defaultLocale set to true.
-
 - If there are more, the first one is used.
 - If there is none, the first entry is used.
 
@@ -545,46 +475,35 @@ Locale specific google reCAPTCHA key.
 
 The Google Tagmanager ID to be used per locale.
 
-#### hygraphLocales: string[]
-
-Add a gcms-locales header to make sure queries return in a certain language, can
-be an array to define fallbacks.
-
 #### linguiLocale: string
 
-Custom locale used to load the .po files. Must be a valid locale, also used for
-Intl functions.
+Custom locale used to load the .po files. Must be a valid locale, also used for Intl functions.
 
 #### permissions: [GraphCommercePermissions](#GraphCommercePermissions)
 
-Allows the option to require login or completely disable certain sections of the
-site on a per store basis
+Allows the option to require login or completely disable certain sections of the site on a per store basis
 
 #### robotsAllow: boolean
 
-Allow the site to be indexed by search engines. If false, the robots.txt file
-will be set to disallow all.
+Allow the site to be indexed by search engines.
+If false, the robots.txt file will be set to disallow all.
 
 ### MagentoConfigurableVariantValues
 
-Options to configure which values will be replaced when a variant is selected on
-the product page.
+Options to configure which values will be replaced when a variant is selected on the product page.
 
 #### content: boolean
 
-Use the name, description, short description and meta data from the configured
-variant
+Use the name, description, short description and meta data from the configured variant
 
 #### gallery: boolean
 
-This option enables the automatic update of product gallery images on the
-product page when a variant is selected, provided that the gallery images for
-the selected variant differ from the currently displayed images.
+This option enables the automatic update of product gallery images on the product page when a variant is selected,
+provided that the gallery images for the selected variant differ from the currently displayed images.
 
 #### url: boolean
 
-When a variant is selected the URL of the product will be changed in the address
-bar.
+When a variant is selected the URL of the product will be changed in the address bar.
 
 This only happens when the actual variant is can be accessed by the URL.
 
@@ -602,9 +521,8 @@ Number of recently viewed products to be stored in localStorage
 
 ### SidebarGalleryConfig
 
-SidebarGalleryConfig will contain all configuration values for the Sidebar
-Gallery component.
+SidebarGalleryConfig will contain all configuration values for the Sidebar Gallery component.
 
 #### paginationVariant: DOTS | THUMBNAILS_BOTTOM
 
-Variant used for the pagination
+Variant used for the pagination

package/framework/icons.md

@@ -44,7 +44,7 @@ const createOverrides = (theme: Theme): Components => ({
       {
         props: {},
         style: ({ theme }) => ({
-          color: theme.palette.primary.main,
+          color: theme.vars.palette.primary.main,
         }),
       },
     ],

package/framework/theming.md

@@ -37,7 +37,7 @@ updated in real-time:
 
 You can search through your codebase to discover which components will be
 affected by your changes. For example, search for occurrences of
-`theme.palette.primary.main`.
+`theme.vars.palette.primary.main`.
 
 ### Best practices
 
@@ -84,7 +84,7 @@ property:
 ```tsx
 sx={{
   borderRadius: 2,
-  backgroundColor: (theme) => theme.palette.primary.main,
+  backgroundColor: (theme) => theme.vars.palette.primary.main,
 }}
 ```
 
@@ -92,8 +92,8 @@ To use the theme object for multiple property's:
 
 ```tsx
 sx={(theme) => ({
-  borderRadius: `1px solid ${theme.palette.divider}`,
-  backgroundColor: theme.palette.primary.main,
+  borderRadius: `1px solid ${theme.vars.palette.divider}`,
+  backgroundColor: theme.vars.palette.primary.main,
 })}
 ```
 
@@ -110,10 +110,10 @@ const AnimatedButton = styled(Button, { name: 'animatedButton' })(
   ({ theme }) => ({
     '@keyframes pulse': {
       '0%': {
-        boxShadow: `0 0 0 0 ${theme.palette.primary.main}`,
+        boxShadow: `0 0 0 0 ${theme.vars.palette.primary.main}`,
       },
       '100%': {
-        boxShadow: `0 0 0 15px ${theme.palette.background.default}`,
+        boxShadow: `0 0 0 15px ${theme.vars.palette.background.default}`,
       },
     },
     animation: 'pulse 1.5s infinite',

package/framework/typography.md

@@ -63,7 +63,7 @@ component:
   gutterBottom
   sx={{
     h3: (theme) => ({
-      color: theme.palette.primary.main,
+      color: theme.vars.palette.primary.main,
     }),
   }}
 >

package/getting-started/graphcms-component.md

@@ -198,7 +198,7 @@ export function Banner(props: BannerFragment) {
             textAlign: 'center' as const,
           },
           'heading-one': (theme) => ({
-            color: theme.palette.primary.main,
+            color: theme.vars.palette.primary.main,
           }),
         }}
       />

package/getting-started/readme.md

@@ -61,8 +61,8 @@ https://user-images.githubusercontent.com/1251986/227236765-503ccaac-6499-48df-b
 ## Page routing
 
 GraphCommerce uses Next.js file-based
-[page routing ↗](https://nextjs.org/docs/routing/introduction). The files
-inside the `📁 /pages` directory handle routing. Modify these files to meet your
+[page routing ↗](https://nextjs.org/docs/routing/introduction). The files inside
+the `📁 /pages` directory handle routing. Modify these files to meet your
 requirements or [build a custom page](./pages.md).
 
 - Product pages: `📄 /p/[...url].tsx`
@@ -103,7 +103,7 @@ sx={{ '& .MuiBox-root': { background: 'blue' }}}
 Pass the theme object to use global values
 
 ```tsx
-sx={(theme)=>({ margin: theme.spacings.lg, color: theme.palette.text.secondary })}
+sx={(theme)=>({ margin: theme.spacings.lg, color: theme.vars.palette.text.secondary })}
 ```
 
 ## Customization

package/package.json

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

package/upgrading/graphcommerce-9-to-10.md

@@ -3,6 +3,30 @@
 Depending on the amounts of customisations you've made, there are some manual
 steps.
 
+## Theme: Replace theme.palette with theme.vars.palette
+
+To support CSS variables properly, replace `theme.palette` with
+`theme.vars.palette` in your theme customizations:
+
+```diff
+- color: theme.palette.primary.main,
++ color: theme.vars.palette.primary.main,
+```
+
+## Theme: Replace dark mode checks with theme.applyStyles
+
+Replace conditional dark mode checks with `theme.applyStyles('dark', ...)`:
+
+```diff
+- background: theme.palette.mode === 'dark'
+-   ? lighten(theme.palette.background.default, 0.15)
+-   : theme.palette.background.default,
++ background: theme.vars.palette.background.default,
++ ...theme.applyStyles('dark', {
++   background: theme.lighten(theme.vars.palette.background.default, 0.15),
++ }),
+```
+
 ## Trans and t import replacements
 
 ```tsx

package/upgrading/readme.md

@@ -74,6 +74,7 @@ packages:
 
 - `rm yarn.lock && yarn` Remove lock and install the dependencies
 - `yarn codegen` Converts all .graphql files to typescript files
+- `rm -r .next`
 - `yarn dev` Run the app
 
 ### Resolving diff issues
@@ -106,6 +107,9 @@ After resolving the diff issues, manually process upgrade instructions:
 
 - [Upgrading to GraphCommerce 5 to 6](../upgrading/graphcommerce-5-to-6.md)
 - [Upgrading to GraphCommerce 6 to 7](../upgrading/graphcommerce-6-to-7.md)
+- [Upgrading to GraphCommerce 7 to 8](../upgrading/graphcommerce-7-to-8.md)
+- [Upgrading to GraphCommerce 8 to 9](../upgrading/graphcommerce-8-to-9.md)
+- [Upgrading to GraphCommerce 9 to 10](../upgrading/graphcommerce-9-to-10.md)
 
 Run and validate your local environment: