@graphcommerce/graphql 6.1.1-canary.4 → 6.2.0-canary.10

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## 6.2.0-canary.10
+
+## 6.2.0-canary.9
+
+## 6.2.0-canary.8
+
+## 6.2.0-canary.7
+
+## 6.2.0-canary.6
+
+### Patch Changes
+
+- [#1915](https://github.com/graphcommerce-org/graphcommerce/pull/1915) [`f4a8c3881`](https://github.com/graphcommerce-org/graphcommerce/commit/f4a8c388183e17c52e7f66536c5448749f494d7f) - Moved the injection of the links to plugins ([@paales](https://github.com/paales))
+
+## 6.1.1-canary.5
+
 ## 6.1.1-canary.4
 
 ## 6.1.1-canary.3

package/components/{GraphQLProvider.tsx → GraphQLProvider/GraphQLProvider.tsx}

@@ -3,38 +3,25 @@ import {
   NormalizedCacheObject,
   ApolloLink,
   InMemoryCache,
-  TypePolicies,
   ApolloProvider,
   HttpLink,
 } from '@apollo/client'
+import { useStorefrontConfig } from '@graphcommerce/next-ui'
 import type { AppProps } from 'next/app'
-import { useCallback, useEffect, useMemo, useRef, useState } from 'react'
-import { createCacheReviver } from '../createCacheReviver'
-import { errorLink } from '../errorLink'
-import fragments from '../generated/fragments.json'
-import { measurePerformanceLink } from '../measurePerformanceLink'
-import { MigrateCache } from '../migrateCache'
-import { mergeTypePolicies } from '../typePolicies'
+import { useCallback, useEffect, useRef, useState } from 'react'
+import { ApolloClientConfig, graphqlConfig, ApolloClientConfigInput } from '../../config'
+import fragments from '../../generated/fragments.json'
+import { createCacheReviver } from './createCacheReviver'
+import { errorLink } from './errorLink'
+import { measurePerformanceLink } from './measurePerformanceLink'
+import { mergeTypePolicies } from './typePolicies'
 
 export const globalApolloClient: { current: ApolloClient<NormalizedCacheObject> | null } = {
   current: null,
 }
 
-export type GraphQLProviderProps = AppProps & {
-  children: React.ReactNode
-  /** Additional ApolloLink to add to the chain. */
-  links?: ApolloLink[]
-  /**
-   * This is a list of type policies which are used to influence how cache is handled.
-   * https://www.apollographql.com/docs/react/caching/cache-field-behavior/
-   */
-  policies?: TypePolicies[]
-  /**
-   * To upgrade the local storage to a new version when the app is updated, but the client isn't
-   * yet, we run these migrations.
-   */
-  migrations?: MigrateCache[]
-}
+export type GraphQLProviderProps = AppProps &
+  Omit<ApolloClientConfigInput, 'storefront'> & { children: React.ReactNode }
 
 /**
  * The GraphQLProvider allows us to configure the ApolloClient and provide it to the rest of the
@@ -43,19 +30,21 @@ export type GraphQLProviderProps = AppProps & {
  * Take a look at the props to see possible customization options.
  */
 export function GraphQLProvider(props: GraphQLProviderProps) {
-  const { children, policies = [], migrations = [], links = [], pageProps } = props
+  const { children, links, migrations, policies, pageProps } = props
   const state = (pageProps as { apolloState?: NormalizedCacheObject }).apolloState
 
   const stateRef = useRef(state)
 
-  const linksRef = useRef(links)
-  const policiesRef = useRef(policies)
+  const storefront = useStorefrontConfig()
+  const conf = graphqlConfig({ links, migrations, policies, storefront })
+  const config = useRef<ApolloClientConfig>(conf)
+  config.current = conf
 
   const createCache = useCallback(
     () =>
       new InMemoryCache({
         possibleTypes: fragments.possibleTypes,
-        typePolicies: mergeTypePolicies(policiesRef.current),
+        typePolicies: mergeTypePolicies(config.current.policies),
       }),
     [],
   )
@@ -63,7 +52,7 @@ export function GraphQLProvider(props: GraphQLProviderProps) {
   const [client] = useState(() => {
     const link = ApolloLink.from([
       ...(typeof window === 'undefined' ? [errorLink, measurePerformanceLink] : []),
-      ...linksRef.current,
+      ...config.current.links,
       // The actual Http connection to the Mesh backend.
       new HttpLink({ uri: '/api/graphql', credentials: 'same-origin' }),
     ])
@@ -77,8 +66,8 @@ export function GraphQLProvider(props: GraphQLProviderProps) {
 
   useEffect(() => {
     // eslint-disable-next-line @typescript-eslint/no-floating-promises
-    createCacheReviver(client, createCache, policies, migrations, state)
-  }, [client, createCache, migrations, policies, state])
+    createCacheReviver(client, createCache, config.current, state)
+  }, [client, createCache, state])
 
   globalApolloClient.current = client
 

package/{createCacheReviver.ts → components/GraphQLProvider/createCacheReviver.ts}

@@ -1,7 +1,7 @@
 import { LocalStorageWrapper, CachePersistor } from 'apollo3-cache-persist'
-import { mergeDeep, ApolloCache, ApolloClient, NormalizedCacheObject } from './apollo'
-import type { StrictTypedTypePolicies } from './generated/types'
-import { MigrateCache, migrateCacheHandler } from './migrateCache'
+import { mergeDeep, ApolloCache, ApolloClient, NormalizedCacheObject } from '../../apollo'
+import { ApolloClientConfig } from '../../config'
+import { migrateCacheHandler } from './migrateCache'
 import { getTypePoliciesVersion } from './typePolicies'
 
 const APOLLO_CACHE_PERSIST = 'apollo-cache-persist'
@@ -13,12 +13,11 @@ let persistor: CachePersistor<NormalizedCacheObject> | null = null
 export async function createCacheReviver(
   client: ApolloClient<NormalizedCacheObject>,
   createCache: () => ApolloCache<NormalizedCacheObject>,
-  policies: StrictTypedTypePolicies[],
-  migrations: MigrateCache[],
+  config: ApolloClientConfig,
   incomingState: NormalizedCacheObject = {},
 ) {
   let state = incomingState
-  const typePoliciesVersion = getTypePoliciesVersion(policies)
+  const typePoliciesVersion = getTypePoliciesVersion(config.policies)
 
   if (typeof window !== 'undefined') {
     try {
@@ -57,7 +56,7 @@ export async function createCacheReviver(
           oldCache.restore(JSON.parse(storedState) as NormalizedCacheObject)
 
           // Run the migration
-          migrateCacheHandler(oldCache, cache, migrations)
+          migrateCacheHandler(oldCache, cache, config.migrations)
 
           state = mergeDeep(cache.extract(), incomingState)
           console.info('migration complete')

package/components/GraphQLProvider/index.ts

@@ -0,0 +1,6 @@
+export * from './createCacheReviver'
+export * from './errorLink'
+export * from './GraphQLProvider'
+export * from './measurePerformanceLink'
+export * from './migrateCache'
+export * from './typePolicies'

package/{measurePerformanceLink.ts → components/GraphQLProvider/measurePerformanceLink.ts}

@@ -2,7 +2,7 @@
 import { ApolloLink } from '@apollo/client'
 import type { MeshFetchHTTPInformation } from '@graphql-mesh/plugin-http-details-extensions'
 import { print } from 'graphql'
-import { cliHyperlink } from './lib/hyperlinker'
+import { cliHyperlink } from '../../lib/hyperlinker'
 
 const running = new Map<
   string,

package/{migrateCache.ts → components/GraphQLProvider/migrateCache.ts}

@@ -1,4 +1,4 @@
-import { ApolloCache, NormalizedCacheObject } from './apollo'
+import { ApolloCache, NormalizedCacheObject } from '../../apollo'
 
 export type MigrateCache = (
   oldCache: ApolloCache<NormalizedCacheObject>,

package/{typePolicies.ts → components/GraphQLProvider/typePolicies.ts}

@@ -1,5 +1,5 @@
 import type { StrictTypedTypePolicies } from '@graphcommerce/graphql'
-import { mergeDeep } from './apollo'
+import { mergeDeep } from '../../apollo'
 
 export const mergeTypePolicies = (policies: StrictTypedTypePolicies[]): StrictTypedTypePolicies =>
   mergeDeep(...policies)

package/config.ts

@@ -0,0 +1,27 @@
+import { ApolloLink, TypePolicies } from '@apollo/client'
+import type { GraphCommerceStorefrontConfig } from '@graphcommerce/next-config'
+import { MigrateCache } from './components/GraphQLProvider/migrateCache'
+
+export type ApolloClientConfigInput = {
+  storefront: GraphCommerceStorefrontConfig
+
+  /** Additional ApolloLink to add to the chain. */
+  links?: ApolloLink[]
+  /**
+   * This is a list of type policies which are used to influence how cache is handled.
+   * https://www.apollographql.com/docs/react/caching/cache-field-behavior/
+   */
+  policies?: TypePolicies[]
+  /**
+   * To upgrade the local storage to a new version when the app is updated, but the client isn't
+   * yet, we run these migrations.
+   */
+  migrations?: MigrateCache[]
+}
+
+export type ApolloClientConfig = Required<ApolloClientConfigInput>
+
+export function graphqlConfig(config: ApolloClientConfigInput): ApolloClientConfig {
+  const { storefront, links = [], policies = [], migrations = [] } = config
+  return { storefront, links, policies, migrations }
+}

package/index.ts

@@ -1,13 +1,5 @@
-export * from './generated/types'
-
-export * from './measurePerformanceLink'
-export * from './errorLink'
-
-export { default as fragments } from './generated/fragments.json'
-
-export * from './migrateCache'
-export * from './typePolicies'
-export * from './createCacheReviver'
-
 export * from './apollo'
 export * from './components/GraphQLProvider'
+export { default as fragments } from './generated/fragments.json'
+export * from './generated/types'
+export * from './config'

package/lib/hyperlinker.ts

@@ -1,5 +1,3 @@
-'use strict'
-
 /*
 A hyperlink is opened upon encountering an OSC 8 escape sequence with the target URI. The syntax is
 OSC 8 ; params ; URI BEL|ST

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/graphql",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "6.1.1-canary.4",
+  "version": "6.2.0-canary.10",
   "sideEffects": false,
   "main": "index.ts",
   "prettier": "@graphcommerce/prettier-config-pwa",
@@ -14,8 +14,8 @@
   },
   "dependencies": {
     "@apollo/client": "^3.7.10",
-    "@graphcommerce/graphql-codegen-near-operation-file": "6.1.1-canary.4",
-    "@graphcommerce/graphql-codegen-relay-optimizer-plugin": "6.1.1-canary.4",
+    "@graphcommerce/graphql-codegen-near-operation-file": "6.2.0-canary.10",
+    "@graphcommerce/graphql-codegen-relay-optimizer-plugin": "6.2.0-canary.10",
     "@graphql-codegen/add": "4.0.1",
     "@graphql-codegen/fragment-matcher": "4.0.1",
     "@graphql-codegen/introspection": "3.0.1",
@@ -29,9 +29,9 @@
     "graphql": "16.6.0"
   },
   "devDependencies": {
-    "@graphcommerce/eslint-config-pwa": "6.1.1-canary.4",
-    "@graphcommerce/prettier-config-pwa": "6.1.1-canary.4",
-    "@graphcommerce/typescript-config-pwa": "6.1.1-canary.4"
+    "@graphcommerce/eslint-config-pwa": "6.2.0-canary.10",
+    "@graphcommerce/prettier-config-pwa": "6.2.0-canary.10",
+    "@graphcommerce/typescript-config-pwa": "6.2.0-canary.10"
   },
   "peerDependencies": {
     "react": "^18.2.0",