@graphcommerce/docs 7.1.0-canary.8 → 8.0.0-canary.100

package/CHANGELOG.md

@@ -1,5 +1,203 @@
 # Change Log
 
+## 8.0.0-canary.100
+
+## 8.0.0-canary.99
+
+## 8.0.0-canary.98
+
+## 8.0.0-canary.97
+
+## 8.0.0-canary.96
+
+## 8.0.0-canary.95
+
+## 8.0.0-canary.94
+
+## 8.0.0-canary.93
+
+## 8.0.0-canary.92
+
+## 8.0.0-canary.91
+
+### Patch Changes
+
+- [#2172](https://github.com/graphcommerce-org/graphcommerce/pull/2172) [`279599e`](https://github.com/graphcommerce-org/graphcommerce/commit/279599e7a86bd96ea9e36065af3c367df9e02a63) - Updated documentation to reflect recent code changes
+  ([@paales](https://github.com/paales))
+
+## 8.0.0-canary.90
+
+## 8.0.0-canary.89
+
+### Patch Changes
+
+- [`b850ab0`](https://github.com/graphcommerce-org/graphcommerce/commit/b850ab06e3fff1cd274651d8082557ed2c308f55) - Updated roadmap and feature-list
+  ([@paales](https://github.com/paales))
+
+## 8.0.0-canary.88
+
+## 8.0.0-canary.87
+
+## 8.0.0-canary.86
+
+## 8.0.0-canary.85
+
+## 8.0.0-canary.84
+
+## 8.0.0-canary.83
+
+## 8.0.0-canary.82
+
+## 8.0.0-canary.81
+
+## 8.0.0-canary.80
+
+## 8.0.0-canary.79
+
+## 8.0.0-canary.78
+
+## 8.0.0-canary.77
+
+## 8.0.0-canary.76
+
+## 8.0.0-canary.75
+
+## 8.0.0-canary.74
+
+## 8.0.0-canary.73
+
+## 8.0.0-canary.72
+
+## 8.0.0-canary.71
+
+## 8.0.0-canary.70
+
+## 8.0.0-canary.69
+
+## 7.1.0-canary.68
+
+## 7.1.0-canary.67
+
+## 7.1.0-canary.66
+
+## 7.1.0-canary.65
+
+## 7.1.0-canary.64
+
+## 7.1.0-canary.63
+
+## 7.1.0-canary.62
+
+## 7.1.0-canary.61
+
+## 7.1.0-canary.60
+
+## 7.1.0-canary.59
+
+## 7.1.0-canary.58
+
+## 7.1.0-canary.57
+
+## 7.1.0-canary.56
+
+## 7.1.0-canary.55
+
+## 7.1.0-canary.54
+
+## 7.1.0-canary.53
+
+### Patch Changes
+
+- [#2119](https://github.com/graphcommerce-org/graphcommerce/pull/2119) [`6adb2e72e`](https://github.com/graphcommerce-org/graphcommerce/commit/6adb2e72ece8210757ced178779dfba11b1bcf55) - Clarify texts by adding formatting and correcting spelling. ([@carlocarels90](https://github.com/carlocarels90))
+
+## 7.1.0-canary.52
+
+## 7.1.0-canary.51
+
+## 7.1.0-canary.50
+
+## 7.1.0-canary.49
+
+## 7.1.0-canary.48
+
+## 7.1.0-canary.47
+
+## 7.1.0-canary.46
+
+## 7.1.0-canary.45
+
+## 7.1.0-canary.38
+
+## 7.1.0-canary.37
+
+### Patch Changes
+
+- [#2112](https://github.com/graphcommerce-org/graphcommerce/pull/2112) [`15a203737`](https://github.com/graphcommerce-org/graphcommerce/commit/15a2037372cd615602d3e2f3deedba9766fc172c) - Make the "Search" string translatable and fix typo. ([@carlocarels90](https://github.com/carlocarels90))
+
+## 7.1.0-canary.36
+
+## 7.1.0-canary.35
+
+## 7.1.0-canary.34
+
+## 7.1.0-canary.33
+
+## 7.1.0-canary.32
+
+## 7.1.0-canary.31
+
+### Minor Changes
+
+- [#2106](https://github.com/graphcommerce-org/graphcommerce/pull/2106) [`9f8c3cac2`](https://github.com/graphcommerce-org/graphcommerce/commit/9f8c3cac214006315055f37cf8d4a783eb99a7ec) - Split off Magento known issues to separate page ([@hnsr](https://github.com/hnsr))
+
+## 7.1.0-canary.30
+
+## 7.1.0-canary.29
+
+### Patch Changes
+
+- [#2104](https://github.com/graphcommerce-org/graphcommerce/pull/2104) [`d0f1f5a2d`](https://github.com/graphcommerce-org/graphcommerce/commit/d0f1f5a2d1380d1c3931e23218924d5e8b1fc60d) - Document workaround/patch for broken cart error handling with Magento 2.4.6. ([@hnsr](https://github.com/hnsr))
+
+## 7.1.0-canary.28
+
+## 7.1.0-canary.27
+
+## 7.1.0-canary.26
+
+## 7.1.0-canary.25
+
+## 7.1.0-canary.24
+
+## 7.1.0-canary.23
+
+## 7.1.0-canary.22
+
+## 7.1.0-canary.21
+
+## 7.1.0-canary.20
+
+## 7.1.0-canary.19
+
+## 7.1.0-canary.18
+
+## 7.1.0-canary.17
+
+## 7.1.0-canary.16
+
+## 7.1.0-canary.15
+
+## 7.1.0-canary.14
+
+## 7.1.0-canary.13
+
+## 7.1.0-canary.12
+
+## 7.1.0-canary.11
+
+## 7.1.0-canary.10
+
+## 7.1.0-canary.9
+
 ## 7.1.0-canary.8
 
 ## 7.0.2-canary.7
@@ -823,31 +1021,31 @@
   All occurences of `<Trans>` and `t` need to be replaced:
 
   ```tsx
-  import { Trans, t } from '@lingui/macro'
+  import { Trans, t } from "@lingui/macro";
 
   function MyComponent() {
-    const foo = 'bar'
+    const foo = "bar";
     return (
       <div aria-label={t`Account ${foo}`}>
         <Trans>My Translation {foo}</Trans>
       </div>
-    )
+    );
   }
   ```
 
   Needs to be replaced with:
 
   ```tsx
-  import { Trans } from '@lingui/react'
-  import { i18n } from '@lingui/core'
+  import { Trans } from "@lingui/react";
+  import { i18n } from "@lingui/core";
 
   function MyComponent() {
-    const foo = 'bar'
+    const foo = "bar";
     return (
       <div aria-label={i18n._(/* i18n */ `Account {foo}`, { foo })}>
-        <Trans key='My Translation {foo}' values={{ foo }}></Trans>
+        <Trans key="My Translation {foo}" values={{ foo }}></Trans>
       </div>
-    )
+    );
   }
   ```
 

package/contributing.md

@@ -7,7 +7,7 @@ process easy and effective for everyone involved.
 
 ### Bug reports
 
-Well-written, thorough bug reports are a great way to contribute to the project.
+Well-written, through bug reports are a great way to contribute to the project.
 Before raising a new issue, please check our
 [issues list ↗](https://github.com/graphcommerce-org/graphcommerce/issues) to
 determine whether the issue you encountered has already been reported.

package/feature-list.md

@@ -125,8 +125,8 @@ Features taken from the Magento Commerce 2 Feature List
       grouped products.
 - [x] Offer virtual products like memberships, services and warranties.
 - [x] Include downloadable/digital products with samples.
-- [ ] Allow customer-personalized products (e.g., upload images and text for
-      monogramming). — [Todo]
+- [x] Allow customer-personalized products (e.g., upload images and text for
+      monogramming). — (No upload support yet)
 - [x] Manage inventory across multiple locations
 - [x] Create new products through a guided online process.
 - [x] Define unlimited product attributes.
@@ -153,12 +153,13 @@ Features taken from the Magento Commerce 2 Feature List
 - [ ] Present product category items in grid or list format. — [Todo]
 - [x] Customize the look and feel of categories and assigned product pages. —
       [Enhanced]
-- [ ] Arrange products on category pages with drag-and-drop merchandising and
+- [x] Arrange products on category pages with drag-and-drop merchandising and
       automated sorting rules. — [Commerce]
 - [ ] Control which products and categories can be viewed by each customer
       group. — [Commerce]
-- [ ] Show side-by-side product comparisons with two or more products. — [Todo]
-- [ ] Display recently viewed products. — [Todo]
+- [x] Show side-by-side product comparisons with two or more products. —
+      [Enhanced]
+- [x] Display recently viewed products. — [Enhanced]
 - [x] Compare products. — [Enhanced]
 - [x] Increase search relevancy and scalability with Elasticsearch technology.
 - [x] Set stop words, attribute weightings, and search synonyms for higher
@@ -214,8 +215,8 @@ Features taken from the Magento Commerce 2 Feature List
 
 - [x] Include a mini cart on store pages to summarize products in the cart.
 - [x] Display an order summary with product images in checkout.
-- [ ] Offer guest and registered user checkout. Registered customers are
-      automatically recognized when they enter their email addresses. — [Todo]
+- [x] Offer guest and registered user checkout. Registered customers are
+      automatically recognized when they enter their email addresses.
 - [ ] Boost conversion rates with an Instant Purchase option that uses saved
       payment and shipping information to speed checkout. — [Todo]
 - [x] Enable shoppers to create a customer account with one click on the
@@ -234,7 +235,8 @@ Features taken from the Magento Commerce 2 Feature List
 ### Payments
 
 - [ ] Download and work with your preferred payment gateway through the Magento
-      Marketplace.
+      Marketplace. —
+      [Supported Payment Methods](https://www.graphcommerce.org/docs/magento#payment-gateways)
 - [x] Securely pass credit card information directly from the client browser to
       the payment gateway, bypassing the Adobe Commerce application.
 - [x] Qualify for the easiest level of PCI compliance (SAQ-A or SAQ A-EP),
@@ -378,8 +380,9 @@ Features taken from the Magento Commerce 2 Feature List
       easier and durable over multiple releases. — [Enhanced]
 - [x] Integrate Adobe Commerce with third-party applications using efficient web
       APIs with REST and GraphQL support. — [Enhanced]
-- [ ] Smoothly manage interactions between extensions using plug-ins and
-      dependency injection software design patterns.
+- [x] Smoothly manage interactions between extensions using plug-ins and
+      dependency injection software design patterns. —
+      [Plugins](https://www.graphcommerce.org/docs/framework/plugins-react_)
 - [ ] Accelerate time-to-market and improve code quality with a fully-automated
       testing framework.
 - [ ] Update code with a standalone installer that checks for prerequisites

package/framework/config.md

@@ -77,7 +77,7 @@ Below is a list of all possible configurations that can be set by GraphCommerce.
 
 ### GraphCommerceConfig
 
-#### `canonicalBaseUrl: String!`
+#### canonicalBaseUrl: string (required)
 
 The canonical base URL is used for SEO purposes.
 
@@ -86,7 +86,7 @@ Examples:
 - https://example.com/en
 - https://example.com/en-US
 
-#### `hygraphEndpoint: String!`
+#### hygraphEndpoint: string (required)
 
 The HyGraph endpoint.
 
@@ -94,33 +94,33 @@ The HyGraph endpoint.
 
 Project settings -> API Access -> High Performance Read-only Content API
 
-#### `magentoEndpoint: String!`
+#### magentoEndpoint: string (required)
 
 GraphQL Magento endpoint.
 
 Examples:
 - https://magento2.test/graphql
 
-#### `storefront: [[GraphCommerceStorefrontConfig](#GraphCommerceStorefrontConfig)!]!`
+#### storefront: [GraphCommerceStorefrontConfig](#GraphCommerceStorefrontConfig)[] (required)
 
 All storefront configuration for the project
 
-#### `cartDisplayPricesInclTax: Boolean`
+#### 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.
 
 When Magento's StoreConfig adds this value, this can be replaced.
 
-#### `compare: Boolean`
+#### compare: boolean
 
 Use compare functionality
 
-#### `compareVariant: [CompareVariant](#CompareVariant) (default: ICON)`
+#### 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
 
-#### `configurableVariantForSimple: Boolean (default: [object Object])`
+#### 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?
@@ -133,13 +133,25 @@ Magento also returns the Simple product and the Configurable product the simple
 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) (default: [object Object])`
+#### 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.
 
 Enabling options here will allow switching of those variants.
 
-#### `customerRequireEmailConfirmation: Boolean`
+#### 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.
+
+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.
+
+Default: 'false'
+
+#### customerRequireEmailConfirmation: boolean
 
 Due to a limitation in the GraphQL API of Magento 2, we need to know if the
 customer requires email confirmation.
@@ -147,11 +159,11 @@ customer requires email confirmation.
 This value should match Magento 2's configuration value for
 `customer/create_account/confirm` and should be removed once we can query
 
-#### `debug: [GraphCommerceDebugConfig](#GraphCommerceDebugConfig)`
+#### debug: [GraphCommerceDebugConfig](#GraphCommerceDebugConfig)
 
 Debug configuration for GraphCommerce
 
-#### `demoMode: Boolean (default: true)`
+#### demoMode: boolean = true
 
 Enables some demo specific code that is probably not useful for a project:
 
@@ -159,7 +171,17 @@ Enables some demo specific code that is probably not useful for a project:
 - Adds "dominant_color" attribute swatches to the product list items.
 - Creates a big list items in the product list.
 
-#### `googleAnalyticsId: String`
+#### 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.
+
+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`
+
+#### googleAnalyticsId: string
 
 See https://support.google.com/analytics/answer/9539598?hl=en
 
@@ -167,7 +189,7 @@ Provide a value to enable Google Analytics for your store.
 
 To override the value for a specific locale, configure in i18n config.
 
-#### `googleRecaptchaKey: String`
+#### googleRecaptchaKey: string
 
 Google reCAPTCHA site key.
 When using reCAPTCHA, this value is required, even if you are configuring different values for each locale.
@@ -177,17 +199,21 @@ Get a site key and a secret key from https://developers.google.com/recaptcha/doc
 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`
+#### 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.
 
-#### `hygraphProjectId: String`
+#### hygraphManagementApi: string
+
+Hygraph Management API. **Only used for migrations.**
+
+#### hygraphProjectId: string
 
 Hygraph Project ID. **Only used for migrations.**
 
-#### `hygraphWriteAccessEndpoint: String`
+#### hygraphWriteAccessEndpoint: string
 
 Content API. **Only used for migrations.**
 
@@ -195,7 +221,7 @@ Content API. **Only used for migrations.**
 
 Project settings -> API Access -> Content API
 
-#### `hygraphWriteAccessToken: String`
+#### hygraphWriteAccessToken: string
 
 Hygraph Management SDK Authorization Token. **Only used for migrations.**
 
@@ -227,53 +253,51 @@ GC_HYGRAPH_WRITE_ACCESS_TOKEN="AccessTokenFromHygraph"
 yarn graphcommerce hygraph-migrate
 ```
 
-#### `legacyProductRoute: Boolean`
+#### limitSsg: boolean
 
-On older versions of GraphCommerce products would use a product type specific route.
+Limit the static generation of SSG when building.
 
-This should only be set to true if you use the /product/[url] AND /product/configurable/[url] routes.
+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.
 
-@deprecated Will be removed in a future version. [migration](../upgrading/graphcommerce-5-to-6.md#product-routing-changes)
-
-#### `limitSsg: Boolean`
-
-Limit the static generation of SSG when building
-
-#### `previewSecret: String`
+#### previewSecret: string
 
 To enable next.js' preview mode, configure the secret you'd like to use.
 
-#### `productFiltersLayout: [ProductFiltersLayout](#ProductFiltersLayout) (default: DEFAULT)`
+#### 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
 
-#### `productFiltersPro: Boolean`
+#### productFiltersPro: boolean
 
 Product filters with better UI for mobile and desktop.
 
-#### `productRoute: String`
+#### productRoute: string
 
 By default we route products to /p/[url] but you can change this to /product/[url] if you wish.
 
 Default: '/p/'
 Example: '/product/'
 
-#### `robotsAllow: Boolean`
+#### recentlyViewedProducts: [RecentlyViewedProductsConfig](#RecentlyViewedProductsConfig)
+
+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.
 
-#### `wishlistHideForGuests: Boolean`
+#### sidebarGallery: [SidebarGalleryConfig](#SidebarGalleryConfig)
 
-Hide the wishlist functionality for guests.
+Configuration for the SidebarGallery component
 
-#### `wishlistIgnoreProductWishlistStatus: Boolean`
+#### wishlistHideForGuests: boolean
 
-Ignores whether a product is already in the wishlist, makes the toggle an add only.
+Hide the wishlist functionality for guests.
 
-#### `wishlistShowFeedbackMessage: Boolean`
+#### wishlistShowFeedbackMessage: boolean
 
 Show a message when the product is added to the wishlist.
 
@@ -281,18 +305,22 @@ Show a message when the product is added to the wishlist.
 
 Debug configuration for GraphCommerce
 
-#### `pluginStatus: Boolean`
+#### pluginStatus: boolean
 
 Reports which plugins are enabled or disabled.
 
-#### `webpackCircularDependencyPlugin: Boolean`
+#### sessions: boolean
+
+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.
 
 When running into memory issues, it can be useful to enable this plugin.
 
-#### `webpackDuplicatesPlugin: Boolean`
+#### webpackDuplicatesPlugin: boolean
 
 When updating packages it can happen that the same package is included with different versions in the same project.
 
@@ -304,11 +332,11 @@ Issues that this can cause are:
 
 All storefront configuration for the project
 
-#### `locale: String!`
+#### locale: string (required)
 
 Must be a locale string https://www.unicode.org/reports/tr35/tr35-59/tr35.html#Identifiers
 
-#### `magentoStoreCode: String!`
+#### magentoStoreCode: string (required)
 
 Magento store code.
 
@@ -319,7 +347,7 @@ Examples:
 - en-us
 - b2b-us
 
-#### `canonicalBaseUrl: String`
+#### canonicalBaseUrl: string
 
 The canonical base URL is used for SEO purposes.
 
@@ -328,39 +356,39 @@ Examples:
 - https://example.com/en
 - https://example.com/en-US
 
-#### `cartDisplayPricesInclTax: Boolean`
+#### 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.
 
-#### `defaultLocale: Boolean`
+#### 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.
 
-#### `domain: String`
+#### domain: string
 
 Domain configuration, must be a domain https://tools.ietf.org/html/rfc3986
 
-#### `googleAnalyticsId: String`
+#### googleAnalyticsId: string
 
 Configure different Google Analytics IDs for different locales.
 
 To disable for a specific locale, set the value to null.
 
-#### `googleRecaptchaKey: String`
+#### googleRecaptchaKey: string
 
 Locale specific google reCAPTCHA key.
 
-#### `googleTagmanagerId: String`
+#### googleTagmanagerId: string
 
 The Google Tagmanager ID to be used per locale.
 
-#### `hygraphLocales: [String!]`
+#### 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`
+#### linguiLocale: string
 
 Specify a custom locale for to load translations.
 
@@ -368,17 +396,37 @@ Specify a custom locale for to load translations.
 
 Options to configure which values will be replaced when a variant is selected on the product page.
 
-#### `content: Boolean`
+#### content: boolean
 
 Use the name, description, short description and meta data from the configured variant
 
-#### `gallery: Boolean`
+#### 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.
 
-#### `url: Boolean`
+#### url: boolean
 
 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.
+This only happens when the actual variant is can be accessed by the URL.
+
+### RecentlyViewedProductsConfig
+
+Settings for recently viewed products
+
+#### enabled: boolean
+
+Enable/disable recently viewed products
+
+#### maxCount: number
+
+Number of recently viewed products to be stored in localStorage
+
+### SidebarGalleryConfig
+
+SidebarGalleryConfig will contain all configuration values for the Sidebar Gallery component.
+
+#### paginationVariant: 'DOTS' | 'THUMBNAILS_BOTTOM'
+
+Variant used for the pagination

package/framework/plugins-react.md

@@ -37,7 +37,7 @@ Function plugins, which can be used to:
 
 In this example we're going to add some text to list items, just like the text
 ‘BY GC’ that can seen in the demo on
-[category pages](https://graphcommerce.vercel.app/nl/women/business).
+[category pages](https://graphcommerce.vercel.app/en/women/business).
 
 1. Create a new file in `/plugins/ProductListItemByGC.tsx` with the following
    contents: