@apollo/client 4.0.0-rc.0 → 4.0.0-rc.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +394 -0
- package/README.md +40 -40
- package/__cjs/cache/core/cache.cjs +16 -19
- package/__cjs/cache/core/cache.cjs.map +1 -1
- package/__cjs/cache/core/cache.d.cts +108 -73
- package/__cjs/cache/core/types/Cache.cjs +0 -4
- package/__cjs/cache/core/types/Cache.cjs.map +1 -1
- package/__cjs/cache/core/types/Cache.d.cts +200 -15
- package/__cjs/cache/{core/types/DataProxy.cjs → deprecated.cjs} +1 -1
- package/__cjs/cache/deprecated.cjs.map +1 -0
- package/__cjs/cache/deprecated.d.cts +6 -0
- package/__cjs/cache/index.cjs.map +1 -1
- package/__cjs/cache/index.d.cts +3 -3
- package/__cjs/cache/inmemory/entityStore.cjs +28 -31
- package/__cjs/cache/inmemory/entityStore.cjs.map +1 -1
- package/__cjs/cache/inmemory/entityStore.d.cts +18 -17
- package/__cjs/cache/inmemory/helpers.cjs.map +1 -1
- package/__cjs/cache/inmemory/inMemoryCache.cjs +3 -8
- package/__cjs/cache/inmemory/inMemoryCache.cjs.map +1 -1
- package/__cjs/cache/inmemory/inMemoryCache.d.cts +4 -4
- package/__cjs/cache/inmemory/key-extractor.cjs +1 -1
- package/__cjs/cache/inmemory/key-extractor.cjs.map +1 -1
- package/__cjs/cache/inmemory/policies.cjs +4 -4
- package/__cjs/cache/inmemory/policies.cjs.map +1 -1
- package/__cjs/cache/inmemory/policies.d.cts +3 -2
- package/__cjs/cache/inmemory/reactiveVars.cjs.map +1 -1
- package/__cjs/cache/inmemory/readFromStore.cjs +4 -6
- package/__cjs/cache/inmemory/readFromStore.cjs.map +1 -1
- package/__cjs/cache/inmemory/readFromStore.d.cts +0 -1
- package/__cjs/cache/inmemory/types.d.cts +1 -6
- package/__cjs/cache/inmemory/writeToStore.cjs +4 -4
- package/__cjs/cache/inmemory/writeToStore.cjs.map +1 -1
- package/__cjs/cache/inmemory/writeToStore.d.cts +1 -1
- package/__cjs/core/ApolloClient.cjs +160 -131
- package/__cjs/core/ApolloClient.cjs.map +1 -1
- package/__cjs/core/ApolloClient.d.cts +788 -191
- package/__cjs/core/ObservableQuery.cjs +50 -20
- package/__cjs/core/ObservableQuery.cjs.map +1 -1
- package/__cjs/core/ObservableQuery.d.cts +190 -107
- package/__cjs/core/QueryInfo.cjs +2 -6
- package/__cjs/core/QueryInfo.cjs.map +1 -1
- package/__cjs/core/QueryInfo.d.cts +9 -8
- package/__cjs/core/QueryManager.cjs +15 -14
- package/__cjs/core/QueryManager.cjs.map +1 -1
- package/__cjs/core/QueryManager.d.cts +20 -20
- package/__cjs/core/deprecated.cjs +3 -0
- package/__cjs/core/deprecated.cjs.map +1 -0
- package/__cjs/core/deprecated.d.cts +29 -0
- package/__cjs/core/index.cjs +1 -2
- package/__cjs/core/index.cjs.map +1 -1
- package/__cjs/core/index.d.cts +12 -9
- package/__cjs/core/networkStatus.cjs.map +1 -1
- package/__cjs/core/types.d.cts +186 -145
- package/__cjs/core/watchQueryOptions.d.cts +14 -303
- package/__cjs/dev/index.cjs.map +1 -1
- package/__cjs/dev/loadDevMessages.cjs.map +1 -1
- package/__cjs/dev/loadErrorMessageHandler.cjs.map +1 -1
- package/__cjs/dev/loadErrorMessages.cjs.map +1 -1
- package/__cjs/dev/setErrorMessageHandler.cjs.map +1 -1
- package/__cjs/dev/setErrorMessageHandler.d.cts +4 -4
- package/__cjs/dev/symbol.cjs.map +1 -1
- package/__cjs/errors/CombinedGraphQLErrors.cjs +64 -11
- package/__cjs/errors/CombinedGraphQLErrors.cjs.map +1 -1
- package/__cjs/errors/CombinedGraphQLErrors.d.cts +168 -14
- package/__cjs/errors/CombinedProtocolErrors.cjs +54 -1
- package/__cjs/errors/CombinedProtocolErrors.cjs.map +1 -1
- package/__cjs/errors/CombinedProtocolErrors.d.cts +132 -2
- package/__cjs/errors/LinkError.cjs +45 -2
- package/__cjs/errors/LinkError.cjs.map +1 -1
- package/__cjs/errors/LinkError.d.cts +45 -2
- package/__cjs/errors/LocalStateError.cjs +35 -5
- package/__cjs/errors/LocalStateError.cjs.map +1 -1
- package/__cjs/errors/LocalStateError.d.cts +41 -5
- package/__cjs/errors/ServerError.cjs +51 -8
- package/__cjs/errors/ServerError.cjs.map +1 -1
- package/__cjs/errors/ServerError.d.cts +71 -11
- package/__cjs/errors/ServerParseError.cjs +46 -8
- package/__cjs/errors/ServerParseError.cjs.map +1 -1
- package/__cjs/errors/ServerParseError.d.cts +72 -16
- package/__cjs/errors/UnconventionalError.cjs +46 -2
- package/__cjs/errors/UnconventionalError.cjs.map +1 -1
- package/__cjs/errors/UnconventionalError.d.cts +46 -2
- package/__cjs/errors/index.cjs.map +1 -1
- package/__cjs/errors/isErrorLike.cjs.map +1 -1
- package/__cjs/errors/utils.cjs.map +1 -1
- package/__cjs/incremental/handlers/defer20220824.cjs.map +1 -1
- package/__cjs/incremental/handlers/defer20220824.d.cts +4 -4
- package/__cjs/incremental/handlers/notImplemented.cjs +1 -1
- package/__cjs/incremental/handlers/notImplemented.cjs.map +1 -1
- package/__cjs/incremental/handlers/notImplemented.d.cts +2 -2
- package/__cjs/incremental/index.cjs.map +1 -1
- package/__cjs/incremental/types.d.cts +4 -4
- package/__cjs/invariantErrorCodes.cjs +84 -93
- package/__cjs/invariantErrorCodes.cjs.map +1 -1
- package/__cjs/link/batch/batchLink.cjs +33 -13
- package/__cjs/link/batch/batchLink.cjs.map +1 -1
- package/__cjs/link/batch/batchLink.d.cts +103 -28
- package/__cjs/link/batch/batching.cjs +1 -1
- package/__cjs/link/batch/batching.cjs.map +1 -1
- package/__cjs/link/batch/batching.d.cts +8 -8
- package/__cjs/link/batch/index.cjs +1 -2
- package/__cjs/link/batch/index.cjs.map +1 -1
- package/__cjs/link/batch/index.d.cts +1 -2
- package/__cjs/link/batch-http/BaseBatchHttpLink.cjs +156 -0
- package/__cjs/link/batch-http/BaseBatchHttpLink.cjs.map +1 -0
- package/__cjs/link/batch-http/BaseBatchHttpLink.d.cts +68 -0
- package/__cjs/link/batch-http/batchHttpLink.cjs +28 -130
- package/__cjs/link/batch-http/batchHttpLink.cjs.map +1 -1
- package/__cjs/link/batch-http/batchHttpLink.d.cts +40 -17
- package/__cjs/link/batch-http/index.cjs +2 -1
- package/__cjs/link/batch-http/index.cjs.map +1 -1
- package/__cjs/link/batch-http/index.d.cts +2 -1
- package/__cjs/link/client-awareness/ClientAwarenessLink.cjs +36 -3
- package/__cjs/link/client-awareness/ClientAwarenessLink.cjs.map +1 -1
- package/__cjs/link/client-awareness/ClientAwarenessLink.d.cts +59 -7
- package/__cjs/link/client-awareness/index.cjs.map +1 -1
- package/__cjs/link/context/index.cjs +37 -14
- package/__cjs/link/context/index.cjs.map +1 -1
- package/__cjs/link/context/index.d.cts +78 -5
- package/__cjs/link/core/ApolloLink.cjs +227 -55
- package/__cjs/link/core/ApolloLink.cjs.map +1 -1
- package/__cjs/link/core/ApolloLink.d.cts +355 -9
- package/__cjs/link/core/concat.cjs +4 -0
- package/__cjs/link/core/concat.cjs.map +1 -1
- package/__cjs/link/core/concat.d.cts +4 -0
- package/__cjs/link/core/deprecated.cjs +3 -0
- package/__cjs/link/core/deprecated.cjs.map +1 -0
- package/__cjs/link/core/deprecated.d.cts +10 -0
- package/__cjs/link/core/empty.cjs +4 -0
- package/__cjs/link/core/empty.cjs.map +1 -1
- package/__cjs/link/core/empty.d.cts +4 -0
- package/__cjs/link/core/execute.cjs.map +1 -1
- package/__cjs/link/core/from.cjs +4 -0
- package/__cjs/link/core/from.cjs.map +1 -1
- package/__cjs/link/core/from.d.cts +4 -0
- package/__cjs/link/core/split.cjs +4 -0
- package/__cjs/link/core/split.cjs.map +1 -1
- package/__cjs/link/core/split.d.cts +4 -0
- package/__cjs/link/core/types.d.cts +1 -30
- package/__cjs/link/error/index.cjs +44 -0
- package/__cjs/link/error/index.cjs.map +1 -1
- package/__cjs/link/error/index.d.cts +84 -10
- package/__cjs/link/http/BaseHttpLink.cjs +62 -12
- package/__cjs/link/http/BaseHttpLink.cjs.map +1 -1
- package/__cjs/link/http/BaseHttpLink.d.cts +256 -2
- package/__cjs/link/http/HttpLink.cjs +27 -2
- package/__cjs/link/http/HttpLink.cjs.map +1 -1
- package/__cjs/link/http/HttpLink.d.cts +45 -135
- package/__cjs/link/http/checkFetcher.cjs +1 -1
- package/__cjs/link/http/index.cjs +1 -3
- package/__cjs/link/http/index.cjs.map +1 -1
- package/__cjs/link/http/index.d.cts +0 -2
- package/__cjs/link/http/parseAndCheckHttpResponse.cjs +41 -26
- package/__cjs/link/http/parseAndCheckHttpResponse.cjs.map +1 -1
- package/__cjs/link/http/parseAndCheckHttpResponse.d.cts +2 -2
- package/__cjs/link/http/rewriteURIForGET.cjs +2 -3
- package/__cjs/link/http/rewriteURIForGET.cjs.map +1 -1
- package/__cjs/link/http/rewriteURIForGET.d.cts +2 -2
- package/__cjs/link/http/selectHttpOptionsAndBody.cjs.map +1 -1
- package/__cjs/link/http/selectHttpOptionsAndBody.d.cts +9 -9
- package/__cjs/link/http/selectURI.cjs.map +1 -1
- package/__cjs/link/http/selectURI.d.cts +2 -2
- package/__cjs/link/index.cjs.map +1 -1
- package/__cjs/link/index.d.cts +2 -1
- package/__cjs/link/persisted-queries/index.cjs +18 -2
- package/__cjs/link/persisted-queries/index.cjs.map +1 -1
- package/__cjs/link/persisted-queries/index.d.cts +207 -28
- package/__cjs/link/remove-typename/index.cjs.map +1 -1
- package/__cjs/link/remove-typename/index.d.cts +0 -1
- package/__cjs/link/remove-typename/removeTypenameFromVariables.cjs +48 -0
- package/__cjs/link/remove-typename/removeTypenameFromVariables.cjs.map +1 -1
- package/__cjs/link/remove-typename/removeTypenameFromVariables.d.cts +124 -8
- package/__cjs/link/retry/delayFunction.cjs.map +1 -1
- package/__cjs/link/retry/delayFunction.d.cts +2 -39
- package/__cjs/link/retry/index.cjs.map +1 -1
- package/__cjs/link/retry/retryFunction.cjs.map +1 -1
- package/__cjs/link/retry/retryFunction.d.cts +2 -29
- package/__cjs/link/retry/retryLink.cjs +37 -12
- package/__cjs/link/retry/retryLink.cjs.map +1 -1
- package/__cjs/link/retry/retryLink.d.cts +130 -6
- package/__cjs/link/schema/index.cjs +20 -0
- package/__cjs/link/schema/index.cjs.map +1 -1
- package/__cjs/link/schema/index.d.cts +130 -9
- package/__cjs/link/subscriptions/index.cjs +23 -0
- package/__cjs/link/subscriptions/index.cjs.map +1 -1
- package/__cjs/link/subscriptions/index.d.cts +24 -2
- package/__cjs/link/utils/createOperation.cjs +12 -4
- package/__cjs/link/utils/createOperation.cjs.map +1 -1
- package/__cjs/link/utils/createOperation.d.cts +2 -2
- package/__cjs/link/utils/filterOperationVariables.cjs.map +1 -1
- package/__cjs/link/utils/index.cjs +1 -5
- package/__cjs/link/utils/index.cjs.map +1 -1
- package/__cjs/link/utils/index.d.cts +0 -2
- package/__cjs/link/ws/index.cjs +35 -1
- package/__cjs/link/ws/index.cjs.map +1 -1
- package/__cjs/link/ws/index.d.cts +64 -7
- package/__cjs/local-state/LocalState.cjs +55 -12
- package/__cjs/local-state/LocalState.cjs.map +1 -1
- package/__cjs/local-state/LocalState.d.cts +94 -0
- package/__cjs/local-state/index.cjs.map +1 -1
- package/__cjs/masking/GraphQLCodegenDataMasking.d.cts +11 -44
- package/__cjs/masking/PreserveTypes.cjs +3 -0
- package/__cjs/masking/PreserveTypes.cjs.map +1 -0
- package/__cjs/masking/PreserveTypes.d.cts +26 -0
- package/__cjs/masking/index.cjs.map +1 -1
- package/__cjs/masking/index.d.cts +1 -1
- package/__cjs/masking/internal/types.d.cts +70 -71
- package/__cjs/masking/maskDefinition.cjs +2 -2
- package/__cjs/masking/maskDefinition.cjs.map +1 -1
- package/__cjs/masking/maskFragment.cjs +2 -2
- package/__cjs/masking/maskFragment.cjs.map +1 -1
- package/__cjs/masking/maskOperation.cjs +1 -1
- package/__cjs/masking/maskOperation.cjs.map +1 -1
- package/__cjs/masking/types.d.cts +5 -23
- package/__cjs/masking/utils.cjs +3 -3
- package/__cjs/masking/utils.cjs.map +1 -1
- package/__cjs/react/context/ApolloContext.cjs +1 -1
- package/__cjs/react/context/ApolloContext.cjs.map +1 -1
- package/__cjs/react/context/ApolloProvider.cjs +1 -1
- package/__cjs/react/hooks/constants.cjs.map +1 -1
- package/__cjs/react/hooks/internal/__use.cjs.map +1 -1
- package/__cjs/react/hooks/internal/index.cjs.map +1 -1
- package/__cjs/react/hooks/internal/useDeepMemo.cjs +0 -3
- package/__cjs/react/hooks/internal/useDeepMemo.cjs.map +1 -1
- package/__cjs/react/hooks/internal/useIsomorphicLayoutEffect.cjs.map +1 -1
- package/__cjs/react/hooks/internal/useRenderGuard.cjs.map +1 -1
- package/__cjs/react/hooks/internal/validateSuspenseHookOptions.cjs.map +1 -1
- package/__cjs/react/hooks/internal/validateSuspenseHookOptions.d.cts +2 -2
- package/__cjs/react/hooks/internal/wrapHook.cjs +1 -0
- package/__cjs/react/hooks/internal/wrapHook.cjs.map +1 -1
- package/__cjs/react/hooks/internal/wrapHook.d.cts +8 -7
- package/__cjs/react/hooks/useApolloClient.cjs +2 -2
- package/__cjs/react/hooks/useApolloClient.cjs.map +1 -1
- package/__cjs/react/hooks/useApolloClient.d.cts +2 -2
- package/__cjs/react/hooks/useBackgroundQuery.cjs.map +1 -1
- package/__cjs/react/hooks/useBackgroundQuery.d.cts +850 -86
- package/__cjs/react/hooks/useFragment.cjs +11 -5
- package/__cjs/react/hooks/useFragment.cjs.map +1 -1
- package/__cjs/react/hooks/useFragment.d.cts +56 -8
- package/__cjs/react/hooks/useLazyQuery.cjs +0 -38
- package/__cjs/react/hooks/useLazyQuery.cjs.map +1 -1
- package/__cjs/react/hooks/useLazyQuery.d.cts +317 -161
- package/__cjs/react/hooks/useLoadableQuery.cjs.map +1 -1
- package/__cjs/react/hooks/useLoadableQuery.d.cts +246 -69
- package/__cjs/react/hooks/useMutation.cjs +6 -7
- package/__cjs/react/hooks/useMutation.cjs.map +1 -1
- package/__cjs/react/hooks/useMutation.d.cts +88 -66
- package/__cjs/react/hooks/useQuery.cjs +12 -38
- package/__cjs/react/hooks/useQuery.cjs.map +1 -1
- package/__cjs/react/hooks/useQuery.d.cts +367 -239
- package/__cjs/react/hooks/useQueryRefHandlers.cjs +2 -1
- package/__cjs/react/hooks/useQueryRefHandlers.cjs.map +1 -1
- package/__cjs/react/hooks/useQueryRefHandlers.d.cts +36 -3
- package/__cjs/react/hooks/useReactiveVar.cjs +2 -1
- package/__cjs/react/hooks/useReactiveVar.cjs.map +1 -1
- package/__cjs/react/hooks/useReactiveVar.d.cts +2 -1
- package/__cjs/react/hooks/useReadQuery.cjs +29 -0
- package/__cjs/react/hooks/useReadQuery.cjs.map +1 -1
- package/__cjs/react/hooks/useReadQuery.d.cts +92 -16
- package/__cjs/react/hooks/useSubscription.cjs +8 -9
- package/__cjs/react/hooks/useSubscription.cjs.map +1 -1
- package/__cjs/react/hooks/useSubscription.d.cts +160 -68
- package/__cjs/react/hooks/useSuspenseFragment.cjs.map +1 -1
- package/__cjs/react/hooks/useSuspenseFragment.d.cts +62 -30
- package/__cjs/react/hooks/useSuspenseQuery.cjs +4 -1
- package/__cjs/react/hooks/useSuspenseQuery.cjs.map +1 -1
- package/__cjs/react/hooks/useSuspenseQuery.d.cts +585 -159
- package/__cjs/react/hooks/useSyncExternalStore.cjs +2 -6
- package/__cjs/react/hooks/useSyncExternalStore.cjs.map +1 -1
- package/__cjs/react/index.cjs +2 -5
- package/__cjs/react/index.cjs.map +1 -1
- package/__cjs/react/index.d.cts +1 -2
- package/__cjs/react/index.react-server.cjs +1 -3
- package/__cjs/react/index.react-server.cjs.map +1 -1
- package/__cjs/react/index.react-server.d.cts +0 -1
- package/__cjs/react/internal/cache/FragmentReference.cjs +1 -1
- package/__cjs/react/internal/cache/FragmentReference.cjs.map +1 -1
- package/__cjs/react/internal/cache/FragmentReference.d.cts +2 -3
- package/__cjs/react/internal/cache/QueryReference.cjs.map +1 -1
- package/__cjs/react/internal/cache/QueryReference.d.cts +14 -12
- package/__cjs/react/internal/cache/SuspenseCache.cjs.map +1 -1
- package/__cjs/react/internal/cache/SuspenseCache.d.cts +2 -2
- package/__cjs/react/internal/cache/getSuspenseCache.cjs.map +1 -1
- package/__cjs/react/internal/cache/getSuspenseCache.d.cts +6 -4
- package/__cjs/react/internal/compiler-runtime/index.cjs +32 -0
- package/__cjs/react/internal/compiler-runtime/index.cjs.map +1 -0
- package/__cjs/react/internal/compiler-runtime/index.d.cts +8 -0
- package/__cjs/react/internal/index.cjs +1 -0
- package/__cjs/react/internal/index.cjs.map +1 -1
- package/__cjs/react/internal/index.d.cts +1 -1
- package/__cjs/react/internal/types.d.cts +3 -3
- package/__cjs/react/query-preloader/createQueryPreloader.cjs +1 -1
- package/__cjs/react/query-preloader/createQueryPreloader.cjs.map +1 -1
- package/__cjs/react/query-preloader/createQueryPreloader.d.cts +60 -51
- package/__cjs/react/ssr/getDataFromTree.cjs.map +1 -1
- package/__cjs/react/ssr/index.cjs.map +1 -1
- package/__cjs/react/ssr/prerenderStatic.cjs +5 -4
- package/__cjs/react/ssr/prerenderStatic.cjs.map +1 -1
- package/__cjs/react/ssr/prerenderStatic.d.cts +11 -9
- package/__cjs/react/ssr/renderToStringWithData.cjs.map +1 -1
- package/__cjs/react/ssr/useSSRQuery.cjs.map +1 -1
- package/__cjs/react/types/deprecated.d.cts +1 -1
- package/__cjs/react/types/types.documentation.d.cts +27 -16
- package/__cjs/testing/core/mocking/mockLink.cjs.map +1 -1
- package/__cjs/testing/core/mocking/mockLink.d.cts +8 -8
- package/__cjs/testing/core/mocking/mockSubscriptionLink.cjs.map +1 -1
- package/__cjs/testing/core/mocking/mockSubscriptionLink.d.cts +3 -4
- package/__cjs/testing/core/types/deprecated.d.cts +3 -2
- package/__cjs/testing/index.cjs.map +1 -1
- package/__cjs/testing/react/MockedProvider.cjs +2 -2
- package/__cjs/testing/react/MockedProvider.cjs.map +1 -1
- package/__cjs/testing/react/MockedProvider.d.cts +2 -7
- package/__cjs/testing/react/index.cjs.map +1 -1
- package/__cjs/utilities/HKT.d.cts +8 -7
- package/__cjs/utilities/caching/index.cjs.map +1 -1
- package/__cjs/utilities/caching/sizes.cjs +3 -3
- package/__cjs/utilities/caching/sizes.cjs.map +1 -1
- package/__cjs/utilities/caching/sizes.d.cts +4 -6
- package/__cjs/utilities/common/stripTypename.cjs +11 -0
- package/__cjs/utilities/common/stripTypename.cjs.map +1 -1
- package/__cjs/utilities/common/stripTypename.d.cts +11 -0
- package/__cjs/utilities/environment/index.cjs.map +1 -1
- package/__cjs/utilities/environment/index.development.cjs.map +1 -1
- package/__cjs/utilities/environment/index.production.cjs.map +1 -1
- package/__cjs/utilities/graphql/DocumentTransform.cjs +86 -3
- package/__cjs/utilities/graphql/DocumentTransform.cjs.map +1 -1
- package/__cjs/utilities/graphql/DocumentTransform.d.cts +94 -5
- package/__cjs/utilities/graphql/isFormattedExecutionResult.cjs +27 -0
- package/__cjs/utilities/graphql/isFormattedExecutionResult.cjs.map +1 -1
- package/__cjs/utilities/graphql/isFormattedExecutionResult.d.cts +27 -0
- package/__cjs/utilities/graphql/operations.cjs +54 -3
- package/__cjs/utilities/graphql/operations.cjs.map +1 -1
- package/__cjs/utilities/graphql/operations.d.cts +54 -3
- package/__cjs/utilities/graphql/print.cjs.map +1 -1
- package/__cjs/utilities/graphql/storeUtils.cjs +9 -0
- package/__cjs/utilities/graphql/storeUtils.cjs.map +1 -1
- package/__cjs/utilities/graphql/storeUtils.d.cts +9 -0
- package/__cjs/utilities/graphql/transform.cjs +12 -1
- package/__cjs/utilities/graphql/transform.cjs.map +1 -1
- package/__cjs/utilities/graphql/transform.d.cts +12 -1
- package/__cjs/utilities/index.cjs +4 -3
- package/__cjs/utilities/index.cjs.map +1 -1
- package/__cjs/utilities/index.d.cts +1 -1
- package/__cjs/utilities/internal/argumentsObjectFromField.cjs.map +1 -1
- package/__cjs/utilities/internal/caches.cjs.map +1 -1
- package/__cjs/utilities/internal/canUseDOM.cjs.map +1 -1
- package/__cjs/utilities/{shared → internal}/canonicalStringify.cjs +35 -14
- package/__cjs/utilities/internal/canonicalStringify.cjs.map +1 -0
- package/__cjs/utilities/internal/canonicalStringify.d.cts +44 -0
- package/__cjs/utilities/internal/checkDocument.cjs +2 -2
- package/__cjs/utilities/internal/checkDocument.cjs.map +1 -1
- package/__cjs/utilities/internal/cloneDeep.cjs.map +1 -1
- package/__cjs/utilities/internal/compact.cjs.map +1 -1
- package/__cjs/utilities/internal/createFragmentMap.cjs.map +1 -1
- package/__cjs/utilities/internal/createFulfilledPromise.cjs.map +1 -1
- package/__cjs/utilities/internal/createRejectedPromise.cjs.map +1 -1
- package/__cjs/utilities/internal/dealias.cjs.map +1 -1
- package/__cjs/utilities/internal/decoratePromise.cjs.map +1 -1
- package/__cjs/utilities/internal/deepFreeze.cjs.map +1 -1
- package/__cjs/{core → utilities/internal}/equalByQuery.cjs +13 -7
- package/__cjs/utilities/internal/equalByQuery.cjs.map +1 -0
- package/__cjs/utilities/internal/equalByQuery.d.cts +5 -0
- package/__cjs/utilities/internal/filterMap.cjs.map +1 -1
- package/__cjs/utilities/internal/getDefaultValues.cjs.map +1 -1
- package/__cjs/utilities/internal/getFragmentDefinition.cjs.map +1 -1
- package/__cjs/utilities/internal/getFragmentDefinitions.cjs.map +1 -1
- package/__cjs/utilities/internal/getFragmentFromSelection.cjs.map +1 -1
- package/__cjs/utilities/internal/getFragmentQueryDocument.cjs +13 -3
- package/__cjs/utilities/internal/getFragmentQueryDocument.cjs.map +1 -1
- package/__cjs/utilities/internal/getFragmentQueryDocument.d.cts +13 -3
- package/__cjs/utilities/internal/getGraphQLErrorsFromResult.cjs.map +1 -1
- package/__cjs/utilities/internal/getMainDefinition.cjs +37 -14
- package/__cjs/utilities/internal/getMainDefinition.cjs.map +1 -1
- package/__cjs/utilities/internal/getMainDefinition.d.cts +36 -8
- package/__cjs/utilities/internal/getMemoryInternals.cjs.map +1 -1
- package/__cjs/utilities/internal/getOperationDefinition.cjs.map +1 -1
- package/__cjs/utilities/internal/getOperationName.cjs.map +1 -1
- package/__cjs/utilities/internal/getQueryDefinition.cjs.map +1 -1
- package/__cjs/utilities/internal/getStoreKeyName.cjs +9 -7
- package/__cjs/utilities/internal/getStoreKeyName.cjs.map +1 -1
- package/__cjs/utilities/internal/globals/global.cjs.map +1 -1
- package/__cjs/utilities/internal/globals/index.cjs.map +1 -1
- package/__cjs/utilities/internal/globals/maybe.cjs.map +1 -1
- package/__cjs/utilities/internal/graphQLResultHasError.cjs.map +1 -1
- package/__cjs/utilities/internal/hasDirectives.cjs.map +1 -1
- package/__cjs/utilities/internal/hasForcedResolvers.cjs.map +1 -1
- package/__cjs/utilities/internal/index.cjs +8 -2
- package/__cjs/utilities/internal/index.cjs.map +1 -1
- package/__cjs/utilities/internal/index.d.cts +4 -0
- package/__cjs/utilities/internal/index.production.cjs.map +1 -1
- package/__cjs/utilities/internal/isArray.cjs.map +1 -1
- package/__cjs/utilities/internal/isDocumentNode.cjs.map +1 -1
- package/__cjs/utilities/internal/isField.cjs.map +1 -1
- package/__cjs/utilities/internal/isNonEmptyArray.cjs.map +1 -1
- package/__cjs/utilities/internal/isNonNullObject.cjs.map +1 -1
- package/__cjs/utilities/internal/isPlainObject.cjs.map +1 -1
- package/__cjs/utilities/internal/makeReference.cjs.map +1 -1
- package/__cjs/utilities/internal/makeUniqueId.cjs.map +1 -1
- package/__cjs/utilities/internal/maybeDeepFreeze.cjs.map +1 -1
- package/__cjs/utilities/internal/mergeDeep.cjs.map +1 -1
- package/__cjs/utilities/internal/mergeDeepArray.cjs.map +1 -1
- package/__cjs/utilities/internal/mergeOptions.cjs.map +1 -1
- package/__cjs/utilities/internal/mergeOptions.d.cts +2 -2
- package/__cjs/utilities/internal/omitDeep.cjs.map +1 -1
- package/__cjs/utilities/internal/preventUnhandledRejection.cjs.map +1 -1
- package/__cjs/utilities/internal/removeDirectivesFromDocument.cjs +2 -6
- package/__cjs/utilities/internal/removeDirectivesFromDocument.cjs.map +1 -1
- package/__cjs/utilities/internal/removeFragmentSpreads.cjs +14 -0
- package/__cjs/utilities/internal/removeFragmentSpreads.cjs.map +1 -0
- package/__cjs/utilities/internal/removeFragmentSpreads.d.cts +3 -0
- package/__cjs/utilities/internal/resultKeyNameFromField.cjs.map +1 -1
- package/__cjs/utilities/internal/shouldInclude.cjs.map +1 -1
- package/__cjs/utilities/internal/storeKeyNameFromField.cjs.map +1 -1
- package/__cjs/utilities/internal/stringifyForDisplay.cjs.map +1 -1
- package/__cjs/utilities/internal/toQueryResult.cjs.map +1 -1
- package/__cjs/utilities/internal/toQueryResult.d.cts +2 -2
- package/__cjs/utilities/internal/types/DocumentationTypes.cjs +3 -0
- package/__cjs/utilities/internal/types/DocumentationTypes.cjs.map +1 -0
- package/__cjs/utilities/internal/types/DocumentationTypes.d.cts +88 -0
- package/__cjs/utilities/internal/types/NoInfer.d.cts +31 -25
- package/__cjs/utilities/internal/types/VariablesOption.d.cts +2 -6
- package/__cjs/utilities/internal/valueToObjectRepresentation.cjs.map +1 -1
- package/__cjs/utilities/invariant/index.cjs.map +1 -1
- package/__cjs/utilities/invariant/index.development.cjs.map +1 -1
- package/__cjs/utilities/policies/pagination.cjs.map +1 -1
- package/__cjs/utilities/subscriptions/relay/index.cjs +3 -2
- package/__cjs/utilities/subscriptions/relay/index.cjs.map +1 -1
- package/__cjs/version.cjs +1 -1
- package/__cjs/version.cjs.map +1 -1
- package/cache/core/cache.d.ts +108 -73
- package/cache/core/cache.js +17 -20
- package/cache/core/cache.js.map +1 -1
- package/cache/core/types/Cache.d.ts +201 -16
- package/cache/core/types/Cache.js +2 -4
- package/cache/core/types/Cache.js.map +1 -1
- package/cache/core/types/common.d.ts +1 -1
- package/cache/core/types/common.js +1 -1
- package/cache/core/types/common.js.map +1 -1
- package/cache/deprecated.d.ts +6 -0
- package/cache/deprecated.js +2 -0
- package/cache/deprecated.js.map +1 -0
- package/cache/index.d.ts +4 -4
- package/cache/index.js +1 -1
- package/cache/index.js.map +1 -1
- package/cache/inmemory/entityStore.d.ts +19 -18
- package/cache/inmemory/entityStore.js +28 -31
- package/cache/inmemory/entityStore.js.map +1 -1
- package/cache/inmemory/fragmentRegistry.d.ts +1 -1
- package/cache/inmemory/fragmentRegistry.js +1 -1
- package/cache/inmemory/fragmentRegistry.js.map +1 -1
- package/cache/inmemory/helpers.d.ts +1 -1
- package/cache/inmemory/helpers.js +1 -1
- package/cache/inmemory/helpers.js.map +1 -1
- package/cache/inmemory/inMemoryCache.d.ts +4 -4
- package/cache/inmemory/inMemoryCache.js +3 -8
- package/cache/inmemory/inMemoryCache.js.map +1 -1
- package/cache/inmemory/key-extractor.d.ts +1 -1
- package/cache/inmemory/key-extractor.js +1 -1
- package/cache/inmemory/key-extractor.js.map +1 -1
- package/cache/inmemory/policies.d.ts +4 -3
- package/cache/inmemory/policies.js +4 -4
- package/cache/inmemory/policies.js.map +1 -1
- package/cache/inmemory/reactiveVars.d.ts +1 -1
- package/cache/inmemory/reactiveVars.js +1 -1
- package/cache/inmemory/reactiveVars.js.map +1 -1
- package/cache/inmemory/readFromStore.d.ts +1 -2
- package/cache/inmemory/readFromStore.js +4 -6
- package/cache/inmemory/readFromStore.js.map +1 -1
- package/cache/inmemory/types.d.ts +2 -7
- package/cache/inmemory/types.js +1 -1
- package/cache/inmemory/types.js.map +1 -1
- package/cache/inmemory/writeToStore.d.ts +2 -2
- package/cache/inmemory/writeToStore.js +4 -4
- package/cache/inmemory/writeToStore.js.map +1 -1
- package/core/ApolloClient.d.ts +788 -191
- package/core/ApolloClient.js +161 -132
- package/core/ApolloClient.js.map +1 -1
- package/core/ObservableQuery.d.ts +190 -107
- package/core/ObservableQuery.js +50 -20
- package/core/ObservableQuery.js.map +1 -1
- package/core/QueryInfo.d.ts +9 -8
- package/core/QueryInfo.js +1 -2
- package/core/QueryInfo.js.map +1 -1
- package/core/QueryManager.d.ts +21 -21
- package/core/QueryManager.js +15 -14
- package/core/QueryManager.js.map +1 -1
- package/core/deprecated.d.ts +29 -0
- package/core/deprecated.js +2 -0
- package/core/deprecated.js.map +1 -0
- package/core/index.d.ts +13 -10
- package/core/index.js +2 -2
- package/core/index.js.map +1 -1
- package/core/networkStatus.d.ts +1 -1
- package/core/networkStatus.js +1 -1
- package/core/networkStatus.js.map +1 -1
- package/core/types.d.ts +186 -145
- package/core/types.js +1 -1
- package/core/types.js.map +1 -1
- package/core/watchQueryOptions.d.ts +15 -304
- package/core/watchQueryOptions.js +1 -1
- package/core/watchQueryOptions.js.map +1 -1
- package/dev/index.d.ts +1 -1
- package/dev/index.js +1 -1
- package/dev/index.js.map +1 -1
- package/dev/loadDevMessages.d.ts +1 -1
- package/dev/loadDevMessages.js +1 -1
- package/dev/loadDevMessages.js.map +1 -1
- package/dev/loadErrorMessageHandler.d.ts +1 -1
- package/dev/loadErrorMessageHandler.js +1 -1
- package/dev/loadErrorMessageHandler.js.map +1 -1
- package/dev/loadErrorMessages.d.ts +1 -1
- package/dev/loadErrorMessages.js +1 -1
- package/dev/loadErrorMessages.js.map +1 -1
- package/dev/setErrorMessageHandler.d.ts +5 -5
- package/dev/setErrorMessageHandler.js +1 -1
- package/dev/setErrorMessageHandler.js.map +1 -1
- package/dev/symbol.d.ts +1 -1
- package/dev/symbol.js +1 -1
- package/dev/symbol.js.map +1 -1
- package/errors/CombinedGraphQLErrors.d.ts +168 -14
- package/errors/CombinedGraphQLErrors.js +64 -11
- package/errors/CombinedGraphQLErrors.js.map +1 -1
- package/errors/CombinedProtocolErrors.d.ts +132 -2
- package/errors/CombinedProtocolErrors.js +54 -1
- package/errors/CombinedProtocolErrors.js.map +1 -1
- package/errors/LinkError.d.ts +45 -2
- package/errors/LinkError.js +45 -2
- package/errors/LinkError.js.map +1 -1
- package/errors/LocalStateError.d.ts +41 -5
- package/errors/LocalStateError.js +35 -5
- package/errors/LocalStateError.js.map +1 -1
- package/errors/ServerError.d.ts +71 -11
- package/errors/ServerError.js +51 -8
- package/errors/ServerError.js.map +1 -1
- package/errors/ServerParseError.d.ts +72 -16
- package/errors/ServerParseError.js +46 -8
- package/errors/ServerParseError.js.map +1 -1
- package/errors/UnconventionalError.d.ts +47 -3
- package/errors/UnconventionalError.js +47 -3
- package/errors/UnconventionalError.js.map +1 -1
- package/errors/index.d.ts +1 -1
- package/errors/index.js +1 -1
- package/errors/index.js.map +1 -1
- package/errors/isErrorLike.d.ts +1 -1
- package/errors/isErrorLike.js +1 -1
- package/errors/isErrorLike.js.map +1 -1
- package/errors/utils.d.ts +1 -1
- package/errors/utils.js +1 -1
- package/errors/utils.js.map +1 -1
- package/incremental/handlers/defer20220824.d.ts +5 -5
- package/incremental/handlers/defer20220824.js +1 -1
- package/incremental/handlers/defer20220824.js.map +1 -1
- package/incremental/handlers/notImplemented.d.ts +3 -3
- package/incremental/handlers/notImplemented.js +1 -1
- package/incremental/handlers/notImplemented.js.map +1 -1
- package/incremental/index.d.ts +1 -1
- package/incremental/index.js.map +1 -1
- package/incremental/types.d.ts +4 -4
- package/incremental/types.js +1 -1
- package/incremental/types.js.map +1 -1
- package/invariantErrorCodes.d.ts +1 -1
- package/invariantErrorCodes.js +88 -94
- package/invariantErrorCodes.js.map +1 -1
- package/legacyEntryPoints/react/internal/compiler-runtime/compiler-runtime.cjs +1 -0
- package/legacyEntryPoints/react/internal/compiler-runtime/compiler-runtime.d.cts +1 -0
- package/legacyEntryPoints/react/internal/compiler-runtime/index.d.ts +1 -0
- package/legacyEntryPoints/react/internal/compiler-runtime/index.js +1 -0
- package/link/batch/batchLink.d.ts +103 -28
- package/link/batch/batchLink.js +33 -12
- package/link/batch/batchLink.js.map +1 -1
- package/link/batch/batching.d.ts +9 -9
- package/link/batch/batching.js +3 -3
- package/link/batch/batching.js.map +1 -1
- package/link/batch/index.d.ts +2 -3
- package/link/batch/index.js +2 -2
- package/link/batch/index.js.map +1 -1
- package/link/batch-http/BaseBatchHttpLink.d.ts +68 -0
- package/link/batch-http/BaseBatchHttpLink.js +152 -0
- package/link/batch-http/BaseBatchHttpLink.js.map +1 -0
- package/link/batch-http/batchHttpLink.d.ts +41 -18
- package/link/batch-http/batchHttpLink.js +28 -129
- package/link/batch-http/batchHttpLink.js.map +1 -1
- package/link/batch-http/index.d.ts +3 -2
- package/link/batch-http/index.js +3 -2
- package/link/batch-http/index.js.map +1 -1
- package/link/client-awareness/ClientAwarenessLink.d.ts +59 -7
- package/link/client-awareness/ClientAwarenessLink.js +37 -4
- package/link/client-awareness/ClientAwarenessLink.js.map +1 -1
- package/link/client-awareness/index.d.ts +1 -1
- package/link/client-awareness/index.js +1 -1
- package/link/client-awareness/index.js.map +1 -1
- package/link/context/index.d.ts +78 -5
- package/link/context/index.js +38 -15
- package/link/context/index.js.map +1 -1
- package/link/core/ApolloLink.d.ts +355 -9
- package/link/core/ApolloLink.js +228 -57
- package/link/core/ApolloLink.js.map +1 -1
- package/link/core/concat.d.ts +5 -1
- package/link/core/concat.js +5 -1
- package/link/core/concat.js.map +1 -1
- package/link/core/deprecated.d.ts +10 -0
- package/link/core/deprecated.js +2 -0
- package/link/core/deprecated.js.map +1 -0
- package/link/core/empty.d.ts +5 -1
- package/link/core/empty.js +5 -1
- package/link/core/empty.js.map +1 -1
- package/link/core/execute.d.ts +1 -1
- package/link/core/execute.js +1 -1
- package/link/core/execute.js.map +1 -1
- package/link/core/from.d.ts +5 -1
- package/link/core/from.js +5 -1
- package/link/core/from.js.map +1 -1
- package/link/core/split.d.ts +5 -1
- package/link/core/split.js +5 -1
- package/link/core/split.js.map +1 -1
- package/link/core/types.d.ts +2 -31
- package/link/core/types.js +1 -1
- package/link/core/types.js.map +1 -1
- package/link/error/index.d.ts +84 -10
- package/link/error/index.js +45 -1
- package/link/error/index.js.map +1 -1
- package/link/http/BaseHttpLink.d.ts +256 -2
- package/link/http/BaseHttpLink.js +63 -13
- package/link/http/BaseHttpLink.js.map +1 -1
- package/link/http/HttpLink.d.ts +46 -136
- package/link/http/HttpLink.js +28 -3
- package/link/http/HttpLink.js.map +1 -1
- package/link/http/checkFetcher.d.ts +1 -1
- package/link/http/checkFetcher.js +1 -1
- package/link/http/checkFetcher.js.map +1 -1
- package/link/http/createSignalIfSupported.d.ts +1 -1
- package/link/http/createSignalIfSupported.js +1 -1
- package/link/http/createSignalIfSupported.js.map +1 -1
- package/link/http/index.d.ts +1 -3
- package/link/http/index.js +1 -2
- package/link/http/index.js.map +1 -1
- package/link/http/parseAndCheckHttpResponse.d.ts +3 -3
- package/link/http/parseAndCheckHttpResponse.js +41 -26
- package/link/http/parseAndCheckHttpResponse.js.map +1 -1
- package/link/http/rewriteURIForGET.d.ts +3 -3
- package/link/http/rewriteURIForGET.js +3 -4
- package/link/http/rewriteURIForGET.js.map +1 -1
- package/link/http/selectHttpOptionsAndBody.d.ts +10 -10
- package/link/http/selectHttpOptionsAndBody.js +1 -1
- package/link/http/selectHttpOptionsAndBody.js.map +1 -1
- package/link/http/selectURI.d.ts +3 -3
- package/link/http/selectURI.js +1 -1
- package/link/http/selectURI.js.map +1 -1
- package/link/index.d.ts +3 -2
- package/link/index.js +1 -1
- package/link/index.js.map +1 -1
- package/link/persisted-queries/index.d.ts +207 -28
- package/link/persisted-queries/index.js +18 -2
- package/link/persisted-queries/index.js.map +1 -1
- package/link/remove-typename/index.d.ts +1 -2
- package/link/remove-typename/index.js.map +1 -1
- package/link/remove-typename/removeTypenameFromVariables.d.ts +125 -9
- package/link/remove-typename/removeTypenameFromVariables.js +49 -1
- package/link/remove-typename/removeTypenameFromVariables.js.map +1 -1
- package/link/retry/delayFunction.d.ts +3 -40
- package/link/retry/delayFunction.js +1 -1
- package/link/retry/delayFunction.js.map +1 -1
- package/link/retry/index.d.ts +1 -1
- package/link/retry/index.js +1 -1
- package/link/retry/index.js.map +1 -1
- package/link/retry/retryFunction.d.ts +3 -30
- package/link/retry/retryFunction.js +1 -1
- package/link/retry/retryFunction.js.map +1 -1
- package/link/retry/retryLink.d.ts +130 -6
- package/link/retry/retryLink.js +39 -14
- package/link/retry/retryLink.js.map +1 -1
- package/link/schema/index.d.ts +130 -9
- package/link/schema/index.js +21 -1
- package/link/schema/index.js.map +1 -1
- package/link/subscriptions/index.d.ts +25 -3
- package/link/subscriptions/index.js +24 -1
- package/link/subscriptions/index.js.map +1 -1
- package/link/utils/createOperation.d.ts +3 -3
- package/link/utils/createOperation.js +13 -5
- package/link/utils/createOperation.js.map +1 -1
- package/link/utils/filterOperationVariables.d.ts +1 -1
- package/link/utils/filterOperationVariables.js +1 -1
- package/link/utils/filterOperationVariables.js.map +1 -1
- package/link/utils/index.d.ts +1 -3
- package/link/utils/index.js +1 -3
- package/link/utils/index.js.map +1 -1
- package/link/ws/index.d.ts +65 -8
- package/link/ws/index.js +30 -0
- package/link/ws/index.js.map +1 -1
- package/local-state/LocalState.d.ts +95 -1
- package/local-state/LocalState.js +55 -12
- package/local-state/LocalState.js.map +1 -1
- package/local-state/index.d.ts +1 -1
- package/local-state/index.js +1 -1
- package/local-state/index.js.map +1 -1
- package/masking/GraphQLCodegenDataMasking.d.ts +12 -45
- package/masking/GraphQLCodegenDataMasking.js +1 -1
- package/masking/GraphQLCodegenDataMasking.js.map +1 -1
- package/masking/PreserveTypes.d.ts +26 -0
- package/masking/PreserveTypes.js +2 -0
- package/masking/PreserveTypes.js.map +1 -0
- package/masking/index.d.ts +2 -2
- package/masking/index.js +1 -1
- package/masking/index.js.map +1 -1
- package/masking/internal/types.d.ts +71 -72
- package/masking/internal/types.js +1 -1
- package/masking/internal/types.js.map +1 -1
- package/masking/maskDefinition.d.ts +1 -1
- package/masking/maskDefinition.js +2 -2
- package/masking/maskDefinition.js.map +1 -1
- package/masking/maskFragment.js +2 -2
- package/masking/maskFragment.js.map +1 -1
- package/masking/maskOperation.js +1 -1
- package/masking/maskOperation.js.map +1 -1
- package/masking/types.d.ts +6 -24
- package/masking/types.js +1 -1
- package/masking/types.js.map +1 -1
- package/masking/utils.js +3 -3
- package/masking/utils.js.map +1 -1
- package/package.json +12 -5
- package/react/compiled/index.d.ts +2 -0
- package/react/compiled/index.js +2 -0
- package/react/compiled/index.js.map +1 -0
- package/react/context/ApolloContext.d.ts +1 -1
- package/react/context/ApolloContext.js +1 -1
- package/react/context/ApolloContext.js.map +1 -1
- package/react/context/ApolloProvider.d.ts +1 -1
- package/react/context/ApolloProvider.js +1 -1
- package/react/context/ApolloProvider.js.map +1 -1
- package/react/hooks/constants.d.ts +1 -1
- package/react/hooks/constants.js +1 -1
- package/react/hooks/constants.js.map +1 -1
- package/react/hooks/internal/__use.d.ts +1 -1
- package/react/hooks/internal/__use.js +1 -1
- package/react/hooks/internal/__use.js.map +1 -1
- package/react/hooks/internal/index.d.ts +1 -1
- package/react/hooks/internal/index.js +1 -1
- package/react/hooks/internal/index.js.map +1 -1
- package/react/hooks/internal/useDeepMemo.d.ts +1 -1
- package/react/hooks/internal/useDeepMemo.js +1 -4
- package/react/hooks/internal/useDeepMemo.js.map +1 -1
- package/react/hooks/internal/useIsomorphicLayoutEffect.d.ts +1 -1
- package/react/hooks/internal/useIsomorphicLayoutEffect.js +1 -1
- package/react/hooks/internal/useIsomorphicLayoutEffect.js.map +1 -1
- package/react/hooks/internal/useRenderGuard.d.ts +1 -1
- package/react/hooks/internal/useRenderGuard.js +1 -1
- package/react/hooks/internal/useRenderGuard.js.map +1 -1
- package/react/hooks/internal/validateSuspenseHookOptions.d.ts +3 -3
- package/react/hooks/internal/validateSuspenseHookOptions.js.map +1 -1
- package/react/hooks/internal/wrapHook.d.ts +8 -7
- package/react/hooks/internal/wrapHook.js +1 -0
- package/react/hooks/internal/wrapHook.js.map +1 -1
- package/react/hooks/useApolloClient.d.ts +3 -3
- package/react/hooks/useApolloClient.js +3 -16
- package/react/hooks/useApolloClient.js.map +1 -1
- package/react/hooks/useBackgroundQuery.d.ts +850 -86
- package/react/hooks/useBackgroundQuery.js +7 -7
- package/react/hooks/useBackgroundQuery.js.map +1 -1
- package/react/hooks/useFragment.d.ts +56 -8
- package/react/hooks/useFragment.js +22 -16
- package/react/hooks/useFragment.js.map +1 -1
- package/react/hooks/useLazyQuery.d.ts +317 -161
- package/react/hooks/useLazyQuery.js +14 -52
- package/react/hooks/useLazyQuery.js.map +1 -1
- package/react/hooks/useLoadableQuery.d.ts +246 -69
- package/react/hooks/useLoadableQuery.js +69 -229
- package/react/hooks/useLoadableQuery.js.map +1 -1
- package/react/hooks/useMutation.d.ts +88 -66
- package/react/hooks/useMutation.js +88 -199
- package/react/hooks/useMutation.js.map +1 -1
- package/react/hooks/useQuery.d.ts +367 -239
- package/react/hooks/useQuery.js +65 -262
- package/react/hooks/useQuery.js.map +1 -1
- package/react/hooks/useQueryRefHandlers.d.ts +36 -3
- package/react/hooks/useQueryRefHandlers.js +26 -65
- package/react/hooks/useQueryRefHandlers.js.map +1 -1
- package/react/hooks/useReactiveVar.d.ts +3 -2
- package/react/hooks/useReactiveVar.js +3 -2
- package/react/hooks/useReactiveVar.js.map +1 -1
- package/react/hooks/useReadQuery.d.ts +92 -16
- package/react/hooks/useReadQuery.js +32 -3
- package/react/hooks/useReadQuery.js.map +1 -1
- package/react/hooks/useSubscription.d.ts +160 -68
- package/react/hooks/useSubscription.js +12 -13
- package/react/hooks/useSubscription.js.map +1 -1
- package/react/hooks/useSuspenseFragment.d.ts +62 -30
- package/react/hooks/useSuspenseFragment.js +1 -1
- package/react/hooks/useSuspenseFragment.js.map +1 -1
- package/react/hooks/useSuspenseQuery.d.ts +585 -159
- package/react/hooks/useSuspenseQuery.js +35 -57
- package/react/hooks/useSuspenseQuery.js.map +1 -1
- package/react/hooks/useSyncExternalStore.d.ts +1 -1
- package/react/hooks/useSyncExternalStore.js +1 -1
- package/react/hooks/useSyncExternalStore.js.map +1 -1
- package/react/hooks-compiled/constants.d.ts +3 -0
- package/react/hooks-compiled/constants.js +2 -0
- package/react/hooks-compiled/constants.js.map +1 -0
- package/react/hooks-compiled/internal/__use.d.ts +4 -0
- package/react/hooks-compiled/internal/__use.js +22 -0
- package/react/hooks-compiled/internal/__use.js.map +1 -0
- package/react/hooks-compiled/internal/index.d.ts +5 -0
- package/react/hooks-compiled/internal/index.js +6 -0
- package/react/hooks-compiled/internal/index.js.map +1 -0
- package/react/hooks-compiled/internal/useDeepMemo.d.ts +3 -0
- package/react/hooks-compiled/internal/useDeepMemo.js +10 -0
- package/react/hooks-compiled/internal/useDeepMemo.js.map +1 -0
- package/react/hooks-compiled/internal/useIsomorphicLayoutEffect.d.ts +3 -0
- package/react/hooks-compiled/internal/useIsomorphicLayoutEffect.js +9 -0
- package/react/hooks-compiled/internal/useIsomorphicLayoutEffect.js.map +1 -0
- package/react/hooks-compiled/internal/useRenderGuard.d.ts +2 -0
- package/react/hooks-compiled/internal/useRenderGuard.js +42 -0
- package/react/hooks-compiled/internal/useRenderGuard.js.map +1 -0
- package/react/hooks-compiled/internal/validateSuspenseHookOptions.d.ts +3 -0
- package/react/hooks-compiled/internal/validateSuspenseHookOptions.js +22 -0
- package/react/hooks-compiled/internal/validateSuspenseHookOptions.js.map +1 -0
- package/react/hooks-compiled/internal/wrapHook.d.ts +67 -0
- package/react/hooks-compiled/internal/wrapHook.js +65 -0
- package/react/hooks-compiled/internal/wrapHook.js.map +1 -0
- package/react/hooks-compiled/useApolloClient.d.ts +18 -0
- package/react/hooks-compiled/useApolloClient.js +36 -0
- package/react/hooks-compiled/useApolloClient.js.map +1 -0
- package/react/hooks-compiled/useBackgroundQuery.d.ts +974 -0
- package/react/hooks-compiled/useBackgroundQuery.js +80 -0
- package/react/hooks-compiled/useBackgroundQuery.js.map +1 -0
- package/react/hooks-compiled/useFragment.d.ts +103 -0
- package/react/hooks-compiled/useFragment.js +103 -0
- package/react/hooks-compiled/useFragment.js.map +1 -0
- package/react/hooks-compiled/useLazyQuery.d.ts +436 -0
- package/react/hooks-compiled/useLazyQuery.js +143 -0
- package/react/hooks-compiled/useLazyQuery.js.map +1 -0
- package/react/hooks-compiled/useLoadableQuery.d.ts +352 -0
- package/react/hooks-compiled/useLoadableQuery.js +247 -0
- package/react/hooks-compiled/useLoadableQuery.js.map +1 -0
- package/react/hooks-compiled/useMutation.d.ts +302 -0
- package/react/hooks-compiled/useMutation.js +262 -0
- package/react/hooks-compiled/useMutation.js.map +1 -0
- package/react/hooks-compiled/useQuery.d.ts +393 -0
- package/react/hooks-compiled/useQuery.js +361 -0
- package/react/hooks-compiled/useQuery.js.map +1 -0
- package/react/hooks-compiled/useQueryRefHandlers.d.ts +77 -0
- package/react/hooks-compiled/useQueryRefHandlers.js +110 -0
- package/react/hooks-compiled/useQueryRefHandlers.js.map +1 -0
- package/react/hooks-compiled/useReactiveVar.d.ts +21 -0
- package/react/hooks-compiled/useReactiveVar.js +34 -0
- package/react/hooks-compiled/useReactiveVar.js.map +1 -0
- package/react/hooks-compiled/useReadQuery.d.ts +100 -0
- package/react/hooks-compiled/useReadQuery.js +72 -0
- package/react/hooks-compiled/useReadQuery.js.map +1 -0
- package/react/hooks-compiled/useSubscription.d.ts +270 -0
- package/react/hooks-compiled/useSubscription.js +222 -0
- package/react/hooks-compiled/useSubscription.js.map +1 -0
- package/react/hooks-compiled/useSuspenseFragment.d.ts +79 -0
- package/react/hooks-compiled/useSuspenseFragment.js +47 -0
- package/react/hooks-compiled/useSuspenseFragment.js.map +1 -0
- package/react/hooks-compiled/useSuspenseQuery.d.ts +630 -0
- package/react/hooks-compiled/useSuspenseQuery.js +144 -0
- package/react/hooks-compiled/useSuspenseQuery.js.map +1 -0
- package/react/hooks-compiled/useSyncExternalStore.d.ts +4 -0
- package/react/hooks-compiled/useSyncExternalStore.js +126 -0
- package/react/hooks-compiled/useSyncExternalStore.js.map +1 -0
- package/react/index.compiled.d.ts +24 -0
- package/react/index.compiled.js +19 -0
- package/react/index.compiled.js.map +1 -0
- package/react/index.d.ts +2 -3
- package/react/index.js +2 -3
- package/react/index.js.map +1 -1
- package/react/index.react-server.d.ts +1 -2
- package/react/index.react-server.js +1 -3
- package/react/index.react-server.js.map +1 -1
- package/react/internal/cache/FragmentReference.d.ts +3 -4
- package/react/internal/cache/FragmentReference.js +2 -2
- package/react/internal/cache/FragmentReference.js.map +1 -1
- package/react/internal/cache/QueryReference.d.ts +14 -12
- package/react/internal/cache/QueryReference.js.map +1 -1
- package/react/internal/cache/SuspenseCache.d.ts +3 -3
- package/react/internal/cache/SuspenseCache.js +1 -1
- package/react/internal/cache/SuspenseCache.js.map +1 -1
- package/react/internal/cache/getSuspenseCache.d.ts +7 -5
- package/react/internal/cache/getSuspenseCache.js +1 -1
- package/react/internal/cache/getSuspenseCache.js.map +1 -1
- package/react/internal/cache/types.d.ts +1 -1
- package/react/internal/cache/types.js +1 -1
- package/react/internal/cache/types.js.map +1 -1
- package/react/internal/compiler-runtime/index.d.ts +8 -0
- package/react/internal/compiler-runtime/index.js +28 -0
- package/react/internal/compiler-runtime/index.js.map +1 -0
- package/react/internal/index.d.ts +2 -2
- package/react/internal/index.js +2 -1
- package/react/internal/index.js.map +1 -1
- package/react/internal/types.d.ts +4 -4
- package/react/internal/types.js +1 -1
- package/react/internal/types.js.map +1 -1
- package/react/query-preloader/createQueryPreloader.d.ts +60 -51
- package/react/query-preloader/createQueryPreloader.js +2 -2
- package/react/query-preloader/createQueryPreloader.js.map +1 -1
- package/react/ssr/getDataFromTree.d.ts +1 -1
- package/react/ssr/getDataFromTree.js.map +1 -1
- package/react/ssr/index.d.ts +1 -1
- package/react/ssr/index.js +1 -1
- package/react/ssr/index.js.map +1 -1
- package/react/ssr/prerenderStatic.d.ts +12 -10
- package/react/ssr/prerenderStatic.js +5 -4
- package/react/ssr/prerenderStatic.js.map +1 -1
- package/react/ssr/renderToStringWithData.d.ts +1 -1
- package/react/ssr/renderToStringWithData.js +1 -1
- package/react/ssr/renderToStringWithData.js.map +1 -1
- package/react/ssr/useSSRQuery.d.ts +1 -1
- package/react/ssr/useSSRQuery.js +1 -1
- package/react/ssr/useSSRQuery.js.map +1 -1
- package/react/types/deprecated.d.ts +2 -2
- package/react/types/deprecated.js +1 -1
- package/react/types/deprecated.js.map +1 -1
- package/react/types/types.documentation.d.ts +27 -16
- package/react/types/types.documentation.js +1 -1
- package/react/types/types.documentation.js.map +1 -1
- package/testing/core/mocking/mockLink.d.ts +8 -8
- package/testing/core/mocking/mockLink.js.map +1 -1
- package/testing/core/mocking/mockSubscriptionLink.d.ts +4 -5
- package/testing/core/mocking/mockSubscriptionLink.js +1 -1
- package/testing/core/mocking/mockSubscriptionLink.js.map +1 -1
- package/testing/core/types/deprecated.d.ts +4 -3
- package/testing/core/types/deprecated.js +1 -1
- package/testing/core/types/deprecated.js.map +1 -1
- package/testing/index.d.ts +1 -1
- package/testing/index.js +1 -1
- package/testing/index.js.map +1 -1
- package/testing/react/MockedProvider.d.ts +3 -8
- package/testing/react/MockedProvider.js +3 -3
- package/testing/react/MockedProvider.js.map +1 -1
- package/testing/react/index.d.ts +1 -1
- package/testing/react/index.js +1 -1
- package/testing/react/index.js.map +1 -1
- package/utilities/DeepPartial.d.ts +1 -1
- package/utilities/DeepPartial.js +1 -1
- package/utilities/DeepPartial.js.map +1 -1
- package/utilities/HKT.d.ts +9 -8
- package/utilities/HKT.js +1 -1
- package/utilities/HKT.js.map +1 -1
- package/utilities/caching/index.d.ts +1 -1
- package/utilities/caching/index.js +1 -1
- package/utilities/caching/index.js.map +1 -1
- package/utilities/caching/sizes.d.ts +5 -7
- package/utilities/caching/sizes.js +4 -4
- package/utilities/caching/sizes.js.map +1 -1
- package/utilities/common/stripTypename.d.ts +12 -1
- package/utilities/common/stripTypename.js +12 -1
- package/utilities/common/stripTypename.js.map +1 -1
- package/utilities/environment/index.d.ts +1 -1
- package/utilities/environment/index.development.d.ts +1 -1
- package/utilities/environment/index.development.js +1 -1
- package/utilities/environment/index.development.js.map +1 -1
- package/utilities/environment/index.js +1 -1
- package/utilities/environment/index.js.map +1 -1
- package/utilities/environment/index.production.d.ts +1 -1
- package/utilities/environment/index.production.js +1 -1
- package/utilities/environment/index.production.js.map +1 -1
- package/utilities/graphql/DocumentTransform.d.ts +94 -5
- package/utilities/graphql/DocumentTransform.js +85 -2
- package/utilities/graphql/DocumentTransform.js.map +1 -1
- package/utilities/graphql/isFormattedExecutionResult.d.ts +28 -1
- package/utilities/graphql/isFormattedExecutionResult.js +28 -1
- package/utilities/graphql/isFormattedExecutionResult.js.map +1 -1
- package/utilities/graphql/operations.d.ts +55 -4
- package/utilities/graphql/operations.js +55 -4
- package/utilities/graphql/operations.js.map +1 -1
- package/utilities/graphql/print.d.ts +1 -1
- package/utilities/graphql/print.js +1 -1
- package/utilities/graphql/print.js.map +1 -1
- package/utilities/graphql/storeUtils.d.ts +10 -1
- package/utilities/graphql/storeUtils.js +10 -1
- package/utilities/graphql/storeUtils.js.map +1 -1
- package/utilities/graphql/transform.d.ts +13 -2
- package/utilities/graphql/transform.js +13 -2
- package/utilities/graphql/transform.js.map +1 -1
- package/utilities/index.d.ts +2 -2
- package/utilities/index.js +2 -2
- package/utilities/index.js.map +1 -1
- package/utilities/internal/argumentsObjectFromField.js.map +1 -1
- package/utilities/internal/caches.js.map +1 -1
- package/utilities/internal/canUseDOM.js.map +1 -1
- package/utilities/internal/canonicalStringify.d.ts +44 -0
- package/utilities/{shared → internal}/canonicalStringify.js +35 -14
- package/utilities/internal/canonicalStringify.js.map +1 -0
- package/utilities/internal/checkDocument.js +1 -1
- package/utilities/internal/checkDocument.js.map +1 -1
- package/utilities/internal/cloneDeep.js.map +1 -1
- package/utilities/internal/compact.js.map +1 -1
- package/utilities/internal/createFragmentMap.js.map +1 -1
- package/utilities/internal/createFulfilledPromise.js.map +1 -1
- package/utilities/internal/createRejectedPromise.js.map +1 -1
- package/utilities/internal/dealias.d.ts +1 -1
- package/utilities/internal/dealias.js +1 -1
- package/utilities/internal/dealias.js.map +1 -1
- package/utilities/internal/decoratePromise.js.map +1 -1
- package/utilities/internal/deepFreeze.js.map +1 -1
- package/utilities/internal/equalByQuery.d.ts +5 -0
- package/{core → utilities/internal}/equalByQuery.js +8 -2
- package/utilities/internal/equalByQuery.js.map +1 -0
- package/utilities/internal/filterMap.d.ts +1 -1
- package/utilities/internal/filterMap.js +1 -1
- package/utilities/internal/filterMap.js.map +1 -1
- package/utilities/internal/getDefaultValues.js.map +1 -1
- package/utilities/internal/getFragmentDefinition.js.map +1 -1
- package/utilities/internal/getFragmentDefinitions.js.map +1 -1
- package/utilities/internal/getFragmentFromSelection.js.map +1 -1
- package/utilities/internal/getFragmentQueryDocument.d.ts +13 -3
- package/utilities/internal/getFragmentQueryDocument.js +13 -3
- package/utilities/internal/getFragmentQueryDocument.js.map +1 -1
- package/utilities/internal/getGraphQLErrorsFromResult.js.map +1 -1
- package/utilities/internal/getMainDefinition.d.ts +37 -9
- package/utilities/internal/getMainDefinition.js +37 -14
- package/utilities/internal/getMainDefinition.js.map +1 -1
- package/utilities/internal/getMemoryInternals.js.map +1 -1
- package/utilities/internal/getOperationDefinition.js.map +1 -1
- package/utilities/internal/getOperationName.js.map +1 -1
- package/utilities/internal/getQueryDefinition.js.map +1 -1
- package/utilities/internal/getStoreKeyName.js +9 -7
- package/utilities/internal/getStoreKeyName.js.map +1 -1
- package/utilities/internal/globals/global.d.ts +1 -1
- package/utilities/internal/globals/index.d.ts +1 -1
- package/utilities/internal/globals/index.js +1 -1
- package/utilities/internal/globals/index.js.map +1 -1
- package/utilities/internal/globals/maybe.d.ts +1 -1
- package/utilities/internal/globals/maybe.js +1 -1
- package/utilities/internal/globals/maybe.js.map +1 -1
- package/utilities/internal/graphQLResultHasError.js.map +1 -1
- package/utilities/internal/hasDirectives.js.map +1 -1
- package/utilities/internal/hasForcedResolvers.d.ts +1 -1
- package/utilities/internal/hasForcedResolvers.js +1 -1
- package/utilities/internal/hasForcedResolvers.js.map +1 -1
- package/utilities/internal/index.d.ts +5 -1
- package/utilities/internal/index.js +4 -1
- package/utilities/internal/index.js.map +1 -1
- package/utilities/internal/index.production.d.ts +1 -1
- package/utilities/internal/index.production.js +1 -1
- package/utilities/internal/index.production.js.map +1 -1
- package/utilities/internal/isArray.js.map +1 -1
- package/utilities/internal/isDocumentNode.js.map +1 -1
- package/utilities/internal/isField.js.map +1 -1
- package/utilities/internal/isNonEmptyArray.js.map +1 -1
- package/utilities/internal/isNonNullObject.js.map +1 -1
- package/utilities/internal/isPlainObject.js.map +1 -1
- package/utilities/internal/makeReference.js.map +1 -1
- package/utilities/internal/makeUniqueId.js.map +1 -1
- package/utilities/internal/maybeDeepFreeze.js.map +1 -1
- package/utilities/internal/mergeDeep.js.map +1 -1
- package/utilities/internal/mergeDeepArray.js.map +1 -1
- package/utilities/internal/mergeOptions.d.ts +2 -2
- package/utilities/internal/mergeOptions.js.map +1 -1
- package/utilities/internal/omitDeep.js.map +1 -1
- package/utilities/internal/preventUnhandledRejection.d.ts +1 -1
- package/utilities/internal/preventUnhandledRejection.js +1 -1
- package/utilities/internal/preventUnhandledRejection.js.map +1 -1
- package/utilities/internal/removeDirectivesFromDocument.js +1 -2
- package/utilities/internal/removeDirectivesFromDocument.js.map +1 -1
- package/utilities/internal/removeFragmentSpreads.d.ts +3 -0
- package/utilities/internal/removeFragmentSpreads.js +11 -0
- package/utilities/internal/removeFragmentSpreads.js.map +1 -0
- package/utilities/internal/resultKeyNameFromField.js.map +1 -1
- package/utilities/internal/shouldInclude.js.map +1 -1
- package/utilities/internal/storeKeyNameFromField.js.map +1 -1
- package/utilities/internal/stringifyForDisplay.js.map +1 -1
- package/utilities/internal/toQueryResult.d.ts +2 -2
- package/utilities/internal/toQueryResult.js.map +1 -1
- package/utilities/internal/types/ApplyHKT.js +1 -1
- package/utilities/internal/types/ApplyHKT.js.map +1 -1
- package/utilities/internal/types/ApplyHKTImplementationWithDefault.js +1 -1
- package/utilities/internal/types/ApplyHKTImplementationWithDefault.js.map +1 -1
- package/utilities/internal/types/DecoratedPromise.js +1 -1
- package/utilities/internal/types/DecoratedPromise.js.map +1 -1
- package/utilities/internal/types/DeepOmit.js +1 -1
- package/utilities/internal/types/DeepOmit.js.map +1 -1
- package/utilities/internal/types/DocumentationTypes.d.ts +88 -0
- package/utilities/internal/types/DocumentationTypes.js +2 -0
- package/utilities/internal/types/DocumentationTypes.js.map +1 -0
- package/utilities/internal/types/FragmentMap.js +1 -1
- package/utilities/internal/types/FragmentMap.js.map +1 -1
- package/utilities/internal/types/FragmentMapFunction.js +1 -1
- package/utilities/internal/types/FragmentMapFunction.js.map +1 -1
- package/utilities/internal/types/FulfilledPromise.js +1 -1
- package/utilities/internal/types/FulfilledPromise.js.map +1 -1
- package/utilities/internal/types/IsAny.js +1 -1
- package/utilities/internal/types/IsAny.js.map +1 -1
- package/utilities/internal/types/NoInfer.d.ts +32 -26
- package/utilities/internal/types/NoInfer.js +1 -1
- package/utilities/internal/types/NoInfer.js.map +1 -1
- package/utilities/internal/types/PendingPromise.js +1 -1
- package/utilities/internal/types/PendingPromise.js.map +1 -1
- package/utilities/internal/types/Prettify.js +1 -1
- package/utilities/internal/types/Prettify.js.map +1 -1
- package/utilities/internal/types/Primitive.js +1 -1
- package/utilities/internal/types/Primitive.js.map +1 -1
- package/utilities/internal/types/RejectedPromise.js +1 -1
- package/utilities/internal/types/RejectedPromise.js.map +1 -1
- package/utilities/internal/types/RemoveIndexSignature.js +1 -1
- package/utilities/internal/types/RemoveIndexSignature.js.map +1 -1
- package/utilities/internal/types/TupleToIntersection.d.ts +1 -1
- package/utilities/internal/types/TupleToIntersection.js +1 -1
- package/utilities/internal/types/TupleToIntersection.js.map +1 -1
- package/utilities/internal/types/VariablesOption.d.ts +2 -6
- package/utilities/internal/types/VariablesOption.js +1 -1
- package/utilities/internal/types/VariablesOption.js.map +1 -1
- package/utilities/internal/valueToObjectRepresentation.js.map +1 -1
- package/utilities/invariant/index.d.ts +1 -1
- package/utilities/invariant/index.development.d.ts +1 -1
- package/utilities/invariant/index.development.js +1 -1
- package/utilities/invariant/index.development.js.map +1 -1
- package/utilities/invariant/index.js +1 -1
- package/utilities/invariant/index.js.map +1 -1
- package/utilities/policies/pagination.d.ts +1 -1
- package/utilities/policies/pagination.js +1 -1
- package/utilities/policies/pagination.js.map +1 -1
- package/utilities/subscriptions/relay/index.d.ts +1 -1
- package/utilities/subscriptions/relay/index.js +4 -3
- package/utilities/subscriptions/relay/index.js.map +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/__cjs/cache/core/types/DataProxy.cjs.map +0 -1
- package/__cjs/cache/core/types/DataProxy.d.cts +0 -140
- package/__cjs/core/equalByQuery.cjs.map +0 -1
- package/__cjs/core/equalByQuery.d.cts +0 -4
- package/__cjs/link/http/serializeFetchParameter.cjs +0 -18
- package/__cjs/link/http/serializeFetchParameter.cjs.map +0 -1
- package/__cjs/link/http/serializeFetchParameter.d.cts +0 -6
- package/__cjs/link/utils/transformOperation.cjs +0 -21
- package/__cjs/link/utils/transformOperation.cjs.map +0 -1
- package/__cjs/link/utils/transformOperation.d.cts +0 -3
- package/__cjs/link/utils/validateOperation.cjs +0 -20
- package/__cjs/link/utils/validateOperation.cjs.map +0 -1
- package/__cjs/link/utils/validateOperation.d.cts +0 -3
- package/__cjs/react/context/ApolloConsumer.cjs +0 -16
- package/__cjs/react/context/ApolloConsumer.cjs.map +0 -1
- package/__cjs/react/context/ApolloConsumer.d.cts +0 -10
- package/__cjs/utilities/shared/canonicalStringify.cjs.map +0 -1
- package/__cjs/utilities/shared/canonicalStringify.d.cts +0 -21
- package/cache/core/types/DataProxy.d.ts +0 -140
- package/cache/core/types/DataProxy.js +0 -2
- package/cache/core/types/DataProxy.js.map +0 -1
- package/core/equalByQuery.d.ts +0 -4
- package/core/equalByQuery.js.map +0 -1
- package/link/http/serializeFetchParameter.d.ts +0 -6
- package/link/http/serializeFetchParameter.js +0 -14
- package/link/http/serializeFetchParameter.js.map +0 -1
- package/link/utils/transformOperation.d.ts +0 -3
- package/link/utils/transformOperation.js +0 -18
- package/link/utils/transformOperation.js.map +0 -1
- package/link/utils/validateOperation.d.ts +0 -3
- package/link/utils/validateOperation.js +0 -17
- package/link/utils/validateOperation.js.map +0 -1
- package/react/context/ApolloConsumer.d.ts +0 -10
- package/react/context/ApolloConsumer.js +0 -11
- package/react/context/ApolloConsumer.js.map +0 -1
- package/utilities/shared/canonicalStringify.d.ts +0 -21
- package/utilities/shared/canonicalStringify.js.map +0 -1
|
@@ -1,113 +1,640 @@
|
|
|
1
|
+
import type { DocumentNode } from "graphql";
|
|
1
2
|
import type { Observable } from "rxjs";
|
|
2
|
-
import type { ApolloCache,
|
|
3
|
-
import type { WatchFragmentOptions, WatchFragmentResult } from "@apollo/client/cache";
|
|
3
|
+
import type { ApolloCache, IgnoreModifier, Reference } from "@apollo/client/cache";
|
|
4
4
|
import type { Incremental } from "@apollo/client/incremental";
|
|
5
|
-
import type { ApolloLink
|
|
5
|
+
import type { ApolloLink } from "@apollo/client/link";
|
|
6
6
|
import type { ClientAwarenessLink } from "@apollo/client/link/client-awareness";
|
|
7
7
|
import type { LocalState } from "@apollo/client/local-state";
|
|
8
8
|
import type { MaybeMasked, Unmasked } from "@apollo/client/masking";
|
|
9
|
-
import
|
|
9
|
+
import { DocumentTransform } from "@apollo/client/utilities";
|
|
10
|
+
import type { VariablesOption } from "@apollo/client/utilities/internal";
|
|
10
11
|
import { getApolloClientMemoryInternals } from "@apollo/client/utilities/internal";
|
|
11
12
|
import type { ObservableQuery } from "./ObservableQuery.cjs";
|
|
12
|
-
import type { DefaultContext,
|
|
13
|
-
import type {
|
|
14
|
-
export
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
13
|
+
import type { DefaultContext, ErrorLike, InternalRefetchQueriesInclude, InternalRefetchQueriesResult, MutationQueryReducersMap, MutationUpdaterFunction, NormalizedExecutionResult, OnQueryUpdated, OperationVariables, RefetchQueriesInclude, RefetchQueriesPromiseResults, SubscriptionObservable, TypedDocumentNode } from "./types.cjs";
|
|
14
|
+
import type { ErrorPolicy, FetchPolicy, MutationFetchPolicy, NextFetchPolicyContext, RefetchWritePolicy, WatchQueryFetchPolicy } from "./watchQueryOptions.cjs";
|
|
15
|
+
export declare namespace ApolloClient {
|
|
16
|
+
interface DefaultOptions {
|
|
17
|
+
watchQuery?: Partial<ApolloClient.WatchQueryOptions<any, any>>;
|
|
18
|
+
query?: Partial<ApolloClient.QueryOptions<any, any>>;
|
|
19
|
+
mutate?: Partial<ApolloClient.MutateOptions<any, any, any>>;
|
|
20
|
+
}
|
|
21
|
+
interface Options {
|
|
22
|
+
/**
|
|
23
|
+
* An `ApolloLink` instance to serve as Apollo Client's network layer. For more information, see [Advanced HTTP networking](https://www.apollographql.com/docs/react/networking/advanced-http-networking/).
|
|
24
|
+
*/
|
|
25
|
+
link: ApolloLink;
|
|
26
|
+
/**
|
|
27
|
+
* The cache that Apollo Client should use to store query results locally. The recommended cache is `InMemoryCache`, which is provided by the `@apollo/client` package.
|
|
28
|
+
*
|
|
29
|
+
* For more information, see [Configuring the cache](https://www.apollographql.com/docs/react/caching/cache-configuration/).
|
|
30
|
+
*/
|
|
31
|
+
cache: ApolloCache;
|
|
32
|
+
/**
|
|
33
|
+
* The time interval (in milliseconds) before Apollo Client force-fetches queries after a server-side render.
|
|
34
|
+
*
|
|
35
|
+
* @defaultValue `0` (no delay)
|
|
36
|
+
*/
|
|
37
|
+
ssrForceFetchDelay?: number;
|
|
38
|
+
/**
|
|
39
|
+
* When using Apollo Client for [server-side rendering](https://www.apollographql.com/docs/react/performance/server-side-rendering/), set this to `true` so that the [`getDataFromTree` function](../react/ssr/#getdatafromtree) can work effectively.
|
|
40
|
+
*
|
|
41
|
+
* @defaultValue `false`
|
|
42
|
+
*/
|
|
43
|
+
ssrMode?: boolean;
|
|
44
|
+
/**
|
|
45
|
+
* If `false`, Apollo Client sends every created query to the server, even if a _completely_ identical query (identical in terms of query string, variable values, and operationName) is already in flight.
|
|
46
|
+
*
|
|
47
|
+
* @defaultValue `true`
|
|
48
|
+
*/
|
|
49
|
+
queryDeduplication?: boolean;
|
|
50
|
+
/**
|
|
51
|
+
* Provide this object to set application-wide default values for options you can provide to the `watchQuery`, `query`, and `mutate` functions. See below for an example object.
|
|
52
|
+
*
|
|
53
|
+
* See this [example object](https://www.apollographql.com/docs/react/api/core/ApolloClient#example-defaultoptions-object).
|
|
54
|
+
*/
|
|
55
|
+
defaultOptions?: ApolloClient.DefaultOptions;
|
|
56
|
+
defaultContext?: Partial<DefaultContext>;
|
|
57
|
+
/**
|
|
58
|
+
* If `true`, Apollo Client will assume results read from the cache are never mutated by application code, which enables substantial performance optimizations.
|
|
59
|
+
*
|
|
60
|
+
* @defaultValue `false`
|
|
61
|
+
*/
|
|
62
|
+
assumeImmutableResults?: boolean;
|
|
63
|
+
localState?: LocalState;
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
*/
|
|
67
|
+
clientAwareness?: ClientAwarenessLink.ClientAwarenessOptions;
|
|
68
|
+
/**
|
|
69
|
+
*
|
|
70
|
+
*/
|
|
71
|
+
enhancedClientAwareness?: ClientAwarenessLink.EnhancedClientAwarenessOptions;
|
|
72
|
+
documentTransform?: DocumentTransform;
|
|
73
|
+
/**
|
|
74
|
+
* Configuration used by the [Apollo Client Devtools extension](https://www.apollographql.com/docs/react/development-testing/developer-tooling/#apollo-client-devtools) for this client.
|
|
75
|
+
*
|
|
76
|
+
* @since 3.11.0
|
|
77
|
+
*/
|
|
78
|
+
devtools?: DevtoolsOptions;
|
|
79
|
+
/**
|
|
80
|
+
* Determines if data masking is enabled for the client.
|
|
81
|
+
*
|
|
82
|
+
* @defaultValue false
|
|
83
|
+
*/
|
|
84
|
+
dataMasking?: boolean;
|
|
85
|
+
/**
|
|
86
|
+
* Determines the strategy used to parse incremental chunks from `@defer`
|
|
87
|
+
* queries.
|
|
88
|
+
*/
|
|
89
|
+
incrementalHandler?: Incremental.Handler<any>;
|
|
90
|
+
}
|
|
91
|
+
interface DevtoolsOptions {
|
|
92
|
+
/**
|
|
93
|
+
* If `true`, the [Apollo Client Devtools](https://www.apollographql.com/docs/react/development-testing/developer-tooling/#apollo-client-devtools) browser extension can connect to this `ApolloClient` instance.
|
|
94
|
+
*
|
|
95
|
+
* The default value is `false` in production and `true` in development if there is a `window` object.
|
|
96
|
+
*/
|
|
97
|
+
enabled?: boolean;
|
|
98
|
+
/**
|
|
99
|
+
* Optional name for this `ApolloClient` instance in the devtools. This is
|
|
100
|
+
* useful when you instantiate multiple clients and want to be able to
|
|
101
|
+
* identify them by name.
|
|
102
|
+
*/
|
|
103
|
+
name?: string;
|
|
104
|
+
}
|
|
105
|
+
type MutateOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache> = {
|
|
106
|
+
/**
|
|
107
|
+
* By providing either an object or a callback function that, when invoked after
|
|
108
|
+
* a mutation, allows you to return optimistic data and optionally skip updates
|
|
109
|
+
* via the `IGNORE` sentinel object, Apollo Client caches this temporary
|
|
110
|
+
* (and potentially incorrect) response until the mutation completes, enabling
|
|
111
|
+
* more responsive UI updates.
|
|
112
|
+
*
|
|
113
|
+
* For more information, see [Optimistic mutation results](https://www.apollographql.com/docs/react/performance/optimistic-ui/).
|
|
114
|
+
*
|
|
115
|
+
* @docGroup 3. Caching options
|
|
116
|
+
*/
|
|
117
|
+
optimisticResponse?: Unmasked<NoInfer<TData>> | ((vars: TVariables, { IGNORE }: {
|
|
118
|
+
IGNORE: IgnoreModifier;
|
|
119
|
+
}) => Unmasked<NoInfer<TData>> | IgnoreModifier);
|
|
120
|
+
/**
|
|
121
|
+
* A `MutationQueryReducersMap`, which is map from query names to
|
|
122
|
+
* mutation query reducers. Briefly, this map defines how to incorporate the
|
|
123
|
+
* results of the mutation into the results of queries that are currently
|
|
124
|
+
* being watched by your application.
|
|
125
|
+
*/
|
|
126
|
+
updateQueries?: MutationQueryReducersMap<TData>;
|
|
127
|
+
/**
|
|
128
|
+
* An array (or a function that _returns_ an array) that specifies which queries you want to refetch after the mutation occurs.
|
|
129
|
+
*
|
|
130
|
+
* Each array value can be either:
|
|
131
|
+
*
|
|
132
|
+
* - An object containing the `query` to execute, along with any `variables`
|
|
133
|
+
*
|
|
134
|
+
* - A string indicating the operation name of the query to refetch
|
|
135
|
+
*
|
|
136
|
+
* @docGroup 1. Operation options
|
|
137
|
+
*/
|
|
138
|
+
refetchQueries?: ((result: NormalizedExecutionResult<Unmasked<TData>>) => InternalRefetchQueriesInclude) | InternalRefetchQueriesInclude;
|
|
139
|
+
/**
|
|
140
|
+
* If `true`, makes sure all queries included in `refetchQueries` are completed before the mutation is considered complete.
|
|
141
|
+
*
|
|
142
|
+
* The default value is `false` (queries are refetched asynchronously).
|
|
143
|
+
*
|
|
144
|
+
* @docGroup 1. Operation options
|
|
145
|
+
*/
|
|
146
|
+
awaitRefetchQueries?: boolean;
|
|
147
|
+
/**
|
|
148
|
+
* A function used to update the Apollo Client cache after the mutation completes.
|
|
149
|
+
*
|
|
150
|
+
* For more information, see [Updating the cache after a mutation](https://www.apollographql.com/docs/react/data/mutations#updating-the-cache-after-a-mutation).
|
|
151
|
+
*
|
|
152
|
+
* @docGroup 3. Caching options
|
|
153
|
+
*/
|
|
154
|
+
update?: MutationUpdaterFunction<TData, TVariables, TCache>;
|
|
155
|
+
/**
|
|
156
|
+
* Optional callback for intercepting queries whose cache data has been updated by the mutation, as well as any queries specified in the `refetchQueries: [...]` list passed to `client.mutate`.
|
|
157
|
+
*
|
|
158
|
+
* Returning a `Promise` from `onQueryUpdated` will cause the final mutation `Promise` to await the returned `Promise`. Returning `false` causes the query to be ignored.
|
|
159
|
+
*
|
|
160
|
+
* @docGroup 1. Operation options
|
|
161
|
+
*/
|
|
162
|
+
onQueryUpdated?: OnQueryUpdated<any>;
|
|
163
|
+
/**
|
|
164
|
+
* Specifies how the mutation handles a response that returns both GraphQL errors and partial results.
|
|
165
|
+
*
|
|
166
|
+
* For details, see [GraphQL error policies](https://www.apollographql.com/docs/react/data/error-handling/#graphql-error-policies).
|
|
167
|
+
*
|
|
168
|
+
* The default value is `none`, meaning that the mutation result includes error details but _not_ partial results.
|
|
169
|
+
*
|
|
170
|
+
* @docGroup 1. Operation options
|
|
171
|
+
*/
|
|
172
|
+
errorPolicy?: ErrorPolicy;
|
|
173
|
+
/**
|
|
174
|
+
* If you're using [Apollo Link](https://www.apollographql.com/docs/react/api/link/introduction/), this object is the initial value of the `context` object that's passed along your link chain.
|
|
175
|
+
*
|
|
176
|
+
* @docGroup 2. Networking options
|
|
177
|
+
*/
|
|
178
|
+
context?: DefaultContext;
|
|
179
|
+
/**
|
|
180
|
+
* Provide `no-cache` if the mutation's result should _not_ be written to the Apollo Client cache.
|
|
181
|
+
*
|
|
182
|
+
* The default value is `network-only` (which means the result _is_ written to the cache).
|
|
183
|
+
*
|
|
184
|
+
* Unlike queries, mutations _do not_ support [fetch policies](https://www.apollographql.com/docs/react/data/queries/#setting-a-fetch-policy) besides `network-only` and `no-cache`.
|
|
185
|
+
*
|
|
186
|
+
* @docGroup 3. Caching options
|
|
187
|
+
*/
|
|
188
|
+
fetchPolicy?: MutationFetchPolicy;
|
|
189
|
+
/**
|
|
190
|
+
* To avoid retaining sensitive information from mutation root field
|
|
191
|
+
* arguments, Apollo Client v3.4+ automatically clears any `ROOT_MUTATION`
|
|
192
|
+
* fields from the cache after each mutation finishes. If you need this
|
|
193
|
+
* information to remain in the cache, you can prevent the removal by passing
|
|
194
|
+
* `keepRootFields: true` to the mutation. `ROOT_MUTATION` result data are
|
|
195
|
+
* also passed to the mutation `update` function, so we recommend obtaining
|
|
196
|
+
* the results that way, rather than using this option, if possible.
|
|
197
|
+
*/
|
|
198
|
+
keepRootFields?: boolean;
|
|
199
|
+
/**
|
|
200
|
+
* A GraphQL document, often created with `gql` from the `graphql-tag`
|
|
201
|
+
* package, that contains a single mutation inside of it.
|
|
202
|
+
*
|
|
203
|
+
* @docGroup 1. Operation options
|
|
204
|
+
*/
|
|
205
|
+
mutation: DocumentNode | TypedDocumentNode<TData, TVariables>;
|
|
206
|
+
} & VariablesOption<NoInfer<TVariables>>;
|
|
207
|
+
interface MutateResult<TData = unknown> {
|
|
208
|
+
/**
|
|
209
|
+
* The data returned from your mutation. Can be `undefined` if `ignoreResults` is `true`.
|
|
210
|
+
*/
|
|
211
|
+
data: TData | undefined;
|
|
212
|
+
/**
|
|
213
|
+
* If the mutation produces one or more errors, this object contains either an array of `graphQLErrors` or a single `networkError`. Otherwise, this value is `undefined`.
|
|
214
|
+
*
|
|
215
|
+
* For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
|
|
216
|
+
*/
|
|
217
|
+
error?: ErrorLike;
|
|
218
|
+
/**
|
|
219
|
+
* Custom extensions returned from the GraphQL server
|
|
220
|
+
*/
|
|
221
|
+
extensions?: Record<string, unknown>;
|
|
222
|
+
}
|
|
20
223
|
/**
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
* The default value is `false` in production and `true` in development if there is a `window` object.
|
|
224
|
+
* Query options.
|
|
24
225
|
*/
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
226
|
+
type QueryOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> = {
|
|
227
|
+
/**
|
|
228
|
+
* A GraphQL query string parsed into an AST with the gql template literal.
|
|
229
|
+
*
|
|
230
|
+
* @docGroup 1. Operation options
|
|
231
|
+
*/
|
|
232
|
+
query: DocumentNode | TypedDocumentNode<TData, TVariables>;
|
|
233
|
+
/**
|
|
234
|
+
* Specifies how the query handles a response that returns both GraphQL errors and partial results.
|
|
235
|
+
*
|
|
236
|
+
* For details, see [GraphQL error policies](https://www.apollographql.com/docs/react/data/error-handling/#graphql-error-policies).
|
|
237
|
+
*
|
|
238
|
+
* The default value is `none`, meaning that the query result includes error details but not partial results.
|
|
239
|
+
*
|
|
240
|
+
* @docGroup 1. Operation options
|
|
241
|
+
*/
|
|
242
|
+
errorPolicy?: ErrorPolicy;
|
|
243
|
+
/**
|
|
244
|
+
* If you're using [Apollo Link](https://www.apollographql.com/docs/react/api/link/introduction/), this object is the initial value of the `context` object that's passed along your link chain.
|
|
245
|
+
*
|
|
246
|
+
* @docGroup 2. Networking options
|
|
247
|
+
*/
|
|
248
|
+
context?: DefaultContext;
|
|
249
|
+
/**
|
|
250
|
+
* Specifies how the query interacts with the Apollo Client cache during execution (for example, whether it checks the cache for results before sending a request to the server).
|
|
251
|
+
*
|
|
252
|
+
* For details, see [Setting a fetch policy](https://www.apollographql.com/docs/react/data/queries/#setting-a-fetch-policy).
|
|
253
|
+
*
|
|
254
|
+
* The default value is `cache-first`.
|
|
255
|
+
*
|
|
256
|
+
* @docGroup 3. Caching options
|
|
257
|
+
*/
|
|
258
|
+
fetchPolicy?: FetchPolicy;
|
|
259
|
+
} & VariablesOption<NoInfer<TVariables>>;
|
|
260
|
+
interface QueryResult<TData = unknown> {
|
|
261
|
+
/**
|
|
262
|
+
* An object containing the result of your GraphQL query after it completes.
|
|
263
|
+
*
|
|
264
|
+
* This value might be `undefined` if a query results in one or more errors (depending on the query's `errorPolicy`).
|
|
265
|
+
*
|
|
266
|
+
* @docGroup 1. Operation data
|
|
267
|
+
*/
|
|
268
|
+
data: TData | undefined;
|
|
269
|
+
/**
|
|
270
|
+
* A single ErrorLike object describing the error that occured during the latest
|
|
271
|
+
* query execution.
|
|
272
|
+
*
|
|
273
|
+
* For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
|
|
274
|
+
*
|
|
275
|
+
* @docGroup 1. Operation data
|
|
276
|
+
*/
|
|
277
|
+
error?: ErrorLike;
|
|
278
|
+
}
|
|
34
279
|
/**
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* One of `uri` or `link` is **required**. If you provide both, `link` takes precedence.
|
|
280
|
+
* Options object for the `client.refetchQueries` method.
|
|
38
281
|
*/
|
|
39
|
-
|
|
282
|
+
interface RefetchQueriesOptions<TCache extends ApolloCache, TResult> {
|
|
283
|
+
/**
|
|
284
|
+
* Optional function that updates cached fields to trigger refetches of queries that include those fields.
|
|
285
|
+
*/
|
|
286
|
+
updateCache?: (cache: TCache) => void;
|
|
287
|
+
/**
|
|
288
|
+
* Optional array specifying queries to refetch. Each element can be either a query's string name or a `DocumentNode` object.
|
|
289
|
+
*
|
|
290
|
+
* Pass `"active"` as a shorthand to refetch all active queries, or `"all"` to refetch all active and inactive queries.
|
|
291
|
+
*
|
|
292
|
+
* Analogous to the [`options.refetchQueries`](https://www.apollographql.com/docs/react/data/mutations/#options) array for mutations.
|
|
293
|
+
*/
|
|
294
|
+
include?: RefetchQueriesInclude;
|
|
295
|
+
/**
|
|
296
|
+
* If `true`, the `options.updateCache` function is executed on a temporary optimistic layer of `InMemoryCache`, so its modifications can be discarded from the cache after observing which fields it invalidated.
|
|
297
|
+
*
|
|
298
|
+
* Defaults to `false`, meaning `options.updateCache` updates the cache in a lasting way.
|
|
299
|
+
*/
|
|
300
|
+
optimistic?: boolean;
|
|
301
|
+
/**
|
|
302
|
+
* Optional callback function that's called once for each `ObservableQuery` that's either affected by `options.updateCache` or listed in `options.include` (or both).
|
|
303
|
+
*
|
|
304
|
+
* If `onQueryUpdated` is not provided, the default implementation returns the result of calling `observableQuery.refetch()`. When `onQueryUpdated` is provided, it can dynamically decide whether (and how) each query should be refetched.
|
|
305
|
+
*
|
|
306
|
+
* Returning `false` from `onQueryUpdated` prevents the associated query from being refetched.
|
|
307
|
+
*/
|
|
308
|
+
onQueryUpdated?: OnQueryUpdated<TResult> | null;
|
|
309
|
+
}
|
|
40
310
|
/**
|
|
41
|
-
* The
|
|
42
|
-
*
|
|
43
|
-
*
|
|
311
|
+
* The result of client.refetchQueries is thenable/awaitable, if you just want
|
|
312
|
+
* an array of fully resolved results, but you can also access the raw results
|
|
313
|
+
* immediately by examining the additional `queries` and `results` properties of
|
|
314
|
+
* the `RefetchQueriesResult<TResult> object`.
|
|
44
315
|
*/
|
|
45
|
-
|
|
316
|
+
interface RefetchQueriesResult<TResult> extends Promise<RefetchQueriesPromiseResults<TResult>>, RefetchQueriesResult.AdditionalProperties<TResult> {
|
|
317
|
+
}
|
|
318
|
+
namespace RefetchQueriesResult {
|
|
319
|
+
interface AdditionalProperties<TResult> {
|
|
320
|
+
/**
|
|
321
|
+
* An array of ObservableQuery objects corresponding 1:1 to TResult values
|
|
322
|
+
* in the results arrays (both the `result` property and the resolved value).
|
|
323
|
+
*/
|
|
324
|
+
queries: ObservableQuery<any>[];
|
|
325
|
+
/**
|
|
326
|
+
* An array of results that were either returned by `onQueryUpdated`, or provided by default in the absence of `onQueryUpdated`, including pending promises.
|
|
327
|
+
*
|
|
328
|
+
* If `onQueryUpdated` returns `false` for a given query, no result is provided for that query.
|
|
329
|
+
*
|
|
330
|
+
* If `onQueryUpdated` returns `true`, the resulting `Promise<ApolloQueryResult<any>>` is included in the `results` array instead of `true`.
|
|
331
|
+
*/
|
|
332
|
+
results: InternalRefetchQueriesResult<TResult>[];
|
|
333
|
+
}
|
|
334
|
+
}
|
|
335
|
+
type SubscribeOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> = {
|
|
336
|
+
/**
|
|
337
|
+
* A GraphQL document, often created with `gql` from the `graphql-tag`
|
|
338
|
+
* package, that contains a single subscription inside of it.
|
|
339
|
+
*/
|
|
340
|
+
query: DocumentNode | TypedDocumentNode<TData, TVariables>;
|
|
341
|
+
/**
|
|
342
|
+
* How you want your component to interact with the Apollo cache. For details, see [Setting a fetch policy](https://www.apollographql.com/docs/react/data/queries/#setting-a-fetch-policy).
|
|
343
|
+
*/
|
|
344
|
+
fetchPolicy?: FetchPolicy;
|
|
345
|
+
/**
|
|
346
|
+
* Specifies the `ErrorPolicy` to be used for this operation
|
|
347
|
+
*/
|
|
348
|
+
errorPolicy?: ErrorPolicy;
|
|
349
|
+
/**
|
|
350
|
+
* Shared context between your component and your network interface (Apollo Link).
|
|
351
|
+
*/
|
|
352
|
+
context?: DefaultContext;
|
|
353
|
+
/**
|
|
354
|
+
* Shared context between your component and your network interface (Apollo Link).
|
|
355
|
+
*/
|
|
356
|
+
extensions?: Record<string, any>;
|
|
357
|
+
} & VariablesOption<NoInfer<TVariables>>;
|
|
358
|
+
interface SubscribeResult<TData = unknown> {
|
|
359
|
+
/**
|
|
360
|
+
* The data returned from your mutation. Can be `undefined` if `ignoreResults` is `true`.
|
|
361
|
+
*/
|
|
362
|
+
data: TData | undefined;
|
|
363
|
+
/**
|
|
364
|
+
* If the mutation produces one or more errors, this object contains either an array of `graphQLErrors` or a single `networkError`. Otherwise, this value is `undefined`.
|
|
365
|
+
*
|
|
366
|
+
* For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
|
|
367
|
+
*/
|
|
368
|
+
error?: ErrorLike;
|
|
369
|
+
/**
|
|
370
|
+
* Custom extensions returned from the GraphQL server
|
|
371
|
+
*/
|
|
372
|
+
extensions?: Record<string, unknown>;
|
|
373
|
+
}
|
|
374
|
+
type WatchFragmentOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> = ApolloCache.WatchFragmentOptions<TData, TVariables>;
|
|
375
|
+
type WatchFragmentResult<TData = unknown> = ApolloCache.WatchFragmentResult<TData>;
|
|
46
376
|
/**
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
* @defaultValue `0` (no delay)
|
|
50
|
-
*/
|
|
51
|
-
ssrForceFetchDelay?: number;
|
|
52
|
-
/**
|
|
53
|
-
* When using Apollo Client for [server-side rendering](https://www.apollographql.com/docs/react/performance/server-side-rendering/), set this to `true` so that the [`getDataFromTree` function](../react/ssr/#getdatafromtree) can work effectively.
|
|
54
|
-
*
|
|
55
|
-
* @defaultValue `false`
|
|
56
|
-
*/
|
|
57
|
-
ssrMode?: boolean;
|
|
58
|
-
/**
|
|
59
|
-
* If `true`, the [Apollo Client Devtools](https://www.apollographql.com/docs/react/development-testing/developer-tooling/#apollo-client-devtools) browser extension can connect to Apollo Client.
|
|
60
|
-
*
|
|
61
|
-
* The default value is `false` in production and `true` in development (if there is a `window` object).
|
|
62
|
-
* @deprecated Please use the `devtools.enabled` option.
|
|
63
|
-
*/
|
|
64
|
-
connectToDevTools?: boolean;
|
|
65
|
-
/**
|
|
66
|
-
* If `false`, Apollo Client sends every created query to the server, even if a _completely_ identical query (identical in terms of query string, variable values, and operationName) is already in flight.
|
|
67
|
-
*
|
|
68
|
-
* @defaultValue `true`
|
|
69
|
-
*/
|
|
70
|
-
queryDeduplication?: boolean;
|
|
71
|
-
/**
|
|
72
|
-
* Provide this object to set application-wide default values for options you can provide to the `watchQuery`, `query`, and `mutate` functions. See below for an example object.
|
|
73
|
-
*
|
|
74
|
-
* See this [example object](https://www.apollographql.com/docs/react/api/core/ApolloClient#example-defaultoptions-object).
|
|
75
|
-
*/
|
|
76
|
-
defaultOptions?: DefaultOptions;
|
|
77
|
-
defaultContext?: Partial<DefaultContext>;
|
|
78
|
-
/**
|
|
79
|
-
* If `true`, Apollo Client will assume results read from the cache are never mutated by application code, which enables substantial performance optimizations.
|
|
80
|
-
*
|
|
81
|
-
* @defaultValue `false`
|
|
82
|
-
*/
|
|
83
|
-
assumeImmutableResults?: boolean;
|
|
84
|
-
localState?: LocalState;
|
|
85
|
-
/**
|
|
86
|
-
*
|
|
87
|
-
*/
|
|
88
|
-
clientAwareness?: ClientAwarenessLink.ClientAwarenessOptions;
|
|
89
|
-
/**
|
|
90
|
-
*
|
|
91
|
-
*/
|
|
92
|
-
enhancedClientAwareness?: ClientAwarenessLink.EnhancedClientAwarenessOptions;
|
|
93
|
-
documentTransform?: DocumentTransform;
|
|
94
|
-
/**
|
|
95
|
-
* Configuration used by the [Apollo Client Devtools extension](https://www.apollographql.com/docs/react/development-testing/developer-tooling/#apollo-client-devtools) for this client.
|
|
96
|
-
*
|
|
97
|
-
* @since 3.11.0
|
|
98
|
-
*/
|
|
99
|
-
devtools?: DevtoolsOptions;
|
|
100
|
-
/**
|
|
101
|
-
* Determines if data masking is enabled for the client.
|
|
102
|
-
*
|
|
103
|
-
* @defaultValue false
|
|
377
|
+
* Watched query options.
|
|
104
378
|
*/
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
379
|
+
type WatchQueryOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> = {
|
|
380
|
+
/**
|
|
381
|
+
* Specifies how the query interacts with the Apollo Client cache during execution (for example, whether it checks the cache for results before sending a request to the server).
|
|
382
|
+
*
|
|
383
|
+
* For details, see [Setting a fetch policy](https://www.apollographql.com/docs/react/data/queries/#setting-a-fetch-policy).
|
|
384
|
+
*
|
|
385
|
+
* The default value is `cache-first`.
|
|
386
|
+
*
|
|
387
|
+
* @docGroup 3. Caching options
|
|
388
|
+
*/
|
|
389
|
+
fetchPolicy?: WatchQueryFetchPolicy;
|
|
390
|
+
/**
|
|
391
|
+
* Specifies the `FetchPolicy` to be used after this query has completed.
|
|
392
|
+
*
|
|
393
|
+
* @docGroup 3. Caching options
|
|
394
|
+
*/
|
|
395
|
+
nextFetchPolicy?: WatchQueryFetchPolicy | ((this: WatchQueryOptions<TData, TVariables>, currentFetchPolicy: WatchQueryFetchPolicy, context: NextFetchPolicyContext<TData, TVariables>) => WatchQueryFetchPolicy);
|
|
396
|
+
/**
|
|
397
|
+
* Defaults to the initial value of options.fetchPolicy, but can be explicitly
|
|
398
|
+
* configured to specify the WatchQueryFetchPolicy to revert back to whenever
|
|
399
|
+
* variables change (unless nextFetchPolicy intervenes).
|
|
400
|
+
*
|
|
401
|
+
* @docGroup 3. Caching options
|
|
402
|
+
*/
|
|
403
|
+
initialFetchPolicy?: WatchQueryFetchPolicy;
|
|
404
|
+
/**
|
|
405
|
+
* Specifies whether a `NetworkStatus.refetch` operation should merge
|
|
406
|
+
* incoming field data with existing data, or overwrite the existing data.
|
|
407
|
+
* Overwriting is probably preferable, but merging is currently the default
|
|
408
|
+
* behavior, for backwards compatibility with Apollo Client 3.x.
|
|
409
|
+
*
|
|
410
|
+
* @docGroup 3. Caching options
|
|
411
|
+
*/
|
|
412
|
+
refetchWritePolicy?: RefetchWritePolicy;
|
|
413
|
+
/**
|
|
414
|
+
* Specifies how the query handles a response that returns both GraphQL errors and partial results.
|
|
415
|
+
*
|
|
416
|
+
* For details, see [GraphQL error policies](https://www.apollographql.com/docs/react/data/error-handling/#graphql-error-policies).
|
|
417
|
+
*
|
|
418
|
+
* The default value is `none`, meaning that the query result includes error details but not partial results.
|
|
419
|
+
*
|
|
420
|
+
* @docGroup 1. Operation options
|
|
421
|
+
*/
|
|
422
|
+
errorPolicy?: ErrorPolicy;
|
|
423
|
+
/**
|
|
424
|
+
* If you're using [Apollo Link](https://www.apollographql.com/docs/react/api/link/introduction/), this object is the initial value of the `context` object that's passed along your link chain.
|
|
425
|
+
*
|
|
426
|
+
* @docGroup 2. Networking options
|
|
427
|
+
*/
|
|
428
|
+
context?: DefaultContext;
|
|
429
|
+
/**
|
|
430
|
+
* Specifies the interval (in milliseconds) at which the query polls for updated results.
|
|
431
|
+
*
|
|
432
|
+
* The default value is `0` (no polling).
|
|
433
|
+
*
|
|
434
|
+
* @docGroup 2. Networking options
|
|
435
|
+
*/
|
|
436
|
+
pollInterval?: number;
|
|
437
|
+
/**
|
|
438
|
+
* If `true`, the in-progress query's associated component re-renders whenever the network status changes or a network error occurs.
|
|
439
|
+
*
|
|
440
|
+
* The default value is `true`.
|
|
441
|
+
*
|
|
442
|
+
* @docGroup 2. Networking options
|
|
443
|
+
*/
|
|
444
|
+
notifyOnNetworkStatusChange?: boolean;
|
|
445
|
+
/**
|
|
446
|
+
* If `true`, the query can return partial results from the cache if the cache doesn't contain results for all queried fields.
|
|
447
|
+
*
|
|
448
|
+
* The default value is `false`.
|
|
449
|
+
*
|
|
450
|
+
* @docGroup 3. Caching options
|
|
451
|
+
*/
|
|
452
|
+
returnPartialData?: boolean;
|
|
453
|
+
/**
|
|
454
|
+
* A callback function that's called whenever a refetch attempt occurs
|
|
455
|
+
* while polling. If the function returns `true`, the refetch is
|
|
456
|
+
* skipped and not reattempted until the next poll interval.
|
|
457
|
+
*
|
|
458
|
+
* @docGroup 2. Networking options
|
|
459
|
+
*/
|
|
460
|
+
skipPollAttempt?: () => boolean;
|
|
461
|
+
/**
|
|
462
|
+
* A GraphQL query string parsed into an AST with the gql template literal.
|
|
463
|
+
*
|
|
464
|
+
* @docGroup 1. Operation options
|
|
465
|
+
*/
|
|
466
|
+
query: DocumentNode | TypedDocumentNode<TData, TVariables>;
|
|
467
|
+
} & VariablesOption<NoInfer<TVariables>>;
|
|
468
|
+
namespace Base {
|
|
469
|
+
interface ReadQueryOptions<TData, TVariables extends OperationVariables> {
|
|
470
|
+
/**
|
|
471
|
+
* The GraphQL query shape to be used constructed using the `gql` template
|
|
472
|
+
* string tag. The query will be used to determine the
|
|
473
|
+
* shape of the data to be read.
|
|
474
|
+
*/
|
|
475
|
+
query: DocumentNode | TypedDocumentNode<TData, TVariables>;
|
|
476
|
+
/**
|
|
477
|
+
* The root id to be used. Defaults to "ROOT_QUERY", which is the ID of the
|
|
478
|
+
* root query object. This property makes `readQuery` capable of reading data
|
|
479
|
+
* from any object in the cache.
|
|
480
|
+
*/
|
|
481
|
+
id?: string;
|
|
482
|
+
/**
|
|
483
|
+
* Whether to return incomplete data rather than null.
|
|
484
|
+
* @defaultValue false
|
|
485
|
+
*/
|
|
486
|
+
returnPartialData?: boolean;
|
|
487
|
+
/**
|
|
488
|
+
* Whether to read from optimistic or non-optimistic cache data.
|
|
489
|
+
* This option should be preferred over the `optimistic` parameter of the
|
|
490
|
+
* `readQuery` method.
|
|
491
|
+
* @defaultValue false
|
|
492
|
+
*/
|
|
493
|
+
optimistic?: boolean;
|
|
494
|
+
}
|
|
495
|
+
}
|
|
496
|
+
type ReadQueryOptions<TData, TVariables extends OperationVariables> = Base.ReadQueryOptions<TData, TVariables> & VariablesOption<TVariables>;
|
|
497
|
+
namespace DocumentationTypes {
|
|
498
|
+
interface ReadQueryOptions<TData, TVariables extends OperationVariables> extends Base.ReadQueryOptions<TData, TVariables> {
|
|
499
|
+
/**
|
|
500
|
+
* Any variables that the GraphQL query may depend on.
|
|
501
|
+
*/
|
|
502
|
+
variables?: TVariables;
|
|
503
|
+
}
|
|
504
|
+
}
|
|
505
|
+
namespace Base {
|
|
506
|
+
interface ReadFragmentOptions<TData, TVariables extends OperationVariables> {
|
|
507
|
+
/**
|
|
508
|
+
* The root id to be used. This id should take the same form as the
|
|
509
|
+
* value returned by the `cache.identify` function. If a value with your
|
|
510
|
+
* id does not exist in the store, `null` will be returned.
|
|
511
|
+
*/
|
|
512
|
+
id?: string;
|
|
513
|
+
/**
|
|
514
|
+
* A GraphQL document created using the `gql` template string tag
|
|
515
|
+
* with one or more fragments which will be used to determine
|
|
516
|
+
* the shape of data to read. If you provide more than one fragment in this
|
|
517
|
+
* document then you must also specify `fragmentName` to specify which
|
|
518
|
+
* fragment is the root fragment.
|
|
519
|
+
*/
|
|
520
|
+
fragment: DocumentNode | TypedDocumentNode<TData, TVariables>;
|
|
521
|
+
/**
|
|
522
|
+
* The name of the fragment in your GraphQL document to be used. If you do
|
|
523
|
+
* not provide a `fragmentName` and there is only one fragment in your
|
|
524
|
+
* `fragment` document then that fragment will be used.
|
|
525
|
+
*/
|
|
526
|
+
fragmentName?: string;
|
|
527
|
+
/**
|
|
528
|
+
* Whether to return incomplete data rather than null.
|
|
529
|
+
* @defaultValue false
|
|
530
|
+
*/
|
|
531
|
+
returnPartialData?: boolean;
|
|
532
|
+
/**
|
|
533
|
+
* Whether to read from optimistic or non-optimistic cache data.
|
|
534
|
+
* This option should be preferred over the `optimistic` parameter of the
|
|
535
|
+
* `readFragment` method.
|
|
536
|
+
* @defaultValue false
|
|
537
|
+
*/
|
|
538
|
+
optimistic?: boolean;
|
|
539
|
+
}
|
|
540
|
+
}
|
|
541
|
+
type ReadFragmentOptions<TData, TVariables extends OperationVariables> = Base.ReadFragmentOptions<TData, TVariables> & VariablesOption<TVariables>;
|
|
542
|
+
namespace DocumentationTypes {
|
|
543
|
+
interface WriteQueryOptions<TData, TVariables extends OperationVariables> extends Base.WriteQueryOptions<TData, TVariables> {
|
|
544
|
+
/**
|
|
545
|
+
* Any variables that your GraphQL fragments depend on.
|
|
546
|
+
*/
|
|
547
|
+
variables?: TVariables;
|
|
548
|
+
}
|
|
549
|
+
}
|
|
550
|
+
namespace Base {
|
|
551
|
+
interface WriteQueryOptions<TData, TVariables extends OperationVariables> {
|
|
552
|
+
/**
|
|
553
|
+
* The GraphQL query shape to be used constructed using the `gql` template
|
|
554
|
+
* string tag. The query will be used to determine the
|
|
555
|
+
* shape of the data to be read.
|
|
556
|
+
*/
|
|
557
|
+
query: DocumentNode | TypedDocumentNode<TData, TVariables>;
|
|
558
|
+
/**
|
|
559
|
+
* The root id to be used. Defaults to "ROOT_QUERY", which is the ID of the
|
|
560
|
+
* root query object. This property makes writeQuery capable of writing data
|
|
561
|
+
* to any object in the cache.
|
|
562
|
+
*/
|
|
563
|
+
id?: string;
|
|
564
|
+
/**
|
|
565
|
+
* The data to write to the store.
|
|
566
|
+
*/
|
|
567
|
+
data: Unmasked<TData>;
|
|
568
|
+
/**
|
|
569
|
+
* Whether to notify query watchers.
|
|
570
|
+
* @defaultValue true
|
|
571
|
+
*/
|
|
572
|
+
broadcast?: boolean;
|
|
573
|
+
/**
|
|
574
|
+
* When true, ignore existing field data rather than merging it with
|
|
575
|
+
* incoming data.
|
|
576
|
+
* @defaultValue false
|
|
577
|
+
*/
|
|
578
|
+
overwrite?: boolean;
|
|
579
|
+
}
|
|
580
|
+
}
|
|
581
|
+
type WriteQueryOptions<TData, TVariables extends OperationVariables> = Base.WriteQueryOptions<TData, TVariables> & VariablesOption<TVariables>;
|
|
582
|
+
namespace DocumentationTypes {
|
|
583
|
+
interface WriteQueryOptions<TData, TVariables extends OperationVariables> extends Base.WriteQueryOptions<TData, TVariables> {
|
|
584
|
+
/**
|
|
585
|
+
* Any variables that the GraphQL query may depend on.
|
|
586
|
+
*/
|
|
587
|
+
variables?: TVariables;
|
|
588
|
+
}
|
|
589
|
+
}
|
|
590
|
+
namespace Base {
|
|
591
|
+
interface WriteFragmentOptions<TData, TVariables extends OperationVariables> {
|
|
592
|
+
/**
|
|
593
|
+
* The root id to be used. This id should take the same form as the
|
|
594
|
+
* value returned by the `cache.identify` function. If a value with your
|
|
595
|
+
* id does not exist in the store, `null` will be returned.
|
|
596
|
+
*/
|
|
597
|
+
id?: string;
|
|
598
|
+
/**
|
|
599
|
+
* A GraphQL document created using the `gql` template string tag from
|
|
600
|
+
* `graphql-tag` with one or more fragments which will be used to determine
|
|
601
|
+
* the shape of data to read. If you provide more than one fragment in this
|
|
602
|
+
* document then you must also specify `fragmentName` to specify which
|
|
603
|
+
* fragment is the root fragment.
|
|
604
|
+
*/
|
|
605
|
+
fragment: DocumentNode | TypedDocumentNode<TData, TVariables>;
|
|
606
|
+
/**
|
|
607
|
+
* The name of the fragment in your GraphQL document to be used. If you do
|
|
608
|
+
* not provide a `fragmentName` and there is only one fragment in your
|
|
609
|
+
* `fragment` document then that fragment will be used.
|
|
610
|
+
*/
|
|
611
|
+
fragmentName?: string;
|
|
612
|
+
/**
|
|
613
|
+
* The data to write to the store.
|
|
614
|
+
*/
|
|
615
|
+
data: Unmasked<TData>;
|
|
616
|
+
/**
|
|
617
|
+
* Whether to notify query watchers.
|
|
618
|
+
* @defaultValue true
|
|
619
|
+
*/
|
|
620
|
+
broadcast?: boolean;
|
|
621
|
+
/**
|
|
622
|
+
* When true, ignore existing field data rather than merging it with
|
|
623
|
+
* incoming data.
|
|
624
|
+
* @defaultValue false
|
|
625
|
+
*/
|
|
626
|
+
overwrite?: boolean;
|
|
627
|
+
}
|
|
628
|
+
}
|
|
629
|
+
type WriteFragmentOptions<TData, TVariables extends OperationVariables> = Base.WriteFragmentOptions<TData, TVariables> & VariablesOption<TVariables>;
|
|
630
|
+
namespace DocumentationTypes {
|
|
631
|
+
interface WriteFragmentOptions<TData, TVariables extends OperationVariables> extends Base.WriteFragmentOptions<TData, TVariables> {
|
|
632
|
+
/**
|
|
633
|
+
* Any variables that your GraphQL fragments depend on.
|
|
634
|
+
*/
|
|
635
|
+
variables?: TVariables;
|
|
636
|
+
}
|
|
637
|
+
}
|
|
111
638
|
}
|
|
112
639
|
/**
|
|
113
640
|
* This is the primary Apollo Client class. It is used to send GraphQL documents (i.e. queries
|
|
@@ -115,7 +642,7 @@ export interface ApolloClientOptions {
|
|
|
115
642
|
* receive results from the server and cache the results in a store. It also delivers updates
|
|
116
643
|
* to GraphQL queries through `Observable` instances.
|
|
117
644
|
*/
|
|
118
|
-
export declare class ApolloClient
|
|
645
|
+
export declare class ApolloClient {
|
|
119
646
|
link: ApolloLink;
|
|
120
647
|
cache: ApolloCache;
|
|
121
648
|
/**
|
|
@@ -133,8 +660,8 @@ export declare class ApolloClient implements DataProxy {
|
|
|
133
660
|
get prioritizeCacheValues(): boolean;
|
|
134
661
|
version: string;
|
|
135
662
|
queryDeduplication: boolean;
|
|
136
|
-
defaultOptions: DefaultOptions;
|
|
137
|
-
readonly devtoolsConfig: DevtoolsOptions;
|
|
663
|
+
defaultOptions: ApolloClient.DefaultOptions;
|
|
664
|
+
readonly devtoolsConfig: ApolloClient.DevtoolsOptions;
|
|
138
665
|
private queryManager;
|
|
139
666
|
private devToolsHookCb?;
|
|
140
667
|
private resetStoreCallbacks;
|
|
@@ -143,29 +670,30 @@ export declare class ApolloClient implements DataProxy {
|
|
|
143
670
|
* Constructs an instance of `ApolloClient`.
|
|
144
671
|
*
|
|
145
672
|
* @example
|
|
673
|
+
*
|
|
146
674
|
* ```js
|
|
147
|
-
* import { ApolloClient, InMemoryCache } from
|
|
675
|
+
* import { ApolloClient, InMemoryCache } from "@apollo/client";
|
|
148
676
|
*
|
|
149
677
|
* const cache = new InMemoryCache();
|
|
150
678
|
*
|
|
151
679
|
* const client = new ApolloClient({
|
|
152
680
|
* // Provide required constructor fields
|
|
153
681
|
* cache: cache,
|
|
154
|
-
* uri:
|
|
682
|
+
* uri: "http://localhost:4000/",
|
|
155
683
|
*
|
|
156
684
|
* // Provide some optional constructor fields
|
|
157
|
-
* name:
|
|
158
|
-
* version:
|
|
685
|
+
* name: "react-web-client",
|
|
686
|
+
* version: "1.3",
|
|
159
687
|
* queryDeduplication: false,
|
|
160
688
|
* defaultOptions: {
|
|
161
689
|
* watchQuery: {
|
|
162
|
-
* fetchPolicy:
|
|
690
|
+
* fetchPolicy: "cache-and-network",
|
|
163
691
|
* },
|
|
164
692
|
* },
|
|
165
693
|
* });
|
|
166
694
|
* ```
|
|
167
695
|
*/
|
|
168
|
-
constructor(options:
|
|
696
|
+
constructor(options: ApolloClient.Options);
|
|
169
697
|
private connectToDevTools;
|
|
170
698
|
/**
|
|
171
699
|
* The `DocumentTransform` used to modify GraphQL documents before a request
|
|
@@ -182,6 +710,12 @@ export declare class ApolloClient implements DataProxy {
|
|
|
182
710
|
/**
|
|
183
711
|
* Call this method to terminate any active client processes, making it safe
|
|
184
712
|
* to dispose of this `ApolloClient` instance.
|
|
713
|
+
*
|
|
714
|
+
* This method performs aggressive cleanup to prevent memory leaks:
|
|
715
|
+
*
|
|
716
|
+
* - Unsubscribes all active `ObservableQuery` instances by emitting a `completed` event
|
|
717
|
+
* - Rejects all currently running queries with "QueryManager stopped while query was in flight"
|
|
718
|
+
* - Removes all queryRefs from the suspense cache
|
|
185
719
|
*/
|
|
186
720
|
stop(): void;
|
|
187
721
|
/**
|
|
@@ -194,16 +728,16 @@ export declare class ApolloClient implements DataProxy {
|
|
|
194
728
|
*
|
|
195
729
|
* For example, suppose you call watchQuery on a GraphQL query that fetches a person's
|
|
196
730
|
* first and last name and this person has a particular object identifier, provided by
|
|
197
|
-
*
|
|
731
|
+
* `cache.identify`. Later, a different query fetches that same person's
|
|
198
732
|
* first and last name and the first name has now changed. Then, any observers associated
|
|
199
733
|
* with the results of the first query will be updated with a new result object.
|
|
200
734
|
*
|
|
201
|
-
* Note that if the cache does not change, the subscriber will
|
|
735
|
+
* Note that if the cache does not change, the subscriber will _not_ be notified.
|
|
202
736
|
*
|
|
203
737
|
* See [here](https://medium.com/apollo-stack/the-concepts-of-graphql-bc68bd819be3#.3mb0cbcmc) for
|
|
204
738
|
* a description of store reactivity.
|
|
205
739
|
*/
|
|
206
|
-
watchQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: WatchQueryOptions<
|
|
740
|
+
watchQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WatchQueryOptions<TData, TVariables>): ObservableQuery<TData, TVariables>;
|
|
207
741
|
/**
|
|
208
742
|
* This resolves a single query according to the options specified and
|
|
209
743
|
* returns a `Promise` which is either resolved with the resulting data
|
|
@@ -213,7 +747,7 @@ export declare class ApolloClient implements DataProxy {
|
|
|
213
747
|
* describe how this query should be treated e.g. whether it should hit the
|
|
214
748
|
* server at all or just resolve from the cache, etc.
|
|
215
749
|
*/
|
|
216
|
-
query<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: QueryOptions<
|
|
750
|
+
query<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.QueryOptions<TData, TVariables>): Promise<ApolloClient.QueryResult<MaybeMasked<TData>>>;
|
|
217
751
|
/**
|
|
218
752
|
* This resolves a single mutation according to the options specified and returns a
|
|
219
753
|
* Promise which is either resolved with the resulting data or rejected with an
|
|
@@ -222,22 +756,41 @@ export declare class ApolloClient implements DataProxy {
|
|
|
222
756
|
*
|
|
223
757
|
* It takes options as an object with the following keys and values:
|
|
224
758
|
*/
|
|
225
|
-
mutate<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache>(options:
|
|
759
|
+
mutate<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache>(options: ApolloClient.MutateOptions<TData, TVariables, TCache>): Promise<ApolloClient.MutateResult<MaybeMasked<TData>>>;
|
|
226
760
|
/**
|
|
227
761
|
* This subscribes to a graphql subscription according to the options specified and returns an
|
|
228
762
|
* `Observable` which either emits received data or an error.
|
|
229
763
|
*/
|
|
230
|
-
subscribe<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options:
|
|
764
|
+
subscribe<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.SubscribeOptions<TData, TVariables>): SubscriptionObservable<ApolloClient.SubscribeResult<MaybeMasked<TData>>>;
|
|
231
765
|
/**
|
|
232
766
|
* Tries to read some data from the store in the shape of the provided
|
|
233
767
|
* GraphQL query without making a network request. This method will start at
|
|
234
|
-
* the root query. To start at a specific id returned by `
|
|
768
|
+
* the root query. To start at a specific id returned by `cache.identify`
|
|
235
769
|
* use `readFragment`.
|
|
236
770
|
*
|
|
237
771
|
* @param optimistic - Set to `true` to allow `readQuery` to return
|
|
238
772
|
* optimistic results. Is `false` by default.
|
|
239
773
|
*/
|
|
240
|
-
readQuery<TData = unknown, TVariables = OperationVariables>(options:
|
|
774
|
+
readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadQueryOptions<TData, TVariables>): Unmasked<TData> | null;
|
|
775
|
+
/**
|
|
776
|
+
* Tries to read some data from the store in the shape of the provided
|
|
777
|
+
* GraphQL query without making a network request. This method will start at
|
|
778
|
+
* the root query. To start at a specific id returned by `cache.identify`
|
|
779
|
+
* use `readFragment`.
|
|
780
|
+
*
|
|
781
|
+
* @param optimistic - Set to `true` to allow `readQuery` to return
|
|
782
|
+
* optimistic results. Is `false` by default.
|
|
783
|
+
*
|
|
784
|
+
*
|
|
785
|
+
* @deprecated Pass the `optimistic` argument as part of the first argument
|
|
786
|
+
* instead of passing it as a separate option.
|
|
787
|
+
*/
|
|
788
|
+
readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadQueryOptions<TData, TVariables>,
|
|
789
|
+
/**
|
|
790
|
+
* @deprecated Pass the `optimistic` argument as part of the first argument
|
|
791
|
+
* instead of passing it as a separate option.
|
|
792
|
+
*/
|
|
793
|
+
optimistic: boolean): Unmasked<TData> | null;
|
|
241
794
|
/**
|
|
242
795
|
* Watches the cache store of the fragment according to the options specified
|
|
243
796
|
* and returns an `Observable`. We can subscribe to this
|
|
@@ -254,7 +807,7 @@ export declare class ApolloClient implements DataProxy {
|
|
|
254
807
|
* the cache to identify the fragment and optionally specify whether to react
|
|
255
808
|
* to optimistic updates.
|
|
256
809
|
*/
|
|
257
|
-
watchFragment<TData = unknown, TVariables = OperationVariables>(options: WatchFragmentOptions<TData, TVariables>): Observable<WatchFragmentResult<TData
|
|
810
|
+
watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WatchFragmentOptions<TData, TVariables>): Observable<ApolloClient.WatchFragmentResult<MaybeMasked<TData>>>;
|
|
258
811
|
/**
|
|
259
812
|
* Tries to read some data from the store in the shape of the provided
|
|
260
813
|
* GraphQL fragment without making a network request. This method will read a
|
|
@@ -269,13 +822,32 @@ export declare class ApolloClient implements DataProxy {
|
|
|
269
822
|
* @param optimistic - Set to `true` to allow `readFragment` to return
|
|
270
823
|
* optimistic results. Is `false` by default.
|
|
271
824
|
*/
|
|
272
|
-
readFragment<
|
|
825
|
+
readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadFragmentOptions<TData, TVariables>): Unmasked<TData> | null;
|
|
826
|
+
/**
|
|
827
|
+
* Tries to read some data from the store in the shape of the provided
|
|
828
|
+
* GraphQL fragment without making a network request. This method will read a
|
|
829
|
+
* GraphQL fragment from any arbitrary id that is currently cached, unlike
|
|
830
|
+
* `readQuery` which will only read from the root query.
|
|
831
|
+
*
|
|
832
|
+
* You must pass in a GraphQL document with a single fragment or a document
|
|
833
|
+
* with multiple fragments that represent what you are reading. If you pass
|
|
834
|
+
* in a document with multiple fragments then you must also specify a
|
|
835
|
+
* `fragmentName`.
|
|
836
|
+
*
|
|
837
|
+
* @param optimistic - Set to `true` to allow `readFragment` to return
|
|
838
|
+
* optimistic results. Is `false` by default.
|
|
839
|
+
*
|
|
840
|
+
*
|
|
841
|
+
* @deprecated Pass the `optimistic` argument as part of the first argument
|
|
842
|
+
* instead of passing it as a separate option.
|
|
843
|
+
*/
|
|
844
|
+
readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadFragmentOptions<TData, TVariables>, optimistic: boolean): Unmasked<TData> | null;
|
|
273
845
|
/**
|
|
274
846
|
* Writes some data in the shape of the provided GraphQL query directly to
|
|
275
847
|
* the store. This method will start at the root query. To start at a
|
|
276
|
-
* specific id returned by `
|
|
848
|
+
* specific id returned by `cache.identify` then use `writeFragment`.
|
|
277
849
|
*/
|
|
278
|
-
writeQuery<TData = unknown, TVariables = OperationVariables>(options:
|
|
850
|
+
writeQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WriteQueryOptions<TData, TVariables>): Reference | undefined;
|
|
279
851
|
/**
|
|
280
852
|
* Writes some data in the shape of the provided GraphQL fragment directly to
|
|
281
853
|
* the store. This method will write to a GraphQL fragment from any arbitrary
|
|
@@ -287,9 +859,9 @@ export declare class ApolloClient implements DataProxy {
|
|
|
287
859
|
* in a document with multiple fragments then you must also specify a
|
|
288
860
|
* `fragmentName`.
|
|
289
861
|
*/
|
|
290
|
-
writeFragment<TData = unknown, TVariables = OperationVariables>(options:
|
|
862
|
+
writeFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WriteFragmentOptions<TData, TVariables>): Reference | undefined;
|
|
291
863
|
__actionHookForDevTools(cb: () => any): void;
|
|
292
|
-
__requestRaw(
|
|
864
|
+
__requestRaw(request: ApolloLink.Request): Observable<ApolloLink.Result<unknown>>;
|
|
293
865
|
/**
|
|
294
866
|
* Resets your entire store by clearing out your cache and then re-executing
|
|
295
867
|
* all of your active queries. This makes it so that you may guarantee that
|
|
@@ -300,13 +872,13 @@ export declare class ApolloClient implements DataProxy {
|
|
|
300
872
|
* user session, and you now want to make sure that any references to data you
|
|
301
873
|
* might have fetched while the user session was active is gone.
|
|
302
874
|
*
|
|
303
|
-
* It is important to remember that `resetStore()`
|
|
875
|
+
* It is important to remember that `resetStore()` _will_ refetch any active
|
|
304
876
|
* queries. This means that any components that might be mounted will execute
|
|
305
877
|
* their queries again using your network interface. If you do not want to
|
|
306
878
|
* re-execute any queries then you should make sure to stop watching any
|
|
307
879
|
* active queries.
|
|
308
880
|
*/
|
|
309
|
-
resetStore(): Promise<QueryResult<any>[] | null>;
|
|
881
|
+
resetStore(): Promise<ApolloClient.QueryResult<any>[] | null>;
|
|
310
882
|
/**
|
|
311
883
|
* Remove all data from the store. Unlike `resetStore`, `clearStore` will
|
|
312
884
|
* not refetch any active queries.
|
|
@@ -329,29 +901,47 @@ export declare class ApolloClient implements DataProxy {
|
|
|
329
901
|
*
|
|
330
902
|
* `reFetchObservableQueries()` is useful if you want to bring the client back to proper state in case of a network outage
|
|
331
903
|
*
|
|
332
|
-
* It is important to remember that `reFetchObservableQueries()`
|
|
904
|
+
* It is important to remember that `reFetchObservableQueries()` _will_ refetch any active
|
|
905
|
+
* queries. This means that any components that might be mounted will execute
|
|
906
|
+
* their queries again using your network interface. If you do not want to
|
|
907
|
+
* re-execute any queries then you should make sure to stop watching any
|
|
908
|
+
* active queries.
|
|
909
|
+
* Takes optional parameter `includeStandby` which will include queries in standby-mode when refetching.
|
|
910
|
+
*
|
|
911
|
+
* Note: `cache-only` queries are not refetched by this function.
|
|
912
|
+
*
|
|
913
|
+
* @deprecated Please use `refetchObservableQueries` instead.
|
|
914
|
+
*/
|
|
915
|
+
reFetchObservableQueries: (includeStandby?: boolean) => Promise<ApolloClient.QueryResult<any>[]>;
|
|
916
|
+
/**
|
|
917
|
+
* Refetches all of your active queries.
|
|
918
|
+
*
|
|
919
|
+
* `refetchObservableQueries()` is useful if you want to bring the client back to proper state in case of a network outage
|
|
920
|
+
*
|
|
921
|
+
* It is important to remember that `refetchObservableQueries()` _will_ refetch any active
|
|
333
922
|
* queries. This means that any components that might be mounted will execute
|
|
334
923
|
* their queries again using your network interface. If you do not want to
|
|
335
924
|
* re-execute any queries then you should make sure to stop watching any
|
|
336
925
|
* active queries.
|
|
337
926
|
* Takes optional parameter `includeStandby` which will include queries in standby-mode when refetching.
|
|
927
|
+
*
|
|
928
|
+
* Note: `cache-only` queries are not refetched by this function.
|
|
338
929
|
*/
|
|
339
|
-
|
|
930
|
+
refetchObservableQueries(includeStandby?: boolean): Promise<ApolloClient.QueryResult<any>[]>;
|
|
340
931
|
/**
|
|
341
|
-
* Refetches specified active queries. Similar to "
|
|
932
|
+
* Refetches specified active queries. Similar to "refetchObservableQueries()" but with a specific list of queries.
|
|
342
933
|
*
|
|
343
934
|
* `refetchQueries()` is useful for use cases to imperatively refresh a selection of queries.
|
|
344
935
|
*
|
|
345
|
-
* It is important to remember that `refetchQueries()`
|
|
936
|
+
* It is important to remember that `refetchQueries()` _will_ refetch specified active
|
|
346
937
|
* queries. This means that any components that might be mounted will execute
|
|
347
938
|
* their queries again using your network interface. If you do not want to
|
|
348
939
|
* re-execute any queries then you should make sure to stop watching any
|
|
349
940
|
* active queries.
|
|
350
941
|
*/
|
|
351
|
-
refetchQueries<TCache extends ApolloCache = ApolloCache, TResult = Promise<QueryResult<any>>>(options: RefetchQueriesOptions<TCache, TResult>): RefetchQueriesResult<TResult>;
|
|
942
|
+
refetchQueries<TCache extends ApolloCache = ApolloCache, TResult = Promise<ApolloClient.QueryResult<any>>>(options: ApolloClient.RefetchQueriesOptions<TCache, TResult>): ApolloClient.RefetchQueriesResult<TResult>;
|
|
352
943
|
/**
|
|
353
|
-
* Get all currently active `ObservableQuery` objects, in a `
|
|
354
|
-
* query ID strings.
|
|
944
|
+
* Get all currently active `ObservableQuery` objects, in a `Set`.
|
|
355
945
|
*
|
|
356
946
|
* An "active" query is one that has observers and a `fetchPolicy` other than
|
|
357
947
|
* "standby" or "cache-only".
|
|
@@ -359,6 +949,9 @@ export declare class ApolloClient implements DataProxy {
|
|
|
359
949
|
* You can include all `ObservableQuery` objects (including the inactive ones)
|
|
360
950
|
* by passing "all" instead of "active", or you can include just a subset of
|
|
361
951
|
* active queries by passing an array of query names or DocumentNode objects.
|
|
952
|
+
*
|
|
953
|
+
* Note: This method only returns queries that have active subscribers. Queries
|
|
954
|
+
* without subscribers are not tracked by the client.
|
|
362
955
|
*/
|
|
363
956
|
getObservableQueries(include?: RefetchQueriesInclude): Set<ObservableQuery<any>>;
|
|
364
957
|
/**
|
|
@@ -378,6 +971,8 @@ export declare class ApolloClient implements DataProxy {
|
|
|
378
971
|
*/
|
|
379
972
|
setLink(newLink: ApolloLink): void;
|
|
380
973
|
get defaultContext(): Partial<DefaultContext>;
|
|
974
|
+
private maskedFragmentTransform;
|
|
975
|
+
private transform;
|
|
381
976
|
/**
|
|
382
977
|
* @experimental
|
|
383
978
|
* This is not a stable API - it is used in development builds to expose
|
|
@@ -386,77 +981,79 @@ export declare class ApolloClient implements DataProxy {
|
|
|
386
981
|
* For more details, see [Memory Management](https://www.apollographql.com/docs/react/caching/memory-management/#measuring-cache-usage)
|
|
387
982
|
*
|
|
388
983
|
* @example
|
|
984
|
+
*
|
|
389
985
|
* ```ts
|
|
390
|
-
* console.log(client.getMemoryInternals())
|
|
986
|
+
* console.log(client.getMemoryInternals());
|
|
391
987
|
* ```
|
|
988
|
+
*
|
|
392
989
|
* Logs output in the following JSON format:
|
|
393
990
|
* @example
|
|
991
|
+
*
|
|
394
992
|
* ```json
|
|
395
|
-
*{
|
|
396
|
-
*
|
|
397
|
-
*
|
|
398
|
-
*
|
|
399
|
-
*
|
|
400
|
-
*
|
|
401
|
-
*
|
|
402
|
-
*
|
|
403
|
-
*
|
|
404
|
-
*
|
|
405
|
-
*
|
|
406
|
-
*
|
|
407
|
-
*
|
|
408
|
-
*
|
|
409
|
-
*
|
|
410
|
-
*
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
*
|
|
415
|
-
*
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
*
|
|
421
|
-
*
|
|
422
|
-
*
|
|
423
|
-
*
|
|
424
|
-
*
|
|
425
|
-
*
|
|
426
|
-
*
|
|
427
|
-
*
|
|
428
|
-
*
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
*
|
|
432
|
-
*
|
|
433
|
-
*
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
*
|
|
440
|
-
*
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
*
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
*
|
|
453
|
-
*
|
|
454
|
-
*
|
|
455
|
-
*
|
|
993
|
+
* {
|
|
994
|
+
* "limits": {
|
|
995
|
+
* "canonicalStringify": 1000,
|
|
996
|
+
* "print": 2000,
|
|
997
|
+
* "documentTransform.cache": 2000,
|
|
998
|
+
* "queryManager.getDocumentInfo": 2000,
|
|
999
|
+
* "PersistedQueryLink.persistedQueryHashes": 2000,
|
|
1000
|
+
* "fragmentRegistry.transform": 2000,
|
|
1001
|
+
* "fragmentRegistry.lookup": 1000,
|
|
1002
|
+
* "fragmentRegistry.findFragmentSpreads": 4000,
|
|
1003
|
+
* "cache.fragmentQueryDocuments": 1000,
|
|
1004
|
+
* "removeTypenameFromVariables.getVariableDefinitions": 2000,
|
|
1005
|
+
* "inMemoryCache.maybeBroadcastWatch": 5000,
|
|
1006
|
+
* "inMemoryCache.executeSelectionSet": 10000,
|
|
1007
|
+
* "inMemoryCache.executeSubSelectedArray": 5000
|
|
1008
|
+
* },
|
|
1009
|
+
* "sizes": {
|
|
1010
|
+
* "canonicalStringify": 4,
|
|
1011
|
+
* "print": 14,
|
|
1012
|
+
* "addTypenameDocumentTransform": [
|
|
1013
|
+
* {
|
|
1014
|
+
* "cache": 14
|
|
1015
|
+
* }
|
|
1016
|
+
* ],
|
|
1017
|
+
* "queryManager": {
|
|
1018
|
+
* "getDocumentInfo": 14,
|
|
1019
|
+
* "documentTransforms": [
|
|
1020
|
+
* {
|
|
1021
|
+
* "cache": 14
|
|
1022
|
+
* },
|
|
1023
|
+
* {
|
|
1024
|
+
* "cache": 14
|
|
1025
|
+
* }
|
|
1026
|
+
* ]
|
|
1027
|
+
* },
|
|
1028
|
+
* "fragmentRegistry": {
|
|
1029
|
+
* "findFragmentSpreads": 34,
|
|
1030
|
+
* "lookup": 20,
|
|
1031
|
+
* "transform": 14
|
|
1032
|
+
* },
|
|
1033
|
+
* "cache": {
|
|
1034
|
+
* "fragmentQueryDocuments": 22
|
|
1035
|
+
* },
|
|
1036
|
+
* "inMemoryCache": {
|
|
1037
|
+
* "executeSelectionSet": 4345,
|
|
1038
|
+
* "executeSubSelectedArray": 1206,
|
|
1039
|
+
* "maybeBroadcastWatch": 32
|
|
1040
|
+
* },
|
|
1041
|
+
* "links": [
|
|
1042
|
+
* {
|
|
1043
|
+
* "PersistedQueryLink": {
|
|
1044
|
+
* "persistedQueryHashes": 14
|
|
1045
|
+
* }
|
|
1046
|
+
* },
|
|
1047
|
+
* {
|
|
1048
|
+
* "removeTypenameFromVariables": {
|
|
1049
|
+
* "getVariableDefinitions": 14
|
|
1050
|
+
* }
|
|
1051
|
+
* }
|
|
1052
|
+
* ]
|
|
1053
|
+
* }
|
|
456
1054
|
* }
|
|
457
|
-
|
|
1055
|
+
* ```
|
|
458
1056
|
*/
|
|
459
1057
|
getMemoryInternals?: typeof getApolloClientMemoryInternals;
|
|
460
1058
|
}
|
|
461
|
-
export {};
|
|
462
1059
|
//# sourceMappingURL=ApolloClient.d.cts.map
|