Skip to content

Add additional typescript types to useFragment codegen #10278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add additional typescript types to useFragment codegen #10278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
243cc83
Add additional typescript types to useFragment codegen
igolka97 Feb 4, 2025
b76f371
generated examples and tests
igolka97 Feb 17, 2025
ae08c0c
Add changeset
igolka97 Feb 17, 2025
48695ff
Fix client-preset.spec.ts tests
igolka97 Feb 17, 2025
aef8705
Merge branch 'master' into master
igolka97 Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gentle-suits-provide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@graphql-codegen/client-preset': patch
---

Add additional types to useFragment codegen for support array of nullable gql types
26 changes: 23 additions & 3 deletions dev-test/gql-tag-operations-masking/gql/fragment-masking.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
): Array<TType> | null | undefined;
// return nullable array of non-nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>> | null> | undefined
): Array<TType | null> | undefined;
// return nullable array of nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>> | null> | null | undefined
): Array<TType | null> | null | undefined;
// return readonly array of non-nullable if `fragmentType` is array of non-nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
Expand All @@ -52,15 +62,25 @@ export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
): ReadonlyArray<TType> | null | undefined;
// return nullable readonly array of non-nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null> | undefined
): ReadonlyArray<TType | null> | undefined;
// return nullable readonly array of nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null> | null | undefined
): ReadonlyArray<TType | null> | null | undefined;
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType:
| FragmentType<DocumentTypeDecoration<TType, any>>
| Array<FragmentType<DocumentTypeDecoration<TType, any>>>
| ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>
| Array<FragmentType<DocumentTypeDecoration<TType, any>> | null>
| ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null>
| null
| undefined
): TType | Array<TType> | ReadonlyArray<TType> | null | undefined {
): TType | Array<TType | null> | ReadonlyArray<TType | null> | null | undefined {
return fragmentType as any;
}

Expand Down
26 changes: 23 additions & 3 deletions dev-test/gql-tag-operations-urql/gql/fragment-masking.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
): Array<TType> | null | undefined;
// return nullable array of non-nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>> | null> | undefined
): Array<TType | null> | undefined;
// return nullable array of nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>> | null> | null | undefined
): Array<TType | null> | null | undefined;
// return readonly array of non-nullable if `fragmentType` is array of non-nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
Expand All @@ -52,15 +62,25 @@ export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
): ReadonlyArray<TType> | null | undefined;
// return nullable readonly array of non-nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null> | undefined
): ReadonlyArray<TType | null> | undefined;
// return nullable readonly array of nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null> | null | undefined
): ReadonlyArray<TType | null> | null | undefined;
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType:
| FragmentType<DocumentTypeDecoration<TType, any>>
| Array<FragmentType<DocumentTypeDecoration<TType, any>>>
| ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>
| Array<FragmentType<DocumentTypeDecoration<TType, any>> | null>
| ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null>
| null
| undefined
): TType | Array<TType> | ReadonlyArray<TType> | null | undefined {
): TType | Array<TType | null> | ReadonlyArray<TType | null> | null | undefined {
return fragmentType as any;
}

Expand Down
26 changes: 23 additions & 3 deletions dev-test/gql-tag-operations/gql/fragment-masking.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
): Array<TType> | null | undefined;
// return nullable array of non-nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>> | null> | undefined
): Array<TType | null> | undefined;
// return nullable array of nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>> | null> | null | undefined
): Array<TType | null> | null | undefined;
// return readonly array of non-nullable if `fragmentType` is array of non-nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
Expand All @@ -52,15 +62,25 @@ export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
): ReadonlyArray<TType> | null | undefined;
// return nullable readonly array of non-nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null> | undefined
): ReadonlyArray<TType | null> | undefined;
// return nullable readonly array of nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null> | null | undefined
): ReadonlyArray<TType | null> | null | undefined;
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType:
| FragmentType<DocumentTypeDecoration<TType, any>>
| Array<FragmentType<DocumentTypeDecoration<TType, any>>>
| ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>
| Array<FragmentType<DocumentTypeDecoration<TType, any>> | null>
| ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null>
| null
| undefined
): TType | Array<TType> | ReadonlyArray<TType> | null | undefined {
): TType | Array<TType | null> | ReadonlyArray<TType | null> | null | undefined {
return fragmentType as any;
}

Expand Down
26 changes: 23 additions & 3 deletions dev-test/gql-tag-operations/graphql/fragment-masking.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
): Array<TType> | null | undefined;
// return nullable array of non-nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>> | null> | undefined
): Array<TType | null> | undefined;
// return nullable array of nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>> | null> | null | undefined
): Array<TType | null> | null | undefined;
// return readonly array of non-nullable if `fragmentType` is array of non-nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
Expand All @@ -52,15 +62,25 @@ export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
): ReadonlyArray<TType> | null | undefined;
// return nullable readonly array of non-nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null> | undefined
): ReadonlyArray<TType | null> | undefined;
// return nullable readonly array of nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null> | null | undefined
): ReadonlyArray<TType | null> | null | undefined;
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType:
| FragmentType<DocumentTypeDecoration<TType, any>>
| Array<FragmentType<DocumentTypeDecoration<TType, any>>>
| ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>
| Array<FragmentType<DocumentTypeDecoration<TType, any>> | null>
| ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null>
| null
| undefined
): TType | Array<TType> | ReadonlyArray<TType> | null | undefined {
): TType | Array<TType | null> | ReadonlyArray<TType | null> | null | undefined {
return fragmentType as any;
}

Expand Down
26 changes: 23 additions & 3 deletions examples/persisted-documents-string-mode/src/gql/fragment-masking.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,16 @@ export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
): Array<TType> | null | undefined;
// return nullable array of non-nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>> | null> | undefined
): Array<TType | null> | undefined;
// return nullable array of nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>> | null> | null | undefined
): Array<TType | null> | null | undefined;
// return readonly array of non-nullable if `fragmentType` is array of non-nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
Expand All @@ -51,15 +61,25 @@ export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
): ReadonlyArray<TType> | null | undefined;
// return nullable readonly array of non-nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null> | undefined
): ReadonlyArray<TType | null> | undefined;
// return nullable readonly array of nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null> | null | undefined
): ReadonlyArray<TType | null> | null | undefined;
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType:
| FragmentType<DocumentTypeDecoration<TType, any>>
| Array<FragmentType<DocumentTypeDecoration<TType, any>>>
| ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>
| Array<FragmentType<DocumentTypeDecoration<TType, any>> | null>
| ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null>
| null
| undefined
): TType | Array<TType> | ReadonlyArray<TType> | null | undefined {
): TType | Array<TType | null> | ReadonlyArray<TType | null> | null | undefined {
return fragmentType as any;
}

Expand Down
26 changes: 23 additions & 3 deletions examples/persisted-documents/src/gql/fragment-masking.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
): Array<TType> | null | undefined;
// return nullable array of non-nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>> | null> | undefined
): Array<TType | null> | undefined;
// return nullable array of nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>> | null> | null | undefined
): Array<TType | null> | null | undefined;
// return readonly array of non-nullable if `fragmentType` is array of non-nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
Expand All @@ -52,15 +62,25 @@ export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
): ReadonlyArray<TType> | null | undefined;
// return nullable readonly array of non-nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null> | undefined
): ReadonlyArray<TType | null> | undefined;
// return nullable readonly array of nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null> | null | undefined
): ReadonlyArray<TType | null> | null | undefined;
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType:
| FragmentType<DocumentTypeDecoration<TType, any>>
| Array<FragmentType<DocumentTypeDecoration<TType, any>>>
| ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>
| Array<FragmentType<DocumentTypeDecoration<TType, any>> | null>
| ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null>
| null
| undefined
): TType | Array<TType> | ReadonlyArray<TType> | null | undefined {
): TType | Array<TType | null> | ReadonlyArray<TType | null> | null | undefined {
return fragmentType as any;
}

Expand Down
26 changes: 23 additions & 3 deletions examples/react/apollo-client-defer/src/gql/fragment-masking.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
): Array<TType> | null | undefined;
// return nullable array of non-nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>> | null> | undefined
): Array<TType | null> | undefined;
// return nullable array of nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>> | null> | null | undefined
): Array<TType | null> | null | undefined;
// return readonly array of non-nullable if `fragmentType` is array of non-nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
Expand All @@ -52,15 +62,25 @@ export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
): ReadonlyArray<TType> | null | undefined;
// return nullable readonly array of non-nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null> | undefined
): ReadonlyArray<TType | null> | undefined;
// return nullable readonly array of nullable if `fragmentType` is nullable array of nullable
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null> | null | undefined
): ReadonlyArray<TType | null> | null | undefined;
export function useFragment<TType>(
_documentNode: DocumentTypeDecoration<TType, any>,
fragmentType:
| FragmentType<DocumentTypeDecoration<TType, any>>
| Array<FragmentType<DocumentTypeDecoration<TType, any>>>
| ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>
| Array<FragmentType<DocumentTypeDecoration<TType, any>> | null>
| ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>> | null>
| null
| undefined
): TType | Array<TType> | ReadonlyArray<TType> | null | undefined {
): TType | Array<TType | null> | ReadonlyArray<TType | null> | null | undefined {
return fragmentType as any;
}

Expand Down
Loading
Loading