@graphcommerce/next-config 6.2.0-canary.8 → 6.2.0-canary.9

package/CHANGELOG.md

@@ -1,5 +1,7 @@
 # Change Log
 
+## 6.2.0-canary.9
+
 ## 6.2.0-canary.8
 
 ## 6.2.0-canary.7

package/__tests__/config/utils/__snapshots__/mergeEnvIntoConfig.ts.snap

@@ -1,9 +1,35 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`parses an env config object 1`] = `
+{
+  "GC_CUSTOMER_REQUIRE_EMAIL_CONFIRMATION": false,
+  "GC_DEMO_MODE": true,
+  "GC_STOREFRONT": [
+    {
+      "defaultLocale": true,
+      "hygraphLocales": [
+        "en",
+      ],
+      "locale": "en",
+      "magentoStoreCode": "en_us",
+    },
+  ],
+  "GC_STOREFRONT_0_DEFAULT_LOCALE": true,
+  "GC_STOREFRONT_0_HYGRAPH_LOCALES_0": "en",
+  "GC_STOREFRONT_0_LOCALE": "en",
+  "GC_STOREFRONT_0_MAGENTO_STORE_CODE": "en_us",
+  "GC_STOREFRONT_1_HYGRAPH_LOCALES_0": "de",
+  "GC_STOREFRONT_1_LOCALE": "de",
+  "GC_STOREFRONT_1_MAGENTO_STORE_CODE": "de_de",
+}
+`;
+
 exports[`traverses a schema and returns a list of env variables that match 1`] = `
 [
   "GC_CANONICAL_BASE_URL",
   "GC_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_COMPARE",
+  "GC_COMPARE_CHECKBOX",
   "GC_CUSTOMER_REQUIRE_EMAIL_CONFIRMATION",
   "GC_DEBUG",
   "GC_DEBUG_PLUGIN_STATUS",
@@ -27,6 +53,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_0",
   "GC_STOREFRONT_0_CANONICAL_BASE_URL",
   "GC_STOREFRONT_0_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_0_COMPARE_CHECKBOX",
   "GC_STOREFRONT_0_DEFAULT_LOCALE",
   "GC_STOREFRONT_0_DOMAIN",
   "GC_STOREFRONT_0_GOOGLE_ANALYTICS_ID",
@@ -60,6 +87,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_1",
   "GC_STOREFRONT_1_CANONICAL_BASE_URL",
   "GC_STOREFRONT_1_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_1_COMPARE_CHECKBOX",
   "GC_STOREFRONT_1_DEFAULT_LOCALE",
   "GC_STOREFRONT_1_DOMAIN",
   "GC_STOREFRONT_1_GOOGLE_ANALYTICS_ID",
@@ -93,6 +121,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_2",
   "GC_STOREFRONT_2_CANONICAL_BASE_URL",
   "GC_STOREFRONT_2_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_2_COMPARE_CHECKBOX",
   "GC_STOREFRONT_2_DEFAULT_LOCALE",
   "GC_STOREFRONT_2_DOMAIN",
   "GC_STOREFRONT_2_GOOGLE_ANALYTICS_ID",
@@ -126,6 +155,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_3",
   "GC_STOREFRONT_3_CANONICAL_BASE_URL",
   "GC_STOREFRONT_3_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_3_COMPARE_CHECKBOX",
   "GC_STOREFRONT_3_DEFAULT_LOCALE",
   "GC_STOREFRONT_3_DOMAIN",
   "GC_STOREFRONT_3_GOOGLE_ANALYTICS_ID",
@@ -159,6 +189,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_4",
   "GC_STOREFRONT_4_CANONICAL_BASE_URL",
   "GC_STOREFRONT_4_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_4_COMPARE_CHECKBOX",
   "GC_STOREFRONT_4_DEFAULT_LOCALE",
   "GC_STOREFRONT_4_DOMAIN",
   "GC_STOREFRONT_4_GOOGLE_ANALYTICS_ID",
@@ -192,6 +223,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_5",
   "GC_STOREFRONT_5_CANONICAL_BASE_URL",
   "GC_STOREFRONT_5_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_5_COMPARE_CHECKBOX",
   "GC_STOREFRONT_5_DEFAULT_LOCALE",
   "GC_STOREFRONT_5_DOMAIN",
   "GC_STOREFRONT_5_GOOGLE_ANALYTICS_ID",
@@ -225,6 +257,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_6",
   "GC_STOREFRONT_6_CANONICAL_BASE_URL",
   "GC_STOREFRONT_6_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_6_COMPARE_CHECKBOX",
   "GC_STOREFRONT_6_DEFAULT_LOCALE",
   "GC_STOREFRONT_6_DOMAIN",
   "GC_STOREFRONT_6_GOOGLE_ANALYTICS_ID",
@@ -258,6 +291,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_7",
   "GC_STOREFRONT_7_CANONICAL_BASE_URL",
   "GC_STOREFRONT_7_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_7_COMPARE_CHECKBOX",
   "GC_STOREFRONT_7_DEFAULT_LOCALE",
   "GC_STOREFRONT_7_DOMAIN",
   "GC_STOREFRONT_7_GOOGLE_ANALYTICS_ID",
@@ -291,6 +325,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_8",
   "GC_STOREFRONT_8_CANONICAL_BASE_URL",
   "GC_STOREFRONT_8_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_8_COMPARE_CHECKBOX",
   "GC_STOREFRONT_8_DEFAULT_LOCALE",
   "GC_STOREFRONT_8_DOMAIN",
   "GC_STOREFRONT_8_GOOGLE_ANALYTICS_ID",
@@ -324,6 +359,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_9",
   "GC_STOREFRONT_9_CANONICAL_BASE_URL",
   "GC_STOREFRONT_9_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_9_COMPARE_CHECKBOX",
   "GC_STOREFRONT_9_DEFAULT_LOCALE",
   "GC_STOREFRONT_9_DOMAIN",
   "GC_STOREFRONT_9_GOOGLE_ANALYTICS_ID",
@@ -357,6 +393,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_10",
   "GC_STOREFRONT_10_CANONICAL_BASE_URL",
   "GC_STOREFRONT_10_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_10_COMPARE_CHECKBOX",
   "GC_STOREFRONT_10_DEFAULT_LOCALE",
   "GC_STOREFRONT_10_DOMAIN",
   "GC_STOREFRONT_10_GOOGLE_ANALYTICS_ID",
@@ -390,6 +427,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_11",
   "GC_STOREFRONT_11_CANONICAL_BASE_URL",
   "GC_STOREFRONT_11_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_11_COMPARE_CHECKBOX",
   "GC_STOREFRONT_11_DEFAULT_LOCALE",
   "GC_STOREFRONT_11_DOMAIN",
   "GC_STOREFRONT_11_GOOGLE_ANALYTICS_ID",
@@ -423,6 +461,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_12",
   "GC_STOREFRONT_12_CANONICAL_BASE_URL",
   "GC_STOREFRONT_12_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_12_COMPARE_CHECKBOX",
   "GC_STOREFRONT_12_DEFAULT_LOCALE",
   "GC_STOREFRONT_12_DOMAIN",
   "GC_STOREFRONT_12_GOOGLE_ANALYTICS_ID",
@@ -456,6 +495,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_13",
   "GC_STOREFRONT_13_CANONICAL_BASE_URL",
   "GC_STOREFRONT_13_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_13_COMPARE_CHECKBOX",
   "GC_STOREFRONT_13_DEFAULT_LOCALE",
   "GC_STOREFRONT_13_DOMAIN",
   "GC_STOREFRONT_13_GOOGLE_ANALYTICS_ID",
@@ -489,6 +529,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_14",
   "GC_STOREFRONT_14_CANONICAL_BASE_URL",
   "GC_STOREFRONT_14_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_14_COMPARE_CHECKBOX",
   "GC_STOREFRONT_14_DEFAULT_LOCALE",
   "GC_STOREFRONT_14_DOMAIN",
   "GC_STOREFRONT_14_GOOGLE_ANALYTICS_ID",
@@ -522,6 +563,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_15",
   "GC_STOREFRONT_15_CANONICAL_BASE_URL",
   "GC_STOREFRONT_15_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_15_COMPARE_CHECKBOX",
   "GC_STOREFRONT_15_DEFAULT_LOCALE",
   "GC_STOREFRONT_15_DOMAIN",
   "GC_STOREFRONT_15_GOOGLE_ANALYTICS_ID",
@@ -555,6 +597,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_16",
   "GC_STOREFRONT_16_CANONICAL_BASE_URL",
   "GC_STOREFRONT_16_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_16_COMPARE_CHECKBOX",
   "GC_STOREFRONT_16_DEFAULT_LOCALE",
   "GC_STOREFRONT_16_DOMAIN",
   "GC_STOREFRONT_16_GOOGLE_ANALYTICS_ID",
@@ -588,6 +631,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_17",
   "GC_STOREFRONT_17_CANONICAL_BASE_URL",
   "GC_STOREFRONT_17_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_17_COMPARE_CHECKBOX",
   "GC_STOREFRONT_17_DEFAULT_LOCALE",
   "GC_STOREFRONT_17_DOMAIN",
   "GC_STOREFRONT_17_GOOGLE_ANALYTICS_ID",
@@ -621,6 +665,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_18",
   "GC_STOREFRONT_18_CANONICAL_BASE_URL",
   "GC_STOREFRONT_18_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_18_COMPARE_CHECKBOX",
   "GC_STOREFRONT_18_DEFAULT_LOCALE",
   "GC_STOREFRONT_18_DOMAIN",
   "GC_STOREFRONT_18_GOOGLE_ANALYTICS_ID",
@@ -654,6 +699,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_19",
   "GC_STOREFRONT_19_CANONICAL_BASE_URL",
   "GC_STOREFRONT_19_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_19_COMPARE_CHECKBOX",
   "GC_STOREFRONT_19_DEFAULT_LOCALE",
   "GC_STOREFRONT_19_DOMAIN",
   "GC_STOREFRONT_19_GOOGLE_ANALYTICS_ID",
@@ -687,6 +733,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_STOREFRONT_20",
   "GC_STOREFRONT_20_CANONICAL_BASE_URL",
   "GC_STOREFRONT_20_CART_DISPLAY_PRICES_INCL_TAX",
+  "GC_STOREFRONT_20_COMPARE_CHECKBOX",
   "GC_STOREFRONT_20_DEFAULT_LOCALE",
   "GC_STOREFRONT_20_DOMAIN",
   "GC_STOREFRONT_20_GOOGLE_ANALYTICS_ID",

package/__tests__/interceptors/findPlugins.ts

@@ -129,12 +129,6 @@ it('finds plugins', () => {
         "ifConfig": "googleRecaptchaKey",
         "plugin": "@graphcommerce/googlerecaptcha/plugins/GrecaptchaGraphQLProvider",
       },
-      {
-        "enabled": true,
-        "exported": "@graphcommerce/graphcms-ui",
-        "func": "hygraphPageContent",
-        "plugin": "@graphcommerce/hygraph-dynamic-rows/plugins/hygraphDynamicRowsPageContent",
-      },
       {
         "enabled": true,
         "exported": "@graphcommerce/graphql/config",
@@ -223,6 +217,34 @@ it('finds plugins', () => {
         "ifConfig": "googleTagmanagerId",
         "plugin": "@graphcommerce/googletagmanager/plugins/GtagFramerNextPages",
       },
+      {
+        "component": "CartFab",
+        "enabled": false,
+        "exported": "@graphcommerce/magento-cart",
+        "ifConfig": "compare",
+        "plugin": "@graphcommerce/magento-compare/plugins/AddCompareFabNextToCart",
+      },
+      {
+        "component": "ProductPageAddToCartActionsRow",
+        "enabled": false,
+        "exported": "@graphcommerce/magento-product",
+        "ifConfig": "compare",
+        "plugin": "@graphcommerce/magento-compare/plugins/AddCompareToProductPage",
+      },
+      {
+        "component": "GraphQLProvider",
+        "enabled": false,
+        "exported": "@graphcommerce/graphql",
+        "ifConfig": "compare",
+        "plugin": "@graphcommerce/magento-compare/plugins/AddCompareTypePolicies",
+      },
+      {
+        "component": "ProductListItem",
+        "enabled": false,
+        "exported": "@graphcommerce/magento-product",
+        "ifConfig": "compare",
+        "plugin": "@graphcommerce/magento-compare/plugins/CompareAbleProductListItem",
+      },
     ]
   `)
 })

package/__tests__/utils/resolveDependenciesSync.ts

@@ -15,7 +15,6 @@ it('resolves dependences', () => {
       "@graphcommerce/magento-cart-shipping-method" => "packages/magento-cart-shipping-method",
       "@graphcommerce/googlerecaptcha" => "packages/googlerecaptcha",
       "@graphcommerce/googletagmanager" => "packages/googletagmanager",
-      "@graphcommerce/hygraph-dynamic-rows" => "packages/hygraph-dynamic-rows",
       "@graphcommerce/graphcms-ui" => "packages/hygraph-ui",
       "@graphcommerce/lingui-next" => "packages/lingui-next",
       "@graphcommerce/next-config" => "packagesDev/next-config",
@@ -24,6 +23,7 @@ it('resolves dependences', () => {
       "@graphcommerce/magento-cart-coupon" => "packages/magento-cart-coupon",
       "@graphcommerce/magento-cart-email" => "packages/magento-cart-email",
       "@graphcommerce/magento-cms" => "packages/magento-cms",
+      "@graphcommerce/magento-compare" => "packages/magento-compare",
       "@graphcommerce/magento-newsletter" => "packages/magento-newsletter",
       "@graphcommerce/magento-payment-included" => "packages/magento-payment-included",
       "@graphcommerce/magento-cart-payment-method" => "packages/magento-cart-payment-method",

package/dist/config/demoConfig.js

@@ -22,4 +22,5 @@ exports.demoConfig = {
     robotsAllow: false,
     demoMode: true,
     limitSsg: true,
+    compare: true,
 };

package/dist/generated/config.js

@@ -1,15 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GraphCommerceStorefrontConfigSchema = exports.GraphCommerceDebugConfigSchema = exports.GraphCommerceConfigSchema = exports.definedNonNullAnySchema = exports.isDefinedNonNullAny = void 0;
+exports.GraphCommerceStorefrontConfigSchema = exports.GraphCommerceDebugConfigSchema = exports.GraphCommerceConfigSchema = exports.CompareVariantSchema = exports.definedNonNullAnySchema = exports.isDefinedNonNullAny = void 0;
 /* eslint-disable */
 const zod_1 = require("zod");
 const isDefinedNonNullAny = (v) => v !== undefined && v !== null;
 exports.isDefinedNonNullAny = isDefinedNonNullAny;
 exports.definedNonNullAnySchema = zod_1.z.any().refine((v) => (0, exports.isDefinedNonNullAny)(v));
+exports.CompareVariantSchema = zod_1.z.enum(['CHECKBOX', 'ICON']);
 function GraphCommerceConfigSchema() {
     return zod_1.z.object({
         canonicalBaseUrl: zod_1.z.string().min(1),
         cartDisplayPricesInclTax: zod_1.z.boolean().nullish(),
+        compare: zod_1.z.boolean().nullish(),
+        compareVariant: exports.CompareVariantSchema.nullish(),
         customerRequireEmailConfirmation: zod_1.z.boolean().nullish(),
         debug: GraphCommerceDebugConfigSchema().nullish(),
         demoMode: zod_1.z.boolean().nullish(),

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/next-config",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "6.2.0-canary.8",
+  "version": "6.2.0-canary.9",
   "type": "commonjs",
   "main": "dist/index.js",
   "types": "src/index.ts",

package/src/config/demoConfig.ts

@@ -21,4 +21,5 @@ export const demoConfig: Partial<GraphCommerceConfig> & Record<string, unknown>
   robotsAllow: false,
   demoMode: true,
   limitSsg: true,
+  compare: true,
 }

package/src/generated/config.ts

@@ -14,6 +14,10 @@ export type Scalars = {
   Float: number;
 };
 
+export type CompareVariant =
+  | 'CHECKBOX'
+  | 'ICON';
+
 /**
  * # GraphCommerce configuration system
  *
@@ -107,6 +111,13 @@ export type GraphCommerceConfig = {
    * When Magento's StoreConfig adds this value, this can be replaced.
    */
   cartDisplayPricesInclTax?: InputMaybe<Scalars['Boolean']>;
+  /** Use compare functionality */
+  compare?: InputMaybe<Scalars['Boolean']>;
+  /**
+   * 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
+   */
+  compareVariant?: InputMaybe<CompareVariant>;
   /**
    * Due to a limitation in the GraphQL API of Magento 2, we need to know if the
    * customer requires email confirmation.
@@ -316,10 +327,14 @@ export const isDefinedNonNullAny = (v: any): v is definedNonNullAny => v !== und
 
 export const definedNonNullAnySchema = z.any().refine((v) => isDefinedNonNullAny(v));
 
+export const CompareVariantSchema = z.enum(['CHECKBOX', 'ICON']);
+
 export function GraphCommerceConfigSchema(): z.ZodObject<Properties<GraphCommerceConfig>> {
   return z.object<Properties<GraphCommerceConfig>>({
     canonicalBaseUrl: z.string().min(1),
     cartDisplayPricesInclTax: z.boolean().nullish(),
+    compare: z.boolean().nullish(),
+    compareVariant: CompareVariantSchema.nullish(),
     customerRequireEmailConfirmation: z.boolean().nullish(),
     debug: GraphCommerceDebugConfigSchema().nullish(),
     demoMode: z.boolean().nullish(),