@apollo/client 4.0.0-rc.5 → 4.0.0-rc.6

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.
Files changed (512) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/README.md +40 -40
  3. package/__cjs/cache/core/cache.cjs +2 -6
  4. package/__cjs/cache/core/cache.cjs.map +1 -1
  5. package/__cjs/cache/core/cache.d.cts +65 -64
  6. package/__cjs/cache/core/types/Cache.cjs +0 -4
  7. package/__cjs/cache/core/types/Cache.cjs.map +1 -1
  8. package/__cjs/cache/core/types/Cache.d.cts +200 -15
  9. package/__cjs/cache/{core/types/DataProxy.cjs → deprecated.cjs} +1 -1
  10. package/__cjs/cache/deprecated.cjs.map +1 -0
  11. package/__cjs/cache/deprecated.d.cts +6 -0
  12. package/__cjs/cache/index.cjs.map +1 -1
  13. package/__cjs/cache/index.d.cts +2 -2
  14. package/__cjs/cache/inmemory/entityStore.cjs +25 -28
  15. package/__cjs/cache/inmemory/entityStore.cjs.map +1 -1
  16. package/__cjs/cache/inmemory/entityStore.d.cts +17 -16
  17. package/__cjs/cache/inmemory/inMemoryCache.cjs.map +1 -1
  18. package/__cjs/cache/inmemory/inMemoryCache.d.cts +4 -4
  19. package/__cjs/cache/inmemory/key-extractor.cjs +1 -1
  20. package/__cjs/cache/inmemory/policies.cjs +4 -4
  21. package/__cjs/cache/inmemory/policies.cjs.map +1 -1
  22. package/__cjs/cache/inmemory/policies.d.cts +3 -2
  23. package/__cjs/cache/inmemory/readFromStore.cjs +2 -2
  24. package/__cjs/cache/inmemory/writeToStore.cjs +4 -4
  25. package/__cjs/cache/inmemory/writeToStore.cjs.map +1 -1
  26. package/__cjs/cache/inmemory/writeToStore.d.cts +1 -1
  27. package/__cjs/core/ApolloClient.cjs +92 -110
  28. package/__cjs/core/ApolloClient.cjs.map +1 -1
  29. package/__cjs/core/ApolloClient.d.cts +774 -180
  30. package/__cjs/core/ObservableQuery.cjs +10 -10
  31. package/__cjs/core/ObservableQuery.cjs.map +1 -1
  32. package/__cjs/core/ObservableQuery.d.cts +120 -68
  33. package/__cjs/core/QueryInfo.cjs.map +1 -1
  34. package/__cjs/core/QueryInfo.d.cts +5 -4
  35. package/__cjs/core/QueryManager.cjs +15 -13
  36. package/__cjs/core/QueryManager.cjs.map +1 -1
  37. package/__cjs/core/QueryManager.d.cts +17 -17
  38. package/__cjs/core/deprecated.cjs +3 -0
  39. package/__cjs/core/deprecated.cjs.map +1 -0
  40. package/__cjs/core/deprecated.d.cts +29 -0
  41. package/__cjs/core/index.cjs.map +1 -1
  42. package/__cjs/core/index.d.cts +9 -5
  43. package/__cjs/core/types.d.cts +29 -129
  44. package/__cjs/core/watchQueryOptions.d.cts +8 -297
  45. package/__cjs/dev/setErrorMessageHandler.cjs.map +1 -1
  46. package/__cjs/dev/setErrorMessageHandler.d.cts +4 -4
  47. package/__cjs/errors/CombinedGraphQLErrors.cjs +59 -11
  48. package/__cjs/errors/CombinedGraphQLErrors.cjs.map +1 -1
  49. package/__cjs/errors/CombinedGraphQLErrors.d.cts +146 -11
  50. package/__cjs/errors/CombinedProtocolErrors.cjs +48 -1
  51. package/__cjs/errors/CombinedProtocolErrors.cjs.map +1 -1
  52. package/__cjs/errors/CombinedProtocolErrors.d.cts +126 -2
  53. package/__cjs/errors/LinkError.cjs +45 -2
  54. package/__cjs/errors/LinkError.cjs.map +1 -1
  55. package/__cjs/errors/LinkError.d.cts +45 -2
  56. package/__cjs/errors/LocalStateError.cjs +35 -5
  57. package/__cjs/errors/LocalStateError.cjs.map +1 -1
  58. package/__cjs/errors/LocalStateError.d.cts +41 -5
  59. package/__cjs/errors/ServerError.cjs +50 -8
  60. package/__cjs/errors/ServerError.cjs.map +1 -1
  61. package/__cjs/errors/ServerError.d.cts +70 -11
  62. package/__cjs/errors/ServerParseError.cjs +45 -8
  63. package/__cjs/errors/ServerParseError.cjs.map +1 -1
  64. package/__cjs/errors/ServerParseError.d.cts +71 -16
  65. package/__cjs/errors/UnconventionalError.cjs +46 -2
  66. package/__cjs/errors/UnconventionalError.cjs.map +1 -1
  67. package/__cjs/errors/UnconventionalError.d.cts +46 -2
  68. package/__cjs/incremental/handlers/notImplemented.cjs +1 -1
  69. package/__cjs/invariantErrorCodes.cjs +72 -80
  70. package/__cjs/link/batch/batchLink.cjs.map +1 -1
  71. package/__cjs/link/batch-http/batchHttpLink.cjs +2 -2
  72. package/__cjs/link/batch-http/batchHttpLink.cjs.map +1 -1
  73. package/__cjs/link/client-awareness/ClientAwarenessLink.cjs.map +1 -1
  74. package/__cjs/link/client-awareness/ClientAwarenessLink.d.cts +4 -4
  75. package/__cjs/link/context/index.cjs +1 -1
  76. package/__cjs/link/context/index.cjs.map +1 -1
  77. package/__cjs/link/context/index.d.cts +1 -1
  78. package/__cjs/link/core/ApolloLink.cjs +2 -2
  79. package/__cjs/link/core/types.d.cts +2 -2
  80. package/__cjs/link/error/index.cjs.map +1 -1
  81. package/__cjs/link/error/index.d.cts +16 -1
  82. package/__cjs/link/http/HttpLink.cjs.map +1 -1
  83. package/__cjs/link/http/HttpLink.d.cts +2 -1
  84. package/__cjs/link/http/checkFetcher.cjs +1 -1
  85. package/__cjs/link/http/parseAndCheckHttpResponse.cjs +1 -1
  86. package/__cjs/link/http/serializeFetchParameter.cjs +1 -1
  87. package/__cjs/link/persisted-queries/index.cjs +2 -2
  88. package/__cjs/link/persisted-queries/index.cjs.map +1 -1
  89. package/__cjs/link/persisted-queries/index.d.cts +11 -11
  90. package/__cjs/link/retry/delayFunction.cjs.map +1 -1
  91. package/__cjs/link/retry/delayFunction.d.cts +1 -1
  92. package/__cjs/link/retry/retryFunction.cjs.map +1 -1
  93. package/__cjs/link/retry/retryFunction.d.cts +1 -1
  94. package/__cjs/link/retry/retryLink.cjs.map +1 -1
  95. package/__cjs/link/schema/index.cjs.map +1 -1
  96. package/__cjs/link/utils/validateOperation.cjs +1 -1
  97. package/__cjs/link/ws/index.cjs.map +1 -1
  98. package/__cjs/local-state/LocalState.cjs +55 -9
  99. package/__cjs/local-state/LocalState.cjs.map +1 -1
  100. package/__cjs/local-state/LocalState.d.cts +94 -0
  101. package/__cjs/masking/GraphQLCodegenDataMasking.d.cts +6 -7
  102. package/__cjs/masking/internal/types.d.cts +70 -70
  103. package/__cjs/masking/maskDefinition.cjs +2 -2
  104. package/__cjs/masking/maskFragment.cjs +2 -2
  105. package/__cjs/masking/maskOperation.cjs +1 -1
  106. package/__cjs/masking/utils.cjs +3 -3
  107. package/__cjs/react/context/ApolloContext.cjs +1 -1
  108. package/__cjs/react/context/ApolloProvider.cjs +1 -1
  109. package/__cjs/react/hooks/internal/useDeepMemo.cjs +0 -3
  110. package/__cjs/react/hooks/internal/useDeepMemo.cjs.map +1 -1
  111. package/__cjs/react/hooks/internal/validateSuspenseHookOptions.cjs.map +1 -1
  112. package/__cjs/react/hooks/internal/validateSuspenseHookOptions.d.cts +2 -2
  113. package/__cjs/react/hooks/internal/wrapHook.cjs +1 -0
  114. package/__cjs/react/hooks/internal/wrapHook.cjs.map +1 -1
  115. package/__cjs/react/hooks/internal/wrapHook.d.cts +8 -7
  116. package/__cjs/react/hooks/useApolloClient.cjs +2 -2
  117. package/__cjs/react/hooks/useApolloClient.cjs.map +1 -1
  118. package/__cjs/react/hooks/useApolloClient.d.cts +2 -2
  119. package/__cjs/react/hooks/useBackgroundQuery.cjs.map +1 -1
  120. package/__cjs/react/hooks/useBackgroundQuery.d.cts +814 -86
  121. package/__cjs/react/hooks/useFragment.cjs +7 -0
  122. package/__cjs/react/hooks/useFragment.cjs.map +1 -1
  123. package/__cjs/react/hooks/useFragment.d.cts +53 -2
  124. package/__cjs/react/hooks/useLazyQuery.cjs +0 -38
  125. package/__cjs/react/hooks/useLazyQuery.cjs.map +1 -1
  126. package/__cjs/react/hooks/useLazyQuery.d.cts +309 -119
  127. package/__cjs/react/hooks/useLoadableQuery.cjs.map +1 -1
  128. package/__cjs/react/hooks/useLoadableQuery.d.cts +113 -126
  129. package/__cjs/react/hooks/useMutation.cjs +6 -7
  130. package/__cjs/react/hooks/useMutation.cjs.map +1 -1
  131. package/__cjs/react/hooks/useMutation.d.cts +57 -17
  132. package/__cjs/react/hooks/useQuery.cjs +1 -35
  133. package/__cjs/react/hooks/useQuery.cjs.map +1 -1
  134. package/__cjs/react/hooks/useQuery.d.cts +163 -18
  135. package/__cjs/react/hooks/useQueryRefHandlers.cjs +2 -1
  136. package/__cjs/react/hooks/useQueryRefHandlers.cjs.map +1 -1
  137. package/__cjs/react/hooks/useQueryRefHandlers.d.cts +21 -1
  138. package/__cjs/react/hooks/useReactiveVar.cjs +2 -1
  139. package/__cjs/react/hooks/useReactiveVar.cjs.map +1 -1
  140. package/__cjs/react/hooks/useReactiveVar.d.cts +2 -1
  141. package/__cjs/react/hooks/useReadQuery.cjs +29 -0
  142. package/__cjs/react/hooks/useReadQuery.cjs.map +1 -1
  143. package/__cjs/react/hooks/useReadQuery.d.cts +95 -16
  144. package/__cjs/react/hooks/useSubscription.cjs +8 -9
  145. package/__cjs/react/hooks/useSubscription.cjs.map +1 -1
  146. package/__cjs/react/hooks/useSubscription.d.cts +99 -32
  147. package/__cjs/react/hooks/useSuspenseFragment.cjs.map +1 -1
  148. package/__cjs/react/hooks/useSuspenseFragment.d.cts +61 -29
  149. package/__cjs/react/hooks/useSuspenseQuery.cjs +4 -1
  150. package/__cjs/react/hooks/useSuspenseQuery.cjs.map +1 -1
  151. package/__cjs/react/hooks/useSuspenseQuery.d.cts +438 -17
  152. package/__cjs/react/index.cjs +1 -3
  153. package/__cjs/react/index.cjs.map +1 -1
  154. package/__cjs/react/index.d.cts +0 -1
  155. package/__cjs/react/index.react-server.cjs +1 -3
  156. package/__cjs/react/index.react-server.cjs.map +1 -1
  157. package/__cjs/react/index.react-server.d.cts +0 -1
  158. package/__cjs/react/internal/cache/FragmentReference.cjs.map +1 -1
  159. package/__cjs/react/internal/cache/FragmentReference.d.cts +2 -3
  160. package/__cjs/react/internal/cache/QueryReference.cjs.map +1 -1
  161. package/__cjs/react/internal/cache/QueryReference.d.cts +11 -11
  162. package/__cjs/react/internal/cache/SuspenseCache.cjs.map +1 -1
  163. package/__cjs/react/internal/cache/SuspenseCache.d.cts +2 -2
  164. package/__cjs/react/internal/cache/getSuspenseCache.cjs.map +1 -1
  165. package/__cjs/react/internal/cache/getSuspenseCache.d.cts +6 -4
  166. package/__cjs/react/internal/index.cjs +1 -0
  167. package/__cjs/react/internal/index.cjs.map +1 -1
  168. package/__cjs/react/internal/index.d.cts +1 -1
  169. package/__cjs/react/internal/types.d.cts +3 -3
  170. package/__cjs/react/query-preloader/createQueryPreloader.cjs +1 -1
  171. package/__cjs/react/query-preloader/createQueryPreloader.cjs.map +1 -1
  172. package/__cjs/react/query-preloader/createQueryPreloader.d.cts +31 -31
  173. package/__cjs/react/ssr/prerenderStatic.cjs +5 -4
  174. package/__cjs/react/ssr/prerenderStatic.cjs.map +1 -1
  175. package/__cjs/react/ssr/prerenderStatic.d.cts +11 -9
  176. package/__cjs/react/ssr/useSSRQuery.cjs.map +1 -1
  177. package/__cjs/react/types/deprecated.d.cts +1 -1
  178. package/__cjs/react/types/types.documentation.d.cts +10 -10
  179. package/__cjs/testing/core/mocking/mockLink.cjs.map +1 -1
  180. package/__cjs/testing/core/mocking/mockLink.d.cts +3 -2
  181. package/__cjs/testing/core/types/deprecated.d.cts +3 -2
  182. package/__cjs/testing/react/MockedProvider.cjs.map +1 -1
  183. package/__cjs/testing/react/MockedProvider.d.cts +2 -3
  184. package/__cjs/utilities/HKT.d.cts +8 -7
  185. package/__cjs/utilities/caching/sizes.cjs +3 -3
  186. package/__cjs/utilities/caching/sizes.cjs.map +1 -1
  187. package/__cjs/utilities/caching/sizes.d.cts +4 -6
  188. package/__cjs/utilities/graphql/DocumentTransform.cjs +2 -2
  189. package/__cjs/utilities/graphql/DocumentTransform.cjs.map +1 -1
  190. package/__cjs/utilities/index.cjs +2 -3
  191. package/__cjs/utilities/index.cjs.map +1 -1
  192. package/__cjs/utilities/index.d.cts +1 -2
  193. package/__cjs/utilities/{shared → internal}/canonicalStringify.cjs +5 -7
  194. package/__cjs/utilities/internal/canonicalStringify.cjs.map +1 -0
  195. package/__cjs/utilities/{shared → internal}/canonicalStringify.d.cts +1 -1
  196. package/__cjs/utilities/internal/checkDocument.cjs +2 -2
  197. package/__cjs/utilities/internal/checkDocument.cjs.map +1 -1
  198. package/__cjs/utilities/internal/createFragmentMap.cjs.map +1 -1
  199. package/__cjs/{core → utilities/internal}/equalByQuery.cjs +13 -7
  200. package/__cjs/utilities/internal/equalByQuery.cjs.map +1 -0
  201. package/__cjs/utilities/internal/equalByQuery.d.cts +5 -0
  202. package/__cjs/utilities/internal/getFragmentQueryDocument.cjs +13 -3
  203. package/__cjs/utilities/internal/getFragmentQueryDocument.cjs.map +1 -1
  204. package/__cjs/utilities/internal/getFragmentQueryDocument.d.cts +13 -3
  205. package/__cjs/utilities/internal/getMemoryInternals.cjs.map +1 -1
  206. package/__cjs/utilities/internal/getStoreKeyName.cjs +1 -2
  207. package/__cjs/utilities/internal/getStoreKeyName.cjs.map +1 -1
  208. package/__cjs/utilities/internal/index.cjs +6 -2
  209. package/__cjs/utilities/internal/index.cjs.map +1 -1
  210. package/__cjs/utilities/internal/index.d.cts +2 -0
  211. package/__cjs/utilities/internal/mergeOptions.cjs.map +1 -1
  212. package/__cjs/utilities/internal/mergeOptions.d.cts +2 -2
  213. package/__cjs/utilities/internal/toQueryResult.cjs.map +1 -1
  214. package/__cjs/utilities/internal/toQueryResult.d.cts +2 -2
  215. package/__cjs/utilities/internal/types/DocumentationTypes.d.cts +16 -2
  216. package/__cjs/utilities/internal/types/NoInfer.d.cts +31 -25
  217. package/__cjs/utilities/subscriptions/relay/index.cjs +2 -0
  218. package/__cjs/utilities/subscriptions/relay/index.cjs.map +1 -1
  219. package/__cjs/version.cjs +1 -1
  220. package/cache/core/cache.d.ts +65 -64
  221. package/cache/core/cache.js +3 -7
  222. package/cache/core/cache.js.map +1 -1
  223. package/cache/core/types/Cache.d.ts +200 -15
  224. package/cache/core/types/Cache.js +1 -3
  225. package/cache/core/types/Cache.js.map +1 -1
  226. package/cache/deprecated.d.ts +6 -0
  227. package/cache/deprecated.js +2 -0
  228. package/cache/deprecated.js.map +1 -0
  229. package/cache/index.d.ts +2 -2
  230. package/cache/index.js.map +1 -1
  231. package/cache/inmemory/entityStore.d.ts +17 -16
  232. package/cache/inmemory/entityStore.js +25 -28
  233. package/cache/inmemory/entityStore.js.map +1 -1
  234. package/cache/inmemory/inMemoryCache.d.ts +4 -4
  235. package/cache/inmemory/inMemoryCache.js.map +1 -1
  236. package/cache/inmemory/key-extractor.js +1 -1
  237. package/cache/inmemory/policies.d.ts +3 -2
  238. package/cache/inmemory/policies.js +4 -4
  239. package/cache/inmemory/policies.js.map +1 -1
  240. package/cache/inmemory/readFromStore.js +2 -2
  241. package/cache/inmemory/writeToStore.d.ts +1 -1
  242. package/cache/inmemory/writeToStore.js +4 -4
  243. package/cache/inmemory/writeToStore.js.map +1 -1
  244. package/core/ApolloClient.d.ts +774 -180
  245. package/core/ApolloClient.js +92 -110
  246. package/core/ApolloClient.js.map +1 -1
  247. package/core/ObservableQuery.d.ts +120 -68
  248. package/core/ObservableQuery.js +10 -10
  249. package/core/ObservableQuery.js.map +1 -1
  250. package/core/QueryInfo.d.ts +5 -4
  251. package/core/QueryInfo.js.map +1 -1
  252. package/core/QueryManager.d.ts +17 -17
  253. package/core/QueryManager.js +15 -13
  254. package/core/QueryManager.js.map +1 -1
  255. package/core/deprecated.d.ts +29 -0
  256. package/core/deprecated.js +2 -0
  257. package/core/deprecated.js.map +1 -0
  258. package/core/index.d.ts +9 -5
  259. package/core/index.js.map +1 -1
  260. package/core/types.d.ts +29 -129
  261. package/core/types.js.map +1 -1
  262. package/core/watchQueryOptions.d.ts +9 -298
  263. package/core/watchQueryOptions.js.map +1 -1
  264. package/dev/setErrorMessageHandler.d.ts +4 -4
  265. package/dev/setErrorMessageHandler.js.map +1 -1
  266. package/errors/CombinedGraphQLErrors.d.ts +147 -12
  267. package/errors/CombinedGraphQLErrors.js +60 -12
  268. package/errors/CombinedGraphQLErrors.js.map +1 -1
  269. package/errors/CombinedProtocolErrors.d.ts +127 -3
  270. package/errors/CombinedProtocolErrors.js +49 -2
  271. package/errors/CombinedProtocolErrors.js.map +1 -1
  272. package/errors/LinkError.d.ts +45 -2
  273. package/errors/LinkError.js +45 -2
  274. package/errors/LinkError.js.map +1 -1
  275. package/errors/LocalStateError.d.ts +42 -6
  276. package/errors/LocalStateError.js +36 -6
  277. package/errors/LocalStateError.js.map +1 -1
  278. package/errors/ServerError.d.ts +71 -12
  279. package/errors/ServerError.js +51 -9
  280. package/errors/ServerError.js.map +1 -1
  281. package/errors/ServerParseError.d.ts +72 -17
  282. package/errors/ServerParseError.js +46 -9
  283. package/errors/ServerParseError.js.map +1 -1
  284. package/errors/UnconventionalError.d.ts +46 -2
  285. package/errors/UnconventionalError.js +46 -2
  286. package/errors/UnconventionalError.js.map +1 -1
  287. package/incremental/handlers/notImplemented.js +1 -1
  288. package/invariantErrorCodes.js +72 -80
  289. package/link/batch/batchLink.js.map +1 -1
  290. package/link/batch-http/batchHttpLink.js +1 -1
  291. package/link/batch-http/batchHttpLink.js.map +1 -1
  292. package/link/client-awareness/ClientAwarenessLink.d.ts +4 -4
  293. package/link/client-awareness/ClientAwarenessLink.js.map +1 -1
  294. package/link/context/index.d.ts +1 -1
  295. package/link/context/index.js +1 -1
  296. package/link/context/index.js.map +1 -1
  297. package/link/core/ApolloLink.js +2 -2
  298. package/link/core/types.d.ts +2 -2
  299. package/link/core/types.js.map +1 -1
  300. package/link/error/index.d.ts +16 -1
  301. package/link/error/index.js.map +1 -1
  302. package/link/http/HttpLink.d.ts +2 -1
  303. package/link/http/HttpLink.js.map +1 -1
  304. package/link/http/checkFetcher.js +1 -1
  305. package/link/http/parseAndCheckHttpResponse.js +1 -1
  306. package/link/http/serializeFetchParameter.js +1 -1
  307. package/link/persisted-queries/index.d.ts +11 -11
  308. package/link/persisted-queries/index.js +2 -2
  309. package/link/persisted-queries/index.js.map +1 -1
  310. package/link/retry/delayFunction.d.ts +1 -1
  311. package/link/retry/delayFunction.js.map +1 -1
  312. package/link/retry/retryFunction.d.ts +1 -1
  313. package/link/retry/retryFunction.js.map +1 -1
  314. package/link/retry/retryLink.js.map +1 -1
  315. package/link/schema/index.js.map +1 -1
  316. package/link/utils/validateOperation.js +1 -1
  317. package/link/ws/index.js.map +1 -1
  318. package/local-state/LocalState.d.ts +94 -0
  319. package/local-state/LocalState.js +55 -9
  320. package/local-state/LocalState.js.map +1 -1
  321. package/masking/GraphQLCodegenDataMasking.d.ts +6 -7
  322. package/masking/GraphQLCodegenDataMasking.js.map +1 -1
  323. package/masking/internal/types.d.ts +70 -70
  324. package/masking/internal/types.js.map +1 -1
  325. package/masking/maskDefinition.js +2 -2
  326. package/masking/maskFragment.js +2 -2
  327. package/masking/maskOperation.js +1 -1
  328. package/masking/types.js.map +1 -1
  329. package/masking/utils.js +3 -3
  330. package/package.json +1 -1
  331. package/react/context/ApolloContext.js +1 -1
  332. package/react/context/ApolloProvider.js +1 -1
  333. package/react/hooks/internal/useDeepMemo.js +0 -3
  334. package/react/hooks/internal/useDeepMemo.js.map +1 -1
  335. package/react/hooks/internal/validateSuspenseHookOptions.d.ts +2 -2
  336. package/react/hooks/internal/validateSuspenseHookOptions.js.map +1 -1
  337. package/react/hooks/internal/wrapHook.d.ts +8 -7
  338. package/react/hooks/internal/wrapHook.js +1 -0
  339. package/react/hooks/internal/wrapHook.js.map +1 -1
  340. package/react/hooks/useApolloClient.d.ts +2 -2
  341. package/react/hooks/useApolloClient.js +2 -2
  342. package/react/hooks/useApolloClient.js.map +1 -1
  343. package/react/hooks/useBackgroundQuery.d.ts +814 -86
  344. package/react/hooks/useBackgroundQuery.js.map +1 -1
  345. package/react/hooks/useFragment.d.ts +54 -3
  346. package/react/hooks/useFragment.js +7 -0
  347. package/react/hooks/useFragment.js.map +1 -1
  348. package/react/hooks/useLazyQuery.d.ts +309 -119
  349. package/react/hooks/useLazyQuery.js +0 -38
  350. package/react/hooks/useLazyQuery.js.map +1 -1
  351. package/react/hooks/useLoadableQuery.d.ts +113 -126
  352. package/react/hooks/useLoadableQuery.js.map +1 -1
  353. package/react/hooks/useMutation.d.ts +57 -17
  354. package/react/hooks/useMutation.js +6 -7
  355. package/react/hooks/useMutation.js.map +1 -1
  356. package/react/hooks/useQuery.d.ts +163 -18
  357. package/react/hooks/useQuery.js +1 -35
  358. package/react/hooks/useQuery.js.map +1 -1
  359. package/react/hooks/useQueryRefHandlers.d.ts +21 -1
  360. package/react/hooks/useQueryRefHandlers.js +2 -1
  361. package/react/hooks/useQueryRefHandlers.js.map +1 -1
  362. package/react/hooks/useReactiveVar.d.ts +2 -1
  363. package/react/hooks/useReactiveVar.js +2 -1
  364. package/react/hooks/useReactiveVar.js.map +1 -1
  365. package/react/hooks/useReadQuery.d.ts +96 -17
  366. package/react/hooks/useReadQuery.js +29 -0
  367. package/react/hooks/useReadQuery.js.map +1 -1
  368. package/react/hooks/useSubscription.d.ts +99 -32
  369. package/react/hooks/useSubscription.js +8 -9
  370. package/react/hooks/useSubscription.js.map +1 -1
  371. package/react/hooks/useSuspenseFragment.d.ts +62 -30
  372. package/react/hooks/useSuspenseFragment.js.map +1 -1
  373. package/react/hooks/useSuspenseQuery.d.ts +438 -17
  374. package/react/hooks/useSuspenseQuery.js +4 -1
  375. package/react/hooks/useSuspenseQuery.js.map +1 -1
  376. package/react/hooks-compiled/internal/useDeepMemo.js +0 -3
  377. package/react/hooks-compiled/internal/useDeepMemo.js.map +1 -1
  378. package/react/hooks-compiled/internal/validateSuspenseHookOptions.d.ts +2 -2
  379. package/react/hooks-compiled/internal/validateSuspenseHookOptions.js.map +1 -1
  380. package/react/hooks-compiled/internal/wrapHook.d.ts +8 -7
  381. package/react/hooks-compiled/internal/wrapHook.js +1 -0
  382. package/react/hooks-compiled/internal/wrapHook.js.map +1 -1
  383. package/react/hooks-compiled/useApolloClient.d.ts +2 -2
  384. package/react/hooks-compiled/useApolloClient.js +2 -2
  385. package/react/hooks-compiled/useApolloClient.js.map +1 -1
  386. package/react/hooks-compiled/useBackgroundQuery.d.ts +814 -86
  387. package/react/hooks-compiled/useBackgroundQuery.js.map +1 -1
  388. package/react/hooks-compiled/useFragment.d.ts +54 -3
  389. package/react/hooks-compiled/useFragment.js +7 -0
  390. package/react/hooks-compiled/useFragment.js.map +1 -1
  391. package/react/hooks-compiled/useLazyQuery.d.ts +309 -119
  392. package/react/hooks-compiled/useLazyQuery.js +0 -38
  393. package/react/hooks-compiled/useLazyQuery.js.map +1 -1
  394. package/react/hooks-compiled/useLoadableQuery.d.ts +113 -126
  395. package/react/hooks-compiled/useLoadableQuery.js.map +1 -1
  396. package/react/hooks-compiled/useMutation.d.ts +57 -17
  397. package/react/hooks-compiled/useMutation.js +6 -7
  398. package/react/hooks-compiled/useMutation.js.map +1 -1
  399. package/react/hooks-compiled/useQuery.d.ts +163 -18
  400. package/react/hooks-compiled/useQuery.js +1 -35
  401. package/react/hooks-compiled/useQuery.js.map +1 -1
  402. package/react/hooks-compiled/useQueryRefHandlers.d.ts +21 -1
  403. package/react/hooks-compiled/useQueryRefHandlers.js +2 -1
  404. package/react/hooks-compiled/useQueryRefHandlers.js.map +1 -1
  405. package/react/hooks-compiled/useReactiveVar.d.ts +2 -1
  406. package/react/hooks-compiled/useReactiveVar.js +2 -1
  407. package/react/hooks-compiled/useReactiveVar.js.map +1 -1
  408. package/react/hooks-compiled/useReadQuery.d.ts +96 -17
  409. package/react/hooks-compiled/useReadQuery.js +29 -0
  410. package/react/hooks-compiled/useReadQuery.js.map +1 -1
  411. package/react/hooks-compiled/useSubscription.d.ts +99 -32
  412. package/react/hooks-compiled/useSubscription.js +8 -9
  413. package/react/hooks-compiled/useSubscription.js.map +1 -1
  414. package/react/hooks-compiled/useSuspenseFragment.d.ts +62 -30
  415. package/react/hooks-compiled/useSuspenseFragment.js.map +1 -1
  416. package/react/hooks-compiled/useSuspenseQuery.d.ts +438 -17
  417. package/react/hooks-compiled/useSuspenseQuery.js.map +1 -1
  418. package/react/index.compiled.d.ts +0 -1
  419. package/react/index.compiled.js +0 -1
  420. package/react/index.compiled.js.map +1 -1
  421. package/react/index.d.ts +0 -1
  422. package/react/index.js +0 -1
  423. package/react/index.js.map +1 -1
  424. package/react/index.react-server.d.ts +0 -1
  425. package/react/index.react-server.js +0 -2
  426. package/react/index.react-server.js.map +1 -1
  427. package/react/internal/cache/FragmentReference.d.ts +2 -3
  428. package/react/internal/cache/FragmentReference.js.map +1 -1
  429. package/react/internal/cache/QueryReference.d.ts +11 -11
  430. package/react/internal/cache/QueryReference.js.map +1 -1
  431. package/react/internal/cache/SuspenseCache.d.ts +2 -2
  432. package/react/internal/cache/SuspenseCache.js.map +1 -1
  433. package/react/internal/cache/getSuspenseCache.d.ts +6 -4
  434. package/react/internal/cache/getSuspenseCache.js.map +1 -1
  435. package/react/internal/index.d.ts +1 -1
  436. package/react/internal/index.js +1 -0
  437. package/react/internal/index.js.map +1 -1
  438. package/react/internal/types.d.ts +3 -3
  439. package/react/internal/types.js.map +1 -1
  440. package/react/query-preloader/createQueryPreloader.d.ts +31 -31
  441. package/react/query-preloader/createQueryPreloader.js +1 -1
  442. package/react/query-preloader/createQueryPreloader.js.map +1 -1
  443. package/react/ssr/prerenderStatic.d.ts +11 -9
  444. package/react/ssr/prerenderStatic.js +5 -4
  445. package/react/ssr/prerenderStatic.js.map +1 -1
  446. package/react/ssr/useSSRQuery.js.map +1 -1
  447. package/react/types/deprecated.d.ts +1 -1
  448. package/react/types/deprecated.js.map +1 -1
  449. package/react/types/types.documentation.d.ts +10 -10
  450. package/react/types/types.documentation.js.map +1 -1
  451. package/testing/core/mocking/mockLink.d.ts +3 -2
  452. package/testing/core/mocking/mockLink.js.map +1 -1
  453. package/testing/core/types/deprecated.d.ts +3 -2
  454. package/testing/core/types/deprecated.js.map +1 -1
  455. package/testing/react/MockedProvider.d.ts +2 -3
  456. package/testing/react/MockedProvider.js.map +1 -1
  457. package/utilities/HKT.d.ts +8 -7
  458. package/utilities/HKT.js.map +1 -1
  459. package/utilities/caching/sizes.d.ts +4 -6
  460. package/utilities/caching/sizes.js +3 -3
  461. package/utilities/caching/sizes.js.map +1 -1
  462. package/utilities/graphql/DocumentTransform.js +1 -1
  463. package/utilities/graphql/DocumentTransform.js.map +1 -1
  464. package/utilities/index.d.ts +1 -2
  465. package/utilities/index.js +1 -2
  466. package/utilities/index.js.map +1 -1
  467. package/utilities/{shared → internal}/canonicalStringify.d.ts +1 -1
  468. package/utilities/{shared → internal}/canonicalStringify.js +4 -6
  469. package/utilities/internal/canonicalStringify.js.map +1 -0
  470. package/utilities/internal/checkDocument.js +1 -1
  471. package/utilities/internal/checkDocument.js.map +1 -1
  472. package/utilities/internal/createFragmentMap.js.map +1 -1
  473. package/utilities/internal/equalByQuery.d.ts +5 -0
  474. package/{core → utilities/internal}/equalByQuery.js +7 -1
  475. package/utilities/internal/equalByQuery.js.map +1 -0
  476. package/utilities/internal/getFragmentQueryDocument.d.ts +13 -3
  477. package/utilities/internal/getFragmentQueryDocument.js +13 -3
  478. package/utilities/internal/getFragmentQueryDocument.js.map +1 -1
  479. package/utilities/internal/getMemoryInternals.js.map +1 -1
  480. package/utilities/internal/getStoreKeyName.js +1 -2
  481. package/utilities/internal/getStoreKeyName.js.map +1 -1
  482. package/utilities/internal/index.d.ts +2 -0
  483. package/utilities/internal/index.js +2 -0
  484. package/utilities/internal/index.js.map +1 -1
  485. package/utilities/internal/mergeOptions.d.ts +2 -2
  486. package/utilities/internal/mergeOptions.js.map +1 -1
  487. package/utilities/internal/toQueryResult.d.ts +2 -2
  488. package/utilities/internal/toQueryResult.js.map +1 -1
  489. package/utilities/internal/types/DocumentationTypes.d.ts +16 -2
  490. package/utilities/internal/types/DocumentationTypes.js.map +1 -1
  491. package/utilities/internal/types/NoInfer.d.ts +31 -25
  492. package/utilities/internal/types/NoInfer.js.map +1 -1
  493. package/utilities/subscriptions/relay/index.js +2 -0
  494. package/utilities/subscriptions/relay/index.js.map +1 -1
  495. package/version.js +1 -1
  496. package/__cjs/cache/core/types/DataProxy.cjs.map +0 -1
  497. package/__cjs/cache/core/types/DataProxy.d.cts +0 -140
  498. package/__cjs/core/equalByQuery.cjs.map +0 -1
  499. package/__cjs/core/equalByQuery.d.cts +0 -4
  500. package/__cjs/react/context/ApolloConsumer.cjs +0 -16
  501. package/__cjs/react/context/ApolloConsumer.cjs.map +0 -1
  502. package/__cjs/react/context/ApolloConsumer.d.cts +0 -10
  503. package/__cjs/utilities/shared/canonicalStringify.cjs.map +0 -1
  504. package/cache/core/types/DataProxy.d.ts +0 -140
  505. package/cache/core/types/DataProxy.js +0 -2
  506. package/cache/core/types/DataProxy.js.map +0 -1
  507. package/core/equalByQuery.d.ts +0 -4
  508. package/core/equalByQuery.js.map +0 -1
  509. package/react/context/ApolloConsumer.d.ts +0 -10
  510. package/react/context/ApolloConsumer.js +0 -11
  511. package/react/context/ApolloConsumer.js.map +0 -1
  512. package/utilities/shared/canonicalStringify.js.map +0 -1
@@ -3,25 +3,84 @@ export declare namespace ServerError {
3
3
  response: Response;
4
4
  bodyText: string;
5
5
  }
6
+ namespace DocumentationTypes {
7
+ interface InstanceProperties {
8
+ /**
9
+ * The raw [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) object provided by the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
10
+ */
11
+ readonly response: Response;
12
+ /**
13
+ * The status code returned by the server in the response. This is provided as
14
+ * a shortcut for `response.status`.
15
+ */
16
+ readonly statusCode: number;
17
+ /**
18
+ * The raw response body text.
19
+ */
20
+ readonly bodyText: string;
21
+ }
22
+ }
6
23
  }
7
24
  /**
8
- * Thrown when a non-200 response is returned from the server.
25
+ * Represents an error when a non-200 HTTP status code is returned from the
26
+ * server according to the [GraphQL Over HTTP specification](https://graphql.github.io/graphql-over-http/draft/). This error
27
+ * contains the full server response, including status code and body text.
28
+ *
29
+ * @remarks
30
+ *
31
+ * This error occurs when your GraphQL server responds with an HTTP status code
32
+ * other than 200 (such as 4xx or 5xx status codes) with any media type other
33
+ * than [`application/graphql-response+json`](https://graphql.github.io/graphql-over-http/draft/#sec-application-graphql-response-json).
34
+ *
35
+ * Servers that return non-200 status codes with other media types are not
36
+ * guaranteed to contain a well-formed GraphQL response and may indicate issues
37
+ * at the HTTP level, such as authentication failures, server unavailability,
38
+ * or other HTTP-level problems.
39
+ *
40
+ * @example
41
+ *
42
+ * ```ts
43
+ * import { ServerError } from "@apollo/client/errors";
44
+ *
45
+ * // Check if an error is a ServerError instance
46
+ * if (ServerError.is(error)) {
47
+ * console.log(`Server returned status: ${error.statusCode}`);
48
+ * console.log(`Response body: ${error.bodyText}`);
49
+ *
50
+ * // Handle specific status codes
51
+ * if (error.statusCode === 401) {
52
+ * // Handle unauthorized access
53
+ * }
54
+ * }
55
+ * ```
9
56
  */
10
57
  export declare class ServerError extends Error {
11
- /** Determine if an error is a `ServerError` instance */
12
- static is(error: unknown): error is ServerError;
13
58
  /**
14
- * The server response.
59
+ * A method that determines whether an error is a `ServerError` object. This
60
+ * method enables TypeScript to narrow the error type.
61
+ *
62
+ * @example
63
+ *
64
+ * ```ts
65
+ * if (ServerError.is(error)) {
66
+ * // TypeScript now knows `error` is a ServerError object
67
+ * console.log(error.errors);
68
+ * }
69
+ * ```
15
70
  */
16
- response: Response;
71
+ static is(error: unknown): error is ServerError;
17
72
  /**
18
- * The status code returned from the server.
19
- */
20
- statusCode: number;
73
+ * The raw [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) object provided by the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
74
+ */
75
+ readonly response: Response;
21
76
  /**
22
- * The raw response body text.
23
- */
24
- bodyText: string;
77
+ * The status code returned by the server in the response. This is provided as a shortcut for `response.status`.
78
+ */
79
+ readonly statusCode: number;
80
+ /**
81
+ * The raw response body text.
82
+ */
83
+ readonly bodyText: string;
25
84
  constructor(message: string, options: ServerError.Options);
26
85
  }
27
- //# sourceMappingURL=ServerError.d.ts.map
86
+ //# sourceMappingURL=ServerError.d.ts.map
@@ -1,23 +1,65 @@
1
1
  import { brand, isBranded } from "./utils.js";
2
2
  /**
3
- * Thrown when a non-200 response is returned from the server.
3
+ * Represents an error when a non-200 HTTP status code is returned from the
4
+ * server according to the [GraphQL Over HTTP specification](https://graphql.github.io/graphql-over-http/draft/). This error
5
+ * contains the full server response, including status code and body text.
6
+ *
7
+ * @remarks
8
+ *
9
+ * This error occurs when your GraphQL server responds with an HTTP status code
10
+ * other than 200 (such as 4xx or 5xx status codes) with any media type other
11
+ * than [`application/graphql-response+json`](https://graphql.github.io/graphql-over-http/draft/#sec-application-graphql-response-json).
12
+ *
13
+ * Servers that return non-200 status codes with other media types are not
14
+ * guaranteed to contain a well-formed GraphQL response and may indicate issues
15
+ * at the HTTP level, such as authentication failures, server unavailability,
16
+ * or other HTTP-level problems.
17
+ *
18
+ * @example
19
+ *
20
+ * ```ts
21
+ * import { ServerError } from "@apollo/client/errors";
22
+ *
23
+ * // Check if an error is a ServerError instance
24
+ * if (ServerError.is(error)) {
25
+ * console.log(`Server returned status: ${error.statusCode}`);
26
+ * console.log(`Response body: ${error.bodyText}`);
27
+ *
28
+ * // Handle specific status codes
29
+ * if (error.statusCode === 401) {
30
+ * // Handle unauthorized access
31
+ * }
32
+ * }
33
+ * ```
4
34
  */
5
35
  export class ServerError extends Error {
6
- /** Determine if an error is a `ServerError` instance */
36
+ /**
37
+ * A method that determines whether an error is a `ServerError` object. This
38
+ * method enables TypeScript to narrow the error type.
39
+ *
40
+ * @example
41
+ *
42
+ * ```ts
43
+ * if (ServerError.is(error)) {
44
+ * // TypeScript now knows `error` is a ServerError object
45
+ * console.log(error.errors);
46
+ * }
47
+ * ```
48
+ */
7
49
  static is(error) {
8
50
  return isBranded(error, "ServerError");
9
51
  }
10
52
  /**
11
- * The server response.
12
- */
53
+ * The raw [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) object provided by the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
54
+ */
13
55
  response;
14
56
  /**
15
- * The status code returned from the server.
16
- */
57
+ * The status code returned by the server in the response. This is provided as a shortcut for `response.status`.
58
+ */
17
59
  statusCode;
18
60
  /**
19
- * The raw response body text.
20
- */
61
+ * The raw response body text.
62
+ */
21
63
  bodyText;
22
64
  constructor(message, options) {
23
65
  super(message);
@@ -29,4 +71,4 @@ export class ServerError extends Error {
29
71
  Object.setPrototypeOf(this, ServerError.prototype);
30
72
  }
31
73
  }
32
- //# sourceMappingURL=ServerError.js.map
74
+ //# sourceMappingURL=ServerError.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"ServerError.js","sourceRoot":"","sources":["../../src/errors/ServerError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAS9C;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,wDAAwD;IACxD,MAAM,CAAC,EAAE,CAAC,KAAc;QACtB,OAAO,SAAS,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,QAAQ,CAAW;IACnB;;OAEG;IACH,UAAU,CAAS;IAEnB;;OAEG;IACH,QAAQ,CAAS;IAEjB,YAAY,OAAe,EAAE,OAA4B;QACvD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAEjC,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;CACF","sourcesContent":["import { brand, isBranded } from \"./utils.js\";\n\nexport declare namespace ServerError {\n export interface Options {\n response: Response;\n bodyText: string;\n }\n}\n\n/**\n * Thrown when a non-200 response is returned from the server.\n */\nexport class ServerError extends Error {\n /** Determine if an error is a `ServerError` instance */\n static is(error: unknown): error is ServerError {\n return isBranded(error, \"ServerError\");\n }\n\n /**\n * The server response.\n */\n response: Response;\n /**\n * The status code returned from the server.\n */\n statusCode: number;\n\n /**\n * The raw response body text.\n */\n bodyText: string;\n\n constructor(message: string, options: ServerError.Options) {\n super(message);\n this.name = \"ServerError\";\n this.response = options.response;\n this.statusCode = options.response.status;\n this.bodyText = options.bodyText;\n\n brand(this);\n Object.setPrototypeOf(this, ServerError.prototype);\n }\n}\n"]}
1
+ {"version":3,"file":"ServerError.js","sources":["../../src/errors/ServerError.ts"],"sourcesContent":["import { brand, isBranded } from \"./utils.js\";\n\nexport declare namespace ServerError {\n export interface Options {\n response: Response;\n bodyText: string;\n }\n\n namespace DocumentationTypes {\n interface InstanceProperties {\n /**\n * The raw [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) object provided by the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).\n */\n readonly response: Response;\n /**\n * The status code returned by the server in the response. This is provided as\n * a shortcut for `response.status`.\n */\n readonly statusCode: number;\n\n /**\n * The raw response body text.\n */\n readonly bodyText: string;\n }\n }\n}\n\n/**\n * Represents an error when a non-200 HTTP status code is returned from the\n * server according to the [GraphQL Over HTTP specification](https://graphql.github.io/graphql-over-http/draft/). This error\n * contains the full server response, including status code and body text.\n *\n * @remarks\n *\n * This error occurs when your GraphQL server responds with an HTTP status code\n * other than 200 (such as 4xx or 5xx status codes) with any media type other\n * than [`application/graphql-response+json`](https://graphql.github.io/graphql-over-http/draft/#sec-application-graphql-response-json).\n *\n * Servers that return non-200 status codes with other media types are not\n * guaranteed to contain a well-formed GraphQL response and may indicate issues\n * at the HTTP level, such as authentication failures, server unavailability,\n * or other HTTP-level problems.\n *\n * @example\n *\n * ```ts\n * import { ServerError } from \"@apollo/client/errors\";\n *\n * // Check if an error is a ServerError instance\n * if (ServerError.is(error)) {\n * console.log(`Server returned status: ${error.statusCode}`);\n * console.log(`Response body: ${error.bodyText}`);\n *\n * // Handle specific status codes\n * if (error.statusCode === 401) {\n * // Handle unauthorized access\n * }\n * }\n * ```\n */\nexport class ServerError extends Error {\n /**\n * A method that determines whether an error is a `ServerError` object. This\n * method enables TypeScript to narrow the error type.\n *\n * @example\n *\n * ```ts\n * if (ServerError.is(error)) {\n * // TypeScript now knows `error` is a ServerError object\n * console.log(error.errors);\n * }\n * ```\n */\n static is(error: unknown): error is ServerError {\n return isBranded(error, \"ServerError\");\n }\n\n /** {@inheritDoc @apollo/client!ServerError.DocumentationTypes.InstanceProperties#response:member} */\n readonly response: Response;\n\n /** {@inheritDoc @apollo/client!ServerError.DocumentationTypes.InstanceProperties#statusCode:member} */\n readonly statusCode: number;\n\n /** {@inheritDoc @apollo/client!ServerError.DocumentationTypes.InstanceProperties#bodyText:member} */\n readonly bodyText: string;\n\n constructor(message: string, options: ServerError.Options) {\n super(message);\n this.name = \"ServerError\";\n this.response = options.response;\n this.statusCode = options.response.status;\n this.bodyText = options.bodyText;\n\n brand(this);\n Object.setPrototypeOf(this, ServerError.prototype);\n }\n}\n"],"names":[],"mappings":"AAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAc,EAAE,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAiC,CAAjC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6C;AA4B7C,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgCA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAiC,CAAjC,CAAA,CAAA,CAAA,EAAA;IACE,CAAF,CAAA;;;;;;;;;;;;KAYA,CAAA;IACE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAW,CAAC,CAAZ,CAAA,CAAA,CAAA,CAA0B,EAA1B;QACI,CAAJ,CAAA,CAAA,CAAA,CAAA,EAAW,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAA,CAA0B,EAAE,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyC,CAAC;IACxC;;;;IAGS,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmB;;;;IAGR,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqB;;;;IAGV,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmB;IAEjB,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAc,CAAd,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,EAAE,CAA/B,CAAA,CAAA,CAAA,CAAA,CAAA,CAA2D,EAA3D;QACI,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAC,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB,CAAC;QACd,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,EAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B;QACzB,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAoB,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA2B,CAAC,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoC;QAChC,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAsB,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsC,CAAC,CAAvC,CAAA,CAAA,CAAA,CAAA,CAA6C;QACzC,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAoB,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA2B,CAAC,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoC;QAEhC,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAC,CAAV,CAAA,CAAA,CAAc,CAAC;QACX,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAA8B,EAAE,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA2C,CAAC,CAA5C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqD,CAAC;IACpD;AACF;"}
@@ -1,26 +1,81 @@
1
- interface ServerParseErrorOptions {
2
- response: Response;
3
- bodyText: string;
1
+ export declare namespace ServerParseError {
2
+ interface Options {
3
+ response: Response;
4
+ bodyText: string;
5
+ }
6
+ namespace DocumentationTypes {
7
+ interface InstanceProperties {
8
+ /**
9
+ * The raw [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) object provided by the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
10
+ */
11
+ readonly response: Response;
12
+ /**
13
+ * The status code returned by the server in the response. This is provided
14
+ * as a shortcut for `response.status`.
15
+ */
16
+ readonly statusCode: number;
17
+ /**
18
+ * The raw response body text.
19
+ */
20
+ readonly bodyText: string;
21
+ }
22
+ }
4
23
  }
5
24
  /**
6
- * Thrown when failing to parse the response as JSON from the server.
25
+ * Represents a failure to parse the response as JSON from the server. This
26
+ * error helps debug issues where the server returns malformed JSON or non-JSON
27
+ * content.
28
+ *
29
+ * @remarks
30
+ *
31
+ * This error occurs when Apollo Client receives a response from the server but
32
+ * cannot parse it as valid JSON. This typically happens when the server returns
33
+ * HTML error pages, plain text responses, or malformed JSON instead of the
34
+ * expected GraphQL JSON response format.
35
+ *
36
+ * @example
37
+ *
38
+ * ```ts
39
+ * import { ServerParseError } from "@apollo/client/errors";
40
+ *
41
+ * // Check if an error is a ServerParseError instance
42
+ * if (ServerParseError.is(error)) {
43
+ * console.log(`Failed to parse response from ${error.response.url}`);
44
+ * console.log(`Raw response: ${error.bodyText}`);
45
+ * console.log(`Status code: ${error.statusCode}`);
46
+ *
47
+ * // Access the original parse error
48
+ * console.log(`Parse error: ${error.cause}`);
49
+ * }
50
+ * ```
7
51
  */
8
52
  export declare class ServerParseError extends Error {
9
- /** Determine if an error is an `ServerParseError` instance */
10
- static is(error: unknown): error is ServerParseError;
11
53
  /**
12
- * The server response.
54
+ * A method that determines whether an error is a `ServerParseError`
55
+ * object. This method enables TypeScript to narrow the error type.
56
+ *
57
+ * @example
58
+ *
59
+ * ```ts
60
+ * if (ServerParseError.is(error)) {
61
+ * // TypeScript now knows `error` is a ServerParseError object
62
+ * console.log(error.statusCode);
63
+ * }
64
+ * ```
13
65
  */
14
- response: Response;
66
+ static is(error: unknown): error is ServerParseError;
15
67
  /**
16
- * The status code returned from the server.
17
- */
18
- statusCode: number;
68
+ * The raw [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) object provided by the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
69
+ */
70
+ readonly response: Response;
19
71
  /**
20
- * The raw body text returned in the server response.
21
- */
22
- bodyText: string;
23
- constructor(originalParseError: unknown, options: ServerParseErrorOptions);
72
+ * The status code returned by the server in the response. This is provided as a shortcut for `response.status`.
73
+ */
74
+ readonly statusCode: number;
75
+ /**
76
+ * The raw response body text.
77
+ */
78
+ readonly bodyText: string;
79
+ constructor(originalParseError: unknown, options: ServerParseError.Options);
24
80
  }
25
- export {};
26
- //# sourceMappingURL=ServerParseError.d.ts.map
81
+ //# sourceMappingURL=ServerParseError.d.ts.map
@@ -1,23 +1,60 @@
1
1
  import { brand, isBranded } from "./utils.js";
2
2
  /**
3
- * Thrown when failing to parse the response as JSON from the server.
3
+ * Represents a failure to parse the response as JSON from the server. This
4
+ * error helps debug issues where the server returns malformed JSON or non-JSON
5
+ * content.
6
+ *
7
+ * @remarks
8
+ *
9
+ * This error occurs when Apollo Client receives a response from the server but
10
+ * cannot parse it as valid JSON. This typically happens when the server returns
11
+ * HTML error pages, plain text responses, or malformed JSON instead of the
12
+ * expected GraphQL JSON response format.
13
+ *
14
+ * @example
15
+ *
16
+ * ```ts
17
+ * import { ServerParseError } from "@apollo/client/errors";
18
+ *
19
+ * // Check if an error is a ServerParseError instance
20
+ * if (ServerParseError.is(error)) {
21
+ * console.log(`Failed to parse response from ${error.response.url}`);
22
+ * console.log(`Raw response: ${error.bodyText}`);
23
+ * console.log(`Status code: ${error.statusCode}`);
24
+ *
25
+ * // Access the original parse error
26
+ * console.log(`Parse error: ${error.cause}`);
27
+ * }
28
+ * ```
4
29
  */
5
30
  export class ServerParseError extends Error {
6
- /** Determine if an error is an `ServerParseError` instance */
31
+ /**
32
+ * A method that determines whether an error is a `ServerParseError`
33
+ * object. This method enables TypeScript to narrow the error type.
34
+ *
35
+ * @example
36
+ *
37
+ * ```ts
38
+ * if (ServerParseError.is(error)) {
39
+ * // TypeScript now knows `error` is a ServerParseError object
40
+ * console.log(error.statusCode);
41
+ * }
42
+ * ```
43
+ */
7
44
  static is(error) {
8
45
  return isBranded(error, "ServerParseError");
9
46
  }
10
47
  /**
11
- * The server response.
12
- */
48
+ * The raw [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) object provided by the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
49
+ */
13
50
  response;
14
51
  /**
15
- * The status code returned from the server.
16
- */
52
+ * The status code returned by the server in the response. This is provided as a shortcut for `response.status`.
53
+ */
17
54
  statusCode;
18
55
  /**
19
- * The raw body text returned in the server response.
20
- */
56
+ * The raw response body text.
57
+ */
21
58
  bodyText;
22
59
  constructor(originalParseError, options) {
23
60
  super(originalParseError instanceof Error ?
@@ -31,4 +68,4 @@ export class ServerParseError extends Error {
31
68
  Object.setPrototypeOf(this, ServerParseError.prototype);
32
69
  }
33
70
  }
34
- //# sourceMappingURL=ServerParseError.js.map
71
+ //# sourceMappingURL=ServerParseError.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"ServerParseError.js","sourceRoot":"","sources":["../../src/errors/ServerParseError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAO9C;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC,8DAA8D;IAC9D,MAAM,CAAC,EAAE,CAAC,KAAc;QACtB,OAAO,SAAS,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;IAC9C,CAAC;IACD;;OAEG;IACH,QAAQ,CAAW;IACnB;;OAEG;IACH,UAAU,CAAS;IACnB;;OAEG;IACH,QAAQ,CAAS;IAEjB,YAAY,kBAA2B,EAAE,OAAgC;QACvE,KAAK,CACH,kBAAkB,YAAY,KAAK,CAAC,CAAC;YACnC,kBAAkB,CAAC,OAAO;YAC5B,CAAC,CAAC,iCAAiC,EACnC,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAC9B,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAEjC,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC1D,CAAC;CACF","sourcesContent":["import { brand, isBranded } from \"./utils.js\";\n\ninterface ServerParseErrorOptions {\n response: Response;\n bodyText: string;\n}\n\n/**\n * Thrown when failing to parse the response as JSON from the server.\n */\nexport class ServerParseError extends Error {\n /** Determine if an error is an `ServerParseError` instance */\n static is(error: unknown): error is ServerParseError {\n return isBranded(error, \"ServerParseError\");\n }\n /**\n * The server response.\n */\n response: Response;\n /**\n * The status code returned from the server.\n */\n statusCode: number;\n /**\n * The raw body text returned in the server response.\n */\n bodyText: string;\n\n constructor(originalParseError: unknown, options: ServerParseErrorOptions) {\n super(\n originalParseError instanceof Error ?\n originalParseError.message\n : \"Could not parse server response\",\n { cause: originalParseError }\n );\n this.name = \"ServerParseError\";\n this.response = options.response;\n this.statusCode = options.response.status;\n this.bodyText = options.bodyText;\n\n brand(this);\n Object.setPrototypeOf(this, ServerParseError.prototype);\n }\n}\n"]}
1
+ {"version":3,"file":"ServerParseError.js","sources":["../../src/errors/ServerParseError.ts"],"sourcesContent":["import { brand, isBranded } from \"./utils.js\";\n\nexport declare namespace ServerParseError {\n export interface Options {\n response: Response;\n bodyText: string;\n }\n\n namespace DocumentationTypes {\n interface InstanceProperties {\n /**\n * The raw [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) object provided by the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).\n */\n readonly response: Response;\n /**\n * The status code returned by the server in the response. This is provided\n * as a shortcut for `response.status`.\n */\n readonly statusCode: number;\n /**\n * The raw response body text.\n */\n readonly bodyText: string;\n }\n }\n}\n\n/**\n * Represents a failure to parse the response as JSON from the server. This\n * error helps debug issues where the server returns malformed JSON or non-JSON\n * content.\n *\n * @remarks\n *\n * This error occurs when Apollo Client receives a response from the server but\n * cannot parse it as valid JSON. This typically happens when the server returns\n * HTML error pages, plain text responses, or malformed JSON instead of the\n * expected GraphQL JSON response format.\n *\n * @example\n *\n * ```ts\n * import { ServerParseError } from \"@apollo/client/errors\";\n *\n * // Check if an error is a ServerParseError instance\n * if (ServerParseError.is(error)) {\n * console.log(`Failed to parse response from ${error.response.url}`);\n * console.log(`Raw response: ${error.bodyText}`);\n * console.log(`Status code: ${error.statusCode}`);\n *\n * // Access the original parse error\n * console.log(`Parse error: ${error.cause}`);\n * }\n * ```\n */\nexport class ServerParseError extends Error {\n /**\n * A method that determines whether an error is a `ServerParseError`\n * object. This method enables TypeScript to narrow the error type.\n *\n * @example\n *\n * ```ts\n * if (ServerParseError.is(error)) {\n * // TypeScript now knows `error` is a ServerParseError object\n * console.log(error.statusCode);\n * }\n * ```\n */\n static is(error: unknown): error is ServerParseError {\n return isBranded(error, \"ServerParseError\");\n }\n /** {@inheritDoc @apollo/client!ServerParseError.DocumentationTypes.InstanceProperties#response:member} */\n readonly response: Response;\n\n /** {@inheritDoc @apollo/client!ServerParseError.DocumentationTypes.InstanceProperties#statusCode:member} */\n readonly statusCode: number;\n\n /** {@inheritDoc @apollo/client!ServerParseError.DocumentationTypes.InstanceProperties#bodyText:member} */\n readonly bodyText: string;\n\n constructor(originalParseError: unknown, options: ServerParseError.Options) {\n super(\n originalParseError instanceof Error ?\n originalParseError.message\n : \"Could not parse server response\",\n { cause: originalParseError }\n );\n this.name = \"ServerParseError\";\n this.response = options.response;\n this.statusCode = options.response.status;\n this.bodyText = options.bodyText;\n\n brand(this);\n Object.setPrototypeOf(this, ServerParseError.prototype);\n }\n}\n"],"names":[],"mappings":"AAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAc,EAAE,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAiC,CAAjC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6C;AA2B7C,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAsC,CAAtC,CAAA,CAAA,CAAA,EAAA;IACE,CAAF,CAAA;;;;;;;;;;;;KAYA,CAAA;IACE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAW,CAAC,CAAZ,CAAA,CAAA,CAAA,CAA0B,EAA1B;QACI,CAAJ,CAAA,CAAA,CAAA,CAAA,EAAW,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAA,CAA0B,EAAE,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8C,CAAC;IAC7C;;;;IAES,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmB;;;;IAGR,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqB;;;;IAGV,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmB;IAEjB,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAc,CAAd,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyC,EAAE,CAA3C,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4E,EAA5E;QACI,CAAJ,CAAA,CAAA,CAAA,CAAS,CACH,CADN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EACoC,CADpC,CAAA,CAAA,CAAA,EAC0C;YAClC,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0B,CAAC,CAA3B,CAAA,CAAA,CAAA,CAAA,CAAA;YACM,EAAE,CAAR,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyC,EACnC,EAAE,CADR,CAAA,CAAA,CAAA,CACa,EAAE,CADf,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CACmC,CAC9B;QACD,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,EAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkC;QAC9B,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAoB,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA2B,CAAC,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoC;QAChC,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAsB,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsC,CAAC,CAAvC,CAAA,CAAA,CAAA,CAAA,CAA6C;QACzC,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAoB,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA2B,CAAC,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoC;QAEhC,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAC,CAAV,CAAA,CAAA,CAAc,CAAC;QACX,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAA8B,EAAE,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgD,CAAC,CAAjD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0D,CAAC;IACzD;AACF;"}
@@ -1,10 +1,54 @@
1
1
  /**
2
2
  * A wrapper error type that represents a non-standard error thrown from a
3
- * response, such as a symbol or plain object. Read the `cause` property to
3
+ * A wrapper error type that represents a non-error value thrown from the
4
+ * link chain, such as a symbol, primitive or plain object. Read the `cause` property to
4
5
  * determine the source of the error.
6
+ *
7
+ * @remarks
8
+ *
9
+ * This error is used to standardize error handling when non-Error values are
10
+ * thrown in the Apollo Client link chain or other parts of the system.
11
+ * JavaScript allows throwing any value (not just Error instances), and this
12
+ * wrapper ensures that all thrown values can be handled consistently as
13
+ * Error-like objects while preserving the original thrown value.
14
+ *
15
+ * > [!NOTE]
16
+ * > Plain strings thrown as errors are wrapped in regular [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) objects instead of `UnconventionalError` objects since strings can be safely used as the error's `message`.
17
+ *
18
+ * @example
19
+ *
20
+ * ```ts
21
+ * import { UnconventionalError } from "@apollo/client/errors";
22
+ *
23
+ * // Check if an error is an UnconventionalError instance
24
+ * if (UnconventionalError.is(error)) {
25
+ * console.log("Non-standard error thrown:", error.cause);
26
+ *
27
+ * // Check the type of the original thrown value
28
+ * if (typeof error.cause === "symbol") {
29
+ * console.log("A symbol was thrown:", error.cause.toString());
30
+ * } else if (typeof error.cause === "object") {
31
+ * console.log("An object was thrown:", error.cause);
32
+ * } else {
33
+ * console.log("Unexpected value thrown:", error.cause);
34
+ * }
35
+ * }
36
+ * ```
5
37
  */
6
38
  export declare class UnconventionalError extends Error {
7
- /** Determine if an error is an `UnconventionalError` instance */
39
+ /**
40
+ * A method that determines whether an error is an `UnconventionalError`
41
+ * object. This method enables TypeScript to narrow the error type.
42
+ *
43
+ * @example
44
+ *
45
+ * ```ts
46
+ * if (UnconventionalError.is(error)) {
47
+ * // TypeScript now knows `error` is a UnconventionalError object
48
+ * console.log("What caused this?", error.cause);
49
+ * }
50
+ * ```
51
+ */
8
52
  static is(error: unknown): error is UnconventionalError;
9
53
  constructor(errorType: unknown);
10
54
  }
@@ -1,11 +1,55 @@
1
1
  import { brand, isBranded } from "./utils.js";
2
2
  /**
3
3
  * A wrapper error type that represents a non-standard error thrown from a
4
- * response, such as a symbol or plain object. Read the `cause` property to
4
+ * A wrapper error type that represents a non-error value thrown from the
5
+ * link chain, such as a symbol, primitive or plain object. Read the `cause` property to
5
6
  * determine the source of the error.
7
+ *
8
+ * @remarks
9
+ *
10
+ * This error is used to standardize error handling when non-Error values are
11
+ * thrown in the Apollo Client link chain or other parts of the system.
12
+ * JavaScript allows throwing any value (not just Error instances), and this
13
+ * wrapper ensures that all thrown values can be handled consistently as
14
+ * Error-like objects while preserving the original thrown value.
15
+ *
16
+ * > [!NOTE]
17
+ * > Plain strings thrown as errors are wrapped in regular [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) objects instead of `UnconventionalError` objects since strings can be safely used as the error's `message`.
18
+ *
19
+ * @example
20
+ *
21
+ * ```ts
22
+ * import { UnconventionalError } from "@apollo/client/errors";
23
+ *
24
+ * // Check if an error is an UnconventionalError instance
25
+ * if (UnconventionalError.is(error)) {
26
+ * console.log("Non-standard error thrown:", error.cause);
27
+ *
28
+ * // Check the type of the original thrown value
29
+ * if (typeof error.cause === "symbol") {
30
+ * console.log("A symbol was thrown:", error.cause.toString());
31
+ * } else if (typeof error.cause === "object") {
32
+ * console.log("An object was thrown:", error.cause);
33
+ * } else {
34
+ * console.log("Unexpected value thrown:", error.cause);
35
+ * }
36
+ * }
37
+ * ```
6
38
  */
7
39
  export class UnconventionalError extends Error {
8
- /** Determine if an error is an `UnconventionalError` instance */
40
+ /**
41
+ * A method that determines whether an error is an `UnconventionalError`
42
+ * object. This method enables TypeScript to narrow the error type.
43
+ *
44
+ * @example
45
+ *
46
+ * ```ts
47
+ * if (UnconventionalError.is(error)) {
48
+ * // TypeScript now knows `error` is a UnconventionalError object
49
+ * console.log("What caused this?", error.cause);
50
+ * }
51
+ * ```
52
+ */
9
53
  static is(error) {
10
54
  return isBranded(error, "UnconventionalError");
11
55
  }
@@ -1 +1 @@
1
- {"version":3,"file":"UnconventionalError.js","sourceRoot":"","sources":["../../src/errors/UnconventionalError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;GAIG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAC5C,iEAAiE;IACjE,MAAM,CAAC,EAAE,CAAC,KAAc;QACtB,OAAO,SAAS,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;IACjD,CAAC;IAED,YAAY,SAAkB;QAC5B,KAAK,CAAC,wCAAwC,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QACtE,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;QAElC,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAC7D,CAAC;CACF","sourcesContent":["import { brand, isBranded } from \"./utils.js\";\n\n/**\n * A wrapper error type that represents a non-standard error thrown from a\n * response, such as a symbol or plain object. Read the `cause` property to\n * determine the source of the error.\n */\nexport class UnconventionalError extends Error {\n /** Determine if an error is an `UnconventionalError` instance */\n static is(error: unknown): error is UnconventionalError {\n return isBranded(error, \"UnconventionalError\");\n }\n\n constructor(errorType: unknown) {\n super(\"An error of unexpected shape occurred.\", { cause: errorType });\n this.name = \"UnconventionalError\";\n\n brand(this);\n Object.setPrototypeOf(this, UnconventionalError.prototype);\n }\n}\n"]}
1
+ {"version":3,"file":"UnconventionalError.js","sourceRoot":"","sources":["../../src/errors/UnconventionalError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAC5C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,CAAC,KAAc;QACtB,OAAO,SAAS,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;IACjD,CAAC;IAED,YAAY,SAAkB;QAC5B,KAAK,CAAC,wCAAwC,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QACtE,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;QAElC,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAC7D,CAAC;CACF","sourcesContent":["import { brand, isBranded } from \"./utils.js\";\n\n/**\n * A wrapper error type that represents a non-standard error thrown from a\n * A wrapper error type that represents a non-error value thrown from the\n * link chain, such as a symbol, primitive or plain object. Read the `cause` property to\n * determine the source of the error.\n *\n * @remarks\n *\n * This error is used to standardize error handling when non-Error values are\n * thrown in the Apollo Client link chain or other parts of the system.\n * JavaScript allows throwing any value (not just Error instances), and this\n * wrapper ensures that all thrown values can be handled consistently as\n * Error-like objects while preserving the original thrown value.\n *\n * > [!NOTE]\n * > Plain strings thrown as errors are wrapped in regular [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) objects instead of `UnconventionalError` objects since strings can be safely used as the error's `message`.\n *\n * @example\n *\n * ```ts\n * import { UnconventionalError } from \"@apollo/client/errors\";\n *\n * // Check if an error is an UnconventionalError instance\n * if (UnconventionalError.is(error)) {\n * console.log(\"Non-standard error thrown:\", error.cause);\n *\n * // Check the type of the original thrown value\n * if (typeof error.cause === \"symbol\") {\n * console.log(\"A symbol was thrown:\", error.cause.toString());\n * } else if (typeof error.cause === \"object\") {\n * console.log(\"An object was thrown:\", error.cause);\n * } else {\n * console.log(\"Unexpected value thrown:\", error.cause);\n * }\n * }\n * ```\n */\nexport class UnconventionalError extends Error {\n /**\n * A method that determines whether an error is an `UnconventionalError`\n * object. This method enables TypeScript to narrow the error type.\n *\n * @example\n *\n * ```ts\n * if (UnconventionalError.is(error)) {\n * // TypeScript now knows `error` is a UnconventionalError object\n * console.log(\"What caused this?\", error.cause);\n * }\n * ```\n */\n static is(error: unknown): error is UnconventionalError {\n return isBranded(error, \"UnconventionalError\");\n }\n\n constructor(errorType: unknown) {\n super(\"An error of unexpected shape occurred.\", { cause: errorType });\n this.name = \"UnconventionalError\";\n\n brand(this);\n Object.setPrototypeOf(this, UnconventionalError.prototype);\n }\n}\n"]}
@@ -5,7 +5,7 @@ export class NotImplementedHandler {
5
5
  return false;
6
6
  }
7
7
  prepareRequest(request) {
8
- invariant(!hasDirectives(["defer"], request.query), 65);
8
+ invariant(!hasDirectives(["defer"], request.query), 64);
9
9
  return request;
10
10
  }
11
11
  extractErrors() { }