@graphcommerce/docs 6.2.0-canary.47 → 6.2.0-canary.49

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 6.2.0-canary.49
+
+### Patch Changes
+
+- [#1959](https://github.com/graphcommerce-org/graphcommerce/pull/1959) [`d0809b132`](https://github.com/graphcommerce-org/graphcommerce/commit/d0809b132a0e4cbdfeb86164f6c16a89ebecd987) - Added support for default values in the Config.graphqls files for the documentation ([@JoshuaS98](https://github.com/JoshuaS98))
+
+## 6.2.0-canary.48
+
 ## 6.2.0-canary.47
 
 ## 6.2.0-canary.46

package/framework/config.md

@@ -115,7 +115,7 @@ When Magento's StoreConfig adds this value, this can be replaced.
 
 Use compare functionality
 
-#### `compareVariant: [CompareVariant](#CompareVariant)`
+#### `compareVariant: [CompareVariant](#CompareVariant) (default: 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
@@ -132,7 +132,7 @@ This value should match Magento 2's configuration value for
 
 Debug configuration for GraphCommerce
 
-#### `demoMode: Boolean`
+#### `demoMode: Boolean (default: true)`
 
 Enables some demo specific code that is probably not useful for a project:
 
@@ -214,6 +214,12 @@ Limit the static generation of SSG when building
 
 To enable next.js' preview mode, configure the secret you'd like to use.
 
+#### `productFiltersLayout: [ProductFiltersLayout](#ProductFiltersLayout) (default: 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`
 
 Product filters with better UI for mobile and desktop.

package/framework/favicon.md

@@ -35,6 +35,20 @@ to simplify the process of making correct favicons.
  <figcaption>Favicon sketch template</figcaption>
 </figure>
 
+## Open Graph preview image
+
+The Open Graph image is automaticly set for product and category pages if
+possible. For product pages the first gallary image will be used and for
+category pages the image uploaded to the `Category Image` attribute. If these
+images are not availale or on any of the other other pages a preview image will
+not be added unless added as `ogImage` prop to the `PageMeta`, `, CategoryMeta`
+or `ProductPageMeta` components.
+
+It is possible to enable a fallback image per route by setting the
+`ogImageUseFallback` prop to `true` on either the `PageMeta`, `, CategoryMeta`
+or `ProductPageMeta` components. The image used as fallback can be found at
+`/public/open-graph-image.jpg`
+
 ## Next steps
 
 - Lear more about [Static file serving](../framework/static-file-serving.md)

package/package.json

@@ -2,10 +2,10 @@
   "name": "@graphcommerce/docs",
   "homepage": "https://www.graphcommerce.org/docs",
   "repository": "github:graphcommerce-org/graphcommerce/docs",
-  "version": "6.2.0-canary.47",
+  "version": "6.2.0-canary.49",
   "sideEffects": true,
   "devDependencies": {
-    "@graphcommerce/prettier-config-pwa": "6.2.0-canary.47"
+    "@graphcommerce/prettier-config-pwa": "6.2.0-canary.49"
   },
   "prettier": "@graphcommerce/prettier-config-pwa"
 }

package/roadmap.md

@@ -15,9 +15,8 @@ The following overview contains the status of items on the GraphCommerce roadmap
 
 ## In progress
 
-- [ ] Algolia implementation
-- [ ] Dynamic Row based content
-- [ ] Product compare functionality
+- [ ] Better authorization handling
+- [ ] Hygraph schema migrations
 - [ ] Edge runtime for GraphQL Mesh and Streaming SSR rendering
 - [ ] Global store messages
 
@@ -25,6 +24,9 @@ The following overview contains the status of items on the GraphCommerce roadmap
 
 [See all releases](https://github.com/graphcommerce-org/graphcommerce/releases?q=prerelease%3Afalse+&expanded=true)
 
+- [x] [Algolia Search (beta)](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/algolia-search)
+- [x] [Dynamic Rows (beta)](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/hygraph-dynamic-rows)
+- [x] [Product compare](https://github.com/graphcommerce-org/graphcommerce/blob/main/packages/magento-compare/Config.graphqls)
 - [x] Google Tagmanager 4 datalayer implementation
       [docs ↗](https://github.com/graphcommerce-org/graphcommerce/tree/main/packages/googleanalytics)
 - [x] Paypal Express payment service

package/upgrading/graphcommerce-6-1-to-6-2.md

@@ -0,0 +1,89 @@
+# Upgrading from GraphCommerce 6.1 to 6.2
+
+Upgrading from GraphCommerce 6.1 to 6.2 is minor update. Depending on the
+amounts of customisations you've made, there are some manual steps. Please
+follow the regular [upgrade steps first](./readme.md).
+
+1. [Add `fetchPolicy: cache-first` to LayoutDocument](#add-cache-first-fetchpolicy-to-layoutdocument)
+2. [Translation file updates](#translation-file-updates)
+
+## Add `fetchPolicy: cache-first` to LayoutDocument queries
+
+🟠 Only required if you've added custom pages
+
+All occurences of LayoutDocument should get a `fetchPolicy: 'cache-first'`
+option.
+
+```tsx
+// Find all occurences of
+staticClient.query({ query: LayoutDocument })
+
+// Replace with
+staticClient.query({ query: LayoutDocument, fetchPolicy: 'cache-first' })
+```
+
+## Use thew new `hygraphPageContent` function instead of DefaultPageQuery
+
+🟠 Only required if you've added custom pages
+
+The `DefaultPageDocument` is removed in favor of the new `hygraphPageContent`
+query. This function handles caching better and allows for (currently in beta)
+DynamicRows feature.
+
+```tsx
+// DefaultPageDocument
+const page = staticClient.query({
+  query: DefaultPageDocument,
+  variables: { url: `blog/${urlKey}` },
+})
+
+// Becomes hygraphPageContent
+const page = hygraphPageContent(staticClient, `blog/${urlKey}`)
+```
+
+## Translation file updates
+
+🟠 Only required if you've added custom translations
+
+All locales files now require a `msgid` comment. All translations need to have a
+`#. js-lingui-explicit-id` comment added. This could be done with a
+find-and-replace:
+
+Find (including the empty line)
+
+```
+
+msgid
+```
+
+Replace with (including the empty line)
+
+```
+
+#. js-lingui-explicit-id
+msgid
+```
+
+To validate your translations run `yarn lingui` to extract everything.
+
+## All @graphql-mesh/\* should be set to latest.
+
+🟠 Only required if you've added custom @graphql-mesh/\* packages
+
+All @graphql-mesh packages are using a 0.x.x versioning schema. This means that
+each minor change is considered a major change by yarn. This causes lots of
+issues with version mismatches. Since `@graphql-mesh` isn't making any major
+breaking before releasing 1.x this is the safest course of action for now. Once
+1.x is released we'll switch to "^1.0.0" as a version constraint.
+
+In your package.json
+
+```json
+// Replace
+    "@graphql-mesh/json-schema": "^0.37.6",
+    "@graphql-mesh/transform-filter-schema": "^0.15.8",
+
+// With
+    "@graphql-mesh/json-schema": "latest",
+    "@graphql-mesh/transform-filter-schema": "latest",
+```

package/upgrading/readme.md

@@ -107,6 +107,7 @@ find . -type f -name '*.rej' -delete
 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.1 to 6.2](../upgrading/graphcommerce-6-1-to-6-2.md)
 
 Run and validate your local environment: