feat(graphcache): make offline exchange optional (#476)

JoviDeCroock · web-flow · commit 9bdae5d75e6e · 2024-01-03T12:07:43.000-06:00
* make offline exchange optional

* update tests

* switch to proper import

* update assertions

* fix
diff --git a/.changeset/fresh-cooks-learn.md b/.changeset/fresh-cooks-learn.md
@@ -0,0 +1,6 @@
+---
+'@graphql-codegen/typescript-urql-graphcache': minor
+---
+
+Add setting to choose for the offlineExchange, otherwise this bugs out the types for folks not using
+the offlineExchange
diff --git a/dev-test/githunt/types.urql.tsx b/dev-test/githunt/types.urql.tsx
@@ -1,7 +1,7 @@
 import { IntrospectionQuery } from 'graphql';
 import gql from 'graphql-tag';
 import * as Urql from 'urql';
-import { offlineExchange } from '@urql/exchange-graphcache';
+import { cacheExchange } from '@urql/exchange-graphcache';
 import {
   OptimisticMutationResolver as GraphCacheOptimisticMutationResolver,
   Resolver as GraphCacheResolver,
@@ -1293,7 +1293,7 @@ export type GraphCacheUpdaters = {
   };
 };
 
-export type GraphCacheConfig = Parameters<typeof offlineExchange>[0] & {
+export type GraphCacheConfig = Parameters<typeof cacheExchange>[0] & {
   updates?: GraphCacheUpdaters;
   keys?: GraphCacheKeysConfig;
   optimistic?: GraphCacheOptimisticUpdaters;
diff --git a/packages/plugins/typescript/urql-graphcache/src/config.ts b/packages/plugins/typescript/urql-graphcache/src/config.ts
@@ -3,4 +3,6 @@ import { RawClientSideBasePluginConfig } from '@graphql-codegen/visitor-plugin-c
 /**
  * @description This plugin generates a generic for the `@urql/exchange-graphcache` (https://github.com/FormidableLabs/urql/exchanges/graphcache) config.
  */
-export type UrqlGraphCacheConfig = RawClientSideBasePluginConfig & {};
+export type UrqlGraphCacheConfig = RawClientSideBasePluginConfig & {
+  offlineExchange?: boolean;
+};
diff --git a/packages/plugins/typescript/urql-graphcache/src/index.ts b/packages/plugins/typescript/urql-graphcache/src/index.ts
@@ -277,7 +277,9 @@ function getOptimisticUpdatersConfig(
 
 function getImports(config: UrqlGraphCacheConfig): string {
   return [
-    "import { offlineExchange } from '@urql/exchange-graphcache';",
+    `import { ${
+      config.offlineExchange ? 'offlineExchange' : 'cacheExchange'
+    } } from '@urql/exchange-graphcache';`,
     `${
       config.useTypeImports ? 'import type' : 'import'
     } { Resolver as GraphCacheResolver, UpdateResolver as GraphCacheUpdateResolver, OptimisticMutationResolver as GraphCacheOptimisticMutationResolver } from '@urql/exchange-graphcache';\n`,
@@ -325,7 +327,9 @@ export const plugin: PluginFunction<UrqlGraphCacheConfig, Types.ComplexPluginOut
         `${typeUpdateResolvers.join(',\n')}` +
         ',\n};',
 
-      'export type GraphCacheConfig = Parameters<typeof offlineExchange>[0] & {\n' +
+      `export type GraphCacheConfig = Parameters<typeof ${
+        config.offlineExchange ? 'offlineExchange' : 'cacheExchange'
+      }>[0] & {\n` +
         '  updates?: GraphCacheUpdaters,\n' +
         '  keys?: GraphCacheKeysConfig,\n' +
         '  optimistic?: GraphCacheOptimisticUpdaters,\n' +
diff --git a/packages/plugins/typescript/urql-graphcache/tests/__snapshots__/urql.spec.ts.snap b/packages/plugins/typescript/urql-graphcache/tests/__snapshots__/urql.spec.ts.snap
@@ -1,7 +1,7 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`urql graphcache Should correctly name GraphCacheResolvers & GraphCacheOptimisticUpdaters with nonstandard mutationType names 1`] = `
-"import { offlineExchange } from '@urql/exchange-graphcache';
+"import { cacheExchange } from '@urql/exchange-graphcache';
 import { Resolver as GraphCacheResolver, UpdateResolver as GraphCacheUpdateResolver, OptimisticMutationResolver as GraphCacheOptimisticMutationResolver } from '@urql/exchange-graphcache';
 
 export type WithTypename<T extends { __typename?: any }> = Partial<T> & { __typename: NonNullable<T['__typename']> };
@@ -40,7 +40,7 @@ export type GraphCacheUpdaters = {
   },
 };
 
-export type GraphCacheConfig = Parameters<typeof offlineExchange>[0] & {
+export type GraphCacheConfig = Parameters<typeof cacheExchange>[0] & {
   updates?: GraphCacheUpdaters,
   keys?: GraphCacheKeysConfig,
   optimistic?: GraphCacheOptimisticUpdaters,
@@ -49,7 +49,7 @@ export type GraphCacheConfig = Parameters<typeof offlineExchange>[0] & {
 `;
 
 exports[`urql graphcache Should correctly output GraphCacheOptimisticUpdaters when there are no mutations 1`] = `
-"import { offlineExchange } from '@urql/exchange-graphcache';
+"import { cacheExchange } from '@urql/exchange-graphcache';
 import { Resolver as GraphCacheResolver, UpdateResolver as GraphCacheUpdateResolver, OptimisticMutationResolver as GraphCacheOptimisticMutationResolver } from '@urql/exchange-graphcache';
 
 export type WithTypename<T extends { __typename?: any }> = Partial<T> & { __typename: NonNullable<T['__typename']> };
@@ -84,7 +84,7 @@ export type GraphCacheUpdaters = {
   },
 };
 
-export type GraphCacheConfig = Parameters<typeof offlineExchange>[0] & {
+export type GraphCacheConfig = Parameters<typeof cacheExchange>[0] & {
   updates?: GraphCacheUpdaters,
   keys?: GraphCacheKeysConfig,
   optimistic?: GraphCacheOptimisticUpdaters,
@@ -93,7 +93,7 @@ export type GraphCacheConfig = Parameters<typeof offlineExchange>[0] & {
 `;
 
 exports[`urql graphcache Should output the cache-generic correctly (with interfaces) 1`] = `
-"import { offlineExchange } from '@urql/exchange-graphcache';
+"import { cacheExchange } from '@urql/exchange-graphcache';
 import { Resolver as GraphCacheResolver, UpdateResolver as GraphCacheUpdateResolver, OptimisticMutationResolver as GraphCacheOptimisticMutationResolver } from '@urql/exchange-graphcache';
 
 export type WithTypename<T extends { __typename?: any }> = Partial<T> & { __typename: NonNullable<T['__typename']> };
@@ -156,7 +156,7 @@ export type GraphCacheUpdaters = {
   },
 };
 
-export type GraphCacheConfig = Parameters<typeof offlineExchange>[0] & {
+export type GraphCacheConfig = Parameters<typeof cacheExchange>[0] & {
   updates?: GraphCacheUpdaters,
   keys?: GraphCacheKeysConfig,
   optimistic?: GraphCacheOptimisticUpdaters,
@@ -165,7 +165,7 @@ export type GraphCacheConfig = Parameters<typeof offlineExchange>[0] & {
 `;
 
 exports[`urql graphcache Should output the cache-generic correctly (with typesPrefix and typesSuffix) 1`] = `
-"import { offlineExchange } from '@urql/exchange-graphcache';
+"import { cacheExchange } from '@urql/exchange-graphcache';
 import { Resolver as GraphCacheResolver, UpdateResolver as GraphCacheUpdateResolver, OptimisticMutationResolver as GraphCacheOptimisticMutationResolver } from '@urql/exchange-graphcache';
 
 export type WithTypename<T extends { __typename?: any }> = Partial<T> & { __typename: NonNullable<T['__typename']> };
@@ -227,7 +227,7 @@ export type GraphCacheUpdaters = {
   },
 };
 
-export type GraphCacheConfig = Parameters<typeof offlineExchange>[0] & {
+export type GraphCacheConfig = Parameters<typeof cacheExchange>[0] & {
   updates?: GraphCacheUpdaters,
   keys?: GraphCacheKeysConfig,
   optimistic?: GraphCacheOptimisticUpdaters,
@@ -236,7 +236,7 @@ export type GraphCacheConfig = Parameters<typeof offlineExchange>[0] & {
 `;
 
 exports[`urql graphcache Should output the cache-generic correctly (with unions) 1`] = `
-"import { offlineExchange } from '@urql/exchange-graphcache';
+"import { cacheExchange } from '@urql/exchange-graphcache';
 import { Resolver as GraphCacheResolver, UpdateResolver as GraphCacheUpdateResolver, OptimisticMutationResolver as GraphCacheOptimisticMutationResolver } from '@urql/exchange-graphcache';
 
 export type WithTypename<T extends { __typename?: any }> = Partial<T> & { __typename: NonNullable<T['__typename']> };
@@ -286,7 +286,7 @@ export type GraphCacheUpdaters = {
   },
 };
 
-export type GraphCacheConfig = Parameters<typeof offlineExchange>[0] & {
+export type GraphCacheConfig = Parameters<typeof cacheExchange>[0] & {
   updates?: GraphCacheUpdaters,
   keys?: GraphCacheKeysConfig,
   optimistic?: GraphCacheOptimisticUpdaters,
@@ -295,7 +295,7 @@ export type GraphCacheConfig = Parameters<typeof offlineExchange>[0] & {
 `;
 
 exports[`urql graphcache Should output the cache-generic correctly 1`] = `
-"import { offlineExchange } from '@urql/exchange-graphcache';
+"import { cacheExchange } from '@urql/exchange-graphcache';
 import { Resolver as GraphCacheResolver, UpdateResolver as GraphCacheUpdateResolver, OptimisticMutationResolver as GraphCacheOptimisticMutationResolver } from '@urql/exchange-graphcache';
 
 export type WithTypename<T extends { __typename?: any }> = Partial<T> & { __typename: NonNullable<T['__typename']> };
@@ -357,7 +357,7 @@ export type GraphCacheUpdaters = {
   },
 };
 
-export type GraphCacheConfig = Parameters<typeof offlineExchange>[0] & {
+export type GraphCacheConfig = Parameters<typeof cacheExchange>[0] & {
   updates?: GraphCacheUpdaters,
   keys?: GraphCacheKeysConfig,
   optimistic?: GraphCacheOptimisticUpdaters,
diff --git a/packages/plugins/typescript/urql-graphcache/tests/urql.spec.ts b/packages/plugins/typescript/urql-graphcache/tests/urql.spec.ts
@@ -166,7 +166,7 @@ describe('urql graphcache', () => {
     const result = mergeOutputs([await plugin(schema, [], { useTypeImports: true })]);
 
     expect(result).toBeSimilarStringTo(`\
-import { offlineExchange } from '@urql/exchange-graphcache';
+import { cacheExchange } from '@urql/exchange-graphcache';
 import type { Resolver as GraphCacheResolver, UpdateResolver as GraphCacheUpdateResolver, OptimisticMutationResolver as GraphCacheOptimisticMutationResolver } from '@urql/exchange-graphcache';
 `);
   });
