@graphcommerce/docs 10.0.0-canary.72 → 10.0.1-canary.0

package/CHANGELOG.md

@@ -1,38 +1,8 @@
 # Change Log
 
-## 10.0.0-canary.72
+## 10.0.1-canary.0
 
-## 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
-
-## 10.0.0-canary.65
-
-## 10.0.0-canary.64
-
-## 10.0.0-canary.63
-
-## 10.0.0-canary.62
-
-## 10.0.0-canary.61
-
-## 10.0.0-canary.60
-
-## 10.0.0-canary.59
-
-## 10.0.0-canary.58
-
-## 10.0.0-canary.57
-
-## 10.0.0-canary.56
+## 10.0.0
 
 ### Major Changes
 
@@ -112,122 +82,10 @@
   - `@mui/*` modern alias rewrites
   - Debug plugins (`CircularDependencyPlugin`, `DuplicatesPlugin`) ([@paales](https://github.com/paales))
 
-## 9.1.0-canary.55
-
-## 9.1.0-canary.54
-
-## 9.1.0-canary.53
-
-## 9.1.0-canary.52
-
-## 9.1.0-canary.51
-
-## 9.1.0-canary.50
-
-## 9.1.0-canary.49
-
-## 9.1.0-canary.48
-
-## 9.1.0-canary.47
-
-## 9.1.0-canary.46
-
-## 9.1.0-canary.45
-
-## 9.1.0-canary.44
-
-## 9.1.0-canary.43
-
-## 9.1.0-canary.42
-
-## 9.1.0-canary.41
-
-## 9.1.0-canary.40
-
-## 9.1.0-canary.39
-
-## 9.1.0-canary.38
-
-## 9.1.0-canary.37
-
-## 9.1.0-canary.36
-
-## 9.1.0-canary.35
-
-## 9.1.0-canary.34
-
-## 9.1.0-canary.33
-
-## 9.1.0-canary.32
-
-## 9.1.0-canary.31
-
-## 9.1.0-canary.30
-
 ### Patch Changes
 
 - [#2523](https://github.com/graphcommerce-org/graphcommerce/pull/2523) [`cc5b602`](https://github.com/graphcommerce-org/graphcommerce/commit/cc5b602694e433ec13688dd3fda60e300461a7d3) - Add correct link to demo project ([@FrankHarland](https://github.com/FrankHarland))
 
-## 9.1.0-canary.29
-
-## 9.1.0-canary.28
-
-## 9.1.0-canary.27
-
-## 9.1.0-canary.26
-
-## 9.1.0-canary.25
-
-## 9.1.0-canary.24
-
-## 9.1.0-canary.23
-
-## 9.1.0-canary.22
-
-## 9.1.0-canary.21
-
-## 9.1.0-canary.20
-
-## 9.1.0-canary.19
-
-## 9.1.0-canary.18
-
-## 9.1.0-canary.17
-
-## 9.1.0-canary.16
-
-## 9.1.0-canary.15
-
-## 9.0.4-canary.14
-
-## 9.0.4-canary.13
-
-## 9.0.4-canary.12
-
-## 9.0.4-canary.11
-
-## 9.0.4-canary.10
-
-## 9.0.4-canary.9
-
-## 9.0.4-canary.8
-
-## 9.0.4-canary.7
-
-## 9.0.4-canary.6
-
-## 9.0.4-canary.5
-
-## 9.0.4-canary.4
-
-## 9.0.4-canary.3
-
-## 9.0.4-canary.2
-
-## 9.0.4-canary.1
-
-## 9.0.4-canary.0
-
 ## 9.0.1
 
 ### Patch Changes

package/feature-list.md

@@ -13,6 +13,7 @@ metaUrl: magento-open-source-full-feature-list-with-graphcommerce
 
 - [Feature] GraphCommerce _unique_ feature
 - [Commerce] Requires Adobe Commerce
+- [Pro] Requires [GraphCommerce Pro](./gc-pro)
 
 </div>
 
@@ -86,9 +87,11 @@ Features taken from the Magento Commerce 2 Feature List
       [Enhanced]
 - [x] Blend content and commerce by adding products to content pages and rich
       content to product pages. — [Enhanced]
-- [x] Create reusable dynamic blocks targeted to customer segments. — [Commerce]
+- [x] Create reusable dynamic blocks targeted to customer segments. — [Pro]
+      `@graphcommerce/adobe-commerce-dynamic-blocks`
 - [x] Easily stage and preview content for seamless updates. — [Partial]
-- [x] Manage upcoming site changes with a timeline dashboard. - [Commerce]
+- [x] Manage upcoming site changes with a timeline dashboard. — [Pro]
+      `@graphcommerce/adobe-commerce` (staging preview)
 - [x] Organize content pages and add pagination, navigation, and menus with a
       page hierarchy tool. — [Enhanced]
 - [x] Track and restore previous versions of content pages. — [Enhanced]
@@ -110,7 +113,8 @@ Features taken from the Magento Commerce 2 Feature List
 - [x] Decrease time to market using the multi-language Venia reference
       storefront. — [Enhanced]
 - [x] Give marketers control with Page Builder to manage content and layouts on
-      PWA Studio-powered storefronts. — [Enhanced]
+      PWA Studio-powered storefronts. — [Pro]
+      `@graphcommerce/magento-pagebuilder`
 - [x] Build PWA experiences using open standards including React, Redux, and
       Webpack. — [Enhanced]
 - [x] Boost developer productivity with real-time, guided development. —
@@ -158,6 +162,11 @@ Features taken from the Magento Commerce 2 Feature List
       automated sorting rules. — [Commerce]
 - [ ] Control which products and categories can be viewed by each customer
       group. — [Commerce]
+- [x] Hide prices for guest users with "Login for prices" messaging. — [Pro]
+      `@graphcommerce/magento-private-pricing`
+- [x] Frontend price display mode switcher (Incl./Excl. VAT). — [Pro]
+      `@graphcommerce/magento-price-view`
+      `@graphcommerce/magento-price-view-vat`
 - [x] Show side-by-side product comparisons with two or more products. —
       [Enhanced]
 - [x] Display recently viewed products. — [Enhanced]
@@ -224,8 +233,13 @@ Features taken from the Magento Commerce 2 Feature List
       checkout thank you page.
 - [x] Allow customers to save their shopping carts to complete their purchases
       later.
-- [ ] Offer gift wrapping and gift messages per order and per item. — [Todo]
-- [ ] Configure pricing and taxes for gift-wrapping options. — [Todo]
+- [x] Manage multiple shopping carts per customer. — [Pro]
+      `@graphcommerce/magento-multi-cart`
+- [x] Offer gift wrapping and gift messages per order and per item. — [Pro]
+      `@graphcommerce/adobe-commerce-gift-wrapping`
+      `@graphcommerce/magento-gift-message`
+- [x] Configure pricing and taxes for gift-wrapping options. — [Pro]
+      `@graphcommerce/adobe-commerce-gift-wrapping`
 - [x] Manage complex tax calculations and prepare signature-ready returns with
       Vertex.
 - [x] Improve order processing capacity with the option to defer stock updates
@@ -264,8 +278,8 @@ Features taken from the Magento Commerce 2 Feature List
       for split fulfillment.
 - [x] Print invoices, packing slips, and shipping labels.
 - [x] Create custom order status labels to track progress.
-- [ ] Use return management authorization (RMA) to efficiently process returns.
-      — [Commerce]
+- [x] Use return management authorization (RMA) to efficiently process returns.
+      — [Pro] `@graphcommerce/adobe-commerce-returns`
 - [x] Enable customer service representatives to create orders and customer
       accounts.
 - [x] Allow customer service to update products, prices, and coupons in
@@ -280,17 +294,18 @@ Features taken from the Magento Commerce 2 Feature List
 
 ### Customer loyalty
 
-- [ ] Offer reward points for purchases, registration, product reviews and other
-      actions. — [Commerce]
-- [ ] Configure reward point redemption rules, caps, and expiration dates. —
-      [Commerce]
-- [ ] Enable customers to save products to multiple wish lists that can be made
-      public. — [Commerce]
-- [ ] Allow customers to create gift registries and send emails to shop the
-      registry. — [Commerce]
-- [ ] Automatically update item counts and notify the registry owner as
-      purchases are made. — [Commerce]
-- [x] Allow customers to purchase physical and virtual gift cards. — [Commerce]
+- [x] Offer reward points for purchases, registration, product reviews and other
+      actions. — [Pro] `@graphcommerce/adobe-commerce-reward-points`
+- [x] Configure reward point redemption rules, caps, and expiration dates. —
+      [Pro] `@graphcommerce/adobe-commerce-reward-points`
+- [x] Enable customers to save products to multiple wish lists that can be made
+      public. — [Pro] `@graphcommerce/adobe-commerce-multi-wishlists`
+- [x] Allow customers to create gift registries and send emails to shop the
+      registry. — [Pro] `@graphcommerce/adobe-commerce-gift-registry`
+- [x] Automatically update item counts and notify the registry owner as
+      purchases are made. — [Pro] `@graphcommerce/adobe-commerce-gift-registry`
+- [x] Allow customers to purchase physical and virtual gift cards. — [Pro]
+      `@graphcommerce/adobe-commerce-gift-c`
 - [ ] Offer exclusive shopping experiences with private or flash sale sites. —
       [Commerce]
 - [ ] Streamline re-ordering by enabling shoppers to add products to the cart by
@@ -307,9 +322,10 @@ Features taken from the Magento Commerce 2 Feature List
 - [x] See order status and history.
 - [x] Re-order from the customer account.
 - [x] View recently ordered items.
-- [x] Track available store credits — [Commerce]
-- [ ] Track gift card totals — [Commerce]
-- [ ] Track reward points — [Commerce]
+- [x] Track available store credits — [Pro]
+      `@graphcommerce/adobe-commerce-store-credit`
+- [x] Track gift card totals — [Pro] `@graphcommerce/adobe-commerce-gift-c`
+- [x] Track reward points — [Pro] `@graphcommerce/adobe-commerce-reward-points`
 - [x] Manage newsletter subscriptions.
 - [x] View submitted product reviews.
 - [ ] Access downloadable/digital products. — [Todo]
@@ -461,6 +477,10 @@ Features taken from the Magento Commerce 2 Feature List
       [Feature]
 - [x] Accelerate site performance with image compression, srcset, and edge CDN
       level caching. — [Feature]
+- [x] Near-realtime SSG revalidation via webhooks from Magento/Hygraph. — [Pro]
+      `@graphcommerce/cache-notify`
+- [x] Cache GraphQL POST requests in Varnish. — [Pro]
+      `@graphcommerce/graphql-mesh-cache-varnish`
 
 ### Managed cloud
 

package/framework/config.md

@@ -7,6 +7,73 @@ GoogleDatalayerConfig to allow enabling certain aspects of the datalayer
 
 Enable core web vitals tracking for GraphCommerce
 
+### GraphCommerceAlgoliaConfig
+
+Algolia configuration for GraphCommerce.
+
+#### applicationId: string (required)
+
+Configure your Algolia application ID. [Algolia API Keys Dashboard](https://www.algolia.com/account/api-keys)
+
+#### indexNamePrefix: string (required)
+
+Stores > Configuration > Algolia Search > Credentials and Basic Setup > Index name prefix
+
+#### searchOnlyApiKey: string (required)
+
+Configure your Search API Key. [Algolia API Keys Dashboard](https://www.algolia.com/account/api-keys)
+
+Make sure the API key has the following ACL: search, listIndexes and settings [Lookup here](https://dashboard.algolia.com/account/api-keys/restricted)
+
+#### catalogEnabled: boolean
+
+By default the catalog will not use algolia. Set this to true to enable Algolia for the catalog.
+
+#### customerGroupPricingEnabled: boolean
+
+Enable Algolia customer group pricing.
+
+Please be aware that personalization needs to be enabled to make this work.
+
+#### frequentlyBoughtTogether: CROSSSELL_PRODUCTS | DISABLED | RELATED_PRODUCTS | UPSELL_PRODUCTS
+
+https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together
+
+Set the location where the frequently bought together model should be shown.
+Good default is CROSSSELL_PRODUCTS, which is shown on the Cart page.
+
+Before enabling, make sure the model is trained in Algolia.
+Do not assign multiple recommendation models to the same location.
+
+#### lookingSimilar: CROSSSELL_PRODUCTS | DISABLED | RELATED_PRODUCTS | UPSELL_PRODUCTS
+
+https://www.algolia.com/doc/guides/algolia-recommend/overview/#looking-similar
+
+Set the location where the looking similar model should be shown.
+Good default is UPSELL_PRODUCTS, which is shown on the Product page by default.
+
+Before enabling, make sure the model is trained in Algolia.
+Do not assign multiple recommendation models to the same location.
+
+#### relatedProducts: CROSSSELL_PRODUCTS | DISABLED | RELATED_PRODUCTS | UPSELL_PRODUCTS
+
+https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content
+
+Set the location where the related products model should be shown.
+Good default is RELATED_PRODUCTS, which is shown on the Product page by default.
+
+Before enabling, make sure the model is trained in Algolia.
+Do not assign multiple recommendation models to the same location.
+
+#### suggestionsSuffix: string
+
+To enable Algolia suggestions, please provide the Suffix that is used for your suggestions index.
+
+The pattern is `${indexNamePrefix}_{storeCode}_{suggestionsSuffix}`.
+Something like `_suggestions` or `_query_suggestions`
+
+For the index `magento2_demo_en_US_suggestions` this would be `_suggestions`
+
 # GraphCommerce configuration system
 
 Global GraphCommerce configuration can be configured in your `graphcommerce.config.js` file
@@ -85,6 +152,12 @@ Below is a list of all possible configurations that can be set by GraphCommerce.
 
 ### GraphCommerceConfig
 
+#### algolia: [GraphCommerceAlgoliaConfig](#GraphCommerceAlgoliaConfig) (required)
+
+Configure your Algolia application ID.
+
+Stores > Configuration > Algolia Search > Credentials and Basic Setup > Application ID
+
 #### canonicalBaseUrl: string (required)
 
 The canonical base URL is used for SEO purposes.
@@ -399,6 +472,10 @@ Allows customers to change their billing address or locks it down.
 
 Changes the availability of the add to cart buttons and the cart page to either customer only or completely disables it.
 
+#### catalogPricing: CUSTOMER_ONLY | ENABLED
+
+Permissions to show the catalog pricing on the frontend.
+
 #### checkout: CUSTOMER_ONLY | DISABLED | ENABLED
 
 Changes the availability of the checkout to either customer only or completely disables it.

package/gc-pro-adobe-commerce.md

@@ -0,0 +1,100 @@
+---
+menu: GraphCommerce Pro Adobe Commerce
+metaTitle: GraphCommerce Pro - Adobe Commerce packages
+metaDescription:
+  'Production-ready packages for Adobe Commerce: Gift Cards, Store Credit,
+  Reward Points, Returns, and more.'
+metaUrl: graphcommerce-pro-adobe-commerce
+---
+
+# GraphCommerce Pro for Adobe Commerce
+
+Production-ready packages extending GraphCommerce with Adobe Commerce features.
+
+For Magento Open Source features, see [GraphCommerce Pro](./gc-pro).
+
+GC Pro for Adobe Commerce license is €2500 per year, send an email to
+sales@graphcommerce.org for a license. Multi year bundles available. Each
+license is valid for one brand or installation, we'll send details.
+
+---
+
+## `@graphcommerce/adobe-commerce`
+
+Adobe Commerce staging preview support. Adds datetime picker to preview mode
+toolbar for previewing scheduled content changes.
+
+**Plugin:** `AdobeCommercePreviewModeToolbar` — sets `magentoPreviewVersion`
+(unix timestamp) in preview mode.
+
+---
+
+## `@graphcommerce/adobe-commerce-gift-c`
+
+Gift card products, cart application, and account management. Supports virtual,
+physical, and combined gift cards.
+
+Note: Package named `gift-c` because `gift-card` is forbidden on npm.
+
+**Components:** `ProductPageGiftCard`, `ApplyGiftCardToCartForm`,
+`GiftCardCartAccordion`, `GiftCardTotals`, `GiftCardAccount`, `GiftCardPage`
+
+**Mutations:** `applyGiftCardToCart`, `removeGiftCardFromCart`
+
+**Query:** `giftCardAccount` — check balance by code
+
+---
+
+## `@graphcommerce/adobe-commerce-store-credit`
+
+Apply store credit at checkout, view balance and history in customer account.
+
+**Components:** `StoreCreditAccordion`, `StoreCreditCurrentBalance`,
+`StoreCreditHistory`, `StoreCreditPage`, `StoreCreditAccountMenuItem`
+
+**Mutations:** `applyStoreCreditToCart`, `removeStoreCreditFromCart`
+
+**Known issue:** `applied_store_credit` throws error for guest carts (patch
+included).
+
+---
+
+## `@graphcommerce/adobe-commerce-reward-points`
+
+Earn and redeem reward points. Shows earnings for cart, registration, and
+newsletter signup.
+
+**Components:** `RewardPointsAccordion`, `RewardPointsCurrentPoints`,
+`RewardPointsHistory`, `RewardPointsEarningsCart`,
+`RewardPointsEarningsRegister`, `RewardPointsEarningsNewsletterCustomer`,
+`RewardPointsBanner`, `RewardPointsPage`, `RewardPointsMenuItem`
+
+---
+
+## `@graphcommerce/adobe-commerce-returns`
+
+Customer-facing RMA (Return Merchandise Authorization) flow. Customers can
+request returns, select items/quantities, add tracking, and communicate with the
+store.
+
+Limitation: Customer-only, no guest return support via GraphQL API.
+
+**Queries:** `OrdersEligibleForReturns`, `ReturnsAttributeList`,
+`Return_Details`
+
+**Mutations:** `requestReturn`, `addReturnTracking`, `removeReturnTracking`,
+`addReturnComment`
+
+---
+
+## Additional Packages
+
+| Package                                             | Description                          |
+| --------------------------------------------------- | ------------------------------------ |
+| `@graphcommerce/adobe-commerce-gift-c-store-credit` | Gift card purchase with store credit |
+| `@graphcommerce/adobe-commerce-gift-registry`       | Gift registry creation and sharing   |
+| `@graphcommerce/adobe-commerce-gift-wrapping`       | Gift wrapping options per order/item |
+| `@graphcommerce/adobe-commerce-multi-coupon`        | Multiple coupon codes per cart       |
+| `@graphcommerce/adobe-commerce-multi-wishlists`     | Multiple wishlists per customer      |
+| `@graphcommerce/adobe-commerce-dynamic-blocks`      | Customer segment targeted content    |
+| `@graphcommerce/adobe-commerce-cart`                | `clearCart` mutation                 |

package/gc-pro.md

@@ -0,0 +1,130 @@
+---
+menu: GraphCommerce Pro
+metaTitle: GraphCommerce Pro - Magento packages
+metaDescription:
+  'Production-ready packages for Magento: PageBuilder, Multi-Cart, Cache
+  Invalidation, Private Pricing, and more.'
+metaUrl: graphcommerce-pro
+---
+
+# GraphCommerce Pro
+
+Production-ready packages extending GraphCommerce with Magento Open Source
+compatible features. Also see
+[GraphCommerce Pro for Adobe Commerce](./gc-pro-adobe-commerce)
+
+GC Pro license is €1000 per year, send an email to sales@graphcommerce.org for a
+license. Multi year bundles available. Each license is valid for one brand or
+installation, we'll send details. All of the packages belof will are included.
+
+---
+
+## `@graphcommerce/magento-multi-cart`
+
+Flexible product list system supporting multiple named carts per customer.
+Supports various use cases beyond shopping carts:
+
+**B2C:** Wishlists, Save for Later, Room/Project Lists
+
+**B2B:** Requisition Lists, Project Carts, Spare Parts / Reorder Lists
+
+Requires: `GraphCommerce_MultiCart` Magento module.
+
+**Features:**
+
+- Multiple cart groups with configurable behavior
+- Tab-based UI to switch between lists
+- Create/rename/delete lists within each group
+- Move or copy items between lists
+- Convert entire list to another group
+- Checkout from any list
+
+**Mutations:** `multiCartCreate`, `multiCartUpdate`, `multiCartTrash`,
+`multiCartSelectCart`, `multiCartMakeReal`, `multiCartCopyItemsToCart`,
+`multiCartMoveItemsBetweenCarts`, `multiCartMoveToOtherCartGroup`
+
+---
+
+## `@graphcommerce/cache-notify`
+
+Near-realtime SSG revalidation via webhooks. GraphCommerce by default statically
+generates pages (SSG) and revalidates after 20 minutes (sometimes more). This
+package adds a `/api/cache-notify` endpoint to handle notifications from Magento
+and Hygraph, so pages are revalidated immediately after content changes.
+
+Requires: `GraphCommerce_GraphQLCacheNotify` Magento module.
+
+**Handlers:**
+
+- `@graphcommerce/cache-notify-magento` — Revalidates on `product.create`,
+  `product.update`, `product.delete`, `category.update` events
+- `@graphcommerce/cache-notify-hygraph` — Revalidates on page publish/unpublish
+
+---
+
+## `@graphcommerce/graphql-mesh-cache-varnish`
+
+Cache GraphQL POST requests in Varnish. Computes SHA256 hash of operation +
+variables and sends as `X-Document-ID` header. Varnish uses this header as cache
+key.
+
+Requires: Varnish VCL modifications (included in package as `varnish6.vcl`).
+
+---
+
+## `@graphcommerce/magento-pagebuilder`
+
+Renders Magento PageBuilder content in the headless storefront. Implementation
+strives to match the source Magento visual implementation.
+
+**Content Types:** `PageBuilderRow`, `PageBuilderColumn`,
+`PageBuilderColumnGroup`, `PageBuilderText`, `PageBuilderHeading`,
+`PageBuilderImage`, `PageBuilderVideo`, `PageBuilderBanner`,
+`PageBuilderSlider`, `PageBuilderSlide`, `PageBuilderTabs`,
+`PageBuilderButtonsList`, `PageBuilderDivider`, `PageBuilderHtml`,
+`PageBuilderMap`, `PageBuilderProductList`, `PageBuilderStaticBlock`
+
+**Features:** Background images/videos, parallax effects (Jarallax), responsive
+columns.
+
+Demo:
+https://graphcommerce-pro-ac-git-canary-reachdigital.vercel.app/page/test-page
+Test Page: https://graphcommerce-pro-ac-git-canary-reachdigital.vercel.app/
+
+---
+
+## `@graphcommerce/magento-private-pricing`
+
+Hide prices for guests with "Login for prices" messaging. Adds `catalogPricing`
+permission to the GraphCommerce permissions system.
+
+**Config:**
+
+```ts
+const config = {
+  permissions: {
+    catalogPricing: 'CUSTOMER_ONLY',
+  },
+}
+```
+
+**Components:** `PrivatePricingMessage`, `PrivatePricingProductListPrice`,
+`PrivatePricingProductPagePriceTiers`, `PrivatePricingSignInButton`
+
+Components can be replaced via plugins for custom rendering.
+
+---
+
+## `@graphcommerce/magento-price-view`
+
+Frontend price display mode switcher. Adds a section to the Store Switcher for
+price view configuration. Stores selection in cookie, sends as header to backend
+for custom price logic.
+
+**Components:** `StoreSwitcherPriceView`, `PriceViewOption`
+
+---
+
+## `@graphcommerce/magento-price-view-vat`
+
+Adds Incl./Excl. VAT toggle option to the price view switcher.

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.72",
+  "version": "10.0.1-canary.0",
   "sideEffects": true,
   "peerDependencies": {
-    "@graphcommerce/prettier-config-pwa": "^10.0.0-canary.72"
+    "@graphcommerce/prettier-config-pwa": "^10.0.1-canary.0"
   },
   "prettier": "@graphcommerce/prettier-config-pwa"
 }