@graphcommerce/next-config 9.0.0-canary.105 → 9.0.0-canary.107

package/__tests__/interceptors/generateInterceptors.ts

@@ -5,33 +5,31 @@ import { generateInterceptors } from '../../src/interceptors/generateInterceptor
 import { parseStructure } from '../../src/interceptors/parseStructure'
 import { parseSync } from '../../src/interceptors/swc'
 import { resolveDependency } from '../../src/utils/resolveDependency'
-
 const projectRoot = `${process.cwd()}/examples/magento-graphcms`
-
 const startLocation = '/** @see {@link file://'
-
 const expectImport = (value: string | undefined): jest.JestMatchers<string> =>
-  expect(value?.slice(value.indexOf('import') - 1, value.indexOf(startLocation) - 1).trim())
+  expect(
+    value
+      ?.slice(value.indexOf('import') - 1, value.indexOf(startLocation) - 1)
 
+      .trim(),
+  )
 const expectInterceptor = (value: string | undefined): jest.JestMatchers<string> => {
   const val = value?.slice(value.indexOf(SOURCE_END) + SOURCE_END.length).trim()
   return expect(val?.trim())
 }
-
 const expectOriginal = (value: string | undefined): jest.JestMatchers<string> =>
   expect(
     value
       ?.slice(value.indexOf(SOURCE_START) + SOURCE_START.length, value.indexOf(SOURCE_END))
       .trim(),
   )
-
 it('it replaces paths and creates a relative path', () => {
   const resolver = resolveDependency(projectRoot)
   const resolved = resolver('@graphcommerce/magento-cart-payment-method')
   expect(resolved?.fromRoot).toMatchInlineSnapshot('"packages/magento-cart-payment-method/index"')
   expect(resolved?.fromModule).toBe('.')
   expect(resolved?.root).toBe('packages/magento-cart-payment-method')
-
   const resolved2 = resolver(
     '@graphcommerce/magento-cart-payment-method/PaymentMethodContext/PaymentMethodContext',
   )
@@ -41,7 +39,6 @@ it('it replaces paths and creates a relative path', () => {
   expect(resolved2?.fromModule).toBe('./PaymentMethodContext')
   expect(resolved2?.root).toBe('packages/magento-cart-payment-method')
 })
-
 it('it generates an interceptor', async () => {
   const resolve = resolveDependency(projectRoot)
   const interceptors = await generateInterceptors(
@@ -65,11 +62,9 @@ it('it generates an interceptor', async () => {
     ],
     resolve,
   )
-
   expect(Object.keys(interceptors)[0]).toBe(
     'packages/magento-cart-payment-method/PaymentMethodContext/PaymentMethodContext',
   )
-
   const result =
     interceptors['packages/magento-cart-payment-method/PaymentMethodContext/PaymentMethodContext']
       ?.template
@@ -93,7 +88,8 @@ it('it generates an interceptor', async () => {
     /**
      * Here you see the 'interceptor' that is applying all the configured plugins.
      *
-     * This file is NOT meant to be modified directly and is auto-generated if the plugins or the original source changes.
+     * This file is NOT meant to be modified directly and is auto-generated if the plugins or the
+     * original source changes.
      *
      * @see {@link file://./PaymentMethodContext.tsx} for original source file
      * @see {PluginAddBraintreeMethods} for source of applied plugin
@@ -102,7 +98,6 @@ it('it generates an interceptor', async () => {
     export const PaymentMethodContextProvider = PluginAddMollieMethodsInterceptor"
   `)
 })
-
 it("resolves a 'root plugin' to be relative to the interceptor", async () => {
   const interceptors = await generateInterceptors(
     [
@@ -117,7 +112,6 @@ it("resolves a 'root plugin' to be relative to the interceptor", async () => {
     ],
     resolveDependency(projectRoot),
   )
-
   expect(Object.keys(interceptors)[0]).toMatchInlineSnapshot(
     '"packages/magento-cart-payment-method/PaymentMethodContext/PaymentMethodContext"',
   )
@@ -128,7 +122,6 @@ it("resolves a 'root plugin' to be relative to the interceptor", async () => {
     "import { Plugin as PluginAddPaymentMethodEnhancer } from '../../../plugins/AddPaymentMethodEnhancer'",
   )
 })
-
 it('it can apply multiple plugins to a single export', async () => {
   const resolve = resolveDependency(projectRoot)
   const interceptors = await generateInterceptors(
@@ -162,7 +155,6 @@ it('it can apply multiple plugins to a single export', async () => {
     "import { Plugin as PluginAddMollieMethods } from '@graphcommerce/mollie-magento-payment/plugins/AddMollieMethods'",
   )
   expectOriginal(result).toContain('PaymentMethodContextProviderOriginal')
-
   expectInterceptor(result).toMatchInlineSnapshot(`
     "type PluginAddAdyenMethodsProps = OmitPrev<
       React.ComponentProps<typeof PluginAddAdyenMethods>,
@@ -183,7 +175,8 @@ it('it can apply multiple plugins to a single export', async () => {
     /**
      * Here you see the 'interceptor' that is applying all the configured plugins.
      *
-     * This file is NOT meant to be modified directly and is auto-generated if the plugins or the original source changes.
+     * This file is NOT meant to be modified directly and is auto-generated if the plugins or the
+     * original source changes.
      *
      * @see {@link file://./PaymentMethodContext.tsx} for original source file
      * @see {PluginAddAdyenMethods} for source of applied plugin
@@ -192,7 +185,6 @@ it('it can apply multiple plugins to a single export', async () => {
     export const PaymentMethodContextProvider = PluginAddMollieMethodsInterceptor"
   `)
 })
-
 it('it handles on duplicates gracefully', async () => {
   const resolve = resolveDependency(projectRoot)
   const interceptors = await generateInterceptors(
@@ -216,7 +208,6 @@ it('it handles on duplicates gracefully', async () => {
     ],
     resolve,
   )
-
   const result =
     interceptors['packages/magento-cart-payment-method/PaymentMethodContext/PaymentMethodContext']
       ?.template
@@ -233,7 +224,8 @@ it('it handles on duplicates gracefully', async () => {
     /**
      * Here you see the 'interceptor' that is applying all the configured plugins.
      *
-     * This file is NOT meant to be modified directly and is auto-generated if the plugins or the original source changes.
+     * This file is NOT meant to be modified directly and is auto-generated if the plugins or the
+     * original source changes.
      *
      * @see {@link file://./PaymentMethodContext.tsx} for original source file
      * @see {PluginAddBraintreeMethods} for source of applied plugin
@@ -241,7 +233,6 @@ it('it handles on duplicates gracefully', async () => {
     export const PaymentMethodContextProvider = PluginAddBraintreeMethodsInterceptor"
   `)
 })
-
 it('correctly renames all variable usages', async () => {
   const resolve = resolveDependency(projectRoot)
   const interceptors = await generateInterceptors(
@@ -257,17 +248,14 @@ it('correctly renames all variable usages', async () => {
     ],
     resolve,
   )
-
   expect(Object.keys(interceptors)[0]).toMatchInlineSnapshot(
     '"packages/magento-product/components/ProductListItem/ProductListItem"',
   )
-
   const template =
     interceptors['packages/magento-product/components/ProductListItem/ProductListItem']?.template
   expectOriginal(template).not.toContain('ProductListItem.selectors')
   expectOriginal(template).toContain('ProductListItemOriginal.selectors')
 })
-
 it('it handles root plugins', async () => {
   const resolve = resolveDependency(projectRoot)
   const interceptors = await generateInterceptors(
@@ -283,15 +271,12 @@ it('it handles root plugins', async () => {
     ],
     resolve,
   )
-
   expect(interceptors['packages/magento-product/index']?.template).toMatchInlineSnapshot(
     'undefined',
   )
 })
-
 it('it handles root plugins and creates a relative path', async () => {
   const resolve = resolveDependency(projectRoot)
-
   const interceptors = await generateInterceptors(
     [
       {
@@ -305,17 +290,14 @@ it('it handles root plugins and creates a relative path', async () => {
     ],
     resolve,
   )
-
   expect(Object.keys(interceptors)[0]).toMatchInlineSnapshot(
     '"packages/next-ui/Overlay/components/OverlayBase"',
   )
-
   expect(
     interceptors['packages/next-ui/Overlay/components/OverlayBase'].targetExports.OverlayBase[0]
       .sourceModule,
   ).toMatchInlineSnapshot('"../../../../examples/magento-graphcms/plugins/EnableCrosssellsPlugin"')
 })
-
 it('generates method interceptors alognside component interceptors', async () => {
   const resolve = resolveDependency(projectRoot)
   const interceptors = await generateInterceptors(
@@ -347,7 +329,6 @@ it('generates method interceptors alognside component interceptors', async () =>
     ],
     resolve,
   )
-
   expect(Object.keys(interceptors)).toMatchInlineSnapshot(
     `
     [
@@ -356,14 +337,12 @@ it('generates method interceptors alognside component interceptors', async () =>
     ]
   `,
   )
-
   expect(
     interceptors['packages/graphql/components/GraphQLProvider/GraphQLProvider']?.template,
   ).toContain('MagentoGraphqlGraphqlProvider')
   expect(interceptors['packages/graphql/config']?.template).toContain('magentoInitMemoryCache')
   expect(interceptors['packages/graphql/config']?.template).toContain('hygraphInitMemoryCache')
 })
-
 it('adds debug logging to interceptors for components', async () => {
   const resolve = resolveDependency(projectRoot)
   const interceptors = await generateInterceptors(
@@ -396,12 +375,10 @@ it('adds debug logging to interceptors for components', async () => {
     resolve,
     { pluginStatus: true },
   )
-
   expectImport(interceptors['packages/graphql/config']?.template).toMatchInlineSnapshot(`
     "import { plugin as pluginhygraphInitMemoryCache } from '@graphcommerce/magento-graphcms/plugins/hygraphInitMemoryCache'
     import { plugin as pluginmagentoInitMemoryCache } from '@graphcommerce/magento-graphql/plugins/magentoInitMemoryCache'"
   `)
-
   expectOriginal(interceptors['packages/graphql/config']?.template).toMatchInlineSnapshot(`
     "import type { GraphCommerceStorefrontConfig } from '@graphcommerce/next-config'
     import type { ApolloLink, TypePolicies } from '@apollo/client'
@@ -460,7 +437,8 @@ it('adds debug logging to interceptors for components', async () => {
     /**
      * Here you see the 'interceptor' that is applying all the configured plugins.
      *
-     * This file is NOT meant to be modified directly and is auto-generated if the plugins or the original source changes.
+     * This file is NOT meant to be modified directly and is auto-generated if the plugins or the
+     * original source changes.
      *
      * @see {@link file://./config.ts} for original source file
      * @see {pluginhygraphInitMemoryCache} for source of applied plugin
@@ -469,7 +447,6 @@ it('adds debug logging to interceptors for components', async () => {
     export const graphqlConfig = pluginmagentoInitMemoryCacheInterceptor"
   `)
 })
-
 it('correctly resolves when a source can not be parsed', async () => {
   const resolve = resolveDependency(projectRoot)
   const interceptors = await generateInterceptors(
@@ -486,12 +463,10 @@ it('correctly resolves when a source can not be parsed', async () => {
     resolve,
     { pluginStatus: true },
   )
-
   expect(Object.keys(interceptors)[0]).toMatchInlineSnapshot(
     '"packages/next-ui/Row/RowLinks/RowLinks"',
   )
 })
-
 it('can correctly find the source for deeper chained exports', () => {
   const resolve = resolveDependency(projectRoot)
   const originalSource = findOriginalSource(
@@ -511,7 +486,6 @@ it('can correctly find the source for deeper chained exports', () => {
     '"@graphcommerce/next-ui/Blog/BlogTags/BlogTag"',
   )
 })
-
 it('Should apply overrides to the correct file', async () => {
   const resolve = resolveDependency(projectRoot)
   const interceptors = await generateInterceptors(
@@ -527,28 +501,23 @@ it('Should apply overrides to the correct file', async () => {
     ],
     resolve,
   )
-
   expect(Object.keys(interceptors)[0]).toMatchInlineSnapshot(
     '"packages/magento-product/components/ProductStaticPaths/getProductStaticPaths"',
   )
-
   const result =
     interceptors['packages/magento-product/components/ProductStaticPaths/getProductStaticPaths']
       ?.template
   expect(result).toContain(
     "import { getProductStaticPaths as getProductStaticPathsreplaceGetProductStaticPaths } from '../../../../plugins/replaceGetProductStaticPaths'",
   )
-
   expectOriginal(result).toContain('getProductStaticPathsDisabled')
 })
-
 it('correctly reports an error for an incorrect export', async () => {
   const fakeconfig = {
     googleRecaptchaKey: '123',
     googleAnalyticsId: '123',
     demoMode: true,
   } as unknown as GraphCommerceConfig
-
   const src = `
 import { getSitemapPaths as getSitemapPathsType } from '@graphcommerce/magento-product'
 import { IfConfig, FunctionPlugin } from '@graphcommerce/next-config'
@@ -562,20 +531,15 @@ export const plugin: FunctionPlugin<typeof getSitemapPathsType> = (prev, ...args
   return prev(...args)
 }
 `
-
   console.error = jest.fn()
   const plugins = parseStructure(parseSync(src), fakeconfig, './plugins/MyPlugin.tsx')
-
   expect((console.error as jest.Mock).mock.calls[0][0]).toMatchInlineSnapshot(
     '"Plugin configuration invalid! See ./plugins/MyPlugin.tsx"',
   )
-
   expect(plugins).toMatchInlineSnapshot('[]')
   const result = await generateInterceptors(plugins, resolveDependency(projectRoot))
-
   expect(Object.keys(result)).toMatchInlineSnapshot('[]')
 })
-
 it('generated a correct file if a replacement and a plugin is applied to the same export', async () => {
   const src1 = `import { ProductPageNameProps } from '@graphcommerce/magento-product'
 import { PluginConfig } from '@graphcommerce/next-config'
@@ -591,7 +555,6 @@ export function ProductPageName(props: ProductPageNameProps) {
   return <div>Complete overrides {product.url_key}</div>
 }
 `
-
   const src2 = `import type { AddToCartItemSelector, ProductPageNameProps } from '@graphcommerce/magento-product'
 import type { IfConfig, PluginProps } from '@graphcommerce/next-config'
 import { useConfigurableSelectedVariant } from '../../hooks'
@@ -610,21 +573,17 @@ const ConfigurableProductPageName = (
 
 export const Plugin = ConfigurableProductPageName
 `
-
   const config = {
     demoMode: true,
     configurableVariantForSimple: true,
     configurableVariantValues: { content: true, gallery: true, url: true },
   } as unknown as GraphCommerceConfig
-
   const firstFile = parseStructure(parseSync(src1), config, './plugins/MyPlugin')
-
   const secondFile = parseStructure(
     parseSync(src2),
     config,
     '@graphcommerce/magento-product-configurable/plugins/ConfigurableProductPage/ConfigurableProductPageName',
   )
-
   const plugins = [...firstFile, ...secondFile]
   expect(plugins).toMatchInlineSnapshot(
     `
@@ -651,20 +610,16 @@ export const Plugin = ConfigurableProductPageName
   `,
   )
   const interceptors = await generateInterceptors(plugins, resolveDependency(projectRoot))
-
   expect(Object.keys(interceptors)[0]).toMatchInlineSnapshot(
     '"packages/magento-product/components/ProductPageName/ProductPageName"',
   )
-
   const result =
     interceptors['packages/magento-product/components/ProductPageName/ProductPageName']?.template
-
   expectImport(result).toMatchInlineSnapshot(`
     "import { Plugin as PluginConfigurableProductPageName } from '@graphcommerce/magento-product-configurable/plugins/ConfigurableProductPage/ConfigurableProductPageName'
     import type { DistributedOmit as OmitPrev } from 'type-fest'
     import { ProductPageName as ProductPageNameMyPlugin } from '../../../../plugins/MyPlugin'"
   `)
-
   expectOriginal(result).toMatchInlineSnapshot(`
     "import type { ProductPageNameFragment } from './ProductPageName.gql'
 
@@ -676,7 +631,6 @@ export const Plugin = ConfigurableProductPageName
       return <>{product.name}</>
     }"
   `)
-
   expectInterceptor(result).toMatchInlineSnapshot(`
     "type PluginConfigurableProductPageNameProps = React.ComponentProps<typeof ProductPageNameMyPlugin> &
       OmitPrev<React.ComponentProps<typeof PluginConfigurableProductPageName>, 'Prev'>
@@ -688,7 +642,8 @@ export const Plugin = ConfigurableProductPageName
     /**
      * Here you see the 'interceptor' that is applying all the configured plugins.
      *
-     * This file is NOT meant to be modified directly and is auto-generated if the plugins or the original source changes.
+     * This file is NOT meant to be modified directly and is auto-generated if the plugins or the
+     * original source changes.
      *
      * @see {@link file://./ProductPageName.tsx} for original source file
      * @see {ProductPageNameMyPlugin} for replacement of the original source (original source not used)
@@ -697,7 +652,6 @@ export const Plugin = ConfigurableProductPageName
     export const ProductPageName = PluginConfigurableProductPageNameInterceptor"
   `)
 })
-
 it('generates to a .ts file when the target file is a .ts as well', async () => {
   const resolve = resolveDependency(projectRoot)
   const interceptors = await generateInterceptors(
@@ -713,14 +667,11 @@ it('generates to a .ts file when the target file is a .ts as well', async () =>
     ],
     resolve,
   )
-
   expect(Object.keys(interceptors)[0]).toMatchInlineSnapshot('"packages/graphql/config"')
   const interceptor = interceptors['packages/graphql/config']
   expect(interceptor.sourcePath).toBe('packages/graphql/config.ts')
 })
-
 it.todo('Should report an error when multiple files are overriding the same export')
-
 it('Can correctly find exports that are default exports', async () => {
   const pluginSource = `
     import { PluginConfig } from '@graphcommerce/next-config'
@@ -741,29 +692,25 @@ it('Can correctly find exports that are default exports', async () => {
     configurableVariantForSimple: true,
     configurableVariantValues: { content: true, gallery: true, url: true },
   } as unknown as GraphCommerceConfig
-
   const plugins = parseStructure(parseSync(pluginSource), config, './plugins/MyProjectIcon')
-
   const interceptors = await generateInterceptors(plugins, resolveDependency(projectRoot))
   expect(Object.keys(interceptors)[0]).toMatchInlineSnapshot('"packages/next-ui/icons"')
-
   const result = interceptors['packages/next-ui/icons']?.template
-
   expectImport(result).toMatchInlineSnapshot(`
     "import {
       iconChevronLeft as iconChevronLeftMyProjectIcon,
       iconChevronRight as iconChevronRightMyProjectIcon,
     } from '../../plugins/MyProjectIcon'"
   `)
-
   expectOriginal(result).toContain('iconChevronLeftDisabled')
   expectOriginal(result).toContain('iconChevronRightDisabled')
-
-  expectInterceptor(result).toMatchInlineSnapshot(`
+  expectInterceptor(result).toMatchInlineSnapshot(
+    `
     "/**
      * Here you see the 'interceptor' that is applying all the configured plugins.
      *
-     * This file is NOT meant to be modified directly and is auto-generated if the plugins or the original source changes.
+     * This file is NOT meant to be modified directly and is auto-generated if the plugins or the
+     * original source changes.
      *
      * @see {@link file://./icons.ts} for original source file
      * @see {iconChevronLeftMyProjectIcon} for replacement of the original source (original source not used)
@@ -773,11 +720,13 @@ it('Can correctly find exports that are default exports', async () => {
     /**
      * Here you see the 'interceptor' that is applying all the configured plugins.
      *
-     * This file is NOT meant to be modified directly and is auto-generated if the plugins or the original source changes.
+     * This file is NOT meant to be modified directly and is auto-generated if the plugins or the
+     * original source changes.
      *
      * @see {@link file://./icons.ts} for original source file
      * @see {iconChevronRightMyProjectIcon} for replacement of the original source (original source not used)
      */
     export const iconChevronRight = iconChevronRightMyProjectIcon"
-  `)
+  `,
+  )
 })

package/__tests__/utils/resolveDependenciesSync.ts

@@ -1,17 +1,16 @@
 import { resolveDependenciesSync, sortDependencies } from '../../src/utils/resolveDependenciesSync'
-
 const projectRoot = `${process.cwd()}/examples/magento-graphcms`
-
 it('resolves dependences', () => {
   const dependencies = resolveDependenciesSync(projectRoot)
-
-  expect(dependencies).toMatchInlineSnapshot(`
+  expect(dependencies).toMatchInlineSnapshot(
+    `
     Map {
       "." => "examples/magento-graphcms",
       "@graphcommerce/cli" => "packages/cli",
       "@graphcommerce/hygraph-cli" => "packages/hygraph-cli",
       "@graphcommerce/demo-magento-graphcommerce" => "packages/demo-magento-graphcommerce",
       "@graphcommerce/magento-recently-viewed-products" => "packages/magento-recently-viewed-products",
+      "@graphcommerce/google-playstore" => "packages/google-playstore",
       "@graphcommerce/googleanalytics" => "packages/googleanalytics",
       "@graphcommerce/googlerecaptcha" => "packages/googlerecaptcha",
       "@graphcommerce/googletagmanager" => "packages/googletagmanager",
@@ -72,9 +71,9 @@ it('resolves dependences', () => {
       "@graphcommerce/eslint-config-pwa" => "packagesDev/eslint-config",
       "@graphcommerce/typescript-config-pwa" => "packagesDev/typescript-config",
     }
-  `)
+  `,
+  )
 })
-
 it('sorts dependencies', () => {
   const sorted = sortDependencies({
     '@graphcommerce/magento-graphcms': {
@@ -94,13 +93,14 @@ it('sorts dependencies', () => {
       dependencies: ['@graphcommerce/magento-product'],
     },
   })
-
-  expect(sorted).toMatchInlineSnapshot(`
+  expect(sorted).toMatchInlineSnapshot(
+    `
     Map {
       "@graphcommerce/magento-graphcms" => "examples/magento-graphcms",
       "@graphcommerce/magento-cart" => "packages/magento-cart",
       "@graphcommerce/magento-product" => "packages/magento-product",
       "@graphcommerce/magento-product-simple" => "packages/magento-product-simple",
     }
-  `)
+  `,
+  )
 })

package/dist/commands/codegen.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.codegen = codegen;
+const generateConfig_1 = require("../config/commands/generateConfig");
+const codegenInterceptors_1 = require("../interceptors/commands/codegenInterceptors");
+const copyFiles_1 = require("./copyFiles");
+/** Run all code generation steps in sequence */
+async function codegen() {
+    // Copy files from packages to project
+    console.log('🔄 Copying files from packages to project...');
+    await (0, copyFiles_1.copyFiles)();
+    // Generate GraphCommerce config types
+    console.log('⚙️  Generating GraphCommerce config types...');
+    await (0, generateConfig_1.generateConfig)();
+    // Generate interceptors
+    console.log('🔌 Generating interceptors...');
+    await (0, codegenInterceptors_1.codegenInterceptors)();
+}