@graphcommerce/googleanalytics 5.2.0-canary.8 → 6.0.0-canary.20

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Change Log
 
+## 6.0.0-canary.20
+
+## 5.2.0-canary.19
+
+## 5.2.0-canary.18
+
+## 5.2.0-canary.17
+
+## 5.2.0-canary.16
+
+## 5.2.0-canary.15
+
+## 5.2.0-canary.14
+
+## 5.2.0-canary.13
+
+## 5.2.0-canary.12
+
+## 5.2.0-canary.11
+
+## 5.2.0-canary.10
+
+## 5.2.0-canary.9
+
 ## 5.2.0-canary.8
 
 ## 5.2.0-canary.7

package/Config.graphqls

@@ -0,0 +1,19 @@
+extend input GraphCommerceI18nConfig {
+  """
+  Configure different Google Analytics IDs for different locales.
+
+  To disable for a specific locale, set the value to null.
+  """
+  googleAnalyticsId: String
+}
+
+extend input GraphCommerceConfig {
+  """
+  See https://support.google.com/analytics/answer/9539598?hl=en
+
+  Provide a value to enable Google Analytics for your store.
+
+  To enable only for a specific locale, override the value in the i18n config.
+  """
+  googleAnalyticsId: String
+}

package/README.md

@@ -1,4 +1,4 @@
-# @graphcommerce/googleanalytics
+# @graphcommerce/googleanalytics ([Config](./Config.graphqls))
 
 This package makes it easy to add Google Analytics GA4 to your GraphCommerce
 webshop.
@@ -13,19 +13,7 @@ Besides the GA4 integration it also tracks the following events:
 - select_item
 - view_item_list
 
-### Configuration
+## Configuration
 
-Fill `NEXT_PUBLIC_GOOGLE_ANALYTICS` in your .env file. The value of
-`NEXT_PUBLIC_GOOGLE_ANALYTICS` can be string or JSON stringified object:
-
-```
-# your .env file
-
-# Google Analytics v4 ID
-NEXT_PUBLIC_GOOGLE_ANALYTICS="G-XXXXXXXX"
-
-# or
-
-# Google Analytics v4 ID per locale
-NEXT_PUBLIC_GOOGLE_ANALYTICS='{"en-us": "G-XXXXXXXX", "nl-nl": "G-XXXXXXXX"}'
-```
+Configure the following ([configuration values](./Config.graphqls)) in your
+graphcommerce.config.js

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/googleanalytics",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "5.2.0-canary.8",
+  "version": "6.0.0-canary.20",
   "sideEffects": false,
   "prettier": "@graphcommerce/prettier-config-pwa",
   "eslintConfig": {
@@ -12,18 +12,18 @@
     }
   },
   "dependencies": {
-    "@graphcommerce/graphql-mesh": "5.2.0-canary.8",
-    "@graphcommerce/magento-cart": "5.2.0-canary.8",
-    "@graphcommerce/magento-cart-payment-method": "5.2.0-canary.8",
-    "@graphcommerce/magento-cart-shipping-method": "5.2.0-canary.8",
-    "@graphcommerce/magento-product": "5.2.0-canary.8",
-    "@graphcommerce/next-config": "5.2.0-canary.8",
-    "@graphcommerce/next-ui": "5.2.0-canary.8"
+    "@graphcommerce/graphql-mesh": "6.0.0-canary.20",
+    "@graphcommerce/magento-cart": "6.0.0-canary.20",
+    "@graphcommerce/magento-cart-payment-method": "6.0.0-canary.20",
+    "@graphcommerce/magento-cart-shipping-method": "6.0.0-canary.20",
+    "@graphcommerce/magento-product": "6.0.0-canary.20",
+    "@graphcommerce/next-config": "6.0.0-canary.20",
+    "@graphcommerce/next-ui": "6.0.0-canary.20"
   },
   "devDependencies": {
-    "@graphcommerce/eslint-config-pwa": "5.2.0-canary.8",
-    "@graphcommerce/prettier-config-pwa": "5.2.0-canary.8",
-    "@graphcommerce/typescript-config-pwa": "5.2.0-canary.8",
+    "@graphcommerce/eslint-config-pwa": "6.0.0-canary.20",
+    "@graphcommerce/prettier-config-pwa": "6.0.0-canary.20",
+    "@graphcommerce/typescript-config-pwa": "6.0.0-canary.20",
     "@types/gtag.js": "^0.0.12"
   },
   "peerDependencies": {

package/plugins/GaAddProductsToCartForm.tsx

@@ -1,9 +1,10 @@
 import { AddProductsToCartFormProps } from '@graphcommerce/magento-product'
-import { PluginProps } from '@graphcommerce/next-config'
+import { IfConfig, PluginProps } from '@graphcommerce/next-config'
 import { gtagAddToCart } from '../events/gtagAddToCart/gtagAddToCart'
 
 export const component = 'AddProductsToCartForm'
 export const exported = '@graphcommerce/magento-product'
+export const ifConfig: IfConfig = 'googleAnalyticsId'
 
 /** When a product is added to the Cart, send a Google Analytics event */
 function GaAddProductsToCartForm(props: PluginProps<AddProductsToCartFormProps>) {

package/plugins/GaCartStartCheckout.tsx

@@ -1,9 +1,10 @@
 import { CartStartCheckoutProps } from '@graphcommerce/magento-cart'
-import { PluginProps } from '@graphcommerce/next-config'
+import { IfConfig, PluginProps } from '@graphcommerce/next-config'
 import { gtagBeginCheckout } from '../events/gtagBeginCheckout/gtagBeginCheckout'
 
 export const component = 'CartStartCheckout'
 export const exported = '@graphcommerce/magento-cart'
+export const ifConfig: IfConfig = 'googleAnalyticsId'
 
 export function GaCartStartCheckout(props: PluginProps<CartStartCheckoutProps>) {
   const { Prev, onStart, ...rest } = props

package/plugins/GaCartStartCheckoutLinkOrButton.tsx

@@ -1,9 +1,10 @@
 import { CartStartCheckoutLinkOrButtonProps } from '@graphcommerce/magento-cart'
-import { PluginProps } from '@graphcommerce/next-config'
+import { IfConfig, PluginProps } from '@graphcommerce/next-config'
 import { gtagBeginCheckout } from '../events/gtagBeginCheckout/gtagBeginCheckout'
 
 export const component = 'CartStartCheckoutLinkOrButton'
 export const exported = '@graphcommerce/magento-cart'
+export const ifConfig: IfConfig = 'googleAnalyticsId'
 
 export function GaCartStartCheckoutLinkOrButton(
   props: PluginProps<CartStartCheckoutLinkOrButtonProps>,

package/plugins/GaFramerNextPages.tsx

@@ -1,9 +1,10 @@
 import type { PagesProps } from '@graphcommerce/framer-next-pages'
-import type { PluginProps } from '@graphcommerce/next-config'
+import type { IfConfig, PluginProps } from '@graphcommerce/next-config'
 import { GoogleAnalyticsScript } from '../components/GoogleAnalyticsScript'
 
 export const component = 'FramerNextPages'
 export const exported = '@graphcommerce/framer-next-pages'
+export const ifConfig: IfConfig = 'googleAnalyticsId'
 
 let warned = false
 

package/plugins/GaPaymentMethodButton.tsx

@@ -1,11 +1,12 @@
 import { useCartQuery } from '@graphcommerce/magento-cart'
 import { PaymentMethodButtonProps } from '@graphcommerce/magento-cart-payment-method'
 import { GetPaymentMethodContextDocument } from '@graphcommerce/magento-cart-payment-method/PaymentMethodContext/GetPaymentMethodContext.gql'
-import { PluginProps } from '@graphcommerce/next-config'
+import { IfConfig, PluginProps } from '@graphcommerce/next-config'
 import { gtagAddPaymentInfo } from '../events/gtagAddPaymentInfo/gtagAddPaymentInfo'
 
 export const component = 'PaymentMethodButton'
 export const exported = '@graphcommerce/magento-cart-payment-method'
+export const ifConfig: IfConfig = 'googleAnalyticsId'
 
 // @todo This plugin can probably be migrated to the actual form that is submitted.
 function GaPaymentMethodButton(props: PluginProps<PaymentMethodButtonProps>) {

package/plugins/GaPaymentMethodContextProvider.tsx

@@ -1,9 +1,10 @@
 import type { PaymentMethodContextProviderProps } from '@graphcommerce/magento-cart-payment-method'
-import type { PluginProps } from '@graphcommerce/next-config'
+import type { IfConfig, PluginProps } from '@graphcommerce/next-config'
 import { gtagAddPurchaseInfo } from '../events/gtagAddPurchaseInfo/gtagAddPurchaseInfo'
 
 export const component = 'PaymentMethodContextProvider'
 export const exported = '@graphcommerce/magento-cart-payment-method'
+export const ifConfig: IfConfig = 'googleAnalyticsId'
 
 function GaPaymentMethodContextProvider(props: PluginProps<PaymentMethodContextProviderProps>) {
   const { Prev, onSuccess, ...rest } = props

package/plugins/GaProductListItem.tsx

@@ -1,10 +1,11 @@
 import { ProductListItemProps } from '@graphcommerce/magento-product'
-import { PluginProps } from '@graphcommerce/next-config'
+import { IfConfig, PluginProps } from '@graphcommerce/next-config'
 import { useEventCallback } from '@mui/material'
 import { useGoogleAnalyticsListItemHandler } from '../components/GoogleAnalyticsItemList'
 
 export const component = 'ProductListItem'
 export const exported = '@graphcommerce/magento-product'
+export const ifConfig: IfConfig = 'googleAnalyticsId'
 
 function GaProductListItemsBase(props: PluginProps<ProductListItemProps>) {
   const { Prev, onClick, ...rest } = props

package/plugins/GaProductListItemsBase.tsx

@@ -1,9 +1,10 @@
 import type { ProductItemsGridProps } from '@graphcommerce/magento-product'
-import { PluginProps } from '@graphcommerce/next-config'
+import { IfConfig, PluginProps } from '@graphcommerce/next-config'
 import { GoogleAnalyticsItemList } from '../components/GoogleAnalyticsItemList'
 
 export const component = 'ProductListItemsBase'
 export const exported = '@graphcommerce/magento-product'
+export const ifConfig: IfConfig = 'googleAnalyticsId'
 
 export function GaProductListItemsBase(props: PluginProps<ProductItemsGridProps>) {
   const { Prev, ...rest } = props

package/plugins/GaShippingMethodForm.tsx

@@ -1,9 +1,10 @@
 import { ShippingMethodFormProps } from '@graphcommerce/magento-cart-shipping-method'
-import { PluginProps } from '@graphcommerce/next-config'
+import { IfConfig, PluginProps } from '@graphcommerce/next-config'
 import { gtagAddShippingInfo } from '../events/gtagAddShippingInfo/gtagAddShippingInfo'
 
 export const component = 'ShippingMethodForm'
 export const exported = '@graphcommerce/magento-cart-shipping-method'
+export const ifConfig: IfConfig = 'googleAnalyticsId'
 
 /** When the ShippingMethod is submitted the result is sent to Google Analytics */
 export function GaShippingMethodForm(props: PluginProps<ShippingMethodFormProps>) {

package/plugins/GaUpdateItemQuantity.tsx

@@ -1,9 +1,9 @@
-import { UpdateItemQuantityProps } from '@graphcommerce/magento-cart-items'
-import { PluginProps } from '@graphcommerce/next-config'
+import type { UpdateItemQuantityProps } from '@graphcommerce/magento-cart-items'
+import { IfConfig, PluginProps } from '@graphcommerce/next-config'
 
 export const component = 'UpdateItemQuantity'
 export const exported = '@graphcommerce/magento-cart-items/UpdateItemQuantity/UpdateItemQuantity'
-export const ifEnv = 'NEXT_PUBLIC_GOOGLE_ANALYTICS' // @frank: chekcen of dit werr
+export const ifConfig: IfConfig = 'googleAnalyticsId'
 
 /**
  * When a product is added to the Cart, by using the + button on cart page, send a Google Analytics