Make isFragmentReady function work with enabled noUncheckedIndexedAcc…

…ess tsc setting (#9385) * Make isFragmentReady function work with enabled noUncheckedIndexedAccess tsc setting * Add changeset * Trigger ci * Change function for string mode * Update isFragmentReady in examples
dotansimha · May 12, 2023 · a7dda35 · a7dda35
1 parent 88c4b49
commit a7dda35
Show file tree

Hide file tree

Showing 27 changed files with 44 additions and 41 deletions.
diff --git a/.changeset/four-buckets-carry.md b/.changeset/four-buckets-carry.md
@@ -0,0 +1,5 @@
+---
+'@graphql-codegen/client-preset': patch
+---
+
+Improve isFragmentReady utility function to work with noUncheckedIndexedAccess TSC setting
diff --git a/dev-test/gql-tag-operations-masking/gql/fragment-masking.ts b/dev-test/gql-tag-operations-masking/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/dev-test/gql-tag-operations-urql/gql/fragment-masking.ts b/dev-test/gql-tag-operations-urql/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/dev-test/gql-tag-operations/gql/fragment-masking.ts b/dev-test/gql-tag-operations/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/dev-test/gql-tag-operations/graphql/fragment-masking.ts b/dev-test/gql-tag-operations/graphql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/persisted-documents-string-mode/src/gql/fragment-masking.ts b/examples/persisted-documents-string-mode/src/gql/fragment-masking.ts
@@ -53,11 +53,10 @@ export function isFragmentReady<TQuery, TFrag>(
   data: FragmentType<TypedDocumentString<Incremental<TFrag>, any>> | null | undefined
 ): data is FragmentType<typeof fragmentNode> {
   const deferredFields = queryNode.__meta__?.deferredFields as Record<string, (keyof TFrag)[]>;
+  const fragName = fragmentNode.__meta__?.fragmentName as string | undefined;
 
-  if (!deferredFields) return true;
+  if (!deferredFields || !fragName) return true;
 
-  const fragName = fragmentNode.__meta__?.fragmentName;
-
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = deferredFields[fragName] ?? [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/persisted-documents/src/gql/fragment-masking.ts b/examples/persisted-documents/src/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/programmatic-typescript/src/gql.generated.ts b/examples/programmatic-typescript/src/gql.generated.ts
@@ -5,6 +5,8 @@ export type InputMaybe<T> = Maybe<T>;
 export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
 export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> };
 export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> };
+export type MakeEmpty<T extends { [key: string]: unknown }, K extends keyof T> = { [_ in K]?: never };
+export type Incremental<T> = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
 /** All built-in and custom scalars, mapped to their actual values */
 export type Scalars = {
   ID: string;

diff --git a/examples/react/apollo-client-defer/src/gql/fragment-masking.ts b/examples/react/apollo-client-defer/src/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/react/apollo-client-defer/tsconfig.json b/examples/react/apollo-client-defer/tsconfig.json
@@ -11,7 +11,8 @@
     "esModuleInterop": true,
     "lib": ["ESNext", "DOM"],
     "skipLibCheck": true,
-    "noEmit": true
+    "noEmit": true,
+    "noUncheckedIndexedAccess": true
   },
   "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"],
   "references": [{ "path": "./tsconfig.node.json" }]

diff --git a/examples/react/apollo-client-swc-plugin/src/gql/fragment-masking.ts b/examples/react/apollo-client-swc-plugin/src/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/react/apollo-client/src/gql/fragment-masking.ts b/examples/react/apollo-client/src/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/react/http-executor/src/gql/fragment-masking.ts b/examples/react/http-executor/src/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/react/nextjs-swr/gql/fragment-masking.ts b/examples/react/nextjs-swr/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/react/tanstack-react-query/src/gql/fragment-masking.ts b/examples/react/tanstack-react-query/src/gql/fragment-masking.ts
@@ -53,11 +53,10 @@ export function isFragmentReady<TQuery, TFrag>(
   data: FragmentType<TypedDocumentString<Incremental<TFrag>, any>> | null | undefined
 ): data is FragmentType<typeof fragmentNode> {
   const deferredFields = queryNode.__meta__?.deferredFields as Record<string, (keyof TFrag)[]>;
+  const fragName = fragmentNode.__meta__?.fragmentName as string | undefined;
 
-  if (!deferredFields) return true;
+  if (!deferredFields || !fragName) return true;
 
-  const fragName = fragmentNode.__meta__?.fragmentName;
-
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = deferredFields[fragName] ?? [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/react/urql/src/gql/fragment-masking.ts b/examples/react/urql/src/gql/fragment-masking.ts
@@ -53,11 +53,10 @@ export function isFragmentReady<TQuery, TFrag>(
   data: FragmentType<TypedDocumentString<Incremental<TFrag>, any>> | null | undefined
 ): data is FragmentType<typeof fragmentNode> {
   const deferredFields = queryNode.__meta__?.deferredFields as Record<string, (keyof TFrag)[]>;
+  const fragName = fragmentNode.__meta__?.fragmentName as string | undefined;
 
-  if (!deferredFields) return true;
+  if (!deferredFields || !fragName) return true;
 
-  const fragName = fragmentNode.__meta__?.fragmentName;
-
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = deferredFields[fragName] ?? [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/typescript-esm/src/gql/fragment-masking.ts b/examples/typescript-esm/src/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/typescript-graphql-request/src/gql/fragment-masking.ts b/examples/typescript-graphql-request/src/gql/fragment-masking.ts
@@ -53,11 +53,10 @@ export function isFragmentReady<TQuery, TFrag>(
   data: FragmentType<TypedDocumentString<Incremental<TFrag>, any>> | null | undefined
 ): data is FragmentType<typeof fragmentNode> {
   const deferredFields = queryNode.__meta__?.deferredFields as Record<string, (keyof TFrag)[]>;
+  const fragName = fragmentNode.__meta__?.fragmentName as string | undefined;
 
-  if (!deferredFields) return true;
+  if (!deferredFields || !fragName) return true;
 
-  const fragName = fragmentNode.__meta__?.fragmentName;
-
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = deferredFields[fragName] ?? [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/vite/vite-react-cts/src/gql/fragment-masking.ts b/examples/vite/vite-react-cts/src/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/vite/vite-react-mts/src/gql/fragment-masking.ts b/examples/vite/vite-react-mts/src/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/vite/vite-react-ts/src/gql/fragment-masking.ts b/examples/vite/vite-react-ts/src/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/vue/apollo-composable/src/gql/fragment-masking.ts b/examples/vue/apollo-composable/src/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/vue/urql/src/gql/fragment-masking.ts b/examples/vue/urql/src/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/vue/villus/src/gql/fragment-masking.ts b/examples/vue/villus/src/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/examples/yoga-tests/src/gql/fragment-masking.ts b/examples/yoga-tests/src/gql/fragment-masking.ts
@@ -61,6 +61,6 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
diff --git a/packages/presets/client/src/fragment-masking-plugin.ts b/packages/presets/client/src/fragment-masking-plugin.ts
@@ -81,12 +81,11 @@ export function isFragmentReady<TQuery, TFrag>(
   data: FragmentType<TypedDocumentString<Incremental<TFrag>, any>> | null | undefined
 ): data is FragmentType<typeof fragmentNode> {
   const deferredFields = queryNode.__meta__?.deferredFields as Record<string, (keyof TFrag)[]>;
+  const fragName = fragmentNode.__meta__?.fragmentName as string | undefined;
 
-  if (!deferredFields) return true;
-
-  const fragName = fragmentNode.__meta__?.fragmentName;
+  if (!deferredFields || !fragName) return true;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = deferredFields[fragName] ?? [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
 `;
@@ -105,7 +104,7 @@ export function isFragmentReady<TQuery, TFrag>(
   const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
   const fragName = fragDef?.name?.value;
 
-  const fields = fragName ? deferredFields[fragName] : [];
+  const fields = (fragName && deferredFields[fragName]) || [];
   return fields.length > 0 && fields.every(field => data && field in data);
 }
 `;

diff --git a/packages/presets/client/tests/client-preset.spec.ts b/packages/presets/client/tests/client-preset.spec.ts
@@ -817,7 +817,7 @@ export * from "./gql";`);
           const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
           const fragName = fragDef?.name?.value;
 
-          const fields = fragName ? deferredFields[fragName] : [];
+          const fields = (fragName && deferredFields[fragName]) || [];
           return fields.length > 0 && fields.every(field => data && field in data);
         }
         "