Skip to content
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.

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

Colocate and flatten hook types #12465

Merged
merged 125 commits into from
Mar 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
125 commits
Select commit Hold shift + click to select a range
708277a
Inline QueryResult in useQuery and rename to UseQueryResult
jerelmiller Mar 20, 2025
382fe2a
Export UseQueryResult from useQuery
jerelmiller Mar 20, 2025
3f4d46d
Add accidentally deleted networkStatus
jerelmiller Mar 20, 2025
3ca5eb1
Update toEqualQueryResult matcher
jerelmiller Mar 20, 2025
f8f76d3
Update type name in useQuery tests
jerelmiller Mar 20, 2025
71b7f93
Use UseQueryResult type in useMutation tests
jerelmiller Mar 20, 2025
d2605c2
Remove children property from QueryDataOptions
jerelmiller Mar 20, 2025
381268b
Update matcher types to use UseQueryResult
jerelmiller Mar 20, 2025
fd28524
Update MockedProvider tests to use UseQueryResult type
jerelmiller Mar 20, 2025
e938ff3
Remove QueryResult type
jerelmiller Mar 20, 2025
664e8ef
Inline useQuery options type and rename to UseQueryOptions
jerelmiller Mar 20, 2025
6188ca7
Export UseQueryOptions
jerelmiller Mar 20, 2025
ebeaff0
Remove unused import
jerelmiller Mar 20, 2025
60e8f3f
Use QueryFunctionOptions in background query types
jerelmiller Mar 20, 2025
9dcc828
Remove QueryHookOptions
jerelmiller Mar 20, 2025
1420e06
Add doc blocks for useSuspenseQuery result
jerelmiller Mar 20, 2025
645f7b5
Inline useSuspenseQuery options type and rename to UseSuspenseQueryOp…
jerelmiller Mar 20, 2025
37ada44
Export UseSuspenseQueryOptions
jerelmiller Mar 20, 2025
5dccf56
Remove SuspenseQueryHookOptions type
jerelmiller Mar 20, 2025
5e168ac
Inline SuspenseHookFetchPolicy and rename to UseSuspenseQueryFetchPolicy
jerelmiller Mar 20, 2025
bc17bb5
Use UseSuspenseQueryFetchPoilcy in useSuspenseQuery tests
jerelmiller Mar 20, 2025
907dd93
Use BackgroundQueryHookFetchPolicy in useBackgroundQuery types
jerelmiller Mar 20, 2025
27d420c
Remove the TData generic from UseSuspenseQueryOptions
jerelmiller Mar 20, 2025
3b09efc
Remove SuspenseQueryHookFetchPolicy
jerelmiller Mar 20, 2025
8f989f7
Inline useBackgroundQuery options type and rename to UseBackgroundQue…
jerelmiller Mar 20, 2025
f1369bd
Inline BackgroundQueryHookFetchPolicy and rename
jerelmiller Mar 20, 2025
18a8bef
Use updated fetch policy type in useBackgroundQuery tests
jerelmiller Mar 20, 2025
5d447a0
Remove old useBackgroundQuery types
jerelmiller Mar 20, 2025
ac0705d
Remove TData generic on UseBackgroundQueryOptions
jerelmiller Mar 20, 2025
84ee011
Remove the no infer type
jerelmiller Mar 20, 2025
c54a7dc
Inline useLoadableQuery options type and rename
jerelmiller Mar 20, 2025
2f66352
Remove old useLoadableQuery options type
jerelmiller Mar 20, 2025
2673bf8
Inline useLoadableQuery fetch policy type and rename
jerelmiller Mar 20, 2025
3807f4d
Use UseLoadableQueryFetchPolicy in useLoadableQuery tests
jerelmiller Mar 20, 2025
17f3adb
Remove old LoadableQueryFetchPolicy
jerelmiller Mar 20, 2025
8427f0e
Inline MutationTuple and rename
jerelmiller Mar 20, 2025
fac3b68
Use new tuple type in useMutation tests
jerelmiller Mar 20, 2025
2264437
Remove old MutationTuple type
jerelmiller Mar 20, 2025
0a069cf
Inline useMutation options type and rename
jerelmiller Mar 20, 2025
a53678f
Remove old MutationHookOptions type
jerelmiller Mar 20, 2025
e2d5953
Remove unused MutationDataOptions type
jerelmiller Mar 20, 2025
8f88188
Remove unused imports
jerelmiller Mar 20, 2025
9ac5ad3
Remove unused MutationFunction type
jerelmiller Mar 20, 2025
47c78f8
Inline MutationFunctionOptions
jerelmiller Mar 20, 2025
af18e62
Inline mutation result and rename
jerelmiller Mar 20, 2025
a0b1c64
Remove unused RefetchQueriesFunction type
jerelmiller Mar 20, 2025
5d8d537
Inline BaseMutationOptions
jerelmiller Mar 20, 2025
47a315a
Remove BaseMutationOptions in favor of UseMutationOptions
jerelmiller Mar 20, 2025
ad779c6
Add todo comment
jerelmiller Mar 20, 2025
1c7eaac
Remove unused imports
jerelmiller Mar 20, 2025
8725287
Inline and flatten QueryDataOptions type
jerelmiller Mar 20, 2025
984f953
Don't export QueryDataOptions
jerelmiller Mar 20, 2025
5b6f691
Simplify types in RenderPromises
jerelmiller Mar 20, 2025
8fe36bf
Remove more unused types in react types
jerelmiller Mar 20, 2025
7adb1c3
Flatten WatchQueryOptions and remove SharedWatchQueryOptions
jerelmiller Mar 20, 2025
343a988
Rename useLazyQuery types to match other hooks
jerelmiller Mar 20, 2025
f728d0b
Stop using ObservableQueryFields type in useLazyQuery
jerelmiller Mar 20, 2025
479f4ff
Stop using ObservableQueryFields in useQuery
jerelmiller Mar 20, 2025
95a292a
Stop using ObservableQueryFields in useSuspenseQuery
jerelmiller Mar 20, 2025
018c03f
Minor formatting
jerelmiller Mar 20, 2025
318284b
Add back Extract on hook fetch policy types
jerelmiller Mar 20, 2025
eed70b1
Add missing docblocks in useBackgroundQuery options
jerelmiller Mar 20, 2025
4786f88
Remove ObservableQueryFields type
jerelmiller Mar 20, 2025
3311498
Remove unused imports
jerelmiller Mar 20, 2025
74457c1
Move export of query ref types to react index file
jerelmiller Mar 20, 2025
7ebd9b7
Inline useSubscription options type and rename
jerelmiller Mar 20, 2025
a34908c
Use new type for callback
jerelmiller Mar 20, 2025
b30b6c4
Use new options type in useSubscription tests
jerelmiller Mar 20, 2025
4103e89
Inline useSubscription result type and rename
jerelmiller Mar 20, 2025
5b2a38b
Inline OnDataOptions and OnSubscriptionDataOptions
jerelmiller Mar 20, 2025
acf31e7
Remove unused subscription types
jerelmiller Mar 20, 2025
f433fd9
Don't export NoInfer from react types
jerelmiller Mar 20, 2025
82b074a
Don't export DefaultContext from react types
jerelmiller Mar 20, 2025
a795678
Stop export * in react/hooks
jerelmiller Mar 20, 2025
3cc8eb3
Flatten UseFragmentOptions type
jerelmiller Mar 20, 2025
83980a4
Don't export react types file
jerelmiller Mar 20, 2025
af4b85b
Mark VariablesOption as internal
jerelmiller Mar 20, 2025
b88fb94
Fix VariablesOption import paths
jerelmiller Mar 20, 2025
808face
Update api report
jerelmiller Mar 20, 2025
55c5703
Move VariableOptions to react/internal entrypoint
jerelmiller Mar 20, 2025
45aab60
Don't mark VariablesOption as internal
jerelmiller Mar 20, 2025
e067807
Rerun api report
jerelmiller Mar 20, 2025
6ff5f24
Add changeset
jerelmiller Mar 20, 2025
8a31014
Small update to changeset
jerelmiller Mar 20, 2025
101267a
Move RefetchFunction and FetchMoreFunction type over to react/internal
jerelmiller Mar 20, 2025
1102881
Rerun api report
jerelmiller Mar 20, 2025
208522c
Convert UseQueryResult and UseQueryOptions into useQuery namespace
jerelmiller Mar 20, 2025
1b0ec1e
Add back old useQuery types as deprecated
jerelmiller Mar 20, 2025
25c01f7
Formatting
jerelmiller Mar 20, 2025
c86c239
Convert useLazyQuery types to a namespace
jerelmiller Mar 20, 2025
cb3b829
Add deprecated useLazyQuery types
jerelmiller Mar 20, 2025
76f4cb4
Convert useMutation types into namespace
jerelmiller Mar 20, 2025
4f89754
Add deprecated useMutation types
jerelmiller Mar 20, 2025
0f24765
Convert useSubscription types to namespace
jerelmiller Mar 20, 2025
2d02394
Add deprecated useSubscription types
jerelmiller Mar 20, 2025
762a032
Convert useFragment types to namespace
jerelmiller Mar 20, 2025
0f56e08
Add deprecated useFragment types
jerelmiller Mar 20, 2025
e098d57
Remove accidentally added returnPartialData option
jerelmiller Mar 20, 2025
187b487
Ensure useFragment variables aren't inferred from variables option
jerelmiller Mar 20, 2025
363182e
Fix type in useFragment test
jerelmiller Mar 20, 2025
19b7d0b
Convert useSuspenseQuery types to namespace
jerelmiller Mar 20, 2025
13a45b5
Add deprecated useSuspenseQuery types
jerelmiller Mar 20, 2025
4f796b1
Convert useBackgroundQuery types to namespace
jerelmiller Mar 20, 2025
e4e755f
Add deprecates useBackgroundQuery types
jerelmiller Mar 20, 2025
c61177c
Convert useSuspenseFragment types to namespace
jerelmiller Mar 20, 2025
812c8be
Add deprecated useSuspenseFragment types
jerelmiller Mar 20, 2025
25dbe9a
Convert useLoadableQuery types to namespace
jerelmiller Mar 20, 2025
0ee46d4
Add deprecated useLoadableQuery types
jerelmiller Mar 20, 2025
c1f300f
Convert useQueryRefHandlers types to namespace
jerelmiller Mar 20, 2025
0a35b75
Add deprecated useQueryRefHandlers types
jerelmiller Mar 20, 2025
a9e1fc9
Convert useReadQuery types to namespace
jerelmiller Mar 20, 2025
d2bcec7
Add deprecated useReadQueryResult types
jerelmiller Mar 20, 2025
5f7fb36
Rerun api report
jerelmiller Mar 20, 2025
817a294
Fix updated type in createQueryPreloader tests
jerelmiller Mar 20, 2025
3e2e847
Flatten MutationOptions base types
jerelmiller Mar 20, 2025
9fb96f8
Rerun api report
jerelmiller Mar 20, 2025
182d1a8
Update changeset
jerelmiller Mar 20, 2025
aa5fc71
Add another changeset
jerelmiller Mar 20, 2025
4810ff1
Put back export *
jerelmiller Mar 21, 2025
8bc6dba
Update size limits
jerelmiller Mar 21, 2025
bdb168c
Use defaultValue in doc block
jerelmiller Mar 21, 2025
a804cd6
Remove export * again
jerelmiller Mar 21, 2025
a7d0e0f
Tweak changeset
jerelmiller Mar 24, 2025
20aa031
Use old names for loadable query options
jerelmiller Mar 24, 2025
ba20497
Clean up Prettier, Size-limit, and Api-Extractor
jerelmiller Mar 24, 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
58 changes: 20 additions & 38 deletions .api-reports/api-report-core.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1469,10 +1469,16 @@ type Modifiers<T extends Record<string, any> = Record<string, unknown>> = Partia
}>;

// @public (undocumented)
interface MutationBaseOptions<TData = unknown, TVariables = OperationVariables, TContext = DefaultContext, TCache extends ApolloCache = ApolloCache> {
export type MutationFetchPolicy = Extract<FetchPolicy, "network-only" | "no-cache">;

// @public (undocumented)
export interface MutationOptions<TData = unknown, TVariables = OperationVariables, TContext = DefaultContext, TCache extends ApolloCache = ApolloCache> {
awaitRefetchQueries?: boolean;
context?: TContext;
errorPolicy?: ErrorPolicy;
fetchPolicy?: MutationFetchPolicy;
keepRootFields?: boolean;
mutation: DocumentNode | TypedDocumentNode<TData, TVariables>;
onQueryUpdated?: OnQueryUpdated<any>;
// Warning: (ae-forgotten-export) The symbol "NoInfer_2" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "IgnoreModifier" needs to be exported by the entry point index.d.ts
Expand All @@ -1485,16 +1491,6 @@ interface MutationBaseOptions<TData = unknown, TVariables = OperationVariables,
variables?: TVariables;
}

// @public (undocumented)
export type MutationFetchPolicy = Extract<FetchPolicy, "network-only" | "no-cache">;

// Warning: (ae-forgotten-export) The symbol "MutationSharedOptions" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export interface MutationOptions<TData = unknown, TVariables = OperationVariables, TContext = DefaultContext, TCache extends ApolloCache = ApolloCache> extends MutationSharedOptions<TData, TVariables, TContext, TCache> {
mutation: DocumentNode | TypedDocumentNode<TData, TVariables>;
}

// @public (undocumented)
export type MutationQueryReducer<T> = (previousResult: Record<string, any>, options: {
mutationResult: FetchResult<Unmasked<T>>;
Expand All @@ -1509,14 +1505,6 @@ export type MutationQueryReducersMap<T = {
[queryName: string]: MutationQueryReducer<T>;
};

// Warning: (ae-forgotten-export) The symbol "MutationBaseOptions" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
interface MutationSharedOptions<TData = unknown, TVariables = OperationVariables, TContext = DefaultContext, TCache extends ApolloCache = ApolloCache> extends MutationBaseOptions<TData, TVariables, TContext, TCache> {
fetchPolicy?: MutationFetchPolicy;
keepRootFields?: boolean;
}

// @public (undocumented)
interface MutationStoreValue {
// (undocumented)
Expand Down Expand Up @@ -2193,22 +2181,6 @@ interface ServerParseErrorOptions {
// @public (undocumented)
export function setLogVerbosity(level: VerbosityLevel): VerbosityLevel;

// @public (undocumented)
interface SharedWatchQueryOptions<TVariables extends OperationVariables, TData> {
context?: DefaultContext;
errorPolicy?: ErrorPolicy;
fetchPolicy?: WatchQueryFetchPolicy;
initialFetchPolicy?: WatchQueryFetchPolicy;
// Warning: (ae-forgotten-export) The symbol "NextFetchPolicyContext" needs to be exported by the entry point index.d.ts
nextFetchPolicy?: WatchQueryFetchPolicy | ((this: WatchQueryOptions<TVariables, TData>, currentFetchPolicy: WatchQueryFetchPolicy, context: NextFetchPolicyContext<TData, TVariables>) => WatchQueryFetchPolicy);
notifyOnNetworkStatusChange?: boolean;
pollInterval?: number;
refetchWritePolicy?: RefetchWritePolicy;
returnPartialData?: boolean;
skipPollAttempt?: () => boolean;
variables?: TVariables;
}

// @public (undocumented)
export interface SingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> {
// (undocumented)
Expand Down Expand Up @@ -2433,11 +2405,21 @@ export type WatchFragmentResult<TData> = {
// @public (undocumented)
export type WatchQueryFetchPolicy = FetchPolicy | "cache-and-network";

// Warning: (ae-forgotten-export) The symbol "SharedWatchQueryOptions" needs to be exported by the entry point index.d.ts
//
// @public
export interface WatchQueryOptions<TVariables extends OperationVariables = OperationVariables, TData = unknown> extends SharedWatchQueryOptions<TVariables, TData> {
export interface WatchQueryOptions<TVariables extends OperationVariables = OperationVariables, TData = unknown> {
context?: DefaultContext;
errorPolicy?: ErrorPolicy;
fetchPolicy?: WatchQueryFetchPolicy;
initialFetchPolicy?: WatchQueryFetchPolicy;
// Warning: (ae-forgotten-export) The symbol "NextFetchPolicyContext" needs to be exported by the entry point index.d.ts
nextFetchPolicy?: WatchQueryFetchPolicy | ((this: WatchQueryOptions<TVariables, TData>, currentFetchPolicy: WatchQueryFetchPolicy, context: NextFetchPolicyContext<TData, TVariables>) => WatchQueryFetchPolicy);
notifyOnNetworkStatusChange?: boolean;
pollInterval?: number;
query: DocumentNode | TypedDocumentNode<TData, TVariables>;
refetchWritePolicy?: RefetchWritePolicy;
returnPartialData?: boolean;
skipPollAttempt?: () => boolean;
variables?: TVariables;
}

// @public (undocumented)
Expand Down
Loading